Errors

In this guide, we will talk about what happens when something goes wrong while you work with the API. Let's look at some status codes and error types you might encounter.

You can tell if your request was successful by checking the status code when receiving an API response. If a response comes back unsuccessful, you can use the error type and error message to see what has gone wrong.


Status codes

Here is a list of the different categories of status codes returned by the InvoiceAhoy API. Use these to understand if a request was successful.

  • Name
    2xx
    Description

    A 2xx status code indicates a successful response.

  • Name
    4xx
    Description

    A 4xx status code indicates a request error — for example an incorrect or missing request parameter. problem.

  • Name
    5xx
    Description

    A 5xx status code indicates a server error. Please reach out to support if you encounter these.


Error types

Whenever a request is unsuccessful, the InvoiceAhoy API will return an error response with an error type and message. You can use this information to understand better what has gone wrong and how to fix it.

Here is a list of the two error types supported by the InvoiceAhoy API —

  • Name
    api_error
    Description

    This means that there is an error with the API.

  • Name
    invalid_request
    Description

    This means that the request was invalid.

  • Name
    document_exists
    Description

    This means that the request tried to create a document that already exists, e.g. sending a doc_number that already exists for a sequence.

  • Name
    not_allowed
    Description

    This means that the request is trying to invoke a feature that is not included in the current plan of the organization.

  • Name
    not_authorized
    Description

    The API key used in the request is not valid.

Error response

{
  "error": "invalid_request",
  "message": "The request is missing a required field [currency]",
  "documentation_url": "https://invoiceahoy.com/docs/errors"
}

Was this page helpful?