GET
List payment sources (organization)
Organization space Accounting module For: Accountant · Permission: accounting_payment_sources.list Conditions
  • The accounting module must be active for the organization.
  • The caller must have been granted access to the book in the URL.
  • The book in the URL must be a company book; the organization’s own book or a client book is refused.
  • Only payment sources of that company are listed.
  • Cheque payments are never listed here; filtering on payment_method cheque is refused, because cheques have their own resource.
  • to must not be before from, and max_amount must not be below min_amount.
Part of Card and payment settlements.

Authorizations

Authorization
string
header
required

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

Path Parameters

book
string
required

Identifier of the company book whose payment sources are listed.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
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.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
received_at,
functional_amount,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
payment_method
enum<string> | null

Keeps only payments made with this method: cash, credit_card, bank_transfer, mobile_money or other. cheque is refused.

Available options:
cash,
credit_card,
bank_transfer,
mobile_money,
cheque,
other
accounting_status
string | null

Keeps only payment sources in this accounting status (up to 40 characters): not_initiated, initiated, settled, cancelled or reversed.

Maximum string length: 40
source_type
string | null

Keeps only payments recorded by this kind of business record, for example order_payment or customer_credit_payment.

Maximum string length: 100
source_id
string | null

Keeps only the payment source created by this business record (27-character KSUID string).

Required string length: 27
customer_id
string | null

Keeps only payments of this customer (27-character KSUID string).

Required string length: 27
from
string<date-time> | null

Keeps payments received on or after this date (ISO 8601); the whole day is included.

to
string<date-time> | null

Keeps payments received on or before this date (ISO 8601); the whole day is included. Must not be before from.

min_amount
integer | null

Keeps payments whose amount (functional_amount, in minor units of the company currency) is at least this integer.

Required range: x >= 0
max_amount
integer | null

Keeps payments whose amount (functional_amount, in minor units of the company currency) is at most this integer. Must not be below min_amount.

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, company_id, organization_id, source_type, source_id, payment_method, register_payment_method_id, money_account_id, functional_amount, currency_code, currency_exponent, original_amount, original_currency_code, original_currency_exponent, company_settlement_amount, company_incoming_fee_snapshot, customer, customer_id, order, reference, received_at, accounting_status, settlement_id, 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: settlement.

Response

Resource.

data
PaymentSourceResource · object[]
required

Items of this page.

meta
object
required

Pagination details.