GET
/
api
/
items
/
{id}
/
estimates
[
  {
    "estimateId": 123,
    "estimateNumber": "EST-2024-001",
    "referenceNumber": "REF-2024-001",
    "estimateDate": "2024-06-01",
    "formattedEstimateDate": "01/06/2024",
    "amount": 1000,
    "formattedAmount": "$1,000.00",
    "quantity": 5,
    "formattedQuantity": "5",
    "rate": 200,
    "formattedRate": "$200.00",
    "customerDisplayName": "Acme Corp",
    "customerCurrencyCode": "USD"
  }
]

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.

Path Parameters

​
id
number
required

The item id

Response

The item associated estimate transactions have been successfully retrieved.

​
estimateId
number
required

The unique identifier of the estimate.

Example:

123

​
estimateNumber
string
required

The estimate number.

Example:

"EST-2024-001"

​
referenceNumber
string
required

The reference number for the estimate.

Example:

"REF-2024-001"

​
estimateDate
string
required

The date of the estimate.

Example:

"2024-06-01"

​
formattedEstimateDate
string
required

The formatted estimate date.

Example:

"01/06/2024"

​
amount
number
required

The amount of the estimate.

Example:

1000

​
formattedAmount
string
required

The formatted amount of the estimate.

Example:

"$1,000.00"

​
quantity
number
required

The quantity in the estimate.

Example:

5

​
formattedQuantity
string
required

The formatted quantity in the estimate.

Example:

"5"

​
rate
number
required

The rate in the estimate.

Example:

200

​
formattedRate
string
required

The formatted rate in the estimate.

Example:

"$200.00"

​
customerDisplayName
string
required

The display name of the customer.

Example:

"Acme Corp"

​
customerCurrencyCode
string
required

The currency code of the customer.

Example:

"USD"