# PUT /api/invoicing/invoices/{id}

Invoices: Updates an existing draft invoice by id.

**Required permissions**: `Invoicing.Invoices`, `Invoicing.Invoices.Update`  
**Scope**: merchant

**Operation ID:** `invoiceCrudUpdate`

## Authorization

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

Requires API key scope: `admin`

Required permissions:
- `Invoicing.Invoices`
- `Invoicing.Invoices.Update`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| id | path | yes | string(uuid) |  |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Request Body

**Content type:** `application/json`

Schema: [`InvoiceUpdateDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceUpdateDto.md)

Properties:
- `recipientId` (string(uuid)) required: Recipient entity ID.
- `recipientType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Recipient entity type.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `currency` (string) required: ISO 4217 currency code. (nullable, min length 3, max length 3, pattern ^[A-Za-z]{3}$)
- `paymentTermsValue` ([PaymentTerms](https://devportal.demo.winkpg.io/docs/api/models/PaymentTerms.md)): Standard payment terms. (nullable)
  Values:
  - `DueOnReceipt`: Payment due immediately upon receipt.
  - `Net15`: Payment due within 15 days of issue.
  - `Net30`: Payment due within 30 days of issue.
  - `Net45`: Payment due within 45 days of issue.
  - `Net60`: Payment due within 60 days of issue.
  - `Net90`: Payment due within 90 days of issue.
  - `Custom`: Custom number of days specified via InvoiceConsts.
- `customPaymentDays` (integer(int32)): Custom number of days when PaymentTerms is Custom. Conditional: When PaymentTermsValue == Custom. Must be > 0. (nullable)
- `dueDate` (string(date-time)): Manual due date override (used if PaymentTerms is null). (nullable)
- `allowPartialPayment` (boolean): Whether partial payments are allowed. (nullable)
- `minimumPaymentAmount` (number(double)): Minimum payment amount when partial payments are enabled. Conditional: When AllowPartialPayment is true and MinimumPaymentAmount is not null. Must be > 0. (nullable)
- `partialPaymentTolerance` (number(double)): Auto-close tolerance. (nullable)
- `depositType` ([InvoiceDepositType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDepositType.md)): When set, requests an up-front deposit on the invoice: the payer is charged exactly the deposit  first, then the remaining balance. Null means no deposit is requested. When set, `depositValue`  is required. (nullable)
  Values:
  - `Percentage`: Deposit is a percentage (0 < value < 100) of the invoice grand total.
  - `FixedAmount`: Deposit is a fixed currency amount (0 < value < grand total).
- `depositValue` (number(double)): The deposit percentage (e.g. 25 for 25%) when `depositType` is  `Percentage`, or the fixed deposit amount when it is  `FixedAmount`. Must be positive; the resolved amount must be  strictly less than the invoice total. Required: When DepositType is not null. Must be > 0. Must be < 100. (nullable)
- `depositDueDate` (string(date-time)): Optional deposit due date, distinct from the balance `dueDate`. When set, it must not  be after the balance due date. Conditional: When DepositType is not null. (nullable)
- `allowedPaymentMethods` (array<string>): Subset of biller's supported payment methods for this invoice. Conditional: When AllowedPaymentMethods is not null. (nullable)
- `vaultRestriction` ([VaultRestriction](https://devportal.demo.winkpg.io/docs/api/models/VaultRestriction.md)): Controls whether new or saved payment methods are allowed. (nullable)
  Values:
  - `Any`: Allow any payment method (new or saved).
  - `AllowNewAndSaved`: Allow both new and saved payment methods.
  - `SavedOnly`: Only allow previously saved (vaulted) payment methods.
- `applyConvenienceFee` (boolean): Per-invoice override of the merchant's convenience fee on this invoice's payments:  `true` applies it, `false` suppresses it, and `null` (the default, and the  behaviour of any payload that omits the field) inherits the merchant and feature decision.  An override can suppress a fee but can never create one: `true` applies the fee only  when invoice convenience fees are enabled for the tenant and the merchant has a  convenience-fee configuration, and the platform's compliance rules still govern whether the  resulting transaction keeps the fee. (nullable)
- `hppPageId` (string(uuid)): Linked HPP configuration ID. (nullable)
- `templateId` (string(uuid)): Invoice style/template reference. (nullable)
- `invoiceLevelDiscount` ([InvoiceDiscountDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDiscountDto.md)): Invoice-level discount.
  Fields:
  - `type` ([DiscountType](https://devportal.demo.winkpg.io/docs/api/models/DiscountType.md)): The type of discount applied to a line item or invoice.
    Values:
    - `Percent`: Percentage discount (e.g., 10%).
    - `Flat`: Flat dollar amount discount (e.g., $5.00).
  - `value` (number(double))
  - `description` (string): (nullable)
- `reminderConfig` ([InvoiceReminderConfigDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceReminderConfigDto.md)): Per-invoice reminder overrides.
  Fields:
  - `preDueDays` (array<integer(int32)>): Days before the due date to send a reminder (for example 7, 3, 1). Null or omitted inherits the  tenant default; an empty list sends no pre-due reminders for this invoice. (nullable)
  - `dueDayReminder` (boolean): (nullable)
  - `postDueDays` (array<integer(int32)>): Days after the due date to send a reminder (for example 1, 7, 14, 30). Null or omitted inherits  the tenant default; an empty list sends no scheduled post-due reminders for this invoice. (nullable)
  - `postDueRecurringDays` (integer(int32)): (nullable)
  - `stopOnPaid` (boolean): (nullable)
  - `maxReminders` (integer(int32)): (nullable)
  - `dunningEndAction` ([DunningEndAction](https://devportal.demo.winkpg.io/docs/api/models/DunningEndAction.md)): (nullable)
    Values:
    - `None`: No automatic action taken.
    - `MarkUncollectible`: Transition the invoice to Uncollectible.
    - `Close`: Transition the invoice to Closed.
  - `daysUntilUncollectible` (integer(int32)): (nullable)
- `sourceType` ([InvoiceSourceType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceSourceType.md)): How this invoice was created. (nullable)
  Values:
  - `Manual`: Manually created by a user.
  - `UsageBilling`: Generated from usage billing data.
  - `RecurringBilling`: Generated from a recurring billing contract.
  - `Api`: Created via API by an external integration.
- `sourceReferenceId` (string): Caller-provided reference. Conditional: When SourceReferenceId is not empty. Max length: 200. (nullable)
- `notes` (array<[EntityNote](https://devportal.demo.winkpg.io/docs/api/models/EntityNote.md)>): Internal notes (not shown to recipient). (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `enteredBy` (string(uuid))
  - `timestamp` (string(date-time))
  - `enteredByName` (string): Denormalized display name of the user who created the note.  Populated at creation time from `ICurrentUser` to avoid N+1 lookups when rendering. (nullable)
  - `content` (string): (nullable, min length 0, max length 1000)
- `recipientNote` (string): Shown on the invoice to the recipient. Conditional: When RecipientNote is not empty. Max length: 2000. (nullable)
- `footerText` (string): Terms and conditions text. Conditional: When FooterText is not empty. Max length: 5000. (nullable)
- `lineItems` (array<[InvoiceLineItemInputDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceLineItemInputDto.md)>): Line items to set on the invoice. (nullable)
  Fields of each item:
  - `parentLineItemId` (string(uuid)): Parent line item ID for bundle/discount/tax line hierarchies. (nullable)
  - `name` (string): Product name snapshot (formal product name). (nullable, max length 200)
  - `description` (string) required: Line item description shown on PDF and HPP. (nullable, max length 500)
  - `notes` (string): Per-line notes visible to the biller only. (nullable, max length 500)
  - `productId` (string(uuid)): Optional link to the product catalog. (nullable)
  - `productCode` (string): SKU or product code. (nullable, max length 50)
  - `unitOfMeasure` (string): Unit of measure (e.g., "each", "hour", "GB"). (nullable, max length 50)
  - `commodityCode` (string): Commodity code sent as enhanced (Level 3) card data when the invoice is paid by card. At most  25 characters. (nullable, max length 25)
  - `quantity` (number(double)): Quantity (default 1). (greater than 0)
  - `unitPrice` (number(double)): Unit price. (min 0)
  - `cost` (number(double)): Cost for margin tracking. (nullable)
  - `pricingSource` ([PricingSource](https://devportal.demo.winkpg.io/docs/api/models/PricingSource.md)): How the unit price was determined. (nullable)
    Values:
    - `Catalog`: Price taken from the product catalog at time of invoicing.
    - `Override`: Price manually overridden by the user.
    - `Promotion`: Price determined by a promotion or coupon.
    - `Contract`: Price from a negotiated contract or quote.
  - `discountType` ([DiscountType](https://devportal.demo.winkpg.io/docs/api/models/DiscountType.md)): Type of discount applied to this line item. (nullable)
    Values:
    - `Percent`: Percentage discount (e.g., 10%).
    - `Flat`: Flat dollar amount discount (e.g., $5.00).
  - `discountValue` (number(double)): Discount value (percentage or flat amount). (nullable)
  - `taxRateId` (string(uuid)): Reference to a reusable tax rate definition. (nullable)
  - `taxRatePercent` (number(double)): Snapshot of the tax rate percentage. (nullable)
  - `taxJurisdiction` (string): Tax jurisdiction (state/country). (nullable, max length 100)
  - `taxRateSource` ([InvoiceTaxRateSource](https://devportal.demo.winkpg.io/docs/api/models/InvoiceTaxRateSource.md)): Optional. Where `taxRatePercent` came from. Provider is stored only when  `taxRateProviderName` is supplied and `taxRateId` is not; any other  combination is stored as Catalog when a rate id is named, otherwise Manual. Provenance is  recorded as supplied, like the percentage: the platform does not verify that a lookup ran. (nullable)
    Values:
    - `Manual`: The operator typed the percentage, or nothing recorded where it came from.
    - `Catalog`: The percentage was snapshotted from one of the biller's named tax rates.
    - `Provider`: The percentage was sourced from the merchant's bound tax provider.
  - `taxRateProviderName` (string): Optional. The tax provider that sourced the percentage; meaningful only with a Provider source. (nullable, max length 50)
  - `taxCode` (string): Tax code snapshotted from product or overridden. (nullable, max length 50)
  - `isTaxable` (boolean): Whether tax applies to this line. (nullable)
  - `isDiscountLine` (boolean): Indicates this is a discount adjustment line. (nullable)
  - `isSystemGenerated` (boolean): Indicates this line was auto-generated. (nullable)
  - `isOptional` (boolean): For quotes-to-invoices flow: whether this line is optional. (nullable)
  - `revenueAccount` (string): GL account for revenue recognition. (nullable, max length 100)
  - `recognitionStartDate` (string(date-time)): Revenue recognition start date. (nullable)
  - `recognitionEndDate` (string(date-time)): Revenue recognition end date. (nullable)
  - `attributes` (object): Extensibility metadata (key-value pairs). (nullable)
- `customFields` (array<[CustomFieldValueDto](https://devportal.demo.winkpg.io/docs/api/models/CustomFieldValueDto.md)>): Custom field values. (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `key` (string) required: (nullable, max length 100)
  - `label` (string): (nullable, max length 200)
  - `value` (string): (nullable, max length 2000)
- `billerSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Optional biller snapshot to freeze on this invoice at creation time.  When supplied, overrides the empty-placeholder default used by IssueAsync.  Useful for programmatic/system-generated invoices where the caller already  holds the party's display info (e.g., billing-run invoice generation).
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Optional recipient snapshot to freeze on this invoice at creation time.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `concurrencyStamp` (string): (nullable)

_Example: Replace a draft's lines_

Replaces the draft's lines with the two sent, both taxed at 8.25 percent, and the server recomputes the totals: a subtotal of 735.00, tax of 60.64 and a total of 795.64. The terms, notes and payment options on the draft are replaced too, and a member left out is cleared, so send every value the draft should keep; line items and custom fields left out are kept as stored. Net 15 terms set the due date when the invoice is issued. Only a draft can be updated: an issued invoice is locked and answers 409 Invoicing:Invoice:IsLocked, and corrections to it are credit notes. Send the concurrencyStamp from your latest read of the invoice, and the recipientId it already names.

```json
{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "lineItems": [
    {
      "description": "Website maintenance, October 2026",
      "quantity": 1,
      "unitPrice": 450,
      "taxRatePercent": 8.25
    },
    {
      "description": "Emergency plugin update",
      "unitOfMeasure": "hour",
      "quantity": 3,
      "unitPrice": 95,
      "taxRatePercent": 8.25
    }
  ],
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  }
}
```

**Content type:** `text/json`

Schema: [`InvoiceUpdateDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceUpdateDto.md)

Properties:
- `recipientId` (string(uuid)) required: Recipient entity ID.
- `recipientType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Recipient entity type.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `currency` (string) required: ISO 4217 currency code. (nullable, min length 3, max length 3, pattern ^[A-Za-z]{3}$)
- `paymentTermsValue` ([PaymentTerms](https://devportal.demo.winkpg.io/docs/api/models/PaymentTerms.md)): Standard payment terms. (nullable)
  Values:
  - `DueOnReceipt`: Payment due immediately upon receipt.
  - `Net15`: Payment due within 15 days of issue.
  - `Net30`: Payment due within 30 days of issue.
  - `Net45`: Payment due within 45 days of issue.
  - `Net60`: Payment due within 60 days of issue.
  - `Net90`: Payment due within 90 days of issue.
  - `Custom`: Custom number of days specified via InvoiceConsts.
- `customPaymentDays` (integer(int32)): Custom number of days when PaymentTerms is Custom. Conditional: When PaymentTermsValue == Custom. Must be > 0. (nullable)
- `dueDate` (string(date-time)): Manual due date override (used if PaymentTerms is null). (nullable)
- `allowPartialPayment` (boolean): Whether partial payments are allowed. (nullable)
- `minimumPaymentAmount` (number(double)): Minimum payment amount when partial payments are enabled. Conditional: When AllowPartialPayment is true and MinimumPaymentAmount is not null. Must be > 0. (nullable)
- `partialPaymentTolerance` (number(double)): Auto-close tolerance. (nullable)
- `depositType` ([InvoiceDepositType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDepositType.md)): When set, requests an up-front deposit on the invoice: the payer is charged exactly the deposit  first, then the remaining balance. Null means no deposit is requested. When set, `depositValue`  is required. (nullable)
  Values:
  - `Percentage`: Deposit is a percentage (0 < value < 100) of the invoice grand total.
  - `FixedAmount`: Deposit is a fixed currency amount (0 < value < grand total).
- `depositValue` (number(double)): The deposit percentage (e.g. 25 for 25%) when `depositType` is  `Percentage`, or the fixed deposit amount when it is  `FixedAmount`. Must be positive; the resolved amount must be  strictly less than the invoice total. Required: When DepositType is not null. Must be > 0. Must be < 100. (nullable)
- `depositDueDate` (string(date-time)): Optional deposit due date, distinct from the balance `dueDate`. When set, it must not  be after the balance due date. Conditional: When DepositType is not null. (nullable)
- `allowedPaymentMethods` (array<string>): Subset of biller's supported payment methods for this invoice. Conditional: When AllowedPaymentMethods is not null. (nullable)
- `vaultRestriction` ([VaultRestriction](https://devportal.demo.winkpg.io/docs/api/models/VaultRestriction.md)): Controls whether new or saved payment methods are allowed. (nullable)
  Values:
  - `Any`: Allow any payment method (new or saved).
  - `AllowNewAndSaved`: Allow both new and saved payment methods.
  - `SavedOnly`: Only allow previously saved (vaulted) payment methods.
- `applyConvenienceFee` (boolean): Per-invoice override of the merchant's convenience fee on this invoice's payments:  `true` applies it, `false` suppresses it, and `null` (the default, and the  behaviour of any payload that omits the field) inherits the merchant and feature decision.  An override can suppress a fee but can never create one: `true` applies the fee only  when invoice convenience fees are enabled for the tenant and the merchant has a  convenience-fee configuration, and the platform's compliance rules still govern whether the  resulting transaction keeps the fee. (nullable)
- `hppPageId` (string(uuid)): Linked HPP configuration ID. (nullable)
- `templateId` (string(uuid)): Invoice style/template reference. (nullable)
- `invoiceLevelDiscount` ([InvoiceDiscountDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDiscountDto.md)): Invoice-level discount.
  Fields:
  - `type` ([DiscountType](https://devportal.demo.winkpg.io/docs/api/models/DiscountType.md)): The type of discount applied to a line item or invoice.
    Values:
    - `Percent`: Percentage discount (e.g., 10%).
    - `Flat`: Flat dollar amount discount (e.g., $5.00).
  - `value` (number(double))
  - `description` (string): (nullable)
- `reminderConfig` ([InvoiceReminderConfigDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceReminderConfigDto.md)): Per-invoice reminder overrides.
  Fields:
  - `preDueDays` (array<integer(int32)>): Days before the due date to send a reminder (for example 7, 3, 1). Null or omitted inherits the  tenant default; an empty list sends no pre-due reminders for this invoice. (nullable)
  - `dueDayReminder` (boolean): (nullable)
  - `postDueDays` (array<integer(int32)>): Days after the due date to send a reminder (for example 1, 7, 14, 30). Null or omitted inherits  the tenant default; an empty list sends no scheduled post-due reminders for this invoice. (nullable)
  - `postDueRecurringDays` (integer(int32)): (nullable)
  - `stopOnPaid` (boolean): (nullable)
  - `maxReminders` (integer(int32)): (nullable)
  - `dunningEndAction` ([DunningEndAction](https://devportal.demo.winkpg.io/docs/api/models/DunningEndAction.md)): (nullable)
    Values:
    - `None`: No automatic action taken.
    - `MarkUncollectible`: Transition the invoice to Uncollectible.
    - `Close`: Transition the invoice to Closed.
  - `daysUntilUncollectible` (integer(int32)): (nullable)
- `sourceType` ([InvoiceSourceType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceSourceType.md)): How this invoice was created. (nullable)
  Values:
  - `Manual`: Manually created by a user.
  - `UsageBilling`: Generated from usage billing data.
  - `RecurringBilling`: Generated from a recurring billing contract.
  - `Api`: Created via API by an external integration.
- `sourceReferenceId` (string): Caller-provided reference. Conditional: When SourceReferenceId is not empty. Max length: 200. (nullable)
- `notes` (array<[EntityNote](https://devportal.demo.winkpg.io/docs/api/models/EntityNote.md)>): Internal notes (not shown to recipient). (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `enteredBy` (string(uuid))
  - `timestamp` (string(date-time))
  - `enteredByName` (string): Denormalized display name of the user who created the note.  Populated at creation time from `ICurrentUser` to avoid N+1 lookups when rendering. (nullable)
  - `content` (string): (nullable, min length 0, max length 1000)
- `recipientNote` (string): Shown on the invoice to the recipient. Conditional: When RecipientNote is not empty. Max length: 2000. (nullable)
- `footerText` (string): Terms and conditions text. Conditional: When FooterText is not empty. Max length: 5000. (nullable)
- `lineItems` (array<[InvoiceLineItemInputDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceLineItemInputDto.md)>): Line items to set on the invoice. (nullable)
  Fields of each item:
  - `parentLineItemId` (string(uuid)): Parent line item ID for bundle/discount/tax line hierarchies. (nullable)
  - `name` (string): Product name snapshot (formal product name). (nullable, max length 200)
  - `description` (string) required: Line item description shown on PDF and HPP. (nullable, max length 500)
  - `notes` (string): Per-line notes visible to the biller only. (nullable, max length 500)
  - `productId` (string(uuid)): Optional link to the product catalog. (nullable)
  - `productCode` (string): SKU or product code. (nullable, max length 50)
  - `unitOfMeasure` (string): Unit of measure (e.g., "each", "hour", "GB"). (nullable, max length 50)
  - `commodityCode` (string): Commodity code sent as enhanced (Level 3) card data when the invoice is paid by card. At most  25 characters. (nullable, max length 25)
  - `quantity` (number(double)): Quantity (default 1). (greater than 0)
  - `unitPrice` (number(double)): Unit price. (min 0)
  - `cost` (number(double)): Cost for margin tracking. (nullable)
  - `pricingSource` ([PricingSource](https://devportal.demo.winkpg.io/docs/api/models/PricingSource.md)): How the unit price was determined. (nullable)
    Values:
    - `Catalog`: Price taken from the product catalog at time of invoicing.
    - `Override`: Price manually overridden by the user.
    - `Promotion`: Price determined by a promotion or coupon.
    - `Contract`: Price from a negotiated contract or quote.
  - `discountType` ([DiscountType](https://devportal.demo.winkpg.io/docs/api/models/DiscountType.md)): Type of discount applied to this line item. (nullable)
    Values:
    - `Percent`: Percentage discount (e.g., 10%).
    - `Flat`: Flat dollar amount discount (e.g., $5.00).
  - `discountValue` (number(double)): Discount value (percentage or flat amount). (nullable)
  - `taxRateId` (string(uuid)): Reference to a reusable tax rate definition. (nullable)
  - `taxRatePercent` (number(double)): Snapshot of the tax rate percentage. (nullable)
  - `taxJurisdiction` (string): Tax jurisdiction (state/country). (nullable, max length 100)
  - `taxRateSource` ([InvoiceTaxRateSource](https://devportal.demo.winkpg.io/docs/api/models/InvoiceTaxRateSource.md)): Optional. Where `taxRatePercent` came from. Provider is stored only when  `taxRateProviderName` is supplied and `taxRateId` is not; any other  combination is stored as Catalog when a rate id is named, otherwise Manual. Provenance is  recorded as supplied, like the percentage: the platform does not verify that a lookup ran. (nullable)
    Values:
    - `Manual`: The operator typed the percentage, or nothing recorded where it came from.
    - `Catalog`: The percentage was snapshotted from one of the biller's named tax rates.
    - `Provider`: The percentage was sourced from the merchant's bound tax provider.
  - `taxRateProviderName` (string): Optional. The tax provider that sourced the percentage; meaningful only with a Provider source. (nullable, max length 50)
  - `taxCode` (string): Tax code snapshotted from product or overridden. (nullable, max length 50)
  - `isTaxable` (boolean): Whether tax applies to this line. (nullable)
  - `isDiscountLine` (boolean): Indicates this is a discount adjustment line. (nullable)
  - `isSystemGenerated` (boolean): Indicates this line was auto-generated. (nullable)
  - `isOptional` (boolean): For quotes-to-invoices flow: whether this line is optional. (nullable)
  - `revenueAccount` (string): GL account for revenue recognition. (nullable, max length 100)
  - `recognitionStartDate` (string(date-time)): Revenue recognition start date. (nullable)
  - `recognitionEndDate` (string(date-time)): Revenue recognition end date. (nullable)
  - `attributes` (object): Extensibility metadata (key-value pairs). (nullable)
- `customFields` (array<[CustomFieldValueDto](https://devportal.demo.winkpg.io/docs/api/models/CustomFieldValueDto.md)>): Custom field values. (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `key` (string) required: (nullable, max length 100)
  - `label` (string): (nullable, max length 200)
  - `value` (string): (nullable, max length 2000)
- `billerSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Optional biller snapshot to freeze on this invoice at creation time.  When supplied, overrides the empty-placeholder default used by IssueAsync.  Useful for programmatic/system-generated invoices where the caller already  holds the party's display info (e.g., billing-run invoice generation).
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Optional recipient snapshot to freeze on this invoice at creation time.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `concurrencyStamp` (string): (nullable)

_Example: Replace a draft's lines_

Replaces the draft's lines with the two sent, both taxed at 8.25 percent, and the server recomputes the totals: a subtotal of 735.00, tax of 60.64 and a total of 795.64. The terms, notes and payment options on the draft are replaced too, and a member left out is cleared, so send every value the draft should keep; line items and custom fields left out are kept as stored. Net 15 terms set the due date when the invoice is issued. Only a draft can be updated: an issued invoice is locked and answers 409 Invoicing:Invoice:IsLocked, and corrections to it are credit notes. Send the concurrencyStamp from your latest read of the invoice, and the recipientId it already names.

```json
{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "lineItems": [
    {
      "description": "Website maintenance, October 2026",
      "quantity": 1,
      "unitPrice": 450,
      "taxRatePercent": 8.25
    },
    {
      "description": "Emergency plugin update",
      "unitOfMeasure": "hour",
      "quantity": 3,
      "unitPrice": 95,
      "taxRatePercent": 8.25
    }
  ],
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  }
}
```

**Content type:** `application/*+json`

Schema: [`InvoiceUpdateDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceUpdateDto.md)

Properties:
- `recipientId` (string(uuid)) required: Recipient entity ID.
- `recipientType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Recipient entity type.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `currency` (string) required: ISO 4217 currency code. (nullable, min length 3, max length 3, pattern ^[A-Za-z]{3}$)
- `paymentTermsValue` ([PaymentTerms](https://devportal.demo.winkpg.io/docs/api/models/PaymentTerms.md)): Standard payment terms. (nullable)
  Values:
  - `DueOnReceipt`: Payment due immediately upon receipt.
  - `Net15`: Payment due within 15 days of issue.
  - `Net30`: Payment due within 30 days of issue.
  - `Net45`: Payment due within 45 days of issue.
  - `Net60`: Payment due within 60 days of issue.
  - `Net90`: Payment due within 90 days of issue.
  - `Custom`: Custom number of days specified via InvoiceConsts.
- `customPaymentDays` (integer(int32)): Custom number of days when PaymentTerms is Custom. Conditional: When PaymentTermsValue == Custom. Must be > 0. (nullable)
- `dueDate` (string(date-time)): Manual due date override (used if PaymentTerms is null). (nullable)
- `allowPartialPayment` (boolean): Whether partial payments are allowed. (nullable)
- `minimumPaymentAmount` (number(double)): Minimum payment amount when partial payments are enabled. Conditional: When AllowPartialPayment is true and MinimumPaymentAmount is not null. Must be > 0. (nullable)
- `partialPaymentTolerance` (number(double)): Auto-close tolerance. (nullable)
- `depositType` ([InvoiceDepositType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDepositType.md)): When set, requests an up-front deposit on the invoice: the payer is charged exactly the deposit  first, then the remaining balance. Null means no deposit is requested. When set, `depositValue`  is required. (nullable)
  Values:
  - `Percentage`: Deposit is a percentage (0 < value < 100) of the invoice grand total.
  - `FixedAmount`: Deposit is a fixed currency amount (0 < value < grand total).
- `depositValue` (number(double)): The deposit percentage (e.g. 25 for 25%) when `depositType` is  `Percentage`, or the fixed deposit amount when it is  `FixedAmount`. Must be positive; the resolved amount must be  strictly less than the invoice total. Required: When DepositType is not null. Must be > 0. Must be < 100. (nullable)
- `depositDueDate` (string(date-time)): Optional deposit due date, distinct from the balance `dueDate`. When set, it must not  be after the balance due date. Conditional: When DepositType is not null. (nullable)
- `allowedPaymentMethods` (array<string>): Subset of biller's supported payment methods for this invoice. Conditional: When AllowedPaymentMethods is not null. (nullable)
- `vaultRestriction` ([VaultRestriction](https://devportal.demo.winkpg.io/docs/api/models/VaultRestriction.md)): Controls whether new or saved payment methods are allowed. (nullable)
  Values:
  - `Any`: Allow any payment method (new or saved).
  - `AllowNewAndSaved`: Allow both new and saved payment methods.
  - `SavedOnly`: Only allow previously saved (vaulted) payment methods.
- `applyConvenienceFee` (boolean): Per-invoice override of the merchant's convenience fee on this invoice's payments:  `true` applies it, `false` suppresses it, and `null` (the default, and the  behaviour of any payload that omits the field) inherits the merchant and feature decision.  An override can suppress a fee but can never create one: `true` applies the fee only  when invoice convenience fees are enabled for the tenant and the merchant has a  convenience-fee configuration, and the platform's compliance rules still govern whether the  resulting transaction keeps the fee. (nullable)
- `hppPageId` (string(uuid)): Linked HPP configuration ID. (nullable)
- `templateId` (string(uuid)): Invoice style/template reference. (nullable)
- `invoiceLevelDiscount` ([InvoiceDiscountDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDiscountDto.md)): Invoice-level discount.
  Fields:
  - `type` ([DiscountType](https://devportal.demo.winkpg.io/docs/api/models/DiscountType.md)): The type of discount applied to a line item or invoice.
    Values:
    - `Percent`: Percentage discount (e.g., 10%).
    - `Flat`: Flat dollar amount discount (e.g., $5.00).
  - `value` (number(double))
  - `description` (string): (nullable)
- `reminderConfig` ([InvoiceReminderConfigDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceReminderConfigDto.md)): Per-invoice reminder overrides.
  Fields:
  - `preDueDays` (array<integer(int32)>): Days before the due date to send a reminder (for example 7, 3, 1). Null or omitted inherits the  tenant default; an empty list sends no pre-due reminders for this invoice. (nullable)
  - `dueDayReminder` (boolean): (nullable)
  - `postDueDays` (array<integer(int32)>): Days after the due date to send a reminder (for example 1, 7, 14, 30). Null or omitted inherits  the tenant default; an empty list sends no scheduled post-due reminders for this invoice. (nullable)
  - `postDueRecurringDays` (integer(int32)): (nullable)
  - `stopOnPaid` (boolean): (nullable)
  - `maxReminders` (integer(int32)): (nullable)
  - `dunningEndAction` ([DunningEndAction](https://devportal.demo.winkpg.io/docs/api/models/DunningEndAction.md)): (nullable)
    Values:
    - `None`: No automatic action taken.
    - `MarkUncollectible`: Transition the invoice to Uncollectible.
    - `Close`: Transition the invoice to Closed.
  - `daysUntilUncollectible` (integer(int32)): (nullable)
- `sourceType` ([InvoiceSourceType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceSourceType.md)): How this invoice was created. (nullable)
  Values:
  - `Manual`: Manually created by a user.
  - `UsageBilling`: Generated from usage billing data.
  - `RecurringBilling`: Generated from a recurring billing contract.
  - `Api`: Created via API by an external integration.
- `sourceReferenceId` (string): Caller-provided reference. Conditional: When SourceReferenceId is not empty. Max length: 200. (nullable)
- `notes` (array<[EntityNote](https://devportal.demo.winkpg.io/docs/api/models/EntityNote.md)>): Internal notes (not shown to recipient). (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `enteredBy` (string(uuid))
  - `timestamp` (string(date-time))
  - `enteredByName` (string): Denormalized display name of the user who created the note.  Populated at creation time from `ICurrentUser` to avoid N+1 lookups when rendering. (nullable)
  - `content` (string): (nullable, min length 0, max length 1000)
- `recipientNote` (string): Shown on the invoice to the recipient. Conditional: When RecipientNote is not empty. Max length: 2000. (nullable)
- `footerText` (string): Terms and conditions text. Conditional: When FooterText is not empty. Max length: 5000. (nullable)
- `lineItems` (array<[InvoiceLineItemInputDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceLineItemInputDto.md)>): Line items to set on the invoice. (nullable)
  Fields of each item:
  - `parentLineItemId` (string(uuid)): Parent line item ID for bundle/discount/tax line hierarchies. (nullable)
  - `name` (string): Product name snapshot (formal product name). (nullable, max length 200)
  - `description` (string) required: Line item description shown on PDF and HPP. (nullable, max length 500)
  - `notes` (string): Per-line notes visible to the biller only. (nullable, max length 500)
  - `productId` (string(uuid)): Optional link to the product catalog. (nullable)
  - `productCode` (string): SKU or product code. (nullable, max length 50)
  - `unitOfMeasure` (string): Unit of measure (e.g., "each", "hour", "GB"). (nullable, max length 50)
  - `commodityCode` (string): Commodity code sent as enhanced (Level 3) card data when the invoice is paid by card. At most  25 characters. (nullable, max length 25)
  - `quantity` (number(double)): Quantity (default 1). (greater than 0)
  - `unitPrice` (number(double)): Unit price. (min 0)
  - `cost` (number(double)): Cost for margin tracking. (nullable)
  - `pricingSource` ([PricingSource](https://devportal.demo.winkpg.io/docs/api/models/PricingSource.md)): How the unit price was determined. (nullable)
    Values:
    - `Catalog`: Price taken from the product catalog at time of invoicing.
    - `Override`: Price manually overridden by the user.
    - `Promotion`: Price determined by a promotion or coupon.
    - `Contract`: Price from a negotiated contract or quote.
  - `discountType` ([DiscountType](https://devportal.demo.winkpg.io/docs/api/models/DiscountType.md)): Type of discount applied to this line item. (nullable)
    Values:
    - `Percent`: Percentage discount (e.g., 10%).
    - `Flat`: Flat dollar amount discount (e.g., $5.00).
  - `discountValue` (number(double)): Discount value (percentage or flat amount). (nullable)
  - `taxRateId` (string(uuid)): Reference to a reusable tax rate definition. (nullable)
  - `taxRatePercent` (number(double)): Snapshot of the tax rate percentage. (nullable)
  - `taxJurisdiction` (string): Tax jurisdiction (state/country). (nullable, max length 100)
  - `taxRateSource` ([InvoiceTaxRateSource](https://devportal.demo.winkpg.io/docs/api/models/InvoiceTaxRateSource.md)): Optional. Where `taxRatePercent` came from. Provider is stored only when  `taxRateProviderName` is supplied and `taxRateId` is not; any other  combination is stored as Catalog when a rate id is named, otherwise Manual. Provenance is  recorded as supplied, like the percentage: the platform does not verify that a lookup ran. (nullable)
    Values:
    - `Manual`: The operator typed the percentage, or nothing recorded where it came from.
    - `Catalog`: The percentage was snapshotted from one of the biller's named tax rates.
    - `Provider`: The percentage was sourced from the merchant's bound tax provider.
  - `taxRateProviderName` (string): Optional. The tax provider that sourced the percentage; meaningful only with a Provider source. (nullable, max length 50)
  - `taxCode` (string): Tax code snapshotted from product or overridden. (nullable, max length 50)
  - `isTaxable` (boolean): Whether tax applies to this line. (nullable)
  - `isDiscountLine` (boolean): Indicates this is a discount adjustment line. (nullable)
  - `isSystemGenerated` (boolean): Indicates this line was auto-generated. (nullable)
  - `isOptional` (boolean): For quotes-to-invoices flow: whether this line is optional. (nullable)
  - `revenueAccount` (string): GL account for revenue recognition. (nullable, max length 100)
  - `recognitionStartDate` (string(date-time)): Revenue recognition start date. (nullable)
  - `recognitionEndDate` (string(date-time)): Revenue recognition end date. (nullable)
  - `attributes` (object): Extensibility metadata (key-value pairs). (nullable)
- `customFields` (array<[CustomFieldValueDto](https://devportal.demo.winkpg.io/docs/api/models/CustomFieldValueDto.md)>): Custom field values. (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `key` (string) required: (nullable, max length 100)
  - `label` (string): (nullable, max length 200)
  - `value` (string): (nullable, max length 2000)
- `billerSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Optional biller snapshot to freeze on this invoice at creation time.  When supplied, overrides the empty-placeholder default used by IssueAsync.  Useful for programmatic/system-generated invoices where the caller already  holds the party's display info (e.g., billing-run invoice generation).
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Optional recipient snapshot to freeze on this invoice at creation time.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `concurrencyStamp` (string): (nullable)

_Example: Replace a draft's lines_

Replaces the draft's lines with the two sent, both taxed at 8.25 percent, and the server recomputes the totals: a subtotal of 735.00, tax of 60.64 and a total of 795.64. The terms, notes and payment options on the draft are replaced too, and a member left out is cleared, so send every value the draft should keep; line items and custom fields left out are kept as stored. Net 15 terms set the due date when the invoice is issued. Only a draft can be updated: an issued invoice is locked and answers 409 Invoicing:Invoice:IsLocked, and corrections to it are credit notes. Send the concurrencyStamp from your latest read of the invoice, and the recipientId it already names.

```json
{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "lineItems": [
    {
      "description": "Website maintenance, October 2026",
      "quantity": 1,
      "unitPrice": 450,
      "taxRatePercent": 8.25
    },
    {
      "description": "Emergency plugin update",
      "unitOfMeasure": "hour",
      "quantity": 3,
      "unitPrice": 95,
      "taxRatePercent": 8.25
    }
  ],
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  }
}
```

## Responses

### 200

OK

**Content type:** `application/json`

Schema: [`InvoiceDto`](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDto.md)

Properties:
- `extraProperties` (object): (nullable, read only)
- `id` (string(uuid))
- `creationTime` (string(date-time)): The date and time when this entity was created.
- `creatorId` (string(uuid)): The ID of the user who created this entity. (nullable)
- `lastModificationTime` (string(date-time)): The date and time when this entity was last modified. (nullable)
- `lastModifierId` (string(uuid)): The ID of the user who last modified this entity. (nullable)
- `isDeleted` (boolean): Indicates whether this entity has been deleted.
- `deleterId` (string(uuid)): The ID of the user who deleted this entity, if it is deleted. (nullable)
- `deletionTime` (string(date-time)): The date and time when this entity was deleted, if it is deleted. (nullable)
- `tenantId` (string(uuid)): (nullable)
- `billerId` (string(uuid))
- `billerType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `recipientId` (string(uuid))
- `recipientType` ([InvoicePartyType](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartyType.md)): Identifies the type of entity acting as the biller or recipient on an invoice.
  Values:
  - `GatewayOwner`: Platform-level gateway owner.
  - `Reseller`: Reseller entity.
  - `Merchant`: Merchant entity.
  - `Customer`: End customer.
- `invoiceNumber` (string): (nullable)
- `status` ([InvoiceStatus](https://devportal.demo.winkpg.io/docs/api/models/InvoiceStatus.md)): Represents the lifecycle status of an invoice.
  Values:
  - `Draft`: Created, editable, not yet issued.
  - `Issued`: Locked and immutable from this point forward.
  - `Sent`: Delivered to recipient via a notification channel.
  - `Viewed`: Recipient opened/viewed the invoice.
  - `PartiallyPaid`: Some payments applied, balance remaining.
  - `Paid`: Fully paid (balance = 0).
  - `PastDue`: Due date passed with outstanding balance.
  - `Closed`: Manually closed (write-off).
  - `Uncollectible`: Auto-marked after dunning period exhausted (configurable: 30/60/90 days past due).
  - `Cancelled`: Voided (only from Draft).
  - `Refunded`: Full refund issued.
- `isLocked` (boolean): (nullable)
- `billerSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Read DTO for denormalized biller/recipient info frozen at invoice issuance.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `recipientSnapshot` ([InvoicePartySnapshotDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePartySnapshotDto.md)): Read DTO for denormalized biller/recipient info frozen at invoice issuance.
  Fields:
  - `name` (string): (nullable, max length 200)
  - `email` (string): (nullable, max length 256)
  - `phone` (string): (nullable, max length 30)
  - `addressLine1` (string): (nullable, max length 200)
  - `addressLine2` (string): (nullable, max length 200)
  - `city` (string): (nullable, max length 100)
  - `state` (string): (nullable, max length 100)
  - `postalCode` (string): (nullable, max length 20)
  - `country` (string): (nullable, max length 100)
  - `companyName` (string): (nullable, max length 200)
  - `taxId` (string): (nullable, max length 50)
  - `logoUrl` (string): (nullable, max length 2048)
- `currency` (string): (nullable)
- `subtotal` (number(double)): (nullable)
- `taxTotal` (number(double)): (nullable)
- `discountTotal` (number(double)): (nullable)
- `grandTotal` (number(double)): (nullable)
- `amountPaid` (number(double)): (nullable)
- `balanceDue` (number(double)): (nullable)
- `invoiceLevelDiscount` ([InvoiceDiscountDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDiscountDto.md)): DTO for an invoice-level discount.
  Fields:
  - `type` ([DiscountType](https://devportal.demo.winkpg.io/docs/api/models/DiscountType.md)): The type of discount applied to a line item or invoice.
    Values:
    - `Percent`: Percentage discount (e.g., 10%).
    - `Flat`: Flat dollar amount discount (e.g., $5.00).
  - `value` (number(double))
  - `description` (string): (nullable)
- `issueDate` (string(date-time)): (nullable)
- `dueDate` (string(date-time)): (nullable)
- `sentAt` (string(date-time)): (nullable)
- `viewedAt` (string(date-time)): (nullable)
- `paidAt` (string(date-time)): (nullable)
- `paymentTermsValue` ([PaymentTerms](https://devportal.demo.winkpg.io/docs/api/models/PaymentTerms.md)): (nullable)
  Values:
  - `DueOnReceipt`: Payment due immediately upon receipt.
  - `Net15`: Payment due within 15 days of issue.
  - `Net30`: Payment due within 30 days of issue.
  - `Net45`: Payment due within 45 days of issue.
  - `Net60`: Payment due within 60 days of issue.
  - `Net90`: Payment due within 90 days of issue.
  - `Custom`: Custom number of days specified via InvoiceConsts.
- `customPaymentDays` (integer(int32)): (nullable)
- `allowPartialPayment` (boolean): (nullable)
- `minimumPaymentAmount` (number(double)): (nullable)
- `partialPaymentTolerance` (number(double)): (nullable)
- `allowedPaymentMethods` (array<string>): (nullable)
- `vaultRestriction` ([VaultRestriction](https://devportal.demo.winkpg.io/docs/api/models/VaultRestriction.md)): (nullable)
  Values:
  - `Any`: Allow any payment method (new or saved).
  - `AllowNewAndSaved`: Allow both new and saved payment methods.
  - `SavedOnly`: Only allow previously saved (vaulted) payment methods.
- `applyConvenienceFee` (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` ([InvoiceDepositRequestInfoDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDepositRequestInfoDto.md)): The deposit request on this invoice, if any. Null when no deposit was requested.
  Fields:
  - `depositType` ([InvoiceDepositType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceDepositType.md)): Whether the deposit is a percentage of the total or a fixed amount.
    Values:
    - `Percentage`: Deposit is a percentage (0 < value < 100) of the invoice grand total.
    - `FixedAmount`: Deposit is a fixed currency amount (0 < value < grand total).
  - `depositValue` (number(double)): The configured percentage (e.g. 25 for 25%) or fixed amount.
  - `depositAmount` (number(double)): The resolved absolute deposit amount (rounded to the cent).
  - `depositDueDate` (string(date-time)): When the deposit is due; null when due on receipt with the invoice. (nullable)
  - `isSatisfied` (boolean): True once the deposit has been fully collected.
- `hppPageId` (string(uuid)): (nullable)
- `templateId` (string(uuid)): (nullable)
- `sourceType` ([InvoiceSourceType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceSourceType.md)): (nullable)
  Values:
  - `Manual`: Manually created by a user.
  - `UsageBilling`: Generated from usage billing data.
  - `RecurringBilling`: Generated from a recurring billing contract.
  - `Api`: Created via API by an external integration.
- `sourceReferenceId` (string): (nullable)
- `notes` (array<[EntityNote](https://devportal.demo.winkpg.io/docs/api/models/EntityNote.md)>): (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `enteredBy` (string(uuid))
  - `timestamp` (string(date-time))
  - `enteredByName` (string): Denormalized display name of the user who created the note.  Populated at creation time from `ICurrentUser` to avoid N+1 lookups when rendering. (nullable)
  - `content` (string): (nullable, min length 0, max length 1000)
- `recipientNote` (string): (nullable)
- `footerText` (string): (nullable)
- `reminderConfig` ([InvoiceReminderConfigDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceReminderConfigDto.md)): 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.
  Fields:
  - `preDueDays` (array<integer(int32)>): Days before the due date to send a reminder (for example 7, 3, 1). Null or omitted inherits the  tenant default; an empty list sends no pre-due reminders for this invoice. (nullable)
  - `dueDayReminder` (boolean): (nullable)
  - `postDueDays` (array<integer(int32)>): Days after the due date to send a reminder (for example 1, 7, 14, 30). Null or omitted inherits  the tenant default; an empty list sends no scheduled post-due reminders for this invoice. (nullable)
  - `postDueRecurringDays` (integer(int32)): (nullable)
  - `stopOnPaid` (boolean): (nullable)
  - `maxReminders` (integer(int32)): (nullable)
  - `dunningEndAction` ([DunningEndAction](https://devportal.demo.winkpg.io/docs/api/models/DunningEndAction.md)): (nullable)
    Values:
    - `None`: No automatic action taken.
    - `MarkUncollectible`: Transition the invoice to Uncollectible.
    - `Close`: Transition the invoice to Closed.
  - `daysUntilUncollectible` (integer(int32)): (nullable)
- `lineItems` (array<[InvoiceLineItemDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceLineItemDto.md)>): (nullable)
  Fields of each item:
  - `id` (string(uuid)): Stable identity for update/delete operations.
  - `sortOrder` (integer(int32)): Display order on the invoice.
  - `parentLineItemId` (string(uuid)): Parent line item ID for bundle/discount/tax line hierarchies. (nullable)
  - `name` (string): Product name snapshot (formal product name). (nullable)
  - `description` (string): Line item description shown on PDF and HPP. (nullable)
  - `notes` (string): Per-line notes visible to the biller only. (nullable)
  - `productId` (string(uuid)): Optional link to the product catalog. (nullable)
  - `productCode` (string): SKU or product code. (nullable)
  - `unitOfMeasure` (string): Unit of measure (e.g., "each", "hour", "GB"). (nullable)
  - `commodityCode` (string): Commodity code sent as enhanced (Level 3) card data when the invoice is paid by card. At most  25 characters. (nullable)
  - `quantity` (number(double)): Quantity.
  - `unitPrice` (number(double)): Unit price.
  - `grossAmount` (number(double)): Computed: Quantity * UnitPrice.
  - `cost` (number(double)): Cost for margin tracking. (nullable)
  - `pricingSource` ([PricingSource](https://devportal.demo.winkpg.io/docs/api/models/PricingSource.md)): How the unit price was determined. (nullable)
    Values:
    - `Catalog`: Price taken from the product catalog at time of invoicing.
    - `Override`: Price manually overridden by the user.
    - `Promotion`: Price determined by a promotion or coupon.
    - `Contract`: Price from a negotiated contract or quote.
  - `discountType` ([DiscountType](https://devportal.demo.winkpg.io/docs/api/models/DiscountType.md)): Type of discount applied to this line item. (nullable)
    Values:
    - `Percent`: Percentage discount (e.g., 10%).
    - `Flat`: Flat dollar amount discount (e.g., $5.00).
  - `discountValue` (number(double)): Discount value (percentage or flat amount). (nullable)
  - `discountAmount` (number(double)): Resolved discount amount. (nullable)
  - `netAmount` (number(double)): After discount, before tax.
  - `taxRateId` (string(uuid)): Reference to a reusable tax rate definition. (nullable)
  - `taxRatePercent` (number(double)): Snapshot of the tax rate percentage. (nullable)
  - `taxableAmount` (number(double)): Explicit taxable base amount. (nullable)
  - `taxAmount` (number(double)): Computed tax amount.
  - `taxJurisdiction` (string): Tax jurisdiction (state/country). (nullable)
  - `taxRateSource` ([InvoiceTaxRateSource](https://devportal.demo.winkpg.io/docs/api/models/InvoiceTaxRateSource.md)): Where `taxRatePercent` came from. Always populated on read: a line stored before  provenance existed reads as Catalog when it names a `taxRateId`, otherwise Manual. (nullable)
    Values:
    - `Manual`: The operator typed the percentage, or nothing recorded where it came from.
    - `Catalog`: The percentage was snapshotted from one of the biller's named tax rates.
    - `Provider`: The percentage was sourced from the merchant's bound tax provider.
  - `taxRateProviderName` (string): The tax provider that sourced the percentage, when `taxRateSource` is Provider. (nullable)
  - `taxCode` (string): Tax code snapshotted from product or overridden. (nullable)
  - `isTaxable` (boolean): Whether tax applies to this line. (nullable)
  - `lineTotal` (number(double)): Line total including tax.
  - `isDiscountLine` (boolean): Indicates this is a discount adjustment line. (nullable)
  - `isSystemGenerated` (boolean): Indicates this line was auto-generated. (nullable)
  - `isOptional` (boolean): For quotes-to-invoices flow: whether this line is optional. (nullable)
  - `revenueAccount` (string): GL account for revenue recognition. (nullable)
  - `recognitionStartDate` (string(date-time)): Revenue recognition start date. (nullable)
  - `recognitionEndDate` (string(date-time)): Revenue recognition end date. (nullable)
  - `attributes` (object): Extensibility metadata (key-value pairs). (nullable)
- `payments` (array<[InvoicePaymentDto](https://devportal.demo.winkpg.io/docs/api/models/InvoicePaymentDto.md)>): (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `transactionId` (string(uuid)): (nullable)
  - `amount` (number(double)): The amount applied against the invoice balance: the invoiced base, never a fee-inclusive  total. Fees the payer was charged on top ride the members below.
  - `convenienceFeeAmount` (number(double)): The convenience fee charged on top of `amount`, in the invoice currency, when one was  assessed. (nullable)
  - `surchargeAmount` (number(double)): The credit-card surcharge charged on top of `amount`, in the invoice currency, when one  was assessed. (nullable)
  - `chargedTotal` (number(double)): The total the payer was actually charged, when known. (nullable)
  - `paymentMethod` (string): (nullable)
  - `status` ([InvoicePaymentStatus](https://devportal.demo.winkpg.io/docs/api/models/InvoicePaymentStatus.md)): Status of a payment attempt against an invoice.
    Values:
    - `Pending`: Payment is pending processing.
    - `Succeeded`: Payment succeeded.
    - `Declined`: Payment was declined by the processor.
    - `Returned`: Payment was returned (e.g., ACH return).
    - `Refunded`: Payment was refunded.
    - `Indeterminate`: The attempt reached the processor but produced no answer the invoice can act on: a referral the merchant has to resolve by voice, a pending or submitted authorization, a partial approval whose approved base cannot be derived, or a status the platform does not recognize. Nothing is credited against the balance and the attempt is not a decline; the row exists so the invoice shows that someone tried and what came back.
  - `declineReasonCode` (string): (nullable)
  - `appliedAt` (string(date-time))
  - `notes` (string): (nullable)
  - `recordedBy` (string): (nullable)
- `activities` (array<[InvoiceActivityDto](https://devportal.demo.winkpg.io/docs/api/models/InvoiceActivityDto.md)>): (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `timestamp` (string(date-time))
  - `type` ([InvoiceActivityType](https://devportal.demo.winkpg.io/docs/api/models/InvoiceActivityType.md)): Classifies entries in the invoice activity timeline.
    Values:
    - `Created`: Invoice was created.
    - `Sent`: Invoice was sent to the recipient.
    - `Viewed`: Recipient viewed the invoice.
    - `PaymentReceived`: A payment was received.
    - `PaymentDeclined`: A payment attempt was declined.
    - `ReminderSent`: A reminder was sent.
    - `StatusChanged`: Invoice status changed.
    - `Edited`: Invoice was edited (Draft only).
    - `Closed`: Invoice was closed.
    - `Cancelled`: Invoice was cancelled.
    - `Refunded`: Invoice was refunded.
    - `CreditApplied`: A credit note was applied.
    - `NoteAdded`: An internal note was added.
    - `AutoChargeAttempted`: An automatic payment was attempted (auto-charge or smart-retry).
    - `PaymentRetryScheduled`: A soft-declined automatic payment was scheduled for a retry.
    - `PaymentRetriesExhausted`: Smart-retry attempts were exhausted (max attempts or retry window reached).
    - `PaymentRetriesStopped`: Smart-retry attempts were stopped (hard decline or manual intervention).
    - `PaymentPlanStarted`: A payment plan was set up against the invoice balance.
    - `InstallmentCollected`: An installment was collected (manually recorded or auto-charged).
    - `InstallmentCollectionFailed`: An automatic installment collection attempt failed (declined).
    - `PaymentPlanCancelled`: The payment plan was cancelled before all installments were collected.
    - `PaymentIndeterminate`: A payment attempt came back with a result the invoice cannot act on (a referral, a pending or submitted authorization, a partial approval, or an unrecognized status). Nothing was credited. Appended last: the numeric value is stored on the activity row and must never be renumbered.
    - `PaymentLinkReissued`: An operator replaced the payment link with a fresh one without notifying the recipient. The previous link stopped working. Appended last: the numeric value is stored on the activity row and must never be renumbered.
  - `description` (string): (nullable)
  - `userId` (string(uuid)): (nullable)
  - `metadata` (string): (nullable)
- `customFields` (array<[CustomFieldValueDto](https://devportal.demo.winkpg.io/docs/api/models/CustomFieldValueDto.md)>): (nullable)
  Fields of each item:
  - `id` (string(uuid))
  - `key` (string) required: (nullable, max length 100)
  - `label` (string): (nullable, max length 200)
  - `value` (string): (nullable, max length 2000)
- `concurrencyStamp` (string): (nullable)
- `entityVersion` (integer(int32))

### 403

Forbidden

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 401

Unauthorized

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 400

Bad Request

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Request failed validation_

One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing.

```json
{
  "error": {
    "code": "null",
    "message": "Your request is not valid!",
    "details": "The following errors were detected during validation.",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": [
      {
        "message": "'Amount' must be greater than 0.",
        "members": [
          "amount"
        ]
      },
      {
        "message": "The card has expired.",
        "members": [
          "expirationDate"
        ],
        "code": "CardData:CardExpired"
      },
      {
        "message": "'Value' must not be empty.",
        "members": [
          "value"
        ],
        "memberPaths": [
          "customFields[2].value"
        ]
      }
    ]
  }
}
```

### 404

Not Found

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Resource not found_

The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message.

```json
{
  "error": {
    "code": "null",
    "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 409

Conflict. The `concurrencyStamp` sent is not the resource's current one: the resource changed after it was read. Read the resource again and retry with the `concurrencyStamp` it returns. The body carries the standard error envelope.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 501

Not Implemented

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 500

Internal Server Error

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

### 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](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take.

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

_Example: Business rule refused the request_

The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code.

```json
{
  "error": {
    "code": "Transactions:OperationNotAllowed",
    "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.",
    "details": "null",
    "data": {
      "correlationId": "0123456789abcdef0123456789abcdef"
    },
    "validationErrors": "null"
  }
}
```

### 429

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.

**Content type:** `application/problem+json`

Schema: [`RateLimitProblemDetails`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md)

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

**Content type:** `application/json`

Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md)

Properties:
- `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md))

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

### cURL

```bash
curl -X PUT "{{BASE_URL}}/api/invoicing/invoices/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "lineItems": [
    {
      "description": "Website maintenance, October 2026",
      "quantity": 1,
      "unitPrice": 450,
      "taxRatePercent": 8.25
    },
    {
      "description": "Emergency plugin update",
      "unitOfMeasure": "hour",
      "quantity": 3,
      "unitPrice": 95,
      "taxRatePercent": 8.25
    }
  ],
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  }
}'
```

### PowerShell

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

$body = @'
{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "lineItems": [
    {
      "description": "Website maintenance, October 2026",
      "quantity": 1,
      "unitPrice": 450,
      "taxRatePercent": 8.25
    },
    {
      "description": "Emergency plugin update",
      "unitOfMeasure": "hour",
      "quantity": 3,
      "unitPrice": 95,
      "taxRatePercent": 8.25
    }
  ],
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  }
}
'@

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

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
import { Configuration, InvoicingApi } from '@winkpg/winkpg-api';

const api = new InvoicingApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.invoiceCrudUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "lineItems": [
    {
      "description": "Website maintenance, October 2026",
      "quantity": 1,
      "unitPrice": 450,
      "taxRatePercent": 8.25
    },
    {
      "description": "Emergency plugin update",
      "unitOfMeasure": "hour",
      "quantity": 3,
      "unitPrice": 95,
      "taxRatePercent": 8.25
    }
  ],
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  }
});
```

### TypeScript (raw HTTP)

```typescript
const response = await fetch('{{BASE_URL}}/api/invoicing/invoices/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
    "recipientId": "00000000-0000-0000-0000-000000000201",
    "recipientType": "Customer",
    "currency": "USD",
    "paymentTermsValue": "Net15",
    "lineItems": [
      {
        "description": "Website maintenance, October 2026",
        "quantity": 1,
        "unitPrice": 450,
        "taxRatePercent": 8.25
      },
      {
        "description": "Emergency plugin update",
        "unitOfMeasure": "hour",
        "quantity": 3,
        "unitPrice": 95,
        "taxRatePercent": 8.25
      }
    ],
    "recipientSnapshot": {
      "name": "Jordan Rivera",
      "email": "jordan.rivera@example.com"
    }
  }),
});

const data = await response.json();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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<InvoiceUpdateDto>("""
    {
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "recipientId": "00000000-0000-0000-0000-000000000201",
      "recipientType": "Customer",
      "currency": "USD",
      "paymentTermsValue": "Net15",
      "lineItems": [
        {
          "description": "Website maintenance, October 2026",
          "quantity": 1,
          "unitPrice": 450,
          "taxRatePercent": 8.25
        },
        {
          "description": "Emergency plugin update",
          "unitOfMeasure": "hour",
          "quantity": 3,
          "unitPrice": 95,
          "taxRatePercent": 8.25
        }
      ],
      "recipientSnapshot": {
        "name": "Jordan Rivera",
        "email": "jordan.rivera@example.com"
      }
    }
    """);

var result = await api.InvoiceCrudUpdateAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);
```

### C# (raw HTTP)

```csharp
using System.Text;

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

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

request.Content = new StringContent("""
    {
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "recipientId": "00000000-0000-0000-0000-000000000201",
      "recipientType": "Customer",
      "currency": "USD",
      "paymentTermsValue": "Net15",
      "lineItems": [
        {
          "description": "Website maintenance, October 2026",
          "quantity": 1,
          "unitPrice": 450,
          "taxRatePercent": 8.25
        },
        {
          "description": "Emergency plugin update",
          "unitOfMeasure": "hour",
          "quantity": 3,
          "unitPrice": 95,
          "taxRatePercent": 8.25
        }
      ],
      "recipientSnapshot": {
        "name": "Jordan Rivera",
        "email": "jordan.rivera@example.com"
      }
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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.InvoiceUpdateDto.from_dict({
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "recipientId": "00000000-0000-0000-0000-000000000201",
      "recipientType": "Customer",
      "currency": "USD",
      "paymentTermsValue": "Net15",
      "lineItems": [
        {
          "description": "Website maintenance, October 2026",
          "quantity": 1,
          "unitPrice": 450,
          "taxRatePercent": 8.25
        },
        {
          "description": "Emergency plugin update",
          "unitOfMeasure": "hour",
          "quantity": 3,
          "unitPrice": 95,
          "taxRatePercent": 8.25
        }
      ],
      "recipientSnapshot": {
        "name": "Jordan Rivera",
        "email": "jordan.rivera@example.com"
      }
    })
    result = api.invoice_crud_update("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
import requests

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

body = {
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "lineItems": [
    {
      "description": "Website maintenance, October 2026",
      "quantity": 1,
      "unitPrice": 450,
      "taxRatePercent": 8.25
    },
    {
      "description": "Emergency plugin update",
      "unitOfMeasure": "hour",
      "quantity": 3,
      "unitPrice": 95,
      "taxRatePercent": 8.25
    }
  ],
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  }
}

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

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.