Complyance Logo

Purchases API

The Purchases API is the buyer-side document retrieval interface for inbound purchase invoices within the Global Unify API v3 surface.

Use this section when you need to:

  • retrieve a single inbound purchase invoice by documentId
  • poll inbound purchase invoices by date range
  • paginate through purchase invoice events with a cursor
  • fetch purchase invoice XML and compliance metadata after receipt

How This Fits Within Global Unify API v3

The main Unify API v3 submit flow is designed for outbound seller-side invoice submission and document processing. Purchases cover a different retrieval path:

  • purchase invoices are inbound buyer-side documents
  • they are stored after receipt and processing
  • retrieval and polling happen through /api/v3/documents with type=purchases

That is why purchases are documented as a dedicated subsection under Global Unify API v3.

Available Endpoints

Get a single purchase invoice

Retrieve the full stored purchase invoice, including invoice data, status, validation results, XML, and compliance metadata.

Get Purchase Invoice →

List purchase invoices

Poll purchase invoices by date range and paginate with nextCursor.

List Purchase Invoices →

Authentication Model

Purchase endpoints use API-key authentication plus client scoping headers:

  • Authorization: Bearer <YOUR_API_KEY>
  • x-client-id: <YOUR_WORKSPACE_ID>
  • x-api-key-environment: production or mock

These endpoints are designed for authenticated buyer workspaces querying their own purchase invoice data.

Supported Flow

  1. Receive inbound purchase invoices into your Complyance workspace
  2. Use webhooks for real-time notification if needed
  3. Use the Purchases API to fetch the full purchase invoice or poll recent invoices
  4. Use SDK purchase clients if you prefer language-specific wrappers

Related Sections