Recurring schedules: Updates an existing recurring invoice schedule by id.

PUT /api/invoicing/recurring-schedules/{id} deprecated

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

Requires API key scope: admin (Administration)

**Required permissions**: `Invoicing.RecurringSchedules`, `Invoicing.RecurringSchedules.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 RecurringInvoiceScheduleUpdateDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X PUT "{{BASE_URL}}/api/invoicing/recurring-schedules/{id}" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "name": "Website maintenance retainer",
  "schedule": {
    "frequency": "Monthly",
    "interval": 1,
    "startDate": "2027-01-01"
  },
  "endAfterOccurrences": 12,
  "autoSend": true,
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  },
  "lineItems": [
    {
      "description": "Website maintenance retainer",
      "unitOfMeasure": "month",
      "quantity": 1,
      "unitPrice": 495
    }
  ]
}'

PowerShell

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

$body = @'
{
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "name": "Website maintenance retainer",
  "schedule": {
    "frequency": "Monthly",
    "interval": 1,
    "startDate": "2027-01-01"
  },
  "endAfterOccurrences": 12,
  "autoSend": true,
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  },
  "lineItems": [
    {
      "description": "Website maintenance retainer",
      "unitOfMeasure": "month",
      "quantity": 1,
      "unitPrice": 495
    }
  ]
}
'@

$response = Invoke-RestMethod -Method PUT -Uri '{{BASE_URL}}/api/invoicing/recurring-schedules/{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.recurringInvoiceScheduleUpdate("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "name": "Website maintenance retainer",
  "schedule": {
    "frequency": "Monthly",
    "interval": 1,
    "startDate": "2027-01-01"
  },
  "endAfterOccurrences": 12,
  "autoSend": true,
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  },
  "lineItems": [
    {
      "description": "Website maintenance retainer",
      "unitOfMeasure": "month",
      "quantity": 1,
      "unitPrice": 495
    }
  ]
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/invoicing/recurring-schedules/{id}', {
  method: 'PUT',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
    "name": "Website maintenance retainer",
    "schedule": {
      "frequency": "Monthly",
      "interval": 1,
      "startDate": "2027-01-01"
    },
    "endAfterOccurrences": 12,
    "autoSend": true,
    "recipientId": "00000000-0000-0000-0000-000000000201",
    "recipientType": "Customer",
    "currency": "USD",
    "paymentTermsValue": "Net15",
    "recipientSnapshot": {
      "name": "Jordan Rivera",
      "email": "jordan.rivera@example.com"
    },
    "lineItems": [
      {
        "description": "Website maintenance retainer",
        "unitOfMeasure": "month",
        "quantity": 1,
        "unitPrice": 495
      }
    ]
  }),
});

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<RecurringInvoiceScheduleUpdateDto>("""
    {
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "name": "Website maintenance retainer",
      "schedule": {
        "frequency": "Monthly",
        "interval": 1,
        "startDate": "2027-01-01"
      },
      "endAfterOccurrences": 12,
      "autoSend": true,
      "recipientId": "00000000-0000-0000-0000-000000000201",
      "recipientType": "Customer",
      "currency": "USD",
      "paymentTermsValue": "Net15",
      "recipientSnapshot": {
        "name": "Jordan Rivera",
        "email": "jordan.rivera@example.com"
      },
      "lineItems": [
        {
          "description": "Website maintenance retainer",
          "unitOfMeasure": "month",
          "quantity": 1,
          "unitPrice": 495
        }
      ]
    }
    """);

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

request.Content = new StringContent("""
    {
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "name": "Website maintenance retainer",
      "schedule": {
        "frequency": "Monthly",
        "interval": 1,
        "startDate": "2027-01-01"
      },
      "endAfterOccurrences": 12,
      "autoSend": true,
      "recipientId": "00000000-0000-0000-0000-000000000201",
      "recipientType": "Customer",
      "currency": "USD",
      "paymentTermsValue": "Net15",
      "recipientSnapshot": {
        "name": "Jordan Rivera",
        "email": "jordan.rivera@example.com"
      },
      "lineItems": [
        {
          "description": "Website maintenance retainer",
          "unitOfMeasure": "month",
          "quantity": 1,
          "unitPrice": 495
        }
      ]
    }
    """, 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.RecurringInvoiceScheduleUpdateDto.from_dict({
      "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
      "name": "Website maintenance retainer",
      "schedule": {
        "frequency": "Monthly",
        "interval": 1,
        "startDate": "2027-01-01"
      },
      "endAfterOccurrences": 12,
      "autoSend": True,
      "recipientId": "00000000-0000-0000-0000-000000000201",
      "recipientType": "Customer",
      "currency": "USD",
      "paymentTermsValue": "Net15",
      "recipientSnapshot": {
        "name": "Jordan Rivera",
        "email": "jordan.rivera@example.com"
      },
      "lineItems": [
        {
          "description": "Website maintenance retainer",
          "unitOfMeasure": "month",
          "quantity": 1,
          "unitPrice": 495
        }
      ]
    })
    result = api.recurring_invoice_schedule_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 = {
  "concurrencyStamp": "5d0c8a3e1f7b4c2a9e6d8b1c0f3a7e52",
  "name": "Website maintenance retainer",
  "schedule": {
    "frequency": "Monthly",
    "interval": 1,
    "startDate": "2027-01-01"
  },
  "endAfterOccurrences": 12,
  "autoSend": True,
  "recipientId": "00000000-0000-0000-0000-000000000201",
  "recipientType": "Customer",
  "currency": "USD",
  "paymentTermsValue": "Net15",
  "recipientSnapshot": {
    "name": "Jordan Rivera",
    "email": "jordan.rivera@example.com"
  },
  "lineItems": [
    {
      "description": "Website maintenance retainer",
      "unitOfMeasure": "month",
      "quantity": 1,
      "unitPrice": 495
    }
  ]
}

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

Parameters

Name In Type Description

id required

path

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description

name required

string

Operator-facing name for the series. nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

Optional operator-facing description. Conditional: When Description is not null. Max length: 1000. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

schedule required

ContractSchedule ContractSchedule

The recurrence rule (frequency, interval, start date, optional end date).

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of ContractSchedule:

Field Type Description

frequency required

Frequency Frequency

The type of the recurrence rule.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Secondly`
`Minutely`
`Hourly`
`Daily`
`Weekly`
`Monthly`
`Yearly`

