Allocations
List allocations
get/accounting/allocations/{invoiceType}
Request
- Base URL: https://api.clearbooks.co.uk/v1
- URL: https://api.clearbooks.co.uk/v1/accounting/allocations/{invoiceType}
- Auth: OAuth 2 (authorization code, authorization URL https://secure.clearbooks.co.uk/account/action/oauth/, token URL https://api.clearbooks.co.uk/oauth/token, scopes: accounting.allocations:read)
Path parameters
invoiceType'sales' | 'purchases' required
Type of invoice
Query parameters
allocationType'creditNote' | 'payment'
Allocation item type
paymentIdinteger
ID of payment
creditNoteIdinteger
ID of credit note
invoiceIdinteger
ID of a sales or purchase invoice
sortBystring
The field to sort results by
sortDirection'ascending' | 'descending'
The direction to sort the results
limitinteger
The number of results to return
pageinteger
The page of results to return
Headers
X-Business-IDinteger
ID of the business to use (required for multi-business authorisations only)
Response
An array of payment allocations
Changes
No recorded changes to this operation across all 1 revision of this API.