Download e-invoices (XML or STAR JSON) | Staple AI

curl -X POST https://api.staple.io/v2/einvoice/sg/download \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "docType": "STAR_JSON",
  "docIds": [
    245210,
    245211
  ]
}'

{
  "documents": [
    {
      "docId": 245210,
      "status": "RECEIVED",
      "docType": "STAR_JSON",
      "data": {
        "Buyer": {
          "Address": {
            "City Name": "Singapore",
            "Country Code": "SG",
            "Postal Zone": "018982",
            "Street Name": "3 Marina Boulevard"
          },
          "Email": "ap@globex-trading.example",
          "Name": "Globex Trading Pte Ltd",
          "Peppol Endpoint ID": "SGUEN202098765B",
          "Peppol Scheme ID": "0195",
          "Registration Number": "202098765B",
          "Tax ID": "M90098765B"
        },
        "Buyer Reference": "BR-2026-0087",
        "Currency": "SGD",
        "Document Type": "Invoice",
        "Invoice Date": "2026-08-20",
        "Invoice Number": "INV-2026-0815",
        "Line Items": [
          {
            "Description": "Apples",
            "Line Amount": 900,
            "Line ID": "1",
            "Quantity": 10,
            "Tax Breakdown": [
              {
                "Tax Amount": 81,
                "Tax Category Code": "SR",
                "Tax Rate": 9,
                "Tax Scheme": "GST",
                "Taxable Amount": 900
              }
            ],
            "Unit Amount": 90,
            "Unit of Measure": "KGM"
          }
        ],
        "PO Number": "PO-450235963",
        "Payment": {
          "Due Date": "2026-09-19",
          "Means Text": "GIRO",
          "Terms": "Net 30 days"
        },
        "Period": {
          "End Date": "2026-08-31",
          "Start Date": "2026-08-01"
        },
        "Seller": {
          "Address": {
            "City Name": "Singapore",
            "Country Code": "SG",
            "Postal Zone": "018989",
            "Street Name": "11 Marina Blvd"
          },
          "Email": "billing@acme-supplies.example",
          "Name": "Acme Supplies Pte Ltd",
          "Peppol Endpoint ID": "SGUEN201912345A",
          "Peppol Scheme ID": "0195",
          "Registration Number": "201912345A",
          "Tax ID": "M90012345A"
        },
        "Tax Point Date": "2026-08-20",
        "Totals": {
          "Allowance Total": 0,
          "Charge Total": 0,
          "Prepaid Amount": 0,
          "Rounding Amount": 0,
          "Subtotal": 900,
          "Sum of Line Amounts": 900,
          "Tax Total": 81,
          "Total": 981,
          "Total incl Tax": 981
        },
        "Transaction Type": "Purchases",
        "UUID": "6f1c2a9e-3b7d-4e52-9a10-2c8d4f7b1e33"
      }
    }
  ],
  "unresolved": [
    {
      "docId": 245211,
      "error": "DOCUMENT_NOT_FOUND"
    }
  ]
}

Download one or more e-invoices in the format you choose:

`docType`	`data` returned
`XML`	The Peppol PINT-SG UBL XML (wrapped in its SBDH envelope), as a string — the XML that was sent, or that was received over Peppol.
`STAR_JSON`	The e-invoice as a STAR JSON object — the same format used to submit e-invoices. For received e-invoices it is mapped from the received XML.

Supported countries: sg (Singapore). The country code is case-insensitive.

Limit: 1–100 docIds per request. Duplicate ids are returned once.

Each document is returned with its current status, whatever state it is in. Documents that cannot be returned are listed in unresolved with a reason, and the rest of the request still succeeds:

`error`	Meaning
`INVALID_DOCUMENT_ID`	The id is not a positive integer.
`DOCUMENT_NOT_FOUND`	No document with this id exists in your organisation.
`NOT_AN_EINVOICE`	The document exists but is not an e-invoice for this country.
`XML_NOT_AVAILABLE`	The document has no XML (`docType: XML`).
`STAR_JSON_NOT_AVAILABLE`	The document has no STAR JSON (`docType: STAR_JSON`).

Access is all-or-nothing: if any requested document belongs to a queue you are not assigned to, nothing is returned and the call fails with 403 listing those docIds.

Authentication

x-api-keystring

API key issued by Staple.

AuthorizationBearer

JWT obtained from the login endpoint.

Path parameters

countryCodeenumRequired

Country of the e-invoices. Supported: sg.

Allowed values:

Request

This endpoint expects an object.

docTypeenumRequired

Format to return. Case-sensitive.

Allowed values:

docIdslist of integersRequired

Internal document IDs (1–100). Numeric strings are also accepted.

Response

The documents that could be returned, plus unresolved for the rest.

documentslist of objectsOptional

unresolvedlist of objectsOptional