Allocations

Create an allocation

Payments and credit notes that use a different currency to the base currency of the Clear Books account, can only be allocated to invoices and bills of the same currency.

post/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:write)

Path parameters

invoiceType'sales' | 'purchases' required

Type of invoice

Headers

X-Business-IDinteger

ID of the business to use (required for multi-business authorisations only)

Request body

Payment required(unresolved $ref)
OR
CreditNote required(unresolved $ref)

Response

Allocation created

Payment required(unresolved $ref)
OR
CreditNote required(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.