Retrieve Purchase Invoice List: /purchase-invoices

Purpose

This API retrieves a paginated list of all purchase invoices recorded in the system. Each invoice includes metadata such as status, issue and due dates, currency details, associated supplier account, and financial figures like subtotal, tax, and total. The endpoint also returns invoice line items, purchase order references, and key performance indicators (KPIs) that support financial tracking and operational analysis.

Use Case

A procurement officer or finance team member wants to view all purchase invoices issued in the system. This API is used to:

• Display invoice history in a UI.
• Fetch data for financial reporting.
• Filter invoices by account or status using optional parameters.

Path Parameters

This endpoint does not require any path parameters.

Query Parameters

*Here, eq = equal, ne = not equal, gt = greater than, ge = greater or equal, lt = less than, le = less or equal.*

Request Body

No request body is required for this endpoint.

Response

The response returns a structured list of purchase invoice objects, each containing detailed metadata and financial information. Each invoice includes its unique ID, status, currency, issue and due dates, tax inclusivity flag, and total amounts. Line items within the invoice specify item quantities, warehouse allocations, accounting codes, and subtotal calculations. If the invoice is linked to a purchase order, that reference is included. KPIs provide insight into outstanding balances, overdue amounts, payment history, and credit application. The response also includes pagination metadata such as record count, limit, offset, and navigation URLs for previous and next pages, enabling efficient client-side data handling and browsing across large datasets.

Response Body

Retrieve Purchase Invoice Details by ID: /purchase-invoices/{id}

Purpose

This API retrieves detailed information about a single purchase invoice identified by its unique invoice ID. It enables clients and internal systems to access all relevant metadata, financial values, and item-level breakdowns associated with the invoice. The endpoint supports visibility into the invoice’s lifecycle, including creation details, currency, totals, and payment tracking metrics.

Use Case

This endpoint is used to review or validate the full details of a specific purchase invoice. It is commonly applied in workflows such as displaying invoice details in a UI, exporting invoice data for reporting, or verifying values during reconciliation. For example, after selecting a supplier and adding multiple items with valid pricing and inventory, a purchase invoice is created. This endpoint allows users to retrieve that invoice and confirm its issue and due dates, subtotal, tax, total, and item-level quantities and warehouse

Path Parameters

Query Parameters

No query parameters are required or supported for this endpoint.

Request Body

No request body is required for this endpoint.

Response

The response returns a structured purchase invoice object containing comprehensive metadata and financial information. It includes the invoice ID, status, currency details, issue and due dates, tax inclusivity flag, and total amounts. Line items are listed with their respective subtotals, quantities, accounting codes, and warehouse references. The response also includes metadata such as the creator, timestamps, versioning, and custom form details. KPIs provide insight into payment status, outstanding balances, overdue amounts, and credit application. This structure ensures that internal systems and users can accurately track, audit, and manage individual purchase invoices.

Response Body

Retrieve Purchase Invoice List by Account ID: /accounts/{id}/purchase-invoices

Purpose

This API fetches a paginated list of all purchase invoices linked to a specific account. It enables users to view invoice records filtered by supplier context, supporting account-level financial tracking and reporting.

Use Case

This endpoint is used to review purchase invoices associated with a particular account. It supports internal systems that display account-specific invoice histories and enables reporting tools to group invoices by supplier or customer. For example, after creating a purchase invoice for a supplier account, this endpoint allows retrieval of all invoices tied to that supplier, including their financial details and item breakdowns.

Path Parameters

Query Parameters

Request Body

No request body is required for this endpoint.

Response

The response returns an account object containing a list of associated purchase invoices. Each invoice includes metadata such as status, issue and due dates, currency, totals, and tax configuration. Line items detail quantities, subtotals, warehouse allocations, and accounting codes. KPIs provide insight into payment status, outstanding amounts, and credit application. Pagination metadata is included to support navigation across multiple invoice records.

Response Body

Retrieve Purchase Invoice Line Details: /purchase-invoices/{id}/lines/{uuid}