count required

integer (int32)

The number of occurrences in a particular recurrence. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

until required

string (date-time)

The datetime that bounds the current recurrence. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

interval required

integer (int32)

The recurrence interval.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

bySecond required

array of integer (int32) array of

BySecond rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byMinute required

array of integer (int32) array of

BySecond rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byHour required

array of integer (int32) array of

BySecond rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byDay required

array of ContractScheduleByDayRule array of ContractScheduleByDayRule

Week day rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byMonth required

array of integer (int32) array of

Month day rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byMonthDay required

array of integer (int32) array of

Month days rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byYearDay required

array of integer (int32) array of

Year days rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byWeekNumber required

array of integer (int32) array of

Week number rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

bySetPosition required

array of integer (int32) array of

BySetPosition rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

firstDayOfWeek required

DayOfWeek DayOfWeek

The first day of week, used in calculating weekday-based recurrences nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Sunday`
`Monday`
`Tuesday`
`Wednesday`
`Thursday`
`Friday`
`Saturday`

nextScheduledRun required

string (date-time)

The next computed billing date, updated after each billing run. Null for contracts that have never been scheduled or have ended. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

startDate required

string (date-time)

The earliest date on which this contract is eligible to bill. Set by the user when creating the contract (defaults to the creation date) and may be set to a future date to delay first billing. The recurrence engine anchors expansion to this date and the daily billing job will not fire a contract whose `startDate` is in the future. Null on contracts created before this field existed. When it is null, the server anchors the schedule on the contract's creation time, or on the current time when that is also absent; callers that compute a schedule themselves should apply the same fallback. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

endAfterOccurrences required

integer (int32)

Optional cap on the total number of invoices the series will generate. Conditional: When EndAfterOccurrences is not null. Must be > 0. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

autoSend required

boolean

When true, each generated invoice is auto-sent via the standard send workflow.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

paymentLinkExpiryHours required

integer (int32)

Optional payment-link expiry (hours) applied when auto-sending. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

viewTokenExpiryDays required

integer (int32)

Optional view-token expiry (days) applied when auto-sending. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

customMessage required

string

Optional custom recipient message applied when auto-sending. Conditional: When CustomMessage is not null. Max length: 2000. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

recipientId required

string (uuid)

Who the generated invoices are billed to.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

recipientType required

InvoicePartyType InvoicePartyType

The type of recipient entity.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`GatewayOwner`	Platform-level gateway owner.
`Reseller`	Reseller entity.
`Merchant`	Merchant entity.
`Customer`	End customer.

currency required

string

ISO 4217 currency code for generated invoices. nullablemin length 3max length 3pattern ^[A-Za-z]{3}$

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

paymentTermsValue required

PaymentTerms PaymentTerms

Payment terms applied to generated invoices. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`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 required

