POST wallet_transactions/create
This method creates a wallet transaction. Single transaction can be created by each call.
Resource URL
http://host_name/crmapi/rest/$version/wallet_transactions/create
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
wallet_identifier (mandatory) | Wallet Identifier | The identifier of the wallet related with the wallet transaction to be created. The allowed wallet identifier fields are the following:
| ||||||||||||
to_wallet_identifier (semi-optional) | Wallet Identifier | The mandatory identifier of the wallet to which the amount will be transferred to, but only in Wallet Transfer Transactions. The allowed wallet identifier fields are the following:
Available from CRM.COM R9.0.0 | ||||||||||||
type_identifier | Wallet Transaction Type identifier | The identifier of the type, classified as debit, credit, reimburse or wallet transfer, which will be used by the wallet transaction to be created. The allowed wallet transaction type identifier fields are the following:
| ||||||||||||
amount | Number | The total amount of the wallet transaction in wallet currency | ||||||||||||
alternative_amount (semi-optional) | Number | The total amount of the wallet transaction in wallet alternative currency Available from CRM.COM R14.2.0 | ||||||||||||
extra_added_amount | Number | An extra added amount that will affect the wallet balance on crediting the wallet, but will not be taken into consideration during various processes such as reimbursing the wallet or invoicing the related accounts receivable. This information is applicable only for credit wallet transactions. Amount should be specified in wallet currency. | ||||||||||||
extra_added_atlernative_amount | Number | An extra added amount that will affect the wallet balance on crediting the wallet, but will not be taken into consideration during various processes such as reimbursing the wallet or invoicing the related accounts receivable. This information is applicable only for credit wallet transactions. Amount should be specified in wallet alternative currency. | ||||||||||||
expiration_date (optional) | Date | The date that the amount that the wallet will be credited for will expire. This information is applicable only if the specified wallet transaction type is classified as Credit or Wallet transfer | ||||||||||||
intended_currency_identifier (optional) | Currency Identifier | The currency that the user was intended to use for the wallet transaction. If specified then it is validated against the currency of the specified wallet and if they don't match then an error is thrown. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:
| ||||||||||||
notes (optional) | String | The notes of the wallet transaction | ||||||||||||
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_string_9 | String | User Defined Field of type String | ||||||||||||
udf_string_10 | String | User Defined Field of type String | ||||||||||||
udf_string_11 | String | User Defined Field of type String | ||||||||||||
udf_string_12 | String | User Defined Field of type String | ||||||||||||
udf_string_13 | String | User Defined Field of type String | ||||||||||||
udf_string_14 | String | User Defined Field of type String | ||||||||||||
udf_string_15 | String | User Defined Field of type String | ||||||||||||
udf_string_16 | 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_float_5 | Float | User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards | ||||||||||||
udf_float_6 | Float | User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards | ||||||||||||
udf_float_7 | Float | User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards | ||||||||||||
udf_float_8 | Float | User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards | ||||||||||||
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 | ||||||||||||
udf_date_5 | Date | User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards | ||||||||||||
udf_date_6 | Date | User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards | ||||||||||||
udf_date_7 | Date | User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards | ||||||||||||
udf_date_8 | Date | User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards | ||||||||||||
(optional) | Debit Wallet Transaction Allotments Object | This information is available and applicable only for debit wallet transactions. Wallet transaction allotments are used to restrict the consumption of the amount that the wallet will be credited for. Only a single wallet allotment can be specified | ||||||||||||
products_set | Set of Wallet Transaction Products Objects | Set of wallet transaction products used to keep track of the products that resulted to the wallet transaction amount | ||||||||||||
allotments_set | Set of Credit Wallet Transaction Allotments Objects | This information is available and applicable only for credit wallet transactions. Wallet transaction allotments are used to restrict the consumption of the amount that the wallet will be credited for. Multiple credit wallet allotments can be 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 |
Referred Objects Response Data
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 wallet transaction |
number | String | The number of the retrieved wallet transaction |
amount | Number | The total amount of the wallet transaction in wallet currency |
alternative_amount | Number | The total amount of the wallet transaction in wallet alternative currency |
extra_added_amount | Number | An extra added amount that will only affect the wallet balance on crediting the wallet in wallet currency |
extra_added_alternative_amount | Number | An extra added amount that will only affect the wallet balance on crediting the wallet in wallet alternative currency |
notes | String | The notes for the retrieved wallet transaction |
life_cycle_state | String | The life cycle state of the retrieved wallet transaction. Supported values are EFFECTIVE and VOIDED |
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_string_9 | String | User Defined Field of type String |
udf_string_10 | String | User Defined Field of type String |
udf_string_11 | String | User Defined Field of type String |
udf_string_12 | String | User Defined Field of type String |
udf_string_13 | String | User Defined Field of type String |
udf_string_14 | String | User Defined Field of type String |
udf_string_15 | String | User Defined Field of type String |
udf_string_16 | 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_float_5 | Float | User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards |
udf_float_6 | Float | User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards |
udf_float_7 | Float | User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards |
udf_float_8 | Float | User Defined Field of type Float Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards |
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 |
udf_date_5 | Date | User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards |
udf_date_6 | Date | User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards |
udf_date_7 | Date | User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards |
udf_date_8 | Date | User Defined Field of type Date Available from CRM.COM R11.6.0, CRM.COM R12.2.0 and CRM.COM R13.0.0 onwards |
caused_by_entity | String | The name of the entity that caused the creation of the wallet transaction. The supported values are the following:
Available from CRM.COM R10.1.0 |
caused_by_entity_id | String | The id of the entity that caused the creation of the wallet transaction. Available from CRM.COM R10.1.0 |
wallet_balance_date | Date | The date on which the wallet transaction's amount was included in the Wallet's balance calculation for a specific wallet balance period Available from CRM.COM R12.1.0 |
type | Wallet Transaction Type Object | The type of the retrieved wallet transaction |
wallet | Wallet Object | The wallet related with the retrieved wallet transaction |
to_wallet | Wallet Object | The wallet to which money is transferred to through the retrieved wallet transaction. Applicable only for Wallet Transfer Transactions Available from CRM.COM R9.0.0 |
voided_by_wallet_transaction | Wallet Transaction Object | The wallet transaction that voided the retrieved wallet transaction |
transferred_by_wallet_transaction | Wallet Transaction Object | The wallet transaction through which money was transferred to another wallet. Applicable only when the wallet transaction is related to another Wallet Transaction with classification Transfer Available from CRM.COM R9.0.0 |
initiated_by_wallet_transaction | Wallet Transaction Object | The wallet transaction that initiated the creation of the retrieved wallet transaction. Available from CRM.COM R15.0.0 |
log_information | Log Information Object | The log information of the retrieved wallet transaction |
initiated_currency | Currency Object | The currency in which the wallet transaction was initiated in |
currency_rate_period | Currency Rate Period | The currency rate period of the wallet transaction Available from CRM.COM R10.0.0 |
wallet_balance_period | Wallet Balance Period Object | The wallet balance period in which this wallet transaction was included. Available from CRM.COM R12.1.0 |
products_set | Set of Wallet Transaction Products Objects | Set of wallet transaction products used to keep track of the products that resulted to the wallet transaction amount |
Referred Objects Response Data