v3

latestOpenAPI 3.0.42026-07-312008682.1 MB
Payments

Get all payments

Returns all payments in the system, filtered by various parameters. At least one filter parameter must be specified. Note this operation uses Pagination and supports Portfolio Access Tokens.

post/api/connector/v1/payments/getAll

Request body

ClientTokenstring required

Token identifying the client application.

AccessTokenstring required

Access token of the client application.

Clientstring required

Name and version of the client application.

EnterpriseIdsstring[] nullable

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

PaymentIdsstring[] nullable

Unique identifiers of specific Payment items. Required if no other filter is provided.

AccountIdsstring[] nullable

Unique identifiers of specific Accounts to which payments belong. Required if no other filter is provided.

BillIdsstring[] nullable

Unique identifiers of specific Bill items to which payments are assigned. Required if no other filter is provided.

ReservationIdsstring[] nullable

Unique identifiers of specific Reservations to which payments belong. Required if no other filter is provided.

Currencystring currency nullable

ISO-4217 code of the Currency the item costs should be converted to.

AccountingStatesAccountingState[] nullable

Accounting state of the item.

StatesPaymentState[] nullable

Payment state of the item.

Type'Payment' | 'CreditCardPayment' | 'AlternativePayment' | 'CashPayment' | 'InvoicePayment' | 'ExternalPayment' | 'GhostPayment' | 'TaxDeductedPayment'

Payment

CreditCardPayment

AlternativePayment

CashPayment

InvoicePayment

ExternalPayment

GhostPayment

TaxDeductedPayment

Response

OK

Cursorstring uuid nullable

Unique identifier of the last and hence oldest payment returned. This can be used in Limitation in a subsequent request to fetch the next batch of payments.