--- title: "Get all payments" method: POST path: "/api/connector/v1/payments/getAll" tags: ["Payments"] --- # Get all payments `POST /api/connector/v1/payments/getAll` Returns all payments in the system, filtered by various parameters. At least one filter parameter must be specified. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property). ## Request body - PaymentFilterParameters - `ClientToken` string, required — Token identifying the client application. - `AccessToken` string, required — Access token of the client application. - `Client` string, required — Name and version of the client application. - `Limitation` Limitation, required — Limitation on the quantity of data returned. - `Count` integer, required - `Cursor` string, uuid, nullable - `EnterpriseIds` string[], nullable — Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. - `PaymentIds` string[], nullable — Unique identifiers of specific `Payment` items. Required if no other filter is provided. - `AccountIds` string[], nullable — Unique identifiers of specific `Accounts` to which payments belong. Required if no other filter is provided. - `BillIds` string[], nullable — Unique identifiers of specific `Bill` items to which payments are assigned. Required if no other filter is provided. - `ReservationIds` string[], nullable — Unique identifiers of specific `Reservations` to which payments belong. Required if no other filter is provided. - `CreatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `UpdatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `ChargedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `ClosedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `SettlementUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `Currency` string, currency, nullable — ISO-4217 code of the `Currency` the item costs should be converted to. - `AccountingStates` AccountingState[], nullable — Accounting state of the item. - `States` PaymentState[], nullable — Payment state of the item. - `Type` 'Payment' | 'CreditCardPayment' | 'AlternativePayment' | 'CashPayment' | 'InvoicePayment' | 'ExternalPayment' | 'GhostPayment' | 'TaxDeductedPayment' — Payment CreditCardPayment AlternativePayment CashPayment InvoicePayment ExternalPayment GhostPayment TaxDeductedPayment ## Response `200` OK - PaymentResult - `Payments` Payment[], required — The list of filtered payments. - `Id` string, uuid, required — Unique identifier of the payment. - `EnterpriseId` string, uuid, required — Unique identifier of the `Enterprise`. - `AccountId` string, uuid, required — Unique identifier of the account (for example `Customer`) the payment belongs to. - `AccountType` 'Company' | 'Customer', required — A discriminator specifying the account type, e.g. `Customer` or `Company` - `PaymentRequestId` string, uuid, nullable — Unique identifier of the `PaymentRequest` the payment is associated with. - `BillId` string, uuid, nullable — Unique identifier of the `Bill` the payment is assigned to. - `ReservationId` string, uuid, nullable — Unique identifier of the `Reservation` the payment belongs to. - `AccountingCategoryId` string, uuid, nullable — Unique identifier of the `AccountingCategory` the payment belongs to. - `Amount` Amount, required - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts. - `NetValue` number, double, required — The net value that the tax is calculated from. - `TaxValue` number, double, required — The value of the tax. - `OriginalAmount` Amount, required - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts. - `NetValue` number, double, required — The net value that the tax is calculated from. - `TaxValue` number, double, required — The value of the tax. - `Notes` string, nullable — Additional notes. - `SettlementId` string, nullable — Identifier of the settled payment from the external system (ApplePay/GooglePay). - `ConsumedUtc` string, date-time, nullable — Date and time of the item consumption in UTC timezone in ISO 8601 format. - `ClosedUtc` string, date-time, nullable — Date and time of the payment bill closure in UTC timezone in ISO 8601 format. - `ChargedUtc` string, date-time, nullable — Charged date and time of the payment in UTC timezone in ISO 8601 format. - `CreatedUtc` string, date-time, required — Creation date and time of the payment created in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the payment in UTC timezone in ISO 8601 format. - `SettlementUtc` string, date-time, required — Date and time of the payment settlement in UTC timezone in ISO 8601 format. - `AccountingState` 'Open' | 'Closed' | 'Inactive' | 'Canceled', required — Open (Order items which carry a non-zero value, are open, and have not been closed on a bill or invoice.) Closed (Order items which carry a non-zero value and have been closed on a bill or invoice.) Inactive (Order items which are either of zero value and have not been canceled, if the state of the payment item is Pending or Failed, or items of optional reservations. Until the reservation is confirmed, all its accounting items are Inactive.) Canceled (Order items which have been canceled, regardless of whether the item is of zero value.) - `State` 'Charged' | 'Canceled' | 'Pending' | 'Failed' | 'Verifying', required — Charged Canceled Pending Failed Verifying - `Identifier` string, nullable — Additional unique identifier of the payment. - `Type` 'Payment' | 'CreditCardPayment' | 'AlternativePayment' | 'CashPayment' | 'InvoicePayment' | 'ExternalPayment' | 'GhostPayment' | 'TaxDeductedPayment', required — Payment CreditCardPayment AlternativePayment CashPayment InvoicePayment ExternalPayment GhostPayment TaxDeductedPayment - `Kind` 'Payment' | 'Chargeback' | 'ChargebackReversal' | 'Refund' — Payment Chargeback ChargebackReversal Refund - `Data` PaymentData - `Discriminator` 'CreditCard' | 'Invoice' | 'External' | 'Ghost' | 'Alternative', required — CreditCard Invoice External Ghost Alternative - `CreditCard` PaymentCreditCardData - `CreditCardId` string, uuid, nullable — Unique identifier of the payment card. - `Transaction` CreditCardTransaction - `PaymentId` string, uuid, required — Unique identifier of the `PaymentItem`. - `SettlementId` string, nullable — Identifier of the settlement. - `SettledUtc` string, date-time, nullable — Settlement date and time in UTC timezone in ISO 8601 format. - `Fee` ExtendedAmount - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - … - `Breakdown` TaxBreakdown, required - … - `Value` number, double, nullable - `Net` number, double, nullable - `Tax` number, double, nullable - `TaxRate` number, double, nullable - `AdjustedFee` ExtendedAmount - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - … - `Breakdown` TaxBreakdown, required - … - `Value` number, double, nullable - `Net` number, double, nullable - `Tax` number, double, nullable - `TaxRate` number, double, nullable - `ChargedAmount` ExtendedAmount, required - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - … - `Breakdown` TaxBreakdown, required - … - `Value` number, double, nullable - `Net` number, double, nullable - `Tax` number, double, nullable - `TaxRate` number, double, nullable - `SettledAmount` ExtendedAmount - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - … - `Breakdown` TaxBreakdown, required - … - `Value` number, double, nullable - `Net` number, double, nullable - `Tax` number, double, nullable - `TaxRate` number, double, nullable - `Invoice` PaymentInvoiceData - `InvoiceId` string, uuid, nullable — Unique identifier of the invoice `Bill`. - `Type` 'Receivable' | 'Balancing' | 'UnderpaymentBalancingReceivable' | 'OverpaymentBalancingReceivable' | 'Overpayment', required — Receivable Balancing UnderpaymentBalancingReceivable OverpaymentBalancingReceivable Overpayment - `External` PaymentExternalData - `Type` 'Unspecified' | 'BadDebts' | 'Bacs' | 'WireTransfer' | 'Invoice' | 'ExchangeRateDifference' | 'Complimentary' | 'Reseller' | 'ExchangeRoundingDifference' | 'Barter' | 'Commission' | 'BankCharges' | 'CrossSettlement' | 'Cash' | 'CreditCard' | 'Prepayment' | 'Cheque' | 'Bancontact' | 'IDeal' | 'PayPal' | 'GiftCard' | 'LoyaltyPoints' | 'ChequeVacances' | 'OnlinePayment' | 'CardCheck' | 'PaymentHubRedirection' | 'Voucher' | 'MasterCard' | 'Visa' | 'Amex' | 'Discover' | 'DinersClub' | 'Jcb' | 'UnionPay' | 'Twint' | 'Reka' | 'LoyaltyCard' | 'PosDiningAndSpaReward' | 'DirectDebit' | 'DepositCheck' | 'DepositCash' | 'DepositCreditCard' | 'DepositWireTransfer', required — Unspecified (Unspecified (unavailable in French Legal Environment)) BadDebts (Bad debts) Bacs (Bacs payment) WireTransfer (Wire transfer) Invoice (Invoice) ExchangeRateDifference (Exchange rate difference) Complimentary (Complimentary) Reseller (Reseller) ExchangeRoundingDifference (Exchange rounding difference) Barter (Barter) Commission (Commission) BankCharges (Bank charges) CrossSettlement (Cross settlement) Cash (Cash) CreditCard (Credit card – deprecated, only for existing partners) Prepayment (Prepayment) Cheque (Cheque) Bancontact (Bancontact) IDeal (iDeal – deprecated, only for existing partners) PayPal (PayPal – deprecated, only for existing partners) GiftCard (Gift card) LoyaltyPoints (Loyalty points) ChequeVacances (Chèque-Vacances) OnlinePayment (Online payment – deprecated, only for existing partners) CardCheck (Card check) PaymentHubRedirection (Payment hub redirection) Voucher (Voucher) MasterCard (MasterCard – deprecated, only for existing partners) Visa (Visa – deprecated, only for existing partners) Amex (American Express – deprecated, only for existing partners) Discover (Discover – deprecated, only for existing partners) DinersClub (Diners Club – deprecated, only for existing partners) Jcb (JCB – deprecated, only for existing partners) UnionPay (UnionPay – deprecated, only for existing partners) Twint (TWINT) Reka (Reka) LoyaltyCard (Loyalty card) PosDiningAndSpaReward (POS Dining & Spa Reward) DirectDebit (Direct debit) DepositCheck (Deposit - check) DepositCash (Deposit - cash) DepositCreditCard (Deposit - credit card – deprecated, only for existing partners) DepositWireTransfer (Deposit - wire transfer) - `ExternalIdentifier` string, nullable — Identifier of the payment from external system. - `Ghost` PaymentGhostData - `OriginalPaymentId` string, uuid, required — Unique identifier of the original payment. - `Alternative` PaymentAlternativeData - `Type` 'Ideal' | 'ApplePay' | 'GooglePay' | 'SepaDirectDebit' | 'PayPal' | 'WireTransfer', required — Ideal (iDEAL) ApplePay (Apple Pay) GooglePay (Google Pay) SepaDirectDebit (SEPA Direct Debit) PayPal (PayPal) WireTransfer (Wire transfer) - `PaymentOrigin` 'Other' | 'System' | 'Operations' | 'AutomaticPayment' | 'PaymentRequest' | 'BookingEngine' | 'Api' | 'Terminal' | 'ChannelManager' | 'OnlineCheckout' | 'BillBalancing' | 'OnlineCheckin' | 'PointOfSales' | 'PaymentToInvoiceLinking' — Other (Fallback value unmapped in the current version of the API.) System Operations AutomaticPayment PaymentRequest BookingEngine Api (Connector API.) Terminal ChannelManager OnlineCheckout BillBalancing OnlineCheckin PointOfSales PaymentToInvoiceLinking - `Cursor` string, uuid, nullable — Unique identifier of the last and hence oldest payment returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of payments. ## Other responses - `204` — Server has successfully fulfilled the request and there is no additional information to send back. - `400` — Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). - `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. - `403` — Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. - `408` — Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) - `429` — Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). - `500` — Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). --- [API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/81933a8ff730/schema)