Endpoint Reference

All paths below are relative to {api_base_url}, which normally ends in /v1. Authenticate every call with the bearer token supplied for the environment.

General endpoints

Method Path Purpose
GET /version/ Retrieve the current AECloud API version.
GET /lhdn/classification_code List product or service classification codes.
GET /lhdn/currency_code List currency codes.
GET /lhdn/payment_method List payment-method codes.
GET /lhdn/tax_type List tax-type codes.
GET /lhdn/unit_type List units of measurement.
POST /lhdn/tin_validation Validate a TIN, identification type, and identification number combination.
GET /lhdn/tin_search Search for a taxpayer TIN using identification details.

Sale document endpoints

Each of the four sale families implements the same six-operation pattern.

Document Submission Status by GUID Status by submission range
Invoice POST /sale/invoice_submission GET /sale/invoice_checkstatus/by_guid GET /sale/invoice_checkstatus/by_submission
Credit note POST /sale/credit_note_submission GET /sale/credit_note_checkstatus/by_guid GET /sale/credit_note_checkstatus/by_submission
Debit note POST /sale/debit_note_submission GET /sale/debit_note_checkstatus/by_guid GET /sale/debit_note_checkstatus/by_submission
Refund note POST /sale/refund_note_submission GET /sale/refund_note_checkstatus/by_guid GET /sale/refund_note_checkstatus/by_submission
Document Cancellation Void by GUID Void by sale code
Invoice POST /sale/invoice_cancellation POST /sale/invoice_void/by_sale_guid POST /sale/invoice_void/by_sale_code
Credit note POST /sale/credit_note_cancellation POST /sale/credit_note_void/by_sale_guid POST /sale/credit_note_void/by_sale_code
Debit note POST /sale/debit_note_cancellation POST /sale/debit_note_void/by_sale_guid POST /sale/debit_note_void/by_sale_code
Refund note POST /sale/refund_note_cancellation POST /sale/refund_note_void/by_sale_guid POST /sale/refund_note_void/by_sale_code

Self-billed document endpoints

Document Submission Status by GUID Status by submission range
Invoice POST /self_billed/invoice_submission GET /self_billed/invoice_checkstatus/by_guid GET /self_billed/invoice_checkstatus/by_submission
Credit note POST /self_billed/credit_note_submission GET /self_billed/credit_note_checkstatus/by_guid GET /self_billed/credit_note_checkstatus/by_submission
Debit note POST /self_billed/debit_note_submission GET /self_billed/debit_note_checkstatus/by_guid GET /self_billed/debit_note_checkstatus/by_submission
Refund note POST /self_billed/refund_note_submission GET /self_billed/refund_note_checkstatus/by_guid GET /self_billed/refund_note_checkstatus/by_submission
Document Cancellation Void by GUID Void by sale code
Invoice POST /self_billed/invoice_cancellation POST /self_billed/invoice_void/by_sale_guid POST /self_billed/invoice_void/by_sale_code
Credit note POST /self_billed/credit_note_cancellation POST /self_billed/credit_note_void/by_sale_guid POST /self_billed/credit_note_void/by_sale_code
Debit note POST /self_billed/debit_note_cancellation POST /self_billed/debit_note_void/by_sale_guid POST /self_billed/debit_note_void/by_sale_code
Refund note POST /self_billed/refund_note_cancellation POST /self_billed/refund_note_void/by_sale_guid POST /self_billed/refund_note_void/by_sale_code

Parameter placement

Operation Input placement
Submission Raw JSON request body.
Status by GUID sale_guid request header.
Status by submission range company_guid, submission_from, submission_to, and optional outlet_name request headers. Dates use YYYY-MM-DD.
Cancellation JSON body containing uppercase SALE_GUID and REASON.
Void by GUID JSON body containing uppercase SALE_GUID.
Void by sale code JSON body containing uppercase COMPANY_CODE, OUTLET_NAME, TERMINAL_NAME, SHIFT_CODE, and SALE_CODE.

Collection status endpoints return at most 25 rows per page. Process the paging metadata or navigation links returned by the service rather than assuming that the first response is complete.