Legal Entities Endpoints
The below endpoints have been implemented to allow data manipulation operations on customer records such as creating or updating legal entity or individual customers, addresses, customer representatives, and groups.
For endpoints that are used for private individuals customers, see the Private Individuals Endpoints page.
FTOS_ACC_CB_AddUpdateLegalEntityCustomer
This endpoint replaces the FTOS_CB_AddUpdateLegalEntityCustomer endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.
Adds or updates a record in the Account entity representing a legal entity customer. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
The FTOS_ACC_CB_AddUpdateLegalEntityCustomer endpoint is called from within the callAction endpoint. Visit the callAction page for more details.
{
"Request": {
"ActionName": "FTOS_ACC_CB_AddUpdateLegalEntityCustomer",
"Data": "{"CustomerInfo":{"customerInternalId":"<customerInternalId>","name":"<name> ","email":"<email>","mobilePhone":"<mobilePhone>","uniqueID":"<uniqueID>","industry":"<industry>","registrationNumber":"<registrationNumber>","emailAddressType":"<emailAddressType>","phoneNumberType":"<phoneNumberType>","accountType":"<accountType>"}}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| name | Mandatory. The name of the legal entity customer. |
| UniqueID | Mandatory. The legal entity's unique ID. |
| industry | The industry of the legal entity customer. |
| accountType | Mandatory. The legal entity's account type. |
| customerInternalId | Optional. The customer's internal ID. |
| Optional. The email address of the legal entity customer. | |
| mobilePhone | Optional. The mobile phone number of the legal entity customer. |
| emailAddressType | Optional. The email address type. |
| phoneNumberType | Optional. The phone number type. |
| registrationNo | Optional. The registration number of the legal entity customer. |
Response
The response indicates the result of the code execution, specifically the result of creating or updating a record in the Account entity. If the record is created or updated successfully, the customerInternalID is returned.
FTOS_ACC_CB_AddUpdateCustomerAddress
This endpoint replaces the FTOS_CB_AddUpdateCustomerAddress endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.
Adds or updates a record in the Address entity representing a customer's address. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
The FTOS_ACC_CB_AddUpdateCustomerAddress endpoint is called from within the callAction endpoint. Visit the callAction page for more details.
{
"Request":{
"ActionName":"FTOS_ACC_CB_AddUpdateCustomerAddress",
"Data": "{"AddressInfo":{"addressIdentifier":"<addressIdentifier>","customerInternalId":"<customerInternalId>","addressType":"<addressType> ","country":"<country>","district":"<district>","city":"<city>","streetName":"<streetName>","streetNo":"<streetNo>","buildingNo":"<buildingNo>","floorNo":"<floorNo>","apartmentNo":"<apartmentNo>","postalCode":"<postalCode>"}}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| addressType | Mandatory. The type of the address. |
| country | Mandatory. The country of the address. |
| district | Mandatory. The district of the address. |
| city | Mandatory. The city of the address. |
| streetName | Mandatory. The street name of the address. |
| streetNo | Mandatory. The street number of the address. |
| buildingNo | Optional. The building number of the address. |
| floorNo | Optional. The floor of the address. |
| apartmentNo | Optional. The apartment number of the address. |
| postalCode | Optional. Mandatory. The postal code of the address. |
Response
The response indicates the result of the code execution, specifically the result of creating or updating a record in the Account entity. If the record is created or updated successfully, the addressIdentifier is returned.
FTOS_ACC_CB_AddUpdateCustomerRepresentative
This endpoint replaces the FTOS_CB_AddUpdateCustomerRepresentative endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.
Adds or updates a record in the AccountRelContact entity representing a customer's representative. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
The FTOS_ACC_CB_AddUpdateCustomerRepresentative endpoint is called from within the callAction endpoint. Visit the callAction page for more details.
{
"Request":{
"ActionName":"FTOS_ACC_CB_AddUpdateCustomerRepresentative",
"Data": "{"CustomerRepresentativeInfo":{"customerInternalId":"<customerInternalId>","customerRepresentativeIdentifier":"<customerRepresentativeIdentifier>","customerRepresentativeNo":"<customerRepresentativeNo>","accountRelationType":"<accountRelationType>"}}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Optional. The customer's internal ID. |
| customerRepresentativeNo | Mandatory. The id of the customer representative. |
| accountRelationType | Mandatory. The relation type of the representative. Check theDependenciespage for possible values. |
| customerRepresentativeIdentifier | Optional. The customer representative identifier. |
Response
The response indicates the result of the code execution, specifically the result of creating or updating a record in the Account entity. If the record is created or updated successfully, the customerRepresentativeIdentifier is returned.
FTOS_ACC_CB_AddUpdateCustomerGroup
This endpoint replaces the FTOS_CB_AddUpdateCustomerGroup endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.
Adds or updates a record in the Account entity representing a customer's group. The isGroup parameter sent via the request body, along with the value of the isGroup attribute at Account entity level, determines the operation performed at the database level.
Syntax
The FTOS_ACC_CB_AddUpdateCustomerGroup endpoint is called from within the callAction endpoint. Visit the callAction page for more details.
{
"Request":{
"ActionName":"FTOS_ACC_CB_AddUpdateCustomerGroup",
"Data": "{"CustomerGroup":{"customerInternalId":"<customerInternalId>","isGroup":<isGroup>,"groupName":"<groupName>"}}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Optional. The customer's internal ID. |
| isGroup | Mandatory. Possible values:true, false. Iftrue, then the customer is marked as a group. |
| groupName | Optional. The name of the group. |
Response
The response indicates the result of the code execution, specifically setting a customer as group and updating the group's information in the Accountentity. If the group is added, removed or updated successfully, the operation parameter returns a corresponding message:
After adding a group:
{"operation": "Customer group added"}After removing a group:
{"operation": "Customer group removed"}After updating a group:
{"operation": "Customer group updated"}This endpoint replaces the FTOS_CB_AddUpdateCustomerGroupMember endpoint. Please refer to the details below on how to use it and adapt your integrations accordingly.
Adds or updates a record in the FTOS_ACC_GroupMember entity representing a customer's group member. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
The FTOS_ACC_CB_AddUpdateCustomerGroupMember endpoint is called from within the callAction endpoint. Visit the callAction page for more details.
{
"Request":{
"ActionName":"FTOS_ACC_CB_AddUpdateCustomerGroupMember",
"Data": "{"CustomerGroupMember":{"customerInternalId":"<customerInternalId>","memberCustomerInternalId":"<memberCustomerInternalId>","ownership":"<ownership>","groupName":"<groupName>"}}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| customerInternalId | Optional. The customer's internal ID. |
| memberCustomerNo | Mandatory. The number of the customer which is a group member. |
| groupName | Optional. The name of the group. |
| ownership | Optional. The member ownership. |
Response
The response indicates the result of the code execution, specifically the result of creating or updating a record in the FTOS_ACC_CB_AddUpdateCustomerGroupMember entity.
FTOS_ACC_CB_UpdateGroupCustomers
Updates a record in the FTOS_ACC_GroupMember entity representing a group customer. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
The FTOS_ACC_CB_UpdateGroupCustomers endpoint is called from within the callAction endpoint. Visit the callAction page for more details.
{
"Request":{
"ActionName":"FTOS_ACC_CB_UpdateGroupCustomers",
"Data": "{\"groupAccountId\":\"<groupAccountId>\",\"customerId\":\"<customerId>\"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| groupAccountId | The group account ID. |
| customerId | The customer ID. |
Response
The response indicates the result of the code execution, specifically the result of updating a record in the FTOS_ACC_CB_AddUpdateCustomerGroupMember entity.
Throw Exception
throwException("This customer belongs to the " + <groupAccountId_displayname> + " group. You cannot associate it with another group.");
FTOS_ACC_CB_DeleteMemberFromGroup
Deletes a record in the FTOS_ACC_GroupMember entity representing a group customer. The set of parameters sent via the request body determines the operation performed at the database level.
Syntax
The FTOS_ACC_CB_DeleteMemberFromGroup endpoint is called from within the callAction endpoint. Visit the callAction page for more details.
{
"Request":{
"ActionName":"FTOS_ACC_CB_DeleteMemberFromGroup",
"Data": "{\"gid\":\"<groupAccountId>\",\"cid\":\"<customerInternalId>\",\"id\":\"<customerId>\",\"mid\":\"<master_customerId>\"}"
},
"ApiInfo":{
"UserName":"<user_name>",
"Token":"<access_token>"
}
}Below is a list of the available parameters:
| Parameter | Description |
|---|---|
| cid | The customer's internal ID. |
| id | The customer ID. |
| mid | The master customer ID. |
Response
The response indicates the result of the code execution, specifically the result of deleting a record in the FTOS_ACC_CB_DeleteMemberFromGroup entity.
Throw Exception
throwException("This customer belongs to the " + <groupAccountId_displayname> + " group. You cannot associate it with another group.");