Versions Compared

Old Version 36

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.


Excerpt

This method creates a accounts receivable. Single accounts receivable can be created by each call. Only customer accounts receivable can be created through this method. Accounts receivable are created in an ACTIVE state

...

Name

Type

Description

token

String

The token retrieved from the login method

name

(mandatory on conditions)

String

The name of the account receivable. The account name is mandatory unless the system is configured to generate the name automatically

description

(optional)

StringThe description of the retrieved accounts receivable

notes

(optional)

StringThe notes of the retrieved accounts receivable

vat_number

(optional)

String

The VAT number of the retrieved accounts receivable

Tip

Deprecated from CRM.COM R15.0.0


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.

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
Tip

Deprecated from CRM.COM R14.0.0


credit_period

(optional)

Number

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


classification_identifier

(optional)

Accounts Receivable Classification Identifier

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

Include Page
V4:accounts_receivable_classification_identifier
V4:accounts_receivable_classification_identifier

credit_rating_code

(optional)

String

The code of  the credit rating. The supported codes are the following

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

owned_by_group_identifier

(optional)

Group identifier

The group owning the accounts receivable. The allowed group identifier fields are the following

Include Page
V4:group_identifier
V4:group_identifier

Tip

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


owned_by_business_unit_identifier

(optional)

Business Unit identifier

The business unit owning the accounts receivable. The allowed business unit identifier fields are the following

Include Page
V4:business_unit_identifier
V4: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. The allowed privacy level identifier fields are the following

Include Page
V4:privacy_level_identifier
V4:privacy_level_identifier

Tip

Deprecated from CRM.COM R18.0.0


currency_identifier

(optional)

Currency identifier

The accounts receivable currency. If not specified, then CRM.COM's default currency is defined as the accounts receivable currency. The allowed currency identifier fields are the following:

Include Page
V4:currency_identifier
V4: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
V4:user_identifier
V4: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


is_tax_exempt

(optional)

Boolean

Defines whether the account owner is Tax Exempt or not

Tip

Available from CRM.COM R17.0.0


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

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


Tip

Available from CRM.COM R16.2.0


contact_information

(mandatory)

Contact information objectThe contact information of the accounts receivable owner

billing_address

(mandatory)

Billing Address Object

The accounts receivable billing address

Tip

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


rewards

(optional)

Rewards Object

The rewards information of the accounts receivable

Tip

Available from CRM.COM R17.0.0


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


payment_preferences_set

(optional)

Set of Payment Preferences Object      

The payment preferences of the retrieved accounts receivable

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

Deprecated from CRM.COM R18.0.0

customer_identification_claim_set

(optional)

Set of Customer Identification Claim Objects


The customer identification claims that will be associated with the accounts receivable

Tip

Available from CRM.COM R18.0.0

fields_set

(optional)

List of Strings, comma separated


A list of fields that should be included in the results. If not specified then all the available fields will be returned

Tip

Available from CRM.COM R10.0.0


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

...

Include Page
V4:access_token_parameters
V4:access_token_parameters
Include Page
V4:customer_identification_medium_parametersV4:customer_identification_medium_parameters

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

...