Skip to navigation
API ReferenceTransactions and Statements

Get account statement

Returns the statement of an account your business opened. Without dates, the statement runs from 90 days ago to the end of the current month. The end date is moved to the last day of its month. Dates in the response use DD-MM-YYYY.

A validation failure here answers 400 with the first error as the message.

Authentication

AuthorizationBearer

Your Halo partner API key, sent as Authorization: Bearer <key>.

Request

This endpoint expects an object.
account_numberstringRequired
An account number your business opened. 10 digits.
start_datedate or nullOptional

Start date. On or before end_date.

end_datedate or nullOptional

End date. On or after start_date.

customer_referencestring or nullOptional<=255 characters
Your own reference, echoed back. At most 255 characters.

Response

The statement.
statusboolean
True on success, false otherwise.
messagestring or map from strings to lists of strings
A short message. On a 422 validation failure it is an object of field names to error lists.
status_codeinteger
The HTTP status code.
dataanyOptional
The result. Left out on most errors.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error