dashboard:readUser IDPayment-status options for the payment dashboard filter.
Without type the full static list is returned: Draft, Submitted, Pending Approval,
Awaiting Payment, Completed, Completed (no charge), Cancelled. With type (an invoice
type from GET /v1/filters/invoice-type) only the statuses that actually occur on the
caller's payments of that invoice type are returned.
typestringInvoice type to narrow the statuses by (see GET /v1/filters/invoice-type).
Payment-status filter list retrieved successfully.
HTTP status code
Response message
List of available filter options.
Array of filter options.
A single filter option with a display name and value identifier.
Unique request ID for tracking
Example
{
"status_code": 200,
"message": "Success",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"data": {
"items": [
{
"name": "Awaiting Payment",
"id": "Awaiting Payment"
},
{
"name": "Completed",
"id": "Completed"
}
]
}
}Was this page helpful?