USusesecuro
invoices

Make Recurring

Changed on

Turn this invoice into period one of a new agreement that repeats it.

post/api/invoices/{invoice_id}/make-recurring

Request

Path parameters

invoice_idstring uuid required

Headers

X-Workspace-Idstring nullable

Request body

frequency'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'semiannual' | 'yearly' required
start_datestring date nullable
namestring nullable
end_type'never' | 'on_date' | 'after_count'
end_datestring date nullable
end_countinteger nullable
payment_terms_daysinteger nullable

Response

Successful Response

idstring uuid required
namestring required
payee_idstring uuid nullable required
originstring required
external_sourcestring nullable
external_idstring nullable
status'active' | 'paused' | 'ended' required
pause_reason'manual' | 'failures' nullable
ended_atstring date nullable
end_reason'canceled_by_client' | 'canceled_by_us' | 'completed' | 'unpaid' | 'other' nullable
frequency'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'semiannual' | 'yearly' required
start_datestring date required
end_type'never' | 'on_date' | 'after_count' required
end_datestring date nullable
end_countinteger nullable
payment_terms_daysinteger nullable
currencystring required
notesstring nullable
custom_fieldsobject nullable
next_sequenceinteger required
last_generated_atstring date-time nullable
consecutive_failuresinteger required
created_atstring date-time required
monthly_amountstring
next_period_startstring date nullable
invoice_countinteger
amount_invoicedstring
amount_paidstring
past_due_countinteger

Changes