Skip to main content
GET
/
api
/
items
/
{id}
/
receipts
Retrieves the item associated receipts transactions.
curl --request GET \
  --url https://api.example.com/api/items/{id}/receipts \
  --header 'Authorization: <authorization>' \
  --header 'organization-id: <organization-id>'
{
  "receiptId": 123,
  "receipNumber": "RCPT-2024-001",
  "referenceNumber": "REF-2024-001",
  "receiptDate": "2024-06-01",
  "formattedReceiptDate": "01/06/2024",
  "amount": 1000,
  "formattedAmount": "$1,000.00",
  "quantity": 10,
  "formattedQuantity": "10",
  "rate": 100,
  "formattedRate": "$100.00",
  "customerDisplayName": "John Doe",
  "customerCurrencyCode": "USD"
}

Headers

​
Authorization
string
required

Value must be 'Bearer ' where 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 receipts transactions have been successfully retrieved.

​
receiptId
number
required

The unique identifier of the receipt.

Example:

123

​
receipNumber
string
required

The receipt number.

Example:

"RCPT-2024-001"

​
referenceNumber
string
required

The reference number for the receipt.

Example:

"REF-2024-001"

​
receiptDate
string
required

The date of the receipt.

Example:

"2024-06-01"

​
formattedReceiptDate
string
required

The formatted date of the receipt.

Example:

"01/06/2024"

​
amount
number
required

The amount for the receipt.

Example:

1000

​
formattedAmount
string
required

The formatted amount for the receipt.

Example:

"$1,000.00"

​
quantity
number
required

The quantity of items in the receipt.

Example:

10

​
formattedQuantity
string
required

The formatted quantity of items in the receipt.

Example:

"10"

​
rate
number
required

The rate per item in the receipt.

Example:

100

​
formattedRate
string
required

The formatted rate per item in the receipt.

Example:

"$100.00"

​
customerDisplayName
string
required

The display name of the customer.

Example:

"John Doe"

​
customerCurrencyCode
string
required

The currency code of the customer.

Example:

"USD"