POST/api/v1/invoices/recurring

Create recurring invoice template

Creates a recurring template used for scheduled invoice generation.

RBAC · invoice

Request body

Content type: application/json · schema InvoiceRecurringCreateBody

client_idstring <uuid>Required

namestringRequired

frequencystringRequired

Enum: dailyweeklymonthlyquarterlyannually

start_datestringRequired

end_datestring

is_activeboolean

invoice_templateobjectRequired

max_generationsnumber

Response body

Success response 201 · schema FinancialInvoiceApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

201

Recurring template created.

400

Invalid recurring template payload.

401

API key missing/invalid.

403

invoice:recurring permission denied.

500

Unexpected recurring template creation failure.

POST /api/v1/invoices/recurring

cURL

curl -X POST "https://algapsa.com/api/v1/invoices/recurring" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "client_id": "01HN2K7VRB9PQ3Y0000000000",
  "name": "string",
  "frequency": "daily",
  "start_date": "string",
  "end_date": "string",
  "is_active": false,
  "invoice_template": {},
  "max_generations": 0
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/invoices/recurring", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "client_id": "01HN2K7VRB9PQ3Y0000000000",
    "name": "string",
    "frequency": "daily",
    "start_date": "string",
    "end_date": "string",
    "is_active": false,
    "invoice_template": {},
    "max_generations": 0
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/invoices/recurring");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""client_id"": ""01HN2K7VRB9PQ3Y0000000000"",
  ""name"": ""string"",
  ""frequency"": ""daily"",
  ""start_date"": ""string"",
  ""end_date"": ""string"",
  ""is_active"": false,
  ""invoice_template"": {},
  ""max_generations"": 0
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

201 OK·application/json

{
  "data": {},
  "meta": {}
}