Appearance

List Purchase orders ​

Endpoint ​

http
GET /unified/accounting/purchase_orders
Integrations supported
  • QuickBooks
  • Xero

Query parameters ​

integrated_account_id
string · uuid
REQUIRED · The ID of the integrated account to use for the request.
Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
created_at
string
This represents the date when the purchase order was created
Supported in
  • QuickBooks
  • Xero
updated_at
string
This represents the date when the purchase order was updated
Supported in
  • QuickBooks
status
string
The status of the purchase order
All possible enum values:
  • authorised
  • billed
  • deleted
  • draft
  • submitted
Supported in
  • Xero

Response Body ​

result
object[]
List of Purchase orders
id
string
REQUIRED · The unique identifier for purchase orders
Supported in
  • QuickBooks
  • Xero
status
string
The status of the purchase order
All possible enum values:
  • draft
  • submitted
  • authorised
  • billed
  • deleted
Supported in
  • QuickBooks
  • Xero
issue_date
string
The issue date of the purchase order
Supported in
  • Xero
delivery_date
string
The delivery date of the purchase order
Supported in
  • Xero
delivery_address
string
The delivery address of the purchase order
Supported in
  • QuickBooks
  • Xero
customer
string
The customer contact making the purchase order
vendor
string
The vendor contact fulfilling the purchase order
Supported in
  • QuickBooks
  • Xero
memo
string
The memo of the purchase order
Supported in
  • Xero
total_amount
number
The total amount of the purchase order
Supported in
  • QuickBooks
  • Xero
currency
string
The currency of the purchase order
Supported in
  • QuickBooks
  • Xero
exchange_rate
number
The exchange rate of the purchase order
Supported in
  • Xero
line_items
object[]
Supported in
  • QuickBooks
  • Xero
id
string
The unique identifier for line item
name
string
The name of the line item
description
string
The description of the line item
item
string
The ID of the item
account
string
The ID of the account
quantity
number
The quantity of the line item
unit_price
number
The unit price of the line item
tax_rate
string
The ID of the tax rate
total_line_amount
number
The total line amount of the line item.
type
string
The type of the line item
tracking_categories
object[]
Tracking categories of the line item
id
string
The ID of the tracking category
name
string
The name of the tracking category
option
string
The option of the tracking category
currency
string
The currency of the line item
exchange_rate
number
The exchange rate of the currency for the line item
created_at
string
This represents the date when the purchase order was created
Supported in
  • QuickBooks
  • Xero
updated_at
string
This represents the date when the purchase order was updated
Supported in
  • QuickBooks
  • Xero
remote_data
object
Raw data returned from the remote API call.
next_cursor
string
The cursor to use for the next page of results. Pass this value as `next_cursor` in the query parameter in the next request to get the next page of results.