supplier_orders

Create /supplier_orders

Create a purchase order to a supplier. Required: supplier, warehouse, status, order_date, responsible and items (at least one line). The number is assigned from the tenant's order series; the subtotal is summed from the lines. Line rate (purchase price) needs the order prices permission. Returns record with the detail projection.

POST

/supplier_orders

curl --request POST \
  --url https://default.hannacrm.app/api/v4/supplier_orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "comment": "<string>",
  "confirmed_order_pick_date": "<string>",
  "contact_person": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "<string>",
  "custom_fields": [
    {
      "slug": "<string>",
      "value": "<any>"
    }
  ],
  "delivery_address": "<string>",
  "delivery_type": "<string>",
  "item_arrival_date": "<string>",
  "items": [
    {
      "comment": "<string>",
      "description": "<string>",
      "item": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "item_code": "<string>",
      "planned_receive_date": "2023-12-25",
      "qty": 123,
      "rate": 123,
      "supplier_code": "<string>",
      "unit": "<string>",
      "vat_percent": 123
    }
  ],
  "link_1": "<string>",
  "link_2": "<string>",
  "link_3": "<string>",
  "note": "<string>",
  "note_en": "<string>",
  "order_date": "<string>",
  "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "planned_receive_date": "<string>",
  "project": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "remind_before": 123,
  "responsible": [
    "<string>"
  ],
  "status": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "supplier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "warehouse": "<string>"
}
'

{
  "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.

Body

clientstring

Client UUID the goods are ordered for.

commentstring

Comment.

confirmed_order_pick_datestring

Confirmed pick-up date (Y-m-d).

contact_personstring

Contact person UUID.

currencystring

Currency name (e.g. EUR). Tenant default when omitted on create.

custom_fieldsobject[]

Custom field values by slug.

Show child attributes

delivery_addressstring

Delivery address.

delivery_typestring

warehouse (to our warehouse) or contact (straight to the client).

item_arrival_datestring

Goods arrival date (Y-m-d).

itemsobject[]required

Order lines; at least one. Each needs qty and item (catalog UUID, which fills code, description, unit, purchase price and VAT) or description. rate (purchase price, excl. VAT) needs the order purchase price permission.

Show child attributes

link_1string

Link 1.

link_2string

Link 2.

link_3string

Link 3.

notestring

Note.

note_enstring

Note in English.

order_datestringrequired

Order date (Y-m-d).

organizationstring

Organization UUID. The user's default organization when omitted on create.

planned_receive_datestring

Planned receive date (Y-m-d).

projectstring

Project UUID.

remind_beforeinteger

Remind this many days before the confirmed pick-up date.

responsiblestring[]required

Responsible staff UUIDs. On update the list replaces the current one.

statusstringrequired

Order status: picklist orders / order_statuses value UUID (GET /api/v4/picklists?filter[module]=orders). A change runs what the CRM runs on it: tasks from the status templates and, where enabled, the accounting export.

supplierstringrequired

Supplier (client) UUID.

warehousestringrequired

Warehouse UUID (or codename).

Response

Success

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