WinkPG Docs
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-11-12 05:58 UTC.

API reference Invoicing

Templates: Creates a new invoice template.

POST /api/invoicing/templates deprecated

Requires: Invoicing.Templates, Invoicing.Templates.Create, merchant scope.

Requires API key scope: admin (Administration)

**Required permissions**: `Invoicing.Templates`, `Invoicing.Templates.Create` **Scope**: merchant

Signed in, you can send this request to your own sandbox merchant from the console and read the answer. Sign in to try it.

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 InvoiceTemplateCreateDto. See the Request body section below for its fields.

Code sample language

cURL

curl -X POST "{{BASE_URL}}/api/invoicing/templates" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Northwind standard",
  "theme": {
    "primaryColor": "#1F3A5F",
    "accentColor": "#F2A541",
    "fontFamily": "Inter",
    "showBillerAddress": true,
    "showBillerLogo": true,
    "showBillerTaxId": true
  },
  "layout": {
    "showProductCode": true,
    "showQuantity": true,
    "showUnitPrice": true,
    "showTax": true,
    "showNotes": true,
    "showPaymentInstructions": true
  },
  "footerHtml": "\u003Cp\u003EThank you for your business. Questions? Email billing@northwind-design.example.com.\u003C/p\u003E",
  "isActive": true
}'

PowerShell

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

