Sign in

v4

latestOpenAPI 3.1.02026-08-032294621.7 MB
Recurring Invoices

Get RecurringInvoice record

Retrieve a specific RecurringInvoice record by its record number with all related data.

get/public/v2/recurring/invoices/{record_number}/

Path parameters

record_numberinteger required

The number attribute of the record.

The number attribute of the record.

Query parameters

searchstring nullable
company_idinteger[] nullable
numberinteger[] nullable
recurring_typeRecurringType[] nullable
updated_afterstring date-time nullable
updated_beforestring date-time nullable

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