GET
List letterings (client account)
Client space Accounting module For: Accountant · Permission: letterings.list Conditions
  • The book is the one selected for the request: the {book} segment in the organization space, or the client account’s own books in the client space.
  • The accounting module must be included in the plan of the organization.
  • The book must be set up for accounting (it must have at least one journal).
  • accounting_account_id is required and must be an account of this book.
  • code, when sent, is a string of at most 8 characters; only matches with exactly that code are returned.
  • per_page is an integer from 1 to 100; sort_by is created_at or code; sort_order is asc or desc.
Part of Match open items.

Authorizations

Authorization
string
header
required

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

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, accounting_account_id, code, lettered_at, created_by, created_by_type, lines_count, total_debit, total_credit, created_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: .

Response

Resource.

data
LetteringResource · object[]
required

Items of this page.

meta
object
required

Pagination details.