BillsBeta
Manages bills representing accounts payable obligations. Supports retrieval, listing with filters, and sync status updates for integration with external accounting systems.
GET /api/v1/spend/billsGET /api/v1/spend/bills/{id}POST /api/v1/spend/bills/{id}/mark_as_paidPOST /api/v1/spend/bills/{id}/syncPOST /api/v1/spend/bills/create
List bills
GET /api/v1/spend/bills
Returns a list of bills filtered by the specified query parameters.
Filter by bills created after this timestamp (inclusive) in ISO8601 format. If not specified, defaults to last 30 days from to_created_at.
Filter by bills updated after this timestamp (inclusive) in ISO8601 format.
Filter by legal entity unique identifier.
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.
Filter by purchase order unique identifier.
Filter by bill status. Possible values are DRAFT, AWAITING_APPROVAL, AWAITING_PAYMENT, PAYMENT_IN_PROGRESS, PAID, REJECTED, SCHEDULED.
Filter by sync status. Possible values are NOT_SYNCED, SYNCED, SYNC_FAILED.
Filter by bills created before this timestamp (exclusive) in ISO8601 format. If not specified, defaults to now.
Filter by bills updated before this timestamp (exclusive) in ISO8601 format.
List of items returned.
List of user emails who can approve the bill.
List of file attachments associated with the bill.
MIME type of the attached file. Common types include image/jpeg, image/png, and application/pdf.
Timestamp for when the resource was created in ISO8601 format.
Original filename of the uploaded attachment, including the file extension.
URL to access and download the attachment file. Authentication is required.
Unique identifier of the attachment.
List of payments applied to the bill.
Amount of the payment.
Timestamp for when the resource was created in ISO8601 format.
Currency of the payment, as an ISO 4217 currency code.
Unique identifier of the payment.
Payment method type. Possible values are TRANSFER, CARD_TRANSACTION, EXTERNAL.
Details of the card transaction used to pay the bill.
Unique identifier of the Airwallex account associated with the wallet that funded the card payment.
Card funding type. Possible values are CREDIT, CASH.
Unique identifier of the card used for payment.
Unique identifier of the card transaction.
Transaction amount in the source currency before conversion.
Currency of the original card transaction, as an ISO 4217 currency code.
Timestamp of the card transaction in ISO8601 format.
Details of the transfer used to pay the bill.
Unique identifier of the Airwallex account associated with the wallet that funded the transfer.
Whether this transfer payment pays multiple bills.
Date when the transfer was made, in ISO8601 format.
Unique identifier of the transfer.
Transfer amount in the source currency before conversion.
Currency of the original transfer, as an ISO 4217 currency code.
Total amount of the bill.
Timestamp for when the resource was created in ISO8601 format.
Unique identifier of the bill.
Unique identifier of the legal entity associated with the bill.
List of line items on the bill.
List of accounting fields selected for the line item.
Type of accounting field. Possible values are SUBSIDIARY, MERCHANT, GENERAL_LEDGER_ACCOUNT, TAX_CODE, CLASS, DEPARTMENT, LOCATION, PROJECT, OTHER.
Name of the accounting field value in the ERP.
External unique identifier of the accounting field value in the ERP.
Name of the accounting field in the ERP software. This field is populated only when type is set to OTHER.
Name of the accounting field value displayed in Airwallex.
Unique identifier of the line item.
Total amount for this line item.
Description of the line item.
Unique identifier of the purchase order line item associated with this bill line item.
Quantity of the line item.
Tax amount for this line item.
Unit price of the line item.
Bill status. Possible values are DRAFT, AWAITING_APPROVAL, AWAITING_PAYMENT, PAYMENT_IN_PROGRESS, PAID, REJECTED, SCHEDULED.
Sync status for an accounting system. Possible values are NOT_SYNCED, SYNCED, SYNC_FAILED.
Tax status indicating whether amounts include or exclude tax. Possible values are TAX_EXCLUSIVE, TAX_INCLUSIVE, UNSPECIFIED.
Timestamp for when the resource was updated in ISO8601 format.
Currency of the bill, as an ISO 4217 currency code.
Description of the bill.
Date when the bill is due, in ISO8601 format.
External identifier for this bill in your system.
Invoice number associated with the bill.
Date when the bill was issued, in ISO8601 format.
Unique identifier of the purchase order associated with the bill.
Error message describing the sync failure reason, populated when the sync status is updated via the API. Null when no sync error has occurred.
Unique identifier of the vendor associated with the bill.
A pointer to the end of the page list used in pagination to retrieve the next page of results.
A pointer to the start of the page list use in pagination to retrieve the previous page of results.
| Error status | Description |
|---|---|
| 400 | Invalid Request. |
| 404 | Not found. |
| 500 | Internal server error. |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/spend/bills' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "items": [3 {4 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",5 "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg",6 "invoice_number": "INV-0001",7 "billing_amount": "551.0",8 "billing_currency": "USD",9 "status": "AWAITING_PAYMENT",10 "sync_status": "SYNCED",11 "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.",12 "tax_status": "TAX_EXCLUSIVE",13 "description": "Office supplies for Q1 2025.",14 "approvers": [15 "[email protected]",16 "[email protected]"17 ],18 "issued_date": "2025-01-10",19 "due_date": "2025-01-10",20 "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",21 "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e",22 "bill_payments": [23 {24 "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",25 "type": "CARD_TRANSACTION",26 "amount": "300.00",27 "currency": "USD",28 "card_transaction": {29 "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",30 "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92",31 "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp",32 "card_funding_type": "CREDIT",33 "source_amount": "300.00",34 "source_currency": "USD",35 "transacted_at": "2025-01-02T00:00:00Z"36 },37 "created_at": "2025-01-02T00:00:00Z"38 },39 {40 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",41 "type": "TRANSFER",42 "amount": "251.00",43 "currency": "USD",44 "transfer": {45 "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92",46 "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp",47 "multi_bill": false,48 "source_amount": "251.00",49 "source_currency": "USD",50 "transfer_date": "2025-01-01"51 },52 "created_at": "2025-01-01T00:00:00Z"53 }54 ],55 "external_id": "BILL-EXT-001",56 "attachments": [57 {58 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",59 "content_type": "image/jpeg",60 "file_name": "flight_receipt.jpg",61 "file_url": "https://www.airwallex.com/flight_receipt.jpg",62 "created_at": "2025-02-02T00:00:00Z"63 }64 ],65 "line_items": [66 {67 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",68 "unit_price": "100.0",69 "quantity": "5",70 "description": "Office supplies",71 "total_amount": "500.0",72 "tax_amount": "51.0",73 "accounting_field_selections": [74 {75 "type": "OTHER",76 "name": "Cost Center",77 "external_id": "1036f6f7-87e4-4508-b865-f670b1926022",78 "value": "Office Expense",79 "value_label": "Office Expense"80 }81 ],82 "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d"83 }84 ],85 "created_at": "2025-01-01T00:00:00Z",86 "updated_at": "2025-02-02T00:00:00Z"87 }88 ],89 "page_after": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0=",90 "page_before": "eyJwYWdlX2JlZm9yZSI6IjIwMjUtMDctMDFUMDA6MDA6MDBaIn0="91}
Get bill
GET /api/v1/spend/bills/{id}
Retrieves the details of an existing bill.
Unique identifier of the bill.
List of user emails who can approve the bill.
List of file attachments associated with the bill.
MIME type of the attached file. Common types include image/jpeg, image/png, and application/pdf.
Timestamp for when the resource was created in ISO8601 format.
Original filename of the uploaded attachment, including the file extension.
URL to access and download the attachment file. Authentication is required.
Unique identifier of the attachment.
List of payments applied to the bill.
Amount of the payment.
Timestamp for when the resource was created in ISO8601 format.
Currency of the payment, as an ISO 4217 currency code.
Unique identifier of the payment.
Payment method type. Possible values are TRANSFER, CARD_TRANSACTION, EXTERNAL.
Details of the card transaction used to pay the bill.
Unique identifier of the Airwallex account associated with the wallet that funded the card payment.
Card funding type. Possible values are CREDIT, CASH.
Unique identifier of the card used for payment.
Unique identifier of the card transaction.
Transaction amount in the source currency before conversion.
Currency of the original card transaction, as an ISO 4217 currency code.
Timestamp of the card transaction in ISO8601 format.
Details of the transfer used to pay the bill.
Unique identifier of the Airwallex account associated with the wallet that funded the transfer.
Whether this transfer payment pays multiple bills.
Date when the transfer was made, in ISO8601 format.
Unique identifier of the transfer.
Transfer amount in the source currency before conversion.
Currency of the original transfer, as an ISO 4217 currency code.
Total amount of the bill.
Currency of the bill, as an ISO 4217 currency code.
Timestamp for when the resource was created in ISO8601 format.
Description of the bill.
Date when the bill is due, in ISO8601 format.
External identifier for this bill in your system.
Unique identifier of the bill.
Invoice number associated with the bill.
Date when the bill was issued, in ISO8601 format.
Unique identifier of the legal entity associated with the bill.
List of line items on the bill.
List of accounting fields selected for the line item.
Type of accounting field. Possible values are SUBSIDIARY, MERCHANT, GENERAL_LEDGER_ACCOUNT, TAX_CODE, CLASS, DEPARTMENT, LOCATION, PROJECT, OTHER.
Name of the accounting field value in the ERP.
External unique identifier of the accounting field value in the ERP.
Name of the accounting field in the ERP software. This field is populated only when type is set to OTHER.
Name of the accounting field value displayed in Airwallex.
Unique identifier of the line item.
Total amount for this line item.
Description of the line item.
Unique identifier of the purchase order line item associated with this bill line item.
Quantity of the line item.
Tax amount for this line item.
Unit price of the line item.
Unique identifier of the purchase order associated with the bill.
Bill status. Possible values are DRAFT, AWAITING_APPROVAL, AWAITING_PAYMENT, PAYMENT_IN_PROGRESS, PAID, REJECTED, SCHEDULED.
Error message describing the sync failure reason, populated when the sync status is updated via the API. Null when no sync error has occurred.
Sync status for an accounting system. Possible values are NOT_SYNCED, SYNCED, SYNC_FAILED.
Tax status indicating whether amounts include or exclude tax. Possible values are TAX_EXCLUSIVE, TAX_INCLUSIVE, UNSPECIFIED.
Timestamp for when the resource was updated in ISO8601 format.
Unique identifier of the vendor associated with the bill.
| Error status | Description |
|---|---|
| 400 | Invalid Request. |
| 404 | Not found. |
| 500 | Internal server error. |
$curl --request GET \> --url 'https://api.sandbox.airwallex.com/api/v1/spend/bills/bill_id' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",3 "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg",4 "invoice_number": "INV-0001",5 "billing_amount": "551.0",6 "billing_currency": "USD",7 "status": "AWAITING_PAYMENT",8 "sync_status": "SYNCED",9 "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.",10 "tax_status": "TAX_EXCLUSIVE",11 "description": "Office supplies for Q1 2025.",12 "approvers": [13 "[email protected]",14 "[email protected]"15 ],16 "issued_date": "2025-01-10",17 "due_date": "2025-01-10",18 "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",19 "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e",20 "bill_payments": [21 {22 "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",23 "type": "CARD_TRANSACTION",24 "amount": "300.00",25 "currency": "USD",26 "card_transaction": {27 "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",28 "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92",29 "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp",30 "card_funding_type": "CREDIT",31 "source_amount": "300.00",32 "source_currency": "USD",33 "transacted_at": "2025-01-02T00:00:00Z"34 },35 "created_at": "2025-01-02T00:00:00Z"36 },37 {38 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",39 "type": "TRANSFER",40 "amount": "251.00",41 "currency": "USD",42 "transfer": {43 "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92",44 "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp",45 "multi_bill": false,46 "source_amount": "251.00",47 "source_currency": "USD",48 "transfer_date": "2025-01-01"49 },50 "created_at": "2025-01-01T00:00:00Z"51 }52 ],53 "external_id": "BILL-EXT-001",54 "attachments": [55 {56 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",57 "content_type": "image/jpeg",58 "file_name": "flight_receipt.jpg",59 "file_url": "https://www.airwallex.com/flight_receipt.jpg",60 "created_at": "2025-02-02T00:00:00Z"61 }62 ],63 "line_items": [64 {65 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",66 "unit_price": "100.0",67 "quantity": "5",68 "description": "Office supplies",69 "total_amount": "500.0",70 "tax_amount": "51.0",71 "accounting_field_selections": [72 {73 "type": "OTHER",74 "name": "Cost Center",75 "external_id": "1036f6f7-87e4-4508-b865-f670b1926022",76 "value": "Office Expense",77 "value_label": "Office Expense"78 }79 ],80 "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d"81 }82 ],83 "created_at": "2025-01-01T00:00:00Z",84 "updated_at": "2025-02-02T00:00:00Z"85}
Mark bill as paid
POST /api/v1/spend/bills/{id}/mark_as_paid
Marks a bill as paid outside of Airwallex.
Unique identifier of the bill.
List of user emails who can approve the bill.
List of file attachments associated with the bill.
MIME type of the attached file. Common types include image/jpeg, image/png, and application/pdf.
Timestamp for when the resource was created in ISO8601 format.
Original filename of the uploaded attachment, including the file extension.
URL to access and download the attachment file. Authentication is required.
Unique identifier of the attachment.
List of payments applied to the bill.
Amount of the payment.
Timestamp for when the resource was created in ISO8601 format.
Currency of the payment, as an ISO 4217 currency code.
Unique identifier of the payment.
Payment method type. Possible values are TRANSFER, CARD_TRANSACTION, EXTERNAL.
Details of the card transaction used to pay the bill.
Unique identifier of the Airwallex account associated with the wallet that funded the card payment.
Card funding type. Possible values are CREDIT, CASH.
Unique identifier of the card used for payment.
Unique identifier of the card transaction.
Transaction amount in the source currency before conversion.
Currency of the original card transaction, as an ISO 4217 currency code.
Timestamp of the card transaction in ISO8601 format.
Details of the transfer used to pay the bill.
Unique identifier of the Airwallex account associated with the wallet that funded the transfer.
Whether this transfer payment pays multiple bills.
Date when the transfer was made, in ISO8601 format.
Unique identifier of the transfer.
Transfer amount in the source currency before conversion.
Currency of the original transfer, as an ISO 4217 currency code.
Total amount of the bill.
Currency of the bill, as an ISO 4217 currency code.
Timestamp for when the resource was created in ISO8601 format.
Description of the bill.
Date when the bill is due, in ISO8601 format.
External identifier for this bill in your system.
Unique identifier of the bill.
Invoice number associated with the bill.
Date when the bill was issued, in ISO8601 format.
Unique identifier of the legal entity associated with the bill.
List of line items on the bill.
List of accounting fields selected for the line item.
Type of accounting field. Possible values are SUBSIDIARY, MERCHANT, GENERAL_LEDGER_ACCOUNT, TAX_CODE, CLASS, DEPARTMENT, LOCATION, PROJECT, OTHER.
Name of the accounting field value in the ERP.
External unique identifier of the accounting field value in the ERP.
Name of the accounting field in the ERP software. This field is populated only when type is set to OTHER.
Name of the accounting field value displayed in Airwallex.
Unique identifier of the line item.
Total amount for this line item.
Description of the line item.
Unique identifier of the purchase order line item associated with this bill line item.
Quantity of the line item.
Tax amount for this line item.
Unit price of the line item.
Unique identifier of the purchase order associated with the bill.
Bill status. Possible values are DRAFT, AWAITING_APPROVAL, AWAITING_PAYMENT, PAYMENT_IN_PROGRESS, PAID, REJECTED, SCHEDULED.
Error message describing the sync failure reason, populated when the sync status is updated via the API. Null when no sync error has occurred.
Sync status for an accounting system. Possible values are NOT_SYNCED, SYNCED, SYNC_FAILED.
Tax status indicating whether amounts include or exclude tax. Possible values are TAX_EXCLUSIVE, TAX_INCLUSIVE, UNSPECIFIED.
Timestamp for when the resource was updated in ISO8601 format.
Unique identifier of the vendor associated with the bill.
| Error status | Description |
|---|---|
| 400 | Invalid Request. |
| 404 | Not found. |
| 500 | Internal server error. |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/spend/bills/bill_id/mark_as_paid' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json'
1{2 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",3 "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg",4 "invoice_number": "INV-0001",5 "billing_amount": "551.0",6 "billing_currency": "USD",7 "status": "AWAITING_PAYMENT",8 "sync_status": "SYNCED",9 "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.",10 "tax_status": "TAX_EXCLUSIVE",11 "description": "Office supplies for Q1 2025.",12 "approvers": [13 "[email protected]",14 "[email protected]"15 ],16 "issued_date": "2025-01-10",17 "due_date": "2025-01-10",18 "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",19 "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e",20 "bill_payments": [21 {22 "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",23 "type": "CARD_TRANSACTION",24 "amount": "300.00",25 "currency": "USD",26 "card_transaction": {27 "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",28 "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92",29 "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp",30 "card_funding_type": "CREDIT",31 "source_amount": "300.00",32 "source_currency": "USD",33 "transacted_at": "2025-01-02T00:00:00Z"34 },35 "created_at": "2025-01-02T00:00:00Z"36 },37 {38 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",39 "type": "TRANSFER",40 "amount": "251.00",41 "currency": "USD",42 "transfer": {43 "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92",44 "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp",45 "multi_bill": false,46 "source_amount": "251.00",47 "source_currency": "USD",48 "transfer_date": "2025-01-01"49 },50 "created_at": "2025-01-01T00:00:00Z"51 }52 ],53 "external_id": "BILL-EXT-001",54 "attachments": [55 {56 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",57 "content_type": "image/jpeg",58 "file_name": "flight_receipt.jpg",59 "file_url": "https://www.airwallex.com/flight_receipt.jpg",60 "created_at": "2025-02-02T00:00:00Z"61 }62 ],63 "line_items": [64 {65 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",66 "unit_price": "100.0",67 "quantity": "5",68 "description": "Office supplies",69 "total_amount": "500.0",70 "tax_amount": "51.0",71 "accounting_field_selections": [72 {73 "type": "OTHER",74 "name": "Cost Center",75 "external_id": "1036f6f7-87e4-4508-b865-f670b1926022",76 "value": "Office Expense",77 "value_label": "Office Expense"78 }79 ],80 "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d"81 }82 ],83 "created_at": "2025-01-01T00:00:00Z",84 "updated_at": "2025-02-02T00:00:00Z"85}
Update bill sync status
POST /api/v1/spend/bills/{id}/sync
Updates the sync status of a bill.
Unique identifier of the bill.
Sync status for an accounting system. Possible values are NOT_SYNCED, SYNCED, SYNC_FAILED.
Error message for sync failures. Only applicable when sync_status is SYNC_FAILED.
List of user emails who can approve the bill.
List of file attachments associated with the bill.
MIME type of the attached file. Common types include image/jpeg, image/png, and application/pdf.
Timestamp for when the resource was created in ISO8601 format.
Original filename of the uploaded attachment, including the file extension.
URL to access and download the attachment file. Authentication is required.
Unique identifier of the attachment.
List of payments applied to the bill.
Amount of the payment.
Timestamp for when the resource was created in ISO8601 format.
Currency of the payment, as an ISO 4217 currency code.
Unique identifier of the payment.
Payment method type. Possible values are TRANSFER, CARD_TRANSACTION, EXTERNAL.
Details of the card transaction used to pay the bill.
Unique identifier of the Airwallex account associated with the wallet that funded the card payment.
Card funding type. Possible values are CREDIT, CASH.
Unique identifier of the card used for payment.
Unique identifier of the card transaction.
Transaction amount in the source currency before conversion.
Currency of the original card transaction, as an ISO 4217 currency code.
Timestamp of the card transaction in ISO8601 format.
Details of the transfer used to pay the bill.
Unique identifier of the Airwallex account associated with the wallet that funded the transfer.
Whether this transfer payment pays multiple bills.
Date when the transfer was made, in ISO8601 format.
Unique identifier of the transfer.
Transfer amount in the source currency before conversion.
Currency of the original transfer, as an ISO 4217 currency code.
Total amount of the bill.
Currency of the bill, as an ISO 4217 currency code.
Timestamp for when the resource was created in ISO8601 format.
Description of the bill.
Date when the bill is due, in ISO8601 format.
External identifier for this bill in your system.
Unique identifier of the bill.
Invoice number associated with the bill.
Date when the bill was issued, in ISO8601 format.
Unique identifier of the legal entity associated with the bill.
List of line items on the bill.
List of accounting fields selected for the line item.
Type of accounting field. Possible values are SUBSIDIARY, MERCHANT, GENERAL_LEDGER_ACCOUNT, TAX_CODE, CLASS, DEPARTMENT, LOCATION, PROJECT, OTHER.
Name of the accounting field value in the ERP.
External unique identifier of the accounting field value in the ERP.
Name of the accounting field in the ERP software. This field is populated only when type is set to OTHER.
Name of the accounting field value displayed in Airwallex.
Unique identifier of the line item.
Total amount for this line item.
Description of the line item.
Unique identifier of the purchase order line item associated with this bill line item.
Quantity of the line item.
Tax amount for this line item.
Unit price of the line item.
Unique identifier of the purchase order associated with the bill.
Bill status. Possible values are DRAFT, AWAITING_APPROVAL, AWAITING_PAYMENT, PAYMENT_IN_PROGRESS, PAID, REJECTED, SCHEDULED.
Error message describing the sync failure reason, populated when the sync status is updated via the API. Null when no sync error has occurred.
Sync status for an accounting system. Possible values are NOT_SYNCED, SYNCED, SYNC_FAILED.
Tax status indicating whether amounts include or exclude tax. Possible values are TAX_EXCLUSIVE, TAX_INCLUSIVE, UNSPECIFIED.
Timestamp for when the resource was updated in ISO8601 format.
Unique identifier of the vendor associated with the bill.
| Error status | Description |
|---|---|
| 400 | Invalid Request. |
| 404 | Not found. |
| 500 | Internal server error. |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/spend/bills/bill_id/sync' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "sync_status": "SYNC_FAILED",> "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.">}'
1{2 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",3 "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg",4 "invoice_number": "INV-0001",5 "billing_amount": "551.0",6 "billing_currency": "USD",7 "status": "AWAITING_PAYMENT",8 "sync_status": "SYNCED",9 "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.",10 "tax_status": "TAX_EXCLUSIVE",11 "description": "Office supplies for Q1 2025.",12 "approvers": [13 "[email protected]",14 "[email protected]"15 ],16 "issued_date": "2025-01-10",17 "due_date": "2025-01-10",18 "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",19 "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e",20 "bill_payments": [21 {22 "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",23 "type": "CARD_TRANSACTION",24 "amount": "300.00",25 "currency": "USD",26 "card_transaction": {27 "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",28 "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92",29 "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp",30 "card_funding_type": "CREDIT",31 "source_amount": "300.00",32 "source_currency": "USD",33 "transacted_at": "2025-01-02T00:00:00Z"34 },35 "created_at": "2025-01-02T00:00:00Z"36 },37 {38 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",39 "type": "TRANSFER",40 "amount": "251.00",41 "currency": "USD",42 "transfer": {43 "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92",44 "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp",45 "multi_bill": false,46 "source_amount": "251.00",47 "source_currency": "USD",48 "transfer_date": "2025-01-01"49 },50 "created_at": "2025-01-01T00:00:00Z"51 }52 ],53 "external_id": "BILL-EXT-001",54 "attachments": [55 {56 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",57 "content_type": "image/jpeg",58 "file_name": "flight_receipt.jpg",59 "file_url": "https://www.airwallex.com/flight_receipt.jpg",60 "created_at": "2025-02-02T00:00:00Z"61 }62 ],63 "line_items": [64 {65 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",66 "unit_price": "100.0",67 "quantity": "5",68 "description": "Office supplies",69 "total_amount": "500.0",70 "tax_amount": "51.0",71 "accounting_field_selections": [72 {73 "type": "OTHER",74 "name": "Cost Center",75 "external_id": "1036f6f7-87e4-4508-b865-f670b1926022",76 "value": "Office Expense",77 "value_label": "Office Expense"78 }79 ],80 "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d"81 }82 ],83 "created_at": "2025-01-01T00:00:00Z",84 "updated_at": "2025-02-02T00:00:00Z"85}
Create bill
POST /api/v1/spend/bills/create
Creates a new bill.
Currency of the bill, as an ISO 4217 currency code.
Date when the bill is due, in ISO8601 format.
External identifier for this bill in your system.
Invoice number associated with the bill.
Date when the bill was issued, in ISO8601 format.
Unique identifier of the legal entity associated with the bill.
List of line items on the bill.
Quantity of the line item.
Unit price of the line item (tax-exclusive). Tax is applied separately based on the selected tax rate.
List of accounting fields selected for the line item.
ID of the accounting field. If AIRWALLEX_ID is selected as identifier_type this refers to the unique identifier of the accounting field in the Airwallex system. If EXTERNAL_ID is selected as identifier_type, this refers to the unique identifier of the accounting field in the ERP system. Use Chart of accounts for chart of account and Tax rates for tax rate. For remaining custom accounting data connections, use the category name to specify the field.
ID of the accounting field value. If AIRWALLEX_ID is selected as identifier_type this refers to the unique identifier of the accounting field value in the Airwallex system. If EXTERNAL_ID is selected as identifier_type, this refers to the unique identifier of the accounting field value in the ERP system.
Type of identifier used for accounting field references. Choose AIRWALLEX_ID to reference internal Airwallex UUIDs, or EXTERNAL_ID to reference identifiers from your integrated ERP system.
Description of the line item.
Unique identifier of the purchase order line item associated with this bill line item.
Unique identifier for this request to ensure idempotency. To prevent accidental duplication, clients should generate a random UUID.
Sync status for an accounting system. Possible values are NOT_SYNCED, SYNCED, SYNC_FAILED.
Tax status for bill creation. Possible values are TAX_EXCLUSIVE, TAX_INCLUSIVE.
Unique identifier of the vendor associated with the bill.
Description of the bill.
Unique identifier of the purchase order associated with the bill.
List of user emails who can approve the bill.
List of file attachments associated with the bill.
MIME type of the attached file. Common types include image/jpeg, image/png, and application/pdf.
Timestamp for when the resource was created in ISO8601 format.
Original filename of the uploaded attachment, including the file extension.
URL to access and download the attachment file. Authentication is required.
Unique identifier of the attachment.
List of payments applied to the bill.
Amount of the payment.
Timestamp for when the resource was created in ISO8601 format.
Currency of the payment, as an ISO 4217 currency code.
Unique identifier of the payment.
Payment method type. Possible values are TRANSFER, CARD_TRANSACTION, EXTERNAL.
Details of the card transaction used to pay the bill.
Unique identifier of the Airwallex account associated with the wallet that funded the card payment.
Card funding type. Possible values are CREDIT, CASH.
Unique identifier of the card used for payment.
Unique identifier of the card transaction.
Transaction amount in the source currency before conversion.
Currency of the original card transaction, as an ISO 4217 currency code.
Timestamp of the card transaction in ISO8601 format.
Details of the transfer used to pay the bill.
Unique identifier of the Airwallex account associated with the wallet that funded the transfer.
Whether this transfer payment pays multiple bills.
Date when the transfer was made, in ISO8601 format.
Unique identifier of the transfer.
Transfer amount in the source currency before conversion.
Currency of the original transfer, as an ISO 4217 currency code.
Total amount of the bill.
Currency of the bill, as an ISO 4217 currency code.
Timestamp for when the resource was created in ISO8601 format.
Description of the bill.
Date when the bill is due, in ISO8601 format.
External identifier for this bill in your system.
Unique identifier of the bill.
Invoice number associated with the bill.
Date when the bill was issued, in ISO8601 format.
Unique identifier of the legal entity associated with the bill.
List of line items on the bill.
List of accounting fields selected for the line item.
Type of accounting field. Possible values are SUBSIDIARY, MERCHANT, GENERAL_LEDGER_ACCOUNT, TAX_CODE, CLASS, DEPARTMENT, LOCATION, PROJECT, OTHER.
Name of the accounting field value in the ERP.
External unique identifier of the accounting field value in the ERP.
Name of the accounting field in the ERP software. This field is populated only when type is set to OTHER.
Name of the accounting field value displayed in Airwallex.
Unique identifier of the line item.
Total amount for this line item.
Description of the line item.
Unique identifier of the purchase order line item associated with this bill line item.
Quantity of the line item.
Tax amount for this line item.
Unit price of the line item.
Unique identifier of the purchase order associated with the bill.
Bill status. Possible values are DRAFT, AWAITING_APPROVAL, AWAITING_PAYMENT, PAYMENT_IN_PROGRESS, PAID, REJECTED, SCHEDULED.
Error message describing the sync failure reason, populated when the sync status is updated via the API. Null when no sync error has occurred.
Sync status for an accounting system. Possible values are NOT_SYNCED, SYNCED, SYNC_FAILED.
Tax status indicating whether amounts include or exclude tax. Possible values are TAX_EXCLUSIVE, TAX_INCLUSIVE, UNSPECIFIED.
Timestamp for when the resource was updated in ISO8601 format.
Unique identifier of the vendor associated with the bill.
| Error status | Description |
|---|---|
| 400 | Invalid Request. |
| 404 | Not found. |
| 500 | Internal server error. |
$curl --request POST \> --url 'https://api.sandbox.airwallex.com/api/v1/spend/bills/create' \> --header 'Authorization: Bearer {{ACCESS_TOKEN}}' \> --header 'Content-Type: application/json' \> --data '{> "request_id": "985461d5-016f-4e1f-a387-5f1380b42d92",> "external_id": "BILL-EXT-001",> "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg",> "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",> "invoice_number": "INV-0001",> "issued_date": "2025-01-10",> "due_date": "2025-01-10",> "billing_currency": "USD",> "tax_status": "TAX_EXCLUSIVE",> "sync_status": "SYNCED",> "line_items": [> {> "description": "Office supplies",> "quantity": "10",> "unit_price": "500.0",> "accounting_field_selections": [> {> "identifier_type": "EXTERNAL_ID",> "field_id": "Chart of accounts",> "field_value_id": "EXT-SALES-003"> }> ],> "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d"> }> ],> "description": "Office supplies for Q1 2025.",> "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e">}'
1{2 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",3 "legal_entity_id": "le_U3jlHqQRNHWn2zAKeeT8sg",4 "invoice_number": "INV-0001",5 "billing_amount": "551.0",6 "billing_currency": "USD",7 "status": "AWAITING_PAYMENT",8 "sync_status": "SYNCED",9 "sync_error_message": "Failed to sync bill: found a mismatch between the bill payment and bill currency.",10 "tax_status": "TAX_EXCLUSIVE",11 "description": "Office supplies for Q1 2025.",12 "approvers": [13 "[email protected]",14 "[email protected]"15 ],16 "issued_date": "2025-01-10",17 "due_date": "2025-01-10",18 "vendor_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",19 "purchase_order_id": "ca56f0ff-8081-4db6-8333-4e011fe9561e",20 "bill_payments": [21 {22 "id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",23 "type": "CARD_TRANSACTION",24 "amount": "300.00",25 "currency": "USD",26 "card_transaction": {27 "card_transaction_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d",28 "card_id": "985461d5-016f-4e1f-a387-5f1380b42d92",29 "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp",30 "card_funding_type": "CREDIT",31 "source_amount": "300.00",32 "source_currency": "USD",33 "transacted_at": "2025-01-02T00:00:00Z"34 },35 "created_at": "2025-01-02T00:00:00Z"36 },37 {38 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",39 "type": "TRANSFER",40 "amount": "251.00",41 "currency": "USD",42 "transfer": {43 "transfer_id": "985461d5-016f-4e1f-a387-5f1380b42d92",44 "account_id": "acct_a2y0pxz3m4k5hoZldn97hjzp",45 "multi_bill": false,46 "source_amount": "251.00",47 "source_currency": "USD",48 "transfer_date": "2025-01-01"49 },50 "created_at": "2025-01-01T00:00:00Z"51 }52 ],53 "external_id": "BILL-EXT-001",54 "attachments": [55 {56 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",57 "content_type": "image/jpeg",58 "file_name": "flight_receipt.jpg",59 "file_url": "https://www.airwallex.com/flight_receipt.jpg",60 "created_at": "2025-02-02T00:00:00Z"61 }62 ],63 "line_items": [64 {65 "id": "985461d5-016f-4e1f-a387-5f1380b42d92",66 "unit_price": "100.0",67 "quantity": "5",68 "description": "Office supplies",69 "total_amount": "500.0",70 "tax_amount": "51.0",71 "accounting_field_selections": [72 {73 "type": "OTHER",74 "name": "Cost Center",75 "external_id": "1036f6f7-87e4-4508-b865-f670b1926022",76 "value": "Office Expense",77 "value_label": "Office Expense"78 }79 ],80 "purchase_order_line_item_id": "ba46f0ff-8081-4db6-8333-4e011fe9561d"81 }82 ],83 "created_at": "2025-01-01T00:00:00Z",84 "updated_at": "2025-02-02T00:00:00Z"85}