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 model

This instance publishes no model under that name. It may have been renamed, or no operation this installation serves uses it.

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-23 00:19 UTC.

API reference Models

InvoiceProductUpdateDto

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

Input DTO for updating an invoice product.

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.

Fields

Field Type Description
name required string nullablemax length 200
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.
description required string Conditional: When Description is not empty. Max length: 1000. 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.
productCode required string Optional SKU or product code. Stored trimmed, with its letter case kept. Unique within the biller, compared case-insensitively: a code another of the biller's products already holds is rejected with a validation error naming this field. Leave it empty (or send whitespace, which is stored as no code) for a product without a code; any number of those may exist. Conditional: When ProductCode is not empty. Max length: 50. 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.
imageBlobName required string Bare blob filename of the product image, as returned by the hosted-page image upload endpoint (`POST /api/hostedpaymentpages/images/upload`). Omit or send null to leave the product without an image; an empty string also clears it. Never a URL, a path, or inline image data. 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.
defaultPrice required number (double) min 0
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.
taxCategoryId required string (uuid) Superseded by `defaultTaxRateId`; retained for compatibility, not read. Accepted and stored as sent, and never applied to a line item. 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.
defaultTaxRateId required string (uuid) Optional. The id of one of the biller's active tax rates, applied to an invoice line when this product is picked. Must belong to the same biller as the product; a rate that does not exist, belongs to another biller, or has been deactivated is rejected with a validation error naming this field. Omit or send null for no default. 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.
sortOrder required integer (int32) 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.
currency required string Conditional: When Currency is not empty. Max length: 3. 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.
pricingModel required PricingModel PricingModel 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.
Fixed A single fixed price per unit.
Tiered Price varies by quantity tier (e.g., 1-10 = $5, 11-50 = $4).
UsageBased Price determined by metered usage (e.g., per GB, per API call).
Custom Custom pricing negotiated per deal or contract.
allowCustomPrice 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.
productType required ProductType ProductType 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.
Physical Physical goods that are shipped or delivered.
Service Professional or managed services billed by time or engagement.
Digital Digital goods such as software licenses, downloads, or subscriptions.
Fee Flat fees such as setup charges, late fees, or surcharges.
Discount Discount line items that reduce the invoice total.
isTaxable 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.
taxCode required string Conditional: When TaxCode is not empty. Max length: 50. 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.
unitOfMeasure required string Conditional: When UnitOfMeasure is not empty. Max length: 50. 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.
commodityCode required string Commodity code snapshotted onto an invoice line when this product is applied, and sent as enhanced (Level 3) card data. At most 25 characters. nullablemax length 25
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.
allowFractionalQuantity 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.
minimumQuantity required number (double) Conditional: When MinimumQuantity is not null. Must be >= 0. 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.
maximumQuantity required number (double) Conditional: When MaximumQuantity is not null. Must be >= 0. 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.
requiresShipping 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.
weight required number (double) nullablegreater than 0max 999999.9999
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.
weightUnit required ShippingWeightUnit ShippingWeightUnit Required: When Weight is not null. 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.
Gram Grams.
Kilogram Kilograms.
Ounce Ounces (avoirdupois).
Pound Pounds (avoirdupois).
length required number (double) nullablegreater than 0max 99999.9999
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.
width required number (double) nullablegreater than 0max 99999.9999
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.
height required number (double) nullablegreater than 0max 99999.9999
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.
dimensionUnit required ShippingDimensionUnit ShippingDimensionUnit Required: When Length is not null or Width is not null or Height is not null. 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.
Centimeter Centimetres.
Inch Inches.
revenueAccount required string Conditional: When RevenueAccount is not empty. Max length: 100. 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.
deferredRevenue 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.
recognitionRuleId required string (uuid) 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.
tags required array of EntityTag array of EntityTag 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.

Fields of each EntityTag:

Field Type Description
name required string nullablemin length 0max length 50
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.
value required string nullablemin length 0max length 150
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.

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 model has no documented fields.

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.