Rates
Update Rate
This endpoint allows you to update specific information of a Rate. If the specified Rate does not exist, the response will be a "bad request".
You will only be able to update a Rate 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 Rate. In order to update a Rate, 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 |
|---|---|---|
| branchId | Integer | Branch the Rate is assigned to |
| branchVisibility | Array | In which Branch the Rate is visible |
| comments | String | A comment to be added to the Rate |
| currencyId | Integer | Currency type e.g. Dollar, Euro, etc. (see Currencies resource) |
| descriptionBR | String | Rate label in Brasilian Portuguese |
| descriptionDE | String | Rate label in German |
| descriptionDK | String | Rate label in Dutch |
| descriptionEN | String | Rate label in English |
| descriptionES | String | Rate label in Spanish |
| descriptionFR | String | Rate label in French |
| descriptionIT | String | Rate label in Italian |
| descriptionPT | String | Rate label in Portuguese |
| descriptionRU | String | Rate label in Russian |
| descriptionUS | String | Rate label in American English |
| endDate | String | Date when the Rate expires |
| extID | String | External ID of the Rate from a third party system (ERP, CRM, Accounting System) |
| startDate | String | Date when the Rate starts |
RESPONSE
Returns a JSON with information about the Rate just updated.
| Attribute | Type | Description |
|---|---|---|
| Message | String | 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/rates/{ID}
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/rates/{ID}
- Auth: API key in header X-Session-Key
Headers
Acceptstring
Request body
Response
Update Rate
Changes
No recorded changes to this operation across all 1 revision of this API.