You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 3
Next »
GET access_tokens/show
This method returns information related with an access token. A single access token is returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
| access_token_identifier (mandatory) | Access Token identifier | The identifier of the access token that should be returned as a result. The allowed access token identifier fields are the following: Name | Type | Description |
|---|
authentication_code (semi-optional) | String | The authentication code of the access token | identifier (semi-optional) | String | The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code | pass_code (mandatory on conditions) | String | The pass code of the access token, which is applicable and mandatory if the identifier is specified |
|
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
Name | Type | Description |
|---|
id | String | The ID of the retrieved access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| card_masked_number | String | The masked number of the card as provided - Applicable only when the authentication code is related with a credit card
|
| card_last_4_digits | String | The last 4 digits of the card as provided. - Applicable only when the authentication code is related with a credit card
|
| verification_code | String | The verification code of the retrieved access token |
| verified_date | Date | The date that the access token was verified |
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 |
| verified_by_user | User Object | The user that verified the access token |
| rewards_participant | Rewards Participant Object | The rewards participant associated with the access token |
| accounts_receivable | Accounts Receivable Object | The accounts receivable associated with the access token |
| classification | Access Token Classification Object | The classification of the access token |
log_information | Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
rewards participant object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved reward participant |
number | String | The number of the retrieved reward participant |
| life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED. |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the reward participant |
Referred Objects Response Data
accounts_receivable object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
| name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
| account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
contact_information object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
| company_name | Sting | The company name of the retrieved contact information |
demographics | Demographics Object | The demographics information of the retrieved contact information |
company_profile | Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
demographics object response data
Name | Type | Description |
| gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
| id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information |
passport_number | String | The passport number of the retrieved contact information |
| passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information |
social_security_number | String | The social security number of the retrieved contact information |
date_of_birth | Date of Birth Object | The date of birth of the retrieved contact information |
name_day | Name Day Object | The name day of the retrieved contact information |
country_of_residence | Country Object | The country of residence of the retrieved contact information |
id_issued_by_country | Country Object | The ID issued country of retrieved contact information |
passport_issued_by_country | Country Object | The passport issued country of retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
date_of_birth object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
name_day object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
company profile object response data
Name | Type | Description |
| profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
| number_of_employees | Number | The number of employees of the retrieved contact information |
| registration_number | String | The registration number of the retrieved contact information |
| vat_registration_number | String | The vat registration number of the retrieved contact information |
| vat_registered_by | String | The vat registration by of the retrieved contact information |
| vat_registration_date | Date | The vat registration date of the retrieved contact information |
| tax_reference_number | String | The tax referenece number of the retrieved contact information |
registered_in_country | Country Object | The country of residence of the retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
accounts_receivable object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
| name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
| account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
contact_information object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
| company_name | Sting | The company name of the retrieved contact information |
demographics | Demographics Object | The demographics information of the retrieved contact information |
company_profile | Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
demographics object response data
Name | Type | Description |
| gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
| id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information |
passport_number | String | The passport number of the retrieved contact information |
| passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information |
social_security_number | String | The social security number of the retrieved contact information |
date_of_birth | Date of Birth Object | The date of birth of the retrieved contact information |
name_day | Name Day Object | The name day of the retrieved contact information |
country_of_residence | Country Object | The country of residence of the retrieved contact information |
id_issued_by_country | Country Object | The ID issued country of retrieved contact information |
passport_issued_by_country | Country Object | The passport issued country of retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
date_of_birth object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
name_day object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
company profile object response data
Name | Type | Description |
| profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
| number_of_employees | Number | The number of employees of the retrieved contact information |
| registration_number | String | The registration number of the retrieved contact information |
| vat_registration_number | String | The vat registration number of the retrieved contact information |
| vat_registered_by | String | The vat registration by of the retrieved contact information |
| vat_registration_date | Date | The vat registration date of the retrieved contact information |
| tax_reference_number | String | The tax referenece number of the retrieved contact information |
registered_in_country | Country Object | The country of residence of the retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
access token classification object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved classification |
name | String | The name of the retrieved classification |
alternative_code | String | The alternative code of the retrieved classification |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
Examples
Example 1
HTTP Method: GET
Request:
Response:
POST access_tokens/create
This method creates an access token. Single access tokens can be created by each call.
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
authentication_code (optional) | String | The authentication code of the access token that will be created. If not specified then it will be generated automatically. |
identifier (mandatory on conditions) | String | The identifier of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code. |
pass_code (mandatory on conditions) | String | The pass code of the access token that will be created. This information is not mandatory if the system is set up to allow creating access tokens with no identifier and pass code, although it is always mandatory if an identifier was specified. |
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 access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| card_masked_number | String | The masked number of the card as provided - Applicable only when the authentication code is related with a credit card
|
| card_last_4_digits | String | The last 4 digits of the card as provided. - Applicable only when the authentication code is related with a credit card
|
| verification_code | String | The verification code of the retrieved access token |
| verified_date | Date | The date that the access token was verified |
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 |
| verified_by_user | User Object | The user that verified the access token |
| rewards_participant | Rewards Participant Object | The rewards participant associated with the access token |
| accounts_receivable | Accounts Receivable Object | The accounts receivable associated with the access token |
| classification | Access Token Classification Object | The classification of the access token |
log_information | Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
rewards participant object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved reward participant |
number | String | The number of the retrieved reward participant |
| life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED. |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the reward participant |
Referred Objects Response Data
accounts_receivable object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
| name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
| account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
contact_information object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
| company_name | Sting | The company name of the retrieved contact information |
demographics | Demographics Object | The demographics information of the retrieved contact information |
company_profile | Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
demographics object response data
Name | Type | Description |
| gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
| id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information |
passport_number | String | The passport number of the retrieved contact information |
| passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information |
social_security_number | String | The social security number of the retrieved contact information |
date_of_birth | Date of Birth Object | The date of birth of the retrieved contact information |
name_day | Name Day Object | The name day of the retrieved contact information |
country_of_residence | Country Object | The country of residence of the retrieved contact information |
id_issued_by_country | Country Object | The ID issued country of retrieved contact information |
passport_issued_by_country | Country Object | The passport issued country of retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
date_of_birth object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
name_day object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
company profile object response data
Name | Type | Description |
| profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
| number_of_employees | Number | The number of employees of the retrieved contact information |
| registration_number | String | The registration number of the retrieved contact information |
| vat_registration_number | String | The vat registration number of the retrieved contact information |
| vat_registered_by | String | The vat registration by of the retrieved contact information |
| vat_registration_date | Date | The vat registration date of the retrieved contact information |
| tax_reference_number | String | The tax referenece number of the retrieved contact information |
registered_in_country | Country Object | The country of residence of the retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
accounts_receivable object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
| name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
| account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
contact_information object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
| company_name | Sting | The company name of the retrieved contact information |
demographics | Demographics Object | The demographics information of the retrieved contact information |
company_profile | Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
demographics object response data
Name | Type | Description |
| gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
| id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information |
passport_number | String | The passport number of the retrieved contact information |
| passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information |
social_security_number | String | The social security number of the retrieved contact information |
date_of_birth | Date of Birth Object | The date of birth of the retrieved contact information |
name_day | Name Day Object | The name day of the retrieved contact information |
country_of_residence | Country Object | The country of residence of the retrieved contact information |
id_issued_by_country | Country Object | The ID issued country of retrieved contact information |
passport_issued_by_country | Country Object | The passport issued country of retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
date_of_birth object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
name_day object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
company profile object response data
Name | Type | Description |
| profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
| number_of_employees | Number | The number of employees of the retrieved contact information |
| registration_number | String | The registration number of the retrieved contact information |
| vat_registration_number | String | The vat registration number of the retrieved contact information |
| vat_registered_by | String | The vat registration by of the retrieved contact information |
| vat_registration_date | Date | The vat registration date of the retrieved contact information |
| tax_reference_number | String | The tax referenece number of the retrieved contact information |
registered_in_country | Country Object | The country of residence of the retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
access token classification object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved classification |
name | String | The name of the retrieved classification |
alternative_code | String | The alternative code of the retrieved classification |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
Examples
Example 1
HTTP Method: POST
Request:
Body:
Response:
POST access_tokens/update
This method updates reward participants. A single rewards participant 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 |
| access_token_identifier (mandatory) | Access Token identifier | The identifier of the access token that should be updated. The allowed access token identifier fields are the following: Name | Type | Description |
|---|
authentication_code (semi-optional) | String | The authentication code of the access token | identifier (semi-optional) | String | The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code | pass_code (mandatory on conditions) | String | The pass code of the access token, which is applicable and mandatory if the identifier is specified |
|
| | | |
| | | |
| | | |
| | | |
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 access token |
| number | String | The number of the retrieved access token |
| life_cycle_state | String | The state of the retrieved access token which can be one of the following: EFFECTIVE, NOT_EFFECTIVE, PENDING_VERIFICATION |
authentication_code | String | The authentication code of the retrieved access token |
| identifier | String | The identifier of the retrieved access token |
| card_masked_number | String | The masked number of the card as provided - Applicable only when the authentication code is related with a credit card
|
| card_last_4_digits | String | The last 4 digits of the card as provided. - Applicable only when the authentication code is related with a credit card
|
| verification_code | String | The verification code of the retrieved access token |
| verified_date | Date | The date that the access token was verified |
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 |
| verified_by_user | User Object | The user that verified the access token |
| rewards_participant | Rewards Participant Object | The rewards participant associated with the access token |
| accounts_receivable | Accounts Receivable Object | The accounts receivable associated with the access token |
| classification | Access Token Classification Object | The classification of the access token |
log_information | Log Information Object | The log information related with the retrieved access token |
Referred Objects Response Data
rewards participant object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved reward participant |
number | String | The number of the retrieved reward participant |
| life_cycle_state | String | The life cycle state of the rewards participant. Available values are EFFECTIVE and TERMINATED. |
| accounts_receivable | Accounts receivable object | The accounts receivable owned by the reward participant |
Referred Objects Response Data
accounts_receivable object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
| name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
| account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
contact_information object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
| company_name | Sting | The company name of the retrieved contact information |
demographics | Demographics Object | The demographics information of the retrieved contact information |
company_profile | Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
demographics object response data
Name | Type | Description |
| gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
| id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information |
passport_number | String | The passport number of the retrieved contact information |
| passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information |
social_security_number | String | The social security number of the retrieved contact information |
date_of_birth | Date of Birth Object | The date of birth of the retrieved contact information |
name_day | Name Day Object | The name day of the retrieved contact information |
country_of_residence | Country Object | The country of residence of the retrieved contact information |
id_issued_by_country | Country Object | The ID issued country of retrieved contact information |
passport_issued_by_country | Country Object | The passport issued country of retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
date_of_birth object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
name_day object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
company profile object response data
Name | Type | Description |
| profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
| number_of_employees | Number | The number of employees of the retrieved contact information |
| registration_number | String | The registration number of the retrieved contact information |
| vat_registration_number | String | The vat registration number of the retrieved contact information |
| vat_registered_by | String | The vat registration by of the retrieved contact information |
| vat_registration_date | Date | The vat registration date of the retrieved contact information |
| tax_reference_number | String | The tax referenece number of the retrieved contact information |
registered_in_country | Country Object | The country of residence of the retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
accounts_receivable object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved accounts receivable |
number | String | The number of the retrieved accounts receivable |
| name | String | The name of the retrieved accounts receivable |
life_cycle_state | String | The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED |
| account_owner | Contact information object | The contact information owning the accounts receivable |
Referred Objects Response Data
contact_information object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved contact information |
type | String | The type of the retrieved contact information which can be PERSON or COMPANY |
life_cycle_state | String | The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL |
name | String | The full name of the retrieved contact information |
first_name | String | The first name of the retrieved contact information |
middle_name | String | The middle name of the retrieved contact information |
last_name | String | The last name of the retrieved contact information |
title | String | The title of the retrieved contact information |
| company_name | Sting | The company name of the retrieved contact information |
demographics | Demographics Object | The demographics information of the retrieved contact information |
company_profile | Company profile object | The company profile of the retrieve contact information |
Referred Objects Response Data
demographics object response data
Name | Type | Description |
| gender | String | The gender of the retrieved contact information which can be MALE or FEMALE |
id_number | String | The ID number of the retrieved contact information |
| id_number_expiration_date | Date | The ID number's expiration date of the retrieved contact information |
passport_number | String | The passport number of the retrieved contact information |
| passport_number_expiration_date | Date | The passport's expiration date of the retrieved contact information |
social_security_number | String | The social security number of the retrieved contact information |
date_of_birth | Date of Birth Object | The date of birth of the retrieved contact information |
name_day | Name Day Object | The name day of the retrieved contact information |
country_of_residence | Country Object | The country of residence of the retrieved contact information |
id_issued_by_country | Country Object | The ID issued country of retrieved contact information |
passport_issued_by_country | Country Object | The passport issued country of retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
date_of_birth object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved date of birth |
month | Integer | The month of the retrieved date of birth |
year | Integer | The year of the retrieved date of birth |
name_day object response data
Name | Type | Description |
|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
company profile object response data
Name | Type | Description |
| profile_year | Number | The profile year of the retrieved contact information |
annual_turnover | Number | The annual turnover of the retrieved contact information |
established_date | Date | The established date of the retrieved contact information |
| number_of_employees | Number | The number of employees of the retrieved contact information |
| registration_number | String | The registration number of the retrieved contact information |
| vat_registration_number | String | The vat registration number of the retrieved contact information |
| vat_registered_by | String | The vat registration by of the retrieved contact information |
| vat_registration_date | Date | The vat registration date of the retrieved contact information |
| tax_reference_number | String | The tax referenece number of the retrieved contact information |
registered_in_country | Country Object | The country of residence of the retrieved contact information |
industry | Industry Object | The industry of retrieved contact information |
industry_sector | Industry sector Object | The sector of retrieved contact information |
Referred Objects Response Data
country object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved country |
name | String | The name of the retrieved country |
| alternative_code | String | The alternative code of the retrieved country |
| dialing_code | String | The dialing code of the retrieved country |
| two_character_code | String | The two character code of the retrieved country |
| three_character_code | String | The three character code of the retrieved country |
| country_flag | Image Object | The flag of the retrieved country |
Referred Objects Response Data
country_flag object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved country flag |
| file | File Object | The information of the attached file |
Referred Objects Response Data
file object response data
Name | Type | Description |
|---|
| file_name | String | The name of the file |
| file_content_url | String | The url that can be used to access the actual content of the file |
| file_mime_type | String | The mime type of the attached file |
industry object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry |
name | String | The name of the retrieved industry |
code | String | The code of the retrieved industry |
industry sector object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved industry sector |
name | String | The name of the retrieved industry sector |
alternative_code | String | The alternative code of the retrieved industry sector |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
access token classification object response data
Name | Type | Description |
|---|
id | String | The id of the retrieved classification |
name | String | The name of the retrieved classification |
alternative_code | String | The alternative code of the retrieved classification |
log_information object response data
Name | Type | Description |
created_date | Date | The date that the retrieved record was created |
updated_date | Date | The last date that the retrieved record was updated |
created_by_unit | Unit Object | The unit that created the retrieved record |
created_by_business_unit | Unit Object | The unit that created the retrieved record |
created_by_user | User Object | The user that created the retrieved record |
updated_by_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_business_unit | Unit Object | The last unit that updated the retrieved record |
updated_by_user | User Object | The last user that updated the retrieved record |
Referred Objects Response Data
unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved unit |
name | String | The name of the retrieved unit |
group_name | String | The name of the group that the retrieved unit belongs to |
community_name | String | The name of the community that the retrieved unit belongs to |
alternative_code | String | The alternative code of the retrieved unit |
description | String | The description of the retrieved unit |
business unit object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved business unit |
name | String | The name of the retrieved business unit |
| code | String | The code of the retrieved business unit |
| unified_code | String | The unified code of the retrieved business unit |
description | String | The description of the retrieved business unit |
| parent_business_unit_name | String | The name of the parent business unit that the retrieved business unit belongs to |
user object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved user |
username | String | The user name of the retrieved user |
person_name | String | The full name of the retrieved user |
email | String | The email of the retrieved user |
Examples
Example 1
HTTP Method: POST
Request:
Body:
Response: