Purchase Return Orders Realtime-enabled

Read and write purchase return orders, goods returned to a vendor. The source is the Purchase Header filtered to Document Type = Return Order, so the document type is stamped for you on insert; you never set it. POST a complete return in one call: the header plus its purchaseReturnOrderLines as a child collection (deep insert). The store key round-trips through integrationId.

Resolve the vendor

Three ways to point a return at a vendor, in addition to the native vendorNumber (Buy-from Vendor No.): set vendorIntegrationId to look the vendor up by its Integration Id and have Business Central fill vendorNumber for you. See resolver fields for how this pattern works. If vendorIntegrationId matches no vendor, the call errors.

Currency translation

currencyCode is translated, not stored verbatim: the local currency reads back as blank LCY and an ISO code maps to the matching Business Central currency. Send the ISO code (e.g. "USD") for a foreign currency, or blank/omit it for the company's local currency.

Create a return order

POST/purchaseReturnOrders

{
  "vendorIntegrationId": "VEND-001",
  "vendorAuthorizationNumber": "RMA-7788",
  "purchaseReturnOrderLines": [
    { "itemNumber": "1000", "quantity": 2, "directUnitCost": 15.00 }
  ]
}

Bound actions

release performs a manual release and reopen returns a released document to Open. post ships and invoices the return. It posts the return shipment and the credit memo in one step.

POST/purchaseReturnOrders({id})/Microsoft.NAV.release

POST/purchaseReturnOrders({id})/Microsoft.NAV.post

archive / cancel snapshot a version and keep the return open, or archive then delete it (soft delete). See Archiving & cancelling.