Recurring Bills

Update RecurringBill record

Changed on

Update an existing RecurringBill record with the provided data. Validates all required fields and business rules.

Side effects

  • If a schedule date is already due, DualEntry can create records from this template in the same request.
put/public/v2/recurring/bills/{record_number}/

Request

  • Base URL: https://api.dualentry.com
  • URL: https://api.dualentry.com/public/v2/recurring/bills/{record_number}/
  • Auth: none declared

Path parameters

record_numberinteger required

The number attribute of the record.

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
codestring nullable
namestring required
memostring required
datestring date required
company_idinteger required
company_namestring required
company_currencystring required
status'active' | 'inactive' required
record_payloadunknown required
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

  • 7588ae19aaffRevision changes
    • breaking

      the request property / became not nullable

    • breaking

      the request property / became not nullable

    • breaking

      the request property / became required

    • breaking

      the request property / became required

  • 238fe9120a75Revision changes
    • info

      added the new optional request property ///

    • info

      added the new optional request property ///