Skip to main content

Get Inbound Shipment Landed Cost Accruals

GET 

/api/inbound-shipments/:inbound_shipment/landed-cost-accruals

Lists the estimated landed cost and customs duty accrued at receipt for every receipt line of an inbound shipment, with how much is cleared, released and still remaining, and when it will auto-release. Lines appear only where the receipt actually added an estimate to stock cost.

Required scope: purchase-orders:read

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

Each line is one receipt line and one component (landed_cost = estimated freight / landed cost, duty = estimated customs duty):

  • accrued — what the receipt added to stock cost and owes on the accrual account (whole cents)
  • cleared — the estimate a landed-cost bill (or a purchase order cost line) replaced; actual and variance (actual − estimate) when attributable to bills
  • released — the estimate taken back out by a release
  • remaining — still owed on the accrual
  • status — accrued, cleared, released, or released_then_billed (a bill arrived after the release and posted as an ordinary landed-cost true-up)
  • on_hand_quantity — units from this receipt still in stock (a release credits Inventory for this share and Cost of Goods Sold / customs duty variance for the rest)
  • release — when released: id, date, reason (manual | auto), note, who released it, and whether it can still be undone (undo_blocked_reason: billed | locked)
  • auto_release_on / auto_release_in_days — when the remaining accrual is released automatically: N days after the purchase order's last receipt, once it is fully received (or closed short). auto_release_blocked_reason: auto_release_off, po_not_fully_received, or release_undone (a release of the line was undone, so auto-release leaves it alone)
  • is_aged — older than the aging threshold with an accrual remaining

totals sums every line and carries next_auto_release_on, auto_release_after_days (null = auto-release off) and aging_warning_days.

Authentication: Requires Bearer token (scope purchase-orders:read, permission purchase_orders.show).

Request​

Responses​

OK

Response Headers
    Content-Type