Payments

List all payments

get/accounting/payments

Request

  • Base URL: https://api.clearbooks.co.uk/v1
  • URL: https://api.clearbooks.co.uk/v1/accounting/payments
  • 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.payments:read)

Query parameters

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 payments

idinteger
datestring date required

Bank date of the payment.

accountingDatestring date

Accounting date of the payment. Only needs to be provided on create if it differs from the bank date. If not provided, it will be automatically populated with the bank date.

descriptionstring required
amountnumber double required

Amount of the payment. Should be positive for money received, and negative for money paid out.

currencystring

ISO 4217 currency code. This is the currency of the bank account and cannot be set on a per-payment level.

exchangeRateunknown
contactIdinteger required
paymentMethodIdinteger

ID of a payment method available for the specified bank account. Payment method is recorded for reference only and is only visible when viewing individual Clear Books bank transactions and customer/supplier payments reports.

bankAccountIdinteger required

Changes

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