Skip to main content

List Sales Order Financial Lines

GET 
/api/sales-orders/:salesOrder/financial-lines

Lists the financial lines attached to a sales order — shipping, handling, fees, and other non-product revenue or cost lines.

Required scope: orders:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

The response body is a plain JSON array of financial line objects. It is NOT wrapped in a data envelope. Each line includes a nested financial_line_type object carrying the type's classification (revenue or cost).

Authentication: Requires Bearer token.

Query parameters:

  • filter[financialLineType.classification] (string, optional): Restrict to lines whose type is classified revenue or cost.

Response fields (per line):

  • id (integer): Financial line ID.
  • financial_line_type_id (integer): The line type (e.g. Shipping, Handling).
  • link_type (string), link_id (integer): The owning document — always the sales order for this endpoint.
  • nominal_code_id (integer|null): Accounting nominal code.
  • description (string): Display description.
  • quantity (integer): Quantity.
  • amount (number): Unit amount in the order currency.
  • discount_rate (number): Fractional discount (0-1) applied to the extended amount.
  • extended_amount (number): Computed as quantity x amount x (1 - discount_rate).
  • tax_allocation (number): Tax amount attributed to this line.
  • tax_rate_id (integer|null), tax_rate (number): Tax rate reference and percentage.
  • allocate_to_products (boolean): Whether the line's value is prorated across the order's product lines.
  • proration_strategy (string): How the value is prorated — one of revenue_based, cost_based, weight_based, volume_based, quantity_based, specific_line, manual.
  • allocate_to_id (integer|null), allocate_to_type (string|null): Target line when proration_strategy is specific_line.
  • sales_channel_line_id (string|null): Channel line reference for lines imported from a sales channel.
  • external_source_type (string|null), external_source_id (integer|null): External record that produced the line.
  • financial_line_type (object): {id, classification} of the line type.

Path parameters:

  • salesOrder (required): Sales order ID.

Request​

Responses​

OK

Response Headers
    Content-Type