Purchase Order GET API Documentation

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.

                JSON
              

                      {
    "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.

                JSON
              

                      {
    "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"
        }
    }
}

                    

Purpose

Fetches detailed information about a specific purchase order by its unique ID. This includes metadata, financial details, currency used, and associated custom elements.

Use Case

This endpoint is used by procurement, finance, or integration systems to:

Retrieve the latest data for a specific purchase order.
View pricing breakdown and tax inclusion status.
Display metadata (issue/due dates, creator, version).
Reference currency and account details.
Load custom attributes or objects linked to the purchase order.

Path Parameter

Name	Type	Required	Description
id	String	Yes	Unique ID of the purchase order.

Query Parameter

No query parameters required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

The response returns a single purchase order object that includes detailed information such as status, unique ID, currency, supplier invoice reference, and key dates like issue date, due date, and expected completion date. It also contains financial data such as subtotal, tax, total, and a flag indicating whether prices are tax inclusive. Additional metadata includes account ID, creator details, timestamps for creation and last update, a version number, and a system-generated UUID. Custom fields and linked objects are returned as empty arrays unless configured. The currency field includes its own metadata, including UUID, name, and a direct API link.

Response Body

                JSON
              

                      {
    "purchase_order": {
        "status": "ACTIVE",
        "id": "PO-DQLP9B-0003",
        "currency": {
            "uuid": "4f444464-defa-4180-a18e-e2bf4b5a84a1",
            "name": "AUD",
            "link": "https://dev-api.exsited.com/api/v1/currencies/4f444464-defa-4180-a18e-e2bf4b5a84a1"
        },
        "supplier_invoice_id": "",
        "issue_date": "2025-07-29T00:00:00Z",
        "due_date": "2025-07-29T00:00:00Z",
        "expected_completion_date": "2025-07-29T00:00:00Z",
        "subtotal": "100.000000",
        "tax": "0.000000",
        "total": "100.000000",
        "price_tax_inclusive": "true",
        "purchase_order_note": "",
        "account_id": "DQLP9B",
        "created_by": "Implementer",
        "created_on": "2025-07-29T11:01:33Z",
        "last_updated_by": "",
        "last_updated_on": "2025-07-29T11:01:33Z",
        "uuid": "b9a9c19c-16d8-4b72-89a2-5438d0bb847b",
        "version": "3",
        "custom_attributes": [],
        "custom_objects": []
    }
}
                    

Attribute	Type	Description
status	String	Current status of the purchase order (e.g., `ACTIVE`)
id	String	Unique ID of the purchase order
currency	Object	Currency details (uuid, name, link)
supplier_invoice_id	String	External supplier invoice ID, if any
issue_date	String	Date the purchase order was issued (ISO 8601 format)
due_date	String	Due date for the purchase order (ISO 8601 format)
expected_completion_date	String	Expected completion date (ISO 8601 format)
subtotal	String	Subtotal amount (before tax)
tax	String	Tax amount applied
total	String	Total amount (including tax if applicable)
price_tax_inclusive	String	`"true"` if tax is included in item prices, otherwise `"false"`
purchase_order_note	String	Optional internal or external note on the purchase order
account_id	String	ID of the account (buyer or client) associated with the PO
created_by	String	User who created the purchase order
created_on	String	Timestamp of when the PO was created (ISO 8601 format)
last_updated_by	String	User who last updated the PO (empty if no updates)
last_updated_on	String	Timestamp of last update (ISO 8601 format)
uuid	String	System-generated UUID for the PO
version	String	Version number of the PO record
custom_attributes	Array	List of custom attributes applied to the PO (empty in this example)
custom_objects	Array	List of custom objects related to the PO (empty in this example)

Purpose

This endpoint retrieves all individual line items associated with a specific purchase order. Each line item contains detailed product, pricing, and tax-related data relevant for purchase management and financial tracking.

Use Case

Use this endpoint when you need to display, audit, or process the individual items included in a specific purchase order. It's commonly used in procurement workflows, invoicing, stock updates, or cost analysis features where item-level breakdown is necessary.

Path Parameters

