Airwallex logo

E-Invoicing Documents

Copy for LLMView as Markdown

An E-Invoicing Document represents the regulatory (e-invoicing or e-reporting) processing record for an Invoice or Credit Note. It tracks the processing status, regulatory artifacts, the recipient's response, and processing errors.

Endpoints
GET /api/v1/billing/e_invoicing_documents/{id}
GET /api/v1/billing/e_invoicing_documents

Retrieve an E-Invoicing DocumentEarly access

GET /api/v1/billing/e_invoicing_documents/{id}

Retrieve an E-Invoicing Document is available for early access
Expect limited functionality as we continue development and build the product in partnership with early users. Reach out to your Airwallex account manager or [email protected] if you would like to use this feature. Learn more about early access.Docs

Retrieves the details of an E-Invoicing Document by ID.

Path parameters
idrequiredstring

The ID of the E-Invoicing Document.

Response body - 200 OK
attachmentsarray

Downloadable regulatory artifacts. Empty when no artifact has been produced.

attachments.created_atstring

Time when the attached file record was created, in ISO8601 format.

attachments.file_namestring

Original file name, including the file extension.

attachments.file_urlstring

URL to access and download the attachment file.

created_atstring

Time when the E-Invoicing Document was created, in ISO8601 format.

credit_note_idstring

ID of the source Credit Note. Set only when type is CREDIT_NOTE, otherwise null.

errorsarray

Errors from the latest failed processing attempt. Empty unless status is FAILED.

errors.codestring

Stable, machine-readable error code.

errors.messagestring

Human-readable description of the error. Do not use this field for programmatic decisions.

errors.detailsobject

Conditional key-value object containing additional details about the error.

errors.sourcestring

Name of the request parameter or resource field that caused the error, when available.

idstring

Unique identifier of the E-Invoicing Document.

invoice_idstring

ID of the source Invoice. Set only when type is INVOICE, otherwise null.

original_customer_responsestring

The customer's original response to the E-Invoice. null when no response has been received.

statusstring

Current regulatory processing status. When FAILED, see errors for details.

PROCESSING

Regulatory processing is in progress.

SUCCEEDED

Regulatory processing completed successfully.

FAILED

Regulatory processing failed. See errors for details.

typestring

Type of the underlying billing document.

INVOICE

The underlying billing document is an Invoice.

CREDIT_NOTE

The underlying billing document is a Credit Note.

updated_atstring

Time when the E-Invoicing Document was last updated, in ISO8601 format.

Errors
Error statusDescription
400

Bad Request. Possible error codes: validation_error

401

Unauthorized. Possible error codes: unauthorized

404

Not Found. Possible error codes: resource_not_found

500

Server Error. Possible error codes: internal_error

GET /api/v1/billing/e_invoicing_documents/{id}
$curl --request GET \
> --url 'https://api.sandbox.airwallex.com/api/v1/billing/e_invoicing_documents/einv_hkpd49cskgblns6iimw' \
> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
> --header 'Content-Type: application/json'
Response (200 OK)
1{
2 "id": "einv_hkpd49cskgblns6iimw",
3 "type": "INVOICE",
4 "status": "SUCCEEDED",
5 "attachments": [
6 {
7 "file_name": "invoice_2026_001.xml",
8 "file_url": "https://invoice.airwallex.com/billing/e_invoicing_documents/attachment?s=jwt_token",
9 "created_at": "2026-08-19T08:30:15+0000"
10 },
11 {
12 "file_name": "invoice_2026_001.pdf",
13 "file_url": "https://invoice.airwallex.com/billing/e_invoicing_documents/attachment?s=jwt_token",
14 "created_at": "2026-08-19T08:30:15+0000"
15 }
16 ],
17 "original_customer_response": "APPROVAL",
18 "errors": [],
19 "invoice_id": "inv_hkpd49cskgblns6iimw",
20 "credit_note_id": null,
21 "created_at": "2026-08-19T08:30:00+0000",
22 "updated_at": "2026-08-19T08:31:10+0000"
23}
Was this section helpful?

Get list of E-Invoicing DocumentsEarly access

GET /api/v1/billing/e_invoicing_documents

Get list of E-Invoicing Documents is available for early access
Expect limited functionality as we continue development and build the product in partnership with early users. Reach out to your Airwallex account manager or [email protected] if you would like to use this feature. Learn more about early access.Docs

Retrieves a list of E-Invoicing Documents based on the query parameters.

