Skip to main content
PUT
/
purchase_orders
/
{id}
Error
A valid request URL is required to generate request examples
{
  "id": 123,
  "rev_num": "<string>",
  "last_revision_num": "<string>",
  "project_id": 123,
  "creator_id": 123,
  "label": "<string>",
  "status": "draft",
  "common_status": "draft",
  "project_name": "<string>",
  "purchase_order_date": "2023-12-25",
  "delivery_date": "2023-12-25",
  "ship_via": "<string>",
  "note": "<string>",
  "payment_terms": "<string>",
  "currency": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "vendor_id": 123,
  "vendor_address_id": 123,
  "vendor_contact_id": 123,
  "shipping_client_id": 123,
  "shipping_client_address_id": 123,
  "shipping_client_contact_id": 123,
  "billing_client_id": 123,
  "billing_client_address_id": 123,
  "billing_client_contact_id": 123,
  "vendor": {
    "id": 123,
    "name": "<string>",
    "data": {},
    "addresses": [
      {
        "id": 123,
        "name": "<string>",
        "phone": "<string>",
        "post_code": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      }
    ],
    "people": [
      {
        "id": 123,
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "position": "<string>",
        "note": "<string>"
      }
    ],
    "category": {
      "id": 123,
      "type": "client"
    }
  },
  "shipping_client": {
    "id": 123,
    "name": "<string>",
    "data": {},
    "addresses": [
      {
        "id": 123,
        "name": "<string>",
        "phone": "<string>",
        "post_code": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      }
    ],
    "people": [
      {
        "id": 123,
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "position": "<string>",
        "note": "<string>"
      }
    ],
    "category": {
      "id": 123,
      "type": "client"
    }
  },
  "billing_client_client": {
    "id": 123,
    "name": "<string>",
    "data": {},
    "addresses": [
      {
        "id": 123,
        "name": "<string>",
        "phone": "<string>",
        "post_code": "<string>",
        "address_line_1": "<string>",
        "address_line_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>"
      }
    ],
    "people": [
      {
        "id": 123,
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "position": "<string>",
        "note": "<string>"
      }
    ],
    "category": {
      "id": 123,
      "type": "client"
    }
  },
  "amount": 123,
  "total": 123,
  "shipping_cost": 123,
  "packing_cost": 123,
  "duties_cost": 123,
  "install_cost": 123,
  "other_cost": 123,
  "sales_tax": 123,
  "invoiced_amount": 123,
  "paid_amount": 123,
  "due_amount": 123,
  "items": [
    {
      "id": 123,
      "name": "<string>",
      "description": "<string>",
      "unit_type": "<string>",
      "quantity": 123,
      "price": 123,
      "taxable": true,
      "second_taxable": true,
      "project_item_id": 123
    }
  ],
  "client_invoice_ids": [
    123
  ],
  "supplier_invoice_ids": [
    123
  ],
  "shipment_ids": [
    123
  ]
}

Authorizations

authorization
string
header
required

Path Parameters

id
string
required

Body

application/json
items
object[]
label
string
vendor_id
integer
shipping_client_id
integer
billing_client_id
integer
notes
string
shipping_cost
number
packing_cost
number
duties_cost
number
install_cost
number
sales_tax
number
other_cost
number

Response

OK

id
integer
rev_num
string | null
last_revision_num
string | null
project_id
integer
creator_id
integer
label
string
status
enum<string>
Available options:
draft,
open,
closed,
approved,
rejected,
review
common_status
enum<string>
Available options:
draft,
review,
approved,
rejected,
open,
shipment_created,
arrival_expected,
received_partially,
closed
project_name
string
purchase_order_date
string<date> | null
delivery_date
string<date> | null
ship_via
string | null
note
string | null
payment_terms
string | null
currency
string
created_at
string<date-time>
updated_at
string<date-time>
vendor_id
integer
vendor_address_id
integer | null
vendor_contact_id
integer | null
shipping_client_id
integer | null
shipping_client_address_id
integer | null
shipping_client_contact_id
integer | null
billing_client_id
integer | null
billing_client_address_id
integer | null
billing_client_contact_id
integer | null
vendor
object
shipping_client
object
billing_client_client
object
amount
number
total
number
shipping_cost
number
packing_cost
number
duties_cost
number
install_cost
number
other_cost
number
sales_tax
number
invoiced_amount
number
paid_amount
number
due_amount
number
items
object[]
client_invoice_ids
integer[]
supplier_invoice_ids
integer[]
shipment_ids
integer[]