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 on conditions) | String | The name of the account receivable. The account name is mandatory unless the system is configured to generate the name automatically | ||||||||||||
description (optional) | 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 Deprecated from CRM.COM R15.0.0 | ||||||||||||
credit_limit (optional) | Number | Is the maximum amount of credit that can be provided to the specific accounts receivable, or in other words the maximum balance that the accounts receivable can ever reach. Deprecated from CRM.COM R11.0.0 | ||||||||||||
credit_period_operator (optional) | String | The credit period operator. The supported values are the following:
Deprecated from CRM.COM R14.0.0 | ||||||||||||
credit_period (optional) | Number | Credit period is the length of time for which a customer is allowed to settle any given debit Deprecated from CRM.COM R14.0.0 | ||||||||||||
classification_identifier (optional) | Accounts Receivable Classification Identifier | The accounts receivable classification identifier. The allowed classification identifier fields are the following:
| ||||||||||||
credit_rating_code (optional) | String | The code of the credit rating. The supported codes are the following: AAA, AA, A, BAA, BA, B, CAA, CA, C | ||||||||||||
owned_by_group_identifier (optional) | Group identifier | The group owning the accounts receivable. The allowed group identifier fields are the following:
Deprecated from CRM.COM R18.0.0 (replaced with owned_by_unit_identifier) | ||||||||||||
owned_by_business_unit_identifier (optional) | Business Unit identifier | The business unit owning the accounts receivable. The allowed business unit identifier fields are the following:
Available from CRM.COM R18.0.0 | ||||||||||||
privacy_level_identifier (optional) | Privacy level identifier | The privacy level of the accounts receivable. The allowed privacy level identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
currency_identifier (optional) | Currency identifier | The accounts receivable currency. If not specified, then CRM.COM's default currency is defined as the accounts receivable currency. The allowed currency identifier fields are the following:
| ||||||||||||
account_manager (optional) | User Identifier | The identifier of the user that should be set as the Account Manager. The allowed user identifier fields are the following:
Assigning an Account Manager is only applicable for Accounts Receivables that are owned by a COMPANY Available from CRM.COM R14.0.0 | ||||||||||||
is_tax_exempt (optional) | Boolean | Defines whether the account owner is Tax Exempt or not Available from CRM.COM R17.0.0 | ||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||||||
custom_field_set (optional) | Set of Custom Fields | The custom fields that are associated with the accounts receivable If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value "custom_field_set": [
{"field_name" : "value"},
{"field_name" : "value"}
]
Available from CRM.COM R16.2.0 | ||||||||||||
(mandatory) | Contact information object | The contact information of the accounts receivable owner | ||||||||||||
(mandatory) | Billing Address Object | The accounts receivable billing address From CRM.COM R14.3.0, billing_address is mandatory based on the accounts receivable definitions' billing address rules | ||||||||||||
(optional) | Rewards Object | The rewards information of the accounts receivable Available from CRM.COM R17.0.0 | ||||||||||||
(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 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) | 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 | ||||||||||||
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 |
Referred Parameter Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved accounts receivable |
| type | String | The type of the retrieved accounts receivable which can be CUSTOMER or SYSTEM or ORGANISATIONAL ORGANISATIONAL type is available from CRM.COM R15.0.0 |
number | String | The number of the retrieved accounts receivable |
name | String | The name of the retrieved accounts receivable |
| description | String | The description of the retrieved accounts receivable |
| notes | String | The notes of the retrieved accounts receivable |
balance | Float | The aggregated amount of posted debits and credits allocated against the accounts receivable, as of a specific date. This information is calculated dynamically |
| opening_balance | Float | The opening balance of the accounts receivable for the latest and still open Accounting Period. This information is calculated during the latest Accounting Period Closing process. |
| opening_balance_date | Date | The date on which the opening balance of the accounts receivable was last calculated by an Accounting Period Closing process. |
outstanding_amount | Float | The total outstanding amount which is owned by the customer, as of a specific date, which is the aggregated amount of posted debits which are not paid and are past their due date. This information is calculated dynamically |
| credit_limit_status | String | Determines if the outstanding amount of the specific accounts receivable has exceeded the allowed credit limit. The supported values are NOT_EXCEEDED or EXCEEDED |
| credit_limit | 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 | Number | Credit period is the length of time for which a customer is allowed to settle any given debit |
life_cycle_state | String | The life cycle state of the retrieved accounts receivable which can be ACTIVE, SUSPENDED or TERMINATED |
primary_account | Boolean | Indicates if the accounts receivable is the primary accounts receivable for the specified customer or not |
| partner_account | Boolean | Indicates if the accounts receivable is owned by a partner group or a partner unit, i.e. is a partner account |
| parent_account | Boolean | Indicates if the accounts receivable is a parent account in a group accounts |
| is_tax_exempt | Boolean | Indicates if the account owner is tax exempt or not Available from CRM.COM R17.0.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
Contact Information object | The contact information related with the specified accounts receivable | |
Classification object | The classification of the retrieved accounts receivable | |
Credit Rating object | The credit rating of the retrieved accounts receivable | |
| credit_period | Credit Period object | The credit period of the retrieved accounts receivable |
Address object | The billing address of the retrieved accounts receivable | |
| currency | Currency object | The accounts receivable's currency |
| parent_account | Accounts Receivable Object | The parent accounts receivable. Applicable only if the retrieved Accounts Receivable is a member in a group of accounts. |
| accounting_period | Accounting Period Object | The latest Accounting Period for which the accounts receivable's opening balance was calculated for. |
| owned_by_group | Group Object | The group that is owning the accounts receivable Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit) |
| owned_by_business_unit | Business Unit Object | The business unit that is owning the accounts receivable Available from CRM.COM R18.0.0 |
| privacy_level | Privacy Level Object | The accounts receivable privacy level Deprecated from CRM.COM R18.0.0 |
| usage_allowance_limits | Usage Allowance Limits Object | The accounts receivable Usage Allowance Limits Available from CRM.COM R13.0.0 Deprecated from CRM.COM R17.0.0 |
Log Information Object | The log information related to the retrieved accounts receivable | |
| account_manager | Users Object | The account manager of the retrieved accounts receivable Applicable only if the retrieved account is owned by a COMPANY |
| pricing_agreement | Pricing Agreement Object | The pricing agreement of the retrieved accounts receivable Applicable only for an Accounts Receivable that is owned by a Company and a Price Plan and/or Usage Service Catalog was agreed as part of a special pricing agreement Available from CRM.COM R14.0.0 From CRM.COM R15.0.0, pricing_agreement is available for all CUSTOMER and ORGANISATIONAL accounts, for both persons and companies |
| recurring_payments_preferences | Recurring Payments Preferences Object | The recurring payments preferences associated with the accounts receivable |
| membership_information | Account Membership Information Object | The accounts receivable membership information in terms of funding scope and the services funded by the parent account. Applicable only if the retrieved accounts receivable is a member account of a group. |
| rewards | Rewards Object | The rewards information of the accounts receivable Available from CRM.COM R17.0.0 |
Set of Accounts Receivable Presentment Preferences Objects | The presentment preferences of the retrieved accounts receivable | |
Set of Accounts Receivable Payment Preferences Objects | The payment preferences of the retrieved accounts receivable | |
| access_tokens_set | Set of Access Token objects | The access tokens associated with the accounts receivable |
| member_accounts | Set of Accounts Receivable Objects | The member accounts of the retrieved accounts receivable. Applicable only if the retrieved account is a Parent Account. |
| usage_allowance_organisational_units | Set of Usage Organisational Conditions Objects | The usage organisational conditions (communities, groups, units) that services can be used at |
Referred Objects Response Data
Examples
HTTP Method: POST
Request
Body
{
"token":"1A2C10CE446847C6BDD71FB816D95A0D",
"name":"Andrew Tomas2",
"description":"normal account",
"notes": "there are currently no notes",
"vat_number":"10",
"credit_limit" :10,
"credit_period_operator":"PLUS",
"credit_period":2,
"classification_identifier":{"alternative_code":"SA"},
"credit_rating_code":"AAA",
"owned_by_group_identifier":{"name":"Main Group"},
"udf_string_1":"udf string 1",
"udf_string_2":"udf string 2",
"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",
"udf_float_1":10,
"udf_float_2":20,
"udf_float_3":30,
"udf_float_4":40,
"udf_float_5":50,
"udf_float_6":60,
"udf_float_7":70,
"udf_float_8":80,
"udf_date_1":"2014-05-05T15:49:59",
"udf_date_2":"2014-06-05T15:49:59",
"udf_date_3":"2014-07-05T15:49:59",
"udf_date_4":"2014-08-05T15:49:59",
"contact_information":
{
"action":"NEW",
"type":"PERSON",
"first_name":"Andrew",
"last_name":"Tomas2",
"address_set":
[
{
"type":"HOME",
"street_name":"Thomas V"
}
],
},
"billing_address":
{
"action":"EXISTING",
"type":"HOME"
},
"presentment_preferences_set":
[
{
"presentment_preference_identifier":{"name":"By Email"},
"state":"ACTIVE",
"email":{"action":"NEW","email":{
"type":"BUSINESS",
"email_address":"test@gmail.com"}
}
}
],
"payment_preferences_set":
[
{
"account_holder": "Lucia Papapavlou",
"is_default":true,
"bank_account_number": "001002003",
"payment_preference_identifier":{"alternative_code":"BTP"},
"bank_account_type_identifier":{"alternative_code":"SA"},
"bank_identifier":{"alternative_code":"BOC"},
"bank_branch_identifier":{"name":" BOC 1"},
}
]
}
Response
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"notes": "Marios Lannister\t17/5/2016 11:33:35\tthere are currently no notes",
"udf_float_1": 10,
"udf_float_2": 20,
"credit_period": 2,
"udf_float_3": 30,
"udf_float_4": 40,
"number": "ACR001027",
"name": "Andrew Tomas2",
"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:33:36",
"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": "Marios Lannister",
"username": "MPAdministrator",
"id": "1"
},
"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": "normal account"
}
}
HTTP Method: POST
Request
Body
{
"token":"{{token}}",
"name":"Mike",
"description":"normal account",
"notes": "there are currently no notes",
"vat_number":"10",
"credit_limit" :10,
"credit_period_operator":"PLUS",
"credit_period":2,
"classification_identifier":{"alternative_code":"SA"},
"credit_rating_code":"AAA",
"owned_by_group_identifier":{"name":"Main Group"},
"contact_information":
{
"action":"NEW",
"type":"PERSON",
"first_name":"Mike",
"last_name":"Peterson",
"address_set":
[
{
"type":"HOME",
"street_name":"Thomas V"
}
],
},
"billing_address":
{
"action":"EXISTING",
"type":"HOME"
},
"presentment_preferences_set":
[
{
"presentment_preference_identifier":{"name":"By Email"},
"state":"ACTIVE",
"email":{"action":"NEW","email":{
"type":"BUSINESS",
"email_address":"test@gmail.com"}
}
}
],
"fields_set":"name,type,life_cycle_state,credit_limit_status,credit_limit,presentment_preferences_set,classification,email,billing_address"
}
Response
{
"status": {
"message": "",
"description": "",
"code": "OK"
},
"data": {
"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": "1DC48B413E434BA88CC5133DE8218B19",
"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
},
"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": "D5D6142208764ABC836921331DE0D6C5",
"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": "BUSINESS",
"id": "A446507203C24ECE88445C09BA5C0627",
"email": "test@gmail.com"
},
"phone": null
}
],
"credit_limit": 10,
"life_cycle_state": "ACTIVE",
"classification": {
"id": "DE3DC5FD43B51C09F7E0573B845ABE08",
"name": "Standard Customer",
"alternative_code": "SA"
},
"type": "CUSTOMER",
"name": "Mike",
"credit_limit_status": "NOT_EXCEEDED"
}
}
HTTP Method: POST
Request
Body
{
"token": "{{token}}",
"name": "New Participant account ",
"description": "normal account",
"notes": "there are currently no notes",
"vat_number": "10",
"credit_limit": 10,
"credit_period_operator": "PLUS",
"credit_period": 2,
"credit_rating_code": "AAA",
"owned_by_group_identifier": {
"name": "Main Group"
},
"contact_information": {
"action": "NEW",
"type": "PERSON",
"first_name": "New",
"last_name": "Participant from account ",
"address_set": [
{
"type": "HOME",
"street_name": "Thomas V"
}
]
},
"billing_address": {
"action": "EXISTING",
"type": "HOME"
},
"rewards": {
"sign_up_on":"2019-07-23T17:00:00",
"sign_up_by_unit_identifier":{"name":"Admin Unit"},
"participating_schemes_set":
[
{
"sign_up_on": "2019-07-23T17:00:00" ,
"sign_up_by_unit_identifier":{"name":"Admin Unit"},
"reward_scheme_identifier":{"name":"Main Rewards Scheme"},
"email_address":"test@crm.com",
"reference_code":"test"
}
],
"enable_automatic_spend":true,
"minimum_wallet_balance":10,
"minimum_spend_amount":1,
"maximum_spend_amount":15,
"authorised_rewards_participating_merchants_set":
[
{
"rewards_participating_merchant_identifier":{"unit_identifier":{"name":"Kounta Unit"}}
}
]
}
}
Response
{
"data": {
"notes": "Administrator Company\t23/7/2019 18:22:13\tthere are currently no notes",
"log_information": {
"created_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"created_date": "2019-07-23T18:22:15",
"updated_date": "2019-07-23T18:22:15",
"updated_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
},
"created_by_user": {
"person_name": "Administrator Company",
"id": "1",
"email": "crm@crm.com",
"username": "mpadministrator"
}
},
"payment_preferences_set": [],
"owned_by_group": {
"alternative_code": "MG",
"community_name": "Main Community",
"name": "Main Group",
"description": "Main Group",
"id": "1",
"unified_code": "MG"
},
"custom_field_set": [],
"description": "normal account",
"contact_information": {
"company_profile": null,
"company_name": null,
"name": "New Participant from account",
"last_name": "Participant from account ",
"id": "1DAEA7DF3936465BA95CFDA8261F5A03",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "New",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"passport_number_expiration_date": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CY",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "1604",
"two_character_code": "CY"
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"id_number_expiration_date": null,
"passport_number": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
},
"billing_address": {
"country": {
"alternative_code": "CY",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "1604",
"two_character_code": "CY"
},
"apartment_number": null,
"care_of": null,
"is_primary": true,
"municipality": null,
"type": "HOME",
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"street_name": "Thomas V",
"udf_date_3": null,
"udf_float_3": null,
"udf_float_4": null,
"udf_string_15": null,
"po_box_postal_code": null,
"udf_string_16": null,
"udf_string_13": null,
"udf_string_14": null,
"udf_string_11": null,
"udf_string_12": null,
"id": "B8CCCD2FB9FE4E199E904D4C7F234309",
"udf_string_10": null,
"udf_float_1": null,
"floor": null,
"udf_float_2": null,
"udf_string_2": null,
"area": 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",
"partner_account": false,
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"number": "574",
"udf_float_3": null,
"udf_float_4": null,
"balance": 0,
"is_tax_exempt": false,
"credit_limit": 300,
"credit_period": {
"credit_period_uot": "MONTHS",
"credit_period_operator": "PLUS",
"credit_period": 5,
"credit_period_setting": "X_DAYS_AFTER",
"credit_period_number_of_days": 5
},
"currency": {
"suffix_symbol": null,
"prefix_symbol": "€",
"decimal_part_name": null,
"code": "EUR",
"integer_part_name": null,
"id": "BC91",
"life_cycle_state": "EFFECTIVE"
},
"id": "43A0A6AC627545E5AAB26C089D95A900",
"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": "SC",
"name": "Standard Customer",
"id": "63E096DF859A44ED958007C71F0389E5"
},
"credit_limit_status": "NOT_EXCEEDED",
"parent_account": false,
"credit_rating": {
"code": "AAA",
"name": "key_aaa_-_subject_to_minimal_credit_risk"
},
"name": "New Participant account ",
"outstanding_amount": 0,
"udf_string_6": null,
"udf_string_7": null,
"accounting_period": null,
"access_tokens_set": [],
"udf_string_8": null,
"rewards": {
"participating_schemes_set": [
{
"scheme": {
"alternative_code": "MRS",
"name": "Main Rewards Scheme",
"description": "hello8",
"id": "827918B0190B466FA578B14C080F02B8",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2019-07-23T00:00:00",
"sign_up_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"reference_code": null,
"id": "0A192710F0BF4C90AF97627FEA577597",
"sign_off_on": null
},
{
"scheme": {
"alternative_code": "peri",
"name": "perini",
"description": "testtest",
"id": "517FAE79D1E245EA81611F9ED334AF8F",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2019-07-23T00:00:00",
"sign_up_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"reference_code": null,
"id": "96599EDD9E9B42ACA44CC92FDE1B394D",
"sign_off_on": null
},
{
"scheme": {
"alternative_code": "rsASU",
"name": "Auto Sign Up",
"description": null,
"id": "8BB1192214864338B6D9E402F6148364",
"life_cycle_state": "EFFECTIVE"
},
"sign_up_on": "2019-07-23T00:00:00",
"sign_up_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"reference_code": null,
"id": "90950E78C916414FAA3E69B7BA80A3C7",
"sign_off_on": null
}
],
"sign_up_on": "2019-07-23T17:00:00",
"sign_up_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"custom_field_set": [],
"auto_spend_authorisation": {
"minimum_wallet_balance": 10,
"minimum_spend_amount": 1,
"maximum_spend_amount": 15,
"updated_date": null,
"updated_by_user": null,
"enabled": true,
"authorised_rewards_participating_merchants_set": [
{
"log_information": {
"created_by_unit": {
"alternative_code": "MU",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Main Unit",
"description": "Main Unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Main Community",
"name": "Admin Unit",
"description": "Admin Unit Description",
"id": "B4529D5D06E749B0976A3512EC4AEDE6"
},
"created_date": "2019-06-20T12:36:23",
"updated_date": "2019-07-23T15:41:58",
"updated_by_user": {
"person_name": "j_ioannou",
"id": "816C8875D4C34F8890B7CDD5B8322DBC",
"username": "j_ioannou"
},
"created_by_user": {
"person_name": "Administrator Company",
"id": "1",
"username": "mpadministrator"
}
},
"description": null,
"id": "15B1DD2372EF44F6BDBE842CBA27A2FC",
"life_cycle_state": "EFFECTIVE",
"group": {
"alternative_code": "KG",
"community_name": "Main Community",
"name": "Kounta Group",
"description": null,
"id": "81F45E6C0423483A844ABFE475E734CD",
"unified_code": "KG"
}
}
]
},
"reward_tier": null,
"spend_blocking_state": {
"updated_date": null,
"updated_by_user": null,
"enabled": false
}
}
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}