> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.staple.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.staple.ai/_mcp/server.

# Get e-invoice status

POST https://api.staple.io/v2/einvoice/{country}/status
Content-Type: application/json

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.

Reference: https://docs.staple.ai/api-reference/v2/e-invoice/get-status

## Authentication

- `x-api-key` header (required) — API key issued by Staple.
- `Authorization` header (bearer token, required) — JWT obtained from the login endpoint.

## Request

### Path parameters

- `country` (enum, required) — Country of the e-invoices. Supported: `sg`, `fr`, `de`, `pl`.
  - Allowed values: `sg`, `fr`, `de`, `pl`

### Body (application/json)

This endpoint expects an object.

- `documentIds` (list of V2EinvoiceCountryStatusPostRequestBodyContentApplicationJsonSchemaDocumentIdsItems, optional) — Internal document IDs (integers or strings). Up to 100.
- `uuids` (list of string, optional) — E-invoice UUIDs. Up to 100.

## Response

### 200

Status of every matched document, plus `unresolved` identifiers.

- `count` (integer, optional) — Number of documents in `results`.
- `results` (list of V2EinvoiceCountryStatusPostResponsesContentApplicationJsonSchemaResultsItems, optional) — One status object per matched document.
- `unresolved` (list of V2EinvoiceCountryStatusPostResponsesContentApplicationJsonSchemaUnresolvedItems, optional)

## Types

### V2EinvoiceCountryStatusPostRequestBodyContentApplicationJsonSchemaDocumentIdsItems

### V2EinvoiceCountryStatusPostResponsesContentApplicationJsonSchemaResultsItems

### V2EinvoiceCountryStatusPostResponsesContentApplicationJsonSchemaUnresolvedItems

- `identifier` (string, optional)
- `type` (enum, optional)
  - Allowed values: `documentId`, `uuid`
- `code` (enum, optional)
  - Allowed values: `DOCUMENT_NOT_FOUND`
- `message` (string, optional)

## Examples

**Request**

```json
{
  "documentIds": [
    245210,
    999999
  ],
  "uuids": [
    "b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04"
  ]
}
```

**Response**

```json
{
  "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."
    }
  ]
}
```

**SDK Code**

```python E-Invoice_getStatus_example
import requests

url = "https://api.staple.io/v2/einvoice/sg/status"

payload = {
    "documentIds": [245210, 999999],
    "uuids": ["b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04"]
}
headers = {
    "x-api-key": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript E-Invoice_getStatus_example
const url = 'https://api.staple.io/v2/einvoice/sg/status';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"documentIds":[245210,999999],"uuids":["b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go E-Invoice_getStatus_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.staple.io/v2/einvoice/sg/status"

	payload := strings.NewReader("{\n  \"documentIds\": [\n    245210,\n    999999\n  ],\n  \"uuids\": [\n    \"b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby E-Invoice_getStatus_example
require 'uri'
require 'net/http'

url = URI("https://api.staple.io/v2/einvoice/sg/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"documentIds\": [\n    245210,\n    999999\n  ],\n  \"uuids\": [\n    \"b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04\"\n  ]\n}"

response = http.request(request)
puts response.read_body
```

```java E-Invoice_getStatus_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.staple.io/v2/einvoice/sg/status")
  .header("x-api-key", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"documentIds\": [\n    245210,\n    999999\n  ],\n  \"uuids\": [\n    \"b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04\"\n  ]\n}")
  .asString();
```

```php E-Invoice_getStatus_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.staple.io/v2/einvoice/sg/status', [
  'body' => '{
  "documentIds": [
    245210,
    999999
  ],
  "uuids": [
    "b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04"
  ]
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp E-Invoice_getStatus_example
using RestSharp;

var client = new RestClient("https://api.staple.io/v2/einvoice/sg/status");
var request = new RestRequest(Method.POST);
request.AddHeader("x-api-key", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"documentIds\": [\n    245210,\n    999999\n  ],\n  \"uuids\": [\n    \"b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04\"\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift E-Invoice_getStatus_example
import Foundation

let headers = [
  "x-api-key": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "documentIds": [245210, 999999],
  "uuids": ["b2e48d17-5c0a-4f3e-8d61-7a9c3e2f5b04"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.staple.io/v2/einvoice/sg/status")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```