List Order Headers
Returns all Order Headers available in the user's ForceManager implementation database.
You will only receive the List of Order Headers 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/salesorders?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/salesorders?where= param1=value AND/OR param2=value2
You can filter Order Headers by dateCreated or accountId, or salesRepId for example.
You can also organise and view the results for Order Headers 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/salesorders?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/salesorders?lang=VALUE
RESPONSE
This endpoint returns information about all Order Headers available in the database.
If you didn't apply any page or count number in the header the default number of records in the response is 50.
List of the supported Order Headers attributes:
| Attribute | Type | Description |
|---|---|---|
| accountAddressId | Object, Null | Account's address to which the Order is linked to (see Address resource) |
| accountId | Object, Null | Account to which the Order Header is linked to (see Accounts resource) |
| archived | Boolean | If true, the Order has been archived |
| blocked | Boolean | If true, the Order has been temporary locked to prevent edits (e.g. when a signature is in progress) |
| branchId | Object, Null | Branch to which the Order has been assigned (see Branches resource) |
| closedDate | String | Date when the Order has been closed |
| comment | String | Comment added to the Order |
| contactId | Object, Null | Contact to which the Order Header is linked to (see Contacts resource) |
| currencyId | Object, Null | Currency type (see Currencies resource) |
| discount1 | Number | First discount that can be applied to the Order, in percents |
| discount2 | Number | Second discount that can be applied to the Order, in percents |
| discount3 | Number | Third discount that can be applied to the Order, in percents |
| discount4 | Number | Fourth discount that can be applied to the Order, in percents |
| extId | String | External ID of the Order from a third party system (ERP, CRM, Accounting System) |
| internalComment | String | Internal comment |
| internalCommentUpdateDate | String | Date when the internal comment was updated |
| internalCommentUpdateSalesRepId | Object, Null | Id of the User who that added the internal comment |
| mainSalesorder | Boolean | If true, the Order is relevant for the linked opportunity |
| opportunityId | Object, Null | Opportunity to which the Order is linked to (see Opportunities resource) |
| rateId | Object, Null | Rate for the Order Header (see Rates resource) |
| readOnly | Boolean | If true, the Order Header cannot be modified or deleted |
| reference | String | Order Header's label |
| number | Integer | Order number (should be sequential and unique in general) |
| salesForcecastDate | String | Forecast date for the Sale |
| salesRepId | Object, Null | User responsible for the Order |
| statusId (Required) | Object, Null | Status of the Order (see Statues resource) |
| salesorderType | Object, Null | Type of the Order (see Type resource) |
| total | Number | Total amount of the Order |
| year | Integer | Year when the Order was created |
| dateCreated | String | Date and time when the Order Header was created |
| dateDeleted | String | Date and time when the Order Header was deleted |
| dateUpdated | String | Date and time when the Order Header was last updated |
| deleted | Boolean | If true, the Order Header has been deleted and archived |
| id | Integer | Unique identifier for the Order Header in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Header |
| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Header |
| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order Header |
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/salesorders
- Auth: API key in header X-Session-Key
Headers
Response
List Order Headers
Changes
No recorded changes to this operation across all 1 revision of this API.