Versions Compared

Key

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


Name

Type

Description

id

String

The ID of the retrieved accounts receivable

typeString

The type of the retrieved accounts receivable which can be CUSTOMER or SYSTEM or ORGANISATIONAL

Tip

ORGANISATIONAL type is available from CRM.COM R15.0.0


number

String

The number of the retrieved accounts receivable

name

String

The name of the retrieved accounts receivable

descriptionStringThe description of the retrieved accounts receivable
notesStringThe notes of the retrieved accounts receivable

balance

Float

The aggregated amount of posted debits and credits allocated against the accounts receivable, as of a specific date. This information is calculated dynamically

Tip

From CRM.COM R10.0.0, balance is calculated as the accounts receivable's opening balance plus the aggregated amount of posted debits and credits allocated against the accounts receivable and which are not related to any accounting period.


opening_balanceFloat

The opening balance of the accounts receivable for the latest and still open Accounting Period. This information is calculated during the latest Accounting Period Closing process.

Tip

Available from CRM.COM R10.0.0


opening_balance_dateDate

The date on which the opening balance of the accounts receivable was last calculated by an Accounting Period Closing process.

Tip

Available from CRM.COM R10.0.0


outstanding_amount

Float

The total outstanding amount which is owned by the customer, as of a specific date, which is the aggregated amount of posted debits which are not paid and are past their due date. This information is calculated dynamically

credit_limit_statusStringDetermines if the outstanding amount of the specific accounts receivable has exceeded the allowed credit limit. The supported values are NOT_EXCEEDED or EXCEEDED
credit_limitNumberIs the maximum amount of credit that can be provided to the specific accounts receivable,or in other words the maximum balance that the accounts receivable can ever reach.
credit_periodNumber

Credit period is the length of time for which a customer is allowed to settle any given debit

Tip

Deprecated from CRM.COM R14.0.0


life_cycle_state

String

The life cycle state of the retrieved accounts receivable which can be ACTIVE, SUSPENDED or TERMINATED

primary_account

Boolean

Indicates if the accounts receivable is the primary accounts receivable for the specified customer or not

partner_accountBoolean

Indicates if the accounts receivable is owned by a partner group or a partner unit, i.e. is a partner account

Tip

Available from CRM.COM R14.2.0


parent_accountBoolean

Indicates if the accounts receivable is a parent account in a group accounts

Tip

Available from CRM.COM R14.2.0


is_tax_exemptBoolean

Indicates if the account owner is tax exempt or not

Tip

Available from CRM.COM R17.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

contact_information

Contact Information object

The contact information related with the specified accounts receivable

classification

Classification object

The classification of the retrieved accounts receivable

credit_rating

Credit Rating object

The credit rating of the retrieved accounts receivable

credit_periodCredit Period object

The credit period of the retrieved accounts receivable

Tip

Available from CRM.COM R14.0.0


billing_address

Address object

The billing address of the retrieved accounts receivable

currencyCurrency object

The accounts receivable's currency

Tip

Available from CRM.COM R10.0.0


parent_accountAccounts Receivable Object

The parent accounts receivable. Applicable only if the retrieved Accounts Receivable is a member in a group of accounts.

Tip

Available from CRM.COM R13.0.0


accounting_periodAccounting Period Object

The latest Accounting Period for which the accounts receivable's opening balance was calculated for.

Tip

Available from CRM.COM R10.0.0


owned_by_groupGroup Object

The group that is owning the accounts receivable

Tip

Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)


owned_by_business_unitBusiness Unit Object

The business unit that is owning the accounts receivable

Tip

Available from CRM.COM R18.0.0


privacy_levelPrivacy Level Object

The accounts receivable privacy level

Tip

Deprecated from CRM.COM R18.0.0


usage_allowance_limitsUsage Allowance Limits Object

The accounts receivable Usage Allowance Limits

Tip

Available from CRM.COM R13.0.0


Tip

Deprecated from CRM.COM R17.0.0


log_information

Log Information Object

The log information related to the retrieved accounts receivable

account_managerUsers Object

The account manager of the retrieved accounts receivable

Applicable only if the retrieved account is owned by a COMPANY

Tip

Available from CRM.COM R14.0.0


pricing_agreementPricing Agreement Object

The pricing agreement of the retrieved accounts receivable

Applicable only for an Accounts Receivable that is owned by a Company and a Price Plan and/or Usage Service Catalog was agreed as part of a special pricing agreement

Tip

Available from CRM.COM R14.0.0


Tip

From CRM.COM R15.0.0, pricing_agreement is available for all CUSTOMER and ORGANISATIONAL accounts, for both persons and companies


recurring_payments_preferencesRecurring Payments Preferences Object

The recurring payments preferences associated with the accounts receivable

Tip

Available from CRM.COM R14.0.0.


membership_informationAccount Membership Information Object

The accounts receivable membership information in terms of funding scope and the services funded by the parent account. Applicable only if the retrieved accounts receivable is a member account of a group.

Tip

Available from CRM.COM R13.1.0


rewardsRewards Object

The rewards information of the accounts receivable

Tip

Available from CRM.COM R17.0.0


presentment_preferences_set

Set of Accounts Receivable Presentment Preferences Objects           

The presentment preferences of the retrieved accounts receivable

payment_preferences_set

Set of Accounts Receivable Payment Preferences Objects      

The payment preferences of the retrieved accounts receivable

access_tokens_setSet of Access Token objects

The access tokens associated with the accounts receivable

Tip

Available from CRM.COM R8.0.0

Deprecated from CRM.COM R18.0.0


customer_identification_claim_setSet of Customer Identification Claim Objects

The customer identification claims associated with the accounts receivable

Tip

Available from CRM.COM R18.0.0


member_accountsSet of Accounts Receivable Objects

The member accounts of the retrieved accounts receivable. Applicable only if the retrieved account is a Parent Account.

Tip

Available from CRM.COM R13.0.0


usage_allowance_organisational_unitsSet of Usage Organisational Conditions Objects

The usage organisational conditions (communities, groups, units) that services can be used at

Tip

Available from CRM.COM R14.2.0

Deprecated from CRM.COM R17.0.0


Anchor
accounts_receivable referred objects
accounts_receivable referred objects
Referred Objects Response Data

...

Include Page
usage_organisational_condition
usage_organisational_condition

Include Page
customer_identification_medium_short
customer_identification_medium_short