Rates
Get Rate
This endpoint retrieves data of a specific Rate based on JSON input. The API returns a single Rate available to the user, according to the unique ID provided. If the specified Rate does not exist, the response will be a "bad request".
You will only receive the 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
| Parameter | Type | Description |
|---|---|---|
| id | integer | The unique and specific identifier of the Rate |
RESPONSE
| Attribute | Type | Description |
|---|---|---|
| branchId | Object, Null | Branch the Rate is assigned to |
| branchVisibility | Object, Null | 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) |
| dateCreated | String | Date and time when the Rate was created |
| dateDeleted | String | Date and time when the Rate was deleted |
| dateUpdated | String | Date and time when the Rate was last updated |
| deleted | boolean | If true, the Rate has been deleted and archived |
| descriptionBR | String | Rate label in Brasilian Portuguese |
| descriptionDE | String | Rate label in German |
| descriptionDK | String | Rate label in Dutch |
| descriptionEN (Required) | 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) |
| id | Integer | Unique identifier of the Rate in ForceManager |
| salesRepIdCreated | Integer | Unique identifier of the User who created the Rate |
| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Rate |
| salesRepIdUpdated | Integer | Unique identifier of the User who last updated the Rate |
| startDate | String | Date when the Rate starts |
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/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
Response
Get Rate
Changes
No recorded changes to this operation across all 1 revision of this API.