Retrieve a purchase invoice

Retrieves the details of a specific purchase invoice.

Rate limit

60 requests/minute per authenticated account. See Rate limiting for response headers (X-RateLimit-*) and retry guidance.

Path parameters

GET /api/purchase-invoices/{id}

Response

Status code: 200 OK

Returns the full purchase invoice.

Response body fields

Meta info object

The meta_info field is an object with the following attributes:

Peppol status object

The meta_info.peppol_status field is an object with the following attributes:

Status values

VALIDATION_FAILED applies only to overall_status.

Client processing guidance

1. Treat overall_status as the primary state for workflow decisions.

2. Use participant_status and fta_status as stage-specific diagnostics for UI and support logs.

3. If overall_status is PENDING, keep the invoice in a processing state and poll/re-fetch later.

4. If overall_status is APPROVED, mark the Peppol flow as successful and continue normal downstream actions.

5. If overall_status is REJECTED or VALIDATION_FAILED, stop submission-dependent actions and surface the failure to users.

6. When validation_results is not empty, display user-friendly error summaries from text, and retain flag, reasonCode, location, and test for troubleshooting.

7. participant_status or fta_status can be null in early/failed validation stages; do not treat null alone as success or failure.

Example `meta_info` values

Typical meta_info.peppol_status shapes:

APPROVED

{
  "meta_info": {
    "peppol_status": {
      "participant_status": "APPROVED",
      "fta_status": "APPROVED",
      "overall_status": "APPROVED",
      "validation_results": []
    }
  }
}

REJECTED

{
  "meta_info": {
    "peppol_status": {
      "participant_status": "REJECTED",
      "fta_status": "APPROVED",
      "overall_status": "REJECTED",
      "validation_results": []
    }
  }
}

VALIDATION_FAILED

VALIDATION_FAILED applies only to overall_status. participant_status and fta_status can be null.

{
  "meta_info": {
    "peppol_status": {
      "participant_status": null,
      "fta_status": null,
      "overall_status": "VALIDATION_FAILED",
      "validation_results": [
        {
          "flag": "fatal",
          "reasonCode": "IBR-128-AE",
          "text": "Country subentity must be a valid UAE subdivision code",
          "location": "/Invoice/cac:AccountingCustomerParty/cac:Party/cac:PostalAddress/cbc:CountrySubentity",
          "test": "normalize-space(.) = 'AUH' or normalize-space(.) = 'DXB' or normalize-space(.) = 'SHJ' or normalize-space(.) = 'UAQ' or normalize-space(.) = 'FUJ' or normalize-space(.) = 'AJM' or normalize-space(.) = 'RAK'"
        }
      ]
    }
  }
}

Nested object field tables are on Create.

Error responses

401 Unauthorized

Authentication required or invalid token.

{
  "errors": {
    "message": "Authentication required or invalid token"
  }
}

404 Not Found

Purchase invoice not found.

{
  "errors": {
    "message": "Purchase invoice not found"
  }
}

500 Internal Server Error

An error occurred while processing the request.

{
  "errors": {
    "message": "An error occurred"
  }
}