supplier_orders

Detail /supplier_orders/{uuid}

Get one purchase order to a supplier by UUID (/supplier_orders/{uuid}) with its lines (items), notes, links, linked pre-invoices and opportunities, and custom fields. Line rate / amount only with the order prices permission.

GET

/supplier_orders/{uuid}

curl --request GET \
  --url 'https://default.hannacrm.app/api/v4/supplier_orders/{uuid}?fields=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>'

{
  "record": {
    "client": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "comment": "<string>",
    "confirmed_order_pick_date": "<string>",
    "contact_person": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "currency": {
      "name": "<string>",
      "symbol": "<string>"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "delivery_address": "<string>",
    "delivery_type": "warehouse",
    "item_arrival_date": "<string>",
    "items": [
      {
        "amount": 123,
        "comment": "<string>",
        "description": "<string>",
        "item": {
          "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        },
        "item_code": "<string>",
        "planned_receive_date": "2023-12-25",
        "qty": 123,
        "rate": 123,
        "supplier_code": "<string>",
        "unit": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vat_percent": 123
      }
    ],
    "link_1": "<string>",
    "link_2": "<string>",
    "link_3": "<string>",
    "note": "<string>",
    "note_en": "<string>",
    "number": "<string>",
    "opportunities": [
      {
        "document_full_number": "<string>",
        "subject": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "order_date": "<string>",
    "organization": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "planned_receive_date": "<string>",
    "pre_invoices": [
      {
        "document_full_number": "<string>",
        "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "project": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "remind_before": "<string>",
    "responsible": [
      {

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Path Parameters

uuidstringrequired

Record identifier (uuid)

Query Parameters

fieldsstring[]query

Optional response field paths (dot notation for nested groups, e.g. billing_address.street; array fields are returned whole). Comma-separated string is also accepted. Identifier field is always included.

Response

Single record

recordobject

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Show child attributes

Still need help? Ask the team