Skip to main content

InvoiceLineSchema

admin_feesnumber
annual_feenumber
annual_fee_on_invoiceboolean
annual_fee_service_item_idintegernullable
billsundefined[]
createdbynullable
createdby_idintegernullable
createddatedate-timenullable
divisional_billing_typenullable
employer_idintegerrequired
generate_bills_from_flat_rateboolean
If True, this billing line will generate bills from the flat rates on the vendor unit. If False, it will generate bills from the rate table. Defaults to False.
idinteger
include_account_namebooleannullable
include_active_membersboolean
include_grace_period_membersboolean
include_runout_membersboolean
include_term_runout_membersboolean
insured_employee_countnullable
insured_employee_count_idintegernullable
invoice_idintegerrequired
invoice_line_account_membersundefined[]
invoice_line_debit_cardsundefined[]
invoice_line_member_communicationsundefined[]
invoice_line_membersundefined[]
invoice_line_rate_table_rowsundefined[]
invoice_line_reimbursement_linesundefined[]
invoice_line_reimbursementsundefined[]
invoice_line_vendor_unit_detail_data_recordsundefined[]
invoice_line_vendor_unit_summary_data_recordsundefined[]
lookback_adjustmentsstringnullable

Possible values: <= 6 characters, [off, credit, debit, both, null]

member_communicationsundefined[]
modifiedbynullable
modifiedby_idintegernullable
modifieddatedate-timenullable
monthly_minimumnumber
monthly_minimum_on_invoiceboolean
monthly_minimum_service_item_idintegernullable
namestringrequired
note_idintegernullable
number_of_enrollmentsnumbernullable
payable_entitiesundefined[]
paymentnumbernullable
payment_service_itemnullable
payment_service_item_idintegernullable
per_unitnumber
per_unit_on_invoiceboolean
per_unit_service_item_idintegernullable
quantify_previous_billing_periodboolean
quantitynumbernullable
reimbursement_linesundefined[]
require_unit_for_monthly_minboolean
subscription_line_idintegerrequired
totalnumbernullable
unitstringnullable

Possible values: <= 40 characters, [total_members, total_members_with_a_policy_holder, total_members_with_a_debit_card, total_debit_cards, total_replaced_debit_cards, total_issued_debit_cards, total_reimbursement_checks, total_reimbursement_direct_deposits, total_reimbursement_contributions, total_reimbursement_debit_cards, total_reimbursements, total_member_communications, total_insured_employee_count, total_dollars_reimbursed, total_dollars_reimbursed_checks, total_dollars_reimbursed_direct_deposits, total_dollars_reimbursed_debit_cards, total_contribution_dollars, total_members_in_number_of_accounts, null]

vendor_unitnullable
vendor_unit_calculation_methodstringnullable

Possible values: <= 14 characters, [cumulative, all_time, billing_period, null]

vendor_unit_detail_data_recordsundefined[]
vendor_unit_idintegernullable
vendor_unit_summary_data_recordsundefined[]
vendor_unit_typestringnullable

Possible values: <= 7 characters, [units, dollars, null]

vendor_unit_use_import_dateboolean
zero_total_on_invoiceboolean
InvoiceLineSchema
{
"admin_fees": 0,
"annual_fee": 0,
"annual_fee_on_invoice": true,
"annual_fee_service_item_id": 0,
"bills": [
null
],
"createdby_id": 0,
"createddate": "2024-07-29T15:51:28.071Z",
"employer_id": 0,
"generate_bills_from_flat_rate": true,
"id": 0,
"include_account_name": true,
"include_active_members": true,
"include_grace_period_members": true,
"include_runout_members": true,
"include_term_runout_members": true,
"insured_employee_count_id": 0,
"invoice_id": 0,
"invoice_line_account_members": [
null
],
"invoice_line_debit_cards": [
null
],
"invoice_line_member_communications": [
null
],
"invoice_line_members": [
null
],
"invoice_line_rate_table_rows": [
null
],
"invoice_line_reimbursement_lines": [
null
],
"invoice_line_reimbursements": [
null
],
"invoice_line_vendor_unit_detail_data_records": [
null
],
"invoice_line_vendor_unit_summary_data_records": [
null
],
"member_communications": [
null
],
"modifiedby_id": 0,
"modifieddate": "2024-07-29T15:51:28.071Z",
"monthly_minimum": 0,
"monthly_minimum_on_invoice": true,
"monthly_minimum_service_item_id": 0,
"name": "string",
"note_id": 0,
"number_of_enrollments": 0,
"payable_entities": [
null
],
"payment": 0,
"payment_service_item_id": 0,
"per_unit": 0,
"per_unit_on_invoice": true,
"per_unit_service_item_id": 0,
"quantify_previous_billing_period": true,
"quantity": 0,
"reimbursement_lines": [
null
],
"require_unit_for_monthly_min": true,
"subscription_line_id": 0,
"total": 0,
"vendor_unit_detail_data_records": [
null
],
"vendor_unit_id": 0,
"vendor_unit_summary_data_records": [
null
],
"vendor_unit_use_import_date": true,
"zero_total_on_invoice": true
}