Invoices
Get a list of attachments for an invoice
Changed onRetrieve a paged collection of attachments belonging to an invoice (required scope attachments:read)
get/v1/finance/invoices/{invoiceId}/attachments
Request
- Base URLhttps://api.bigchange.com
- AuthHTTP bearer
Path parameters
invoiceIdinteger required
The invoice id
Query parameters
fileNamestring
Only return attachments where the file name contains this value
sortBy'createdAt'
The field to sort attachments by<p>Possible values:</p><ul><li><b>createdAt</b>: Sort by the date the attachment was created</li></ul>
Example:createdAt
The field to sort items in the page by
direction'ascending' | 'descending'
Represents the direction in which sorting should be applied<p>Possible values:</p><ul><li><b>ascending</b>: Indicates ascending sorting order</li><li><b>descending</b>: Indicates descending sorting order</li></ul>
Example:ascending
The direction to apply the sort
pageNumberinteger
The page number being requested
pageSizeinteger
The page size being requested
Headers
Customer-Idinteger required
The customer identifier
Response
OK
Example response
{
"items": [
{
"id": 123456,
"fileName": "invoice.pdf",
"fileDescription": "Signed contract",
"fileType": "application/pdf",
"fileExtension": "pdf",
"isNew": true,
"isImage": true,
"createdAt": "2024-01-15T09:30:00.0000000+00:00",
"entityType": "job",
"isResourceVisible": true
}
],
"pageNumber": 2,
"pageSize": 100,
"pageItemCount": 55
}Changes
- info
endpoint added
- info