Invoices: Updates an existing draft invoice by id.

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

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

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

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

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a InvoiceUpdateDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/invoicing/invoices/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": ""
}'

PowerShell

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

$body = @'
{
  "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": ""
}
'@

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

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/invoicing/invoices/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "currency": ""
  }),
});

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<InvoiceUpdateDto>("""
    {
      "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "currency": ""
    }
    """);

var result = await api.InvoiceCrudUpdateAsync(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("PUT"), "/api/invoicing/invoices/{id}");
request.Headers.Add("api-key", "{{API_KEY}}");

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

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "recipientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currency": ""
}

response = requests.request(
    "PUT",
    "{{BASE_URL}}/api/invoicing/invoices/{id}",
    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
`recipientId` required	string (uuid)	Recipient entity ID.
`recipientType` required	all of InvoicePartyType	Recipient entity type.
`currency` required	string	ISO 4217 currency code. nullablemin length 3max length 3pattern ^[A-Za-z]{3}$
`paymentTermsValue` required	all of PaymentTerms	Standard payment terms. nullable
`customPaymentDays` required	integer (int32)	Custom number of days when PaymentTerms is Custom. Conditional: When PaymentTermsValue == Custom. Must be > 0. nullable
`dueDate` required	string (date-time)	Manual due date override (used if PaymentTerms is null). nullable
`allowPartialPayment` required	boolean	Whether partial payments are allowed. nullable
`minimumPaymentAmount` required	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` required	number (double)	Auto-close tolerance. nullable
`depositType` required	all of InvoiceDepositType	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
`depositValue` required	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` required	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` required	array of string	Subset of biller's supported payment methods for this invoice. Conditional: When AllowedPaymentMethods is not null. nullable
`vaultRestriction` required	all of VaultRestriction	Controls whether new or saved payment methods are allowed. nullable
`applyConvenienceFee` required	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` required	string (uuid)	Linked HPP configuration ID. nullable
`templateId` required	string (uuid)	Invoice style/template reference. nullable
`invoiceLevelDiscount` required	all of InvoiceDiscountDto	Invoice-level discount.
`reminderConfig` required	all of InvoiceReminderConfigDto	Per-invoice reminder overrides.
`sourceType` required	all of InvoiceSourceType	How this invoice was created. nullable
`sourceReferenceId` required	string	Caller-provided reference. Conditional: When SourceReferenceId is not empty. Max length: 200. nullable
`notes` required	array of EntityNote	Internal notes (not shown to recipient). nullable
`recipientNote` required	string	Shown on the invoice to the recipient. Conditional: When RecipientNote is not empty. Max length: 2000. nullable
`footerText` required	string	Terms and conditions text. Conditional: When FooterText is not empty. Max length: 5000. nullable
`lineItems` required	array of InvoiceLineItemInputDto	Line items to set on the invoice. nullable
`customFields` required	array of CustomFieldValueDto	Custom field values. nullable
`billerSnapshot` required	all of InvoicePartySnapshotDto	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).
`recipientSnapshot` required	all of InvoicePartySnapshotDto	Optional recipient snapshot to freeze on this invoice at creation time.
`concurrencyStamp` required	string	nullable

This request body has no documented fields.