Skip to content

getPurchaseReturnOrder

READ

Get purchase return order.

POST /api/v1/purchasing/getPurchaseReturnOrder
curl -X POST '<your-host>/api/v1/purchasing/getPurchaseReturnOrder' \
  -H 'Authorization: Bearer <api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "purchaseReturnOrderId": "string"
  }'
Response
{
  "assignee": "string",
  "companyId": "string",
  "createdAt": "string",
  "createdBy": "string",
  "currencyCode": "string",
  "customFields": "…",
  "exchangeRate": 0,
  "expirationDate": "string",
  "externalNotes": "…",
  "id": "string",
  "internalNotes": "…",
  "linesCount": 0,
  "locationId": "string",
  "orderDate": "string",
  "purchaseOrderId": "string",
  "purchaseReturnOrderId": "string",
  "quantityAuthorized": 0,
  "quantityCredited": 0,
  "quantityShipped": 0,
  "replacementPurchaseOrderId": "string",
  "status": "Completed",
  "supplierContactId": "string",
  "supplierId": "string",
  "supplierLocationId": "string",
  "supplierReference": "string",
  "updatedAt": "string",
  "updatedBy": "string"
}

Parameters

ParameterType

Input schema

schema
{
  "type": "object",
  "properties": {
    "purchaseReturnOrderId": {
      "type": "string"
    }
  },
  "required": [
    "purchaseReturnOrderId"
  ]
}