Edit recurring invoice schedule

const options = {
  method: 'PATCH',
  headers: {'x-dolfin-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    memo: '<string>',
    autoSend: true,
    paymentTermsDays: 123,
    totalOccurrences: 123,
    startDate: '2023-11-07T05:31:56Z',
    lineItems: [
      {
        productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity: 123,
        taxRateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        unitPriceOverride: 123
      }
    ]
  })
};

fetch('https://api.dolfinai.co/v1/recurring-invoices/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dolfinai.co/v1/recurring-invoices/{id}"

payload = {
    "memo": "<string>",
    "autoSend": True,
    "paymentTermsDays": 123,
    "totalOccurrences": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "lineItems": [
        {
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 123,
            "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "unitPriceOverride": 123
        }
    ]
}
headers = {
    "x-dolfin-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.dolfinai.co/v1/recurring-invoices/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
request.AddJsonBody("{\n  \"memo\": \"<string>\",\n  \"autoSend\": true,\n  \"paymentTermsDays\": 123,\n  \"totalOccurrences\": 123,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"lineItems\": [\n    {\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 123,\n      \"taxRateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"unitPriceOverride\": 123\n    }\n  ]\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

curl --request PATCH \
  --url https://api.dolfinai.co/v1/recurring-invoices/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-dolfin-api-key: <api-key>' \
  --data '
{
  "memo": "<string>",
  "autoSend": true,
  "paymentTermsDays": 123,
  "totalOccurrences": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "lineItems": [
    {
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 123,
      "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unitPriceOverride": 123
    }
  ]
}
'

{
  "currency": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "memo": "<string>",
  "paymentTermsDays": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "totalOccurrences": 123,
  "occurrencesGenerated": 123,
  "nextRunAt": "2023-11-07T05:31:56Z",
  "autoSend": true,
  "lastGeneratedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "phone": "<string>",
    "taxNumber": "<string>",
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "lineItems": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productName": "<string>",
      "quantity": 123,
      "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unitPriceOverride": 123
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Recurring Invoices

Edit recurring invoice schedule

Edit a schedule’s template. Changes only affect future occurrences — already-generated invoices are untouched (edit a Draft occurrence via PATCH /invoices/). Memo, AutoSend, TotalOccurrences, and LineItems are always editable; StartDate and Cadence only before the first invoice is generated. CustomerId and Currency are immutable — a different counterparty or currency is a new schedule.

Authentication. An API key (x-dolfin-api-key) together with the x-dolfin-organisation-id header identifying the organisation, or a JWT Bearer token that carries the organisation in its claims.

PATCH

recurring-invoices

{id}

Edit recurring invoice schedule

const options = {
  method: 'PATCH',
  headers: {'x-dolfin-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    memo: '<string>',
    autoSend: true,
    paymentTermsDays: 123,
    totalOccurrences: 123,
    startDate: '2023-11-07T05:31:56Z',
    lineItems: [
      {
        productId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        quantity: 123,
        taxRateId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        unitPriceOverride: 123
      }
    ]
  })
};

fetch('https://api.dolfinai.co/v1/recurring-invoices/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.dolfinai.co/v1/recurring-invoices/{id}"

payload = {
    "memo": "<string>",
    "autoSend": True,
    "paymentTermsDays": 123,
    "totalOccurrences": 123,
    "startDate": "2023-11-07T05:31:56Z",
    "lineItems": [
        {
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "quantity": 123,
            "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "unitPriceOverride": 123
        }
    ]
}
headers = {
    "x-dolfin-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://api.dolfinai.co/v1/recurring-invoices/{id}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("x-dolfin-api-key", "<api-key>");
request.AddJsonBody("{\n  \"memo\": \"<string>\",\n  \"autoSend\": true,\n  \"paymentTermsDays\": 123,\n  \"totalOccurrences\": 123,\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"lineItems\": [\n    {\n      \"productId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"quantity\": 123,\n      \"taxRateId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"unitPriceOverride\": 123\n    }\n  ]\n}", false);
var response = await client.PatchAsync(request);

Console.WriteLine("{0}", response.Content);

curl --request PATCH \
  --url https://api.dolfinai.co/v1/recurring-invoices/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-dolfin-api-key: <api-key>' \
  --data '
{
  "memo": "<string>",
  "autoSend": true,
  "paymentTermsDays": 123,
  "totalOccurrences": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "lineItems": [
    {
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "quantity": 123,
      "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unitPriceOverride": 123
    }
  ]
}
'

{
  "currency": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "memo": "<string>",
  "paymentTermsDays": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "totalOccurrences": 123,
  "occurrencesGenerated": 123,
  "nextRunAt": "2023-11-07T05:31:56Z",
  "autoSend": true,
  "lastGeneratedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customer": {
    "name": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organisationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "<string>",
    "phone": "<string>",
    "taxNumber": "<string>",
    "addressLine1": "<string>",
    "addressLine2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "updatedAt": "2023-11-07T05:31:56Z",
    "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "lineItems": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "productName": "<string>",
      "quantity": 123,
      "taxRateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "unitPriceOverride": 123
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

x-dolfin-api-key

string

header

required

An API key issued to your client. It carries the client's scope; org-scoped calls also require the x-dolfin-organisation-id header. Keys are created and revoked by a client administrator.

Headers

x-dolfin-organisation-id

string<uuid>

Target organisation. Required when authenticating with an API key; omit for Bearer callers (resolved from the token).

Path Parameters

string<uuid>

required

Body

application/json

memo

null | string

autoSend

null | boolean

paymentTermsDays

Payment terms in days (0-365) applied to future occurrences. Omit to leave unchanged; 0 means due on receipt.

totalOccurrences

Must be at least the number of occurrences already generated. Setting it equal completes the schedule.

startDate

null | string<date-time>

Only editable before the first invoice is generated.

cadence

null | enum<string>

Only editable before the first invoice is generated.

Available options:

Weekly,

Monthly,

Quarterly,

Annually

lineItems

null | object[]

Full replacement of the line-item templates. Affects future occurrences only.

Show child attributes

Response

currency

string

required

ISO 4217 currency code (e.g. GBP, USD, EUR)

string<uuid>

organisationId

string<uuid>

customerId

string<uuid>

memo

null | string

paymentTermsDays

Payment terms in days applied to every generated invoice. Null means each occurrence uses the organisation's default at generation time.

startDate

string<date-time>

cadence

enum<string>

Available options:

Weekly,

Monthly,

Quarterly,

Annually

totalOccurrences

occurrencesGenerated

nextRunAt

null | string<date-time>

When the next invoice will be generated. Null on Paused, Completed, and Cancelled schedules.

autoSend

boolean

status

enum<string>

Available options:

Active,

Paused,

Completed,

Cancelled

lastGeneratedAt

null | string<date-time>

createdAt

string<date-time>

createdBy

null | string<uuid>

updatedAt

string<date-time>

updatedBy

null | string<uuid>

customer

null | object

Show child attributes

lineItems

object[]

Show child attributes

Overview

Auth

Users

Organisations

Clients

Agent

MCP

Invoices

Invoice Reminders

Recurring Invoices

Credit Notes

Receivables

Bills

Companies

Purchase Orders

Delivery Notes

Matching

Supplier Credit Notes

Approval Policies

Payables

Bank Payments

Gmail

Suppliers

Payments

Customers

Products

Tax Rates

Currencies

Bank details

Industries

Webhooks

Edit recurring invoice schedule

Authorizations

Headers

Path Parameters

Body

Response