List Rates
Returns all Rates available in the user's ForceManager implementation database.
You will only receive the List of Rates 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 |
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/rates?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/rates?where= param1=value AND/OR param2=value2
You can filter Rates by dateCreated and id for example.
You can also organise and view the results for Rates 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/rates?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/rates?lang=VALUE
RESPONSE
This endpoint returns information about all Rates 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 Rates attributes:
| 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 |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/rates
- Auth: API key in header X-Session-Key
Headers
Response
List Rates
Changes
No recorded changes to this operation across all 1 revision of this API.