Error
A valid request URL is required to generate request examples{
"id": 4,
"rev_num": null,
"last_revision_num": null,
"project_id": 5,
"creator_id": 1,
"label": "PO-2",
"status": "draft",
"common_status": "draft",
"project_name": "Sample Project (With Purchasing)",
"purchase_order_date": "2026-08-07",
"sent_date": null,
"delivery_date": null,
"ship_via": null,
"note": null,
"payment_terms": null,
"currency": "USD",
"documents_count": 0,
"created_at": "2026-08-07T12:02:25.837-04:00",
"updated_at": "2026-08-07T12:02:25.837-04:00",
"vendor_id": 12,
"vendor_address_id": 12,
"vendor_contact_id": null,
"shipping_client_id": null,
"shipping_client": null,
"shipping_client_address_id": null,
"shipping_client_contact_id": null,
"billing_client_id": null,
"billing_client": null,
"billing_client_address_id": null,
"billing_client_contact_id": null,
"amount": 0,
"total": 0,
"shipping_cost": 0,
"packing_cost": 0,
"duties_cost": 0,
"install_cost": 0,
"other_cost": 0,
"sales_tax": 0,
"invoiced_amount": 0,
"paid_amount": 0,
"due_amount": 0,
"items": [
{
"id": 35,
"name": "",
"description": "",
"unit_type": null,
"quantity": 1,
"price": 0,
"taxable": false,
"second_taxable": false,
"received": 0,
"shipped": 0,
"project_item_id": 52
}
],
"vendor": {
"id": 12,
"name": "Sample supplier",
"data": {
"notes": {
"value": {
"value": "This is a sample supplier"
}
},
"account": {
"value": {
"vat": null,
"terms": null,
"currency": "USD",
"lead_time": null,
"credit_limit": null,
"account_number": null,
"registration_number": null
}
},
"address": {
"value": [
{
"id": 12,
"city": "New York",
"name": "Sample First Name Sample Last Name",
"phone": "0123456789",
"state": "New York",
"country": "United States of America",
"contacts": {
"value": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"note": "This is a sample supplier",
"email": "info_1@supplier.com",
"phone": "0123456789",
"position": null,
"priority": "primary"
}
]
},
"priority": "primary",
"post_code": "10001",
"address_line_1": "A street address",
"address_line_2": null,
"team_region_id": null
}
]
},
"company_details": {
"value": {
"email": "info_1@supplier.com",
"status": "Approved",
"website": "www.supplier.com",
"language": null,
"password": "Password",
"user_name": "Username",
"company_name": "Sample supplier"
}
}
},
"addresses": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"phone": "0123456789",
"postcode": "10001",
"address_line_1": "A street address",
"address_line_2": null,
"city": "New York",
"state": "New York",
"country": "United States of America"
}
],
"people": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"email": "info_1@supplier.com",
"phone": "0123456789",
"position": null,
"note": "This is a sample supplier"
}
],
"categories": [
{
"id": 2,
"type": "supplier"
}
]
},
"client_invoice_ids": [],
"supplier_invoice_ids": [],
"shipment_ids": []
}{
"error": "Bad Request: <description>"
}{
"error": "Unauthorized"
}{
"error": "Forbidden"
}Purchase Order
Creates a purchase order
POST
/
purchase_orders
Error
A valid request URL is required to generate request examples{
"id": 4,
"rev_num": null,
"last_revision_num": null,
"project_id": 5,
"creator_id": 1,
"label": "PO-2",
"status": "draft",
"common_status": "draft",
"project_name": "Sample Project (With Purchasing)",
"purchase_order_date": "2026-08-07",
"sent_date": null,
"delivery_date": null,
"ship_via": null,
"note": null,
"payment_terms": null,
"currency": "USD",
"documents_count": 0,
"created_at": "2026-08-07T12:02:25.837-04:00",
"updated_at": "2026-08-07T12:02:25.837-04:00",
"vendor_id": 12,
"vendor_address_id": 12,
"vendor_contact_id": null,
"shipping_client_id": null,
"shipping_client": null,
"shipping_client_address_id": null,
"shipping_client_contact_id": null,
"billing_client_id": null,
"billing_client": null,
"billing_client_address_id": null,
"billing_client_contact_id": null,
"amount": 0,
"total": 0,
"shipping_cost": 0,
"packing_cost": 0,
"duties_cost": 0,
"install_cost": 0,
"other_cost": 0,
"sales_tax": 0,
"invoiced_amount": 0,
"paid_amount": 0,
"due_amount": 0,
"items": [
{
"id": 35,
"name": "",
"description": "",
"unit_type": null,
"quantity": 1,
"price": 0,
"taxable": false,
"second_taxable": false,
"received": 0,
"shipped": 0,
"project_item_id": 52
}
],
"vendor": {
"id": 12,
"name": "Sample supplier",
"data": {
"notes": {
"value": {
"value": "This is a sample supplier"
}
},
"account": {
"value": {
"vat": null,
"terms": null,
"currency": "USD",
"lead_time": null,
"credit_limit": null,
"account_number": null,
"registration_number": null
}
},
"address": {
"value": [
{
"id": 12,
"city": "New York",
"name": "Sample First Name Sample Last Name",
"phone": "0123456789",
"state": "New York",
"country": "United States of America",
"contacts": {
"value": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"note": "This is a sample supplier",
"email": "info_1@supplier.com",
"phone": "0123456789",
"position": null,
"priority": "primary"
}
]
},
"priority": "primary",
"post_code": "10001",
"address_line_1": "A street address",
"address_line_2": null,
"team_region_id": null
}
]
},
"company_details": {
"value": {
"email": "info_1@supplier.com",
"status": "Approved",
"website": "www.supplier.com",
"language": null,
"password": "Password",
"user_name": "Username",
"company_name": "Sample supplier"
}
}
},
"addresses": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"phone": "0123456789",
"postcode": "10001",
"address_line_1": "A street address",
"address_line_2": null,
"city": "New York",
"state": "New York",
"country": "United States of America"
}
],
"people": [
{
"id": 12,
"name": "Sample First Name Sample Last Name",
"email": "info_1@supplier.com",
"phone": "0123456789",
"position": null,
"note": "This is a sample supplier"
}
],
"categories": [
{
"id": 2,
"type": "supplier"
}
]
},
"client_invoice_ids": [],
"supplier_invoice_ids": [],
"shipment_ids": []
}{
"error": "Bad Request: <description>"
}{
"error": "Unauthorized"
}{
"error": "Forbidden"
}Authorizations
Body
application/json
Show child attributes
Show child attributes
Response
Created
Available options:
draft, review, approved, rejected, open, shipment_created, arrival_expected, received_partially, closed Available options:
draft, review, approved, rejected, open, shipment_created, arrival_expected, received_partially, closed Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I