Get Started
API Reference
- Api keys
- Items
- Inventory Adjustments
- Branches
- Warehouses
- Accounts
- Inventory Cost
- Sale Invoices
- Pdf Templates
- Tax Rates
- Payments Received
- Import
- resources
- Payment Links
- stripe
- Item Categories
- Expenses
- Warehouse Transfers
- Customers
- Vendors
- Sale Estimates
- GETRetrieves the sale estimates.
- POSTCreate a new sale estimate.
- GETRetrieves the sale estimate details.
- PUTEdit the given sale estimate.
- DELDelete the given sale estimate.
- GETRetrieves the sale estimate state.
- POSTDeliver the given sale estimate.
- PUTApprove the given sale estimate.
- PUTReject the given sale estimate.
- POSTNotify the given sale estimate by SMS.
- GETRetrieves the sale estimate SMS details.
- GETRetrieves the sale estimate mail state.
- POSTSend the given sale estimate by mail.
- GET
- Sale Receipts
- Bills
- Landed Cost
- Manual Journals
- Credit Notes
- Credit Note Refunds
- Credit Notes Apply Invoice
- Vendor Credits
- Vendor Credits Apply Bills
- Bill Payments
- Vendor Credits Refunds
- Bank Accounts
- Banking Plaid
- banking-plaid
- Banking Categorization
- Banking Transactions
- Banking Uncategorized Transactions
- Banking Pending Transactions
- Bank Rules
- Banking Recognized Transactions
- Banking Transactions Matching
- Transactions Locking
- Settings
- Reports
- Dashboard
- Roles
- Subscriptions
- Organization
- Payment Services
- Attachments
- Export
- Views
- Currencies
- misc
- Users
- Contacts
Sale Estimates
Retrieves the sale estimates.
GET
/
api
/
sale-estimates
Copy
{
"customerId": 1,
"estimateDate": "2024-01-01",
"expirationDate": "2024-01-31",
"reference": "EST-2024-001",
"estimateNumber": "EST-2024-001",
"note": "This is a note.",
"termsConditions": "Payment due in 30 days.",
"sendToEmail": "[email protected]",
"exchangeRate": 1,
"amount": 1000,
"currencyCode": "USD",
"deliveredAt": "2024-01-05",
"approvedAt": "2024-01-10",
"rejectedAt": "2024-01-15",
"userId": 42,
"convertedToInvoiceId": 100,
"convertedToInvoiceAt": "2024-02-01",
"createdAt": "2024-01-01",
"updatedAt": "2024-01-10",
"branchId": 2,
"warehouseId": 3,
"discount": 100,
"discountType": "amount",
"adjustment": 50,
"formattedSubtotal": "1,000.00",
"formattedAmount": "1,200.00",
"formattedEstimateDate": "2024-01-01",
"formattedExpirationDate": "2024-01-31",
"formattedDeliveredAtDate": "2024-01-05",
"formattedApprovedAtDate": "2024-01-10",
"formattedRejectedAtDate": "2024-01-15",
"discountAmountFormatted": "100.00",
"discountPercentageFormatted": "10%",
"adjustmentFormatted": "50.00",
"totalFormatted": "1,150.00",
"totalLocalFormatted": "1,200.00",
"formattedCreatedAt": "2024-01-01",
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"attachments": [
{}
],
"data": [
{
"customerId": 1,
"estimateDate": "2024-01-01",
"expirationDate": "2024-01-31",
"reference": "EST-2024-001",
"estimateNumber": "EST-2024-001",
"note": "This is a note.",
"termsConditions": "Payment due in 30 days.",
"sendToEmail": "[email protected]",
"exchangeRate": 1,
"amount": 1000,
"currencyCode": "USD",
"deliveredAt": "2024-01-05",
"approvedAt": "2024-01-10",
"rejectedAt": "2024-01-15",
"userId": 42,
"convertedToInvoiceId": 100,
"convertedToInvoiceAt": "2024-02-01",
"createdAt": "2024-01-01",
"updatedAt": "2024-01-10",
"branchId": 2,
"warehouseId": 3,
"discount": 100,
"discountType": "amount",
"adjustment": 50,
"formattedSubtotal": "1,000.00",
"formattedAmount": "1,200.00",
"formattedEstimateDate": "2024-01-01",
"formattedExpirationDate": "2024-01-31",
"formattedDeliveredAtDate": "2024-01-05",
"formattedApprovedAtDate": "2024-01-10",
"formattedRejectedAtDate": "2024-01-15",
"discountAmountFormatted": "100.00",
"discountPercentageFormatted": "10%",
"adjustmentFormatted": "50.00",
"totalFormatted": "1,150.00",
"totalLocalFormatted": "1,200.00",
"formattedCreatedAt": "2024-01-01",
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"attachments": [
{}
]
}
]
}
Headers
Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.
Example:
"Bearer bc_1234567890abcdef"
Required if Authorization is a JWT token. The organization ID to operate within.
Response
200 - application/json
Sale estimates retrieved successfully
The response is of type object
.
Copy
{
"customerId": 1,
"estimateDate": "2024-01-01",
"expirationDate": "2024-01-31",
"reference": "EST-2024-001",
"estimateNumber": "EST-2024-001",
"note": "This is a note.",
"termsConditions": "Payment due in 30 days.",
"sendToEmail": "[email protected]",
"exchangeRate": 1,
"amount": 1000,
"currencyCode": "USD",
"deliveredAt": "2024-01-05",
"approvedAt": "2024-01-10",
"rejectedAt": "2024-01-15",
"userId": 42,
"convertedToInvoiceId": 100,
"convertedToInvoiceAt": "2024-02-01",
"createdAt": "2024-01-01",
"updatedAt": "2024-01-10",
"branchId": 2,
"warehouseId": 3,
"discount": 100,
"discountType": "amount",
"adjustment": 50,
"formattedSubtotal": "1,000.00",
"formattedAmount": "1,200.00",
"formattedEstimateDate": "2024-01-01",
"formattedExpirationDate": "2024-01-31",
"formattedDeliveredAtDate": "2024-01-05",
"formattedApprovedAtDate": "2024-01-10",
"formattedRejectedAtDate": "2024-01-15",
"discountAmountFormatted": "100.00",
"discountPercentageFormatted": "10%",
"adjustmentFormatted": "50.00",
"totalFormatted": "1,150.00",
"totalLocalFormatted": "1,200.00",
"formattedCreatedAt": "2024-01-01",
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"attachments": [
{}
],
"data": [
{
"customerId": 1,
"estimateDate": "2024-01-01",
"expirationDate": "2024-01-31",
"reference": "EST-2024-001",
"estimateNumber": "EST-2024-001",
"note": "This is a note.",
"termsConditions": "Payment due in 30 days.",
"sendToEmail": "[email protected]",
"exchangeRate": 1,
"amount": 1000,
"currencyCode": "USD",
"deliveredAt": "2024-01-05",
"approvedAt": "2024-01-10",
"rejectedAt": "2024-01-15",
"userId": 42,
"convertedToInvoiceId": 100,
"convertedToInvoiceAt": "2024-02-01",
"createdAt": "2024-01-01",
"updatedAt": "2024-01-10",
"branchId": 2,
"warehouseId": 3,
"discount": 100,
"discountType": "amount",
"adjustment": 50,
"formattedSubtotal": "1,000.00",
"formattedAmount": "1,200.00",
"formattedEstimateDate": "2024-01-01",
"formattedExpirationDate": "2024-01-31",
"formattedDeliveredAtDate": "2024-01-05",
"formattedApprovedAtDate": "2024-01-10",
"formattedRejectedAtDate": "2024-01-15",
"discountAmountFormatted": "100.00",
"discountPercentageFormatted": "10%",
"adjustmentFormatted": "50.00",
"totalFormatted": "1,150.00",
"totalLocalFormatted": "1,200.00",
"formattedCreatedAt": "2024-01-01",
"entries": [
{
"index": 1,
"itemId": 1,
"rate": 1,
"quantity": 1,
"discount": 1,
"discountType": "percentage",
"description": "This is a description",
"taxCode": "123456",
"taxRateId": 1,
"warehouseId": 1,
"projectId": 1,
"projectRefId": 1,
"projectRefType": "TASK",
"projectRefInvoicedAmount": 100,
"sellAccountId": 1020,
"costAccountId": 1021
}
],
"attachments": [
{}
]
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.