PUT
Edit a recurring entry (client account)
Client space Accounting module For: Accountant · Permission: recurring_entries.update, journal_entries.create (only when changing what it posts or reactivating) Conditions
  • The accounting module must be included in the plan of the organization.
  • In the client space the book is always the client account’s own book.
  • Changing what the template posts or when (lines, journal, start or end date, frequency, day of month) or reactivating it also needs the journal_entries.create permission.
  • The book must be set up for accounting (it must have at least one journal).
  • The template must belong to the selected book.
  • status can only be set to active or paused; finished is set by the schedule.
  • A finished template can be restarted only by sending end_date in the same call (a later date, or null to remove the end); sending status alone is refused.
  • Changing the start date is refused when the new date is before the start of the earliest open fiscal year of the book.
  • When lines are sent they must meet the same rules as at creation: at least two lines, distinct postable accounts of the book, positive whole amounts, balanced.
  • A journal that is changed must belong to the selected book.
  • The resulting end date must not be before the start date.
  • A field sent as null keeps its stored value, except end_date, where null removes the end of the schedule.
What else happens
  • Saves the changed template and recomputes the next occurrence when the schedule, the start date, the end date or the status (reactivation) changes.
  • Pausing records the pause date: occurrences that fall due while paused are dropped, not posted, once the template is reactivated; occurrences due before the pause are still posted.
  • When the next occurrence ends up past the end date the status becomes finished; moving the end date past it makes a finished template active again.
  • Journal entries already posted are not changed.
Part of Record and correct entries.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

recurringEntry
string
required

Identifier of the recurring entry template (27-character KSUID).

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, label, journal_id, frequency, day_of_month, start_date, end_date, next_run_on, last_run_on, lines, status, created_by, created_by_type, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: journal.

Response

Resource (only with response=resource).

id

Identifier of the recurring entry template (27-character KSUID).

owner_type

Kind of book the template belongs to: organization, company or client.

label

Name of the template; it becomes the description of each entry it posts.

journal_id

Identifier of the journal the entries are posted in (27-character KSUID).

journal
object

The journal. Present only when requested with include=journal and the caller holds the journals.retrieve permission.

frequency

How often the entry is posted: monthly, quarterly (every 3 months) or yearly (every 12 months).

day_of_month
integer

Day of the month of each occurrence, from 1 to 31; in shorter months the last day of the month is used.

start_date

Date from which occurrences are due (YYYY-MM-DD).

end_date

Date after which no occurrence is posted (YYYY-MM-DD); null when the schedule has no end.

next_run_on

Date of the next occurrence to post (YYYY-MM-DD).

last_run_on

Date of the latest occurrence posted (YYYY-MM-DD); null when none has been posted yet.

lines
any[]

Lines posted at each occurrence, as entered: objects with accounting_account_id, direction (debit or credit), amount (whole number in minor units) and label.

status

State of the template: active (posts on schedule), paused (temporarily not posting) or finished (the next occurrence is past the end date).

created_by

Identifier of the member or agent account that created the template; null when unknown.

created_by_type

Kind of the creator; null when unknown.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).