List recurring invoice templates

GET /api/v1/recurring/invoices

List all recurring invoice templates for the business.

Operation ID: list_recurring_invoice_templates_api_v1_recurring_invoices_get · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Query

status RecurringStatusEnum

Filter by status

customer_id string

Filter by customer ID

cursor string

Cursor for pagination

limit integer

Pagination limit

direction string default: next

Pagination direction: 'next' or 'prev'

include_total_count boolean default: False

Whether to include total count (expensive - avoid if possible)

sort_by string

Column name to sort by (e.g. 'created_at', 'amount', 'name'). When changing sort, reset cursor to None.

descending boolean default: True

Sort direction: true for descending (newest/largest first), false for ascending

Responses

200 Successful Response

Schema: RecurringTemplateListResponse

items array · RecurringTemplateResponse requiredRecurringTemplateResponse
27 fields
id string required
business_id string required
name string required
recurrence_type RecurrenceTypeEnum-Output requiredRecurrenceTypeEnum-Output
status RecurringStatusEnum requiredRecurringStatusEnum
frequency FrequencyEnum requiredFrequencyEnum
start_date string · date required
end_date string · date
next_occurrence string · date required
last_generated string · date-time
day_of_month integer
day_of_week integer
max_occurrences integer
occurrences_generated integer required
template_data object required
days_until_due integer required
auto_send boolean required
notes string
customer CustomerSummary
vendor VendorSummary
created_at string · date-time required
updated_at string · date-time required
amount_in_dollars number
frequency_display string required
days_until_next integer
is_due boolean required
should_generate boolean required
total_count integer
next_cursor string
prev_cursor string
has_next boolean
has_prev boolean

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

422 Validation Error

Schema: HTTPValidationError

detail array · ValidationError ValidationError
5 fields
loc array · string | integer required
msg string required
type string required
input object
ctx object