integer (int32)

Custom number of days when PaymentTerms is Custom. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

allowPartialPayment required

boolean

Whether partial payments are allowed on generated invoices. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

minimumPaymentAmount required

number (double)

Minimum payment amount when partial payments are enabled. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

partialPaymentTolerance required

number (double)

Auto-mark-paid tolerance for generated invoices. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

allowedPaymentMethods required

array of string array of

Subset of supported payment methods allowed on generated invoices. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

vaultRestriction required

VaultRestriction VaultRestriction

Vault restriction applied to generated invoices. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Any`	Allow any payment method (new or saved).
`AllowNewAndSaved`	Allow both new and saved payment methods.
`SavedOnly`	Only allow previously saved (vaulted) payment methods.

hppPageId required

string (uuid)

Linked HPP configuration id. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

templateId required

string (uuid)

Invoice style/template reference (styling only). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

invoiceLevelDiscount required

InvoiceDiscountDto InvoiceDiscountDto

Optional invoice-level discount applied to generated invoices.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoiceDiscountDto:

Field Type Description

type required

DiscountType DiscountType

The type of discount applied to a line item or invoice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Percent`	Percentage discount (e.g., 10%).
`Flat`	Flat dollar amount discount (e.g., $5.00).

value required

number (double)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

reminderConfig required

InvoiceReminderConfigDto InvoiceReminderConfigDto

Reminder configuration applied to generated invoices.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoiceReminderConfigDto:

Field Type Description

preDueDays required

array of integer (int32) array of

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dueDayReminder required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

postDueDays required

array of integer (int32) array of

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

postDueRecurringDays required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

stopOnPaid required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

maxReminders required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dunningEndAction required

DunningEndAction DunningEndAction

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`None`	No automatic action taken.
`MarkUncollectible`	Transition the invoice to Uncollectible.
`Close`	Transition the invoice to Closed.

daysUntilUncollectible required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

billerSnapshot required

InvoicePartySnapshotDto InvoicePartySnapshotDto

Biller snapshot frozen onto each generated invoice at issue time.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoicePartySnapshotDto:

Field Type Description

name required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

email required

string

nullablemax length 256

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

phone required

string

nullablemax length 30

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

addressLine1 required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

addressLine2 required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

city required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

state required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

postalCode required

string

nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

country required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

companyName required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxId required

string

nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

logoUrl required

string

nullablemax length 2048

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

recipientSnapshot required

InvoicePartySnapshotDto InvoicePartySnapshotDto

Recipient snapshot frozen onto each generated invoice at issue time.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoicePartySnapshotDto:

Field Type Description

name required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

email required

string

nullablemax length 256

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

phone required

string

nullablemax length 30

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

addressLine1 required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

addressLine2 required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

city required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

state required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

postalCode required

string

nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

country required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

companyName required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxId required

string

nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

logoUrl required

string

nullablemax length 2048

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

lineItems required

array of InvoiceLineItemInputDto array of InvoiceLineItemInputDto

Line items copied onto each generated invoice. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each InvoiceLineItemInputDto:

Field Type Description

parentLineItemId required

string (uuid)

Parent line item ID for bundle/discount/tax line hierarchies. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

name required

string

Product name snapshot (formal product name). nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

Line item description shown on PDF and HPP. nullablemax length 500

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

notes required

string

Per-line notes visible to the biller only. nullablemax length 500

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

productId required

string (uuid)

