Versions Compared

Old Version 24

changes.mady.by.user Joseph Ioannou

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou

Saved on

Key

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


Expand
titleaccounts_receivable_parameter object data


Name

Type

Description

action

(mandatory)

String

Defines if a new or existing accounts receivable should be used. The supported values are the following:

NEW, EXISTING

accounts_receivable_identifier

(mandatory on conditions)

Accounts receivable identifier

An existing accounts receivable that should be used. This is applicable and mandatory if the action is set to EXISTING. The allowed accounts receivable identifier fields are the following:

Include Page
accounts_receivable_identifier
accounts_receivable_identifier

name

(mandatory on conditions)

String

The name of the accounts receivable. This is applicable and mandatory if the action is set to NEW

description

(optional)

StringThe description of the retrieved accounts receivable. This is applicable if the action is set to NEW

notes

(optional)

StringThe notes of the retrieved accounts receivable. This is applicable if the action is set to NEW

vat_number

(optional)

String

The VAT number of the retrieved accounts receivable. This is applicable if the action is set to NEW

credit_limit

(optional)

Number

Is 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. This is applicable if the action is set to NEW

Tip

Deprecated from CRM.COM R11.0.0


credit_period_operator 

(optional)

String

The credit period operator. The supported values are the following:

PLUS,MINUS

This is applicable if the action is set to NEW

credit_period

(optional)

NumberCredit period is the length of time for which a customer is allowed to settle any given debit. This is applicable if the action is set to NEW

classification_identifier

(mandatory on conditions)

Accounts receivable classification identifier

The accounts receivable classification identifier.  This is applicable and mandatory if the action is set to NEW. The allowed classification identifier fields are the following:

Include Page
accounts_receivable_classification_identifier
accounts_receivable_classification_identifier

This is applicable if the action is set to NEW

credit_rating_code

(mandatory on conditions)

String

The code of  the credit rating. This is applicable and mandatory if the action is set to NEW. The supported codes are the following:

AAA, AA, A, BAA, BA, B, CAA, CA, C

 This is applicable if the action is set to NEW

owned_by

_group

_group_identifier

(optional)

Group identifier

The group owning the accounts receivable. This is applicable if the action is set to NEW. The allowed group identifier fields are the following:

Include Page
group_identifier
group_identifier

Tip

Deprecated from CRM.COM R18.0.0


owned_by_business_unit_identifier

(optional)

Group
Business Unit identifier

The

group owning

business unit owning the accounts receivable. This is applicable if the action is set to NEW. The allowed

group

business unit identifier fields are the following:

Include Page

group

business_unit_identifier

group

business_unit_identifier

Tip

Available from CRM.COM R18.0.0


privacy_level_identifier

(optional)

Privacy level identifier

The privacy level of the accounts receivable. This is applicable if the action is set to NEW. The allowed privacy level identifier fields are the following:

Include Page
privacy_level_identifier
privacy_level_identifier
Tip

Deprecated from CRM.COM R18.0.0


currency_identifier

(optional)

Currency identifier
The identifier of the currency to be used. This is optional information but it is only applicable when creating a new accunts receivable. The allowed currency identifier fields are the following:

Include Page
currency_identifier
currency_identifier

Tip

Available from CRM.COM R10.0.0


account_manager

(optional)

User Identifier

The identifier of the user that should be set as the Account Manager. The allowed user identifier fields are the following

Include Page
user_identifier
user_identifier

Assigning an Account Manager is only applicable for Accounts Receivables that are owned by a COMPANY

Tip

Available from CRM.COM R14.0.0


udf_string_1 

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_2 

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_3 

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_4 

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_5

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_6 

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_7

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_string_8

(optional)

String

User Defined Field of type String. This is applicable if the action is set to NEW

udf_float_1

(optional)

Float

User Defined Field of type Float. This is applicable if the action is set to NEW

udf_float_2

(optional)

Float

User Defined Field of type Float. This is applicable if the action is set to NEW

udf_float_3

(optional)

Float

User Defined Field of type Float. This is applicable if the action is set to NEW

udf_float_4

(optional)

Float

User Defined Field of type Float. This is applicable if the action is set to NEW

udf_date_1 

(optional)

Date

User Defined Field of type Date. This is applicable if the action is set to NEW

udf_date_2 

(optional)

Date

User Defined Field of type Date. This is applicable if the action is set to NEW

udf_date_3

(optional)

Date

User Defined Field of type Date. This is applicable if the action is set to NEW

udf_date_4

(optional)

Date

User Defined Field of type Date. This is applicable if the action is set to NEW

custom_field_set

(optional)

Set of Custom Fields

The custom fields that are associated with the accounts receivable

If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value

Code Block
languagejavascript
themeConfluence
linenumberstrue
"custom_field_set": [
	{"field_name
_1
" : "value
_1
"},
	{"field_name
_2
" : "value
_2
"}
]


Tip

Available from CRM.COM R16.2.0


contact_information

(mandatory on conditions)

Contact information objectThe contact information of the accounts receivable owner. This is applicable and mandatory if the action is set to NEW

billing_address

(mandatory on conditions)

Billing address object

The accounts receivable billing address. This is applicable and mandatory if the action is set to NEW

Tip

From CRM.COM R14.3.0, billing_address is mandatory based on the accounts receivable definitions' billing address rules


wallet_top_up_rules

(optional)

Wallet Top Up Rules Object

The accounts receivable wallet top up rules. Applicable only if the account owner owns a wallet and has opt in to recurring payments through payment preferences

Tip

Available from CRM.COM R14.2.0


presentment_preferences_set 

(optional)

Set of Presentment Preferences Object            

The presentment preferences of the retrieved accounts receivable. This is applicable if the action is set to NEW

payment_preferences_set

(optional)

Set of Payment Preferences Object      

The payment preferences of the retrieved accounts receivable. This is applicable if the action is set to NEW

access_tokens_set

(mandatory on conditions)

Set of Access Token Objects

The access tokens that will be associated with the accounts receivable. This information is mandatory if the active access token definition is set up to require at least one access token for each accounts receivable

Tip

Available from CRM.COM R8.0.0


Anchor
accounts_receivable_create referred objects parameters
accounts_receivable_create referred objects parameters
Referred Parameter Objects Data

Include Page
contact_information_parameters
contact_information_parameters

Include Page
billing_address_parameter
billing_address_parameter

Include Page
wallet_top_up_rules_parameter
wallet_top_up_rules_parameter

Include Page
accounts_receivable_presentment_preference_parameter
accounts_receivable_presentment_preference_parameter

Include Page
accounts_receivable_payment_preference_parameter
accounts_receivable_payment_preference_parameter

Include Page
access_token_parameters
access_token_parameters

...