getAllPayments
Retrieve all payments by filtering based on payment IDs, customer IDs, bill IDs, creation/consumption date ranges, payment states, or pagination settings.
Instructions
Returns all payments based on filter parameters
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| BillIds | No | Filter by bill IDs | |
| ConsumedUtc | No | Date range filter for payment consumption | |
| CreatedUtc | No | Date range filter for payment creation | |
| CustomerIds | No | Filter by customer IDs | |
| Limitation | No | Pagination settings | |
| PaymentIds | No | Filter by specific payment IDs | |
| States | No | Filter by payment states |
Input Schema (JSON Schema)
{
"additionalProperties": false,
"properties": {
"BillIds": {
"description": "Filter by bill IDs",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"ConsumedUtc": {
"description": "Date range filter for payment consumption",
"properties": {
"EndUtc": {
"description": "End of consumption date range (ISO 8601)",
"type": "string"
},
"StartUtc": {
"description": "Start of consumption date range (ISO 8601)",
"type": "string"
}
},
"type": "object"
},
"CreatedUtc": {
"description": "Date range filter for payment creation",
"properties": {
"EndUtc": {
"description": "End of creation date range (ISO 8601)",
"type": "string"
},
"StartUtc": {
"description": "Start of creation date range (ISO 8601)",
"type": "string"
}
},
"type": "object"
},
"CustomerIds": {
"description": "Filter by customer IDs",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"Limitation": {
"description": "Pagination settings",
"properties": {
"Count": {
"description": "Maximum number of payments to return",
"type": "number"
},
"Cursor": {
"description": "Pagination cursor for next page",
"type": "string"
}
},
"type": "object"
},
"PaymentIds": {
"description": "Filter by specific payment IDs",
"items": {
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
"States": {
"description": "Filter by payment states",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
}