Purpose

This API retrieves detailed information about a specific line item within a purchase invoice, identified by its unique line UUID. It enables clients and systems to access granular financial and inventory data tied to individual invoice entries.

Use Case

This endpoint is used to fetch line-level details from a purchase invoice for display, validation, or analysis. It supports workflows such as showing item breakdowns in a UI, verifying pricing and tax configurations, and auditing warehouse allocations or accounting codes. For example, after creating a purchase invoice with multiple items, this endpoint allows retrieval of a specific item’s financial values and metadata.

Path Parameters

Query Parameters

No query parameters are required or supported for this endpoint.

Request Body

This endpoint does not require a request body.

Response

The response returns a purchase invoice object containing a single line item with detailed attributes. These include subtotal, total, tax amount, accounting code, item quantity, warehouse name, and versioning. While invoice-level metadata such as status, ID, and creator fields are present, they may be null or minimal in this context. KPIs are also included, summarizing payment status and credit application, though they may reflect default values. This structure ensures precise access to item-level financial data within a broader invoice contex

Response Body

Retrieve All Notes for a Purchase Invoice: /purchase-invoices/{purchase_invoice_id}/notes

Purpose

This API retrieves all notes associated with a specific purchase invoice. Notes can include descriptive text, file attachments, metadata (creator, timestamps), and optional custom attributes. It also supports pagination for cases where a large number of notes are attached.

Use Case

Use this API when you need to list all notes for a given purchase invoice, for example, to display invoice-related comments, attached files, or to audit who added notes and when. Ideal for UIs that display invoice details with supporting documentation.

Path Parameters

Query Parameters

No query parameter is required for this endpoint.

Request Body

No request body is required for this endpoint.

Response

On success, the response returns a purchase_invoice object containing two main elements: notes, which is an array of note objects where each note includes its unique identifier (uuid), versioning, rich-text content, attached files (with uuid, name, and version), audit metadata (created_by, created_on, last_updated_by, last_updated_on), and optional custom_attributes; and pagination, which provides metadata for navigating results, including the total record count, applied limit, current offset, and links to previous and next pages. This structure ensures efficient handling of large datasets while maintaining complete audit details for each note.

Response Body

Retrieve a Specific Note for a Purchase Invoice: /purchase-invoices/{purchase_invoice_id}/notes/{NOTE_UUID}

Purpose

Retrieves details of a single note attached to a purchase invoice by its unique identifier.

Use Case

Use this API to fetch full information about a specific note for viewing, editing, or auditing.

Path Parameters

Query Parameters

No query parameter is required for this endpoint.

Request Body

This endpoint does not require a request body.

Response

Returns a single note object inside the purchase_invoice. The note includes its unique uuid, version number, content (with HTML support), attached files (if any), and full audit metadata (created_by, created_on, last_updated_by, last_updated_on). Custom attributes can also be present.

Response Body

Retrieve All Files for a Note: /purchase-invoices/{purchase_invoice_id}/notes/{NOTE_UUID}/files

Purpose

Retrieves a list of all files attached to a specific note.

Use Case

Useful when you want to display or download all files attached to a note, for example, invoice attachments like receipts or scanned documents.

Path Parameters

Query Parameters

No query parameters are required or supported for this endpoint.

Request Body

This endpoint does not require a request body.

Response

The response contains a files array under purchase_invoice.note, listing all files associated with the note. Each file includes its unique uuid, file name, and version. Additionally, custom_attributes may be present for extra metadata.

Response Body

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

Purpose

Retrieves metadata of a single file attached to a note, identified by its unique file UUID.

Use Case

Use this API when you need to fetch or download a specific file attached to a note, e.g., retrieving a scanned receipt linked to an invoice.

Path Parameters

Query Parameters

No query parameters are required or supported for this endpoint.

Request Body

This endpoint does not require a request body.

Response

The response contains a single file object under purchase_invoice.note. It provides the file’s unique identifier (uuid), its name, and its version. custom_attributes may also be included to store client-defined metadata.

Response Body