v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
Bills

View bill

Find a single bill by ID.

get/v1/Bills/{id}

Path parameters

idinteger required

Format - int32. ID of the bill to view.

Response

OK

okboolean
bill_idinteger

Primary identifier for this bill.

parent_bill_idinteger

Parent id for this child account's bill.

bill_type'NORMAL' | 'CHILD' | 'PARENT'

Bill type (i.e. NORMAL, CHILD, PARENT).

print_batch_idinteger

ID print batch the bill was created in.

customer_idinteger

ID of customer account on bill.

due_datestring date-time

Due date of the bill.

created_datestring date-time

Date the bill was created.

amount_duenumber double

Total amount due at the time of bill creation.

invoice_amountnumber double

Total amount of charges on the bill.

credit_memo_amountnumber double

Total amount of credits on the bill.

print_queue_flagboolean

Indicates if bill is ready to be added to the print queue.

printed_datestring date-time

Date the bill was printed.

generate_downloadsboolean

Indicates bill generates associated CDR downloads.

late_fee_applied_flagboolean
first_month_flagboolean
ebpp_queue_flagboolean

Indicates if bill needs to be added to email queue.

ebpp_sent_datestring date-time

Date the bill was sent to customer.

itemize_localboolean

Indicates if bill should include local calls.

is_final_billboolean

Indicates if this bill is final.

notestring

Remarks or comments associated with bill.

bill_print_type_idinteger
isLiveboolean

Indicates if bill is ready to be shown on BillCenter.

cycle_datestring date-time

Cycle date the bill was created for.

pdf_only_flagboolean

Indicates that the bill should create a PDF but not be printed.

print_profile_idinteger

ID of print profile used on bill.

ready_for_pdf_flagboolean

Indicates if bill is ready for PDF generation.

bill_create_batch_idinteger

ID of bill creation batch.

pdf_file_idinteger

Foreign key indicating the PDF file representing this bill.