Skip to main content
GET
Get billable lines for a receiving report

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

receivingReportId
integer
required

Receiving report ID

Query Parameters

include_extra_costs
boolean
default:true

Whether to include the receipt-scoped extra-cost lines (freight / duty / service) in data. Defaults to true on this endpoint. Set to false to return only the product lines.

Response

Successful response

data
object[]

Flat list of billable lines. Product lines carry line_type: "product"; extra-cost lines carry a classified line_type (freight / duty / service / other) and receipt_scoped: true.

vendor_id
integer | null

The single vendor for the receipt, or null when the receipt spans more than one vendor. Use vendor_groups in that case.

vendor_groups
object[]

Per-vendor breakdown of the billable lines on the receipt.

is_multi_vendor
boolean

true when the receipt has billable lines from more than one vendor.

purchase_order_id
integer | null

The single purchase order for the receipt, or null when the receipt consolidates more than one PO. Use purchase_order_ids in that case.

purchase_order_ids
integer[]

All purchase orders contributing lines to this receipt.

extra_costs_included
boolean

Whether extra-cost lines were included in data (reflects the include_extra_costs query parameter).

extra_cost_summary
object

Summary of the receipt-scoped extra-cost lines.