Skip to main content
GET
The charge ledger, with the payer dimensions carried down from the booking so a recharge

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
booking_id
string
booking_number
string
booking_title
string
line_type
string
line_id
string
charge_category
string
description
string
pricing_state
string
booking_rate_id
string
rate_basis
string
rate_type
string
unit_rate
string
quantity
string
unit_of_measure_id
string
unit_of_measure
string
amount
string
amount_currency_id
string
currency
string
accrual_period_start
string
accrual_period_end
string
is_chargeable
string
reverses_charge_id
string
is_correction
string
is_reversed
string
incurred_at
string
charge_to
string
cost_center_id
string
department_id
string
business_unit_id
string
project_id
string
customer_id
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

accrual_period_end
string<timestamp with time zone>
accrual_period_start
string<timestamp with time zone>
amount
number<numeric>
amount_currency_id
string<uuid>
booking_id
string<uuid>

Note: This is a Foreign Key to bookings.id.

booking_number
string<character varying>
Maximum string length: 60
booking_rate_id
string<uuid>

Note: This is a Foreign Key to booking_rates.id.

booking_title
string<character varying>
Maximum string length: 250
business_unit_id
string<uuid>

Note: This is a Foreign Key to business_units.id.

charge_category
string<character varying>
Maximum string length: 30
charge_to
string<character varying>
Maximum string length: 30
cost_center_id
string<uuid>

Note: This is a Foreign Key to cost_centre_settings.id.

currency
string<character varying>
customer_id
string<uuid>
department_id
string<uuid>

Note: This is a Foreign Key to department_settings.id.

description
string<character varying>
Maximum string length: 250
id
string<uuid>

Note: This is a Primary Key.

incurred_at
string<timestamp with time zone>
is_chargeable
boolean<boolean>
is_correction
boolean<boolean>
is_reversed
boolean<boolean>
line_id
string<uuid>
line_type
string<character varying>
Maximum string length: 20
pricing_state
string<character varying>
Maximum string length: 20
project_id
string<uuid>

Note: This is a Foreign Key to project_settings.id.

quantity
number<numeric>
rate_basis
string<character varying>
rate_type
string<character varying>
reverses_charge_id
string<uuid>

Note: This is a Foreign Key to booking_charges.id.

unit_of_measure
string<character varying>
Maximum string length: 30
unit_of_measure_id
string<uuid>

Note: This is a Foreign Key to units_of_measure.id.

unit_rate
number<numeric>