Skip to main content

List Cost Entry Source Lines

GET 

/api/cost-entries/:costEntry/source-lines

Paginated source lines of one cost entry: one row per charge on the vendor document the entry was booked from, each with how much of it is allocated (through allocations linked to the line) and the basis of its amount. Lines that are not fully allocated explain the entry's unallocated amount.

Required scope: purchase-orders:read

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

Filters (all optional, also usable inside filter_groups):

  • filter[search] — reference / SKU, description, charge, product SKU or name, and (exact, numeric) the line ID. Narrow with search_columns.
  • filter[allocation_state.is] / .is_not — allocated, partial, unallocated, not_allocated (partial + unallocated: every line that explains Unallocated).
  • filter[charge_type.is] — product_charge, account_fee, unmatched_reference, rounding, adjustment, other.
  • filter[basis.is] — invoiced, estimated_split, computed, manual.
  • filter[charge_group.is], filter[external_reference.contains], filter[description.contains], filter[product_id.is], filter[line_number.*], filter[amount.*], filter[unallocated_amount.greater_than].

Allowed sorts (prefix - for descending): id, line_number, charge_group, charge_type, external_reference, amount, basis, unallocated_amount, allocation_state. Default: line_number.

Response adds unfiltered_total (all lines on the entry).

Authentication: Requires Bearer token (scope purchase-orders:read).

Request​

Responses​

OK

Response Headers
    Content-Type