Invoices: Runs the full send workflow.

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

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

Issues the invoice if it is still draft, generates the PDF, creates the payment and view tokens, sends the notification, and marks the invoice as sent. Calling it again on an invoice that is Sent, Viewed, PartiallyPaid or PastDue re-sends it: the payment link and view token are rotated (the links already delivered stop working), a fresh notification is sent, and the status is left unchanged. Any other status is refused with `Invoicing:Invoice:InvalidStatusTransition` and nothing is changed.

Try this in the console

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

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/invoicing/invoices/{id}/send" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "customMessage": "",
  "paymentLinkExpiryHours": 0,
  "viewTokenExpiryDays": 0
}'

PowerShell

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

$body = @'
{
  "customMessage": "",
  "paymentLinkExpiryHours": 0,
  "viewTokenExpiryDays": 0
}
'@

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

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/invoicing/invoices/{id}/send', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "customMessage": "",
    "paymentLinkExpiryHours": 0,
    "viewTokenExpiryDays": 0
  }),
});

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<SendInvoiceInput>("""
    {
      "customMessage": "",
      "paymentLinkExpiryHours": 0,
      "viewTokenExpiryDays": 0
    }
    """);

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

C# (raw HTTP)

using System.Text;

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

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

request.Content = new StringContent("""
    {
      "customMessage": "",
      "paymentLinkExpiryHours": 0,
      "viewTokenExpiryDays": 0
    }
    """, 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.SendInvoiceInput.from_dict({
      "customMessage": "",
      "paymentLinkExpiryHours": 0,
      "viewTokenExpiryDays": 0
    })
    result = api.invoice_lifecycle_send("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

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

body = {
  "customMessage": "",
  "paymentLinkExpiryHours": 0,
  "viewTokenExpiryDays": 0
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/invoicing/invoices/{id}/send",
    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
`customMessage` required	string	Optional custom message to include in the notification email. Conditional: When CustomMessage is not null. Max length: 2000. nullable
`paymentLinkExpiryHours` required	integer (int32)	Payment link expiry in hours. Defaults to 720 (30 days) if not specified. Conditional: When PaymentLinkExpiryHours is not null. Must be > 0. nullable
`viewTokenExpiryDays` required	integer (int32)	View token expiry in days. Defaults to 90 days if not specified. Conditional: When ViewTokenExpiryDays is not null. Must be > 0. nullable

This request body has no documented fields.