GET
List recurring entries (organization)
Organization space Accounting module For: Accountant · Permission: recurring_entries.list 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 book must be set up for accounting (it must have at least one journal).
  • Only templates of the selected book are listed.
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

book
string
required

Identifier of the accounting book (a 27-character KSUID): the organization itself or one of its companies. The caller must hold an accounting access grant on it.

Query Parameters

per_page
integer | null

Number of items per page.

Required range: 1 <= x <= 100
cursor
string | null

Position in the list. Pass the meta.next_cursor or meta.prev_cursor value of the previous page; leave it out to get the first page.

sort_by
enum<string> | null

Field the list is sorted by.

Available options:
label,
next_run_on,
start_date,
created_at
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

Available options:
asc,
desc
status
enum<string> | null

Only templates with this status: active (posting on schedule), paused (temporarily not posting) or finished (end date passed).

Available options:
active,
paused,
finished
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.

data
RecurringEntryResource · object[]
required

Items of this page.

meta
object
required

Pagination details.