Last updated: 2024-12-12 18:42:33

In Billink API, error responses follow a consistent format. All errors are returned with an HTTP status code 200, which indicates the request was processed but there was an issue with the operation.

The format of the error is as follows:

<?xml version='1.0' encoding='UTF-8' ?>
<API>
    <RESULT>ERROR</RESULT>
    <ERROR>
        <CODE>000</CODE>
        <DESCRIPTION>Error message</DESCRIPTION>
    </ERROR>
</API> 

• CODE: A unique error code representing the specific issue.
• DESCRIPTION: A detailed description of the error.

These errors might indicate a variety of issues including but not limited to problems with API versioning, client authentication, missing or incorrect parameters, data format issues, and restrictions on actions (such as workflow limitations or invalid operations).

Common Issues:

1. Client Identification: Errors related to missing or incorrect client username, client id, or API version.
2. Invoice and Workflow Management: Missing or incorrect invoice numbers or workflow data.
3. Order Management: Trying to perform actions on orders that are not allowed or are already processed.
4. Request Limitations: Exceeding request limits (e.g., number of invoices, action frequency).
5. Parameter Validation: Incorrect or unsupported parameters in requests.

This helps you to easily handle and debug issues by following the provided error code descriptions across all API endpoints.

In the next subsections, you will see errors specific to each endpoint. Each of these subsections includes a list of error codes and their corresponding descriptions to help you understand and resolve issues effectively.