GET
View a recurring entry (organization)
Organization space Accounting module For: Accountant · Permission: recurring_entries.retrieve Conditions
  • The accounting module must be included in the plan of the organization.
  • In the organization space the caller needs an accounting access grant on the book named in the URL.
  • The template must belong to the selected book.
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 accounting book (the first path segment; the generated name is misleading). The template is the second parameter, recurring_entry.

recurring_entry
string
required

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

Query Parameters

response
enum<string>
default:resource

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

Available options:
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.

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).