List Sales
Returns all Sales available in the user's ForceManager implementation database.
You will only receive the List of Sales 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 |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
| ExtraFieldDescription | {number} | If equal to "0", the response returns only the value of each Extra Fields, if equal to "1" also the description is returned |
REQUEST
You can apply filters, organise and choose the language and pagination using any query string parameter in SQL. Query string parameters appear after a question mark in the endpoint followed by the parameters and their values. In the query string, each parameter is listed one right after the other with an "and" separating them. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| page | Integer | Define the pagination data for the returned objects |
| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |
| order | String | organise and view the results for a specific attribute in descendent order - at the top the most recent results while the oldest results will be down the list |
| lang | String | Define the language in which you want to receive the response |
You can define the pagination data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.
e.g.
https://api.forcemanager.com/api/v4/sales?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/sales?where= param1=value AND/OR param2=value2
You can also organise and view the results for Sales in descendent order - at the top, the most recent results while the oldest results will be down the list.
e.g.
https://api.forcemanager.com/api/v4/sales?order=VALUE
In the request, and using query string parameters, you can also define the language in which you want to receive the response.
e.g.
https://api.forcemanager.com/api/v4/sales?lang=VALUE
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| accountExtId | String | 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 for 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 |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/sales
- Auth: API key in header X-Session-Key
Headers
Response
List Sales
Changes
No recorded changes to this operation across all 1 revision of this API.