Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

Jira Legacy
serverJIRA at CRM.COM
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId1b00a04b-4f64-31f0-b2ee-8f67e19ac21f
keyCRMCOM-6761
and should be moved under usage_authorisations Web API documentation after is implemented

This method returns information related with a usage authorisation request.  A single buy in advance request is returned 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 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

Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

...

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

GET accounts_receivable/get_remaining_usage_allowance

Tip

Available from CRM.COM R13.0.0

Note

 The following Web API method is not implemented yet. Is part of

Jira Legacy
serverJIRA at CRM.COM
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId1b00a04b-4f64-31f0-b2ee-8f67e19ac21f
keyCRMCOM-6761
and should be moved under accounts_receivable Web API documentation after is implemented

This method returns information related with an accounts receivable's remaining usage allowance. Information related to a single accounts receivable is returned by each call. 

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Accounts receivable identifier  

The identifier of the accounts receivable for which its remaining usage allowance should be returned as a result. The allowed accounts receivable 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

...

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

POST accounts_receivable/add_member

Tip

Available from CRM.COM R13.0.0

Note

 The following Web API method is not implemented yet. Is part of

Jira Legacy
serverJIRA at CRM.COM
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId1b00a04b-4f64-31f0-b2ee-8f67e19ac21f
keyCRMCOM-6760
and should be moved under accounts_receivable Web API documentation after is implemented

This method adds members on a parent accounts receivable. Both of the accounts (parent and member) should be in an active life cycle state and should not be a member in another account group or a system account. The member account additionally should have the same currency as the parent account and have a different owner compared to the parent account owner.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

parent_account

(mandatory)

...

The parent accounts receivable of the group within which the member account will be added. The available accounts receivable identifiers are the following:

...

funding_scope

(mandatory)

...

The funding scope of the member accounts receivable to be added. Two options are available

  • FULLY_FUNDED
  • PARTIALLY_FUNDED

...

member_account

(mandatory)

...

funded_services

(mandatory)

...

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

...

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

 

POST accounts_receivable/remove_member

Tip

Available from CRM.COM R13.0.0

Note

 The following Web API method is not implemented yet. Is part of

Jira Legacy
serverJIRA at CRM.COM
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId1b00a04b-4f64-31f0-b2ee-8f67e19ac21f
keyCRMCOM-6760
and should be movedunder accounts_receivable Web API documentation after is implemented

This method removes a member account from a parent accounts receivable. 

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

member_account_identifier

(mandatory)

...

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

...

Examples

HTTP Method: POST

 

Request:

Response:

 
Expand
titleExample 1
Code Block
themeConfluence
languagejavascript
linenumberstrue
Panel
nameblue

Child pages (Children Display)
alltrue
excerpttrue