Skip to end of banner
Go to start of banner

system_accounts_receivable_complete

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Name

Type

Description

id

String

The ID of the retrieved accounts receivable

typeStringThe type of the retrieved accounts receivable which can be CUSTOMER or SYSTEM

number

String

The number of the retrieved accounts receivable

name

String

The name of the retrieved accounts receivable

descriptionStringThe description of the retrieved accounts receivable
notesStringThe 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

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

life_cycle_state

String

The life cycle state of the retrieved accounts receivable which can be ACTIVE, SUSPENDED or TERMINATED

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

Contact Information object

The contact information related with the specified accounts receivable

owned_by_groupGroup objectThe group that is owning the accounts receivable
privacy_levelPrivacy level objectThe accounts receivable privacy level

log_information

Log Information Object

The log information related with the retrieved 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_nameSting

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_dateDate

The ID number's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

passport_number

String

The passport number of the retrieved contact information

passport_number_expiration_dateDate

The passport's expiration date of the retrieved contact information

Available from CRM.COM R14.0.0

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe 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_employeesNumber

The number of employees of the retrieved contact information

registration_number

String

The registration number of the retrieved contact information

vat_registration_numberString

The vat registration number of the retrieved contact information

vat_registered_byString

The vat registration by of the retrieved contact information

vat_registration_date

Date

The vat registration date of the retrieved contact information

tax_reference_numberString

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_codeString

The alternative code of the retrieved country

dialing_codeString

The dialing code of the retrieved country

Available from CRM.COM R15.1.0

two_character_codeString

The two character code of the retrieved country

three_character_codeString

The three character code of the retrieved country

country_flagImage Object

The flag of the retrieved country

Available from CRM.COM R15.1.0

Referred Objects Response Data

 country_flag object response data

Name

Type

Description

id

String

The ID of the retrieved country flag

fileFile ObjectThe information of the attached file

Referred Objects Response Data

 file object response data

 

Name

Type

Description

file_nameStringThe name of the file
file_content_urlStringThe url that can be used to access the actual content of the file
file_mime_typeStringThe 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

 group object response data

Name

Type

Description

id

String

The ID of the retrieved group

name

String

The name of the retrieved group

community_name

String

The name of the community that the retrieved group belongs to

alternative_code

String

The alternative code of the retrieved group

unified_codeString

The unified code of the retrieved group

Available from CRM.COM R16.2.2

description

String

The description of the retrieved group

 privacy_level object response data

Name

Type

Description

id

String

The id of the retrieved privacy level

numberStringThe number of the retrieved privacy level

name

String

The name of the retrieved privacy level

hierarchy_level

String

The hierarchy level of the retrieved privacy level

 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

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

created_by_business_unit

Unit Object

The unit that created the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Available from CRM.COM R18.0.0

created_by_user

User Object

The user that created the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

updated_by_unit

Unit Object

The last unit that updated the retrieved record

From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled

Deprecated from CRM.COM R18.0.0

updated_by_business_unit

Unit Object

The last unit that updated the retrieved record

Available from CRM.COM R18.0.0

updated_by_user

User Object

The last user that updated the retrieved record

From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

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

codeStringThe code of the retrieved business unit
unified_codeString

The unified code of the retrieved business unit

description

String

The description of the retrieved business unit

parent_business_unit_nameStringThe 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

  • No labels