Versions Compared

Key

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


...

owning the subscription

Name

Type

Description

id

String

The ID of the retrieved subscriptioninvoice

number

String

The number of the retrieved subscriptioninvoice

notesreference_numberStringNotes for The reference number of the retrieved subscriptioninvoice
life_cycle_stateString

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

DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTEDREJECTED, 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
subscriptionmember_typeaccountSubscription type Accounts receivable object

The

subscription type of the retrieved subscription
billing_termsBilling terms objectThe billing terms of the retrieved subscription
subscription_addressAddress objectThe address denoting the location of the retrieved subscription
owned_by_groupGroup objectThe group that is owning the subscription
privacy_levelPrivacy level objectThe subscription's privacy level

log_information

Log Information Object

The log information related with the retrieved subscription

termed_services_setSet of termed subscription service objectsThe termed subscription services of the retrieved subscription
one_time_services_setSet of one time subscription service objectsThe one time subscription services of the retrieved subscription

usage_services_set

Set of usage subscription service objectsThe usage subscription services of the retrieved subscription
installed_items_setSet of subscription installed item objectsThe subscription installed items of the retrieved subscription
termed_services_distribution_setSet of termed service distribution objectsThe distribution of termed subscription services
one_time_services_distribution_setSet of one time service distribution objectsThe distribution of one time subscription services
usage_services_distribution_setSet of usage service distribution objectsThe distribution of usage subscription services
installed_items_distribution_setSet of installed item distribution objectsThe distribution of  subscription installed items

...

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 relatedwiththe retrieved invoice

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

Anchor
invoice referred objects
invoice referred objects
Referred Objects Response Data

Include Page
accounts_receivable_short
accounts_receivable_short

Include Page
subscriptionfinancial_typetransaction_shortsubscription_type_short
Include Page
billingfinancial_termstransaction_shortbillingtype_terms_short

Include Page
addressfinancial_shortaddress_short
Include Page
grouptransaction_category_shortgroup_short
Include Page
privacy_level_shortprivacy_levelfinancial_transaction_category_short

Include Page
logfinancial_informationtransaction_shortlogrejection_informationreason_short
Include Page
termedfinancial_subscriptiontransaction_servicerejection_shorttermed_subscription_service_reason_short

Include Page
oneaccounting_timeperiod_subscription_serviceinformation_shortone
accounting_timeperiod_subscription_serviceinformation_short

Include Page
usagecurrency_subscriptionrate_serviceperiod_shortusage
currency_subscriptionrate_serviceperiod_short

Include Page
subscriptionlog_installed_iteminformation_shortsubscription
log_installed_iteminformation_short

Include Page
termed_subscription_service_distribution_shorttermed_subscription_service_distribution_short
Include Page
one_time_subscription_service_distribution_short
one_time_subscription_service_distribution_short
Include Page
usage_subscription_service_distribution_shortusage_subscription_service_distribution_short
Include Page
subscription_installed_item_distribution_shortsubscription_installed_item_distributioninvoice_item_short
invoice_item_short