# GET /api/invoicing/invoices Invoices: Retrieves a continuation-token paged, filtered list of invoices. Invoices are listed by continuation token only; there is no skip/take list route. **Operation ID:** `invoiceCrudGetContinuationList` ## Authorization Requires: Invoicing.Invoices, merchant scope. Requires API key scope: `admin` Required permissions: - `Invoicing.Invoices` ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | BillerId | query | no | string(uuid) | Filter by billing entity. | | BillerType | query | no | [InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md) | Filter by biller type. | | RecipientId | query | no | string(uuid) | Filter by recipient. | | Status | query | no | [InvoiceStatus](https://devportal.demo.winkpg.io/docs/api/models/InvoiceStatus.md) | Filter by status. | | InvoiceNumber | query | no | string | Filter by invoice number (partial match). | | Currency | query | no | string | Filter by currency (exact match). | | MinIssueDate | query | no | string(date-time) | Filter invoices issued on or after this date. | | MaxIssueDate | query | no | string(date-time) | Filter invoices issued on or before this date. | | MinDueDate | query | no | string(date-time) | Filter invoices due on or after this date. | | MaxDueDate | query | no | string(date-time) | Filter invoices due on or before this date. | | MinAmount | query | no | 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 | query | no | 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 | query | no | [InvoiceSourceType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceSourceType.md) | Filter by source type. | | Filter.Logic | query | no | [FilterLogic](https://devportal.demo.winkpg.io/docs/api/models/FilterLogic.md) | | | Filter.Rules | query | no | array<[FilterRule](https://devportal.demo.winkpg.io/docs/api/models/FilterRule.md)> | | | Filter.Groups | query | no | array<[FilterGroup](https://devportal.demo.winkpg.io/docs/api/models/FilterGroup.md)> | | | MaxResultCount | query | no | integer(int32) | | | ContinuationToken | query | no | string | | | IncludeDeleted | query | no | boolean | | | IncludeInactive | query | no | boolean | | | IncludeApproxTotalCount | query | no | boolean | Set to false to skip the approximate total count query and receive a null count; omit the value or set it to true to receive the count as before. | | Sorting.Field | query | no | string | | | Sorting.Descending | query | no | boolean | | | suppressNulls | query | no | boolean | If true, omit properties with null values. | **`BillerType` values** | Value | Description | | --- | --- | | `GatewayOwner` | Platform-level gateway owner. | | `Reseller` | Reseller entity. | | `Merchant` | Merchant entity. | | `Customer` | End customer. | **`Status` values** | Value | Description | | --- | --- | | `Draft` | Created, editable, not yet issued. | | `Issued` | Locked and immutable from this point forward. | | `Sent` | Delivered to recipient via a notification channel. | | `Viewed` | Recipient opened/viewed the invoice. | | `PartiallyPaid` | Some payments applied, balance remaining. | | `Paid` | Fully paid (balance = 0). | | `PastDue` | Due date passed with outstanding balance. | | `Closed` | Manually closed (write-off). | | `Uncollectible` | Auto-marked after dunning period exhausted (configurable: 30/60/90 days past due). | | `Cancelled` | Voided (only from Draft). | | `Refunded` | Full refund issued. | **`SourceType` values** | Value | Description | | --- | --- | | `Manual` | Manually created by a user. | | `UsageBilling` | Generated from usage billing data. | | `RecurringBilling` | Generated from a recurring billing contract. | | `Api` | Created via API by an external integration. | **`Filter.Logic` values** | Value | Description | | --- | --- | | `And` | | | `Or` | | ## Responses ### 200 A page of invoices, with the token for the next page when there is one. **Content type:** `application/json` Schema: [`ContinuationPagedResultDtoOfInvoiceListDto`](https://devportal.demo.winkpg.io/docs/api/models/ContinuationPagedResultDtoOfInvoiceListDto.md) Properties: - `items` (array<[InvoiceListDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceListDto.md)>): The items returned for this page. (nullable) Fields of each item: - `extraProperties` (object): (nullable, read only) - `id` (string(uuid)) - `creationTime` (string(date-time)): The date and time when this entity was created. - `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable) - `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable) - `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable) - `isDeleted` (boolean): Indicates whether this entity has been deleted. - `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable) - `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable) - `tenantId` (string(uuid)): (nullable) - `billerId` (string(uuid)) - `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice. Values: - `GatewayOwner`: Platform-level gateway owner. - `Reseller`: Reseller entity. - `Merchant`: Merchant entity. - `Customer`: End customer. - `recipientId` (string(uuid)) - `recipientType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice. Values: - `GatewayOwner`: Platform-level gateway owner. - `Reseller`: Reseller entity. - `Merchant`: Merchant entity. - `Customer`: End customer. - `invoiceNumber` (string): (nullable) - `status` ([InvoiceStatus](https://devportal.demo.winkpg.io/docs/api/models/InvoiceStatus.md)): Represents the lifecycle status of an invoice. Values: - `Draft`: Created, editable, not yet issued. - `Issued`: Locked and immutable from this point forward. - `Sent`: Delivered to recipient via a notification channel. - `Viewed`: Recipient opened/viewed the invoice. - `PartiallyPaid`: Some payments applied, balance remaining. - `Paid`: Fully paid (balance = 0). - `PastDue`: Due date passed with outstanding balance. - `Closed`: Manually closed (write-off). - `Uncollectible`: Auto-marked after dunning period exhausted (configurable: 30/60/90 days past due). - `Cancelled`: Voided (only from Draft). - `Refunded`: Full refund issued. - `isLocked` (boolean): (nullable) - `currency` (string): (nullable) - `grandTotal` (number(double)): (nullable) - `amountPaid` (number(double)): (nullable) - `balanceDue` (number(double)): (nullable) - `issueDate` (string(date-time)): (nullable) - `dueDate` (string(date-time)): (nullable) - `sentAt` (string(date-time)): (nullable) - `paidAt` (string(date-time)): (nullable) - `paymentTermsValue` ([PaymentTerms](https://devportal.demo.winkpg.io/docs/api/models/PaymentTerms.md)): (nullable) Values: - `DueOnReceipt`: Payment due immediately upon receipt. - `Net15`: Payment due within 15 days of issue. - `Net30`: Payment due within 30 days of issue. - `Net45`: Payment due within 45 days of issue. - `Net60`: Payment due within 60 days of issue. - `Net90`: Payment due within 90 days of issue. - `Custom`: Custom number of days specified via InvoiceConsts. - `sourceType` ([InvoiceSourceType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceSourceType.md)): (nullable) Values: - `Manual`: Manually created by a user. - `UsageBilling`: Generated from usage billing data. - `RecurringBilling`: Generated from a recurring billing contract. - `Api`: Created via API by an external integration. - `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)) - `concurrencyStamp` (string): (nullable) - `entityVersion` (integer(int32)) - `nextContinuationToken` (string): Continuation token to use when requesting the next page. Null means no additional pages exist. (nullable) - `approxTotalCount` (integer(int64)): An approximate total count of matching items. This value is optional and may be stale or estimated, so treat it as an approximation. (nullable) - `pageItemCount` (integer(int32)): Convenience property for the number of items in this page. (read only) - `retrievedAt` (string(date-time)): When the page was retrieved. Useful for diagnostics and cache behavior. ### 403 Forbidden **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 404 The caller's biller scope does not cover the requested `BillerId` (`Invoicing:Biller:ForeignBillerNotAllowed`). Every biller-filtered invoicing list answers this way. Reported as not-found rather than forbidden so the response cannot be used to probe which billers exist. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 429 The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause. **Content type:** `application/problem+json` Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) Properties: - `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself, so there is no sub-type for a caller to branch on. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines. - `detail` (string) required: A human-readable explanation of this occurrence of the problem. (nullable) - `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the `Retry-After` header. Always at least one: a value of zero would invite an immediate retry that is certain to be rejected again. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## Example request Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key. ### cURL ```bash curl -X GET "{{BASE_URL}}/api/invoicing/invoices" \ -H "api-key: {{API_KEY}}" ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/invoicing/invoices' ` -Headers $headers ``` ### TypeScript (SDK) ```bash npm install @winkpg/winkpg-api ``` ```typescript import { Configuration, InvoicingApi } from '@winkpg/winkpg-api'; const api = new InvoicingApi(new Configuration({ basePath: '{{BASE_URL}}', apiKey: '{{API_KEY}}', })); const { data } = await api.invoiceCrudGetContinuationList(); ``` ### TypeScript (raw HTTP) ```typescript const response = await fetch('{{BASE_URL}}/api/invoicing/invoices', { method: 'GET', headers: { "api-key": "{{API_KEY}}", }, }); const data = await response.json(); ``` ### C# (SDK) ```bash dotnet add package WinkPg.Api.Client ``` ```csharp using WinkPg.Api.Client.Api; using WinkPg.Api.Client.Client; var config = new Configuration { BasePath = "{{BASE_URL}}" }; config.AddApiKey("api-key", "{{API_KEY}}"); var api = new InvoicingApi(config); var result = await api.InvoiceCrudGetContinuationListAsync(); ``` ### C# (raw HTTP) ```csharp using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") }; var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/invoicing/invoices"); request.Headers.Add("api-key", "{{API_KEY}}"); var response = await http.SendAsync(request); response.EnsureSuccessStatusCode(); var json = await response.Content.ReadAsStringAsync(); ``` ### Python (SDK) ```bash pip install winkpg-api ``` ```python import winkpg_api configuration = winkpg_api.Configuration(host="{{BASE_URL}}") configuration.api_key["ApiKey"] = "{{API_KEY}}" with winkpg_api.ApiClient(configuration) as client: api = winkpg_api.InvoicingApi(client) result = api.invoice_crud_get_continuation_list() ``` ### Python (raw HTTP) ```bash pip install requests ``` ```python import requests headers = { "api-key": "{{API_KEY}}", } response = requests.request( "GET", "{{BASE_URL}}/api/invoicing/invoices", headers=headers, ) response.raise_for_status() data = response.json() ``` ## See also - [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.