Rippling: Retrieve a specific bill payment — response body — line items item

API reference · Contract 2026-10-28

SDK schema: Retrieve a specific bill payment — response body — line items item

Field	Type	Presence	Description and constraints
$	object	Root
amortization_status	string	Optional	Amortization state. Null when not set. Known values: NOT_STARTED, IN_PROGRESS, COMPLETED, ERROR
amortized	boolean	Optional	Whether this line is amortized.
amount	object	Optional	Amount of this split, in the merchant currency. The `value` is a decimal string.
amount.currency_type	string	Optional	The currency type, ex: USD, EUR, etc.
amount.value	JSON	Optional
amount.value (anyOf 1)	number	Alternative	The decimal amount for the currency.
amount.value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
category_id	string	Optional	ID of the Spend category assigned to this split. No public API is currently available to retrieve this category; its name is in `category_name`.
category_name	string	Optional	Name of the spend category.
dimension_choices	object	Optional	Selected dimension values, keyed by dimension ID. Includes department and work location. Additional keys: see wildcard field
dimension_choices.*	Model	Additional keys	Expand Retrieve a specific bill payment — response body — line items item dimension choices value
discount	string	Optional	Discount on the item as a percentage (`10.00` means 10%), as a decimal string. Null when not set.
end_date	string	Optional	Amortization end date. Null when not set.
gl_amortization_schedule	string	Optional	ID of the amortization schedule in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
gl_amortization_template	string	Optional	ID of the amortization template in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
gl_billable	string	Optional	Whether this split is billed to `gl_customer` in the accounting system. `BILLABLE` means it is billed, `NOT_BILLABLE` means it is not. Null when not set. Known values: BILLABLE, NOT_BILLABLE
gl_customer	string	Optional	ID of the customer record in the connected accounting integration. No public Rippling API is currently available to retrieve this accounting customer.
gl_tax_code	string	Optional	Rippling ID of the tax code synced from the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
memo	string	Optional	Memo entered on this split.
prepaid_account	string	Optional	ID of the prepaid account in the connected accounting integration. No public API is currently available to retrieve it. Null when not set.
price	object	Optional	Unit price, in the merchant currency. The `value` is a decimal string. Null when not set.
price.currency_type	string	Optional	The currency type, ex: USD, EUR, etc.
price.value	JSON	Optional
price.value (anyOf 1)	number	Alternative	The decimal amount for the currency.
price.value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
quantity	string	Optional	Item quantity, as a decimal string. Null when not set.
quantity_unit_of_measure	string	Optional	Unit for quantity, such as tons or seats. Null when quantity is not set.
start_date	string	Optional	Amortization start date. Null when not set.
tax_amount	object	Optional	Tax amount entered on the line, in the merchant currency. The `value` is a decimal string. Null when not set.
tax_amount.currency_type	string	Optional	The currency type, ex: USD, EUR, etc.
tax_amount.value	JSON	Optional
tax_amount.value (anyOf 1)	number	Alternative	The decimal amount for the currency.
tax_amount.value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
tax_code_display_alias	string	Optional	Display name of the tax code. Null when not set.
term	string	Optional	Term length, as a decimal string. Null when not set.
term_unit_of_measure	string	Optional	Unit for term: YEARS, QUARTERS, MONTHS, WEEKS, or DAYS. Null when term is not set. Known values: YEARS, QUARTERS, MONTHS, WEEKS, DAYS
total_amortized_amount	object	Optional	Amount amortized so far, in the company’s headquarters currency. The `value` is a decimal string. Null when not set.
total_amortized_amount.currency_type	string	Optional	The currency type, ex: USD, EUR, etc.
total_amortized_amount.value	JSON	Optional
total_amortized_amount.value (anyOf 1)	number	Alternative	The decimal amount for the currency.
total_amortized_amount.value (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Retrieve a specific bill payment — response body — line items item dimension choices value