Skip to main content

List Linkable Inbound Shipments for Invoice

GET 
/api/purchase-invoices/:purchaseInvoice/linkable-inbound-shipments

List the inbound shipments that can still be linked to this purchase invoice: shipments carrying at least one line for the invoice's purchase order, not cancelled, and not already linked to this invoice. A shipment already linked to a different invoice is still offered — a consolidated shipment is billed once per purchase order it carries, and a supplier may split one shipment across several invoices.

Required scope: purchase-orders:read

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

Use this to discover a candidate before calling Link Inbound Shipment to Invoice. Because goods normally ship before the supplier bills, the shipment an invoice covers usually already exists and was created against the purchase order.

Returns the same shipment shape as GET /api/inbound-shipments/{inboundShipment}.

Authentication: Requires Bearer token.

Each row also carries the shipment matcher's verdict for this invoice:

  • link_match — exact (every line the shipment carries for this purchase order is billed by exactly one line on this invoice and none is already paired to another invoice), partial (some overlap, but a line is ambiguous or already claimed — for example a purchase order line billed by two lines on this invoice, a shipment line missing from this invoice, or a shipment unlinked from this invoice earlier) or none (no line in common)
  • link_match_reason — the verdict in plain words

An exact shipment is what Auto-Link Inbound Shipments links on its own; partial and none shipments can still be linked by hand.

Request​

Responses​

OK