Orders / Entity
Get Order Header
This endpoint retrieves data of a specific Order Header based on JSON input. The API returns a single Header available to the user, according to the unique ID provided. If the specified Order Header does not exist, the response will be a "bad request".
You will only receive the Order Header 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 Order Header |
RESPONSE
| 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) |
| 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 |
get/salesorders/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/salesorders/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
X-FM-Entity-Countstring
Response
Get Order Header
Changes
No recorded changes to this operation across all 1 revision of this API.