searchCriteria
A set of search criteria.
Contains elements as defined in the following table.
| Component | Type | Occurs | Nillable? | Description |
|---|---|---|---|---|
| anyId | id | 0..1 | No | Any identity associated with the payment, not just the payment identity. This includes the transaction identity, the invoice and credit note numbers, as well as the order number of any payment part belonging to the payment. If the exact payment identity is known, it is generally a better idea to use the getPayment() method as that is a lot quicker. |
| paymentMethodId | id | 0..1 | No | The identity of the payment method. |
| governmentId | nonEmptyString | 0..1 | No | The desired customer government identity. |
| customerName | string | 0..1 | No | The desired customer name. Please be aware that searches will be performed on the full (possibly composite name) of the customer. |
| bookedFrom | dateTime | 0..1 | No | The earliest desired payment booking timestamp. |
| bookedTo | dateTime | 0..1 | No | The latest desired payment booking timestamp. |
| modifiedFrom | dateTime | 0..1 | No | The earliest desired payment modification timestamp. |
| modifiedTo | dateTime | 0..1 | No | The latest desired payment modification timestamp. |
| finalizedFrom | dateTime/development/api-types/ | 0..1 | No | No The earliest desired payment finalization timestamp. |
| finalizedTo | dateTime | 0..1 | No | The latest desired payment finalization timestamp. |
| amountFrom | positiveDecimal | 0..1 | No | The minimum desired total payment amount. Please be aware that searches will be performed on the current total payment amount, i.e. taking taking into consideration the status of the various payment parts |
| amountTo | positiveDecimal | 0..1 | No | The maximum desired total payment amount. Please be aware that searches will be performed on the current total payment amount, i.e. taking taking into consideration the status of the various payment parts. |
| bonusFrom | nonNegativeInteger | 0..1 | Yes | The minimum desired total payment bonus amount. Please be aware that searches will be performed on the current total payment bonus amount, i.e. not taking into consideration the status of the various payment diffs. |
| bonusTo | nonNegativeInteger | 0..1 | Yes | The maximum desired total payment bonus amount. Please be aware that searches will be performed on the current total payment bonus amount, i.e. not taking into consideration the status of the various payment diffs. |
| frozen | boolean | 0..1 | No | The payment freeze status. |
| withMetaData | withMetaData | 0..1 | No | The desired meta data. |
| statusSet | paymentStatus | 0..100 | No | List of the statuses the payment must have. |
| statusNotSet | paymentStatus | 0..100 | No | List of the statuses the payment must not have |