GET
Check accounting setup (client account)
Client space Accounting module For: Accountant · Permission: journal_entries.viewreports Conditions
  • The accounting module must be included in the plan of the organization.
  • From the client space the book is always the client account’s own book.
Part of Set up the books.

Authorizations

Authorization
string
header
required

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

Response

provisioned
boolean
required

true when the book can post: it has all journal types plus the carry-forward journal, every posting role expected for this type of book is mapped, and a fiscal year exists. Otherwise false.

missing_role_mappings
tuple
required

Posting roles expected for this type of book that have no account mapping. Each item has role (the posting role) and expected_code (the standard account code that role normally maps to, or null). Empty when nothing is missing.

non_postable_mappings
array
required

Mappings, among roles without a third-party type, whose account cannot receive entries, so posting for that role would be refused. Each item has role and account_code. Empty when none.

open_period_covers_today
boolean
required

true when an open fiscal period of the book contains today's date; false when no such period exists, so posting dated today would be refused.

current_fiscal_year
object | null
required

The fiscal year of the book whose start and end dates contain today (the latest start when several), or null when there is none.

currency
object
required

Comparison of the currency of the books with the currency configured for the owner of the book.

checked_at
string<date-time>
required

Date and time of the check (ISO 8601).