---
title: "List all payments"
method: GET
path: "/accounting/payments"
tags: ["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

- `sortBy` string
- `sortDirection` 'ascending' | 'descending'
- `limit` integer
- `page` integer

## Headers

- `X-Business-ID` integer

## Response `200`

An array of payments

- Payment[]
  - `id` integer
  - `date` string, date, required: Bank date of the payment.
  - `accountingDate` string, 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.
  - `description` string, required
  - `amount` number, double, required: Amount of the payment. Should be positive for money received, and negative for money paid out.
  - `currency` string: ISO 4217 currency code. This is the currency of the bank account and cannot be set on a per-payment level.
  - `exchangeRate` unknown
  - `contactId` integer, required
  - `paymentMethodId` integer: 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.
  - `bankAccountId` integer, required

## Other responses

- `400`: The request was malformed or missing required parameters
- `401`: A valid authorisation token is required to perform this action
- `403`: No permission was granted to perform this action
- `429`: The application is making too many requests and has been rate limited

---

[API](https://skmtc.dev/clearbooks/apis/clear-books-api.md) · [All operations](https://skmtc.dev/clearbooks/apis/clear-books-api/llms.txt) · [OpenAPI document](https://skmtc.dev/clearbooks/apis/clear-books-api/revisions/5e46fa6863a7?raw)