Parameter	Type	Description
`id`	string	Unique ID of the purchase order (e.g., `PO-XXXX-0001`).

Query Parameters

This endpoint does not accept any query parameters.

Request Body

No request body is required for this endpoint.

Response

The response returns a purchase_order object that includes a list of lines, where each line represents a product or service included in the purchase order. Each line contains subtotal, total, and tax values, along with item-specific details such as name, quantity, and associated tax configurations. Pricing rules and tax metadata are also included where applicable. The response structure supports extensibility through pricing snapshots and accounting codes, enabling finance teams and systems to process complex cost structures with tax logic included.

Response Body

                JSON
              

                      {
    "purchase_order": {
        "lines": [
            {
                "subtotal": "100.000000",
                "total": "100.000000",
                "tax": "0.000000",
                "item_uuid": "",
                "item_id": "",
                "item_name": "banana",
                "item_quantity": "5.000000",
                "item_price_snapshot": {
                    "pricing_rule": {
                        "uuid": "",
                        "version": "",
                        "price_type": "",
                        "price": "",
                        "uom": "",
                        "warehouse": "",
                        "pricing_version": "",
                        "latest_used_pricing_version": ""
                    }
                },
                "item_purchase_tax_configuration": {
                    "purchase_price_is_tax_inclusive": "false",
                    "tax_code": {
                        "uuid": "58a36f3d-efaa-4ce7-bfc5-ce20c7330e6a",
                        "code": "No Tax",
                        "rate": "0.000000",
                        "link": "https://dev-api.exsited.com/api/v3/settings/taxes/58a36f3d-efaa-4ce7-bfc5-ce20c7330e6a"
                    }
                },
                "item_price_tax_exempt": "false",
                "item_price_tax": {
                    "uuid": "58a36f3d-efaa-4ce7-bfc5-ce20c7330e6a",
                    "code": "No Tax",
                    "rate": "0.000000",
                    "link": "https://dev-api.exsited.com/api/v3/settings/taxes/58a36f3d-efaa-4ce7-bfc5-ce20c7330e6a"
                },
                "purchase_order_note": "",
                "item_accounting_code": {
                    "cost_of_goods_sold": ""
                },
                "uuid": "920c4851-6a33-4cf5-a76b-5bc97648f091",
                "version": "1"
            }
        ]
    }
}
                    

Attribute	Type	Description
`subtotal`	string	Subtotal amount for the line item before tax.
`total`	string	Total amount for the line item including applicable tax.
`tax`	string	Tax amount applied to the line item.
`item_uuid`	string	Unique ID of the item (if applicable).
`item_id`	string	Item ID from catalog (if available).
`item_name`	string	Name of the purchased item.
`item_quantity`	string	Quantity of the item ordered.
`item_price_snapshot`	object	Snapshot of pricing rule details used at the time of order.
`item_purchase_tax_configuration`	object	Contains tax configuration settings for the item.
`item_price_tax_exempt`	string	Boolean string indicating if item is exempt from tax.
`item_price_tax`	object	Tax object applied to the item (uuid, code, rate, link).
`purchase_order_note`	string	Any note associated with this line item in the purchase order.
`item_accounting_code`	object	Contains the accounting code for cost of goods sold.
`uuid`	string	Unique system identifier for this line item.
`version`	string	Version of the line item record.

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.

                JSON
              

                      {
    "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.

                JSON
              

                      {
    "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"
        }
    }
}

                    

Purpose

Retrieve all notes linked to a specific purchase order, including their metadata, content, attached files, and audit information.

Use Case

View all comments, remarks, or instructions logged against a purchase order.
Access files (example: images, receipts, scanned approvals) attached to notes.
Support collaboration and auditing for procurement processes.

Path Parameters

Parameter	Type	Required	Description
purchase_order_id	string	Yes	Unique identifier of the purchase order.

Query Parameters

Parameter	Type	Required	Description
limit	integer	No	Maximum number of records to return (default: 20).
offset	integer	No	Number of records to skip (default: 0).

Request Body

No data is required for the request body.

Response

