Skip to main content
GET
Error

Authorizations

authorization
string
header
required

Query Parameters

project_id
integer[]
page
string
default:1
per_page
integer
default:25
Required range: 1 <= x <= 100
since
since_updated_at_date
string
status
enum<string>[]
Available options:
draft,
open,
closed,
approved,
rejected,
review,
voided

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,
review,
approved,
rejected,
open,
shipment_created,
arrival_expected,
received_partially,
closed
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
sent_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 | null
billing_client_client
object | null
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[]