Orders / Entity
Update Order Header
This endpoint allows you to update a specific Order Header. If the specified Header does not exist, the response will be a "bad request".
You will only be able to update an 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
This endpoint allows updating the information of a specific Order Header. In order to update an Header, you just have to specify the attributes you want to modify and complete with the up to date information. It is not necessary to send all attributes.
| Attribute | Type | Description |
|---|---|---|
| accountAddressId | Integer | Account's address to which the Order is linked to (see Address resource) |
| accountId | Integer | 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 | Integer | 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 | Integer | Contact to which the Order Header is linked to (see Contacts resource) |
| currencyId | Integer | 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 |
| mainSalesorder | Boolean | If true, the Order is relevant for the linked opportunity |
| opportunityId | Integer | Opportunity to which the Order is linked to (see Opportunities resource) |
| rateId | Integer | 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 | Integer | User responsible for the Order |
| statusId | Integer | Status of the Order (see Statues resource) |
| total | Number | Total amount of the Order |
| year | Integer | Year when the Order was created |
RESPONSE
Returns a JSON with information about the Order Header just updated.
| Attribute | Description |
|---|---|
| Message | Shows the operation status |
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 |
put/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
Request body
Response
Update Order Header
Changes
No recorded changes to this operation across all 1 revision of this API.