Query parameters
typerequiredstring

Type of the underlying billing document, one of INVOICE or CREDIT_NOTE.

INVOICE
CREDIT_NOTE
from_created_atstring

The start date of created_at in ISO8601 format (inclusive).

from_updated_atstring

The start date of updated_at in ISO8601 format (inclusive).

pagestring

A bookmark for use in pagination to retrieve either the next page or the previous page of results. You can fetch the value for this identifier from the response of the previous API call. To retrieve the next page of results, pass the value of page_after (if not null) from the response to a subsequent call. To retrieve the previous page of results, pass the value of page_before (if not null) from the response to a subsequent call.

page_sizeinteger

Number of E-Invoicing Documents per page. Defaults to 20.

statusstring

Regulatory processing status, one of PROCESSING, SUCCEEDED or FAILED.

PROCESSING
SUCCEEDED
FAILED
to_created_atstring

The end date of created_at in ISO8601 format (exclusive).

to_updated_atstring

The end date of updated_at in ISO8601 format (exclusive).

Response body - 200 OK
itemsarray

Paged results.

items.attachmentsarray

Downloadable regulatory artifacts. Empty when no artifact has been produced.

items.attachments.created_atstring

Time when the attached file record was created, in ISO8601 format.

items.attachments.file_namestring

Original file name, including the file extension.

items.attachments.file_urlstring

URL to access and download the attachment file.

items.created_atstring

Time when the E-Invoicing Document was created, in ISO8601 format.

items.errorsarray

Errors from the latest failed processing attempt. Empty unless status is FAILED.

items.errors.codestring

Stable, machine-readable error code.

items.errors.messagestring

Human-readable description of the error. Do not use this field for programmatic decisions.

items.errors.detailsobject

Conditional key-value object containing additional details about the error.

items.errors.sourcestring

Name of the request parameter or resource field that caused the error, when available.

items.idstring

Unique identifier of the E-Invoicing Document.

items.statusstring

Current regulatory processing status. When FAILED, see errors for details.

PROCESSING

Regulatory processing is in progress.

SUCCEEDED

Regulatory processing completed successfully.

FAILED

Regulatory processing failed. See errors for details.

items.typestring

Type of the underlying billing document.

INVOICE

The underlying billing document is an Invoice.

CREDIT_NOTE

The underlying billing document is a Credit Note.

items.updated_atstring

Time when the E-Invoicing Document was last updated, in ISO8601 format.

items.credit_note_idstring

ID of the source Credit Note. Set only when type is CREDIT_NOTE, otherwise null.

items.invoice_idstring

ID of the source Invoice. Set only when type is INVOICE, otherwise null.

items.original_customer_responsestring

The customer's original response to the E-Invoice. null when no response has been received.

page_afterstring

The page cursor used for searching after page.

page_beforestring

The page cursor used for search before page.

Errors
Error statusDescription
400

Bad Request. Possible error codes: validation_error

401

Unauthorized. Possible error codes: unauthorized

500

Server Error. Possible error codes: internal_error

GET /api/v1/billing/e_invoicing_documents
$curl --request GET \
> --url 'https://api.sandbox.airwallex.com/api/v1/billing/e_invoicing_documents?type=INVOICE&status=SUCCEEDED' \
> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \
> --header 'Content-Type: application/json'
Response (200 OK)
1{
2 "items": [
3 {
4 "id": "einv_hkpd49cskgblns6iimw",
5 "type": "INVOICE",
6 "status": "SUCCEEDED",
7 "attachments": [
8 {
9 "file_name": "invoice_2026_001.xml",
10 "file_url": "https://invoice.airwallex.com/billing/e_invoicing_documents/attachment?s=jwt_token",
11 "created_at": "2026-08-19T08:30:15+0000"
12 },
13 {
14 "file_name": "invoice_2026_001.pdf",
15 "file_url": "https://invoice.airwallex.com/billing/e_invoicing_documents/attachment?s=jwt_token",
16 "created_at": "2026-08-19T08:30:15+0000"
17 }
18 ],
19 "original_customer_response": "APPROVAL",
20 "errors": [],
21 "invoice_id": "inv_hkpd49cskgblns6iimw",
22 "credit_note_id": null,
23 "created_at": "2026-08-19T08:30:00+0000",
24 "updated_at": "2026-08-19T08:31:10+0000"
25 }
26 ],
27 "page_after": "<string>",
28 "page_before": "<string>"
29}
Was this section helpful?