Optional link to the product catalog. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

productCode required

string

SKU or product code. nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

unitOfMeasure required

string

Unit of measure (e.g., "each", "hour", "GB"). nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

commodityCode required

string

Commodity code sent as enhanced (Level 3) card data when the invoice is paid by card. At most 25 characters. nullablemax length 25

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

quantity required

number (double)

Quantity (default 1). greater than 0

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

unitPrice required

number (double)

Unit price. min 0

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

cost required

number (double)

Cost for margin tracking. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

pricingSource required

PricingSource PricingSource

How the unit price was determined. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`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 required

DiscountType DiscountType

Type of discount applied to this line item. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Percent`	Percentage discount (e.g., 10%).
`Flat`	Flat dollar amount discount (e.g., $5.00).

discountValue required

number (double)

Discount value (percentage or flat amount). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxRateId required

string (uuid)

Reference to a reusable tax rate definition. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxRatePercent required

number (double)

Snapshot of the tax rate percentage. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxJurisdiction required

string

Tax jurisdiction (state/country). nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxRateSource required

InvoiceTaxRateSource InvoiceTaxRateSource

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: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`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 required

string

Optional. The tax provider that sourced the percentage; meaningful only with a Provider source. nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxCode required

string

Tax code snapshotted from product or overridden. nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isTaxable required

boolean

Whether tax applies to this line. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDiscountLine required

boolean

Indicates this is a discount adjustment line. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isSystemGenerated required

boolean

Indicates this line was auto-generated. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isOptional required

boolean

For quotes-to-invoices flow: whether this line is optional. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

revenueAccount required

string

GL account for revenue recognition. nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

recognitionStartDate required

string (date-time)

Revenue recognition start date. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

recognitionEndDate required

string (date-time)

Revenue recognition end date. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

attributes required

object

Extensibility metadata (key-value pairs). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

customFields required

array of CustomFieldValueDto array of CustomFieldValueDto

Custom field values copied onto each generated invoice. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each CustomFieldValueDto:

Field Type Description

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

key required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

label required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

value required

string

nullablemax length 2000

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

notes required

array of EntityNote array of EntityNote

Internal notes copied onto each generated invoice. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each EntityNote:

Field Type Description

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

enteredBy required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

timestamp required

string (date-time)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

enteredByName required

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

content required

string

nullablemin length 0max length 1000

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

recipientNote required

string

Recipient-facing note copied onto each generated invoice. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

footerText required

string

Footer / terms text copied onto each generated invoice. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

concurrencyStamp required

string

Optimistic concurrency stamp. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This request body has no documented fields.

Responses

200 OK

Body: RecurringInvoiceScheduleDto RecurringInvoiceScheduleDto Each item has these fields.

Field Type Description

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creationTime required

string (date-time)

The date and time when this entity was created.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

creatorId required

string (uuid)

The ID of the user who created this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModificationTime required

string (date-time)

The date and time when this entity was last modified. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastModifierId required

string (uuid)

The ID of the user who last modified this entity. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDeleted required

boolean

Indicates whether this entity has been deleted.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deleterId required

string (uuid)

The ID of the user who deleted this entity, if it is deleted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

deletionTime required

string (date-time)

The date and time when this entity was deleted, if it is deleted. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerId required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

billerType required

InvoicePartyType InvoicePartyType

Identifies the type of entity acting as the biller or recipient on an invoice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`GatewayOwner`	Platform-level gateway owner.
`Reseller`	Reseller entity.
`Merchant`	Merchant entity.
`Customer`	End customer.

name required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

status required

RecurringInvoiceScheduleStatus RecurringInvoiceScheduleStatus

Lifecycle status of a recurring invoice schedule (series).

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Active`	The series is active and generates invoices on each due run.
`Paused`	Generation is suspended; the series can be resumed later. No invoices are generated while paused.
`Cancelled`	The series has been cancelled. Terminal: no further generation.
`Completed`	The series reached its end (end date or max occurrences). Terminal: no further generation.

schedule required

ContractSchedule ContractSchedule

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of ContractSchedule:

Field Type Description

frequency required

Frequency Frequency

