GET
/
api
/
sale-estimates
{
  "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

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Response

200 - application/json

Sale estimates retrieved successfully

​
customerId
number
required

Unique identifier of the customer

Example:

1

​
estimateDate
string
required

Date of the estimate

Example:

"2024-01-01"

​
expirationDate
string
required

Expiration date of the estimate

Example:

"2024-01-31"

​
reference
string
required

Reference number of the estimate

Example:

"EST-2024-001"

​
estimateNumber
string
required

Estimate number

Example:

"EST-2024-001"

​
note
string
required

Note for the estimate

Example:

"This is a note."

​
termsConditions
string
required

Terms and conditions for the estimate

Example:

"Payment due in 30 days."

​
sendToEmail
string
required

Email to send the estimate to

Example:

"[email protected]"

​
exchangeRate
number
required

Exchange rate used for the estimate

Example:

1

​
amount
number
required

Amount of the estimate

Example:

1000

​
currencyCode
string
required

Currency code

Example:

"USD"

​
userId
number
required

User ID who created the estimate

Example:

42

​
discount
number
required

Discount value

Example:

100

​
discountType
string
required

Discount type

Example:

"amount"

​
adjustment
number
required

Adjustment value

Example:

50

​
formattedSubtotal
string
required

Formatted subtotal of the estimate

Example:

"1,000.00"

​
formattedAmount
string
required

Formatted total amount of the estimate

Example:

"1,200.00"

​
formattedEstimateDate
string
required

Formatted estimate date

Example:

"2024-01-01"

​
formattedExpirationDate
string
required

Formatted expiration date

Example:

"2024-01-31"

​
formattedDeliveredAtDate
string
required

Formatted delivered at date

Example:

"2024-01-05"

​
formattedApprovedAtDate
string
required

Formatted approved at date

Example:

"2024-01-10"

​
formattedRejectedAtDate
string
required

Formatted rejected at date

Example:

"2024-01-15"

​
discountAmountFormatted
string
required

Formatted discount amount

Example:

"100.00"

​
discountPercentageFormatted
string
required

Formatted discount percentage

Example:

"10%"

​
adjustmentFormatted
string
required

Formatted adjustment amount

Example:

"50.00"

​
totalFormatted
string
required

Formatted total

Example:

"1,150.00"

​
totalLocalFormatted
string
required

Formatted total in local currency

Example:

"1,200.00"

​
formattedCreatedAt
string
required

Formatted created at date

Example:

"2024-01-01"

​
entries
object[]
required

Entries of the sale estimate

​
attachments
object[]
required

Attachments of the sale estimate

​
deliveredAt
string

Delivered at date

Example:

"2024-01-05"

​
approvedAt
string

Approved at date

Example:

"2024-01-10"

​
rejectedAt
string

Rejected at date

Example:

"2024-01-15"

​
convertedToInvoiceId
number

Converted to invoice ID

Example:

100

​
convertedToInvoiceAt
string

Converted to invoice at date

Example:

"2024-02-01"

​
createdAt
string

Created at date

Example:

"2024-01-01"

​
updatedAt
string

Updated at date

Example:

"2024-01-10"

​
branchId
number

Branch ID

Example:

2

​
warehouseId
number

Warehouse ID

Example:

3

​
data
object[]