| Table of Contents |
|---|
| minLevel | 1 |
|---|
| maxLevel | 3 |
|---|
| outline | false |
|---|
| style | default |
|---|
| type | list |
|---|
| printable | false |
|---|
|
...
| Operation/Type of operation | Behavior | Examples |
|---|
| 1 | Any operation that creates a customer resource. | If business_entity_id is provided, the customer resource is created and linked to it. If business_entity_id is not provided, the customer resource is created under the default business entity of the site.
| |
| 2 | Create a resource other than customer | If business_entity_id is provided, and it is the same as that linked to the target resource: the resource is created and linked to the business entity provided. If business_entity_id is provided, and it is not the same as that linked to the target resource, a 404 Not Found response is sent because the resource cannot be found in the context of the business entity specified. If business_entity_id is not provided, the resource is created and linked to the business entity of the target resource.
| |
| 3 | Update/delete a resource | If business_entity_id is provided, and it is the same as that linked to theresource, the operation proceeds successfully. If business_entity_id is provided, and it is not the same as that linked to the resource, a 404 Not Found response is sent because the resource cannot be found in the context of the business entity specified. If business_entity_id is not provided, the operation proceeds successfully.
| |
| 4 | List resources | If business_entity_id is provided, then only those resources linked to the business entity are returned since the context of the operation is now restricted to the business entity specified. If business_entity_id is not provided,then all resources in the site are returned.
| |
| 5 | Retrieve a resource | If business_entity_id is provided, and it is the same as that linked to theresource, the resource is retrieved successfully. If business_entity_id is provided, and it is not the same as that linked to the resource, a 404 Not Found response is sent because the resource cannot be found in the context of the business entity specified. If business_entity_id is not provided, the resource is retrieved successfully.
| |
Terminology
This section defines some useful terms for describing how business entities work.
...
| 1 | resource_type[<operator>]
| Status |
|---|
| colour | Purple |
|---|
| title | string filter |
|---|
|
Filter business_entity_transfer resources based on resource_type.| Tip |
|---|
Tip Use this filter along with active_resource_id[<operator>] to retrieve the history of all the business entity transfers for a resource. |
|
| 2 | resource_id[<operator>]
| Status |
|---|
| colour | Purple |
|---|
| title | string filter |
|---|
|
Filter business_entity_transfer resources based on resource_id. |
| 3 | active_resource_id[<operator>]
| Status |
|---|
| colour | Purple |
|---|
| title | string filter |
|---|
|
Filter business_entity_transfer resources based on active_resource_id. | Tip |
|---|
Tip Use this filter along with resource_type[<operator>] to retrieve the history of all the business entity transfers for a resource. |
|
| 4 | created_at[<operator>]
| Status |
|---|
| colour | Purple |
|---|
| title | unix time in seconds filter |
|---|
|
Filter business_entity_transfer resources based on created_at.
Supported operators : after, before, on, between Example → created_at[after] = "1702022464" |
Returns
| Attribute | Description |
|---|
| 1 | business_entity_transfer
| | Status |
|---|
| colour | Blue |
|---|
| title | always returned |
|---|
|
Resource object representing business_entity_transfer. |
| 2 | next_offset
|
This attribute is returned only if more resources are present. To fetch the next set of resources use this value
for the input parameter offset. |