Versions Compared

Old Version 17

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou (Unlicensed)

Saved on

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

titleaccounts_receivable_parameter object data

...

Name

...

Type

...

Description

...

(mandatory)

...

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

NEW, EXISTING

...


The name of the accounts receivable.
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
An existing

The accounts receivable

that should be used.

classification identifier.  This is applicable and mandatory if the action is set to

EXISTING

NEW. The allowed

accounts receivable

classification identifier fields are the following:

Include Page
accounts_receivable_classification_identifier
accounts_receivable_

identifier

name

(mandatory on conditions)

String

classification_identifier

This is applicable

and mandatory

if the action is set to NEW

description

credit_rating_code

(

optional

mandatory on conditions)

String

The

description of the retrieved accounts receivable

code of  the credit rating. This is applicable and mandatory if the action is set to NEW

notes

(optional)

StringThe notes of the retrieved accounts receivable. This

. 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

vat_number

owned_by_group_identifier

(optional)

String
Group identifier

The

VAT number of

group owning the

retrieved

accounts receivable. This is applicable if the action is set to NEW

credit_limit

(optional)

NumberIs 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

. 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)

Business Unit identifier

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

Include Page
business_unit_identifier
business_unit_identifier

Tip
Deprecated

Available from CRM.COM

R11

R18.0.0

credit


privacy_

period

level_

operator 

identifier

(optional)

StringThe credit period operator. The supported values
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:

PLUS,MINUS

This is applicable if the action is set to NEW

credit_period

Include Page
privacy_level_identifier
privacy_level_identifier
Tip

Deprecated from CRM.COM R18.0.0


currency_identifier

(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 identifierThe accounts receivable classification identifier.  This is applicable and mandatory if the action is set to NEW. The allowed classification
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

accounts_receivable_classification

user_identifier

accounts_receivable

user_

classification_

identifier

This

Assigning an Account Manager 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

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

owned

udf_

by_group_identifier

string_2 

(optional)

Group identifierThe group owning the accounts receivable
String

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

. The allowed group identifier fields are the following: Include Pagegroup_identifiergroup_identifierprivacy_level_identifier

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)

Privacy level identifierThe privacy level of the accounts receivable
String

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

. The allowed privacy level identifier fields are the following: Include Pageprivacy_level_identifierprivacy_level_identifiercurrency_identifier

udf_string_5

(optional)

Currency identifierThe identifier of the currency to be used
String

User Defined Field of type String. This is

optional information but it is only applicable when creating a new accunts receivable. The allowed currency identifier fields are the following: Include Pagecurrency_identifiercurrency_identifier
Tip

Available from CRM.COM R10.0.0

account_manager

applicable if the action is set to NEW

udf_string_6 

(optional)

String

User

Identifier

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

Include Pageuser_identifieruser_identifier

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

TipAvailable from CRM.COM R14.0.0

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_

1 

8

(optional)

String

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

udf_

string

float_

2 

1

(optional)

String

Float

User Defined Field of type

String

Float. This is applicable if the action is set to NEW

udf_

string

float_

3 

2

(optional)

String

Float

User Defined Field of type

String

Float. This is applicable if the action is set to NEW

udf_

string

float_

4 

3

(optional)

String

Float

User Defined Field of type

String

Float. This is applicable if the action is set to NEW

udf_

string

float_

5

4

(optional)

String

Float

User Defined Field of type

String

Float. This is applicable if the action is set to NEW

udf_

string

date_

6

1 

(optional)

String

Date

User Defined Field of type

String

Date. This is applicable if the action is set to NEW

udf_

string

date_

7

2 

(optional)

String

Date

User Defined Field of type

String

Date. This is applicable if the action is set to NEW

udf_

string

date_

8

3

(optional)

String

Date

User Defined Field of type

String

Date. This is applicable if the action is set to NEW

udf_

float

date_

1

4

(optional)

Float

Date

User Defined Field of type

Float

Date. This is applicable if the action is set to NEW

udf

custom_

float

field_

2

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

set

(optional)

Float

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

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" : "value"},
	{"field_name" : "value"}
]


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
udf

billing_

date_4

address

(

optionalUser Defined Field of type Date

mandatory on conditions)

Date

Billing address object

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

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 objectThe 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

automatic_recurring_payments_preferences

(optional)

Automatic Recurring Payments Preferences Object

The automatic recurring payments

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

Applicable only if the configuration allows customers to opt in automatic recurring payments

tip

Available from CRM.COM R14.0.0

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
accountswallet_receivabletop_presentmentup_preferencerules_parameteraccounts
wallet_receivabletop_presentmentup_preferencerules_parameter

Include Page
accounts_receivable_paymentpresentment_preference_parameter
accounts_receivable_paymentpresentment_preference_parameter

Include Page
automaticaccounts_recurringreceivable_paymentspayment_preference_parameterautomatic
accounts_recurringreceivable_paymentspayment_preference_parameter

Include Page
access_token_parameters
access_token_parameters

...