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

​
accept
string
required

Path Parameters

​
id
number
required

The sale estimate id

Response

200 - application/json

The sale estimate details have been successfully retrieved.

The response is of type object.