STstuut
ap-portals

Get Order

Get swept purchase order

One swept PO with its detail-sweep lines (per-line amount_invoiced is the headroom signal) and the swept invoices billed against it — PO numbers normalized with the sweep-time matcher's rules, buyer names matched by containment.

get/v2/ap-portals/orders/{order_id}

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

order_idstring required

Response

Successful Response

idstring required
order_numberstring required
state'open' | 'on_hold' | 'changed' | 'invoiced' | 'closed' | 'cancelled' | 'not_found' | 'unknown' required

Normalized purchase-order lifecycle from a sweep. Invoice creation is a separate fact (can_create_invoice), not answered by these labels: OPEN (active), ON_HOLD (buyer reviewing), CHANGED (superseded — re-fetch the new PO), INVOICED (fully billed), CLOSED / CANCELLED (terminal), NOT_FOUND (referenced but not located in the portal), UNKNOWN (unrecognized provider status). The "PO running low" headroom signal is derived from amounts, not from a status.

order_statusstring nullable required
confirmation_requiredboolean nullable required
can_create_invoiceboolean nullable required
invoice_creation_blocked_reasonstring nullable required
invoice_creation_checked_atstring date-time nullable required
can_submit_invoiceboolean required
customerstring nullable required

Portal buyer identifier.

amountstring nullable required
currencystring nullable required
amount_invoicedstring nullable required
amount_totalstring decimal nullable required
amount_invoiced_totalstring decimal nullable required
order_datestring date nullable required
payload_idstring nullable required
provider'kehe' | 'taulia' | 'coupa' | 'ariba' | 'meijer' | 'kroger' | 'walgreens' | 'albertsons' | 'target' | 'heb' | 'heb_sidm' | 'c_and_s' | 'walmart' | 'walmart_highradius' | 'cvs' | 'cvs_sap' | 'cvs_image_silo' | 'kroger_supplier_connect' | 'kroger_claimtrax' | 'kroger_verigon' | 'servicetitan' | 'sandbox' | 'generic' required

Supported AP Portal providers.

ap_portal_account_idstring required
synced_atstring date-time required
payment_termstring nullable required
display_status'open' | 'awaiting_confirmation' | 'on_hold' | 'changed' | 'invoiced' | 'closed' | 'cancelled' | 'not_found' | 'unknown' required

Changes

No recorded changes to this operation across all 1 revision of this API.