Sign in

v1

latestOpenAPI 3.0.02026-07-2335196124.2 KB
Accounting

Retrieve accounting payments list

Extract information about accounting payments with filtering and pagination options.

get/payments/

Query parameters

Status'ALL' | 'PAID' | 'PARTIAL_PAID' | 'UNPAID' | 'CANCELED'

Payment status filter. Possible values: ALL, PAID, PARTIAL_PAID, UNPAID, CANCELED

InvoiceDate'anytime' | 'today' | 'yesterday' | 'last7Days' | 'last30Days' | 'currentMonth' | 'lastMonth' | 'lastYear' | 'custom'

Invoice date interval filter. Possible values: anytime, today, yesterday, last7Days, last30Days, currentMonth, lastMonth, lastYear, custom

InvoiceDateStartDatestring

Invoice date start date (required when InvoiceDate is "custom"). Format: YYYY-MM-DD

InvoiceDateEndDatestring

Invoice date end date (required when InvoiceDate is "custom"). Format: YYYY-MM-DD

PaidOn'anytime' | 'today' | 'yesterday' | 'last7Days' | 'last30Days' | 'currentMonth' | 'lastMonth' | 'lastYear' | 'custom'

Paid on interval filter. Possible values: anytime, today, yesterday, last7Days, last30Days, currentMonth, lastMonth, lastYear, custom

PaidOnStartDatestring

Paid on start date (required when PaidOn is "custom"). Format: YYYY-MM-DD

PaidOnEndDatestring

Paid on end date (required when PaidOn is "custom"). Format: YYYY-MM-DD

TransactionType'ALL' | 'SALES' | 'SERVICES' | 'ADJUSTMENTS' | 'DISPUTES' | 'ROLLING_RESERVE' | 'AFF_COMM' | 'PO'

Transaction type filter. Possible values: ALL, SALES, SERVICES, ADJUSTMENTS, DISPUTES, ROLLING_RESERVE, AFF_COMM, PO

Pageinteger

Page number for pagination. Default value is 1.

Limitinteger

Number of results per page. Default value is 100. Maximum value is 200.

Headers

Accept'application/json' required
X-Avangate-Authenticationstring required

Authentication header

Response

OK