Skip to main content
GET
List ledger entries

Authorizations

Authorization
string
header
required

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

Headers

Content-Type
string

Content-Type must be set to application/json

Path Parameters

businessId
string
required

The UUID of the business

Query Parameters

start_date
string<date-time>

Start date for entries (inclusive)

end_date
string<date-time>

End date for entries (exclusive)

reporting_basis
enum<string>
default:ACCRUAL

Reporting basis for the entries (ACCRUAL or CASH)

Available options:
ACCRUAL,
CASH
customer_id
string<uuid>

Filter entries by customer UUID

customer_external_id
string

Filter entries by customer external ID

vendor_id
string<uuid>

Filter entries by vendor UUID

vendor_external_id
string

Filter entries by vendor external ID

include_entries_before_activation
boolean
default:false

Include entries before business activation date

Response

List of ledger entries

id
string

Unique identifier of the ledger entry

business_id
string<uuid>
ledger_id
string
agent
enum<string>
Available options:
SMS,
API,
LAYER_AUTO,
LAYER_MANUAL
entry_type
enum<string>
Available options:
BANK,
MANUAL,
OPENING_BALANCE
date
string<date-time>
entry_at
string<date-time>
reversal_of_id
string | null
reversal_id
string | null
line_items
object[]
transaction
object
invoice
object
manual_entry
object
source
object