| Table of Contents | ||
|---|---|---|
|
GET accounts_receivable/show
This method returns information related with an accounts receivable. Single accounts receivable is returned by each call. Note that you can use the POST accounts_receivable/show method as well, which provides the ability to identify the accounts receivable using an access token
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Accounts receivable identifier
The identifier of the accounts receivable that should be returned as a result. The allowed accounts receivable identifier fields are the following:
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request:
Response:
|
GET accounts_receivable/list
This method returns information related with accounts receivable. Multiple accounts receivables are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(semi-optional)
...
The identifier of the subscription related with the accounts that will be returned as results. The allowed subscription identifier fields are the following:
...
(semi-optional)
...
The identifier of the contact information related with the accounts that will be returned as results. The allowed contact information identifier fields are the following:
...
(semi-optional)
...
The identifier of the payment preference related with the accounts that will be returned as results. The allowed payment preference identifier fields are the following:
...
(semi-optional)
...
The identifier of the presentment preference related with the accounts that will be returned as results. The allowed presentment preference identifier fields are the following:
...
wallet_identifier
(semi-optional)
...
The identifier of the wallet elated with the accounts that should be returned as a result. The allowed wallet identifier fields are the following:
...
| Tip |
|---|
...
email_address
(semi-optional)
...
The email address of the contact information owning the accounts that should be returned as a result.
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
phone_number
(semi-optional)
...
The phone number of the contact information owning the accounts that should be returned as a result.
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
| Tip |
|---|
Available from CRM.COM R13.0.0 |
...
offset
(optional)
...
Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| Tip |
|---|
Available from CRM.COM R13.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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: GET
Request:
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": [
{
"notes": null,
"udf_float_1": null,
"credit_period": 0,
"udf_float_2": null,
"udf_float_3": null,
"number": "ACR000929",
"udf_float_4": null,
"udf_string_1": null,
"name": "ACR000929",
"udf_string_2": null,
"udf_string_3": null,
"contact_information": {
"last_name": "Tz",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Ek",
"type": "PERSON",
"id": "15D4F07E221E44088CDE00A96DB1A250",
"name": "Tz Ek",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": "18181818",
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": null,
"industry": null,
"id_issued_by_country": null
}
},
"privacy_level": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"id": "0DA7BAB9909E49828BB84079AA588AF8",
"credit_period_operator": "PLUS",
"balance": 1245.31,
"outstanding_amount": 1245.31,
"payment_preferences_set": [],
"credit_rating": {
"name": "key_ba_-_subject_to_substantial_credit_risk",
"code": "BA"
},
"classification": {
"id": "DD764F3EB0334FC857F8BE5DD4CB41E1",
"name": "VIP Customer",
"alternative_code": "VC"
},
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"accounting_period": {
"closed_date": null,
"to_date": "2016-05-31 00:00:00.0",
"from_date": "2016-05-01 00:00:00.0",
"life_cycle_state": "OPEN",
"number": "052016",
"name": "May 2016"
},
"primary_account": true,
"billing_address": {
"udf_string_10": null,
"street_number": "435",
"care_of": null,
"udf_string_11": null,
"udf_float_1": null,
"street_name": "kassa",
"udf_string_12": null,
"udf_float_2": null,
"udf_string_13": null,
"udf_float_3": null,
"udf_string_14": null,
"udf_float_4": null,
"udf_string_15": null,
"udf_string_16": null,
"po_box": null,
"udf_string_1": null,
"floor": null,
"udf_string_2": null,
"area": "Aglantzia",
"udf_string_3": null,
"district": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"state": "Active",
"udf_string_8": null,
"udf_string_9": null,
"country": {
"three_character_code": "CMR",
"two_character_code": "CM",
"id": "164",
"name": "CAMEROON",
"alternative_code": null
},
"id": "CAB5EC4F32DB4C2F87C93BF0972024FD",
"postal_code": "1212",
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"po_box_postal_code": null,
"apartment_number": null,
"town_city": "Nicosia",
"type": "BUSINESS",
"municipality": null
},
"log_information": {
"updated_date": "2016-04-12T17:22:50",
"created_date": "2015-12-30T10:43:17",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
}
},
"owned_by_group": {
"community_name": "Internal Community",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG1"
},
"life_cycle_state": "ACTIVE",
"opening_balance": 20,
"credit_limit": 300,
"presentment_preferences_set": [],
"opening_balance_date": "2016-05-17 10:17:30.0",
"access_tokens_set": [],
"type": "CUSTOMER",
"description": null,
"credit_limit_status": "EXCEEDED"
}
]
} |
...
| title | Example 1 |
|---|
HTTP Method: GET
Request:
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": [
{
"notes": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-02-19T14:24:40",
"updated_date": "2016-04-11T12:26:55",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "Ekaterini Tzirtzipi",
"id": "708FB289CCAA4DA3B5CCD186E023CF0C",
"email": null,
"username": "etzirtzipi"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Ekaterini Tzirtzipi",
"last_name": "Tzirtzipi",
"id": "3236797A43C746F8AD9F4A91A4035735",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Ekaterini",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "343434",
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"billing_address": {
"apartment_number": null,
"care_of": null,
"country": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"municipality": null,
"type": "BUSINESS",
"udf_date_2": null,
"udf_date_1": null,
"street_name": "Lidras",
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"po_box_postal_code": null,
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "79E72F8D36CA49C1999F090561AE0020",
"state": "Active",
"udf_string_10": null,
"floor": null,
"udf_float_1": null,
"udf_float_2": null,
"area": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"po_box": null,
"town_city": null,
"district": null,
"street_number": null,
"postal_code": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null
},
"primary_account": true,
"type": "CUSTOMER",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "ACR0000000050",
"udf_float_3": null,
"udf_float_4": null,
"balance": -38.15,
"credit_period_operator": "PLUS",
"credit_limit": null,
"credit_period": 2,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "1B61E3A9DB864363A1502829952DF3CD",
"opening_balance": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"presentment_preferences_set": [],
"udf_string_1": null,
"life_cycle_state": "ACTIVE",
"classification": {
"alternative_code": "RC",
"name": "Residential Customer",
"id": "622533B94C749EE89D1933FD4D1FFFF7"
},
"credit_limit_status": "NOT_EXCEEDED",
"credit_rating": {
"code": "AAA",
"name": "key_aaa_-_subject_to_minimal_credit_risk"
},
"name": "ACR0000000050 Ekaterini Tzirtzipi",
"outstanding_amount": 0,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [],
"udf_string_8": null
},
{
"notes": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-03-24T08:27:09",
"updated_date": "2016-03-24T08:29:06",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Ekaterini Tzirtzipi",
"last_name": "Tzirtzipi",
"id": "3236797A43C746F8AD9F4A91A4035735",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Ekaterini",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "343434",
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"billing_address": {
"apartment_number": null,
"care_of": null,
"country": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"municipality": null,
"type": "BUSINESS",
"udf_date_2": null,
"udf_date_1": null,
"street_name": "Lidras",
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"po_box_postal_code": null,
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "79E72F8D36CA49C1999F090561AE0020",
"state": "Active",
"udf_string_10": null,
"floor": null,
"udf_float_1": null,
"udf_float_2": null,
"area": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"po_box": null,
"town_city": null,
"district": null,
"street_number": null,
"postal_code": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null
},
"primary_account": false,
"type": "CUSTOMER",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "ACR0000000145",
"udf_float_3": null,
"udf_float_4": null,
"balance": 0,
"credit_period_operator": "PLUS",
"credit_limit": null,
"credit_period": 2,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "71B5891495F540BE9097F524CA594F7E",
"opening_balance": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"presentment_preferences_set": [
{
"phone": null,
"presentment_method": {
"alternative_code": "P",
"name": "Post",
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Template CRM.COM User",
"last_name": "CRM.COM User",
"id": "CRM1",
"life_cycle_state": null,
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Template",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": " ",
"gender": null,
"country_of_residence": null,
"date_of_birth": {
"month": 4,
"year": 1984,
"day": 2
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": "47006270010",
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"id": "DDCC4450F9311CA9BC6BD663889A16C9",
"state": "ACTIVE",
"type": "POST"
},
"id": "C78F160C3665412FA6F26033A883D40E",
"state": "ACTIVE",
"email": null
}
],
"udf_string_1": null,
"life_cycle_state": "TERMINATED",
"classification": {
"alternative_code": "RC",
"name": "Residential Customer",
"id": "622533B94C749EE89D1933FD4D1FFFF7"
},
"credit_limit_status": "NOT_EXCEEDED",
"credit_rating": {
"code": "AAA",
"name": "key_aaa_-_subject_to_minimal_credit_risk"
},
"name": "ACR0000000145 Ekaterini Tzirtzipi",
"outstanding_amount": 0,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [],
"udf_string_8": null
},
{
"notes": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-03-31T08:26:04",
"updated_date": "2016-03-31T08:26:57",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Ekaterini Tzirtzipi",
"last_name": "Tzirtzipi",
"id": "3236797A43C746F8AD9F4A91A4035735",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Ekaterini",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "343434",
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"billing_address": {
"apartment_number": null,
"care_of": null,
"country": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"municipality": null,
"type": "BUSINESS",
"udf_date_2": null,
"udf_date_1": null,
"street_name": "Lidras",
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"po_box_postal_code": null,
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "79E72F8D36CA49C1999F090561AE0020",
"state": "Active",
"udf_string_10": null,
"floor": null,
"udf_float_1": null,
"udf_float_2": null,
"area": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"po_box": null,
"town_city": null,
"district": null,
"street_number": null,
"postal_code": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null
},
"primary_account": false,
"type": "CUSTOMER",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "ACR0000000189",
"udf_float_3": null,
"udf_float_4": null,
"balance": 0,
"credit_period_operator": "PLUS",
"credit_limit": null,
"credit_period": 2,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "394C7536686B46C6B786494C884C62EA",
"opening_balance": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"presentment_preferences_set": [],
"udf_string_1": null,
"life_cycle_state": "ACTIVE",
"classification": {
"alternative_code": "RC",
"name": "Residential Customer",
"id": "622533B94C749EE89D1933FD4D1FFFF7"
},
"credit_limit_status": "NOT_EXCEEDED",
"credit_rating": {
"code": "AAA",
"name": "key_aaa_-_subject_to_minimal_credit_risk"
},
"name": "ACR0000000189 Ekaterini Tzirtzipi",
"outstanding_amount": 0,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [],
"udf_string_8": null
},
{
"notes": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-03-17T12:59:04",
"updated_date": "2016-03-31T08:18:22",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Ekaterini Tzirtzipi",
"last_name": "Tzirtzipi",
"id": "3236797A43C746F8AD9F4A91A4035735",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Ekaterini",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "343434",
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"billing_address": {
"apartment_number": null,
"care_of": null,
"country": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"municipality": null,
"type": "BUSINESS",
"udf_date_2": null,
"udf_date_1": null,
"street_name": "Lidras",
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"po_box_postal_code": null,
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "79E72F8D36CA49C1999F090561AE0020",
"state": "Active",
"udf_string_10": null,
"floor": null,
"udf_float_1": null,
"udf_float_2": null,
"area": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"po_box": null,
"town_city": null,
"district": null,
"street_number": null,
"postal_code": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null
},
"primary_account": false,
"type": "CUSTOMER",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "ACR0000000108",
"udf_float_3": null,
"udf_float_4": null,
"balance": 0,
"credit_period_operator": "PLUS",
"credit_limit": null,
"credit_period": 2,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "EB017D73567040A6A220E5E76A090641",
"opening_balance": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"presentment_preferences_set": [],
"udf_string_1": null,
"life_cycle_state": "TERMINATED",
"classification": {
"alternative_code": "RC",
"name": "Residential Customer",
"id": "622533B94C749EE89D1933FD4D1FFFF7"
},
"credit_limit_status": "NOT_EXCEEDED",
"credit_rating": {
"code": "AAA",
"name": "key_aaa_-_subject_to_minimal_credit_risk"
},
"name": "ACR0000000108 Ekaterini Tzirtzipi",
"outstanding_amount": 0,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [
{
"authentication_code": "15",
"number": "AT0000000097",
"identifier": "jimmyKimmel@gmail.com",
"id": "5A8A728D81DB4C818989D023025760D7",
"life_cycle_state": "EFFECTIVE",
"classification": null
}
],
"udf_string_8": null
},
{
"notes": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-03-23T15:16:59",
"updated_date": "2016-03-31T08:12:08",
"updated_by_user": {
"person_name": "lpapapavlou",
"id": "E89974529ECD47459FA7C0486F3BFA66",
"email": null,
"username": "lpapapavlou"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Ekaterini Tzirtzipi",
"last_name": "Tzirtzipi",
"id": "3236797A43C746F8AD9F4A91A4035735",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Ekaterini",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "343434",
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"billing_address": {
"apartment_number": null,
"care_of": null,
"country": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"municipality": null,
"type": "BUSINESS",
"udf_date_2": null,
"udf_date_1": null,
"street_name": "Lidras",
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"po_box_postal_code": null,
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "79E72F8D36CA49C1999F090561AE0020",
"state": "Active",
"udf_string_10": null,
"floor": null,
"udf_float_1": null,
"udf_float_2": null,
"area": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"po_box": null,
"town_city": null,
"district": null,
"street_number": null,
"postal_code": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null
},
"primary_account": false,
"type": "CUSTOMER",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "ACR0000000143",
"udf_float_3": null,
"udf_float_4": null,
"balance": 0,
"credit_period_operator": "PLUS",
"credit_limit": null,
"credit_period": 2,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "B6C9D4FD7E0D47D392A3705CCFB1E6E5",
"opening_balance": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"presentment_preferences_set": [],
"udf_string_1": null,
"life_cycle_state": "ACTIVE",
"classification": {
"alternative_code": "RC",
"name": "Residential Customer",
"id": "622533B94C749EE89D1933FD4D1FFFF7"
},
"credit_limit_status": "NOT_EXCEEDED",
"credit_rating": {
"code": "AAA",
"name": "key_aaa_-_subject_to_minimal_credit_risk"
},
"name": "ACR0000000143 Ekaterini Tzirtzipi",
"outstanding_amount": 0,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [
{
"authentication_code": "14",
"number": "AT0000000096",
"identifier": "kathy_tz@gmail.com",
"id": "817A02342D434E438CF64AF73CA22816",
"life_cycle_state": "EFFECTIVE",
"classification": null
}
],
"udf_string_8": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
GET accounts_receivable/suspense_account/show
This method returns information related with the system account which is specified as the suspense account
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST accounts_receivable/show
| Tip |
|---|
Available from CRM.COM R8.0.0 |
This method returns information related with an accounts receivable. This method is similar to the GET method, but it supports identifying the accounts receivable that will be retrieved using an access token. Single accounts receivable is returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Accounts Receivable Identifier
The identifier of the accounts receivable that should be returned as a result. The allowed accounts receivable identifier fields are the following:
...
fields_set
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST accounts_receivable/create
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
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
name
(mandatory)
...
String
...
The name of the account receivable
...
description
(optional)
...
notes
(optional)
...
vat_number
(optional)
...
String
...
The VAT number of the retrieved accounts receivable
...
credit_limit
(optional)
...
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)
...
The credit period operator. The supported values are the following:
PLUS,MINUS
...
credit_period
(optional)
...
classification_identifier
(optional)
...
The accounts receivable classification identifier. The allowed classification identifier fields are the following:
...
credit_rating_code
(optional)
...
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)
...
The group owning the accounts receivable. The allowed group 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:
...
currency_identifier
(optional)
...
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:
...
| Tip |
|---|
...
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)
...
(mandatory)
...
The accounts receivable billing address.
...
(optional)
...
Set of Presentment Preferences Object
...
The presentment preferences of the retrieved accounts receivable
...
(optional)
...
Set of Payment Preferences Object
...
The payment preferences of the retrieved accounts receivable
...
(mandatory on conditions)
...
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 |
|---|
...
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 |
|---|
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
| Expand | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST accounts_receivable/update
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)
...
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)
...
notes
(optional)
...
vat_number
(optional)
...
String
...
The VAT number of the retrieved accounts receivable
...
credit_limit
(optional)
...
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
(optional)
...
classification_identifier
...
The accounts receivable classification identifier. The allowed classification identifier fields are the following:
...
credit_rating_identifier
(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:
...
privacy_level_identifier
(optional)
...
The privacy level of the accounts receivable. The allowed privacy level identifier fields are the following:
...
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)
...
The accounts receivable billing address.
...
(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
...
(mandatory on conditions)
...
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:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
"set": [
{
"action": "add_existing",
...........
},
{
"action": "remove",
...........
},
{
"action": "add_new",
...........
}
] |
| Tip |
|---|
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"1A2C10CE446847C6BDD71FB816D95A0D",
"accounts_receivable_identifier":{"number":"ACR001027"},
"name":"Lukia Papapavlou",
"description":"premium account",
"notes": "test notes"
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"notes": "Marios Lannister\t17/5/2016 11:33:35\tthere are currently no notes\tMarios Lannister\t17/5/2016 11:38:10\ttest notes",
"udf_float_1": 10,
"udf_float_2": 20,
"credit_period": 2,
"udf_float_3": 30,
"udf_float_4": 40,
"number": "ACR001027",
"name": "Lukia Papapavlou",
"udf_string_1": "udf string 1",
"udf_string_2": "udf string 2",
"privacy_level": null,
"contact_information": {
"last_name": "Tomas2",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Andrew",
"type": "PERSON",
"id": "786E6D78AC764BECB616D34D2D61F053",
"name": "Tomas2 Andrew",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": null,
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": null,
"industry": null,
"id_issued_by_country": null
}
},
"udf_string_3": "udf string 3",
"udf_string_4": "udf string 4",
"udf_string_5": "udf string 5",
"udf_string_6": "udf string 6",
"udf_string_7": "udf string 7",
"udf_string_8": "udf string 8",
"id": "0C6F60B6DE7D4853A6E41E5FE537EDEC",
"credit_period_operator": "PLUS",
"balance": 0,
"outstanding_amount": 0,
"payment_preferences_set": [
{
"default": true,
"payment_preference": {
"type": "OTHER",
"id": "0135CB827A97DC1ECDA7EEA993A8ED09",
"name": "Bank Transfer Payment",
"description": null,
"alternative_code": "BTP"
},
"bank_branch": {
"id": "7559D997AD2DA661F2FC3AFE90257F79",
"name": " BOC 1",
"alternative_code": "B1"
},
"cards_set": [],
"id": "4FEEB97864804D57BDF86D4459E887DB",
"bank": {
"id": "A5B487FA26F43959188DB9584D2522D5",
"name": "Bank of Cyprus",
"alternative_code": "BOC"
},
"use_for_recurring_payments": null,
"account_holder": "Lucia Papapavlou",
"bank_account_number": "001002003",
"default_card": null,
"bank_account_type": {
"id": "249CEEE1901507788DF83C8758E4716E",
"name": "Savings Account",
"alternative_code": null
}
}
],
"credit_rating": {
"name": "key_aaa_-_subject_to_minimal_credit_risk",
"code": "AAA"
},
"classification": {
"id": "DE3DC5FD43B51C09F7E0573B845ABE08",
"name": "Standard Customer",
"alternative_code": "SA"
},
"udf_date_1": "2014-05-05T15:49:59",
"udf_date_2": "2014-06-05T15:49:59",
"udf_date_3": "2014-07-05T15:49:59",
"accounting_period": null,
"udf_date_4": "2014-08-05T15:49:59",
"billing_address": {
"udf_string_10": null,
"street_number": null,
"care_of": null,
"udf_string_11": null,
"udf_float_1": null,
"street_name": "Thomas V",
"udf_string_12": null,
"udf_float_2": null,
"udf_string_13": null,
"udf_float_3": null,
"udf_string_14": null,
"udf_float_4": null,
"udf_string_15": null,
"udf_string_16": null,
"po_box": null,
"udf_string_1": null,
"floor": null,
"udf_string_2": null,
"area": null,
"udf_string_3": null,
"district": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"udf_string_7": null,
"state": "Active",
"udf_string_8": null,
"udf_string_9": null,
"country": {
"three_character_code": "CYP",
"two_character_code": "CY",
"id": "181",
"name": "CYPRUS",
"alternative_code": null
},
"id": "78C14BFC8BB248FFB6A86EC91464E666",
"postal_code": null,
"udf_date_1": null,
"udf_date_2": null,
"udf_date_3": null,
"udf_date_4": null,
"po_box_postal_code": null,
"apartment_number": null,
"town_city": null,
"type": "HOME",
"municipality": null
},
"primary_account": true,
"owned_by_group": {
"community_name": "Internal Community",
"id": "84F33366CB592BAAE7E2044D93611C6A",
"name": "Main Group",
"description": "Main Group",
"alternative_code": "MG1"
},
"log_information": {
"updated_date": "2016-05-17T11:38:10",
"created_date": "2016-05-17T11:33:35",
"created_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit": {
"community_name": "Internal Community",
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"group_name": "Main Group",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user": {
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1",
"email": "sakkascy1986@hotmail.com"
},
"updated_by_user": {
"person_name": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
}
},
"presentment_preferences_set": [
{
"state": "ACTIVE",
"presentment_method": {
"state": "ACTIVE",
"type": "EMAIL",
"id": "06A57761BCC28FA9687C57321F2BEB28",
"name": "By Email",
"description": null,
"contact_information": {
"last_name": "Spector",
"middle_name": null,
"life_cycle_state": "FINANCIAL",
"company_profile": null,
"title": null,
"first_name": "Mathew",
"type": "PERSON",
"id": "95548C3522A249E6B452D20C700BA95C",
"name": "Spector Mathew",
"company_name": null,
"demographics": {
"gender": null,
"passport_issued_by_country": null,
"social_security_number": "1245",
"passport_number": null,
"industry_sector": null,
"country_of_residence": {
"three_character_code": "USA",
"two_character_code": "US",
"id": "127",
"name": "UNITED STATES",
"alternative_code": null
},
"name_day": {
"month": null,
"day": null
},
"date_of_birth": {
"month": null,
"day": null,
"year": null
},
"id_number": "454545",
"industry": null,
"id_issued_by_country": null
}
},
"alternative_code": "BE"
},
"id": "7528AC290B9D4034907531E495752CBE",
"email": {
"notes": null,
"udf_float_1": null,
"udf_float_2": null,
"udf_date_1": null,
"udf_float_3": null,
"udf_date_2": null,
"udf_float_4": null,
"udf_date_3": null,
"udf_date_4": null,
"udf_string_1": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_6": null,
"state": "Active",
"udf_string_7": null,
"udf_string_8": null,
"type": "key_business",
"id": "66980E70BF9742C9A9A2E0D8EE23CED3",
"email": "test@gmail.com"
},
"phone": null
}
],
"credit_limit": 10,
"opening_balance": null,
"life_cycle_state": "ACTIVE",
"access_tokens_set": [],
"opening_balance_date": null,
"type": "CUSTOMER",
"credit_limit_status": "NOT_EXCEEDED",
"description": "premium account"
}
} |
...
| title | Example 2 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000269"},
"name":"Mike 2 Tyson",
"description":"premium account",
"notes": "test notes"
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"notes": "CRM COM\t5/7/2016 10:01:24\tthere are currently no notes\tCRM COM\t5/7/2016 10:06:41\ttest notes",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-07-05T07:01:24",
"updated_date": "2016-07-05T07:06:41",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": "premium account",
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Mohammed Tyson J.",
"last_name": "Tyson J.",
"id": "79379F71BA344F1387F65709822B9FB1",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Mohammed",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"billing_address": {
"apartment_number": null,
"care_of": null,
"country": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"municipality": null,
"type": "HOME",
"udf_date_2": null,
"udf_date_1": null,
"street_name": "Thomas V",
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"po_box_postal_code": null,
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "43D57FD689A14E7FAE917A94EB273289",
"state": "Active",
"udf_string_10": null,
"floor": null,
"udf_float_1": null,
"udf_float_2": null,
"area": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"po_box": null,
"town_city": null,
"district": null,
"street_number": null,
"postal_code": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null
},
"primary_account": true,
"type": "CUSTOMER",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "ACR0000000269",
"udf_float_3": null,
"udf_float_4": null,
"balance": 0,
"credit_period_operator": "PLUS",
"credit_limit": 10,
"credit_period": 2,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "0AEDF6606C3243F983471998FB940DEA",
"opening_balance": 0,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"presentment_preferences_set": [
{
"phone": null,
"presentment_method": {
"alternative_code": "E",
"name": "Email",
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "michael may",
"last_name": "may",
"id": "7F1D15F4735C4461A2E033FD960DDB10",
"life_cycle_state": "MARKETING",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "michael",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"id": "67EC7B4252DA209B59733125FB248CED",
"state": "ACTIVE",
"type": "EMAIL"
},
"id": "1115B2672884425D8CF356F68BD19262",
"state": "ACTIVE",
"email": {
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"notes": null,
"udf_string_5": null,
"udf_string_1": null,
"type": "BUSINESS",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"id": "EFCC3C7B76C8406580DA21700BC7FC09",
"state": "Active",
"udf_string_6": null,
"udf_float_1": null,
"udf_string_7": null,
"udf_float_2": null,
"email": "test2@gmail.com",
"udf_string_8": null
}
}
],
"udf_string_1": null,
"life_cycle_state": "ACTIVE",
"classification": {
"alternative_code": "VC",
"name": "VIP Customer",
"id": "F36179059928D40AC42DF66A67364021"
},
"credit_limit_status": "NOT_EXCEEDED",
"credit_rating": {
"code": "AAA",
"name": "key_aaa_-_subject_to_minimal_credit_risk"
},
"name": "Mike 2 Tyson",
"outstanding_amount": 0,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [],
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
|
POST accounts_receivable/change_credit_limit
| Tip |
|---|
Available from CRM.COM R11.0.0 |
This method changes the credit terms of accounts receivable i.e. either its credit limit or the credit rating or both. A single accounts receivable's credit terms can be updated by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
The identifier of the account receivable whose credit terms will be updated. The allowed account receivable identifier fields are the following:
...
credit_limit
(semi-optional)
...
Number
...
The new credit limit of the accounts receivable
...
credit_rating_code
(semi-optional)
...
String
...
AAA, AA, A, BAA, BA, B, CAA, CA, C
...
fields_set
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Both those parameters is allowed to be specified.
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"C2F69E45F0584081864FF0E5ADA05C6C",
"accounts_receivable_identifier":{"number":"ACR0000000703"},
"credit_limit":5,
"credit_rating_code":"BA"
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"notes": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-09-28T10:23:43",
"updated_date": "2016-09-28T14:26:11",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": null,
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": null,
"username": "MPAdministrator"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Georgia Kountouri",
"last_name": "Kountouri",
"id": "B6D8444BF9604C779511F195F6114393",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Georgia",
"demographics": {
"name_day": {
"month": 4,
"day": 23
},
"id_number": "822432",
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": 3,
"year": 1981,
"day": 28
},
"industry_sector": {
"alternative_code": "FIN",
"name": "FINANCIALS",
"id": "61FD1DE51A932732C059FE9CFB6B38B3"
},
"passport_number": "c45678",
"industry": null,
"social_security_number": "32234567889",
"id_issued_by_country": {
"alternative_code": "AFG",
"three_character_code": null,
"name": "AFGHANISTAN",
"id": "128",
"two_character_code": null
},
"passport_issued_by_country": {
"alternative_code": "AFG",
"three_character_code": null,
"name": "AFGHANISTAN",
"id": "128",
"two_character_code": null
}
}
},
"billing_address": null,
"primary_account": false,
"type": "CUSTOMER",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "ACR0000000703",
"udf_float_3": null,
"udf_float_4": null,
"balance": null,
"credit_period_operator": "PLUS",
"credit_limit": 5,
"credit_period": 0,
"currency": {
"suffix_symbol": "N/A",
"prefix_symbol": "€",
"decimal_part_name": "cents",
"code": "EUR",
"integer_part_name": "euro",
"id": "2"
},
"id": "2527E387A0D547D69DAF118DD057085C",
"opening_balance": 0,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"presentment_preferences_set": [],
"udf_string_1": null,
"life_cycle_state": "ACTIVE",
"classification": {
"alternative_code": "RC",
"name": "Residential Customer",
"id": "622533B94C749EE89D1933FD4D1FFFF7"
},
"credit_limit_status": "NOT_EXCEEDED",
"credit_rating": {
"code": "BA",
"name": "key_ba_-_subject_to_substantial_credit_risk"
},
"name": "GK4",
"outstanding_amount": null,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [],
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
|
GET accounts_receivable/write_off_account/show
| Tip |
|---|
Available from CRM.COM R13.0.0 |
This method returns information related with the system account which is specified as the write off account
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
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 |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET accounts_receivable/assets/list
| Tip |
|---|
This method returns the physical goods assets that were purchased by the specified customer. Multiple assets are retrieved by this call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Accounts receivable identifier
The identifier of the accounts receivable that should be returned as a result. The allowed accounts receivable identifier fields are the following:
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
POST accounts_receivable/assets/return
| Tip |
|---|
Available from CRM.COM R11.5.0 and CRM.COM R12.1.0 |
This method is used when an Accounts Receivable Asset is returned back by a customer. Multiple assets can be returned through each call. The method returns a list of all of the accounts receivable assets which were successfully returned.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
The identifier of the account receivable that owns the asses to be returned. The allowed account receivable identifier fields are the following:
...
accounts_receivable_assets_set
(mandatory)
...
fields_set
(optional)
...
Response Data
...
Examples
| Expand | ||
|---|---|---|
| ||
HTTP Method: POST {{server}}/crmapi/rest/v2/accounts_receivable/assets/return Request: Response:
|
POST accounts_receivable/assets/transfer_ownership
| Tip |
|---|
Available from CRM.COM R13.0.0 |
This method is used when an Accounts Receivable Asset is moved from one Accounts Receivable to another because of a transfer of ownership. Multiple assets can be moved through each call but only as long as they are transferred to the same account owner. The method returns a list of all of the accounts receivable assets which were successfully transferred to another accounts receivable.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
The identifier of the account receivable that owns the assets whose ownership will be transferred to another accounts receivable. The allowed account receivable identifier fields are the following:
...
(mandatory)
...
The identifier of the account receivable to which the ownership of the assets will be transferred to. The allowed account receivable identifier fields are the following:
...
accounts_receivable_assets_set
(mandatory)
...
fields_set
(optional)
...
Response Data
...
Examples
| Expand | ||
|---|---|---|
| ||
HTTP Method: POST {{server}}/crmapi/rest/v2/accounts_receivable/assets/transfer_ownership Request: Response:
|
GET accounts_receivable/get_remaining_usage_allowance
| Tip |
|---|
Available from CRM.COM R13.0.0 |
This method returns information related with an accounts receivable's remaining usage allowance. Information related to a single accounts receivable is returned by each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Accounts receivable identifier
The identifier of the accounts receivable for which its remaining usage allowance should be returned as a result. The allowed accounts receivable identifier fields are the following:
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST
Request:
Response:
|
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST
Request: Response:
|
POST accounts_receivable/add_member
| Tip |
|---|
Available from CRM.COM R13.0.0 |
This method adds an accounts receivable as a member in a group of accounts. Only a single account can be added as a member in each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
parent_account
(mandatory)
...
The parent accounts receivable of the group within which the member account will be added. The available accounts receivable identifiers are the following:
...
funding_scope
(mandatory)
...
The funding scope of the member accounts receivable to be added. Two options are available:
- FULLY_FUNDED
- PARTIALLY_FUNDED
...
(mandatory)
...
(mandatory)
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"parent_account":{"number":"ACR0000008003"},
"funding_scope":"FULLY_FUNDED",
"member_account":
{
"action":"NEW",
"name":"Lucien Member Acc",
"classification_identifier":{"name":"Residential Customer"},
"credit_rating_code":"AA",
"contact_information":
{
"action":"NEW",
"type":"PERSON",
"first_name":"Lucien",
"last_name":"Leto"
},
"billing_address":
{
"action":"NEW",
"address":
{
"type":"HOME",
"street_name":"Legends Road",
"street_number":"3"
}
}
},
"funded_services":
[
{
"product":{"code":"Serendipity"}
},
{
"type":{"name":"Usage"}
}
]
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"member_accounts": [
{
"number": "ACR0000011920",
"funded_services": [
{
"product_family": null,
"product": null,
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": false,
"alternative_code": "U",
"udr_type": null,
"composition_method": "FLAT",
"name": "Usage",
"description": null,
"id": "E39ACA40EC7B42AEBC113468F4884157",
"classification": "SERVICES",
"physical_good_type": null
}
},
{
"product_family": null,
"product": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"product_type": null
}
],
"name": "New Member Acc",
"id": "6037C5695FB2420892E007C0FB212E7E",
"life_cycle_state": "ACTIVE",
"funding_scope": "FULLY_FUNDED"
},
{
"number": "ACR0000011927",
"funded_services": [
{
"product_family": null,
"product": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"product_type": null
},
{
"product_family": null,
"product": null,
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": false,
"alternative_code": "U",
"udr_type": null,
"composition_method": "FLAT",
"name": "Usage",
"description": null,
"id": "E39ACA40EC7B42AEBC113468F4884157",
"classification": "SERVICES",
"physical_good_type": null
}
}
],
"name": "Lucien Member Acc",
"id": "0E2FA4ED924A409DABF2C24F12DC33F0",
"life_cycle_state": "ACTIVE",
"funding_scope": "FULLY_FUNDED"
}
],
"notes": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2017-03-01T08:01:12",
"updated_date": "2017-04-03T18:34:49",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Marinos Anton 3",
"last_name": "Anton 3",
"id": "8A4E37F4BD37491BAE078159CA4969B6",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Marinos",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"billing_address": {
"apartment_number": null,
"care_of": null,
"country": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"municipality": null,
"type": "BUSINESS",
"udf_date_2": null,
"udf_date_1": null,
"street_name": "Athalassis",
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"po_box_postal_code": null,
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "9ABF413DAE3847A09481208E354A176E",
"state": "Active",
"udf_string_10": null,
"floor": null,
"udf_float_1": null,
"udf_float_2": null,
"area": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"po_box": null,
"town_city": null,
"district": null,
"street_number": "10",
"postal_code": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null
},
"primary_account": false,
"type": "CUSTOMER",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "ACR0000008003",
"udf_float_3": null,
"udf_float_4": null,
"balance": 0,
"credit_period_operator": "PLUS",
"credit_limit": 50,
"credit_period": 2,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "2DBED4B086174DB2A4F9BC193F535F3D",
"opening_balance": 0,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"presentment_preferences_set": [],
"udf_string_1": null,
"life_cycle_state": "ACTIVE",
"classification": {
"alternative_code": "RC",
"name": "Residential Customer",
"id": "622533B94C749EE89D1933FD4D1FFFF7"
},
"credit_limit_status": "NOT_EXCEEDED",
"credit_rating": {
"code": "AAA",
"name": "key_aaa_-_subject_to_minimal_credit_risk"
},
"name": "ACR0000008003",
"outstanding_amount": null,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [],
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"parent_account":{"number":"ACR0000008085"},
"funding_scope":"PARTIALLY_FUNDED",
"member_account":
{
"action":"existing",
"accounts_receivable_identifier":{"number":"ACR0000008030"}
},
"funded_services":
[
{
"product":{"code":"Serendipity}
},
{
"family":{"name":"Decoders"}
},
{
"type":{"name":"Usage"}
}
]
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"member_accounts": [
{
"number": "ACR0000008030",
"funded_services": [
{
"product_family": null,
"product": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"product_type": null
},
{
"product_family": null,
"product": null,
"product_type": {
"service_type": "TERMED",
"used_for_provisioning": false,
"alternative_code": "U",
"composition_method": "FLAT",
"name": "Usage",
"description": null,
"id": "E39ACA40EC7B42AEBC113468F4884157",
"classification": "SERVICES",
"physical_good_type": null
}
},
{
"product_family": {
"code": "D",
"name": "Decoders",
"description": null,
"id": "5149B4514E63446FA6364CE445A265CF"
},
"product": null,
"product_type": null
}
],
"name": "ACR0000008030",
"id": "3960217EC77D4FF190DDDA985C361B1F",
"life_cycle_state": "ACTIVE",
"funding_scope": "PARTIALLY_FUNDED",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Anton 2",
"id": "76EBF36822904F10B28B570EFD8665C1",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Marinos",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
}
],
"notes": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2017-03-27T17:12:00",
"updated_date": "2017-04-05T15:44:21",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Marinos Antoniades",
"last_name": "Antoniades",
"id": "6FC181BB34D34CB49607BC7765FF1028",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Marinos",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "9696454",
"gender": null,
"country_of_residence": {
"alternative_code": "FJI",
"three_character_code": null,
"name": "FIJI",
"id": "196",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"billing_address": {
"apartment_number": null,
"care_of": null,
"country": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"municipality": null,
"type": "HOME",
"udf_date_2": null,
"udf_date_1": null,
"street_name": "Myrtous",
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"po_box_postal_code": null,
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "0CB71C5597484E50B355025861FE7B1E",
"state": "Active",
"udf_string_10": null,
"floor": null,
"udf_float_1": null,
"udf_float_2": null,
"area": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"po_box": null,
"town_city": null,
"district": null,
"street_number": "6",
"postal_code": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null
},
"primary_account": false,
"type": "CUSTOMER",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "ACR0000008085",
"udf_float_3": null,
"udf_float_4": null,
"balance": 0,
"credit_period_operator": "PLUS",
"credit_limit": 50,
"credit_period": 2,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "7914C581AE684BD59B62C76CC91EDE14",
"opening_balance": 0,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"presentment_preferences_set": [],
"udf_string_1": null,
"life_cycle_state": "ACTIVE",
"classification": {
"alternative_code": "VC",
"name": "VIP Customer",
"id": "F36179059928D40AC42DF66A67364021"
},
"usage_allowance_limits": {
"accumulated_maximum_rated_amount_per_transaction": null,
"usage_services_allowance": [
{
"service_family": null,
"service_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "U-Fixed",
"udr_type": {
"alternative_code": "UT",
"name": "UDR Type",
"description": null,
"id": "2596B027536040809599D4665AF1D528"
},
"composition_method": "FLAT",
"name": "Usage - Fixed B",
"description": "Add a description of the new type",
"id": "2717F3F8A27444309F6AC1EA7D77D1A2",
"classification": "SERVICES",
"physical_good_type": null
},
"maximum_rated_amount_per_day": "20",
"service": null,
"maximum_usage_per_transaction": null,
"maximum_rated_amount_per_month": null,
"maximum_usage_per_day": null,
"maximum_rated_amount_per_transaction": null,
"maximum_usage_per_month": null
},
{
"service_family": null,
"service_type": null,
"maximum_rated_amount_per_day": null,
"service": {
"code": "VOD & PPV",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "U-Fixed",
"udr_type": {
"alternative_code": "UT",
"name": "UDR Type",
"description": null,
"id": "2596B027536040809599D4665AF1D528"
},
"composition_method": "FLAT",
"name": "Usage - Fixed B",
"description": "Add a description of the new type",
"id": "2717F3F8A27444309F6AC1EA7D77D1A2",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "LOTR-FIX",
"description": "VOD & PPV",
"id": "82A3A682C4514A87980414A7A990CBCE"
},
"maximum_usage_per_transaction": null,
"maximum_rated_amount_per_month": "200",
"maximum_usage_per_day": "5",
"maximum_rated_amount_per_transaction": null,
"maximum_usage_per_month": null
},
{
"service_family": null,
"service_type": null,
"maximum_rated_amount_per_day": null,
"service": {
"code": "V for Vendetta",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "VS",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "VOD Service",
"description": null,
"id": "B06ACBEF10A24057902837A51BCB2B36",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "VFV",
"description": "V for Vendetta VOD",
"id": "FD50BBBFAC7245838F205F5C143F54AE"
},
"maximum_usage_per_transaction": null,
"maximum_rated_amount_per_month": null,
"maximum_usage_per_day": "5",
"maximum_rated_amount_per_transaction": null,
"maximum_usage_per_month": null
},
{
"service_family": {
"code": "TEST CRMCOM4837 FOR A LONG NAME ",
"name": "TEST CRMCOM4837 FOR A LONG NAME 1111111111111111",
"description": null,
"id": "742A4BB6867E422AA3876E43BFAFBE18"
},
"service_type": null,
"maximum_rated_amount_per_day": null,
"service": null,
"maximum_usage_per_transaction": null,
"maximum_rated_amount_per_month": "30",
"maximum_usage_per_day": null,
"maximum_rated_amount_per_transaction": "3",
"maximum_usage_per_month": null
}
],
"accumulated_maximum_usage_per_day": "10",
"accumulated_maximum_usage_per_month": null,
"accumulated_maximum_rated_amount_per_month": "500",
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"accumulated_maximum_rated_amount_per_day": "50",
"accumulated_maximum_usage_per_transaction": "5"
},
"credit_limit_status": "NOT_EXCEEDED",
"credit_rating": {
"code": "AAA",
"name": "key_aaa_-_subject_to_minimal_credit_risk"
},
"name": "ACR0000008085",
"outstanding_amount": null,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [],
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
POST accounts_receivable/remove_member
| Tip |
|---|
Available from CRM.COM R13.0.0 |
This method removes a member account from a group of accounts. Only one member accounts can be removed from a group in each call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
member_account_identifier
(mandatory)
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
Response Data
...
Examples
...
| title | Example 1 |
|---|
HTTP Method: POST
Request:
Body:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"token":"{{token}}",
"member_account_identifier":{"name":"Philip Rushmore Account"}
} |
Response:
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"data": {
"notes": null,
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2017-04-03T18:54:23",
"updated_date": "2017-04-03T18:55:14",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Community",
"name": "Main Group",
"description": "Main Group",
"id": "1"
},
"description": null,
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "Philip Rushmore",
"last_name": "Rushmore",
"id": "6108D0EE590749C096E912B148C0919C",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Philip",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"billing_address": {
"apartment_number": null,
"care_of": null,
"country": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"municipality": null,
"type": "HOME",
"udf_date_2": null,
"udf_date_1": null,
"street_name": "Roads Road",
"udf_date_4": null,
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"po_box_postal_code": null,
"udf_string_15": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "D6A19C04A19E4AC8BE9C2186AE10DDEA",
"state": "Active",
"udf_string_10": null,
"floor": null,
"udf_float_1": null,
"udf_float_2": null,
"area": null,
"udf_string_2": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"po_box": null,
"town_city": null,
"district": null,
"street_number": "3",
"postal_code": null,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null,
"udf_string_9": null
},
"primary_account": true,
"type": "CUSTOMER",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "ACR0000011928",
"udf_float_3": null,
"udf_float_4": null,
"balance": 0,
"credit_period_operator": "PLUS",
"credit_limit": 45,
"credit_period": 2,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"id": "0FB6982EB3254933AADF8A536CD1D375",
"opening_balance": 0,
"udf_float_1": null,
"udf_float_2": null,
"udf_string_2": null,
"opening_balance_date": null,
"udf_string_3": null,
"udf_string_4": null,
"udf_string_5": null,
"privacy_level": null,
"presentment_preferences_set": [],
"udf_string_1": null,
"life_cycle_state": "ACTIVE",
"classification": {
"alternative_code": "RC",
"name": "Residential Customer",
"id": "622533B94C749EE89D1933FD4D1FFFF7"
},
"usage_allowance_limits": {
"accumulated_maximum_rated_amount_per_transaction": null,
"usage_services_allowance": [
{
"service_family": null,
"service_type": null,
"maximum_rated_amount_per_day": null,
"service": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"maximum_usage_per_transaction": "1",
"maximum_rated_amount_per_month": null,
"maximum_usage_per_day": "3",
"maximum_rated_amount_per_transaction": null,
"maximum_usage_per_month": null
}
],
"accumulated_maximum_usage_per_day": null,
"accumulated_maximum_usage_per_month": null,
"accumulated_maximum_rated_amount_per_month": "200",
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "2"
},
"accumulated_maximum_rated_amount_per_day": "30",
"accumulated_maximum_usage_per_transaction": null
},
"credit_limit_status": "NOT_EXCEEDED",
"credit_rating": {
"code": "AA",
"name": "key_aa_-_subject_to_very_low_credit_risk"
},
"name": "Philip Rushmore Account",
"outstanding_amount": null,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [],
"udf_string_8": null
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
} |
GET accounts_receivable/vouchers/list
| Tip |
|---|
This method returns the Activated vouchers (used or not) that were assigned to the specified Accounts Receivable. Multiple vouchers are retrieved by this call.
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
(mandatory)
...
Accounts Receivable Identifier
The identifier of the accounts receivable that should be returned as a result. The allowed accounts receivable identifier fields are the following:
...
applicable_for_use
(optional)
...
Determines if the retrieved results will be consisted by Activated vouchers that belong to that Account Receivable account and are available to be used or not
The following options are available
- True - Will return only Activated Vouchers that are ready to be used and belong to that Account Receivable account
- False - Will return only the vouchers that were used against the specified Account Receivable account
- Not Specified - Will return all above vouchers
...
number_of_results
(optional)
...
The number of results that can be retrieved through each call
...
offset
(optional)
...
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
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
...
| Panel | ||||
|---|---|---|---|---|
| ||||
|