Get invoice list
GET {{baseUrl}}/invoices
Description
This API endpoint enables users to retrieve a comprehensive list of all invoices created.
Notes
Make sure you have the necessary authentication and authorization to access that endpoint, if necessary.
The
itemsPerPage
,page
, andmonth
parameters are optional and can be used for filtering and pagination.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
itemsPerPage | null | (optional) Number of items to be displayed per page. | |
page | null | (optional, default: 1) Page number for pagination. | |
month | null | (optional, datetime in ISO format) Filter invoices based on the month. |
RESPONSES
status: OK
{"data":[{"id":189,"invoiceNo":null,"invoiceDate":null,"price":{"amount":129,"currency":"US Dollar","symbol":"$"},"downloadUrl":"https://drayup-ui-dev.azurewebsites.net/uploads/invoices/23350002-189.pdf","booking":{"bookingId":75,"bookingCode":"23350002","checkIn":"2023-08-29T00:00:00","checkOut":"2023-08-30T00:00:00","space":1,"usedSpace":0,"invoiceTerm":1,"isPinCodeUsed":true,"createdDate":"2023-08-29T13:31:02.8137229Z","yard":{"id":1,"name":"Savannah"}}}]}