Versions Compared

Key

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

Available from CRM.COM R14.0.0

Excerpt

This method transfers money from an active wallet to its related accounts receivable or from an active accounts receivable to its related active wallet, if there is enough money.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

mode

(mandatory)

String

It determines if the money transferring will be performed from a wallet to an account or vice versa. The following options are supported:

  • WALLET_TO_ACCOUNT: If this mode is set then it is mandatory to specify a wallet from which the money transfer will be performed. The accounts receivable field is not applicable.
  • ACCOUNT_TO_WALLET: If this mode is set then it is mandatory to specify an accounts receivable from which the money transfer will be performed. The wallet field is not applicable.

wallet_identifier
(
mandatorysemi-optional)

Wallet identifier

The identifier of the wallet from which the money will be transferred. Note that this information is applicable and mandatory only if the mode is set to WALLET_TO_ACCOUNT.

 The allowed wallets identifier fields are the following:

Include Page
V4:wallet_identifier
V4:wallet_identifier

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable from which the money will be transferred. Note that this information is applicable and mandatory only if the mode is set to ACCOUNT_TO_WALLET.

 The allowed accounts receivable identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

amount

(mandatory)

FloatThe amount that will be transferred from the active wallet to its related accounts receivable or from the active accounts receivable to its related active wallet based on the mode selected

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
V4:wallet_complete
V4:wallet_complete

Examples

Expand
titleExample 1

HTTP Method: POST

 

Request:

Body:

Code Block
themeConfluence
languagejs
linenumberstrue
 

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
 

...