...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
This method updates accounts receivable. Single accounts receivable can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Excerpt |
---|
This method updates accounts receivable. Single accounts receivable can be updated by each call. Fields which are not specified are not updated at all. Fields which are specified as null will be set as null. |
Resource URL
http://host_name/crmapi/rest/$version/accounts_receivable/update
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
accounts_receivable_identifier (mandatory) | Account Receivable Identifier | The identifier of the account receivable to be updated. The allowed account receivable identifier fields are the following:
| ||||||
name (optional) | String | The name of the account receivable | ||||||
description (optional) | String | The description of the retrieved accounts receivable | ||||||
notes (optional) | String | The notes of the retrieved accounts receivable | ||||||
vat_number (optional) | String | The VAT number of the retrieved accounts receivable | ||||||
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.
| ||||||
credit_period (optional) | Number | Credit period is the length of time for which a customer is allowed to settle any given debit
| ||||||
classification_identifier (optional) | Accounts Receivable Classification Identifier | The accounts receivable classification identifier. The allowed classification identifier fields are the following:
| ||||||
credit_rating_identifier (optional) | Credit rating identifier | The accounts receivable credit rating identifier. The allowed credit rating identifier fields are the following:
| ||||||
owned_by_group_identifier (optional) | Group identifier | The group owning the accounts receivable. The allowed group identifier fields are the following:
| ||||||
privacy_level_identifier (optional) | Privacy level identifier | The privacy level of the accounts receivable. The allowed privacy level identifier fields are the following:
|
|
|
|
|
|
name
(optional)
String
The name of the account receivable
| ||
account_manager (optional) |
User Identifier | The |
notes
(optional)
vat_number
(optional)
String
The VAT number of the retrieved accounts receivable
identifier of the user that should be set as the Account Manager. The allowed user identifier fields are the following:
Assigning an Account Manager is only applicable for Accounts Receivables that are owned by a COMPANY
| ||||||||
is_tax_exempt (optional) |
Boolean |
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.
Defines whether the account owner is Tax Exempt or not
|
|
udf_string_ |
1 (optional) |
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 |
String | User Defined Field of type String |
udf_string_2 (optional) |
The accounts receivable classification identifier. The allowed classification identifier fields are the following:
privacy_level_identifier
(optional)
The privacy level of the accounts receivable. The allowed privacy level identifier fields are the following:
account_manager
(optional)
The identifier of the user that should be set as the Account Manager. The allowed user identifier fields are the following:
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)
User Defined Field of type String
udf_string_2
(optional)
User Defined Field of type String
udf_string_3
(optional)
User Defined Field of type String
udf_string_4
(optional)
User Defined Field of type String
udf_string_5
(optional)
User Defined Field of type String
udf_string_6
(optional)
User Defined Field of type String
udf_string_7
(optional)
User Defined Field of type String
udf_string_8
(optional)
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
(mandatory)
String | User Defined Field of type String | |
udf_string_3 (optional) | String | User Defined Field of type String |
udf_string_4 (optional) |
The accounts receivable credit rating identifier. The allowed credit rating identifier fields are the following:
owned_by_group_identifier
(optional)
The group owning the accounts receivable. The allowed group identifier fields are the following:
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
| |||||||||||
(mandatory) | Billing Address object | The accounts receivable billing address.
| |||||||||||
(optional) | Rewards Object | The rewards information of the accounts receivable
| |||||||||||
(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.
| |||||||||||
(optional) | Set of accounts receivable presentment preferences objects | The presentment preferences of the retrieved accounts receivable.
| |||||||||||
(optional) | Set of accounts receivable payment preferences objects | The payment preferences of the retrieved accounts receivable
|
automatic_recurring_payments_preferences
(optional)
Automatic Recurring Payments Preferences Object
Tip |
---|
Available from CRM.COM R14.0.0 |
(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 If no records are specified in the set then nothing will be updated. To remove a record use action:"remove". To add a record use action:"add_existing" or "add_new". Different actions can be used within the same set. For example:
|
|
Anchoraccounts_receivable_update referred objects parameters accounts_receivable_update referred objects parameters
Referred Parameter Objects Data
accounts_receivable_update referred objects parameters | |
accounts_receivable_update referred objects parameters |
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
|
Include Page | ||||
---|---|---|---|---|
| ||||
Include Page | ||||
|
Include Page | ||||
---|---|---|---|---|
|
...
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST
Request:Request: http://cyn1lnx004:9080/crmapi/rest/v2/accounts_receivable/update Body:
Response:
|
...
Expand | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||
HTTP Method: POST
Request:Request: http://cyn1lnx004:9080/crmapi/rest/v2/accounts_receivable/update Body:
Response:
|
...