Get e-invoice status | Staple AI

curl -X POST https://api.staple.io/v2/einvoice/sg/status \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "documentIds": [
    245210,
    999999
  ],
  "uuids": [
    "b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04"
  ]
}'

{
  "count": 1,
  "results": [
    {
      "createdAt": "2026-10-09T03:48:46.739Z",
      "documentId": "245210",
      "documentStatus": "RECEIVED",
      "general": {
        "checks": [
          {
            "code": "IS_EINVOICE_NUMBER_DUPLICATE",
            "status": false
          },
          {
            "code": "IS_XML_SCHEMA_VALID",
            "status": true
          },
          {
            "code": "IS_RECIPIENT_EXISTS_IN_STAPLE",
            "status": null
          },
          {
            "code": "IS_VALID",
            "status": true
          }
        ],
        "country": "sg",
        "status": "RECEIVED",
        "type": "INVOICE"
      },
      "network": {
        "attempts": 1,
        "details": {
          "destination": "PEPPOL_IRAS",
          "flow": "AR",
          "sendStatus": "SENT_SUCCESSFULLY"
        },
        "errors": [],
        "message": "Sent successfully",
        "network": "PEPPOL",
        "networkResponse": null,
        "status": "SENT_SUCCESSFULLY",
        "submittedAt": "2026-10-09T03:48:52.549Z"
      },
      "taxAuthority": {
        "attempts": 1,
        "authority": "IRAS",
        "details": {
          "acknowledgementId": "261009-727cb231-591d-4c80-8320-d1c564f39df2-s001",
          "auditStatus": "SUCCESSFUL_IRAS_SUBMISSION",
          "senderId": "0195:SGUEN201912345A",
          "sourceErrorCode": null,
          "transmissionID": "05605b7c-4b46-4d19-9374-c565465daf0a"
        },
        "errors": [],
        "status": "SUCCESSFUL_IRAS_SUBMISSION",
        "submittedAt": "2026-10-09T03:50:11.502Z",
        "taxAuthorityResponse": {
          "acknowledgementId": "261009-727cb231-591d-4c80-8320-d1c564f39df2-s001",
          "code": 200,
          "correlationId": "727cb231-591d-4c80-8320-d1c564f39df2",
          "documentUuid": "6f1c2a9e-3b7d-4e52-9a10-2c8d4f7b1e33",
          "message": "Acknowledged.",
          "progress": "ProcessingQueue",
          "received": 1,
          "senderId": "0195:SGUEN201912345A",
          "success": true,
          "transmissionId": "05605b7c-4b46-4d19-9374-c565465daf0a",
          "version": "1.0"
        }
      },
      "uuid": "6f1c2a9e-3b7d-4e52-9a10-2c8d4f7b1e33"
    }
  ],
  "unresolved": [
    {
      "identifier": "999999",
      "type": "documentId",
      "code": "DOCUMENT_NOT_FOUND",
      "message": "No document with ID 999999 exists for country sg."
    },
    {
      "identifier": "b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04",
      "type": "uuid",
      "code": "DOCUMENT_NOT_FOUND",
      "message": "No document with UUID b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04 exists for country sg."
    }
  ]
}

Get the current status of one or more e-invoices in a single call, looked up by internal document ID, by e-invoice UUID, or both.

Supported countries: sg, fr, de, pl. The country is case-insensitive.

Limit: up to 100 documentIds and 100 uuids per request (up to 200 identifiers). At least one identifier is required. A UUID can match more than one document (for example, the same e-invoice delivered to several queues), so count is the number of documents returned.

Only documents in queues you are assigned to are returned. Identifiers that match nothing you can access are listed in unresolved with code DOCUMENT_NOT_FOUND.

Each result has three sections:

Section	Contents
`general`	Country, document type (`INVOICE` / `CREDIT_NOTE`), document status and validation `checks`. A check `status` of `null` means it was not run.
`network`	Delivery over the e-invoicing network (Peppol): status, message, errors, attempts and the network response.
`taxAuthority`	Submission to the tax authority (IRAS for Singapore): status, errors, attempts, the authority’s response and its reference ids.

network.status values: PENDING, SENT_SUCCESSFULLY, FAILED_TO_SEND, INVALID_XML_FORMAT, CONSUMER_NOT_FOUND, NETWORK_TRANSMISSION_ERROR, NOT_APPLICABLE.

taxAuthority.status values: NOT_SUBMITTED, SUCCESSFUL_IRAS_SUBMISSION, REJECTED_IRAS_SUBMISSION, INVALID_XML_FORMAT, NETWORK_TRANSMISSION_ERROR, NOT_APPLICABLE.

NOT_APPLICABLE means the channel is not used for this document — for example, a received e-invoice has no network send.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Path parameters

countryenumRequired

Country of the e-invoices. Supported: sg, fr, de, pl.

Allowed values:

Request

Provide at least one of documentIds or uuids.

documentIdslist of integers or stringsOptional

Internal document IDs (integers or strings). Up to 100.

uuidslist of stringsOptional

E-invoice UUIDs. Up to 100.

Response

Status of every matched document, plus unresolved identifiers.

countintegerOptional

Number of documents in results.

resultslist of objectsOptional

One status object per matched document.

unresolvedlist of objectsOptional