On success, the API returns a purchase_order object containing a list of notes. Each note includes its unique identifier, version, content (HTML-supported), audit metadata (creator and timestamps), and any attached files. Pagination metadata is also provided to navigate through large result sets.

Response Body

                JSON
              

                      {
    "purchase_order": {
        "notes": [
            {
                "uuid": "{{NOTE_UUID}}",
                "version": "1",
                "content": "<p>{{NOTE_CONTENT}}</p>",
                "files": [
                    {
                        "uuid": "{{FILE_UUID}}",
                        "name": "{{FILE_NAME}}",
                        "version": "1"
                    }
                ],
                "created_by": "{{CREATED_BY}}",
                "created_on": "{{CREATED_ON}}",
                "last_updated_by": "{{LAST_UPDATED_BY}}",
                "last_updated_on": "{{LAST_UPDATED_ON}}",
                "custom_attributes": []
            }
        ],
        "pagination": {
            "records": 1,
            "limit": 20,
            "offset": 0,
            "previous_page": "",
            "next_page": "NULL"
        }
    }
}

                    

Attribute	Type	Description
purchase_order	object	Container holding purchase order data.
purchase_order.notes	array	List of notes for the purchase order.
purchase_order.notes[].uuid	string (UUID)	Unique identifier of the note.
purchase_order.notes[].version	string	Version number of the note (used for concurrency control).
purchase_order.notes[].content	string (HTML)	Note content with HTML formatting supported.
purchase_order.notes[].files	array	Files attached to the note.
purchase_order.notes[].files[].uuid	string (UUID)	Unique identifier of the file.
purchase_order.notes[].files[].name	string	Name of the attached file.
purchase_order.notes[].files[].version	string	Version number of the file.
purchase_order.notes[].created_by	string	User who created the note.
purchase_order.notes[].created_on	string (date-time)	Timestamp when the note was created.
purchase_order.notes[].last_updated_by	string	User who last updated the note (if any).
purchase_order.notes[].last_updated_on	string (date-time)	Timestamp of the last update (if any).
purchase_order.notes[].custom_attributes	array	Custom attributes defined by client configuration.
purchase_order.pagination	object	Pagination metadata.
purchase_order.pagination.records	integer	Total number of records available.
purchase_order.pagination.limit	integer	Maximum number of records returned per request.
purchase_order.pagination.offset	integer	Number of records skipped.
purchase_order.pagination.previous_page	string	Link to the previous page (if available).
purchase_order.pagination.next_page	string/null	Link to the next page (if available).

Purpose

Retrieve details of a specific note within a purchase order by its UUID.

Use Case

Fetch a single note for display or review.
Access metadata and files associated with one note.

Path Parameters

Parameter	Type	Required	Description
purchase_order_id	string	Yes	Unique identifier of the purchase order.
NOTE_UUID	string	Yes	Unique identifier of the note.

Query Parameters

No query parameter is required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

On success, the API returns the details of the specified note, including its unique identifier, version, content, files, and audit details.

Response Body

                JSON
              

                      {
    "purchase_order": {
        "note": {
            "uuid": "{{NOTE_UUID}}",
            "version": "1",
            "content": "<p>{{NOTE_CONTENT}}</p>",
            "files": [
                {
                    "uuid": "{{FILE_UUID}}",
                    "name": "{{FILE_NAME}}",
                    "version": "1"
                }
            ],
            "created_by": "{{CREATED_BY}}",
            "created_on": "{{CREATED_ON}}",
            "last_updated_by": "{{LAST_UPDATED_BY}}",
            "last_updated_on": "{{LAST_UPDATED_ON}}",
            "custom_attributes": []
        }
    }
}

                    

Attribute	Type	Description
purchase_order	object	Container holding purchase order data.
purchase_order.note	object	The requested note.
purchase_order.note.uuid	string (UUID)	Unique identifier of the note.
purchase_order.note.version	string	Version number of the note.
purchase_order.note.content	string (HTML)	Note content.
purchase_order.note.files	array	Attached files.
purchase_order.note.files[].uuid	string (UUID)	Unique identifier of the file.
purchase_order.note.files[].name	string	File name.
purchase_order.note.files[].version	string	File version.
purchase_order.note.created_by	string	User who created the note.
purchase_order.note.created_on	string (date-time)	Creation timestamp.
purchase_order.note.last_updated_by	string	User who last updated the note.
purchase_order.note.last_updated_on	string (date-time)	Last update timestamp.
purchase_order.note.custom_attributes	array	Custom attributes if defined.

