...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
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 | |
| server | JIRA at CRM.COM | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution |
| serverId | 1b00a04b-4f64-31f0-b2ee-8f67e19ac21f |
| key | CRMCOM-6761 |
This method returns information related with a usage authorisation request. A single buy in advance request Usage Authorisation is returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| usage_authorisation_identifier (mandatory) | StringUsage Authorisation Identifier | The unique identifier of the usage authorisation related to the usage service. The allowed alert 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 |
Restrictions
- 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 | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST
Request: Response:
|
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 | |
| server | JIRA at CRM.COM |
| columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution | 1b00a04b-4f64-31f0-b2ee-8f67e19ac21f |
| key | CRMCOM-6761 |
This method returns information related with usage authorisation requests that were submitted against a specific subscription. Multiple usage authorisations are returned by each call.
Resource URL
Parameters
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 |
Restrictions
- 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 | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST
Request: Response:
|
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
|
This method creates a usage authorisation. A single usage authorisation can be created by each call.
Resource URL
Parameters
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 authorisation to be created. The allowed subscription identifier fields are the following:
| ||||||
authorisation_amount (mandatory) | Float | The amount of money that the account owner is authorised to consumethe subscriber requests to be authorised | ||||||
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.
Response Data
| Include Page | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||
HTTP Method: POST
Request: Response:
|
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 | |
| server | JIRA at CRM.COM | columns | key,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
| serverId | 1b00a04b-4f64-31f0-b2ee-8f67e19ac21f |
| key | CRMCOM-6761 |
This method cancels an existing usage authorisation. This method can be used only if the specified usage authorisation's life cycle state is set to Blocked. A single usage authorisation can be cancelled by each call.
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
| usage_authorisation_identifier (mandatory) | String | The unique identifier of the usage authorisation to be cancelled. The allowed usage authorisation 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 |
Restrictions
- 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 | ||||
|---|---|---|---|---|
|
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: POST
Request: Response:
|