| Tip |
|---|
Available from CRM.COM R4.0.0 |
| Table of Contents | ||
|---|---|---|
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| voucher_identifier (mandatory) | Voucher identifier | The identifier of the voucher that should be returned as a result. The allowed vouchers identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
type_identifier | Voucher type identifier | The identifier of the voucher type related with the vouchers that should be returned as a result. The allowed voucher type identifier fields are the following:
| ||||||
| lot_identifier (semi-optional) | Lot identifier | The identifier of the lot related with the vouchers that should be returned as a result. The allowed lot identifier fields are the following:
| ||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call
| ||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number
| ||||||
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 |
...
This method returns a voucher's secret number. The secret number of a single voucher is returned by each call
| Tip |
|---|
Available from CRM.COM R5.0.0 |
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| voucher_identifier (mandatory) | Voucher identifier | The identifier of the voucher that should be returned as a result. The allowed vouchers identifier fields are the following:
| ||||||
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 |
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
| secret_number (mandatory) | String | The secret number of the voucher that will be used | ||||||||
accounts_receivable_identifier | Accounts receivable identifier | The identifier of the account receivable that the payment should be allocated in. The allowed accounts receivable identifier fields are the following:
| ||||||||
| payment_category_identifier (optional) | Payment category identifier | The identifier of the payment category related with the payment that will be created. The allowed payment category identifier fields are the following:
| ||||||||
notes | Notes Object | The notes for the payment to be created | ||||||||
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.
...
This method returns a random accepted for activation voucher, which is can be selected by the user that is requesting the voucher, and sets the voucher life cycle state to activated. A single voucher is retrieved by each call
| Tip |
|---|
Available from CRM.COM R5.0.0 |
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
type_identifier | Voucher type identifier | The identifier of the voucher type related with the voucher that should be returned as a result. The allowed job type identifier fields are the following:
| ||||||
| lot_identifier (semi-optional) | Lot identifier | The identifier of the lot related with the vouchers that should be returned as a result. The allowed lot identifier fields are the following:
| ||||||
accounts_receivable_identifier (optional) | Accounts Receivable Identifier | The identifier of the accounts receivable that the voucher will be submitted to. The group owning the accounts receivable is filtered against the available vouchers' allowed organisational units. The allowed accounts receivable identifier fields are the following:
| ||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be using the voucher. The group is filtered against the available vouchers' allowed organisational units. The allowed group identifier fields are the following:
| ||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be using the voucher. The unit is filtered against the available vouchers' allowed organisational units. The allowed unit identifier fields are the following:
| ||||||
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 |
...
POST vouchers/retrieve_based_on_secret_number
| Tip |
|---|
Available from CRM.COM R11.0.0 |
This method returns information related with a voucher by specifying the voucher secret number. A single voucher is returned by each call
...
Name | Type | Description |
token | String | The token retrieved from the login method |
| secret_number (mandatory) | String | The secret number of the voucher that should be returned as a result.
|
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 |
...