Purpose

Retrieve all files attached to a specific note of a purchase order.

Use Case

Fetch supporting documents linked to a note.
Display file attachments associated with procurement notes.

Path Parameters

Parameter	Type	Required	Description
purchase_order_id	string	Yes	Unique identifier of the purchase order.
NOTE_UUID	string	Yes	Unique identifier of the note.

Query Parameters

No query parameter is required for the request body.

Request Body

No data is required for the request body.

Response

On success, the API returns a list of files attached to the given note, including their UUIDs, names, and versions.

Response Body

                JSON
              

                      {
    "purchase_order": {
        "note": {
            "files": [
                {
                    "uuid": "{{FILE_UUID}}",
                    "name": "{{FILE_NAME}}",
                    "version": "1"
                }
            ],
            "custom_attributes": []
        }
    }
}

                    

Attribute	Type	Description
purchase_order	object	Container object.
purchase_order.note	object	The requested note container.
purchase_order.note.files	array	List of files.
purchase_order.note.files[].uuid	string (UUID)	File identifier.
purchase_order.note.files[].name	string	File name.
purchase_order.note.files[].version	string	File version.
purchase_order.note.custom_attributes	array	Custom attributes if defined.

Purpose

Retrieve details of a specific file attached to a purchase order note.

Use Case

Fetch metadata of a particular file.
Verify attached file details before downloading or processing.

Path Parameters

Parameter	Type	Required	Description
purchase_order_id	string	Yes	Unique identifier of the purchase order.
NOTE_UUID	string	Yes	Unique identifier of the note.
FILE_UUID	string	Yes	Unique identifier of the file.

Query Parameters

No query parameter is required for this endpoint.

Request Body

No data is required for the request body.

Response

On success, the API returns the file metadata, including its UUID, name, and version, within the note container.

Response Body

                JSON
              

                      {
    "purchase_order": {
        "note": {
            "file": {
                "uuid": "{{FILE_UUID}}",
                "name": "{{FILE_NAME}}",
                "version": "1"
            },
            "custom_attributes": []
        }
    }
}

                    

Attribute	Type	Description
purchase_order	object	Container object.
purchase_order.note	object	The requested note container.
purchase_order.note.file	object	Metadata of the requested file.
purchase_order.note.file.uuid	string (UUID)	Unique identifier of the file.
purchase_order.note.file.name	string	File name.
purchase_order.note.file.version	string	File version.
purchase_order.note.custom_attributes	array	Custom attributes if defined.

Endpoint: GET /api/v3/purchase-orders

Purpose

Use Case

Request Data

Response

Endpoint: GET/api/v3/purchase-orders/{id}

Purpose

Use Case

Request Data

Response

Retrieve Purchase Order Details: /purchase-orders/{id}/information

Purpose

Use Case

Path Parameter

Query Parameter

Request Body

Response

Response Body

Getting Purchase Order Line Details: /purchase-orders/{id}/lines

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Endpoint: GET /api/v3/purchase-orders/{id}/lines/{uuid}

Purpose

Use Case

Request Data

Response

Endpoint: GET /api/v3/accounts/{id}/purchase-orders

Purpose

Use Case

Request Data

Response

Retrieve All Notes for a Purchase Order: /purchase-orders/{purchase_order_id}/notes

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Specific Purchase Order Note: /purchase-orders/{purchase_order_id}/notes/{NOTE_UUID}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve Files for a Note: /purchase-orders/{purchase_order_id}/notes/{NOTE_UUID}/files

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body

Retrieve a Specific File from a Note: /purchase-orders/{purchase_order_id}/notes/{NOTE_UUID}/files/{FILE_UUID}

Purpose

Use Case

Path Parameters

Query Parameters

Request Body

Response

Response Body