Update recurring template

PUT /api/v1/recurring/{template_id}

Update an existing recurring template.

Operation ID: update_recurring_template_api_v1_recurring__template_id__put · 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

Path

template_id string required

Request body

Schema: RecurringTemplateUpdate

name string

Updated name

currency string

Updated currency (USD, CAD, AUD, EUR, or GBP)

frequency FrequencyEnum

Updated frequency

days_until_due integer

Updated days until due

day_of_month integer

Updated day of month (1-31). Only applies to monthly/quarterly/annually frequencies. If the day doesn't exist in a month, generates on the last day instead.

day_of_week integer

Updated day of week (0=Monday, 6=Sunday). Only applies to weekly/biweekly frequencies.

end_date string · date

Updated end date. Whichever of end_date or max_occurrences is reached first stops generation.

max_occurrences integer

Updated max occurrences. Whichever of end_date or max_occurrences is reached first stops generation.

notes string

Updated notes

template_data object

Updated template data

auto_send boolean

Updated auto-send setting

customer_id string

Updated customer ID (only for invoice templates)

vendor_id string

Updated vendor ID (only for bill templates)

Responses

200 Successful Response

Schema: RecurringTemplateResponse

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

400 Bad Request - Invalid input

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

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