v4

latestOpenAPI 3.1.02026-08-03427198448.4 KB
internal

List Payments

List payments with optional filters.

get/api/internal/payments

Query parameters

user_idstring
org_idstring
invoice_idstring nullable

Filter by invoice UUID

Filter by invoice UUID

client_idstring nullable

Filter by client UUID

Filter by client UUID

payment_typestring nullable

Filter by payment type: stripe, cash, cheque, credit_card, bank_transfer, other

Filter by payment type: stripe, cash, cheque, credit_card, bank_transfer, other

invoice_numberstring nullable

Filter by invoice number

Filter by invoice number

order_bystring nullable

Column to sort by (e.g., payment_date, amount, created_at)

Column to sort by (e.g., payment_date, amount, created_at)

order_descboolean nullable

Sort in descending order (most recent first)

Sort in descending order (most recent first)

limitinteger

Maximum number of payments to return

Maximum number of payments to return

offsetinteger

Number of payments to skip

Number of payments to skip

Response

Successful Response

{"stackTrail":"paths:/api/internal/payments:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}