The type of the recurrence rule.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Secondly`
`Minutely`
`Hourly`
`Daily`
`Weekly`
`Monthly`
`Yearly`

count required

integer (int32)

The number of occurrences in a particular recurrence. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

until required

string (date-time)

The datetime that bounds the current recurrence. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

interval required

integer (int32)

The recurrence interval.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

bySecond required

array of integer (int32) array of

BySecond rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byMinute required

array of integer (int32) array of

BySecond rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byHour required

array of integer (int32) array of

BySecond rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byDay required

array of ContractScheduleByDayRule array of ContractScheduleByDayRule

Week day rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byMonth required

array of integer (int32) array of

Month day rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byMonthDay required

array of integer (int32) array of

Month days rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byYearDay required

array of integer (int32) array of

Year days rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

byWeekNumber required

array of integer (int32) array of

Week number rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

bySetPosition required

array of integer (int32) array of

BySetPosition rule modifier. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

firstDayOfWeek required

DayOfWeek DayOfWeek

The first day of week, used in calculating weekday-based recurrences nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Sunday`
`Monday`
`Tuesday`
`Wednesday`
`Thursday`
`Friday`
`Saturday`

nextScheduledRun required

string (date-time)

The next computed billing date, updated after each billing run. Null for contracts that have never been scheduled or have ended. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

startDate required

string (date-time)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

nextRunUtc required

string (date-time)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lastRunUtc required

string (date-time)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

occurrenceCount required

integer (int32)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

endAfterOccurrences required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

autoSend required

boolean

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

paymentLinkExpiryHours required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

viewTokenExpiryDays required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

customMessage required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

recipientId required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

recipientType required

InvoicePartyType InvoicePartyType

Identifies the type of entity acting as the biller or recipient on an invoice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`GatewayOwner`	Platform-level gateway owner.
`Reseller`	Reseller entity.
`Merchant`	Merchant entity.
`Customer`	End customer.

currency required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

paymentTermsValue required

PaymentTerms PaymentTerms

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`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 required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

allowPartialPayment required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

minimumPaymentAmount required

number (double)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

partialPaymentTolerance required

number (double)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

allowedPaymentMethods required

array of string array of

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

vaultRestriction required

VaultRestriction VaultRestriction

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Any`	Allow any payment method (new or saved).
`AllowNewAndSaved`	Allow both new and saved payment methods.
`SavedOnly`	Only allow previously saved (vaulted) payment methods.

hppPageId required

string (uuid)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

templateId required

string (uuid)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

invoiceLevelDiscount required

InvoiceDiscountDto InvoiceDiscountDto

DTO for an invoice-level discount.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoiceDiscountDto:

Field Type Description

type required

DiscountType DiscountType

The type of discount applied to a line item or invoice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Percent`	Percentage discount (e.g., 10%).
`Flat`	Flat dollar amount discount (e.g., $5.00).

value required

number (double)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

reminderConfig required

InvoiceReminderConfigDto InvoiceReminderConfigDto

DTO for invoice reminder configuration. Each member overrides the tenant's reminder default on its own; a member that is null or omitted inherits that default.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoiceReminderConfigDto:

Field Type Description

preDueDays required

array of integer (int32) array of

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dueDayReminder required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

postDueDays required

array of integer (int32) array of

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

postDueRecurringDays required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

stopOnPaid required

boolean

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

maxReminders required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

dunningEndAction required

DunningEndAction DunningEndAction

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`None`	No automatic action taken.
`MarkUncollectible`	Transition the invoice to Uncollectible.
`Close`	Transition the invoice to Closed.

daysUntilUncollectible required

integer (int32)

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

billerSnapshot required

InvoicePartySnapshotDto InvoicePartySnapshotDto

Read DTO for denormalized biller/recipient info frozen at invoice issuance.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoicePartySnapshotDto:

Field Type Description

name required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

email required

string

nullablemax length 256

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

phone required

string

nullablemax length 30

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

addressLine1 required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

addressLine2 required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

city required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

state required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

postalCode required

string

nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

country required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

companyName required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxId required

string

nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

logoUrl required

string

nullablemax length 2048

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

recipientSnapshot required

InvoicePartySnapshotDto InvoicePartySnapshotDto

Read DTO for denormalized biller/recipient info frozen at invoice issuance.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of InvoicePartySnapshotDto:

Field Type Description

name required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

email required

string

nullablemax length 256

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

phone required

string

nullablemax length 30

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

addressLine1 required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

addressLine2 required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

city required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

state required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

postalCode required

string

nullablemax length 20

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

country required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

companyName required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxId required

string

nullablemax length 50

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

logoUrl required

string

nullablemax length 2048

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

lineItems required

array of InvoiceLineItemDto array of InvoiceLineItemDto

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each InvoiceLineItemDto:

Field Type Description

id required

string (uuid)

Stable identity for update/delete operations.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

sortOrder required

integer (int32)

Display order on the invoice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

parentLineItemId required

string (uuid)

Parent line item ID for bundle/discount/tax line hierarchies. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

name required

string

Product name snapshot (formal product name). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

description required

string

Line item description shown on PDF and HPP. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

notes required

string

Per-line notes visible to the biller only. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

productId required

string (uuid)

Optional link to the product catalog. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

productCode required

string

SKU or product code. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

unitOfMeasure required

string

Unit of measure (e.g., "each", "hour", "GB"). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

commodityCode required

string

Commodity code sent as enhanced (Level 3) card data when the invoice is paid by card. At most 25 characters. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

quantity required

number (double)

Quantity.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

unitPrice required

number (double)

Unit price.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

grossAmount required

number (double)

Computed: Quantity * UnitPrice.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

cost required

number (double)

Cost for margin tracking. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

pricingSource required

PricingSource PricingSource

How the unit price was determined. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`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 required

