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:25 UTC.

API reference Invoicing

Invoices: Appends an internal note to an invoice.

POST /api/invoicing/invoices/{id}/notes deprecated

Requires: Invoicing.Invoices, Invoicing.Invoices.Update, merchant scope.

Internal notes are operator commentary kept alongside the invoice; they are never shown to the recipient. Unlike the update endpoint, this one accepts a locked invoice, because a note is not part of the issued document. The author and timestamp are stamped from the calling user, and a `NoteAdded` activity is recorded on the invoice.

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

Code sample language

cURL
curl -X POST "{{BASE_URL}}/api/invoicing/invoices/{id}/notes" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "content": ""
}'

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

$body = @'
{
  "content": ""
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/invoicing/invoices/{id}/notes' `
    -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.invoiceLifecycleAddNote("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "content": ""
});

TypeScript (raw HTTP)
const response = await fetch('{{BASE_URL}}/api/invoicing/invoices/{id}/notes', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "content": ""
  }),
});

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<AddInvoiceNoteInput>("""
    {
      "content": ""
    }
    """);

var result = await api.InvoiceLifecycleAddNoteAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), 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/invoices/{id}/notes");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "content": ""
    }
    """, 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.AddInvoiceNoteInput.from_dict({
      "content": ""
    })
    result = api.invoice_lifecycle_add_note("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)
import requests

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

body = {
  "content": ""
}

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

Parameters

Name In Type Description
id required path string (uuid)
suppressNulls required query boolean If true, omit properties with null values.

Request body

application/json , required

Field Type Description
content required string The note text. Leading and trailing whitespace is trimmed before the note is stored. nullablemax length 1000

This request body has no documented fields.

Responses

200 The note was appended and the returned invoice includes it.

Body: InvoiceDto Each item has these fields.

Field Type Description
extraProperties required object nullableread only
id required string (uuid)
creationTime required string (date-time) The date and time when this entity was created.
creatorId required string (uuid) The ID of the user who created this entity. nullable
lastModificationTime required string (date-time) The date and time when this entity was last modified. nullable
lastModifierId required string (uuid) The ID of the user who last modified this entity. nullable
isDeleted required boolean Indicates whether this entity has been deleted.
deleterId required string (uuid) The ID of the user who deleted this entity, if it is deleted. nullable
deletionTime required string (date-time) The date and time when this entity was deleted, if it is deleted. nullable
tenantId required string (uuid) nullable
billerId required string (uuid)
billerType required InvoicePartyType Identifies the type of entity acting as the biller or recipient on an invoice. one of: GatewayOwner, Reseller, Merchant, Customer
recipientId required string (uuid)
recipientType required InvoicePartyType Identifies the type of entity acting as the biller or recipient on an invoice. one of: GatewayOwner, Reseller, Merchant, Customer
invoiceNumber required string nullable
status required InvoiceStatus Represents the lifecycle status of an invoice. one of: Draft, Issued, Sent, Viewed, PartiallyPaid, Paid, PastDue, Closed, Uncollectible, Cancelled, Refunded
isLocked required boolean nullable
billerSnapshot required InvoicePartySnapshotDto Read DTO for denormalized biller/recipient info frozen at invoice issuance.
recipientSnapshot required InvoicePartySnapshotDto Read DTO for denormalized biller/recipient info frozen at invoice issuance.
currency required string nullable
subtotal required number (double) nullable
taxTotal required number (double) nullable
discountTotal required number (double) nullable
grandTotal required number (double) nullable
amountPaid required number (double) nullable
balanceDue required number (double) nullable
invoiceLevelDiscount required InvoiceDiscountDto DTO for an invoice-level discount.
issueDate required string (date-time) nullable
dueDate required string (date-time) nullable
sentAt required string (date-time) nullable
viewedAt required string (date-time) nullable
paidAt required string (date-time) nullable
paymentTermsValue required all of PaymentTerms nullable
customPaymentDays required integer (int32) nullable
allowPartialPayment required boolean nullable
minimumPaymentAmount required number (double) nullable
partialPaymentTolerance required number (double) nullable
allowedPaymentMethods required array of string nullable
vaultRestriction required all of VaultRestriction nullable
applyConvenienceFee required boolean Per-invoice override of the merchant's convenience fee on this invoice's payments. `null` inherits the merchant and feature decision. `true` applies the fee only when invoice convenience fees are enabled for the tenant. nullable
depositRequest required all of InvoiceDepositRequestInfoDto The deposit request on this invoice, if any. Null when no deposit was requested.
hppPageId required string (uuid) nullable
templateId required string (uuid) nullable
sourceType required all of InvoiceSourceType nullable
sourceReferenceId required string nullable
notes required array of EntityNote nullable
recipientNote required string nullable
footerText required string nullable
reminderConfig required InvoiceReminderConfigDto DTO for invoice reminder configuration. Each member overrides the tenant's reminder default on its own; a member that is null or omitted inherits that default.
lineItems required array of InvoiceLineItemDto nullable
payments required array of InvoicePaymentDto nullable
activities required array of InvoiceActivityDto nullable
customFields required array of CustomFieldValueDto nullable
concurrencyStamp required string nullable
entityVersion required integer (int32)

This response has no documented body fields.

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.

400 The note content is missing or longer than the permitted length.

Body: RemoteServiceErrorResponse Each item has these fields.

Field Type Description
error required RemoteServiceErrorInfo

This response has no documented body fields.

404 The invoice does not exist, or is not visible to this caller (`Invoicing:Biller:ForeignBillerNotAllowed`).

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.

409 The invoice already holds the maximum number of notes (`Invoicing:Invoice:NoteLimitReached`).

Body: Each item has these fields.

Field Type Description

This response has no body.

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.