Create a recurring invoice template.

POSThttps://staging.softsolz.uk/api/v1/services/invoicing/recurring

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

namestring

Template name.

source_invoice_idsarray of integers

One or more POSTED source invoices to clone each run.

cadencestring

Run cadence (default "monthly").

due_in_daysinteger

Days until due on each generated invoice (default 30).

is_activeboolean

Whether the schedule starts active (default true).

start_atstring

First run time.

Response

Response Body

idstringTemplate id.

namestringTemplate name.

source_invoice_idsarray of integersPosted source invoices cloned each run.

cadencestringRun cadence.

due_in_daysintegerDays until due on each generated invoice.

is_activebooleanWhether the schedule is active.

next_run_atstring | nullNext scheduled run.

created_atstringCreation timestamp.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.invoicing.createRecurring({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 201

{
  "data": {
    "id": "string",
    "name": "string",
    "source_invoice_ids": [],
    "cadence": "string",
    "due_in_days": 0,
    "is_active": true,
    "next_run_at": "string",
    "created_at": "string"
  }
}