Available from CRM.COM R14.0.0
This method transfers money from an 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 | ||||||||||||
accounts_receivable_identifier (mandatory) | Accounts Receivable Identifier | The identifier of the accounts receivable from which the money will be transferred. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
amount (mandatory) | Float | The amount that will be transferred from the accounts receivable to its related active wallet | ||||||||||||
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
Name | Type | Description |
|---|---|---|
wallet_balance | Number | The balance of the wallet after the transfer |
| accounts_receivable_balance | Number | The balance of the account after the transfer |
Wallet Transaction object | The wallet transaction that was created during the transfer | |
| invoice | Invoice object | The invoice that was created during the transfer |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable_identifier":{"number":"ACR0000000512"},
"amount":10
}
Response:
{
"data": {
"wallet_balance": 40,
"invoice": {
"posted_on": "2017-09-05T14:27:45",
"number": "I00003672",
"total_amount": 10,
"unsettled_amount": null,
"issued_on": "2017-09-05T14:27:44",
"currency_rate_period": {
"from_date": "2017-08-21 18:02:15.0",
"to_date": null,
"rate": 0.84,
"inverse_rate": 1.190476,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9",
"life_cycle_state": "EFFECTIVE"
},
"id": "99D527123ADE4116B72689B157EB7166"
},
"id": "7B22BA1B97B349CFBB239580F4BCDE10",
"life_cycle_state": "POSTED",
"outstanding_amount": null,
"reference_number": "8122",
"due_on": "2017-09-12T00:00:00"
},
"wallet_transaction": {
"number": "67607",
"amount": 10,
"wallet": {
"number": "W0000007360",
"accounts_receivable": {
"number": "ACR0000000512",
"name": "Marina Test Acc2",
"id": "B34AFB749B4147269AE2D2D9F1D179C4",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Anton",
"id": "E6B41F80110B4B9293A3552253571A76",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Marina",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": "546712",
"gender": "FEMALE",
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "CD23F0205A9042CE89FD786CD45E79D2",
"life_cycle_state": "EFFECTIVE"
},
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"group_name": "Main Group",
"community_name": "Community",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2017-09-05T14:27:45",
"updated_date": "2017-09-05T14:27:45",
"updated_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
}
},
"caused_by_entity": null,
"currency_rate_period": {
"from_date": "2017-08-21 18:02:15.0",
"to_date": null,
"rate": 0.84,
"inverse_rate": 1.190476,
"currency": {
"suffix_symbol": null,
"prefix_symbol": "£",
"decimal_part_name": null,
"code": "GBP",
"integer_part_name": null,
"id": "9",
"life_cycle_state": "EFFECTIVE"
},
"id": "99D527123ADE4116B72689B157EB7166"
},
"id": "55D6A0BAB46D4B958935328CF229A46C",
"life_cycle_state": "EFFECTIVE",
"extra_added_amount": null,
"type": {
"alternative_code": "CI",
"name": "Credit Invoice",
"description": null,
"id": "620AABC4DA0A4F3880FB058D8771620F",
"classification": "CREDIT"
},
"caused_by_entity_id": null
},
"accounts_receivable_balance": 0
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}