POST/api/v1/invoices/generate

Generate recurring invoice

Generates one recurring invoice using canonical selector_input payload.

RBAC · invoice

Request body

Content type: application/json · schema InvoiceSelectorBody

selector_inputobjectRequired

clientIdstring <uuid>Required

windowStartstringRequired

windowEndstringRequired

executionWindowobjectRequired

kindstringRequired

Enum: client_cadence_windowcontract_cadence_window

identityKeystringRequired

cadenceOwnerstringRequired

Enum: clientcontract

clientIdstring <uuid>

billingCycleIdstring <uuid>Nullable

contractIdstring <uuid>Nullable

contractLineIdstring <uuid>Nullable

windowStartstringNullable

windowEndstringNullable

Response body

Success response 201 · schema FinancialInvoiceApiSuccess

dataanyOfRequired

anyOf (option 1)object

anyOf (option 2)array of object

itemsobject

metaobject

Response codes

201

Invoice generated.

400

Invalid selector payload.

401

API key missing/invalid.

403

invoice:create permission denied.

500

Unexpected generation failure.

POST /api/v1/invoices/generate

cURL

curl -X POST "https://algapsa.com/api/v1/invoices/generate" \
  -H "X-API-Key: $ALGA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "selector_input": {
    "clientId": "01HN2K7VRB9PQ3Y0000000000",
    "windowStart": "string",
    "windowEnd": "string",
    "executionWindow": {
      "kind": "client_cadence_window",
      "identityKey": "string",
      "cadenceOwner": "client",
      "clientId": "01HN2K7VRB9PQ3Y0000000000",
      "billingCycleId": "01HN2K7VRB9PQ3Y0000000000",
      "contractId": "01HN2K7VRB9PQ3Y0000000000",
      "contractLineId": "01HN2K7VRB9PQ3Y0000000000",
      "windowStart": "string",
      "windowEnd": "string"
    }
  }
}'

TypeScript

const response = await fetch("https://algapsa.com/api/v1/invoices/generate", {
  method: "POST",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "selector_input": {
      "clientId": "01HN2K7VRB9PQ3Y0000000000",
      "windowStart": "string",
      "windowEnd": "string",
      "executionWindow": {
        "kind": "client_cadence_window",
        "identityKey": "string",
        "cadenceOwner": "client",
        "clientId": "01HN2K7VRB9PQ3Y0000000000",
        "billingCycleId": "01HN2K7VRB9PQ3Y0000000000",
        "contractId": "01HN2K7VRB9PQ3Y0000000000",
        "contractLineId": "01HN2K7VRB9PQ3Y0000000000",
        "windowStart": "string",
        "windowEnd": "string"
      }
    }
  })
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://algapsa.com/api/v1/invoices/generate");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Content = new StringContent(@"{
  ""selector_input"": {
    ""clientId"": ""01HN2K7VRB9PQ3Y0000000000"",
    ""windowStart"": ""string"",
    ""windowEnd"": ""string"",
    ""executionWindow"": {
      ""kind"": ""client_cadence_window"",
      ""identityKey"": ""string"",
      ""cadenceOwner"": ""client"",
      ""clientId"": ""01HN2K7VRB9PQ3Y0000000000"",
      ""billingCycleId"": ""01HN2K7VRB9PQ3Y0000000000"",
      ""contractId"": ""01HN2K7VRB9PQ3Y0000000000"",
      ""contractLineId"": ""01HN2K7VRB9PQ3Y0000000000"",
      ""windowStart"": ""string"",
      ""windowEnd"": ""string""
    }
  }
}", Encoding.UTF8, "application/json");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

201 OK·application/json

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