Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Name

Type

Description

id

String

The ID of the retrieved bill

number

String

The number of the retrieved bill

life_cycle_state

String

The life cycle state of the bill. One of the following values is returned:

POSTED, PRESENTED, PRESENTED_CONFIRMED, PRESENTED_REJECTED

from_dateDateThe date from which the accounts receivable is billed for
to_dateDateThe date until which the accounts receivable is billed for
previous_bill_total_due_amountNumberThe total due amount from previous bills
balance_brought_forwardNumber 

The account outstanding amount as of date that the bill is created. This amount excludes the bill amount. This information should replace the Previous Bill Unpaid Amount

Tip

Available from CRM.COM R9.0.0


total_credit_amount_posted_between_billsNumber The total credit amount posted between bills
total_debit_amount_posted_between_billsNumber

The total debit amount posted between bills

Tip

Available from CRM.COM R14.0.0


total_billed_amountNumberThe total billed amount
total_amount_to_be_paidNumberThe total amount to be paid
statusString

The status of the bill in terms of it is settled or not.The supported values are the following:

SETTLED, UNSETTLED, PARTIALLY_SETTLED

classificationString 

Set based the exceptional bills thresholds, defined in normal billing run definitions, having the following predefined options:

NORMAL, MAX_CREDIT_AMOUNT_REACHED, MAX_CREDIT_LIMIT_AMOUNT_REACHED

typeString

The type of  billing run that generated the bill.The supported values are the following:

NORMAL

Tip

Deprecated from CRM.COM R18.0.0


outstanding_amountNumberThe total outstanding amount of bill, as of a specific date, which is the aggregated amount of posted debits which are not paid and are past their due date.
unsettled_amountNumberThe total unsettled amount of bill, which is the aggregated amount of posted debits which are not paid.
due_dateDateThe due date of bill. The field is calculated dynamically. The maximum due date of related invoices.
number_of_credit_notesNumberThe number of credit notes related with bill.
number_of_invoicesNumberThe number of invoices related with bill.
total_credit_amountNumberThe sum of credit note amount related with bill.
total_debit_amountNumberThe sum of invoice amount related with bill.
bill_number_check_digitNumber

The check digit generated based on the bill's number

Tip

Available from CRM.COM R14.0.0


accounts_receivable_check_digitNumber

The check digit generated based on the bill's accounts receivable number

Tip

Available from CRM.COM R14.0.0


bill_amount_check_digitNumber

The check digit generated based on the bill's amount

Tip

Available from CRM.COM R14.0.0


udf_string_1

String

User Defined Field of type String

udf_string_2

String

User Defined Field of type String

udf_string_3

String

User Defined Field of type String

udf_string_4

String

User Defined Field of type String

udf_string_5

String

User Defined Field of type String

udf_string_6

String

User Defined Field of type String

udf_string_7

String

User Defined Field of type String

udf_string_8

String

User Defined Field of type String

udf_float_1

Float

User Defined Field of type Float

udf_float_2

Float

User Defined Field of type Float

udf_float_3

Float

User Defined Field of type Float

udf_float_4

Float

User Defined Field of type Float

udf_date_1

Date

User Defined Field of type Date

udf_date_2

Date

User Defined Field of type Date

udf_date_3

Date

User Defined Field of type Date

udf_date_4

Date

User Defined Field of type Date`

accounts_receivableAccounts receivable objectThe accounts receivable into which the retrieved bill is allocated
currencyCurrency object

The bill's currency

Tip

Available from CRM.COM R10.0.0


normal_billing_runNormal billing Billing run object

The normal billing run that generated the retrieved bill

Tip

Deprecated from CRM.COM R18.0.0


log_informationLog information objectThe log information for the retrieved bill
bill_items_setSet of bill itemsThe items of the retrieved bill

...

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
currency_short
currency_short

Include Page
normal_billing_run_short
normal_billing_run_short

...