Invoices: Retrieves a continuation-token paged, filtered list of invoices.

GET /api/invoicing/invoices deprecated

Requires: Invoicing.Invoices, merchant scope.

Invoices are listed by continuation token only; there is no skip/take list route.

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.

The request body is a . See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X GET "{{BASE_URL}}/api/invoicing/invoices" \
  -H "api-key: {{API_KEY}}"

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/invoicing/invoices' `
    -Headers $headers

npm install @winkpg/winkpg-api

TypeScript (SDK)

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)

const response = await fetch('{{BASE_URL}}/api/invoicing/invoices', {
  method: 'GET',
  headers: {
    "api-key": "{{API_KEY}}",
  },
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

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)

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();

pip install winkpg-api

Python (SDK)

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()

pip install requests

Python (raw HTTP)

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()

Parameters

Name	In	Type	Description
`BillerId` required	query	string (uuid)	Filter by billing entity.
`BillerType` required	query	InvoicePartyType	Filter by biller type.
`RecipientId` required	query	string (uuid)	Filter by recipient.
`Status` required	query	InvoiceStatus	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	InvoiceSourceType	Filter by source type.
`Filter.Logic` required	query	FilterLogic
`Filter.Rules` required	query	array of FilterRule
`Filter.Groups` required	query	array of FilterGroup
`MaxResultCount` required	query	integer (int32)
`ContinuationToken` required	query	string
`IncludeDeleted` required	query	boolean
`IncludeInactive` required	query	boolean
`IncludeApproxTotalCount` required	query	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` 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.