DiscountType DiscountType

Type of discount applied to this line item. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`Percent`	Percentage discount (e.g., 10%).
`Flat`	Flat dollar amount discount (e.g., $5.00).

discountValue required

number (double)

Discount value (percentage or flat amount). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

discountAmount required

number (double)

Resolved discount amount. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

netAmount required

number (double)

After discount, before tax.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxRateId required

string (uuid)

Reference to a reusable tax rate definition. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxRatePercent required

number (double)

Snapshot of the tax rate percentage. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxableAmount required

number (double)

Explicit taxable base amount. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxAmount required

number (double)

Computed tax amount.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxJurisdiction required

string

Tax jurisdiction (state/country). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxRateSource required

InvoiceTaxRateSource InvoiceTaxRateSource

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: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

`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 required

string

The tax provider that sourced the percentage, when `taxRateSource` is Provider. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

taxCode required

string

Tax code snapshotted from product or overridden. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isTaxable required

boolean

Whether tax applies to this line. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

lineTotal required

number (double)

Line total including tax.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isDiscountLine required

boolean

Indicates this is a discount adjustment line. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isSystemGenerated required

boolean

Indicates this line was auto-generated. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isOptional required

boolean

For quotes-to-invoices flow: whether this line is optional. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

revenueAccount required

string

GL account for revenue recognition. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

recognitionStartDate required

string (date-time)

Revenue recognition start date. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

recognitionEndDate required

string (date-time)

Revenue recognition end date. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

attributes required

object

Extensibility metadata (key-value pairs). nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

customFields required

array of CustomFieldValueDto array of CustomFieldValueDto

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each CustomFieldValueDto:

Field Type Description

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

key required

string

nullablemax length 100

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

label required

string

nullablemax length 200

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

value required

string

nullablemax length 2000

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

notes required

array of EntityNote array of EntityNote

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of each EntityNote:

Field Type Description

id required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

enteredBy required

string (uuid)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

timestamp required

string (date-time)

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

enteredByName required

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

content required

string

nullablemin length 0max length 1000

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

recipientNote required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

footerText required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

concurrencyStamp required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

403 Forbidden

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

401 Unauthorized

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

400 Bad Request

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

404 Not Found

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

501 Not Implemented

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

500 Internal Server Error

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

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 lists the values `error.code` can take. 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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by Invoicing

The API reference isn't available right now

No such operation

This reference may be out of date

Recurring schedules: Updates an existing recurring invoice schedule by id.

Example request

Parameters

Request body

Responses

200 OK

403 Forbidden

401 Unauthorized

400 Bad Request

404 Not Found

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.

501 Not Implemented

500 Internal Server Error

Errors

Authentication