rate_calculation_accounts_receivable_parameters

 accounts_receivable_parameter object data

Name

Type

Description

classification_identifier

(mandatory)

Accounts receivable classification identifier

 The accounts receivable classification identifier.  The allowed classification identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the classification

name

(semi-optional)

String

The name of the classification

alternative_code

(semi-optional)

String

The alternative code of  the classification

billing_address

(optional)

Billing address ObjectThe accounts receivable billing address

presentment_preferences_set 

(optional)

Set of Presentment Preferences Object            

The presentment preferences of the accounts receivable.

payment_preferences_set

(optional)

Set of Payment Preferences Object      

The payment preferences of the retrieved accounts receivable.

Referred Parameter Objects Data

 billing_address object parameter data
Name
Type
Description
action

(mandatory)

String

Defines if a new or existing address will be used. In the case of an existing address then it also defines if the existing address should be updated or not. The supported values are the following:

NEW, EXISTING, EXISTINGUPDATED

type

(mandatory on conditions)

String

The contact information address that should be set as the billing address address. This is applicable and mandatory only if the action is set to EXISTING or EXISTINGUPDATED. The supported options are the following:

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

address

(mandatory on conditions)

Address objectThe address to be created (if action is set to NEW) or updated (if action is set to EXISTINGUPDATED). This is applicable and mandatory only if the action is set to NEW or EXISTINGUPDATED.

Referred Objects Response Data

 address parameter object data

From R14.2.0, the following object is applicable for CRM.COM Address Format

NameTypeDescription

type

(mandatory)

String

The type of the address which can be added

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

is_primary

(mandatory on conditions)

Boolean

Weather the address is the primary one


Applicable from CRM.COM R16.1.0 onwards

postal_code

(optional)

String

The postal code of the address

street_name

(mandatory on conditions)

String

The street name of the address

street_number

(optional)

String

The street number of the address


floor

(optional)

Integer

The floor of the address


apartment_number

(optional)

String

The apartment number of the address


area

(optional)

String

The area of the address


town_city

(optional)

String

The town/city of the address


district

(optional)

String

The district of the address


municipality

(optional)

         

String

The municipality of the address


country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

po_box

(optional)

String

The PO box of the address

po_box_postal_code

(optional)

String

The PO box postal code of the address

care_of

(optional)

String

The care of person of the address

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date


From R14.2.0, the following object is applicable for International Address Format
NameTypeDescription

type

(mandatory)

String

The type of the address which can be added

HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

postal_code

(optional)

String

The postal code of the address


town_city

(optional)

String

The town/city of the address

country_identifier

(optional)

Country identifier

The country of the address. The allowed country identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the country

name

(semi-optional)

String

The name of the country

alternative_code

(semi-optional)

String

The alternative code of the retrieved country

two_character_code

(semi-optional)

String

 The two character code of the retrieved country


three_character_code

(semi-optional)

String

 The three character code of the retrieved country

address_line_1

(mandatory)

String

The address line 1

address_line_2

(optional)

String

 The address line 2

state_province_county

(optional)

String

The state or province or county of the address.


udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

 accounts_receivable_presentment_preference object parameter data
Name
Type
Description
presentment_preference_identifier

(mandatory)

Identifier  

The identifier of the presentment preference to be added on account presentment preference object. The allowed presentment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of presentment preference

name 

(semi-optional)

String

The name of presentment preference

alternative_code

(semi-optional)

String

The alternative code of presentment preference

 accounts_receivable_payment_preference object parameter data

Name

Type

Description

payment_preference_identifier

(mandatory)

Identifier  

The identifier of the payment preference to be added on account payment preference object. The allowed payment preference identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of payment preference

name 

(semi-optional)

String

The name of payment preference

alternative_code 

(semi-optional)

String

The alternative code of payment preference