POST accounts_receivable/assets/transfer_ownership
Available from CRM.COM R13.0.0
This method is used when an Accounts Receivable Asset is moved from one Accounts Receivable to another because of a transfer of ownership. Multiple assets can be moved through each call but only as long as they are transferred to the same account owner. The method returns a list of all of the accounts receivable assets which were successfully transferred to another accounts receivable.
Resource URL
Parameters
Name | Type | Description | ||||||||||||||||||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||||||||||||||||||
| accounts_receivable_identifier (mandatory) | Account receivable Identifier | The identifier of the account receivable that owns the assets whose ownership will be transferred to another accounts receivable. The allowed account receivable identifier fields are the following:
| ||||||||||||||||||||||||||||||
| transfer_to_accounts_receivable_identifier (mandatory) | Account receivable Identifier | The identifier of the account receivable to which the ownership of the assets will be transferred to. The allowed account receivable identifier fields are the following:
| ||||||||||||||||||||||||||||||
accounts_receivable_assets_set (mandatory) | Set of Accounts Receivable Assets | A set of accounts receivable assets which will be transferred to another accounts receivable by this call. All specified assets should be owned by the specified accounts receivable | ||||||||||||||||||||||||||||||
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 |
Referred Parameter Objects
Response Data
Name | Type | Description |
|---|---|---|
| id | String | The id of the physical good sale |
| sales_method | String | The sales method that was used while selling the installed item, which can be DIRECT_SALE, INDIRECT_SALE or PRE_SALE |
| performed_date | Date | The date that the installed item was provided to the customer |
| return_date | Date | The date on which the purchased physical good was returned or replaced |
| transfer_date | Date | The date on which the purchased physical good's ownership was transferred to another account owner Available from CRM.COM R13.0.0 |
| accounts_receivable | Accounts Receivable Object | The Accounts Receivable that owns or used to own the specified physical good. Available from CRM.COM R13.0.0 |
| ownership_transferred_to | Accounts Receivable Object | The Accounts Receivable to which the purchased physical good's ownership was transferred to. Applicable only if sales method is set to Transfer of Ownership. Available from CRM.COM R13.0.0 |
| ownership_transferred_from
| Accounts Receivable Object | The Accounts Receivable from which the purchased physical good's ownership was transferred from. Applicable only if sales method is set to Transfer of Ownership. Available from CRM.COM R13.0.0 |
| performed_by_user | User Object | The user that provided the installed item to the customer |
| returned_by_user | User Object | The user that performed the physical good's return or replacement |
| transferred_by_user | User Object | The user that performed the physical good's transfer of ownership to another account owner Available from CRM.COM R13.0.0 |
| product | Product Object | The purchased physical good |
| installed_item | Installed Item Object | The purchased installed item |
| invoice | Invoice Object | The invoice that was posted for the purchased physical good |
| credit_note | Credit Note Object | The credit note that was posted when the purchased physical good is returned. |
| stock_out_warehouse_transaction | Warehouse Transaction Object | The stock out warehouse transaction that was applied in order to move the installed item out of the warehouse while selling it to the customer |
| stock_in_warehouse_transaction | Warehouse Transaction Object | The stock in warehouse transaction that was applied in order to move back to a warehouse a purchased physical good which is returned by the customer |
| job | Job Object | The Job through which the physical goods was sold to the account owner |
Referred Objects Response Data
Examples
HTTP Method: POST
{{server}}/crmapi/rest/v2/accounts_receivable/assets/transfer_ownership
Request:
Response:
{
"data": [
{
"ownership_transferred_to": {
"number": "ACR0000012152",
"name": "ACR0000012152",
"id": "5F83167A0F1745E7821590B95365B694",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "7002_1_6_1",
"id": "2979BB173D1D496AABA16ACEC63D4538",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Test",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"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
}
}
},
"product": {
"code": "Decoder",
"product_type": {
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "D",
"composition_method": "FLAT",
"name": "Decoder",
"description": null,
"id": "719BA4754DDD44B394F02E87F8247369",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "D",
"description": "a",
"id": "B9ED693B156A4F2B97FFA2184DA56E66"
},
"performed_date": "2017-06-29T19:45:46",
"performed_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"transferred_by_user": {
"person_name": "CRM COM",
"id": "1",
"email": "dev@crm.com",
"username": "MPAdministrator"
},
"stock_in_warehouse_transaction": null,
"ownership_transferred_from": {
"number": "ACR0000001036",
"name": "ACR0000001036",
"id": "17EAD08FF1C74028B0CA7210B83F3336",
"life_cycle_state": "ACTIVE"
},
"accounts_receivable": {
"number": "ACR0000012093",
"name": "ACR0000012093",
"id": "03DA4190DB6E42F08E1A372197B0D90C",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": null,
"last_name": "Ioannou1",
"id": "D9FE4C817BE24DBBB7FCE1B56A698696",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Marios",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "CYP",
"three_character_code": "CYP",
"name": "CYPRUS",
"id": "181",
"two_character_code": "CY"
},
"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
}
}
},
"transfer_date": "2017-06-29T20:01:12",
"credit_note": null,
"installed_item": {
"product": {
"code": "Decoder",
"product_type": {
"service_type": null,
"used_for_provisioning": true,
"alternative_code": "D",
"composition_method": "FLAT",
"name": "Decoder",
"description": null,
"id": "719BA4754DDD44B394F02E87F8247369",
"classification": "PHYSICALGOODS",
"physical_good_type": "TRACEABLE"
},
"alternative_code": "D",
"description": "a",
"id": "B9ED693B156A4F2B97FFA2184DA56E66"
},
"alternative_code": "1323232321",
"serial_number": "pk_decod31",
"id": "2487BFB93E4C410BBFC44C026C5ACDF7",
"state": "EFFECTIVE"
},
"sales_method": "DIRECT_SALE",
"returned_by_user": null,
"id": "1C0CB562B0F2428F84419367F4E7C922",
"invoice": null,
"job": {
"number": "J00001000",
"description": null,
"rating_state": "COMPLETED",
"accounts_receivable": {
"number": "ACR0000012245",
"name": "ACR0000012245",
"id": "9B8C4D865CA640FFB1E0FDC47E4EC973",
"life_cycle_state": "ACTIVE"
},
"id": "35F67FB92D384B8FB2858E866D674B96",
"life_cycle_state": "COMPLETED",
"type": {
"billing_method": "BILL_ON_STARTING_PROGRESS",
"alternative_code": "BOOG",
"name": "Based On Ordered GP (PK)",
"fulfillment_scope": "GENERIC_PURPOSE",
"description": null,
"fulfillment_method": "BASED_ON_ORDERED_ITEMS",
"id": "E07903E59A514603B351E18A8B13B2EB",
"billing_directive": "BILLABLE"
}
},
"stock_out_warehouse_transaction": null,
"return_date": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}