GET
List entry imports (organization)
Organization space Accounting module For: Accountant · Permission: entry_imports.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).
  • status, when sent, must be one of staged, validated, rejected, posted.
  • sort_by is created_at or status; per_page is an integer from 1 to 100.
Part of Import entries from a file.

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 (the organization's own or a client account's) the request works on; 27-character KSUID.

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:
created_at,
status
sort_order
enum<string> | null

asc for ascending order, desc for descending order.

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

Optional filter on the import status: staged, validated, rejected or posted.

Available options:
staged,
validated,
rejected,
posted
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, original_name, row_count, status, error_count, posted_journal_entry_ids, 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: .

Response

Resource.

data
EntryImportListResource · object[]
required

Items of this page.

meta
object
required

Pagination details.