GET usage_authorisation/show
| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Note | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
The following Web API method is not implemented yet. Is part of
|
...
Name | Type | Description |
token | String | The token retrieved from the login method |
| usage_authorisation_identifier (mandatory) | String | The unique identifier of the usage authorisation related to the usage service |
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 |
...
GET usage_authorisation/list
| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Note | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
The following Web API method is not implemented yet. Is part of
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| subscription_identifier (mandatory) | Subscription Identifier | The identifier of the subscription related with the usage authorisations that should be returned as a result. The allowed subscription 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 usage_authorisations/create
| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Note | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
The following Web API method is not implemented yet. Is part of
|
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| parentsubscription_accountidentifier (mandatory) | Accounts Receivable Subscription Identifier | The parent accounts receivable identifier of the group within which the member account will be added. The available accounts receivable identifiers subscription related with the usage authorisation to be created. The allowed subscription identifier fields are the following:
| ||||||
| authorisation_scopeamount | (mandatory)Float | String | The funding scope of the member accounts receivable to be added. Two options are available
| |||||
(mandatory) | Accounts receivable object | The accounts receivable that will be added as a member in an account group. | ||||||
(mandatory) | Set of Product objects | The service or service type or service family that will be funded by the parent accountamount of money that the account owner is authorised to consume | ||||||
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 |
...
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
...
...
Response Data
...
| Include Page | ||
|---|---|---|
|
Response Data
| Include Page | |||
|---|---|---|---|
|
...
POST usage_authorisations/cancel
| Tip |
|---|
Available from CRM.COM R13.0.0 |
| Note | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
The following Web API method is not implemented yet. Is part of
|
...
Name | Type | Description | |||
token | String | The token retrieved from the login method | |||
| memberusage_accountauthorisation_identifier (mandatory) | Accounts receivable identifier | The member accounts receivable that will be removed from the account group. The allowed accounts receivable identifier fields are the following:
| V4:accounts_receivable_identifier | V4:accounts_receivable_identifierStringThe unique identifier of the usage authorisation to be cancelled | |
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 |
...
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Anchor accounts_receivable_add_members referred objects parameters accounts_receivable_add_members referred objects parameters
Referred Objects Response Data
| accounts_receivable_add_members referred objects parameters | |
| accounts_receivable_add_members referred objects parameters |
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
...