$body = @'
{
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Northwind standard",
  "theme": {
    "primaryColor": "#1F3A5F",
    "accentColor": "#F2A541",
    "fontFamily": "Inter",
    "showBillerAddress": true,
    "showBillerLogo": true,
    "showBillerTaxId": true
  },
  "layout": {
    "showProductCode": true,
    "showQuantity": true,
    "showUnitPrice": true,
    "showTax": true,
    "showNotes": true,
    "showPaymentInstructions": true
  },
  "footerHtml": "\u003Cp\u003EThank you for your business. Questions? Email billing@northwind-design.example.com.\u003C/p\u003E",
  "isActive": true
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/invoicing/templates' `
    -Headers $headers -ContentType 'application/json' -Body $body

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.invoiceTemplateCreate({
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Northwind standard",
  "theme": {
    "primaryColor": "#1F3A5F",
    "accentColor": "#F2A541",
    "fontFamily": "Inter",
    "showBillerAddress": true,
    "showBillerLogo": true,
    "showBillerTaxId": true
  },
  "layout": {
    "showProductCode": true,
    "showQuantity": true,
    "showUnitPrice": true,
    "showTax": true,
    "showNotes": true,
    "showPaymentInstructions": true
  },
  "footerHtml": "\u003Cp\u003EThank you for your business. Questions? Email billing@northwind-design.example.com.\u003C/p\u003E",
  "isActive": true
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/invoicing/templates', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "billerId": "00000000-0000-0000-0000-000000000001",
    "billerType": "Merchant",
    "name": "Northwind standard",
    "theme": {
      "primaryColor": "#1F3A5F",
      "accentColor": "#F2A541",
      "fontFamily": "Inter",
      "showBillerAddress": true,
      "showBillerLogo": true,
      "showBillerTaxId": true
    },
    "layout": {
      "showProductCode": true,
      "showQuantity": true,
      "showUnitPrice": true,
      "showTax": true,
      "showNotes": true,
      "showPaymentInstructions": true
    },
    "footerHtml": "\u003Cp\u003EThank you for your business. Questions? Email billing@northwind-design.example.com.\u003C/p\u003E",
    "isActive": true
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new InvoicingApi(config);
var body = JsonSerializer.Deserialize<InvoiceTemplateCreateDto>("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Northwind standard",
      "theme": {
        "primaryColor": "#1F3A5F",
        "accentColor": "#F2A541",
        "fontFamily": "Inter",
        "showBillerAddress": true,
        "showBillerLogo": true,
        "showBillerTaxId": true
      },
      "layout": {
        "showProductCode": true,
        "showQuantity": true,
        "showUnitPrice": true,
        "showTax": true,
        "showNotes": true,
        "showPaymentInstructions": true
      },
      "footerHtml": "\u003Cp\u003EThank you for your business. Questions? Email billing@northwind-design.example.com.\u003C/p\u003E",
      "isActive": true
    }
    """);

var result = await api.InvoiceTemplateCreateAsync(body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/invoicing/templates");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Northwind standard",
      "theme": {
        "primaryColor": "#1F3A5F",
        "accentColor": "#F2A541",
        "fontFamily": "Inter",
        "showBillerAddress": true,
        "showBillerLogo": true,
        "showBillerTaxId": true
      },
      "layout": {
        "showProductCode": true,
        "showQuantity": true,
        "showUnitPrice": true,
        "showTax": true,
        "showNotes": true,
        "showPaymentInstructions": true
      },
      "footerHtml": "\u003Cp\u003EThank you for your business. Questions? Email billing@northwind-design.example.com.\u003C/p\u003E",
      "isActive": true
    }
    """, Encoding.UTF8, "application/json");

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)
    body = winkpg_api.InvoiceTemplateCreateDto.from_dict({
      "billerId": "00000000-0000-0000-0000-000000000001",
      "billerType": "Merchant",
      "name": "Northwind standard",
      "theme": {
        "primaryColor": "#1F3A5F",
        "accentColor": "#F2A541",
        "fontFamily": "Inter",
        "showBillerAddress": True,
        "showBillerLogo": True,
        "showBillerTaxId": True
      },
      "layout": {
        "showProductCode": True,
        "showQuantity": True,
        "showUnitPrice": True,
        "showTax": True,
        "showNotes": True,
        "showPaymentInstructions": True
      },
      "footerHtml": "\u003Cp\u003EThank you for your business. Questions? Email billing@northwind-design.example.com.\u003C/p\u003E",
      "isActive": True
    })
    result = api.invoice_template_create(body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "billerId": "00000000-0000-0000-0000-000000000001",
  "billerType": "Merchant",
  "name": "Northwind standard",
  "theme": {
    "primaryColor": "#1F3A5F",
    "accentColor": "#F2A541",
    "fontFamily": "Inter",
    "showBillerAddress": True,
    "showBillerLogo": True,
    "showBillerTaxId": True
  },
  "layout": {
    "showProductCode": True,
    "showQuantity": True,
    "showUnitPrice": True,
    "showTax": True,
    "showNotes": True,
    "showPaymentInstructions": True
  },
  "footerHtml": "\u003Cp\u003EThank you for your business. Questions? Email billing@northwind-design.example.com.\u003C/p\u003E",
  "isActive": True
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/invoicing/templates",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name In Type Description
suppressNulls required query boolean If true, omit properties with null values.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description
name required string nullablemax length 100
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isDefault required boolean nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
theme required InvoiceThemeDto InvoiceThemeDto DTO for invoice theme visual settings.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoiceThemeDto:

Field Type Description
primaryColor required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
accentColor required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
logoUrl required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
fontFamily required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showBillerAddress required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showBillerLogo required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showBillerTaxId required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

layout required InvoiceLayoutDto InvoiceLayoutDto DTO for invoice layout configuration.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoiceLayoutDto:

Field Type Description
showProductCode required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showQuantity required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showUnitPrice required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showDiscount required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showTax required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showRecipientTaxId required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showShippingAddress required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showNotes required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showPaymentInstructions required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
additionalColumns required array of string array of nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

headerHtml required string Conditional: When HeaderHtml is not null. Max length: 50000. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
footerHtml required string Conditional: When FooterHtml is not null. Max length: 50000. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
emailSubjectTemplate required string Conditional: When EmailSubjectTemplate is not null. Max length: 500. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
emailBodyTemplate required string Conditional: When EmailBodyTemplate is not null. Max length: 50000. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
attachPdfToEmail required boolean Whether the invoice and reminder emails sent from this template carry the invoice PDF as an attachment. Only false turns the attachment off. On create, null attaches. On update, null leaves the stored setting as it is. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isActive required boolean nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
billerId required string (uuid)
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
billerType required InvoicePartyType InvoicePartyType Identifies the type of entity acting as the biller or recipient on an invoice.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
GatewayOwner Platform-level gateway owner.
Reseller Reseller entity.
Merchant Merchant entity.
Customer End customer.

This request body has no documented fields.

Responses

Response status

OK

Body: InvoiceTemplateDto InvoiceTemplateDto Each item has these fields.

Field Type Description
id required string (uuid)
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
creationTime required string (date-time) The date and time when this entity was created.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
creatorId required string (uuid) The ID of the user who created this entity. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lastModificationTime required string (date-time) The date and time when this entity was last modified. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
lastModifierId required string (uuid) The ID of the user who last modified this entity. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
billerId required string (uuid)
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
billerType required InvoicePartyType InvoicePartyType Identifies the type of entity acting as the biller or recipient on an invoice.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
GatewayOwner Platform-level gateway owner.
Reseller Reseller entity.
Merchant Merchant entity.
Customer End customer.
name required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isDefault required boolean nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
theme required InvoiceThemeDto InvoiceThemeDto DTO for invoice theme visual settings.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoiceThemeDto:

Field Type Description
primaryColor required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
accentColor required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
logoUrl required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
fontFamily required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showBillerAddress required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showBillerLogo required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showBillerTaxId required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

layout required InvoiceLayoutDto InvoiceLayoutDto DTO for invoice layout configuration.
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoiceLayoutDto:

Field Type Description
showProductCode required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showQuantity required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showUnitPrice required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showDiscount required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showTax required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showRecipientTaxId required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showShippingAddress required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showNotes required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
showPaymentInstructions required boolean
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
additionalColumns required array of string array of nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

headerHtml required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
footerHtml required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
emailSubjectTemplate required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
emailBodyTemplate required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
attachPdfToEmail required boolean Whether the invoice and reminder emails sent from this template carry the invoice PDF as an attachment. Null and true both attach; only false turns the attachment off. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isActive required boolean nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
isDemoData required boolean True when this template belongs to the biller's removable demo data set. Null for every other template. Read-only: no request sets it. Filter on it to leave demo rows out of a list. nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
concurrencyStamp required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

  1. 400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
  2. 401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
  3. 403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
  4. 404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
  5. 500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
  6. 501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
  7. 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 lists the values `error.code` can take.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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo RemoteServiceErrorInfo
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description
code required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
message required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
details required string nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
data required object nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
validationErrors required array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo nullable
Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

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

  • ApiKey with scopes

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.