Invoices: Retrieves a continuation-token paged, filtered list of invoices.
GET
/api/invoicing/invoices
deprecated
Requires: Invoicing.Invoices, merchant scope.
The public invoice list surface is continuation-token only (Cosmos charges RU per skipped row on a skip/take path). The in-process skip/take `GetListAsync` is implemented explicitly below so it satisfies the CRUD contract without being exposed over HTTP.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
BillerId
required |
query | string (uuid) | Filter by billing entity. |
BillerType
required |
query | WinkPGInvoicingInvoicePartyType | Filter by biller type. |
RecipientId
required |
query | string (uuid) | Filter by recipient. |
Status
required |
query | WinkPGInvoicingInvoiceStatus | Filter by status. |
InvoiceNumber
required |
query | string | Filter by invoice number (partial match). |
Currency
required |
query | string | Filter by currency (exact match). |
MinIssueDate
required |
query | string (date-time) | Filter invoices issued on or after this date. |
MaxIssueDate
required |
query | string (date-time) | Filter invoices issued on or before this date. |
MinDueDate
required |
query | string (date-time) | Filter invoices due on or after this date. |
MaxDueDate
required |
query | string (date-time) | Filter invoices due on or before this date. |
MinAmount
required |
query | number (double) | Filter by minimum grand total. An invoice with no grand total (a null `GrandTotal`) is excluded when this bound is set, consistently across the list, count, and export. |
MaxAmount
required |
query | number (double) | Filter by maximum grand total. An invoice with no grand total (a null `GrandTotal`) is excluded when this bound is set, consistently across the list, count, and export. |
SourceType
required |
query | WinkPGInvoicingInvoiceSourceType | Filter by source type. |
Filter.Logic
required |
query | PhoenixAbpCoreDataFilteringFilterLogic | |
Filter.Rules
required |
query | array of PhoenixAbpCoreDataFilteringFilterRule | |
Filter.Groups
required |
query | array of PhoenixAbpCoreDataFilteringFilterGroup | |
MaxResultCount
required |
query | integer (int32) | |
ContinuationToken
required |
query | string | |
IncludeDeleted
required |
query | boolean | |
IncludeInactive
required |
query | boolean | |
Sorting.Field
required |
query | string | |
Sorting.Descending
required |
query | boolean | |
suppressNulls
required |
query | boolean | If true, omit properties with null values. |
Request body
application/json
, required
| Field | Type | Description |
|---|
This request body has no documented fields.
Responses
200 OK
| Field | Type | Description |
|---|
This response has no documented body fields.
403 Forbidden
| Field | Type | Description |
|---|
This response has no documented body fields.
401 Unauthorized
| Field | Type | Description |
|---|
This response has no documented body fields.
400 Bad Request
| Field | Type | Description |
|---|
This response has no documented body fields.
404 Not Found
| Field | Type | Description |
|---|
This response has no documented body fields.
501 Not Implemented
| Field | Type | Description |
|---|
This response has no documented body fields.
500 Internal Server Error
| Field | Type | Description |
|---|
This response has no documented body fields.
default The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.
| Field | Type | Description |
|---|
This response has no documented body fields.
Errors
A failed request returns the platform error envelope. The
error reference lists every value
error.code can carry and shows the four response shapes.