Endpoint: GET /api/v3/purchase-orders
Purpose
Retrieve a list of purchase orders and their details, enabling the review of order information and management of procurement processes.
Use Case
This endpoint is used to fetch information about purchase orders, including their unique identifiers, order statuses, and related item details. It is commonly used in procurement systems for tracking and managing supplier transactions.
Query Parameters
- limit: (Optional) Maximum number of records to return.
- offset: (Optional) Starting index for the records to be retrieved.
- filter: (Optional) Apply filters to narrow down the result set based on conditions.
- fields: (Optional) Specify which fields should be included in the response.
- order: (Optional) Sorting order of the results, e.g., ascending or descending.
Request Data
The endpoint does not require a request body. Ensure to include valid authorization headers.
Response
The response returns a collection of purchase orders along with their relevant details. Each purchase order includes a unique identifier, the current status, order creation date, and related metadata. Items within the purchase orders are also listed, including their unique item identifiers, names, quantities ordered, and received quantities. Pagination details such as the total number of records, limit, and offset values are provided to help manage large datasets effectively.
{
"purchase_orders": [
{
"status": "STATUS",
"id": "PURCHASE_ORDER_ID",
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_NAME",
"link": "CURRENCY_LINK"
},
"supplier_invoice_id": "SUPPLIER_INVOICE_ID",
"issue_date": "ISSUE_DATE",
"due_date": "DUE_DATE",
"expected_completion_date": "EXPECTED_COMPLETION_DATE",
"subtotal": "SUBTOTAL",
"tax": "TAX",
"total": "TOTAL",
"price_tax_inclusive": "PRICE_TAX_INCLUSIVE",
"purchase_order_note": "PURCHASE_ORDER_NOTE",
"account_id": "ACCOUNT_ID",
"created_by": "CREATED_BY",
"created_on": "CREATED_ON",
"last_updated_by": "LAST_UPDATED_BY",
"last_updated_on": "LAST_UPDATED_ON",
"uuid": "PURCHASE_ORDER_UUID",
"version": "VERSION",
"custom_attributes": [
{
"name": "CUSTOM_ATTRIBUTE_NAME",
"value": "CUSTOM_ATTRIBUTE_VALUE"
}
],
"custom_objects": [],
"lines": [
{
"subtotal": "LINE_SUBTOTAL",
"total": "LINE_TOTAL",
"tax": "LINE_TAX",
"item_uuid": "ITEM_UUID",
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_quantity": "ITEM_QUANTITY",
"item_price_snapshot": {
"pricing_rule": {
"uuid": "PRICING_RULE_UUID",
"version": "PRICING_RULE_VERSION",
"price_type": "PRICE_TYPE",
"price": "PRICE",
"uom": "UOM",
"warehouse": "WAREHOUSE",
"pricing_version": "PRICING_VERSION"
}
},
"item_purchase_tax_configuration": {
"purchase_price_is_tax_inclusive": "PURCHASE_PRICE_TAX_INCLUSIVE",
"tax_code": {
"uuid": "TAX_CODE_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_CODE_LINK"
}
},
"item_price_tax_exempt": "ITEM_PRICE_TAX_EXEMPT",
"item_price_tax": {
"uuid": "TAX_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
},
"purchase_order_note": "LINE_PURCHASE_ORDER_NOTE",
"item_accounting_code": {
"cost_of_goods_sold": "COST_OF_GOODS_SOLD_CODE"
},
"uuid": "LINE_UUID",
"version": "LINE_VERSION"
}
],
"kpis": {
"total_expense": "TOTAL_EXPENSE",
"estimated_total": "ESTIMATED_TOTAL",
"total_outstanding": "TOTAL_OUTSTANDING",
"total_overdue": "TOTAL_OVERDUE",
"last_invoice_issue_date": "LAST_INVOICE_ISSUE_DATE",
"last_invoice_total": "LAST_INVOICE_TOTAL",
"total_purchase_invoice": "TOTAL_PURCHASE_INVOICE",
"last_reactivated_on": "LAST_REACTIVATED_ON",
"last_calcelled_on": "LAST_CANCELLED_ON",
"last_changed_on": "LAST_CHANGED_ON",
"last_deleted_on": "LAST_DELETED_ON",
"issue_date": "ISSUE_DATE"
}
}
],
"pagination": {
"records": "TOTAL_RECORDS",
"limit": "LIMIT",
"offset": "OFFSET",
"previous_page": "PREVIOUS_PAGE_LINK",
"next_page": "NEXT_PAGE_LINK"
}
}
Endpoint: GET/api/v3/purchase-orders/{id}
Purpose
Retrieve detailed information about a specific purchase order, including its status, line items, and financial details.
Use Case
This endpoint is used to fetch comprehensive details of a specific purchase order identified by its unique ID. It provides information about the purchase order's metadata, associated items, and financial metrics, enabling efficient management of procurement processes.
Request Data
|
Field |
Type |
Description |
|---|---|---|
|
id |
string |
The unique identifier of the purchase order. |
Response
The response provides detailed information about the specified purchase order, including its unique ID, status, associated account, currency, subtotal, tax, total, and line items. The response includes detailed information about the purchase order, such as its unique ID, status, associated account, currency, subtotal, tax, and total. The line items section provides details of each item, including their unique identifiers, names, quantities, and pricing snapshots. The KPIs summarize financial and operational metrics for the purchase order, including total expenses and outstanding amounts.
{
"purchase_order": {
"status": "STATUS",
"id": "PURCHASE_ORDER_ID",
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_NAME",
"link": "CURRENCY_LINK"
},
"supplier_invoice_id": "SUPPLIER_INVOICE_ID",
"issue_date": "ISSUE_DATE",
"due_date": "DUE_DATE",
"expected_completion_date": "EXPECTED_COMPLETION_DATE",
"subtotal": "SUBTOTAL_AMOUNT",
"tax": "TAX_AMOUNT",
"total": "TOTAL_AMOUNT",
"price_tax_inclusive": "IS_TAX_INCLUSIVE",
"purchase_order_note": "NOTE",
"account_id": "ACCOUNT_ID",
"created_by": "CREATOR_NAME",
"created_on": "CREATION_TIMESTAMP",
"last_updated_by": "UPDATED_BY",
"last_updated_on": "UPDATED_TIMESTAMP",
"uuid": "PURCHASE_ORDER_UUID",
"version": "VERSION",
"custom_attributes": [
{
"name": "ATTRIBUTE_NAME",
"value": "ATTRIBUTE_VALUE"
}
],
"custom_objects": [],
"lines": [
{
"subtotal": "LINE_SUBTOTAL",
"total": "LINE_TOTAL",
"tax": "LINE_TAX",
"item_uuid": "ITEM_UUID",
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_quantity": "ITEM_QUANTITY",
"item_price_snapshot": {
"pricing_rule": {
"uuid": "PRICING_RULE_UUID",
"version": "PRICING_VERSION",
"price_type": "PRICE_TYPE",
"price": "PRICE_AMOUNT",
"uom": "UNIT_OF_MEASURE",
"warehouse": "WAREHOUSE_NAME",
"pricing_version": "PRICING_VERSION",
"latest_used_pricing_version": "LATEST_USED_VERSION"
}
},
"item_purchase_tax_configuration": {
"purchase_price_is_tax_inclusive": "IS_TAX_INCLUSIVE",
"tax_code": {
"uuid": "TAX_CODE_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
}
},
"item_price_tax_exempt": "IS_TAX_EXEMPT",
"item_price_tax": {
"uuid": "ITEM_TAX_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
},
"purchase_order_note": "LINE_NOTE",
"item_accounting_code": {
"cost_of_goods_sold": "ACCOUNT_CODE"
},
"uuid": "LINE_UUID",
"version": "LINE_VERSION"
}
],
"kpis": {
"total_expense": "TOTAL_EXPENSE",
"estimated_total": "ESTIMATED_TOTAL",
"total_outstanding": "OUTSTANDING_AMOUNT",
"total_overdue": "OVERDUE_AMOUNT",
"last_invoice_issue_date": "LAST_INVOICE_DATE",
"last_invoice_total": "LAST_INVOICE_TOTAL",
"total_purchase_invoice": "TOTAL_INVOICE_COUNT",
"last_reactivated_on": "LAST_REACTIVATED_DATE",
"last_calcelled_on": "LAST_CANCELLED_DATE",
"last_changed_on": "LAST_CHANGED_DATE",
"last_deleted_on": "LAST_DELETED_DATE",
"issue_date": "ISSUE_DATE"
}
}
}
Endpoint: GET/api/v3/purchase-orders/{id}/information
Purpose
Retrieve detailed information about a specific purchase order, including its status, metadata, and custom attributes.
Use Case
This endpoint is used to fetch comprehensive details of a specific purchase order identified by its unique ID. It is commonly utilized in procurement and order management systems to track and manage purchase order data.
Request Data
|
Field |
Type |
Description |
|---|---|---|
|
id |
string |
The unique identifier of the purchase order. |
Response
The response provides details about the purchase order, including its status, associated account, financial metrics, and custom attributes. The response includes detailed information about the purchase order, such as its unique ID, status, associated account, currency, subtotal, tax, and total. Additionally, it contains metadata about the purchase order, including the creator's information and timestamps. The custom_attributes field provides a list of user-defined attributes associated with the purchase order.
{
"purchase_order": {
"status": "STATUS",
"id": "PURCHASE_ORDER_ID",
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_NAME",
"link": "CURRENCY_LINK"
},
"supplier_invoice_id": "SUPPLIER_INVOICE_ID",
"issue_date": "ISSUE_DATE",
"due_date": "DUE_DATE",
"expected_completion_date": "EXPECTED_COMPLETION_DATE",
"subtotal": "SUBTOTAL_AMOUNT",
"tax": "TAX_AMOUNT",
"total": "TOTAL_AMOUNT",
"price_tax_inclusive": "IS_TAX_INCLUSIVE",
"purchase_order_note": "NOTE",
"account_id": "ACCOUNT_ID",
"created_by": "CREATOR_NAME",
"created_on": "CREATION_TIMESTAMP",
"last_updated_by": "UPDATED_BY",
"last_updated_on": "UPDATED_TIMESTAMP",
"uuid": "PURCHASE_ORDER_UUID",
"version": "VERSION",
"custom_attributes": [
{
"name": "ATTRIBUTE_NAME",
"value": "ATTRIBUTE_VALUE"
}
],
"custom_objects": []
}
}
Endpoint: GET /api/v3/purchase-orders/{id}/lines
Purpose
Retrieve the line items associated with a specific purchase order, including details about each item such as quantity, pricing, and tax configuration.
Use Case
This endpoint is used to fetch the line items of a specific purchase order, allowing users to view detailed information about the items included in the order. It is commonly utilized for procurement management and financial tracking.
Request Data
|
Field |
Type |
Description |
|---|---|---|
|
id |
string |
The unique identifier of the purchase order. |
Response
The response contains the details of the line items associated with the specified purchase order, including metadata and pricing information. The response includes detailed information about the line items in the specified purchase order: Includes the subtotal, total, tax, item ID, name, quantity, and unique identifiers for each line item. Provides the pricing rule, price type, unit of measure, warehouse details, and pricing version. Contains information about the tax configuration, including whether the purchase price includes tax, tax code, and rate.
{
"purchase_order": {
"lines": [
{
"subtotal": "LINE_SUBTOTAL",
"total": "LINE_TOTAL",
"tax": "LINE_TAX",
"item_uuid": "ITEM_UUID",
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_quantity": "ITEM_QUANTITY",
"item_price_snapshot": {
"pricing_rule": {
"uuid": "PRICING_RULE_UUID",
"version": "PRICING_VERSION",
"price_type": "PRICE_TYPE",
"price": "ITEM_PRICE",
"uom": "UNIT_OF_MEASURE",
"warehouse": "WAREHOUSE_NAME",
"pricing_version": "PRICING_VERSION",
"latest_used_pricing_version": "LATEST_USED_VERSION"
}
},
"item_purchase_tax_configuration": {
"purchase_price_is_tax_inclusive": "IS_TAX_INCLUSIVE",
"tax_code": {
"uuid": "TAX_CODE_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
}
},
"item_price_tax_exempt": "IS_TAX_EXEMPT",
"item_price_tax": {
"uuid": "ITEM_TAX_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
},
"purchase_order_note": "NOTE",
"item_accounting_code": {
"cost_of_goods_sold": "ACCOUNT_CODE"
},
"uuid": "LINE_UUID",
"version": "LINE_VERSION"
}
]
}
}
Endpoint: GET /api/v3/purchase-orders/{id}/lines/{uuid}
Purpose
Retrieve details of a specific line item within a purchase order, including pricing, tax configuration, and metadata.
Use Case
This endpoint is used to fetch comprehensive details about a single line item in a purchase order, identified by the line item UUID. It is commonly utilized for procurement analysis, auditing, and inventory tracking.
Request Data
| Field | Type | Description |
|---|---|---|
| id | string | The unique identifier of the purchase order. |
| uuid | string | The unique identifier of the line item. |
Response
The response provides detailed information about the specified line item in the purchase order. This includes the subtotal, total, and tax amounts for the item, along with metadata such as the item ID, name, and quantity. Pricing details are provided through a snapshot of the pricing rule, including the price type, value, and associated warehouse. Tax configuration details specify whether the item price is tax-inclusive, the tax rate, and the relevant tax code. The response also includes metadata like the purchase order note, accounting codes, and versioning details of the line item.
{
"purchase_order": {
"line": {
"subtotal": "LINE_SUBTOTAL",
"total": "LINE_TOTAL",
"tax": "LINE_TAX",
"item_uuid": "ITEM_UUID",
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_quantity": "ITEM_QUANTITY",
"item_price_snapshot": {
"pricing_rule": {
"uuid": "PRICING_RULE_UUID",
"version": "PRICING_RULE_VERSION",
"price_type": "PRICE_TYPE",
"price": "PRICE_VALUE",
"uom": "UNIT_OF_MEASURE",
"warehouse": "WAREHOUSE_NAME",
"pricing_version": "PRICING_VERSION",
"latest_used_pricing_version": "LATEST_USED_VERSION"
}
},
"item_purchase_tax_configuration": {
"purchase_price_is_tax_inclusive": "IS_TAX_INCLUSIVE",
"tax_code": {
"uuid": "TAX_CODE_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
}
},
"item_price_tax_exempt": "IS_TAX_EXEMPT",
"item_price_tax": {
"uuid": "ITEM_TAX_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
},
"purchase_order_note": "NOTE",
"item_accounting_code": {
"cost_of_goods_sold": "ACCOUNT_CODE"
},
"uuid": "LINE_UUID",
"version": "LINE_VERSION"
}
}
}
Endpoint: GET /api/v3/accounts/{id}/purchase-orders
Purpose
Retrieve all purchase orders associated with a specific account, including details about the orders, items, and financial metrics.
Use Case
This endpoint is used to fetch a list of purchase orders linked to a specific account. It provides comprehensive details about each order, including metadata, custom attributes, line items, and KPIs, enabling effective account and procurement management.
Request Data
| Field | Type | Description |
|---|---|---|
| id | string | The unique identifier of the account. |
Response
The response includes a list of purchase orders associated with the specified account. Each purchase order contains details such as its ID, status, currency, supplier invoice ID, issue and due dates, expected completion date, subtotal, tax, total amount, and custom attributes. Line items within the orders include metadata such as item IDs, names, quantities, pricing snapshots, and tax configurations. Additionally, KPIs summarize financial and operational metrics for each purchase order. Pagination details are provided to navigate through the results.
{
"account": {
"purchase_orders": [
{
"status": "STATUS",
"id": "PURCHASE_ORDER_ID",
"currency": {
"uuid": "CURRENCY_UUID",
"name": "CURRENCY_NAME",
"link": "CURRENCY_LINK"
},
"supplier_invoice_id": "SUPPLIER_INVOICE_ID",
"issue_date": "ISSUE_DATE",
"due_date": "DUE_DATE",
"expected_completion_date": "EXPECTED_COMPLETION_DATE",
"subtotal": "SUBTOTAL",
"tax": "TAX_AMOUNT",
"total": "TOTAL_AMOUNT",
"price_tax_inclusive": "IS_TAX_INCLUSIVE",
"purchase_order_note": "NOTE",
"account_id": "ACCOUNT_ID",
"created_by": "CREATED_BY",
"created_on": "CREATION_TIMESTAMP",
"last_updated_by": "UPDATED_BY",
"last_updated_on": "UPDATED_TIMESTAMP",
"uuid": "PURCHASE_ORDER_UUID",
"version": "VERSION",
"custom_attributes": [
{
"name": "ATTRIBUTE_NAME",
"value": "ATTRIBUTE_VALUE"
}
],
"custom_objects": [],
"lines": [
{
"subtotal": "LINE_SUBTOTAL",
"total": "LINE_TOTAL",
"tax": "LINE_TAX",
"item_uuid": "ITEM_UUID",
"item_id": "ITEM_ID",
"item_name": "ITEM_NAME",
"item_quantity": "ITEM_QUANTITY",
"item_price_snapshot": {
"pricing_rule": {
"uuid": "PRICING_RULE_UUID",
"version": "PRICING_VERSION",
"price_type": "PRICE_TYPE",
"price": "ITEM_PRICE",
"uom": "UNIT_OF_MEASURE",
"warehouse": "WAREHOUSE_NAME"
}
},
"item_purchase_tax_configuration": {
"purchase_price_is_tax_inclusive": "IS_TAX_INCLUSIVE",
"tax_code": {
"uuid": "TAX_CODE_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
}
},
"item_price_tax_exempt": "IS_TAX_EXEMPT",
"item_price_tax": {
"uuid": "ITEM_TAX_UUID",
"code": "TAX_CODE",
"rate": "TAX_RATE",
"link": "TAX_LINK"
},
"uuid": "LINE_UUID",
"version": "LINE_VERSION"
}
],
"kpis": {
"total_expense": "TOTAL_EXPENSE",
"estimated_total": "ESTIMATED_TOTAL",
"total_outstanding": "OUTSTANDING_AMOUNT",
"total_overdue": "OVERDUE_AMOUNT",
"last_invoice_issue_date": "LAST_INVOICE_DATE",
"last_invoice_total": "LAST_INVOICE_TOTAL",
"total_purchase_invoice": "TOTAL_PURCHASE_INVOICES",
"last_reactivated_on": "LAST_REACTIVATED_DATE",
"last_calcelled_on": "LAST_CANCELLED_DATE",
"last_changed_on": "LAST_CHANGED_DATE",
"last_deleted_on": "LAST_DELETED_DATE"
}
}
],
"pagination": {
"records": "TOTAL_RECORDS",
"limit": "RESULTS_LIMIT",
"offset": "OFFSET_VALUE",
"previous_page": "PREVIOUS_PAGE_LINK",
"next_page": "NEXT_PAGE_LINK"
}
}
}