- Created by George Rossides (Unlicensed) , last modified by Georgia Kountouri on Sept 18, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 22 Next »
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved payment |
| number | String | The number of the retrieved payment |
| reference_number | String | The reference number of the retrieved payment |
| life_cycle_state | String | The state of the retrieved payment which can be one of the following: DRAFT, REJECTED, POSTED, CANCELLED |
| payment_amount | Number | The amount of the payment |
| issued_on | Date | The date that the payment was issued |
| posted_on | Date | The date that the payment was posted |
| received_on | Date | The date that the payment was received |
| notes | String | Shared notes for the payment |
| processed_by_payment_gateway | String | The payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed
|
| payment_gateway_reference_number | String | A reference to the number of the payment that was created on the payment gateway. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed
|
| back_office_code | String | The back office code of the retrieved payment Available from CRM.COM R9.1.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| accounts_receivable | Accounts Receivable Object | The related accounts receivable For releases prior CRM.COM R14.0.0, the related Accounts Receivable Object is retrieved always From CRM.COM R14.0.0 and onwards, Accounts Receivable Object will be retrieved only if the payment was posted against it |
| voucher | Voucher Object | The related voucher Available from CRM.COM R14.0.0 |
| type | Financial transaction type object | The financial transaction type of the payment |
| category | Financial transaction category object | The category of the payment |
| payment_method | Payment method object | The payment method of that payment. |
| received_by_user | User object | The user who actually received the payment. |
| received_by_unit | Unit object | The unit who actually received the payment. |
| rejection_reason | Financial transaction rejection reason object | The reason that the payment was rejected |
| card | Payment Gateway Card Object | The card that was charged by the payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed
|
| payment_preference | Accounts Receivable Payment Preference Object | The accounts receivable payment preference that were used by the payment gateway that processed the payment. This information becomes available only if the selected payment method is included in the payment gateway provider as a linked payment method, or if the payment is already posted and the information was already completed Available from CRM.COM R11.0.0 |
| accounting_period_information | Accounting Period Information object | The accounting period information of the retrieved payment. This is applicable only if the payment was processed within an Accounting Period Closing process run. Available from CRM.COM R10.0.0 |
| currency_rate_period | Currency Rate Period object | The currency rate period based on which the payment's amounts were calculated Available from CRM.COM R10.0.0 |
| invoices_to_pay_set | Set of invoice objects | The invoices that were intended to be paid |
| bills_to_pay_set | Set of bill objects | The bills that were intended to be paid |
| products_to_pay_set | Set of products | The products that were intended to be paid Available from CRM.COM R12.0.0 |
Log Information Object | The log information related with the retrieved payment |
Referred Objects 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
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 Object | The demographics information of the retrieved contact information | |
Company profile object | The company profile of the retrieve contact information |
Referred Objects 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 Available from CRM.COM R14.0.0 |
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 Available from CRM.COM R14.0.0 |
social_security_number | String | The social security number of the retrieved contact information |
Date of Birth Object | The date of birth of the retrieved contact information | |
Name Day Object | The name day of the retrieved contact information | |
Country Object | The country of residence of the retrieved contact information | |
Country Object | The ID issued country of retrieved contact information | |
Country Object | The passport issued country of retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects 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 | Type | Description |
|---|---|---|
day | Integer | The day of the retrieved name day |
month | Integer | The month of the retrieved name day |
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 Available from CRM.COM R15.1.0 |
| 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 Available from CRM.COM R15.1.0 |
Referred Objects 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
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 |
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 |
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 |
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 |
Country Object | The country of residence of the retrieved contact information | |
Industry Object | The industry of retrieved contact information | |
Industry sector Object | The sector of retrieved contact information |
Referred Objects 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 Available from CRM.COM R15.1.0 |
| 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 Available from CRM.COM R15.1.0 |
Referred Objects 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
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 |
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 |
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 |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved voucher |
number | String | The number of the retrieved voucher |
| value | Number | The value of the retrieved voucher |
| extra_added_value | Number | The extra added value of the retrieved voucher From CRM.COM R14.0.0 and onwards this information is only available if the voucher type classification is "Payment Voucher" |
life_cycle_state | String | The life cycle state of the retrieved voucher which can be DRAFT, ACCEPTED_FOR_ACTIVATION, NOT_ACCEPTED_FOR_ACTIVATION, ACTIVATED, USED, CANCELLED, PURGED From CRM.COM R14.0.0 and onwards the applicable life cycle state of the retrieved voucher of type with classification "Refund Voucher" can be ACTIVATED, USED, PURGED |
| type | Voucher Type object | The type information of the retrieved voucher |
| lot | Vouchers Lot Object | The lot of the retrieved voucher From CRM.COM R14.0.0 and onwards this information is available only if the voucher type classification is "Payment Voucher" |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved voucher type |
| name | String | The Name of the retrieved voucher type |
| alternative_code | String | The Alternative Code of the retrieved voucher type |
| value_options | String | Defines if the value should be fixed, as defined in the voucher type, or a variable, as defined during the creation of the vouchers. The supported options are FIXED and VARIABLE From CRM.COM R13.1.0 and onwards for voucher types of classification equal to "Electronic Voucher" the supported option is VARIABLE From CRM.COM R14.0.0 and onwards for voucher types of classification equal to "Refund Voucher" the supported option is VARIABLE |
| classification | String | The Classification of the retrieved voucher type Available from CRM.COM R13.1.0 |
| description | String | The Description of the retrieved voucher type |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved lot |
| number | String | The number of the retrieved lot |
| alternative_code | String | The alternative code of the retrieved lot |
| description | String | The description of the retrieved lot |
| 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 WRITE_OFF classification is available from CRM.COM R13.0.0 |
| 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 |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment method |
name | String | The name of the retrieved payment method |
alternative_code | String | The alternative code of the retrieved payment method |
| description | String | The description of the retrieved payment method |
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 |
String | The email of the retrieved user |
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 |
| 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 |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment gateway card |
payment_gateway_reference_number | String | The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card |
card_holder_name | String | The card holders name, as provided during the registration of the card |
| brand | String | The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways are the following
|
| expiration_month | Number | The card's expiration month, which can be from 1 to 12 |
| expiration_year | Number | The card's expiration year which is a 4 digits number |
| type | String | The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:
|
| last_digits | String | The last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242 |
| consumer_token | String | The consumer token |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved payment preference |
account_holder | String | The account holder of the retrieved payment preference |
bank_account_number | String | The bank account number of the retrieved payment preference |
default | Boolean | Indicates if the retrieved payment preference is the default for the related accounts receivable |
| state | String | Indicates if the retrieved payment preference is active or not. The supported values are ACTIVE or INACTIVE Available from CRM.COM R15.0.0 |
use_for_recurring_payments | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable. Depracated from CRM.COM R16.0.0 (and replaced by opt_in_for_subscriptions). The parameter will still function but it will not be maintained |
opt_in_for_subscriptions | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to its subscriptions. Available from CRM.COM R16.0.0 |
opt_in_for_purchases | Boolean | Indicates if the specific Accounts Receivable Payment Preference will be used to automatically pay any unsettled bills allocated to the related accounts receivable, related to purchases. Available from CRM.COM R16.0.0 |
| notes | String | The notes of the retrieved payment preference object. Available from CRM.COM R10.1.0 |
| payment_medium_identifier | String | The payment medium identifier related with the retrieved payment preference Available from CRM.COM R11.0.0 |
iban | String | The international bank account number Available from CRM.COM R13.1.0 |
business_identifier_code | String | The business identifier code that identifies the bank Available from CRM.COM R13.1.0 |
unique_mandate_reference | Number | The unique reference, which identifies a mandate that was signed by a Debtor for any given Creditor Available from CRM.COM R13.1.0 |
mandate_signing_date | Date | The date that the mandate was signed Available from CRM.COM R13.1.0 |
| mandate_termination_date | Date | The date that the mandate will be terminated. No payments should be send after that date (inclusive) Available from CRM.COM R13.1.0 |
| payment_preference | Payment Preference Object | The payment preference of the retrieved payment preference |
Bank Account Type Object | The bank account type related with the retrieved payment preference | |
Bank Object | The bank related with the retrieved payment preference | |
Bank Branch Object | The bank branch related with the retrieved payment preference | |
| payment_medium_type | Payment Medium Type | The payment medium type related with the retrieved payment preference Available from CRM.COM R11.0.0 |
| payment_medium_brand | Payment Medium Brand | The payment medium brand related with the retrieved payment preference Available from CRM.COM R11.0.0 |
| default_card | Payment Gateway Card Objects | It defines the default payment gateway card that should be used while automatically creating payments against that specific accounts receivable. The default card is also set on payments done using the specific payment preference, although the user can modify this information, by selecting an additional card. |
| cards_set | Set Payment Gateway Card Objects | The set of all payment gateway cards which are related with the specific accounts receivable payment preference |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment preference |
name | String | The name of the retrieved payment preference |
alternative_code | String | The alternative code of the retrieved payment preference |
| type | Sting | The type of the payment preference, such as
BRAINTREE_PAYMENT_GATEWAY and CUSTOM_PAYMENT_GATEWAY are available from CRM.COM R14.2.0 WALLET available from CRM.COM R17.0.0 |
| description | Sting | The description of the retrieved payment preference |
Name | Type | Description |
id | String | The id of the retrieved bank account type |
name | String | The name of the retrieved bank account type |
alternative_code | String | The alternative code of the retrieved bank account type |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved bank |
name | String | The name of the retrieved bank |
alternative_code | String | The alternative code of the retrieved bank |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved bank branch |
name | String | The name of the retrieved bank branch |
alternative_code | String | The alternative code of the retrieved bank branch |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment medium type |
name | String | The name of the retrieved payment medium type |
alternative_code | String | The alternative code of the retrieved payment medium type |
| description | String | The description of the retrieved payment medium type |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment medium brand |
name | String | The name of the retrieved payment medium brand |
alternative_code | String | The alternative code of the retrieved payment medium brand |
| description | String | The description of the retrieved payment medium brand |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment gateway card |
payment_gateway_reference_number | String | The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card |
card_holder_name | String | The card holders name, as provided during the registration of the card |
| brand | String | The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways are the following
|
| expiration_month | Number | The card's expiration month, which can be from 1 to 12 |
| expiration_year | Number | The card's expiration year which is a 4 digits number |
| type | String | The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:
|
| last_digits | String | The last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242 |
| consumer_token | String | The consumer token |
Name | Type | Description |
|---|---|---|
default | Boolean | Indicates if the retrieved payment gateway card is the default for the related accounts receivable payment preference |
Payment Gateway Card Object | The represented payment gateway card |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved payment gateway card |
payment_gateway_reference_number | String | The card's reference number as provided by the payment gateway. This number is used to submit transactions on the payment gateway that will be processed using that card |
card_holder_name | String | The card holders name, as provided during the registration of the card |
| brand | String | The card's brand, as provided by the payment gateway provider. The supported brands by the payment gateways are the following
|
| expiration_month | Number | The card's expiration month, which can be from 1 to 12 |
| expiration_year | Number | The card's expiration year which is a 4 digits number |
| type | String | The type of the card, as provided by the payment gateway provider. The supported types by the payment gateway are the following:
|
| last_digits | String | The last 4 digits of the card as provided by the payment gateway provider. Those digits are masked with 12 asterisk characters for example **** ***** ***** 4242 |
| consumer_token | String | The consumer token |
Name | Type | Description |
|---|---|---|
accounting_period_date | Date | The Date on which the Accounting Period was set on the financial transaction |
Accounting Period Object | The Accounting Period of the financial transaction. |
Referred Objects 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 |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency rate period |
| rate | Number | The exchange rate of the currency rate period |
| inverse_rate | Number | The inverse exchange rate of the currency rate period |
| from_date | Date | The date from which the exchange rate is valid |
| to_date | Date | The date until which the exchange rate is valid |
| currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved invoice |
number | String | The number of the retrieved invoice |
reference_number | String | The reference number of the retrieved invoice |
life_cycle_state | String | The life cycle state of the invoice. One of the following values is returned: DRAFT, REJECTED, POSTED, CANCELLED |
| issued_on | Date | The date that the invoice was issued |
| posted_on | Date | The date that the invoice was posted |
| due_on | Date | The date that the credit period for that specific invoice is ending. |
| total_amount | Number | The total amount of the invoice |
| outstanding_amount | Number | The total outstanding amount of the invoice |
| unsettled_amount | Number | The total unsettled amount of the invoice |
| currency_rate_period | Currency Rate Period object | The currency rate period based on which the invoice's amounts were calculated Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency rate period |
| rate | Number | The exchange rate of the currency rate period |
| inverse_rate | Number | The inverse exchange rate of the currency rate period |
| from_date | Date | The date from which the exchange rate is valid |
| to_date | Date | The date until which the exchange rate is valid |
| currency | Currency Object | The Currency with which the returned exchange rate information refers to |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved bill |
number | String | The number of the retrieved bill |
life_cycle_state | String | The life cycle state of the bill. One of the following values is returned: POSTED, PRESENTED, PRESENTED_CONFIRMED, PRESENTED_REJECTED |
| from_date | Date | The date from which the accounts receivable is billed for |
| to_date | Date | The date until which the accounts receivable is billed for |
| due_date | Date | The due date of bill. The field is calculated dynamically. The maximum due date of related invoices. Available from CRM.COM R12.4.0 |
| total_billed_amount | Number | The total billed amount |
| total_amount_to_be_paid | Number | The total amount to be paid |
| bill_status | String | The status of the bill in terms of it is settled or not.The supported values are the following: SETTLED, UNSETTLED, PARTIALLY_SETTLED |
| currency | Currency object | The bill's currency Available from CRM.COM R10.0.0 |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0 |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
Name | Type | Description |
|---|---|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product Available from CRM.COM R12.3.0 |
| global_rate | Global Rate Object | The global rate of the retrieved product Available from CRM.COM R15.0.0 |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0 |
Referred Objects Response Data
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
| Name | Type | Description |
|---|---|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following:
From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED |
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between
|
| uot | String | The 'UOT' applicable for the rate
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
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 |
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 | |
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 | |
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 | |
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 | |
Unit Object | The last unit that updated the retrieved record Available from CRM.COM R18.0.0 | |
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
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 |
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 |
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 |
String | The email of the retrieved user |
- No labels