Sign in
OpenAPI 3.1.02026-08-122324681.8 MB

1690a2e6f8e9

Recurring Invoices

Create RecurringInvoice record

Create a new RecurringInvoice record with the provided data. Validates all required fields and business rules.

post/public/v2/recurring/invoices/

Request body

rrulestring rrule required

Recurrence rule in iCalendar RRULE format (RFC 5545)

memostring required
namestring required
datestring date required
company_idinteger required
status'active' | 'inactive' required
recurring_type'automatic' | 'reminder' required

Example request

{
  "rrule": "FREQ=DAILY"
}

Response

OK

internal_idinteger required
numberinteger required
namestring required
memostring required
datestring date required
company_idinteger required
company_namestring required
company_currencystring required
status'active' | 'inactive' required
{"stackTrail":"components:schemas:PublicRecurringInvoiceSchemaOut:properties:record_payload","oasType":"schema","type":"unknown","title":"Record Payload"}
rrulestring required
next_occurrencestring date-time nullable required
last_generatedstring date-time nullable required
recurring_type'automatic' | 'reminder' required
created_atstring date-time required

Date and time the record was created

updated_atstring date-time required

Date and time the record was last updated