Versions Compared

Key

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

...

...

...

...


Name

Type

Description

id

String

The ID of the retrieved invoice

number

String

The number of the retrieved invoice

reference_numberStringThe reference number of the retrieved invoice
life_cycle_stateString

The state of the retrieved invoice which can be one of the following:

DRAFT, REJECTED, POSTED, CANCELLED

discount_amountNumberThe total discount amount provided by the invoice
vat_amountNumber

The total VAT amount applied on the invoice

Tip

Deprecated from CRM.COM R17.0.0


tax_amountNumber

The Total Tax amount applied on the invoice

Tip

Available from CRM.COM R12.0.0


net_amountNumberThe total net amount of the invoice
total_amountNumberThe total amount which is invoiced
outstanding_amountNumberThe outstanding amount of this invoice
unsettled_amountNumberThe unsettled amount of this invoice
issued_onDateThe date that the invoice was issued
posted_onDateThe date that the invoice was posted
due_onDateThe date that the invoice was received
notesStringShared notes for the invoice
back_office_codeString

The back office code of the retrieved invoice

Tip

Available from CRM.COM R9.1.0


udf_string_1

String

User Defined Field DefinedField of type String

udf_string_2

String

User Defined Field DefinedField of type String

udf_string_3

String

User Defined Field DefinedField of type String

udf_string_4

String

User Defined Field DefinedField of type String

udf_string_5

String

User Defined Field DefinedField of type String

udf_string_6

String

User Defined Field DefinedField of type String

udf_string_7

String

User Defined Field DefinedField of type String

udf_string_8

String

User Defined Field DefinedField 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 related accounts receivable
member_accountAccounts receivable object

The member accounts receivable. Applicable only if the retrieved Invoice was issued because the member account is funded by a parent account.

Tip

Available from CRM.COM R13.0.0


typeFinancial transaction type objectThe financial transaction type of this invoice
categoryFinancial transaction category objectThe category of the invoice
rejection_reasonFinancial transaction rejection reason objectThe reason that the invoice was rejected
accounting_period_informationAccounting Period Information object

The accounting period information of the retrieved invoice. This is applicable only if the invoice was processed during an Accounting Period Closing process run

Tip

Available from CRM.COM R10.0.0


currency_rate_periodCurrency Rate Period object

The currency rate period based on which the invoice's amounts were calculated

Tip

Available from CRM.COM R10.0.0


log_information

Log Information Object

The log information related with the relatedwiththe retrieved invoice

invoice_item_setSet of invoice item objectsA list of items which are invoiced by this invoice

...

Include Page
financial_transaction_rejection_reason_short
financial_transaction_rejection_reason_short

invoice_item_short
Include Page
invoice_item_short
Include Page
accounting_period_information_short
accounting_period_information_short

...

Include Page
log_information_short
log_information_short

Include Page
invoice_item_short
invoice_item_short