View as Markdown

llms.txt

The API reference isn't available right now

This instance couldn't load its API specification. The reference returns as soon as the specification is readable again.

Back to the API reference

No such operation

This instance documents no operation under that identifier. It may have been renamed, or it may belong to a feature this installation hasn't enabled.

Back to the API reference

This reference may be out of date

This instance couldn't reach its API specification on the last attempt, so this page shows the copy fetched before that. Anything added or changed since then is missing here, and the reference updates itself as soon as the specification is readable again. Last fetched 2026-10-01 06:30 UTC.

API reference Invoicing

Invoices: Exports the filtered invoice list as CSV.

GET /api/invoicing/exports/invoices/csv deprecated

Requires: Invoicing.Invoices, merchant scope.

Returns a downloadable UTF-8 .csv file covering every invoice matching the applied filters (biller, biller type, recipient, status, invoice number, currency, issue-date range, due-date range, amount range, and source type), in the requested sort order. Paging members are ignored: an export is not a page. A filtered set of more than 10,000 invoices is rejected rather than truncated; narrow the filter (for example by date range or status) and retry.

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.

Code sample language

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

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

$response = Invoke-RestMethod -Method GET -Uri '{{BASE_URL}}/api/invoicing/exports/invoices/csv' `
    -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.invoiceExportExportToCsv();

TypeScript (raw HTTP)
const response = await fetch('{{BASE_URL}}/api/invoicing/exports/invoices/csv', {
  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.InvoiceExportExportToCsvAsync();

C# (raw HTTP)
using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("GET"), "/api/invoicing/exports/invoices/csv");
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_export_export_to_csv()

pip install requests

Python (raw HTTP)
import requests

headers = {
    "api-key": "{{API_KEY}}",
}

response = requests.request(
    "GET",
    "{{BASE_URL}}/api/invoicing/exports/invoices/csv",
    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.
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.
MaxAmount required query number (double) Filter by maximum grand total.
SourceType required query InvoiceSourceType Filter by source type.
Ids required query array of string (uuid) Restrict the result to these specific invoices, AND-combined with every other filter.
Filter required query string Gets or sets a general filter string for the result set.
Name required query string Gets or sets the name filter for the result set.
IncludeDeleted required query boolean Gets or sets a value indicating whether to include deleted entities in the result set.
IncludeInactive required query boolean Gets or sets a value indicating whether to include inactive entities in the result set.
Sorting required query string
SkipCount required query integer (int32)
MaxResultCount required query integer (int32)
ExtraProperties required query object
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 The exported CSV.

Body: string (binary) Each item has these fields.

Field Type Description

This response has no documented body fields.

400 The filtered set exceeds the 10,000-row export limit (`Invoicing:Export:RowLimitExceeded`). Narrow the filter, for example by date range or status, and retry.

Body: Each item has these fields.

Field Type Description

This response has no body.

404 The caller's biller scope does not cover the requested biller (`Invoicing:Biller:ForeignBillerNotAllowed`). Reported as not-found rather than forbidden so the response cannot be used to probe which billers exist.

Body: Each item has these fields.

Field Type Description

This response has no body.

403 Forbidden

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

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.

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

429 The request was refused because a rate limit was exceeded. 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.

Body: RateLimitProblemDetails Each item has these fields.

Field Type Description
type required string 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 required string A short, human-readable summary of the problem type. nullable
status required integer (int32) The HTTP status code, repeated in the body as the problem-details format defines.
detail required string A human-readable explanation of this occurrence of the problem. nullable
retryAfterSeconds required integer (int32) 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.

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.

Codes declared by Invoicing

Authentication

    Reconnecting to the server

    Could not reconnect

    This session has ended

    Attempt 1

    Your work on this page is still here. Retrying keeps it; reloading starts the page again.

    The server no longer holds this page's state, so it has to be loaded again.