Sales
Get Sale
This endpoint retrieves data of a specific Sale based on JSON input. The API returns a single Sale available to the user, according to the unique ID provided. If the specified Sale does not exist, the response will be a "bad request".
You will only receive the Sale after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
REQUEST
| Parameter | Type | Description |
|---|---|---|
| id | Integer | The unique and specific identifier of the Sale |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| accountExtId | Object, Null | External ID of the Account from a third party system (ERP, CRM, Accounting System) |
| accountId | Object, Null | Account to which the Sale is linked to |
| date | String | The Sale's date |
| dateCreated | String | Date and time when the Sale was created |
| dateDeleted | String | Date and time when the Sale was deleted |
| dateUpdated | String | Date and time when the Sale was last updated |
| deleted | boolean | If true, the Sale has been deleted and archived |
| extId | String | External ID of the Sale from a third party system (ERP, CRM, Accounting System) |
| id | Integer | Unique identifier of the Sale in ForceManager |
| salesRepExtId | Object, Null | External ID of the User from a third party system (ERP, CRM, Accounting System) |
| salesRepId | Object, Null | User responsible for the Sale |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Sale |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Sale |
| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Sale |
| total | Number | Total amount of the Sale |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
get/sales/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/sales/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Response
Get Sale
Changes
No recorded changes to this operation across all 1 revision of this API.