GET
List customer payments
Company space For: Cashier and seller, Manager, Accountant · Permission: customer_credit_payments.list Part of Collect customer credit.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

customer_id
string | null

Only the payments of this customer.

Required string length: 27
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
sort_by
enum<string> | null

Field the list is sorted by.

Available options:
id,
payment_date,
created_at,
reference,
amount
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, customer_id, source, cash_register_id, amount, currency_code, currency_exponent, original_amount, original_currency_code, original_currency_exponent, conversion_snapshot, actual_fee_amount, register_payment_method_id, payment_method, money_account_id, cash_account_id, payment_date, reference, description, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

Resource.

data
CreditPaymentResource · object[]
required

Items of this page.

meta
object
required

Pagination details.