You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 6
Next »
Name | Type | Description |
|---|
id | String | The ID of the retrieved refund |
| number | String | The number of the retrieved refund |
| reference_number | String | The reference number of the retrieved refund |
| life_cycle_state | String | The state of the retrieved refund which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED |
| refund_amount | Number | The total refund amount |
| issued_on | Date | The date that the refund was issued |
| posted_on | Date | The date that the refund was posted |
| notes | String | Shared notes for the refund |
| back_office_code | String | The back office code of the retrieved refund |
| issue_reason | String | A description of the reason that the refund is issued |
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 |
| accounts_receivable | Accounts receivable object | The related accounts receivable |
| type | Financial transaction type object | The financial transaction type of this refund |
| category | Financial transaction category object | The category of the refund |
| rejection_reason | Financial transaction rejection reason object | The reason that the refund was rejected |
| accounting_period | Accounting Period object | The refund's accounting period |
log_information | Log Information Object | The log information related with the retrieved refund |
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 |
financial_transaction_type response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved financial transaction type |
| name | String | The Name of the retrieved financial transaction type |
| alternative_code | String | The Alternative code of the retrieved financial transaction type |
| description | String | The Description of the retrieved financial transaction type |
| classification | Sting | The Classification of the retrieved financial transaction category which can be one of the following: INVOICE, INVOICE_CANCELLATION, CREDIT_NOTE, PAYMENT, PAYMENT_CANCELLATION, REFUND, WRITE_OFF |
financial_transaction_category response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved financial transaction category |
| name | String | The Name of the retrieved financial transaction category |
| code | String | The code of the retrieved financial transaction category |
| description | String | The Description of the retrieved financial transaction category |
rejection_reason response data object
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved financial transaction rejection reason |
| name | String | The Name of the retrieved financial transaction rejection reason |
| alternative_code | String | The Alternative code of the retrieved financial transaction rejection reason |
| description | String | The Description of the retrieved financial transaction rejection reason |
accounting period object response data
Name | Type | Description |
|---|
number | String | The Accounting Period's number |
name | String | The Accounting Period's name |
| from_date | Date | The Accounting Period's from date |
| to_date | Date | The Accounting Period's to date |
| life_cycle_state | Sting | The Accounting Period's life cycle state. Available values are OPEN and CLOSED |
| closed_date | Date | The Accounting Period's closed date. Available only for Accounting Periods in Closed life cycle state |
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 |