Sign in
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/

Headers

Idempotency-Keystring

Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.

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

Changes

Changed in 2 of the 14 revisions of this API.2

  • 34b7cf5b4b6c1See the full diff
    • ○

      added the new optional header request parameter Idempotency-Key

      new-optional-request-parameter

  • 525a590a98f81See the full diff
    • ○

      added the new optional request property record_payload/items/items/tax/anyOf[subschema #1: ItemTaxData]/tax_metadata

      new-optional-request-property

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog