{"openapi":"3.0.3","info":{"title":"Sage Sales Management Public API Documentation for Developers","description":"# Overview\n\n### WELCOME TO SAGE SALES MANAGEMENT API V4 DOCUMENTATION\n\nThis new version of our Application Programming Interface (API) represents a huge step forward. It is more powerful and easier to use than the previous version. Here you will find all the guidance you need to build integrations for the Sage Sales Management application. \nSome of the biggest and most important changes are:\n\n- New authentication.\n \n- New entities.\n \n- More customisation.\n \n- Better and faster response speed.\n \n\n#### Requirements\n\nBefore you start you will need your **Public API key** and **Private API key**. If you already have a **Sage Sales Management** **account** and you are an admin, you can find your API key under [Settings > Integrations > API key](https://app.forcemanager.net/views/settings.aspx#) management of the Sage Sales Management web app or in the [Password](https://admin.forcemanager.net/#/app/apikeys) section of the ForceAdmin tool.\n\n#### Some info to get up to speed with the **Sage Sales Management** API\n\n- The API is organised around RESTful to query and update the data.\n \n- All requests have to be made over SSL.\n \n- All requests and response bodies, including errors, are encoded in JSON. Remember to specify the Content-Type header as `application/json`.\n \n- Each entity has a unique integer ID.\n \n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\n#### Three-column Design\n\nAll the example responses are in the right columns, so you can see the examples while you are looking at the resources description and parameters.\n\n#### Feedback\n\nYour Feedback matter, let us know what you want to see from Sage Sales Management API or let us know any issue you want to report. You can email us at [support@forcemanager.net](https://mailto:support@forcemanager.net).\n\n# Endpoints\n\nThe **Sage Sales Management** API is designed around the concept of resources. \nA \"**resource**\" is related to an entity within Sage Sales Management. You may know these resources already as Account, Opportunities, Products, Contacts, and so on. \nEndpoints are available through the API. These can be actions like retrieving an Opportunity, updating a Contact or deleting an Account. Every resource has its own endpoint that is used to receive data for a particular resource. Endpoints perform a specific function, taking some number of parameters and returning data.\n\n# Requests\n\n**Sage Sales Management** Users can use the RESTful - based API - to query and update their data. All data is sent and received in JSON format and all API requests require authentication. In order to do a proper JSON-formatted request, make sure you provide Content-Type: `application/json` in HTTP request headers. \nFour HTTP verbs are supported. These \"verbs\" represent the type of action a HTTP client (e.g. Postman or REST Easy) might perform against a resource. \nYou can filter Products by `dateCreated`, `familyId` and `model` for example.\n\n- GET request: retrieves data\n \n- POST request: adds new records\n \n- PUT request: partial update of records\n \n- DELETE request: deletes records\n \n\nYou 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.\n\nAll API calls in production must be made to [https://api.forcemanager.com/api/v4](https://api.forcemanager.com/api/v4) where v4 (version identifier) is the current version of the API.\n\nIf you want to test the API in your sandbox implementation, the API calls must be made to [https://sandbox-api.forcemanager.com](https://sandbox-api.forcemanager.com). To know how to create a sandbox implementation please refer to the [ForceAdmin Sandbox](https://admin.forcemanager.net/#/app/sandbox) section. You must also generate the properly public and private API key to interact with your sandbox implementation. You can do so accessing ForceAdmin with your sandbox credentials.\n\nThere you can find a list of endpoints and resources such as Accounts, Contacts, Activity, Opportunities, Calendar… Those can be accessible via the URL + resource name. For example, you would use the following endpoint to access Accounts: [https://api.forcemanager.com/api/v4/accounts](https://api.forcemanager.com/api/v4/accounts).\n\n##### Headers Parameters\n\nHeader parameters are included in the request header. Usually the header includes the content-type and the authentication parameters. The lasts are common across all endpoints. If you want to know how you can get the authentication, it is documented in [Authentication](#).\n\n| RESOURCE | DESCRIPTION |\n| --- | --- |\n| Accounts | An Account represents a company or person with whom a business relationship is developed |\n| Related Accounts | A Related Account represents a company or person in a relationship with another company or person |\n| Warnings | A Warning is a recommendation, an important message that needs to be highlighted in the detail of a resource |\n| Activities | An Activity covers interactions with customers or prospective customers |\n| Calendar | A Calendar is an agenda that corresponds to a work and activity schedule you plan to carry out within a certain period of time |\n| Emails | All the e-mails recorded in **Sage Sales Management** in regards the communications of the employees with the Account and Contacts registered in ForceManager |\n| Documents | A document is a media file (pdf, jpg, mov, docx, xlsx, ...) that can be attached to a resource or to the document repository in **Sage Sales Management** |\n| Contacts | A Contact represents an individual associated with an existing Account |\n| Extra Fields | The Extra Fields are custom fields that allows you to enrich the information of a specific resource, to let you personalize it based on your business context |\n| Opportunities | An Opportunity is the possible sale of your products or services to a prospective customer or and existing account |\n| Products | A Product represents any good or service that you offer. All the products are available in a catalog in your account |\n| Rates | All the product's Rates you can add to a specific Sales Order |\n| Sales Orders | A Sale Order corresponds to an economic proposal that has been drawn up for an account |\n| Roles | Roles are a set of permissions that can be associated to any user |\n| Users | Users refers to employees that you have (activated or deactivated) in **Sage Sales Management** |\n| Value Lists | Value lists are groups of predetermined values (i.e. dropdown lists) that help you to classify and aggregate information of a resource |\n| Views | A View is a shortcut that helps users to quickly filter resource data. A View basically wraps an SQL command |\n| Webhooks | A Webhooks is an endpoint automatically called by **Sage Sales Management** when a linked action occurs (e.g. the update of an Account) |\n\n# Pagination\n\n**Sage Sales Management** accounts can have a lot of content - more than you would want to pull down in a single request. Pagination will help you when you work with large collection of resources, so you can control how many you receive from the API. \nThe API endpoints provide a limited number of items per request, that is 50 by default. The call return a \\[\\] when you are at the last page. You can specify the page of results to be returned in two different ways: \n\\* In the headers section you can define how many items you want to get in every page, using the `X-FM-Entity-Count` header parameter. E.g. if you set count as 20, in the first page you will receive the first 20 items. \n\\* `page={{number}}`: it is a query parameter that specifies the page of results to return. E.g. `/api/v4/accounts?page=1` the API will return the second page of accounts results, since the first page is 0.\n\n# Filters, Orders and Language\n\nYou can **apply filters** 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, the operators to filter are: =, >, >=, <, <=, <>, AND, OR and LIKE. \nThe order of the parameters does not matter. \ne.g. `https://api.forcemanager.com/api/v4/{{entity}}?where=param1=value AND/OR param2=value2`e.g.[https://api.forcemanager.com/api/v4/{{entity}}?where=param1>=value](https://api.forcemanager.com/api/v4/%7B%7Bentity%7D%7D?where=param1%3E=value) \ne.g. `https://api.forcemanager.com/api/v4/{{entity}}?where=param1 LIKE \"value\" AND param2` \nYou can also **order** the results in any call except value list. With this you will be able to view your results in descendent order - at the top, the most recent results while the oldest results will be down the list. \ne.g. [https://api.forcemanager.com/com/v4/{{entity}}?order={{attribute}}](https://api.forcemanager.com/com/v4/%7B%7Bentity%7D%7D?order=%7B%7Battribute%7D%7D) \nYou can define the **language** in which you want to receive the response.The available languages are: English (en), Spanish (es), Portuguese (pt), Italian (it), French (fr), Deutsch (de), Russian (ru). \ne.g. [https://api.forcemanager.com/api/v4/{{entity}}?lang={{language}}](https://api.forcemanager.com/api/v4/%7B%7Bentity%7D%7D?lang=%7B%7Blanguage%7D%7D)\n\n# API Errors description\n\n**Sage Sales Management** API can response your requests with the following errors:\n\n| ID | Name | Description |\n| --- | --- | --- |\n| 900 | Connection Error | The database connection cannot be established |\n| 901 | Internal data Error | The SQL is not generated correctly |\n| 902 | Internal data Error | An error occurred while processing the SQL Transaction |\n| 903 | Internal data Error | The SQL for the Insert is not generated correctly |\n| 904 | Internal data Error | An error occurred during the Insert transaction in database |\n| 905 | Internal data Error | The SQL for the Update is not generated correctly |\n| 906 | Internal data Error | An error occurred during the Update transaction in database |\n| 907 | Internal data Error | An error occurred during the Delete transaction in database |\n| 908 | Internal data Error | Error executing the transaction in database |\n| 909 | Internal data Error | Error executing the Procedure |\n| 910 | Resource not exist | The resource you provide doesn't exist |\n\n# Security\n\nMake sure that all request to the **Sage Sales Management** API are made over SSL (https:// not http://). \nUsing HTTPS, the computer sender and recipient agree on encrypting the information exchanged between them, so that no one in between can read the line of messages.\n\n# Data Transfer\n\nAll entities sent and received in the API are encoded using JSON objects. \nThe **Sage Sales Management** RESTful API is compliant with the W3C CORS specification, which allows any properly-authorized requests to be made from any origin domain. This means that you should not need to wrap calls in JSONP callbacks in order to make calls from browser-based applications. \nThis represents a log of all changes to the API and the versions that are related to each new addition. These are all of the changes that are introduced by an API version. Use them to check whether your app is compatible with an API version, and what changes you might need to make before you migrate your app.\n\n# Release Notes\n\n## Version: 01/08/2021\n\n\\* Changes in `Contacts` -> The property `gender` is now returned in a value list format, e.g. `{\"id\":1, \"value\": \"Male\"}`, instead of with just a binary value, e.g. `1`.\n\n## Version: 18/06/2020\n\n\\* Fixed issue: In entity Users. POST request was ignoring the field `isActive` in order to create the users as active or not.\n\n## Version: 08/05/2020\n\n\\* Changes in `tblFamiliasProd` -> The property `name` is renamed to `description`.","version":"4.0.0"},"servers":[{"url":"https://api.forcemanager.com/api/v4","description":"Production"},{"url":"https://sandbox-api.forcemanager.com/api/v4","description":"Sandbox"}],"tags":[{"name":"Account Addresses","description":""},{"name":"Accounts / Entity","description":"","x-displayName":"Entity"},{"name":"Accounts / Types","description":"","x-displayName":"Types"},{"name":"Accounts / Segments","description":"","x-displayName":"Segments"},{"name":"Accounts / Statuses","description":"","x-displayName":"Statuses"},{"name":"Activities / Entity","description":"","x-displayName":"Entity"},{"name":"Activities / Types","description":"","x-displayName":"Types"},{"name":"Activities / Points","description":"","x-displayName":"Points"},{"name":"Authentication","description":""},{"name":"Branches","description":""},{"name":"Bulks","description":""},{"name":"Calls","description":""},{"name":"Campaigns / Entity","description":"","x-displayName":"Entity"},{"name":"Campaigns / Statuses","description":"","x-displayName":"Statuses"},{"name":"Campaigns / Accounts","description":"","x-displayName":"Accounts"},{"name":"Campaigns / Questions","description":"","x-displayName":"Questions"},{"name":"Campaigns / Question Answers","description":"","x-displayName":"Question Answers"},{"name":"Campaigns / Question Values","description":"","x-displayName":"Question Values"},{"name":"Opportunities / Types","description":"","x-displayName":"Types"},{"name":"Opportunities / Entity","description":"","x-displayName":"Entity"},{"name":"Opportunities / Statuses","description":"","x-displayName":"Statuses"},{"name":"Contacts / Entity","description":"","x-displayName":"Entity"},{"name":"Contacts / Types","description":"","x-displayName":"Types"},{"name":"Countries","description":""},{"name":"Currencies","description":""},{"name":"Documents / Entity","description":"","x-displayName":"Entity"},{"name":"Documents / Folders","description":"","x-displayName":"Folders"},{"name":"Products / Carousel","description":"","x-displayName":"Carousel"},{"name":"Products / Entity","description":"","x-displayName":"Entity"},{"name":"Products / Families","description":"","x-displayName":"Families"},{"name":"Products / Categories","description":"","x-displayName":"Categories"},{"name":"Products / Rates","description":"","x-displayName":"Rates"},{"name":"Emails","description":""},{"name":"Entity Contacts","description":""},{"name":"Entity Owners","description":""},{"name":"Events/Tasks","description":""},{"name":"Extra Fields / Entity","description":"","x-displayName":"Entity"},{"name":"Extra Fields / Tabs","description":"","x-displayName":"Tabs"},{"name":"Forms / Entity","description":"","x-displayName":"Entity"},{"name":"Forms / States","description":"","x-displayName":"States"},{"name":"Forms / Templates","description":"","x-displayName":"Templates"},{"name":"News","description":""},{"name":"Orders / Entity","description":"","x-displayName":"Entity"},{"name":"Orders / Statuses","description":"","x-displayName":"Statuses"},{"name":"Orders / Types","description":"","x-displayName":"Types"},{"name":"Rates","description":""},{"name":"Related Accounts / Entity","description":"","x-displayName":"Entity"},{"name":"Related Accounts / Types","description":"","x-displayName":"Types"},{"name":"Resources","description":""},{"name":"Roles","description":""},{"name":"Sales","description":""},{"name":"TimeZones","description":""},{"name":"Users / Entity","description":"","x-displayName":"Entity"},{"name":"Users / Types","description":"","x-displayName":"Types"},{"name":"Value Lists / Entity","description":"","x-displayName":"Entity"},{"name":"Value Lists / Values","description":"","x-displayName":"Values"},{"name":"Warnings","description":""},{"name":"Webhooks","description":""}],"security":[{"SessionKey":[]}],"components":{"securitySchemes":{"SessionKey":{"type":"apiKey","in":"header","name":"X-Session-Key"}}},"paths":{"/accountAddresses/schema":{"get":{"operationId":"account-addresses-schema","summary":"Account Addresses schema","description":"The Schema is metadata that tells you how the data is structured for this specific Value list. \n\nYou will only receive the Account Addresses Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThe Account Addresses Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Account Addresses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Account Addresses schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"accountId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"address1":{"description":"","maxLength":180,"readOnly":false,"type":["string","null"]},"address2":{"description":"","maxLength":180,"readOnly":false,"type":["string","null"]},"city":{"description":"","maxLength":200,"readOnly":false,"type":["string","null"]},"countryId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"countries","type":["object","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"description":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"postcode":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"region":{"description":"","maxLength":200,"readOnly":false,"type":["string","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]}},"required":[],"title":"accountAddresses","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountAddresses":{"get":{"operationId":"list-account-addresses","summary":"List Account Addresses","description":"Returns all Account Addresses available in the user's ForceManager implementation database.\n\nYou will only receive the Account Addresses after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Account Addresses available for the value list.\n\nList of the supported Account Addresses attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Object, Null | Account to which the address is linked to |\n| address1 | String | Account's first address |\n| address2 | String | Account's second address |\n| city | String | City name |\n| countryId | Object, Null | Id of the Country that the address is referred to (see [Countries](#) resource) |\n| description | String | A description added to the Account Address |\n| postcode | String | Postcode of the address |\n| region | String | Region/State name |\n| dateCreated | String | Date and time when the Account Address was created |\n| dateDeleted | String | Date and time when the Account Address was deleted |\n| dateUpdated | String | Date and time when the Account Address was last updated |\n| deleted | Boolean | If true, the Account Address has been deleted and archived |\n| id | Integer | Unique identifier for the Account Address in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Address |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Address |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account Address |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Account Addresses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Account Addresses","content":{"application/json":{"examples":{"default":{"value":[{"accountId":{"id":1234,"value":"LANA S.A."},"address1":"Pau Roder","address2":"n. 46","city":"Barcelona","countryId":{"id":73,"value":"España"},"dateCreated":"2017-05-30T17:43:24.253Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"description":null,"id":1,"postcode":"08034","region":"Barcelona","salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":null},{"accountId":{"id":1234,"value":""},"address1":"via Verdi 1","address2":null,"city":"Milano","countryId":{"id":112,"value":"Italia"},"dateCreated":"2021-12-15T14:41:08.443Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"description":"This is the main shipping address","id":1,"postcode":"0801","region":"Lombardia","salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-account-address","summary":"Create Account Address","description":"This endpoint allows you to create an Account Address based on JSON input.\n\nYou will only be able to create an Account Address after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId (*Required*) | Integer | Account to which the address is linked to |\n| address1 | String | Account's first address |\n| address2 | String | Account's second address |\n| city | String | City name |\n| countryId | Integer | Id of the Country that the address is referred to (see [Countries](#) resource) |\n| description | String | A description added to the Account Address |\n| postcode | String | Postcode of the address |\n| region | String | Region/State name |\n| dateCreated | String | Date and time when the Account Address was created |\n| dateDeleted | String | Date and time when the Account Address was deleted |\n| dateUpdated | String | Date and time when the Account Address was last updated |\n| deleted | Boolean | If true, the Account Address has been deleted and archived |\n| id | Integer | Unique identifier for the Account Address in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Address |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Address |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account Address |\n\n**RESPONSE**\n\nReturns a JSON with information about the Accout Address just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Account Address |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Account Addresses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Account Address","content":{"application/json":{"examples":{"default":{"value":{"id":2,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"integer"},"address1":{"type":"string"},"address2":{"type":"string"},"city":{"type":"string"},"countryId":{"type":"integer"},"description":{"type":"string"},"postcode":{"type":"string"},"region":{"type":"string"}}},"examples":{"default":{"value":{"accountId":1234,"address1":"via Verdi 1","address2":null,"city":"Milano","countryId":112,"description":"This is the main shipping address","postcode":"0801","region":"Lombardia"}}}}}}}},"/accountAddresses/{ID}":{"get":{"operationId":"get-account-address","summary":"Get Account Address","description":"This endpoint retrieves data of a specific Account Address based on JSON input. The API returns a single Address available to the user, according to the unique ID provided. If the specified Account Address does not exist, the response will be a \"bad request\".\n\nYou will only receive the Account Address after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Account Address |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Object, Null | Account to which the address is linked to |\n| address1 | String | Account's first address |\n| address2 | String | Account's second address |\n| city | String | City name |\n| countryId | Object, Null | Id of the Country that the address is referred to (see [Countries](#) resource) |\n| description | String | A description added to the Account Address |\n| postcode | String | Postcode of the address |\n| region | String | Region/State name |\n| dateCreated | String | Date and time when the Account Address was created |\n| dateDeleted | String | Date and time when the Account Address was deleted |\n| dateUpdated | String | Date and time when the Account Address was last updated |\n| deleted | Boolean | If true, the Account Address has been deleted and archived |\n| id | Integer | Unique identifier for the Account Address in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Address |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Address |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account Address |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Account Addresses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Account Address","content":{"application/json":{"examples":{"default":{"value":{"accountId":{"id":1234,"value":"LANA S.A."},"address1":"Pau Roder","address2":"n. 46","city":"Barcelona","countryId":{"id":73,"value":"España"},"dateCreated":"2017-05-30T17:43:24.253Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"description":null,"id":1,"postcode":"08034","region":"Barcelona","salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":null}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-account-address","summary":"Update Account Address","description":"This endpoint allows you to update a specific Account Address. If the specified Address does not exist, the response will be a \"bad request\".\n\nYou will only be able to update an Account Address after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Account Address. In order to update an Address, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Integer | Account to which the address is linked to |\n| address1 | String | Account's first address |\n| address2 | String | Account's second address |\n| city | String | City name |\n| countryId | Integer | Id of the Country that the address is referred to (see [Countries](#) resource) |\n| description | String | A description added to the Account Address |\n| postcode | String | Postcode of the address |\n| region | String | Region/State name |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Address just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Account Addresses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Account Address","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"address1":{"type":"string"},"city":{"type":"string"}}},"examples":{"default":{"value":{"address1":"Gran via, 326","city":"Madrid"}}}}}}},"delete":{"operationId":"delete-account-address","summary":"Delete Account Address","description":"This endpoint allows you to delete a specific Account Address from the user's ForceManager implementation database. If the specified Account Address does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Account Address after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | */* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Account Address to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Address just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Account Addresses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Account Address","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/accounts/schema":{"get":{"operationId":"accounts-schema","summary":"Accounts schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The Schema defines all the fields that exist for an Account object. \nYou will only receive the Accounts Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Accounts Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Table | String | The name of the values list table |\n| Type | Object, null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Accounts schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"address1":{"description":"","maxLength":180,"readOnly":false,"type":["string","null"]},"address2":{"description":"","maxLength":180,"readOnly":false,"type":["string","null"]},"branchId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"branches","type":["object","null"]},"city":{"description":"","maxLength":200,"readOnly":false,"type":["string","null"]},"comment":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"countryId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"countries","type":["object","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateGeocoded":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"email":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"extId":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"fax":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"geocoded":{"description":"","readOnly":false,"type":["boolean","null"]},"geocodingAccuracy":{"description":"","readOnly":false,"type":["integer","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"latitude":{"description":"","readOnly":false,"type":["number","null"]},"longitude":{"description":"","readOnly":false,"type":["number","null"]},"marketingCommunications":{"description":"","readOnly":false,"type":["boolean","null"]},"name":{"description":"","maxLength":80,"readOnly":false,"type":["string","null"]},"permissionLevel":{"description":"","readOnly":false,"type":["integer","null"]},"phone":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"phone2":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"phone3":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"postcode":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"public":{"description":"","readOnly":false,"type":["boolean","null"]},"rateId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"rates","type":["object","null"]},"readOnly":{"description":"","readOnly":false,"type":["boolean","null"]},"region":{"description":"","maxLength":200,"readOnly":false,"type":["string","null"]},"salesRepId1":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepId2":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepId3":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepId4":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepId5":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"segmentId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accountSegments","type":["object","null"]},"statusId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accountStatuses","type":["object","null"]},"typeId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accountTypes","type":["object","null"]},"vatNumber":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"website":{"description":"","maxLength":300,"readOnly":false,"type":["string","null"]}},"required":["name","salesRepId1"],"title":"accounts","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/accounts":{"get":{"operationId":"list-accounts","summary":"List Accounts","description":"Returns all Accounts available in the user's ForceManager implementation database.\n\nYou will only receive the List of Accounts after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/accounts?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/accounts?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Accounts by `dateCreated` or `address`, or `typeId` for example.\n\nYou can also **organise and view** the results for Accounts in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/accounts?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/accounts?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Accounts available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Accounts attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| address1 | String | The Account's main address. e.g. number, street, suite, apt#, postal code, etc. |\n| address2 | String | The Account's second address |\n| branchId | Object, Null | Branch to which the Account has been assigned (see [Branches](#) resource) |\n| city | String | City name |\n| comment | Object | Comment added to the Account |\n| countryId | Object, Null | Country ID (see [Countries](#) resource) of the Account address |\n| dateCreated | String | Date and time when the Account was created |\n| dateDeleted | String | Date and time when the Account was deleted |\n| dateUpdated | string | Date and time when the Account was last updated |\n| deleted | Boolean | If true, the Account has been deleted and archived |\n| email | String | Account's email address |\n| extId | String | External ID of the Account from a third party system (ERP, CRM, Accounting System) |\n| fax | String | Account's fax number |\n| geocoded | Boolean | If true, the Account has been geolocated |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |\n| id | Integer | Unique identifier for the Account in ForceManager |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| name | String | Name of the Account |\n| permissionLevel | String | Defines the visibility of the Account. Set from 1 to 5 being 5 the highest level of permission |\n| phone | String | First contact phone number for the Account |\n| phone2 | String | Second contact phone number for the Account |\n| phone3 | String | Third contact phone number for the Account |\n| postcode | String | The Account's address postcode |\n| public | Boolean | If true, the Account is visible to everyone regardless of the level of permission |\n| rateId | Integer | Rate for the Account (see [Rates](#) resource) |\n| readOnly | boolean | If true, the Account can not be modified or deleted |\n| region | String | Region/State name |\n| salesRepId1 | Object, Null | First User responsible for the Account |\n| salesRepId2 | Object, Null | Second User responsible for the Account |\n| salesRepId3 | Object, Null | Third User responsible for the Account |\n| salesRepId4 | Object, Null | Forth User responsible for the Account |\n| salesRepId5 | Object, Null | Fifth User responsible for the Account |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Account |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Account |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Account |\n| segmentId | Object, Null | Segment of the Account (see [Segments](#) resource) |\n| statusId | Object, Null | Status of the Account (see [Statues](#) resource) |\n| typeId | Object, Null | Type of the Account (see [Types](#) resource) |\n| vatNumber | String | Value Added Tax identification number of the Account |\n| website | String | The Account's website address |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Accounts","content":{"application/json":{"examples":{"default":{"value":[{"address1":"Gran Via de Carles III, 156X","address2":"","branchId":{"id":4380,"value":"HQ"},"city":"Barcelona","comment":"","countryId":{"id":73,"value":"España"},"dateCreated":"2015-07-13T17:24:59.237Z","dateDeleted":null,"dateUpdated":"2016-01-28T16:25:54.05Z","deleted":false,"email":"Jade.Orozco@hdiwhy.es","extId":null,"fax":"","geocoded":true,"geocodingAccuracy":1,"id":1191,"latitude":41.3732894,"longitude":2.138572,"name":"Adaecuo","permissionLevel":2,"phone":"643464946494","phone2":"","phone3":"","postcode":"08034","public":false,"rateId":null,"readOnly":false,"region":"Barcelona","salesRepId1":{"id":5548,"value":"Luis Sánchez"},"salesRepId2":null,"salesRepId3":null,"salesRepId4":null,"salesRepId5":null,"salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":5548,"segmentId":{"id":6398,"value":"B"},"statusId":null,"typeId":{"id":4912,"value":"Distributor"},"vatNumber":null,"website":null},{"address1":"Carrer de Maria Auxiliadora, 29","address2":"","branchId":{"id":4380,"value":"HQ"},"city":"Barcelona","comment":"","countryId":{"id":73,"value":"España"},"dateCreated":"2015-07-13T17:50:55.697Z","dateDeleted":null,"dateUpdated":"2017-11-13T11:20:41.443Z","deleted":false,"email":"amasa@institution.org","extId":null,"fax":"","geocoded":true,"geocodingAccuracy":19,"id":1192,"latitude":41.3913005,"longitude":2.129141,"name":"Fundición Amasa","permissionLevel":2,"phone":"61946494","phone2":null,"phone3":"","postcode":"08017","public":false,"rateId":null,"readOnly":false,"region":"Barcelona","salesRepId1":{"id":5548,"value":"Luis Sánchez"},"salesRepId2":null,"salesRepId3":null,"salesRepId4":null,"salesRepId5":null,"salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":5548,"segmentId":{"id":6399,"value":"C"},"statusId":null,"typeId":{"id":4917,"value":"Partner"},"vatNumber":null,"website":""}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-account","summary":"Create Account","description":"This endpoint allows you to create a Account based on JSON input.\n\nYou will only be able to create a Account after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| address1 | String | The Account's main address. e.g. number, street, suite, apt#, postal code, etc. |\n| address2 | String | The Account's second address |\n| branchId (_Required_) | Integer | Branch to which the Account has been assigned (see [Branches](#) resource) |\n| city | String | City name |\n| comment | Object | Comment added to the Account |\n| countryId | Integer | Country ID (see [Countries](#) resource) of the Account address |\n| email | String | Account's email address |\n| extId | String | External ID of the Account from a third party system (ERP, CRM, Accounting System) |\n| fax | String | Account's fax number |\n| geocoded | Boolean | If true, the Account has been geolocated |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| name (_Required_) | String | Name of the Account |\n| permissionLevel | String | Defines the visibility of the Account. Set from 1 to 5 being 5 the highest level of permission |\n| phone | String | First contact phone number for the Account |\n| phone2 | String | Second contact phone number for the Account |\n| phone3 | String | Third contact phone number for the Account |\n| postcode | String | The Account's address postcode |\n| public | Boolean | If true, the Account is visible to everyone regardless of the level of permission |\n| rateId | Integer | Rate for the Account (see [Rates](#) resource) |\n| readOnly | boolean | If true, the Account can not be modified or deleted |\n| region | String | Region/State name |\n| salesRepId1 (_Required_) | Integer | First User responsible for the Account |\n| salesRepId2 | Integer | Second User responsible for the Account |\n| salesRepId3 | Integer | Third User responsible for the Account |\n| salesRepId4 | Integer | Forth User responsible for the Account |\n| salesRepId5 | Integer | Fifth User responsible for the Account |\n| segmentId | Integer | Segment of the Account (see [Segments](#) resource) |\n| statusId | Integer | Status of the Account (see Statues resource) |\n| typeId | Integer | Type of the Account (see [Types](#) resource) |\n| vatNumber | String | Value Added Tax identification number of the Account |\n| website | String | The Account's website address |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Account |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Account","content":{"application/json":{"examples":{"default":{"value":{"id":402,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"branchId":{"type":"integer"},"city":{"type":"string"},"comment":{"type":"string"},"countryId":{"type":"integer"},"email":{"type":"string"},"fax":{"type":"string"},"geocoded":{"type":"boolean"},"geocodingAccuracy":{"type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"},"name":{"type":"string"},"permissionLevel":{"type":"integer"},"phone":{"type":"string"},"phone2":{"type":"string"},"phone3":{"type":"string"},"postcode":{"type":"string"},"public":{"type":"boolean"},"rateId":{"type":"integer"},"readOnly":{"type":"boolean"},"region":{"type":"string"},"salesRepId1":{"type":"integer"},"segmentId":{"type":"integer"},"statusId":{"type":"integer"},"typeId":{"type":"integer"},"vatNumber":{"type":"string"},"website":{"type":"string"}}},"examples":{"default":{"value":{"address1":"2765 Smith Street","address2":"7865 North Street","branchId":461,"city":"Springfield","comment":"it has a potencial","countryId":168,"email":"info@onlineserviceco.com","fax":"+39 695-2382","geocoded":true,"geocodingAccuracy":0,"latitude":41.3913395,"longitude":2.1291421,"name":"Online Service Company","permissionLevel":2,"phone":"314-695-8223","phone2":"314-345-7248","phone3":"801-895-6472","postcode":"4","public":false,"rateId":33,"readOnly":false,"region":"MO","salesRepId1":310,"segmentId":25,"statusId":18,"typeId":63,"vatNumber":"4","website":"www.onlineserviceco.com"}}}}}}}},"/accounts/{ID}":{"get":{"operationId":"get-account","summary":"Get Account","description":"This endpoint retrieves data of a specific Account based on JSON input. The API returns a single Account available to the user, according to the unique ID provided. If the specified Account does not exist, the response will be a \"bad request\".\n\nYou will only receive the Account after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Account |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| address1 | String | The Account's main address. e.g. number, street, suite, apt#, postal code, etc. |\n| address2 | String | The Account's second address |\n| branchId | Object, Null | Branch to which the Account has been assigned (see [Branches](#) resource) |\n| city | String | City name |\n| comment | Object | Comment added to the Account |\n| countryId | Object, Null | Country ID (see [Countries](#) resource) of the Account address |\n| dateCreated | String | Date and time when the Account was created |\n| dateDeleted | String | Date and time when the Account was deleted |\n| dateUpdated | string | Date and time when the Account was last updated |\n| deleted | Boolean | If true, the Account has been deleted and archived |\n| email | String | Account's email address |\n| extId | String | External ID of the Account from a third party system (ERP, CRM, Accounting System) |\n| fax | String | Account's fax number |\n| geocoded | Boolean | If true, the Account has been geolocated |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |\n| id | Integer | Unique identifier for the Account in ForceManager |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| name | String | Name of the Account |\n| permissionLevel | String | Defines the visibility of the Account. Set from 1 to 5 being 5 the highest level of permission |\n| phone | String | First contact phone number for the Account |\n| phone2 | String | Second contact phone number for the Account |\n| phone3 | String | Third contact phone number for the Account |\n| postcode | String | The Account's address postcode |\n| public | Boolean | If true, the Account is visible to everyone regardless of the level of permission |\n| rateId | Integer | Rate for the Account (see [Rates](#) resource) |\n| readOnly | boolean | If true, the Account can not be modified or deleted |\n| region | String | Region/State name |\n| salesRepId1 | Object, Null | First User responsible for the Account |\n| salesRepId2 | Object, Null | Second User responsible for the Account |\n| salesRepId3 | Object, Null | Third User responsible for the Account |\n| salesRepId4 | Object, Null | Forth User responsible for the Account |\n| salesRepId5 | Object, Null | Fifth User responsible for the Account |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Account |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Account |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Account |\n| segmentId | Object, Null | Segment of the Account (see [Segments](#) resource) |\n| statusId | Object, Null | Status of the Account (see Statues resource) |\n| typeId | Object, Null | Type of the Account (see [Types](#) resource) |\n| vatNumber | String | Value Added Tax identification number of the Account |\n| website | String | The Account's website address |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [Optional]"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [Optional]"}],"responses":{"200":{"description":"Get Account","content":{"application/json":{"examples":{"default":{"value":{"address1":"Via Sile, 41, 31056 Roncade TV, Italy","address2":null,"branchId":{"id":16,"value":"Headquarter"},"city":"Roncade","comment":null,"countryId":{"id":112,"value":"Italy"},"dateCreated":"2021-11-25T12:30:31.18Z","dateDeleted":null,"dateGeocoded":null,"dateUpdated":"2021-11-30T13:08:05.45Z","deleted":false,"email":"hello@h-farm.com","extId":"2863700-A","fax":null,"geocoded":false,"geocodingAccuracy":null,"id":399,"latitude":45.5641322,"longitude":12.4281169,"marketingCommunications":false,"name":"H-Farm s.p.a.","permissionLevel":0,"phone":null,"phone2":null,"phone3":null,"postcode":"31056","public":null,"rateId":null,"readOnly":false,"region":"Veneto","salesRepId1":{"id":121,"value":"letatit838@gyn.com"},"salesRepId2":null,"salesRepId3":null,"salesRepId4":null,"salesRepId5":null,"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":90,"segmentId":null,"statusId":{"id":192,"value":"Customer"},"typeId":{"id":162,"value":"Educational"},"vatNumber":null,"website":"https://www.h-farm.com"}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-account","summary":"Update Account","description":"This endpoint allows you to update a specific Account. If the specified Account does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Account after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Account. In order to update a Account, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| address1 | String | The Account's main address. e.g. number, street, suite, apt#, postal code, etc. |\n| address2 | String | The Account's second address |\n| branchId | Integer | Branch to which the Account has been assigned (see [Branches](#) resource) |\n| city | String | City name |\n| comment | Object | Comment added to the Account |\n| countryId | Integer | Country ID (see [Countries](#) resource) of the Account address |\n| email | String | Account's email address |\n| extId | String | External ID of the Account from a third party system (ERP, CRM, Accounting System) |\n| fax | String | Account's fax number |\n| geocoded | Boolean | If true, the Account has been geolocated |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| name | String | Name of the Account |\n| permissionLevel | String | Defines the visibility of the Account. Set from 1 to 5 being 5 the highest level of permission |\n| phone | String | First contact phone number for the Account |\n| phone2 | String | Second contact phone number for the Account |\n| phone3 | String | Third contact phone number for the Account |\n| postcode | String | The Account's address postcode |\n| public | Boolean | If true, the Account is visible to everyone regardless of the level of permission |\n| rateId | Integer | Rate for the Account (see [Rates](#) resource) |\n| readOnly | boolean | If true, the Account can not be modified or deleted |\n| region | String | Region/State name |\n| salesRepId1 | Integer | First User responsible for the Account |\n| salesRepId2 | Integer | Second User responsible for the Account |\n| salesRepId3 | Integer | Third User responsible for the Account |\n| salesRepId4 | Integer | Forth User responsible for the Account |\n| salesRepId5 | Integer | Fifth User responsible for the Account |\n| segmentId | Integer | Segment of the Account (see [Segments](#) resource) |\n| statusId | Integer | Status of the Account (see Statues resource) |\n| typeId | Integer | Type of the Account (see [Types](#) resource) |\n| vatNumber | String | Value Added Tax identification number of the Account |\n| website | String | The Account's website address |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Account","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"address1":{"type":"string"},"phone3":{"type":"string"},"website":{"type":"string"}}},"examples":{"default":{"value":{"address1":"East Street","phone3":"314-695 2382","website":"www.onlineservicecompany.com"}}}}}}},"delete":{"operationId":"delete-account","summary":"Delete Account","description":"This endpoint allows you to delete a specific Account from the user's ForceManager implementation database. If the specified Account does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Accounts after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Account to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Account","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountTypes/schema":{"get":{"operationId":"account-types-schema","summary":"Account Types schema","description":"Returns properties object with the definition of each field in the Account Type table.\n\nYou will only receive the Account Types Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Account Types Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Account Types schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"computeSfm":{"description":"","readOnly":false,"type":["boolean","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"internal":{"description":"","readOnly":false,"type":["boolean","null"]},"order":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]}},"required":[],"title":"accountTypes","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountTypes":{"get":{"operationId":"list-account-types","summary":"List Account Types","description":"Returns all Account Types available in the user's ForceManager implementation database.\n\nYou will only receive the List of Account Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**RESPONSE**\n\nThis endpoint returns information about all Account Types available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Account Types attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Account Type is visible |\n| computeSfm | Boolean | If true, the Account Type counts for sales analytics |\n| internal | Boolean | If true, the Account Type is for internal use only |\n| dateCreated | String | Date and time when the Account Type was created |\n| dateDeleted | String | Date and time when the Account Type was deleted |\n| dateUpdated | String | Date and time when the Account Type was last updated |\n| deleted | Boolean | If true, the Account Type has been deleted and archived |\n| descriptionBR | String | Account Type label in Brasilian Portuguese |\n| descriptionDE | String | Account Type label in German |\n| descriptionDK | String | Account Type label in Dutch |\n| descriptionEN | String | Account Type label in English |\n| descriptionES | String | Account Type label in Spanish |\n| descriptionFR | String | Account Type label in French |\n| descriptionIT | String | Account Type label in Italian |\n| descriptionPT | String | Account Type label in Portuguese |\n| descriptionRU | String | Account Type label in Russian |\n| descriptionUS | String | Account Type label in American English |\n| id | Integer | Unique identifier for the Account Type in ForceManager |\n| order | Integer | The position of the Account Type in the Account Types value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account Type |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Account Types","content":{"application/json":{"examples":{"default":{"value":[{"branchVisibility":null,"computeSfm":true,"dateCreated":"2011-11-09T14:25:48.03Z","dateDeleted":"2021-11-17T11:31:25.513Z","dateUpdated":"2019-08-06T12:31:46.003Z","deleted":true,"descriptionBR":null,"descriptionDE":"Hersteller","descriptionDK":null,"descriptionEN":"Manufacturer","descriptionES":"Fabricante","descriptionFR":"Fabricant","descriptionIT":"Fabbricante","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":12,"internal":false,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":90,"salesRepIdUpdated":1},{"branchVisibility":null,"computeSfm":true,"dateCreated":"2011-11-09T14:25:48.03Z","dateDeleted":"2021-11-17T11:31:25.77Z","dateUpdated":"2019-08-06T12:31:46.003Z","deleted":true,"descriptionBR":null,"descriptionDE":"Benutzer","descriptionDK":null,"descriptionEN":"User","descriptionES":"Usuario","descriptionFR":"Utilisateur","descriptionIT":"Utente","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":13,"internal":false,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":90,"salesRepIdUpdated":1},{"branchVisibility":null,"computeSfm":true,"dateCreated":"2011-11-09T14:25:48.03Z","dateDeleted":"2021-11-17T11:31:26.063Z","dateUpdated":"2019-08-06T12:31:46.003Z","deleted":true,"descriptionBR":null,"descriptionDE":"Gläubiger","descriptionDK":null,"descriptionEN":"Creditor","descriptionES":"Acreedor","descriptionFR":"Créancier","descriptionIT":"Creditore","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":14,"internal":false,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":90,"salesRepIdUpdated":1},{"branchVisibility":null,"computeSfm":true,"dateCreated":"2011-11-09T14:25:48.03Z","dateDeleted":"2021-11-17T11:31:26.523Z","dateUpdated":"2019-08-06T12:31:46.003Z","deleted":true,"descriptionBR":null,"descriptionDE":"Vertriebshändler","descriptionDK":null,"descriptionEN":"Distributor","descriptionES":"Distribuidor","descriptionFR":"Distributeur","descriptionIT":"Distributore","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":20,"internal":false,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":90,"salesRepIdUpdated":1},{"branchVisibility":null,"computeSfm":true,"dateCreated":"2011-11-09T14:25:48.03Z","dateDeleted":"2021-11-17T11:31:26.79Z","dateUpdated":"2019-08-06T12:31:46.007Z","deleted":true,"descriptionBR":null,"descriptionDE":"Sonstige","descriptionDK":null,"descriptionEN":"Other","descriptionES":"Otro","descriptionFR":"Autre","descriptionIT":"Altro","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":21,"internal":false,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":90,"salesRepIdUpdated":1}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-account-type","summary":"Create Account Type","description":"This endpoint allows you to create a Account Type based on JSON input.\n\nYou will only be able to create a Account Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Account Type is visible |\n| computeSfm | Boolean | If true, the Account Type counts for sales analytics |\n| internal | Boolean | If true, the Account Type is for internal use only |\n| descriptionBR | String | Account Type label in Brasilian Portuguese |\n| descriptionDE | String | Account Type label in German |\n| descriptionDK | String | Account Type label in Dutch |\n| descriptionEN (*Required*) | String | Account Type label in English |\n| descriptionES | String | Account Type label in Spanish |\n| descriptionFR | String | Account Type label in French |\n| descriptionIT | String | Account Type label in Italian |\n| descriptionPT | String | Account Type label in Portuguese |\n| descriptionRU | String | Account Type label in Russian |\n| descriptionUS | String | Account Type label in American English |\n| order | Integer | The position of the Account Type in the Account Types value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Type just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Account Type |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Account Type","content":{"application/json":{"examples":{"default":{"value":{"id":166,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"}}},"examples":{"default":{"value":{"descriptionEN":"Partner"}}}}}}}},"/accountTypes/{ID}":{"get":{"operationId":"get-account-type","summary":"Get Account Type","description":"You will only receive the Account Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| id | Integer | The unique and specific identifier of the Account Type |\n\n**RESPONSE**\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| branchVisibility | Object, Null | In which Branch the Account Type is visible |\n| computeSfm | Boolean | If true, the Account Type counts for sales analytics |\n| internal | Boolean | If true, the Account Type is for internal use only |\n| dateCreated | String | Date and time when the Account Type was created |\n| dateDeleted | String | Date and time when the Account Type was deleted |\n| dateUpdated | String | Date and time when the Account Type was last updated |\n| deleted | Boolean | If true, the Account Type has been deleted and archived |\n| descriptionBR | String | Account Type label in Brasilian Portuguese |\n| descriptionDE | String | Account Type label in German |\n| descriptionDK | String | Account Type label in Dutch |\n| descriptionEN | String | Account Type label in English |\n| descriptionES | String | Account Type label in Spanish |\n| descriptionFR | String | Account Type label in French |\n| descriptionIT | String | Account Type label in Italian |\n| descriptionPT | String | Account Type label in Portuguese |\n| descriptionRU | String | Account Type label in Russian |\n| descriptionUS | String | Account Type label in American English |\n| id | Integer | Unique identifier for the Account Type in ForceManager |\n| order | Integer | The position of the Account Type in the Account Types value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account Type |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Account Type","content":{"application/json":{"examples":{"default":{"value":{"branchVisibility":null,"computeSfm":true,"dateCreated":"2021-12-16T00:18:11.163Z","dateDeleted":null,"dateUpdated":"2021-12-16T00:19:07.27Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Partner","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":166,"internal":false,"order":10,"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":90}}}}}}},"security":[{"SessionKey":[]}]}},"/list/accountTypes/{ID}":{"put":{"operationId":"update-account-type","summary":"Update Account Type","description":"This endpoint allows you to update a specific Account Type. If the specified Account Type does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Account Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Account Type. In order to update an Account Type, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Account Type is visible |\n| computeSfm | Boolean | If true, the Account Type counts for sales analytics |\n| internal | Boolean | If true, the Account Type is for internal use only |\n| descriptionBR | String | Account Type label in Brasilian Portuguese |\n| descriptionDE | String | Account Type label in German |\n| descriptionDK | String | Account Type label in Dutch |\n| descriptionEN | String | Account Type label in English |\n| descriptionES | String | Account Type label in Spanish |\n| descriptionFR | String | Account Type label in French |\n| descriptionIT | String | Account Type label in Italian |\n| descriptionPT | String | Account Type label in Portuguese |\n| descriptionRU | String | Account Type label in Russian |\n| descriptionUS | String | Account Type label in American English |\n| order | Integer | The position of the Account Type in the Account Types value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Type just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Account Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"computeSfm":{"type":"boolean"},"internal":{"type":"boolean"},"order":{"type":"integer"}}},"examples":{"default":{"value":{"computeSfm":true,"internal":false,"order":10}}}}}}},"delete":{"operationId":"delete-account-type","summary":"Delete Account Type","description":"This endpoint allows you to delete a specific Account Type from the user's ForceManager implementation database. If the specified Account Type does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Account Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Account Type to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Type just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Account Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountSegments/schema":{"get":{"operationId":"account-segments-schema","summary":"Account Segments schema","description":"Returns properties object with the definition of each field in the Account Segment table. \nWith the Account Segment you can differentiate the Account based on specific visit cycles, hence assigning a priority to each Account.\n\nYou will only receive the Account Segment Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Account Segment Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Segments"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Account Segments schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"order":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"visitCycle":{"description":"","readOnly":false,"type":["integer","null"]}},"required":[],"title":"accountSegments","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountSegments":{"get":{"operationId":"list-account-segments","summary":"List Account Segments","description":"Returns all Account Segments available in the user's ForceManager implementation database.\n\nYou will only receive the List of Account Segments after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**RESPONSE**\n\nThis endpoint returns information about all Account Segments available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Account Segments attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Account Segment is visible |\n| dateCreated | String | Date and time when the Account Segment was created |\n| dateDeleted | String | Date and time when the Account Segment was deleted |\n| dateUpdated | String | Date and time when the Account Segment was last updated |\n| deleted | Boolean | If true, the Account Segment has been deleted and archived |\n| descriptionBR | String | Account Segment label in Brasilian Portuguese |\n| descriptionDE | String | Account Segment label in German |\n| descriptionDK | String | Account Segment label in Dutch |\n| descriptionEN | String | Account Segment label in English |\n| descriptionES | String | Account Segment label in Spanish |\n| descriptionFR | String | Account Segment label in French |\n| descriptionIT | String | Account Segment label in Italian |\n| descriptionPT | String | Account Segment label in Portuguese |\n| descriptionRU | String | Account Segment label in Russian |\n| descriptionUS | String | Account Segment label in American English |\n| visitCycle | Integer | Visit cycle linked to the value. e.g. visit every 30 days accounts in Segment A |\n| id | Integer | Unique identifier for the Account Segment in ForceManager |\n| order | Integer | The position of the Account Segment in the Account Segments value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Segment |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Segment |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account Segment |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Segments"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Account Segments","content":{"application/json":{"examples":{"default":{"value":[{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.257Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.257Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":null,"descriptionES":"A","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"visitCycle":15},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.257Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.257Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":null,"descriptionES":"B","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":2,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"visitCycle":30},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.257Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.257Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":null,"descriptionES":"C","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":3,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"visitCycle":45},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.257Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.257Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":null,"descriptionES":"D","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":4,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"visitCycle":60},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.257Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.257Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":null,"descriptionES":"-","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":5,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"visitCycle":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-account-segment","summary":"Create Account Segment","description":"This endpoint allows you to create a Account Segment based on JSON input.\n\nYou will only be able to create a Account Segment after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Account Segment is visible |\n| descriptionBR | String | Account Segment label in Brasilian Portuguese |\n| descriptionDE | String | Account Segment label in German |\n| descriptionDK | String | Account Segment label in Dutch |\n| descriptionEN (*Required*) | String | Account Segment label in English |\n| descriptionES | String | Account Segment label in Spanish |\n| descriptionFR | String | Account Segment label in French |\n| descriptionIT | String | Account Segment label in Italian |\n| descriptionPT | String | Account Segment label in Portuguese |\n| descriptionRU | String | Account Segment label in Russian |\n| descriptionUS | String | Account Segment label in American English |\n| order | Integer | The position of the Account Segment in the Account Segments value list |\n| visitCycle | Integer | Visit cycle linked to the value. e.g. visit every 30 days accounts in Segment A |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Segment just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Account Segment |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Segments"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Account Segment","content":{"application/json":{"examples":{"default":{"value":{"id":6,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"visitCycle":{"type":"integer"}}},"examples":{"default":{"value":{"descriptionEN":"E","visitCycle":90}}}}}}}},"/accountSegments/{ID}":{"get":{"operationId":"get-account-segment","summary":"Get Account Segment","description":"This endpoint retrieves data of a specific Account Segment based on JSON input. The API returns a single Account Segment available to the user in the Value List, according to the unique ID provided. If the specified Account Segment does not exist, the response will be a \"bad request\".\n\nYou will only receive the Account Segment after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| id | Integer | The unique and specific identifier of the Account Segment |\n\n**RESPONSE**\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| branchVisibility | Object, Null | In which Branch the Account Segment is visible |\n| dateCreated | String | Date and time when the Account Segment was created |\n| dateDeleted | String | Date and time when the Account Segment was deleted |\n| dateUpdated | String | Date and time when the Account Segment was last updated |\n| deleted | Boolean | If true, the Account Segment has been deleted and archived |\n| descriptionBR | String | Account Segment label in Brasilian Portuguese |\n| descriptionDE | String | Account Segment label in German |\n| descriptionDK | String | Account Segment label in Dutch |\n| descriptionEN | String | Account Segment label in English |\n| descriptionES | String | Account Segment label in Spanish |\n| descriptionFR | String | Account Segment label in French |\n| descriptionIT | String | Account Segment label in Italian |\n| descriptionPT | String | Account Segment label in Portuguese |\n| descriptionRU | String | Account Segment label in Russian |\n| descriptionUS | String | Account Segment label in American English |\n| visitCycle | Integer | Visit cycle linked to the value. e.g. visit every 30 days accounts in Segment A |\n| id | Integer | Unique identifier for the Account Segment in ForceManager |\n| order | Integer | The position of the Account Segment in the Account Segments value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Segment |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Segment |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account Segment |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Segments"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Account Segment","content":{"application/json":{"examples":{"default":{"value":{"branchVisibility":null,"dateCreated":"2021-12-16T00:31:57.723Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"E","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":6,"order":null,"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"visitCycle":90}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-account-segment","summary":"Update Account Segment","description":"This endpoint allows you to update a specific Account Segment. If the specified Account Segment does not exist, the response will be a \"bad request\".\n\nYou will only be able to update an Account Segment after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Account Segment. In order to update an Account Segment, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Account Segment is visible |\n| descriptionBR | String | Account Segment label in Brasilian Portuguese |\n| descriptionDE | String | Account Segment label in German |\n| descriptionDK | String | Account Segment label in Dutch |\n| descriptionEN | String | Account Segment label in English |\n| descriptionES | String | Account Segment label in Spanish |\n| descriptionFR | String | Account Segment label in French |\n| descriptionIT | String | Account Segment label in Italian |\n| descriptionPT | String | Account Segment label in Portuguese |\n| descriptionRU | String | Account Segment label in Russian |\n| descriptionUS | String | Account Segment label in American English |\n| order | Integer | The position of the Account Segment in the Account Segments value list |\n| visitCycle | Integer | Visit cycle linked to the value. e.g. visit every 30 days accounts in Segment A |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Segment just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Segments"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Account Segment","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"visitCycle":{"type":"integer"}}},"examples":{"default":{"value":{"visitCycle":120}}}}}}},"delete":{"operationId":"delete-account-segment","summary":"Delete Account Segment","description":"This endpoint allows you to delete a specific Account Segment from the user's ForceManager implementation database. If the specified Account Segment does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Account Segments after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Account Segment to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Segment just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Segments"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Account Segment","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountStatuses/schema":{"get":{"operationId":"account-statuses-schema","summary":"Account Statuses schema","description":"Returns properties object with the definition of each field in the Account Status table.\n\nYou will only receive the Account Status Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Account Status Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Account Statuses schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"lost":{"description":"","readOnly":false,"type":["boolean","null"]},"order":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"won":{"description":"","readOnly":false,"type":["boolean","null"]}},"required":[],"title":"accountStatuses","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountStatuses":{"get":{"operationId":"list-account-statuses","summary":"List Account Statuses","description":"Returns all Account Statuses available in the user's ForceManager implementation database.\n\nYou will only receive the List of Account Statuses after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**RESPONSE**\n\nThis endpoint returns information about all Account Statuses available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Account Statuses attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Account Status is visible |\n| won | Boolean | If true, the Account Status has been won |\n| lost | Boolean | If true, the Account Status has been lost |\n| dateCreated | String | Date and time when the Account Status was created |\n| dateDeleted | String | Date and time when the Account Status was deleted |\n| dateUpdated | String | Date and time when the Account Status was last updated |\n| deleted | Boolean | If true, the Account Status has been deleted and archived |\n| descriptionBR | String | Account Status label in Brasilian Portuguese |\n| descriptionDE | String | Account Status label in German |\n| descriptionDK | String | Account Status label in Dutch |\n| descriptionEN | String | Account Status label in English |\n| descriptionES | String | Account Status label in Spanish |\n| descriptionFR | String | Account Status label in French |\n| descriptionIT | String | Account Status label in Italian |\n| descriptionPT | String | Account Status label in Portuguese |\n| descriptionRU | String | Account Status label in Russian |\n| descriptionUS | String | Account Status label in American English |\n| id | Integer | Unique identifier for the Account Status in ForceManager |\n| order | Integer | The position of the Account Status in the Account Statuses value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Status |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Status |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account Status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Account Statuses","content":{"application/json":{"examples":{"default":{"value":[{"branchVisibility":null,"dateCreated":"2021-11-17T13:42:06.837Z","dateDeleted":"2021-11-17T13:49:30.45Z","dateUpdated":null,"deleted":true,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Lead","descriptionES":"Lead","descriptionFR":null,"descriptionIT":"Lead","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"lost":false,"order":null,"salesRepIdCreated":90,"salesRepIdDeleted":90,"salesRepIdUpdated":null,"won":false},{"branchVisibility":null,"dateCreated":"2021-11-17T13:42:07.07Z","dateDeleted":"2021-11-17T13:49:30.687Z","dateUpdated":null,"deleted":true,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Prospect","descriptionES":"Prospecto","descriptionFR":null,"descriptionIT":"Potenziale","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":2,"lost":false,"order":null,"salesRepIdCreated":90,"salesRepIdDeleted":90,"salesRepIdUpdated":null,"won":false},{"branchVisibility":null,"dateCreated":"2021-11-17T13:42:07.58Z","dateDeleted":"2021-11-17T13:49:30.93Z","dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Customer","descriptionES":"Cliente","descriptionFR":null,"descriptionIT":"Cliente","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":3,"lost":false,"order":null,"salesRepIdCreated":90,"salesRepIdDeleted":90,"salesRepIdUpdated":null,"won":true}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-account-status","summary":"Create Account Status","description":"This endpoint allows you to create a Account Status based on JSON input.\n\nYou will only be able to create a Account Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Account Status is visible |\n| won | Boolean | If true, the Account Status has been won |\n| lost | Boolean | If true, the Account Status has been lost |\n| descriptionBR | String | Account Status label in Brasilian Portuguese |\n| descriptionDE | String | Account Status label in German |\n| descriptionDK | String | Account Status label in Dutch |\n| descriptionEN (*Required*) | String | Account Status label in English |\n| descriptionES | String | Account Status label in Spanish |\n| descriptionFR | String | Account Status label in French |\n| descriptionIT | String | Account Status label in Italian |\n| descriptionPT | String | Account Status label in Portuguese |\n| descriptionRU | String | Account Status label in Russian |\n| descriptionUS | String | Account Status label in American English |\n| order | Integer | The position of the Account Status in the Account Statuses value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Status just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Account Status |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Account Status","content":{"application/json":{"examples":{"default":{"value":{"id":196,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"lost":{"type":"boolean"},"branchVisibility":{"type":"array"}}},"examples":{"default":{"value":{"descriptionEN":"Ex-Customer","lost":true,"branchVisibility":[16]}}}}}}}},"/accountStatuses/{ID}":{"get":{"operationId":"get-account-status","summary":"Get Account Status","description":"This endpoint retrieves data of a specific Account Status based on JSON input. The API returns a single Account Status available to the user in the Value List, according to the unique ID provided. If the specified Account Status does not exist, the response will be a \"bad request\".\n\nYou will only receive the Account Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| id | Integer | The unique and specific identifier of the Account Status |\n\n**RESPONSE**\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| branchVisibility | Object, Null | In which Branch the Account Status is visible |\n| won | Boolean | If true, the Account Status has been won |\n| lost | Boolean | If true, the Account Status has been lost |\n| dateCreated | String | Date and time when the Account Status was created |\n| dateDeleted | String | Date and time when the Account Status was deleted |\n| dateUpdated | String | Date and time when the Account Status was last updated |\n| deleted | Boolean | If true, the Account Status has been deleted and archived |\n| descriptionBR | String | Account Status label in Brasilian Portuguese |\n| descriptionDE | String | Account Status label in German |\n| descriptionDK | String | Account Status label in Dutch |\n| descriptionEN | String | Account Status label in English |\n| descriptionES | String | Account Status label in Spanish |\n| descriptionFR | String | Account Status label in French |\n| descriptionIT | String | Account Status label in Italian |\n| descriptionPT | String | Account Status label in Portuguese |\n| descriptionRU | String | Account Status label in Russian |\n| descriptionUS | String | Account Status label in American English |\n| id | Integer | Unique identifier for the Account Status in ForceManager |\n| order | Integer | The position of the Account Status in the Account Statuses value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Account Status |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Account Status |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Account Status |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Account Status","content":{"application/json":{"examples":{"default":{"value":{"branchVisibility":[{"id":16,"value":"SELLF_MIGRATION"}],"dateCreated":"2021-12-16T10:01:50.917Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Ex-Customer","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":196,"lost":true,"order":null,"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":false}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-account-status","summary":"Update Account Status","description":"This endpoint allows you to update a specific Account Status. If the specified Account Status does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Account Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Account Status. In order to update an Account Status, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Account Status is visible |\n| won | Boolean | If true, the Account Status has been won |\n| lost | Boolean | If true, the Account Status has been lost |\n| descriptionDE | String | Account Status label in German |\n| descriptionDK | String | Account Status label in Dutch |\n| descriptionEN | String | Account Status label in English |\n| descriptionES | String | Account Status label in Spanish |\n| descriptionFR | String | Account Status label in French |\n| descriptionIT | String | Account Status label in Italian |\n| descriptionPT | String | Account Status label in Portuguese |\n| descriptionRU | String | Account Status label in Russian |\n| descriptionUS | String | Account Status label in American English |\n| order | Integer | The position of the Account Status in the Account Statuses value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Status just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Account Status","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"lost":{"type":"boolean"},"won":{"type":"boolean"},"branchVisibility":{"type":"array"},"order":{"type":"integer"}}},"examples":{"default":{"value":{"descriptionEN":"Ex-Provider","lost":true,"won":false,"branchVisibility":[17],"order":6}}}}}}},"delete":{"operationId":"delete-account-status","summary":"Delete Account Status","description":"This endpoint allows you to delete a specific Account Status from the user's ForceManager implementation database. If the specified Account Status does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Account Statuses after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Account Status to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account Status just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Accounts / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Account Status","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/activities/schema":{"get":{"operationId":"activities-schema","summary":"Activities schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for an Activity object.\n\nYou will only receive the Activities Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Activities Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Table | String | The name of the values list table |\n| Type | Object, Null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Activities schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"accountId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"checkin":{"description":"","readOnly":false,"type":["boolean","null"]},"checkinTypeId":{"description":"","readOnly":false,"type":["integer","null"]},"checkoutDate":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"comment":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"contactId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"contacts","type":["object","null"]},"date":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"extId":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"geocoded":{"description":"","readOnly":false,"type":["boolean","null"]},"geocodingAccuracy":{"description":"","readOnly":false,"type":["integer","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"latitude":{"description":"","readOnly":false,"type":["number","null"]},"longitude":{"description":"","readOnly":false,"type":["number","null"]},"opportunityId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"opportunities","type":["object","null"]},"permissionLevel":{"description":"","readOnly":false,"type":["integer","null"]},"readOnly":{"description":"","readOnly":false,"type":["boolean","null"]},"salesRepId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"typeId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"activityTypes","type":["object","null"]}},"required":["accountId","date","typeId","salesRepId"],"title":"activities","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/activities":{"get":{"operationId":"list-activities","summary":"List Activities","description":"Returns all Activities available in the user's ForceManager implementation database.\n\nYou will only receive the List of Activities after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/activities?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/activities?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Activities by `dateCreated` or `typeId`, or `accountId` for example.\n\nYou can also **organise and view** the results for Activities in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/activities?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/activities?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Activities available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Activities attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId (_Required_) | Object, Null | ID of the Account to which the Activity is linked to (see [Accounts](#) resource) |\n| contactId | Object, Null | Contact the Activity is linked to (see [Contacts](#) resource) |\n| opportunityId | Object, Null | Opportunity to which the Activity is linked to (see [Opportunities](#) resource) |\n| typeId (_Required_) | Object, Null | Activity Type ID (see [Types](#) resource) |\n| salesRepId | Object, Null | Unique identifier of the User associated to the Activity (see [Users](#) resource) |\n| checkin | Boolean | True in the case the Activity had been certified to done within the geofencing range, false otherwise |\n| checkinTypeId | Integer | It exists three different types of checkin: 1 (check-in at an Account's location); 2 (check-in at an open Opportunity); 3 (fast check-in when a User reports a physical visit without having to link them to any existing Account or Opportunity in ForceManager) |\n| checkoutDate | String | Date and time for the check-out. Registers the end of a visit to a client |\n| comment | String | A comment of the Activity |\n| date (_Required_) | String | Date referred to the moment in which the Activity took place |\n| geocoded | Boolean | If true, the Activity has been geolocated and a geocode is automatically calculated by the system (latitude and longitude) |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| permissionLevel | String | Defines the visibility of the Activity. Set from 1 to 5 being 5 the highest level of permission |\n| readOnly | Boolean | If true, the Activity cannot be modified or deleted |\n| extId | String | External ID of the Activity from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | Unique identifier for the Activity in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Activity |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Activity |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Activity |\n| dateCreated | String | Date and time when the Activity was created |\n| dateDeleted | String | Date and time when the Activity was deleted |\n| dateUpdated | String | Date and time when the Activity was last updated |\n| deleted | boolean | If true, the Activity has been deleted and archived |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Activities","content":{"application/json":{"examples":{"default":{"value":[{"accountId":{"id":1241,"value":"Acme Inc."},"checkin":false,"checkinTypeId":1,"checkoutDate":null,"comment":"","contactId":null,"date":"2016-02-29T17:00:04Z","dateCreated":"2016-02-29T16:22:34.4Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"extId":null,"geocoded":true,"geocodingAccuracy":26,"id":845,"latitude":41.3914952,"longitude":2.1293456,"opportunityId":{"id":847,"value":"Opportunity 32"},"permissionLevel":2,"readOnly":false,"salesRepId":{"id":5548,"value":"Luis Sánchez"},"salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"typeId":{"id":6418,"value":"Visit"}},{"accountId":{"id":1241,"value":"Acme Inc."},"checkin":false,"checkinTypeId":1,"checkoutDate":null,"comment":"","contactId":null,"date":"2016-02-29T17:28:50Z","dateCreated":"2016-02-29T17:30:10.923Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"extId":null,"geocoded":true,"geocodingAccuracy":10,"id":847,"latitude":41.3914359,"longitude":2.1293349,"opportunityId":{"id":846,"value":"Opportunity 2015-2016"},"permissionLevel":2,"readOnly":false,"salesRepId":{"id":5548,"value":"Luis Sánchez"},"salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"typeId":{"id":6419,"value":"Meeting"}}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-activity","summary":"Create Activity","description":"This endpoint allows you to create an Activity based on JSON input.\n\nYou will only be able to create an Activity after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId (*Required*) | Integer | ID of the Account to which the Activity is linked to (see [Accounts](#) resource) |\n| contactId | Integer | Contact the Activity is linked to (see [Contacts](#) resource) |\n| opportunityId | Integer | Opportunity to which the Activity is linked to (see [Opportunities](#) resource) |\n| typeId (*Required*) | Integer | Activity Type ID (see [Types](#) resource) |\n| salesRepId (*Required*) | Integer | Unique identifier of the User associated to the Activity (see [Users](#) resource) |\n| checkin | Boolean | True in the case the Activity had been certified to done within the geofencing range, false otherwise |\n| checkinTypeId | Integer | It exists three different types of checkin: 1 (check-in at an Account's location); 2 (check-in at an open Opportunity); 3 (fast check-in when a User reports a physical visit without having to link them to any existing Account or Opportunity in ForceManager) |\n| checkoutDate | String | Date and time for the check-out. Registers the end of a visit to a client |\n| comment | String | A comment of the Activity |\n| date (*Required*) | String | Date referred to the moment in which the Activity took place |\n| geocoded | Boolean | If true, the Activity has been geolocated and a geocode is automatically calculated by the system (latitude and longitude) |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| permissionLevel | String | Defines the visibility of the Activity. Set from 1 to 5 being 5 the highest level of permission |\n| readOnly | Boolean | If true, the Activity cannot be modified or deleted |\n| extId | String | External ID of the Activity from a third party system (ERP, CRM, Accounting System) |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new Activity |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Activity","content":{"application/json":{"examples":{"default":{"value":{"id":1120,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"integer"},"date":{"type":"string"},"checkin":{"type":"boolean"},"checkinTypeId":{"type":"integer"},"comment":{"type":"string"},"opportunityId":{"type":"integer"},"permissionLevel":{"type":"integer"},"salesRepId":{"type":"integer"},"typeId":{"type":"integer"}}},"examples":{"default":{"value":{"accountId":1183,"date":"2018-06-19 10:42:12","checkin":false,"checkinTypeId":1,"comment":"Electronic signatures is a very useful tool for the customer","opportunityId":1,"permissionLevel":1,"salesRepId":2101,"typeId":6421}}}}}}}},"/activities/{ID}":{"get":{"operationId":"get-activity","summary":"Get Activity","description":"This endpoint retrieves data of a specific Activity based on JSON input. The API returns a single Activity available to the user, according to the unique ID provided. If the specified Activity does not exist, the response will be a \"bad request\".\n\nYou will only receive the Activity after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Activity |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId (*Required*) | Object, Null | ID of the Account to which the Activity is linked to (see [Accounts](#) resource) |\n| contactId | Object, Null | Contact the Activity is linked to (see [Contacts](#) resource) |\n| opportunityId | Object, Null | Opportunity to which the Activity is linked to (see [Opportunities](#) resource) |\n| typeId (*Required*) | Object, Null | Activity Type ID (see [Types](#) resource) |\n| salesRepId | Object, Null | Unique identifier of the User associated to the Activity (see [Users](#) resource) |\n| checkin | Boolean | True in the case the Activity had been certified to done within the geofencing range, false otherwise |\n| checkinTypeId | Integer | It exists three different types of checkin: 1 (check-in at an Account's location); 2 (check-in at an open Opportunity); 3 (fast check-in when a User reports a physical visit without having to link them to any existing Account or Opportunity in ForceManager) |\n| checkoutDate | String | Date and time for the check-out. Registers the end of a visit to a client |\n| comment | String | A comment of the Activity |\n| date (*Required*) | String | Date referred to the moment in which the Activity took place |\n| geocoded | Boolean | If true, the Activity has been geolocated and a geocode is automatically calculated by the system (latitude and longitude) |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| permissionLevel | String | Defines the visibility of the Activity. Set from 1 to 5 being 5 the highest level of permission |\n| readOnly | Boolean | If true, the Activity cannot be modified or deleted |\n| extId | String | External ID of the Activity from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | Unique identifier for the Activity in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Activity |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Activity |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Activity |\n| dateCreated | String | Date and time when the Activity was created |\n| dateDeleted | String | Date and time when the Activity was deleted |\n| dateUpdated | String | Date and time when the Activity was last updated |\n| deleted | boolean | If true, the Activity has been deleted and archived |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [Optional]"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [Optional]"}],"responses":{"200":{"description":"Get Activity","content":{"application/json":{"examples":{"default":{"value":{"accountId":{"id":1186,"value":"Polaroid"},"checkin":false,"checkinTypeId":1,"checkoutDate":null,"comment":"Take samples","contactId":{"id":1056,"value":"Roger Chase"},"date":"2015-07-09T10:59:00Z","dateCreated":"2015-07-09T11:00:06.137Z","dateDeleted":null,"dateUpdated":"2018-06-12T09:20:40.96Z","deleted":false,"extId":null,"geocoded":true,"geocodingAccuracy":1,"id":799,"latitude":41.3910821,"longitude":2.1291351,"opportunityId":{"id":823,"value":"Opportunity 2015-7"},"permissionLevel":2,"readOnly":false,"salesRepId":{"id":5548,"value":"Luis Sánchez"},"salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":51,"typeId":{"id":6417,"value":"Video call"}}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-activity","summary":"Update Activity","description":"This endpoint allows you to update a specific Activity. If the specified Activity does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Activity after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Activity. In order to update an Activity, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Integer | ID of the Account to which the Activity is linked to (see [Accounts](#) resource) |\n| contactId | Integer | Contact the Activity is linked to (see [Contacts](#) resource) |\n| opportunityId | Integer | Opportunity to which the Activity is linked to (see [Opportunities](#) resource) |\n| typeId | Integer | Activity Type ID (see [Types](#) resource) |\n| salesRepId | Integer | Unique identifier of the User associated to the Activity (see [Users](#) resource) |\n| checkin | Boolean | True in the case the Activity had been certified to done within the geofencing range, false otherwise |\n| checkinTypeId | Integer | It exists three different types of checkin: 1 (check-in at an Account's location); 2 (check-in at an open Opportunity); 3 (fast check-in when a User reports a physical visit without having to link them to any existing Account or Opportunity in ForceManager) |\n| checkoutDate | String | Date and time for the check-out. Registers the end of a visit to a client |\n| comment | String | A comment of the Activity |\n| date | String | Date referred to the moment in which the Activity took place |\n| geocoded | Boolean | If true, the Activity has been geolocated and a geocode is automatically calculated by the system (latitude and longitude) |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile can detect |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| permissionLevel | String | Defines the visibility of the Activity. Set from 1 to 5 being 5 the highest level of permission |\n| readOnly | Boolean | If true, the Activity cannot be modified or deleted |\n| extId | String | External ID of the Activity from a third party system (ERP, CRM, Accounting System) |\n\n**RESPONSE**\n\nReturns a JSON with information about the Activity just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Activity","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string"},"geocoded":{"type":"boolean"},"geocodingAccuracy":{"type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"}}},"examples":{"default":{"value":{"comment":"Take samples","geocoded":true,"geocodingAccuracy":1,"latitude":41.3910821,"longitude":2.1291351}}}}}}},"delete":{"operationId":"delete-activity","summary":"Delete Activity","description":"This endpoint allows you to delete a specific Activity from the user's ForceManager implementation database. If the specified Activity does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Activities after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Activity to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Activity just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Activity","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/activityTypes/schema":{"get":{"operationId":"activity-types-schema","summary":"Activity Types schema","description":"Returns properties object with the definition of each field in the Activity Type table. \nWith the Activity Type you can differentiate the Type of Activity with which professional relationships are stablished.\n\nYou will only receive the Activity Type Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Activity Type Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Activity Types schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"automatic":{"description":"","readOnly":false,"type":["boolean","null"]},"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"checkin":{"description":"","readOnly":false,"type":["boolean","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"fastCheckin":{"description":"","readOnly":false,"type":["boolean","null"]},"general":{"description":"","readOnly":false,"type":["boolean","null"]},"hide":{"description":"","readOnly":false,"type":["boolean","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"order":{"description":"","readOnly":false,"type":["integer","null"]},"phoneCall":{"description":"","readOnly":false,"type":["boolean","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"system":{"description":"","readOnly":false,"type":["boolean","null"]},"videoCall":{"description":"","readOnly":false,"type":["boolean","null"]},"visibleInActivities":{"description":"","readOnly":false,"type":["boolean","null"]},"visibleInAgendaActivities":{"description":"","readOnly":false,"type":["boolean","null"]},"visit":{"description":"","readOnly":false,"type":["boolean","null"]},"workflow":{"description":"","readOnly":false,"type":["boolean","null"]}},"required":[],"title":"activityTypes","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/activityTypes":{"get":{"operationId":"list-activity-types","summary":"List Activity Types","description":"Returns all Activity Types available in the user's ForceManager implementation database.\n\nYou will only receive the List of Activity Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/activityTypes?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/activityTypes?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can also **organise and view** the results for Activity Types in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/activityTypes?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/activityTypes?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Activity Types available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Activity Types attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array, Null | In which Branches the Activity Type is visible |\n| descriptionBR | String | Activity Type name in Brasilian Portuguese |\n| descriptionDE | String | Activity Type name in German |\n| descriptionDK | String | Activity Type name in Dutch |\n| descriptionEN | String | Activity Type name in English |\n| descriptionES | String | Activity Type name in Spanish |\n| descriptionFR | String | Activity Type name in French |\n| descriptionIT | String | Activity Type name in Italian |\n| descriptionPT | String | Activity Type name in Portuguese |\n| descriptionRU | String | Activity Type name in Russian |\n| descriptionUS | String | Activity Type name in American English |\n| general | Boolean | If true, this Activity Type will appear when adding a normal Activity |\n| checkin | Boolean | If true, this Activity Type will appear when doing a check-in |\n| fastCheckin | Boolean | If true, this Activity Type will appear when doing a fast check-in |\n| phoneCall | Boolean | If true, the Activity Type is a phone call |\n| visit | Boolean | If true, the Activity Type is a visit |\n| videoCall | Boolean | If true, the Activity Type is a video call |\n| visibleInActivities | Boolean | If true, the Activity Type is visible in the activity feed |\n| visibleInAgendaActivities | Boolean | If true, the Activity Type is visible in the calendar |\n| workflow | Boolean | If true, the Activity Type is visible in workflows |\n| id | Integer | Unique identifier for the Activity Type in ForceManager |\n| order | Integer | The position in what you want the Activity Type to appear in the list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Activity Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Activity Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Activity Type |\n| dateCreated | String | Date and time when the Activity Type was created |\n| dateDeleted | String | Date and time when the Activity Type was deleted |\n| dateUpdated | String | Date and time when the Activity Type was last updated |\n| deleted | Boolean | If true, the branch has been deleted and archived |\n| system (_Deprecated_) | Boolean | |\n| automatic (_Deprecated_) | Boolean | |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Activity Types","content":{"application/json":{"examples":{"default":{"value":[{"automatic":false,"branchVisibility":null,"checkin":false,"dateCreated":"2012-01-27T12:22:54.23Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.23Z","deleted":false,"descriptionBR":null,"descriptionDE":"Telefonanruf","descriptionDK":null,"descriptionEN":"Phone call","descriptionES":"Llamada Telefónica","descriptionFR":"Appel téléphonique","descriptionIT":"Telefonata","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"fastCheckin":false,"general":true,"hide":false,"id":1,"order":null,"phoneCall":true,"salesRepIdCreated":null,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"system":true,"videoCall":false,"visibleInActivities":true,"visibleInAgendaActivities":true,"visit":false,"workflow":false},{"automatic":false,"branchVisibility":null,"checkin":true,"dateCreated":"2012-01-27T12:22:54.23Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.23Z","deleted":false,"descriptionBR":null,"descriptionDE":"Besuch","descriptionDK":null,"descriptionEN":"Visit","descriptionES":"Visita","descriptionFR":"Visite","descriptionIT":"Visita","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"fastCheckin":false,"general":true,"hide":false,"id":4,"order":null,"phoneCall":false,"salesRepIdCreated":null,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"system":false,"videoCall":false,"visibleInActivities":true,"visibleInAgendaActivities":true,"visit":true,"workflow":false},{"automatic":false,"branchVisibility":null,"checkin":false,"dateCreated":"2012-01-27T12:22:54.23Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.23Z","deleted":false,"descriptionBR":null,"descriptionDE":"Besprechung","descriptionDK":null,"descriptionEN":"Meeting","descriptionES":"Reunión","descriptionFR":"Réunion","descriptionIT":"Riunione","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"fastCheckin":false,"general":true,"hide":false,"id":5,"order":null,"phoneCall":false,"salesRepIdCreated":null,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"system":false,"videoCall":false,"visibleInActivities":true,"visibleInAgendaActivities":true,"visit":false,"workflow":false},{"automatic":false,"branchVisibility":null,"checkin":false,"dateCreated":"2012-01-27T12:22:54.23Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.23Z","deleted":false,"descriptionBR":null,"descriptionDE":"Kommentar","descriptionDK":null,"descriptionEN":"Comment","descriptionES":"Comentario","descriptionFR":"Commentaire","descriptionIT":"Commento","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"fastCheckin":false,"general":true,"hide":false,"id":8,"order":null,"phoneCall":false,"salesRepIdCreated":null,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"system":false,"videoCall":false,"visibleInActivities":true,"visibleInAgendaActivities":true,"visit":false,"workflow":false}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-activity-type","summary":"Create Activity Type","description":"This endpoint allows you to create an Activity Type based on JSON input.\n\nYou will only be able to create an Activity Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branches the Activity Type is visible |\n| descriptionBR | String | Activity Type name in Brasilian Portuguese |\n| descriptionDE | String | Activity Type name in German |\n| descriptionDK | String | Activity Type name in Dutch |\n| descriptionEN (*Required*) | String | Activity Type name in English |\n| descriptionES | String | Activity Type name in Spanish |\n| descriptionFR | String | Activity Type name in French |\n| descriptionIT | String | Activity Type name in Italian |\n| descriptionPT | String | Activity Type name in Portuguese |\n| descriptionRU | String | Activity Type name in Russian |\n| descriptionUS | String | Activity Type name in American English |\n| general | Boolean | If true, this Activity Type will appear when adding a normal Activity |\n| checkin | Boolean | If true, this Activity Type will appear when doing a check-in |\n| fastCheckin | Boolean | If true, this Activity Type will appear when doing a fast check-in |\n| phoneCall | Boolean | If true, the Activity Type is a phone call |\n| visit | Boolean | If true, the Activity Type is a visit |\n| videoCall | Boolean | If true, the Activity Type is a video call |\n| visibleInActivities | Boolean | If true, the Activity Type is visible in the activity feed |\n| visibleInAgendaActivities | Boolean | If true, the Activity Type is visible in the calendar |\n| workflow | Boolean | If true, the Activity Type is visible in workflows |\n| order | Integer | The position in what you want the Activity Type to appear in the list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Activity Type just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Activity Type |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Activity Type","content":{"application/json":{"examples":{"default":{"value":{"id":9,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"branchVisibility":{"type":"array"},"checkin":{"type":"boolean"},"descriptionEN":{"type":"string"},"descriptionES":{"type":"string"},"fastCheckin":{"type":"boolean"},"general":{"type":"boolean"},"order":{"type":"string"},"phoneCall":{"type":"boolean"},"visit":{"type":"boolean"},"videocall":{"type":"boolean"}}},"examples":{"default":{"value":{"branchVisibility":[16,17],"checkin":false,"descriptionEN":"Phone call","descriptionES":"Llamada Telefónica","fastCheckin":false,"general":true,"order":null,"phoneCall":true,"visit":false,"videocall":true}}}}}}}},"/activityTypes/{ID}":{"get":{"operationId":"get-activity-type","summary":"Get Activity Type","description":"This endpoint retrieves data of a specific Activity Type based on JSON input. The API returns a single Type available to the user in the Value List, according to the unique ID provided. If the specified Activity Type does not exist, the response will be a \"bad request\".\n\nYou will only receive the Activity Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Activity Type |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array, Null | In which Branches the Activity Type is visible |\n| descriptionBR | String | Activity Type name in Brasilian Portuguese |\n| descriptionDE | String | Activity Type name in German |\n| descriptionDK | String | Activity Type name in Dutch |\n| descriptionEN | String | Activity Type name in English |\n| descriptionES | String | Activity Type name in Spanish |\n| descriptionFR | String | Activity Type name in French |\n| descriptionIT | String | Activity Type name in Italian |\n| descriptionPT | String | Activity Type name in Portuguese |\n| descriptionRU | String | Activity Type name in Russian |\n| descriptionUS | String | Activity Type name in American English |\n| general | Boolean | If true, this Activity Type will appear when adding a normal Activity |\n| checkin | Boolean | If true, this Activity Type will appear when doing a check-in |\n| fastCheckin | Boolean | If true, this Activity Type will appear when doing a fast check-in |\n| phoneCall | Boolean | If true, the Activity Type is a phone call |\n| visit | Boolean | If true, the Activity Type is a visit |\n| videoCall | Boolean | If true, the Activity Type is a video call |\n| visibleInActivities | Boolean | If true, the Activity Type is visible in the activity feed |\n| visibleInAgendaActivities | Boolean | If true, the Activity Type is visible in the calendar |\n| workflow | Boolean | If true, the Activity Type is visible in workflows |\n| id | Integer | Unique identifier for the Activity Type in ForceManager |\n| order | Integer | The position in what you want the Activity Type to appear in the list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Activity Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Activity Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Activity Type |\n| dateCreated | String | Date and time when the Activity Type was created |\n| dateDeleted | String | Date and time when the Activity Type was deleted |\n| dateUpdated | String | Date and time when the Activity Type was last updated |\n| deleted | Boolean | If true, the branch has been deleted and archived |\n| system (*Deprecated*) | Boolean | |\n| automatic (*Deprecated*) | Boolean | |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Activity Type","content":{"application/json":{"examples":{"default":{"value":{"automatic":false,"branchVisibility":[{"id":16,"value":"Sales"},{"id":17,"value":"Support"}],"checkin":false,"dateCreated":"2021-12-15T22:11:57.95Z","dateDeleted":null,"dateUpdated":"2021-12-15T22:15:46.503Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Phone call","descriptionES":"Llamada Telefónica","descriptionFR":"appel téléphonique","descriptionIT":"telefonata","descriptionPT":"chamada telefonica","descriptionRU":null,"descriptionUS":null,"fastCheckin":false,"general":true,"hide":false,"id":9,"order":null,"phoneCall":true,"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":90,"system":false,"videoCall":true,"visibleInActivities":true,"visibleInAgendaActivities":true,"visit":false,"workflow":false}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-activity-type","summary":"Update Activity Type","description":"This endpoint allows you to update a specific Activity Type. If the specified Type does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Activity Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Activity Type. In order to update a Type, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branches the Activity Type is visible |\n| descriptionBR | String | Activity Type name in Brasilian Portuguese |\n| descriptionDE | String | Activity Type name in German |\n| descriptionDK | String | Activity Type name in Dutch |\n| descriptionEN | String | Activity Type name in English |\n| descriptionES | String | Activity Type name in Spanish |\n| descriptionFR | String | Activity Type name in French |\n| descriptionIT | String | Activity Type name in Italian |\n| descriptionPT | String | Activity Type name in Portuguese |\n| descriptionRU | String | Activity Type name in Russian |\n| descriptionUS | String | Activity Type name in American English |\n| general | Boolean | If true, this Activity Type will appear when adding a normal Activity |\n| checkin | Boolean | If true, this Activity Type will appear when doing a check-in |\n| fastCheckin | Boolean | If true, this Activity Type will appear when doing a fast check-in |\n| phoneCall | Boolean | If true, the Activity Type is a phone call |\n| visit | Boolean | If true, the Activity Type is a visit |\n| videoCall | Boolean | If true, the Activity Type is a video call |\n| visibleInActivities | Boolean | If true, the Activity Type is visible in the activity feed |\n| visibleInAgendaActivities | Boolean | If true, the Activity Type is visible in the calendar |\n| workflow | Boolean | If true, the Activity Type is visible in workflows |\n| order | Integer | The position in what you want the Activity Type to appear in the list |\n\n**RESPONSE** \nReturns a JSON with information about the Activity Type just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Activity Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionFR":{"type":"string"},"descriptionIT":{"type":"string"},"descriptionPT":{"type":"string"}}},"examples":{"default":{"value":{"descriptionFR":"appel téléphonique","descriptionIT":"telefonata","descriptionPT":"chamada telefonica"}}}}}}},"delete":{"operationId":"delete-activity-type","summary":"Delete Activity Type","description":"This endpoint allows you to delete a specific Activity Type from the user's ForceManager implementation database. If the specified Activity Type does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Activity Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Activity Type to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Activity Type just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Activity Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/activity/points":{"get":{"operationId":"list-activity-points","summary":"List Activity Points","description":"Returns all Activity Points available in the user's ForceManager implementation database.\n\nYou will only receive the List of Activity Points after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThis endpoint returns all Activity Points that can be set, that are:\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| IntervalDays | Integer | Days before today that will be used to calculate the Scores |\n| PointsPerActivity | Integer | Points that the user will receive when performing an Activity that is not of \"Visit\" Type |\n| PointsPerCheckin | Integer | Points that the user will receive when performing a \"Checkin\" |\n| PointsPerEmail | Integer | Points that the user will receive for each received/sent \"Email\" |\n| PointsPerInternalEmail | Integer | Points the user will receive for each \"Email\" they receive/send internal |\n| PointsPerInternalPhoneCallMinute | Integer | Points the user will receive depending on the duration of their internal \"Calls\" |\n| PointsPerOpportunity | Integer | Points the user will receive for each Opportunity won |\n| PointsPerPhoneCallMinute | Integer | Points the user will receive depending on the duration of their \"Calls\" |\n| PointsPerSalesOrder | Integer | Points that the user will receive for each Order won |\n| PointsPerVisit | Integer | Points that the user will receive when performing an Activity of \"Visit\" Type |\n| SalesInput | Integer | The sales will be calculated: 0 -> with customized Z_viewsalesuser. If 1 -> With won Opportunities. If 2 -> With won Quotes. If 3 -> With won sales Orders |\n| ScoringPerEnvironment | Integer | 0 -> the scores will be relative to the all implementation. If different than 0 the scores will be relative to the Branch |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Points"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List activity points","content":{"application/json":{"examples":{"default":{"value":{"IntervalDays":0,"PointsPerActivity":60,"PointsPerCheckin":60,"PointsPerEmail":60,"PointsPerFastCheckin":60,"PointsPerInternalEmail":60,"PointsPerInternalPhoneCallMinute":432,"PointsPerOpportunity":60,"PointsPerPhoneCallMinute":450,"PointsPerQuote":60,"PointsPerSalesOrder":20,"PointsPerVisit":60,"SalesInput":0,"ScoringPerEnvironment":0}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-activity-points","summary":"Update Activity Points","description":"This endpoint allows you to update one or more Activity Points.\n\nYou will only be able to update an Activity Point after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of an Activity Point. In order to update a Point, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| IntervalDays | Integer | Days before today that will be used to calculate the Scores |\n| PointsPerActivity | Integer | Points that the user will receive when performing an Activity that is not of \"Visit\" Type |\n| PointsPerCheckin | Integer | Points that the user will receive when performing a \"Checkin\" |\n| PointsPerEmail | Integer | Points that the user will receive for each received/sent \"Email\" |\n| PointsPerInternalEmail | Integer | Points the user will receive for each \"Email\" they receive/send internal |\n| PointsPerInternalPhoneCallMinute | Integer | Points the user will receive depending on the duration of their internal \"Calls\" |\n| PointsPerOpportunity | Integer | Points the user will receive for each Opportunity won |\n| PointsPerPhoneCallMinute | Integer | Points the user will receive depending on the duration of their \"Calls\" |\n| PointsPerSalesOrder | Integer | Points that the user will receive for each Order won |\n| PointsPerVisit | Integer | Points that the user will receive when performing an Activity of \"Visit\" Type |\n| SalesInput | Integer | The sales will be calculated: 0 -> with customized Z_viewsalesuser. If 1 -> With won Opportunities. If 2 -> With won Quotes. If 3 -> With won sales Orders |\n| ScoringPerEnvironment | Integer | 0 -> the scores will be relative to the all implementation. If different than 0 the scores will be relative to the Branch |\n\n**RESPONSE** \nReturns a JSON with information about the Activity Point just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Activities / Points"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Activity Points","content":{"application/json":{"examples":{"default":{"value":{"IntervalDays":0,"PointsPerActivity":60,"PointsPerCheckin":60,"PointsPerEmail":60,"PointsPerInternalEmail":60,"PointsPerInternalPhoneCallMinute":432,"PointsPerOpportunity":60,"PointsPerPhoneCallMinute":450,"PointsPerQuote":60,"PointsPerVisit":60,"SalesInput":0,"ScoringPerEnvironment":0}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"IntervalDays":{"type":"integer"},"PointsPerActivity":{"type":"integer"},"PointsPerCheckin":{"type":"integer"},"PointsPerEmail":{"type":"integer"},"PointsPerFastCheckin":{"type":"integer"},"PointsPerInternalEmail":{"type":"integer"},"PointsPerInternalPhoneCallMinute":{"type":"integer"},"PointsPerOpportunity":{"type":"integer"},"PointsPerPhoneCallMinute":{"type":"integer"},"PointsPerQuote":{"type":"integer"},"PointsPerSalesOrder":{"type":"integer"},"PointsPerVisit":{"type":"integer"},"SalesInput":{"type":"integer"},"ScoringPerEnvironment":{"type":"integer"}}},"examples":{"default":{"value":{"IntervalDays":0,"PointsPerActivity":60,"PointsPerCheckin":60,"PointsPerEmail":60,"PointsPerFastCheckin":60,"PointsPerInternalEmail":60,"PointsPerInternalPhoneCallMinute":432,"PointsPerOpportunity":60,"PointsPerPhoneCallMinute":450,"PointsPerQuote":60,"PointsPerSalesOrder":20,"PointsPerVisit":60,"SalesInput":0,"ScoringPerEnvironment":0}}}}}}}},"/login":{"post":{"operationId":"login","summary":"Login","description":"","tags":["Authentication"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Login","content":{"application/json":{"examples":{"default":{"value":{"token":"MTUyODcxMTk1MXxRd3dBUUhzaVNXMXdiR1Z0Wlc1MFlYUnBiMjVKWkNJNklqRXdOak1jkaVZYTmxja2xrSWpvaU5URWlMQ0pVYVcxbFNXNXBkQ0k2TVRVeU9EY3hNVGsxTVgwPXyYpNYcZ6zQTU5q5wkh3b5KLYFmKi_rqIswzH6H9zwm1w=="}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}}},"examples":{"default":{"value":{"username":"YOUR_PUBLIC_KEY","password":"YOUR_PRIVATE_KEY"}}}}}}}},"/branches/schema":{"get":{"operationId":"branches-schema","summary":"Branches schema","description":"Returns properties object with the definition of each field in the Branches table.\n\nYou will only receive the Branches Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Branches Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Branches"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Branches schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"currencyId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"currencies","type":["object","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"default":{"description":"","readOnly":false,"type":["boolean","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"extId":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"imperialSystem":{"description":"","readOnly":false,"type":["boolean","null"]},"mainEnvironment":{"description":"","readOnly":false,"type":["boolean","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"timeZoneId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"tblTimeZones","type":["object","null"]}},"required":["currencyId","timeZoneId"],"title":"branches","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/branches":{"get":{"operationId":"list-branches","summary":"List Branches","description":"Returns all Branches. You will only receive the Branches after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Branches available for the value list.\n\nList of the supported Branches attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| currencyId | Object, Null | ID of the Currency (see [Currencies](#) resource) associated to the Branch |\n| dateCreated | String | Date and time when the Branch was created |\n| dateDeleted | String | Date and time when the Branch was deleted |\n| dateUpdated | String | Date and time when the Branch was last updated |\n| default | Boolean | If true, the Branch is the one assigned by default, this is valid for any kind of implementations |\n| deleted | Boolean | If true, the Branch has been deleted and archived |\n| descriptionBR | String | Branch name in Brasilian Portuguese |\n| descriptionDE | String | Branch name in German |\n| descriptionDK | String | Branch name in Dutch |\n| descriptionEN | String | Branch name in English |\n| descriptionES | String | Branch name in Spanish |\n| descriptionFR | String | Branch name in French |\n| descriptionIT | String | Branch name in Italian |\n| descriptionPT | String | Branch name in Portuguese |\n| descriptionRU | String | Branch name in Russian |\n| descriptionUS | String | Branch name in American English |\n| extId | String | External unique identifier for the Branch |\n| id | Integer | Unique identifier for the Branch in ForceManager |\n| imperialSystem | Boolean | If true, the Branch adopt the imperial system measurement (i.e. miles instead of km) |\n| mainEnvironment | Boolean | If true, the Branch is the main one, for long tail implementations |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Branch |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Branch |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Branch |\n| timeZoneId | Object | The id and the friendly name of the Branch timezone |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Branches"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Branches","content":{"application/json":{"examples":{"default":{"value":[{"currencyId":null,"dateCreated":"2009-06-09T19:51:11Z","dateDeleted":null,"dateUpdated":"2021-11-30T18:09:26.95Z","default":false,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Main Environment","descriptionES":"Main Environment","descriptionFR":null,"descriptionIT":"Main Environment","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"extId":"","id":16,"imperialSystem":false,"mainEnvironment":false,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":90,"timeZoneId":{"id":31,"value":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris"}}]}}}}}},"security":[{"SessionKey":[]}]}},"/branches/{ID}":{"get":{"operationId":"get-branch","summary":"Get Branch","description":"This endpoint retrieves data of a specific Branch based on JSON input. The API returns a single Branch available to the user in the Value List, according to the unique ID provided. If the specified Branch does not exist, the response will be a \"bad request\".\n\nYou will only receive the Branch after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier for the Branch to retrieve data |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| currencyId | Object, Null | ID of the Currency (see [Currencies](#) resource) associated to the Branch |\n| dateCreated | String | Date and time when the Branch was created |\n| dateDeleted | String | Date and time when the Branch was deleted |\n| dateUpdated | String | Date and time when the Branch was last updated |\n| default | Boolean | If true, the Branch is the one assigned by default, this is valid for any kind of implementations |\n| deleted | Boolean | If true, the Branch has been deleted and archived |\n| descriptionBR | String | Branch name in Brasilian Portuguese |\n| descriptionDE | String | Branch name in German |\n| descriptionDK | String | Branch name in Dutch |\n| descriptionEN | String | Branch name in English |\n| descriptionES | String | Branch name in Spanish |\n| descriptionFR | String | Branch name in French |\n| descriptionIT | String | Branch name in Italian |\n| descriptionPT | String | Branch name in Portuguese |\n| descriptionRU | String | Branch name in Russian |\n| descriptionUS | String | Branch name in American English |\n| extId | String | External unique identifier for the Branch |\n| id | Integer | Unique identifier for the Branch in ForceManager |\n| imperialSystem | Boolean | If true, the Branch adopt the imperial system measurement (i.e. miles instead of km) |\n| mainEnvironment | Boolean | If true, the Branch is the main one, for long tail implementations |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Branch |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Branch |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Branch |\n| timeZoneId | Object | The id and the friendly name of the Branch timezone |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Branches"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Branch","content":{"application/json":{"examples":{"default":{"value":{"currencyId":null,"dateCreated":"2009-06-09T19:51:11Z","dateDeleted":null,"dateUpdated":"2021-11-30T18:09:26.95Z","default":false,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Main Environment","descriptionES":"Main Environment","descriptionFR":null,"descriptionIT":"Main Environment","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"extId":"","id":16,"imperialSystem":false,"mainEnvironment":false,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":90,"timeZoneId":{"id":31,"value":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris"}}}}}}}},"security":[{"SessionKey":[]}]},"delete":{"operationId":"delete-branch","summary":"Delete Branch","description":"This endpoint allows you to delete a specific Branch from the Value List. If the specified Branch does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete a Branch after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| id | Integer | The unique and specific identifier of the Branch to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Branch just deleted.\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Branches"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Branch","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/VALUE/bulk":{"post":{"operationId":"bulk-create-resources","summary":"Bulk Create Resources","description":"This endpoint allows you to create multiple Resources (200 entities for request) based on JSON input.\n\nYou will only be able to create multiple Resources after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nYou have to send a Array with the following JSON data:\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | String | Unique operation identifier |\n| data | Object | JSONObject with the Resource data (same data as Create Resource method) |\n\nYou can check the \"data\" object in the specific documentation section of each resource (e.g. [Accounts](#), [Contacts](#), [Opportunities](#), [Orders](#), [Value Lists](#)).\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | Integer | Unique operation identifier |\n| id | Integer | Id assigned to the new Resource |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Bulks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Bulk Create Accounts","content":{"application/json":{"examples":{"default":{"value":[{"id":403,"message":"Entity create success","guid":"UniqueIdentifierOperation_1","code":1},{"id":404,"message":"Entity create success","guid":"UniqueIdentifierOperation_2","code":1}]}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"default":{"value":[{"guid":"UniqueIdentifierOperation_1","data":{}},{"guid":"UniqueIdentifierOperation_2","data":{}}]}}}}}},"put":{"operationId":"bulk-update-resources","summary":"Bulk Update Resources","description":"This endpoint allows you to update a multiple Resources (200 entities for request) information from the user's ForceManager implementation database. \nIn order to update multiple Resources, 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.\n\nYou will only be able to update a Resource after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of multiple Resources. In order to update a Resource, 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.**\n\nYou have to send an Array with the following JSON data:\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | String | Unique operation identifier |\n| data | Object | JSONObject with the Resource data (same data as Create Resource method) |\n| id | Integer | Unique Resource's identifier |\n\nYou can check the \"data\" object in the specific documentation section of each resource (e.g. [Accounts](#), [Contacts](#), [Opportunities](#), [Orders](#), [Value Lists](#)).\n\n**RESPONSE**\n\nReturns a JSON with information about the Resource just updated.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Bulks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Bulk Update Accounts","content":{"application/json":{"examples":{"default":{"value":[{"id":19,"message":"Entity update success","guid":"UniqueOperationIdentifier_1","code":1},{"id":21,"message":"Entity update success","guid":"UniqueOperationIdentifier_2","code":1}]}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"default":{"value":[{"guid":"UniqueOperationIdentifier_1","id":19,"data":{}},{"guid":"UniqueOperationIdentifier_2","id":21,"data":{}}]}}}}}},"delete":{"operationId":"bulk-delete-resources","summary":"Bulk Delete Resources","description":"This endpoint allows you to delete multiple Resources (120 entities for request) from the user's ForceManager implementation database. If the specified Resource does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete multiple Resources after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nYou have to send an Array with the following JSON data:\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | String | Unique operation identifier |\n| id | Integer | Unique Resource's identifier |\n\n**RESPONSE**\n\nReturns a JSON with information about the Resource just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | Integer | Unique operation identifier |\n| id | Integer | Id assigned to the new Resource |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Bulks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Bulk Delete Accounts","content":{"application/json":{"examples":{"default":{"value":[{"id":19,"message":"Entity delete success","guid":"UniqueOperationIdentifier_1","code":1},{"id":21,"message":"Entity delete success","guid":"UniqueOperationIdentifier_2","code":1}]}}}}}},"security":[{"SessionKey":[]}]}},"/calls":{"get":{"operationId":"list-calls","summary":"List Calls","description":"Returns all Calls available in the user's ForceManager implementation database.\n\nYou will only receive the List of Calls after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\nYou can apply filters. The order of the parameters does not matter.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| offset | Integer | Define position from which the records must be returned |\n| count | Integer | Define the number of results to return |\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/users/scores?offset=VALUE&count=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Calls available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Calls attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| duration | Integer | Duration of the Call, in seconds |\n| startDate | String | Moment in which the Call is started |\n| endDate | String | Moment in which the Call is ended |\n| type | Integer | 0 if it is an incoming Call, 1 if it is an outgoing call, 2 if it is a missed call |\n| terminalType | Integer | Set to 1, it is a free field to eventually distinguish the type of terminals |\n| phone | String | The called phone number |\n| accountId | Integer | Account to which the Call is linked to (see [Accounts](#) resource) |\n| contactId | Integer | Contact to which the Call is linked to (see [Contacts](#) resource) |\n| salesRepId | Integer | Unique identifier of the User associated to the Call (see [Users](#) resource) |\n| opportunityId | Integer | Opportunity to which the Call is linked to (see [Opportunities](#) resource) |\n| phoneAlias | String | An alias of the phone number, e.g. a Contact name |\n| description | String | A descriptive text of the Call content |\n| timeZoneId | Integer | TimeZone of the Call (see [TimeZones](#) resource) |\n| id | Integer | Unique identifier for the Call in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Call |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Call |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Call |\n| dateCreated | String | Date and time when the Call was created |\n| dateDeleted | String | Date and time when the Call was deleted |\n| dateUpdated | String | Date and time when the Call was last updated |\n| deleted | boolean | If true, the Call has been deleted and archived |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Calls"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Calls","content":{"application/json":{"examples":{"default":{"value":[{"duration":40,"startDate":"0001/01/01 00:00:00","endDate":"0001/01/01 00:00:00","type":1,"terminalType":1,"phone":"00190320984","accountId":-1,"contactId":-1,"salesRepId":-1,"opportunityId":-1,"phoneAlias":"","description":"Urgent call","timeZoneId":31,"deleted":true,"dateCreated":null,"dateDeleted":"2016-02-09T11:11:53.287Z","dateUpdated":null,"salesRepIdCreated":-1,"salesRepIdUpdated":-1,"salesRepIdDeleted":1,"id":78996},{"duration":28,"startDate":"2009/01/07 11:19:15","endDate":"2009/01/07 11:19:43","type":1,"terminalType":1,"phone":"+34667426052","accountId":92,"contactId":119,"salesRepId":63,"opportunityId":-1,"phoneAlias":"Tom Clancy","description":"","timeZoneId":31,"deleted":false,"dateCreated":"2021-12-21T12:36:43.657Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":120,"salesRepIdUpdated":-1,"salesRepIdDeleted":-1,"id":78999}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-call-by-user-id","summary":"Create Call by User ID","description":"This endpoint allows you to create a Call based on JSON input, providing the ForceManager User ID to whom the Call has to be associated.\n\nYou will only be able to create a Call after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| duration | Integer | Duration of the Call, in seconds |\n| startDate | String | Moment in which the Call is started |\n| endDate | String | Moment in which the Call is ended |\n| type | Integer | 0 if it is an incoming Call, 1 if it is an outgoing call, 2 if it is a missed call |\n| terminalType | Integer | Set to 1, it is a free field to eventually distinguish the type of terminals |\n| phone (*Required*) | String | The called phone number |\n| accountId (*Required*) | Integer | Account to which the Call is linked to (see [Accounts](#) resource) |\n| contactId | Integer | Contact to which the Call is linked to (see [Contacts](#) resource) |\n| salesRepId (*Required*) | Integer | Unique identifier of the User associated to the Call (see [Users](#) resource) |\n| opportunityId | Integer | Opportunity to which the Call is linked to (see [Opportunities](#) resource) |\n| phoneAlias | String | An alias of the phone number, e.g. a Contact name |\n| description | String | A descriptive text of the Call content |\n| timeZoneId | Integer | TimeZone of the Call (see [TimeZones](#) resource) |\n\n**RESPONSE**\n\nReturns a JSON with information about the Call just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Opportunity |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Calls"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Call by User ID - Deprecated","content":{"application/json":{"examples":{"default":{"value":[{"duration":988,"startDate":"2009/01/07 11:19:15","endDate":"2009/01/07 11:35:43","type":1,"terminalType":1,"phone":"+34667426052","accountId":92,"contactId":119,"salesRepId":63,"opportunityId":-1,"phoneAlias":"Bob O'Malley ","description":"","timeZoneId":31,"deleted":false,"dateCreated":"2021-12-21T16:14:08.453Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":-1,"salesRepIdDeleted":-1,"id":79007},{"duration":0,"startDate":"2009/01/07 11:19:15","endDate":"2009/01/07 11:19:15","type":2,"terminalType":1,"phone":"+34667426052","accountId":92,"contactId":119,"salesRepId":63,"opportunityId":-1,"phoneAlias":"Bob O'Malley ","description":"","timeZoneId":31,"deleted":false,"dateCreated":"2021-12-21T16:14:08.523Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":-1,"salesRepIdDeleted":-1,"id":79008}]}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"type":{"type":"integer"},"terminalType":{"type":"integer"},"phone":{"type":"string"},"accountId":{"type":"integer"},"contactId":{"type":"integer"},"salesRepId":{"type":"integer"},"opportunityId":{"type":"integer"},"phoneAlias":{"type":"string"},"timeZoneId":{"type":"integer"}}},"examples":{"default":{"value":{"startDate":"2009/01/07 11:19:15","endDate":"2009/01/07 11:35:43","type":1,"terminalType":1,"phone":"+34667426052","accountId":92,"contactId":119,"salesRepId":63,"opportunityId":-1,"phoneAlias":"Bob O'Malley","timeZoneId":31}}}}}}}},"/calls/identify":{"post":{"operationId":"create-call-by-user-phone-number","summary":"Create Call by User Phone Number","description":"This endpoint allows you to create a Call based on JSON input, providing as an identifier of the ForceManager User its email instead of the ID. This endpoint is useful in the case in which the external system (e.g. a PBX) is not aware of the ForceManager User ID but it has the reference of all the Users' phone numbers.\n\nYou will only be able to create a Call after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| duration | Integer | Duration of the Call, in seconds |\n| startDate | String | Moment in which the Call is started |\n| endDate | String | Moment in which the Call is ended |\n| type | Integer | 0 if it is an incoming Call, 1 if it is an outgoing call, 2 if it is a missed call |\n| terminalType | Integer | Set to 1, it is a free field to eventually distinguish the type of terminals |\n| phone (*Required*) | String | The called phone number |\n| accountId (*Required*) | Integer | Account to which the Call is linked to (see [Accounts](#) resource) |\n| contactId | Integer | Contact to which the Call is linked to (see [Contacts](#) resource) |\n| userPhoneFM (*Required*) | Integer | ForceManager email of the User associated to the Call (see [Users](#) resource) provided as unique identifier in place of the User ID |\n| opportunityId | Integer | Opportunity to which the Call is linked to (see [Opportunities](#) resource) |\n| phoneAlias | String | An alias of the phone number, e.g. a Contact name |\n| description | String | A descriptive text of the Call content |\n| timeZoneId | Integer | TimeZone of the Call (see [TimeZones](#) resource) |\n\n**RESPONSE**\n\nReturns a JSON with information about the Call just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Opportunity |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Calls"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Call by User Phone Number","content":{"application/json":{"examples":{"default":{"value":{"message":"success"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"type":{"type":"integer"},"terminalType":{"type":"integer"},"phone":{"type":"string"},"accountId":{"type":"integer"},"contactId":{"type":"integer"},"userPhoneFM":{"type":"string"},"opportunityId":{"type":"integer"},"phoneAlias":{"type":"string"},"timeZoneId":{"type":"integer"}}},"examples":{"default":{"value":{"startDate":"2009/01/07 11:19:15","endDate":"2009/01/07 11:35:43","type":1,"terminalType":1,"phone":"+34667426052","accountId":92,"contactId":119,"userPhoneFM":"+0189732291","opportunityId":-1,"phoneAlias":"Bob O'Malley","timeZoneId":31}}}}}}}},"/calls/{ID}":{"get":{"operationId":"get-call","summary":"Get Call","description":"This endpoint retrieves data of a specific Call based on JSON input. The API returns a single Call available to the user, according to the unique ID provided. If the specified Call does not exist, the response will be a \"bad request\".\n\nYou will only receive the Call after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | integer | The unique and specific identifier of the Call |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| duration | Integer | Duration of the Call, in seconds |\n| startDate | String | Moment in which the Call is started |\n| endDate | String | Moment in which the Call is ended |\n| type | Integer | 0 if it is an incoming Call, 1 if it is an outgoing call, 2 if it is a missed call |\n| terminalType | Integer | Set to 1, it is a free field to eventually distinguish the type of terminals |\n| phone | String | The called phone number |\n| accountId | Integer | Account to which the Call is linked to (see [Accounts](#) resource) |\n| contactId | Integer | Contact to which the Call is linked to (see [Contacts](#) resource) |\n| salesRepId | Integer | Unique identifier of the User associated to the Call (see [Users](#) resource) |\n| opportunityId | Integer | Opportunity to which the Call is linked to (see [Opportunities](#) resource) |\n| phoneAlias | String | An alias of the phone number, e.g. a Contact name |\n| description | String | A descriptive text of the Call content |\n| timeZoneId | Integer | TimeZone of the Call (see [TimeZones](#) resource) |\n| id | Integer | Unique identifier for the Call in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Call |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Call |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Call |\n| dateCreated | String | Date and time when the Call was created |\n| dateDeleted | String | Date and time when the Call was deleted |\n| dateUpdated | String | Date and time when the Call was last updated |\n| deleted | boolean | If true, the Call has been deleted and archived |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Calls"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Call","content":{"application/json":{"examples":{"default":{"value":{"duration":28,"startDate":"2009/01/07 11:19:15","endDate":"2009/01/07 11:19:43","type":0,"terminalType":0,"phone":"3493223255","accountId":92,"contactId":119,"salesRepId":63,"opportunityId":-1,"phoneAlias":"Mark Clancy ","description":"","timeZoneId":31,"deleted":true,"dateCreated":null,"dateDeleted":"2016-02-09T11:11:53.287Z","dateUpdated":"2021-12-21T16:01:02.253Z","salesRepIdCreated":-1,"salesRepIdUpdated":90,"salesRepIdDeleted":1,"id":78996}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-call","summary":"Update Call","description":"This endpoint allows you to update specific information of a Call. If the specified Call does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Call after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Call. In order to update a Call, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| duration | Integer | Duration of the Call, in seconds |\n| startDate | String | Moment in which the Call is started |\n| endDate | String | Moment in which the Call is ended |\n| type | Integer | 0 if it is an incoming Call, 1 if it is an outgoing call, 2 if it is a missed call |\n| terminalType | Integer | Set to 1, it is a free field to eventually distinguish the type of terminals |\n| phone | String | The called phone number |\n| accountId | Integer | Account to which the Call is linked to (see [Accounts](#) resource) |\n| contactId | Integer | Contact to which the Call is linked to (see [Contacts](#) resource) |\n| salesRepId | Integer | Unique identifier of the User associated to the Call (see [Users](#) resource) |\n| opportunityId | Integer | Opportunity to which the Call is linked to (see [Opportunities](#) resource) |\n| phoneAlias | String | An alias of the phone number, e.g. a Contact name |\n| description | String | A descriptive text of the Call content |\n| timeZoneId | Integer | TimeZone of the Call (see [TimeZones](#) resource) |\n\n**RESPONSE**\n\nReturns a JSON with information about the Call just updated.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Calls"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Call","content":{"application/json":{"examples":{"default":{"value":{"duration":28,"startDate":"2009/01/07 11:19:15","endDate":"2009/01/07 11:19:43","type":0,"terminalType":0,"phone":"3493223255","accountId":92,"contactId":119,"salesRepId":63,"opportunityId":-1,"phoneAlias":"Mark Clancy ","description":"","timeZoneId":31,"deleted":true,"dateCreated":null,"dateDeleted":"2016-02-09T11:11:53.287Z","dateUpdated":"2021-12-21T16:01:02.253Z","salesRepIdCreated":-1,"salesRepIdUpdated":90,"salesRepIdDeleted":1,"id":78996}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"},"phone":{"type":"string"},"accountId":{"type":"integer"},"contactId":{"type":"integer"},"salesRepId":{"type":"integer"},"opportunityId":{"type":"integer"},"phoneAlias":{"type":"string"},"timeZoneId":{"type":"integer"}}},"examples":{"default":{"value":{"startDate":"2009/01/07 11:19:15","endDate":"2009/01/07 11:19:43","phone":"3493223255","accountId":92,"contactId":119,"salesRepId":63,"opportunityId":-1,"phoneAlias":"Mark Clancy","timeZoneId":31}}}}}}},"delete":{"operationId":"delete-call","summary":"Delete Call","description":"This endpoint allows you to delete a specific Call from the user's ForceManager implementation database. If the specified Call does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete a Call after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Call to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Call just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Calls"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"400":{"description":"Delete Call","content":{"application/json":{"examples":{"default":{"value":{"code":-1,"error":"not exist"}}}}}}},"security":[{"SessionKey":[]}]}},"/calls/phone/VALUE":{"get":{"operationId":"get-resources-by-phone-number","summary":"Get Resources by Phone Number","description":"The Calls API provides a simple interface to manage your Calls. Calls are generally made via mobile apps, VoIP services or PBX systems.\n\nThe API allows you to read, update and delete your Calls. You can retrieve individual Calls, as well as a complete list.\n\nYou can also determine whose Contacts, Accounts and Users are associated to specific phone numbers.\n\nAvailable methods:\n\n| Type | URL | Action |\n| --- | --- | --- |\n| GET | v4/calls | Get all Calls |\n| POST | v4/calls | Create a specific Call specifing a ForceManager User ID |\n| POST | v4/calls/identify | Create a specific Call specifing a ForceManager User phone number |\n| GET | v4/calls/:ID | Get a specific Call |\n| PUT | v4/calls/:ID | Update a specific Call |\n| DEL | v4/calls/:ID | Delete a specific Call |\n| GET | v4/calls/phone/VALUE | Get a list of Contacts, Accounts, Users IDs referred to a specific phone number |","tags":["Calls"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Resources by Phone Number","content":{"application/json":{"examples":{"default":{"value":{"userIds":[],"contactIds":[287,288,289],"accountIds":[1,1,1]}}}}}}},"security":[{"SessionKey":[]}]}},"/campaigns":{"get":{"operationId":"list-campaigns","summary":"List Campaigns","description":"Returns all Campaigns available in the user's ForceManager implementation database.\n\nYou will only receive the List of Campaigns after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou can apply filters. The order of the parameters does not matter.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| offset | Integer | Define position from which the records must be returned |\n| count | Integer | Define the number of results to return |\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/campaigns?offset=VALUE&count=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Campaigns available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Campaigns attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| title | String | A short descriptive name for the specific Campaign |\n| description | String | A longer description of the Campaign content, it can be also HTML |\n| videoUrl | String | A link to a video that describe the sales Campaign |\n| address2 | String | Second address to whom the Campaign is linked |\n| startDate | String | Date in wich the Campaign starts |\n| endDate | String | Date when the Campaign ends |\n| ownerId | Integer | Unique identifier of the User associated to the Campaign (see [Users](#) resource) |\n| typeId | Integer | Type of the Campaign (see [Types](#) resource) |\n| statusId | Integer | Status of the Campaign (see [Statues](#) resource) |\n| dateCreated | String | Date and time when the Campaign was created |\n| dateDeleted | String | Date and time when the Campaign was deleted |\n| dateUpdated | String | Date and time when the Campaign was last updated |\n| deleted | Boolean | If true, the Campaign has been deleted and archived |\n| id | Integer | Unique identifier for the Campaign in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Campaigns","content":{"application/json":{"examples":{"default":{"value":[{"title":"Promo Campaign to present the new products portfolio","description":"","ownerId":117,"statusId":1,"typeId":1,"startDate":"2021-09-25T15:04:05Z","endDate":"2022-09-30T15:04:05Z","deleted":true,"videoUrl":"https://www.youtube.com/watch?v=YmcFveP-P7k","dateCreated":"2021-12-29T10:40:32.66Z","dateDeleted":"2021-12-29T11:42:05.7Z","dateUpdated":"2021-12-29T10:41:43.097Z","salesRepIdCreated":90,"salesRepIdUpdated":90,"salesRepIdDeleted":90,"id":1},{"title":"Communication of the new pricing strategy for partners","description":"

Hi everyone.

We want to inform the new pricing strategy to the channel (see attached document).

To do this, we have assigned you the partners that correspond to your territories.

The campaign will end on February 26th.

In case of doubts, do not hesitate to ask. 


Channel

","ownerId":217,"statusId":4,"typeId":2,"startDate":"2021-01-21T23:00:00Z","endDate":"2021-02-26T22:59:59Z","deleted":false,"videoUrl":"https://www.youtube.com/watch?v=YmcFveP-P7k","dateCreated":"2021-12-29T10:44:39.07Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":0,"salesRepIdDeleted":0,"id":2}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-campaign","summary":"Create Campaign","description":"This endpoint allows you to create a Campaign based on JSON input.\n\nYou will only be able to create a Campaign after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| title (*Required*) | String | A short descriptive name for the specific Campaign |\n| description | String | A longer description of the Campaign content, it can be also HTML |\n| videoUrl | String | A link to a video that describe the sales Campaign |\n| address2 | String | Second address to whom the Campaign is linked |\n| startDate (*Required*) | String | Date in wich the Campaign starts |\n| endDate (*Required*) | String | Date when the Campaign ends |\n| ownerId (*Required*) | Integer | Unique identifier of the User associated to the Campaign (see [Users](#) resource) |\n| typeId (*Required*) | Integer | Type of the Campaign (see [Types](#) resource) |\n| statusId (*Required*) | Integer | Status of the Campaign (see [Statues](#) resource) |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Campaign |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Campaign","content":{"application/json":{"examples":{"default":{"value":{"title":"Communication of the new pricing strategy for partners","description":"

Hi everyone.

We want to inform the new pricing strategy to the channel (see attached document).

To do this, we have assigned you the partners that correspond to your territories.

The campaign will end on February 26th.

In case of doubts, do not hesitate to ask. 


Channel

","ownerId":217,"statusId":4,"typeId":2,"startDate":"2021-01-21T23:00:00Z","endDate":"2021-02-26T22:59:59Z","deleted":false,"videoUrl":"https://www.youtube.com/watch?v=YmcFveP-P7k","dateCreated":"2021-12-29T10:44:39.07Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":0,"salesRepIdDeleted":0,"id":2}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"ownerId":{"type":"integer"},"statusId":{"type":"integer"},"typeId":{"type":"integer"},"startDate":{"type":"string"},"endDate":{"type":"string"},"deleted":{"type":"boolean"},"videoUrl":{"type":"string"}}},"examples":{"default":{"value":{"title":"Communication of the new pricing strategy for partners","description":"

Hi everyone.

We want to inform the new pricing strategy to the channel (see attached document).

To do this, we have assigned you the partners that correspond to your territories.

The campaign will end on February 26th.

In case of doubts, do not hesitate to ask. 


Channel

","ownerId":217,"statusId":4,"typeId":2,"startDate":"2021-01-21T23:00:00Z","endDate":"2021-02-26T22:59:59Z","deleted":false,"videoUrl":"https://www.youtube.com/watch?v=YmcFveP-P7k"}}}}}}}},"/campaigns/{ID}":{"get":{"operationId":"get-campaign","summary":"Get Campaign","description":"This endpoint retrieves data of a specific Campaign based on JSON input. The API returns a single Campaign available to the user, according to the unique ID provided. If the specified Campaign does not exist, the response will be a \"bad request\".\n\nYou will only receive the Campaign after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Campaign |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| title | String | A short descriptive name for the specific Campaign |\n| description | String | A longer description of the Campaign content, it can be also HTML |\n| videoUrl | String | A link to a video that describe the sales Campaign |\n| address2 | String | Second address to whom the Campaign is linked |\n| startDate | String | Date in wich the Campaign starts |\n| endDate | String | Date when the Campaign ends |\n| ownerId | Integer | Unique identifier of the User associated to the Campaign (see [Users](#) resource) |\n| typeId | Integer | Type of the Campaign (see [Types](#) resource) |\n| statusId | Integer | Status of the Campaign (see [Statues](#) resource) |\n| dateCreated | String | Date and time when the Campaign was created |\n| dateDeleted | String | Date and time when the Campaign was deleted |\n| dateUpdated | String | Date and time when the Campaign was last updated |\n| deleted | Boolean | If true, the Campaign has been deleted and archived |\n| id | Integer | Unique identifier for the Campaign in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Campaign","content":{"application/json":{"examples":{"default":{"value":{"title":"Promo Campaign to present the new products portfolio","description":"","ownerId":117,"statusId":1,"typeId":1,"startDate":"2021-09-20T15:04:05Z","endDate":"2022-09-20T15:04:05Z","deleted":false,"videoUrl":"https://www.youtube.com/watch?v=YmcFveP-P7k","dateCreated":"2021-12-29T10:40:32.66Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":0,"salesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-campaign","summary":"Update Campaign","description":"This endpoint allows you to update a specific Campaign. If the specified Campaign does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Campaign after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Campaign. In order to update a Campaign, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| title | String | A short descriptive name for the specific Campaign |\n| description | String | A longer description of the Campaign content, it can be also HTML |\n| videoUrl | String | A link to a video that describe the sales Campaign |\n| address2 | String | Second address to whom the Campaign is linked |\n| startDate | String | Date in wich the Campaign starts |\n| endDate | String | Date when the Campaign ends |\n| ownerId | Integer | Unique identifier of the User associated to the Campaign (see [Users](#) resource) |\n| typeId | Integer | Type of the Campaign (see [Types](#) resource) |\n| statusId | Integer | Status of the Campaign (see [Statues](#) resource) |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Campaign","content":{"application/json":{"examples":{"default":{"value":{"title":"Promo Campaign to present the new products portfolio","description":"","ownerId":117,"statusId":1,"typeId":1,"startDate":"2021-09-25T15:04:05Z","endDate":"2022-09-30T15:04:05Z","deleted":false,"videoUrl":"https://www.youtube.com/watch?v=YmcFveP-P7k","dateCreated":"2021-12-29T10:40:32.66Z","dateDeleted":null,"dateUpdated":"2021-12-29T10:41:43.097Z","salesRepIdCreated":90,"salesRepIdUpdated":90,"salesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"startDate":{"type":"string"},"endDate":{"type":"string"}}},"examples":{"default":{"value":{"startDate":"2021-09-25T15:04:05Z","endDate":"2022-09-30T15:04:05Z"}}}}}}},"delete":{"operationId":"delete-campaign","summary":"Delete Campaign","description":"This endpoint allows you to delete a specific Campaign from the user's ForceManager implementation database. If the specified Campaign does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Campaigns after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Campaign to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Campaign","content":{"application/json":{"examples":{"default":{"value":{"message":"success"}}}}}}},"security":[{"SessionKey":[]}]}},"/opportunityTypes":{"get":{"operationId":"list-opportunity-types","summary":"List Opportunity Types","description":"Returns all Opportunity Types available in the user's ForceManager implementation database.\n\nYou will only receive the List of Opportunity Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**RESPONSE**\n\nThis endpoint returns information about all Opportunity Types available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Opportunity Types attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Opportunity Type is visible |\n| defaultStatus | Boolean | The ID of the Opportunity Status selected by default for a chosen Opportunity Type, in the multiple pipeline context |\n| dateCreated | String | Date and time when the Opportunity Type was created |\n| dateDeleted | String | Date and time when the Opportunity Type was deleted |\n| dateUpdated | String | Date and time when the Opportunity Type was last updated |\n| deleted | Boolean | If true, the Opportunity Type has been deleted and archived |\n| descriptionBR | String | Opportunity Type label in Brasilian Portuguese |\n| descriptionDE | String | Opportunity Type label in German |\n| descriptionDK | String | Opportunity Type label in Dutch |\n| descriptionEN | String | Opportunity Type label in English |\n| descriptionES | String | Opportunity Type label in Spanish |\n| descriptionFR | String | Opportunity Type label in French |\n| descriptionIT | String | Opportunity Type label in Italian |\n| descriptionPT | String | Opportunity Type label in Portuguese |\n| descriptionRU | String | Opportunity Type label in Russian |\n| descriptionUS | String | Opportunity Type label in American English |\n| id | Integer | Unique identifier for the Opportunity Type in ForceManager |\n| order | Integer | The position of the Opportunity Type in the Opportunity Types value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Opportunity Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Opportunity Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Opportunity Type |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Opportunity Types","content":{"application/json":{"examples":{"default":{"value":"[\n {\n \"branchVisibility\": null,\n \"dateCreated\": \"2021-11-29T17:16:04.9Z\",\n \"dateDeleted\": null,\n \"dateUpdated\": null,\n \"defaultStatus\": null,\n \"deleted\": false,\n \"descriptionBR\": null,\n \"descriptionDE\": null,\n \"descriptionDK\": null,\n \"descriptionEN\": \"Sales Pipeline\",\n \"descriptionES\": \"Flujo de ventas\",\n \"descriptionFR\": null,\n \"descriptionIT\": \"Linea di vendita\",\n \"descriptionPT\": null,\n \"descriptionRU\": null,\n \"descriptionUS\": null,\n \"id\": 1,\n \"order\": null,\n \"salesRepIdCreated\": 90,\n \"salesRepIdDeleted\": 90,\n \"salesRepIdUpdated\": null\n },\n {\n \"branchVisibility\": null,\n \"dateCreated\": \"2021-11-29T17:16:05.223Z\",\n \"dateDeleted\": null,\n \"dateUpdated\": null,\n \"defaultStatus\": null,\n \"deleted\": false,\n \"descriptionBR\": null,\n \"descriptionDE\": null,\n \"descriptionDK\": null,\n \"descriptionEN\": \"Customer care line\",\n \"descriptionES\": \"Linea de soporte\",\n \"descriptionFR\": null,\n \"descriptionIT\": \"Supporto post-vendita\",\n \"descriptionPT\": null,\n \"descriptionRU\": null,\n \"descriptionUS\": null,\n \"id\": 2,\n \"order\": 1,\n \"salesRepIdCreated\": 90,\n \"salesRepIdDeleted\": 90,\n \"salesRepIdUpdated\": null\n },\n]"}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-opportunity-type","summary":"Create Opportunity Type","description":"This endpoint allows you to create a Opportunity Status based on JSON input.\n\nYou will only be able to create a Opportunity Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Opportunity Type is visible |\n| defaultStatus | Boolean | The ID of the Opportunity Status selected by default for a chosen Opportunity Type, in the multiple pipeline context |\n| descriptionBR | String | Opportunity Type label in Brasilian Portuguese |\n| descriptionDE | String | Opportunity Type label in German |\n| descriptionDK | String | Opportunity Type label in Dutch |\n| descriptionEN | String | Opportunity Type label in English |\n| descriptionES | String | Opportunity Type label in Spanish |\n| descriptionFR | String | Opportunity Type label in French |\n| descriptionIT | String | Opportunity Type label in Italian |\n| descriptionPT | String | Opportunity Type label in Portuguese |\n| descriptionRU | String | Opportunity Type label in Russian |\n| descriptionUS | String | Opportunity Type label in American English |\n| order | Integer | The position of the Opportunity Type in the Opportunity Types value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Opportunity Status just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Opportunity Status |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Opportunity Type","content":{"application/json":{"examples":{"default":{"value":{"id":69,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"branchVisibility":{"type":"array"},"descriptionEN":{"type":"string"},"defaultStatus":{"type":"integer"},"order":{"type":"integer"}}},"examples":{"default":{"value":{"branchVisibility":[16],"descriptionEN":"Food and Beverage","defaultStatus":1,"order":4}}}}}}}},"/campaignStatuses":{"get":{"operationId":"list-campaign-statuses","summary":"List Campaign Statuses","description":"Returns all Campaign Statuses available in the user's ForceManager implementation database.\n\nYou will only receive the List of Campaign Statuses after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**RESPONSE**\n\nThis endpoint returns information about all Campaign Statuses available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Campaign Statuses attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| descriptionBR | String | Campaign Status label in Brasilian Portuguese |\n| descriptionDE | String | Campaign Status label in German |\n| descriptionDK | String | Campaign Status label in Dutch |\n| descriptionEN | String | Campaign Status label in English |\n| descriptionES | String | Campaign Status label in Spanish |\n| descriptionFR | String | Campaign Status label in French |\n| descriptionIT | String | Campaign Status label in Italian |\n| descriptionPT | String | Campaign Status label in Portuguese |\n| descriptionRU | String | Campaign Status label in Russian |\n| descriptionUS | String | Campaign Status label in American English |\n| id | Integer | Unique identifier for the Campaign Status in ForceManager |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Campaign Statuses","content":{"application/json":{"examples":{"default":{"value":[{"id":1,"descriptionEN":"Drafts","descriptionES":"Borradores","descriptionIT":"Bozze","descriptionFR":"Brouillons","descriptionDE":"Entwürfe","descriptionPT":"Rascunhos","descriptionUS":"Drafts","descriptionBR":"Rascunhos","descriptionRU":"Drafts","descriptionDK":"Draftet"},{"id":2,"descriptionEN":"Ongoing","descriptionES":"Activas","descriptionIT":"Incompleta","descriptionFR":"Inachevées","descriptionDE":"Nicht abgeschlossen","descriptionPT":"Incompletas","descriptionUS":"Ongoing","descriptionBR":"Incompletas","descriptionRU":"Ongoing","descriptionDK":"Ufuldendt"},{"id":3,"descriptionEN":"Scheduled","descriptionES":"Planificadas","descriptionIT":"Pianificato","descriptionFR":"Prévues","descriptionDE":"Geplant","descriptionPT":"Planejado","descriptionUS":"Scheduled","descriptionBR":"Planejado","descriptionRU":"Scheduled","descriptionDK":"Planlagt"},{"id":4,"descriptionEN":"Ended","descriptionES":"Finalizadas","descriptionIT":"Terminata","descriptionFR":"Terminées","descriptionDE":"Beendet","descriptionPT":"Concluído","descriptionUS":"Ended","descriptionBR":"Acabada","descriptionRU":"Ended","descriptionDK":"Afsluttet"}]}}}}}},"security":[{"SessionKey":[]}]}},"/campaigns/{ID}/entities":{"get":{"operationId":"list-campaign-accounts","summary":"List Campaign Accounts","description":"Returns all Campaign Accounts available in the user's ForceManager implementation database.\n\nYou will only receive the List of Campaign Accounts after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou can apply filters. The order of the parameters does not matter.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| offset | Integer | Define position from which the records must be returned |\n| count | Integer | Define the number of results to return |\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/campaigns/:ID/entities/VALUE?offset=VALUE&count=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Campaign Accounts available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Campaign Accounts attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignId | Integer | ID of the corresponding Campaign (see [Campaigns](#) resource) |\n| activityId | Integer | The ID of an Activity done for a sales Campaign (see [Activities](#) resource) |\n| accountId | Integer | ID of the Account targeted by the Campaign (see [Accounts](#) resource) |\n| completed | Boolean | If true, an Activity related to the Account had been done for the corresponding Campaign |\n| dateCreated | String | Date and time when the Campaign Account was created |\n| dateDeleted | String | Date and time when the Campaign Account was deleted |\n| dateUpdated | String | Date and time when the Campaign Account was last updated |\n| deleted | Boolean | If true, the Campaign Account has been deleted and archived |\n| id | Integer | Unique identifier for the Campaign Account in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign Account |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign Account |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign Account |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Accounts"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"OK"}},"security":[{"SessionKey":[]}]}},"/campaigns/{ID}/entities/VALUE":{"post":{"operationId":"create-campaign-account","summary":"Create Campaign Account","description":"This endpoint allows you to update a specific Campaign Account. If the specified Campaign Account does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Campaign Account after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Campaign Account.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Integer | The unique and specific identifier of the Campaign Account |\n| id | Integer | The unique and specific identifier of the Campaign |\n\nIn order to update a Campaign Account, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignId | Integer | ID of the corresponding Campaign (see [Campaigns](#) resource) |\n| activityId | Integer | The ID of an Activity done for a sales Campaign (see [Activities](#) resource) |\n| accountId | Integer | ID of the Account targeted by the Campaign (see [Accounts](#) resource) |\n| completed | Boolean | If true, an Activity related to the Account had been done for the corresponding Campaign |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Accounts"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Campaign Account","content":{"application/json":{"examples":{"default":{"value":{"campaignId":1,"accountId":87,"activityId":-1,"completed":true,"deleted":false,"DateCreated":"2021-12-29T16:35:00.667Z","DateDeleted":null,"DateUpdated":null,"SalesRepIdCreated":90,"SalesRepIdUpdated":0,"SalesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"activityId":{"type":"integer"},"completed":{"type":"boolean"}}},"examples":{"default":{"value":{"activityId":-1,"completed":false}}}}}}},"get":{"operationId":"get-campaign-account","summary":"Get Campaign Account","description":"This endpoint retrieves data of a specific Campaign Account based on JSON input. The API returns a single Campaign Account available to the user, according to the unique ID provided. If the specified Campaign Account does not exist, the response will be a \"bad request\".\n\nYou will only receive the Campaign Account after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Integer | The unique and specific identifier of the Campaign Account |\n| id | Integer | The unique and specific identifier of the Campaign |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignId | Integer | ID of the corresponding Campaign (see [Campaigns](#) resource) |\n| activityId | Integer | The ID of an Activity done for a sales Campaign (see [Activities](#) resource) |\n| accountId | Integer | ID of the Account targeted by the Campaign (see [Accounts](#) resource) |\n| completed | Boolean | If true, an Activity related to the Account had been done for the corresponding Campaign |\n| dateCreated | String | Date and time when the Campaign Account was created |\n| dateDeleted | String | Date and time when the Campaign Account was deleted |\n| dateUpdated | String | Date and time when the Campaign Account was last updated |\n| deleted | Boolean | If true, the Campaign Account has been deleted and archived |\n| id | Integer | Unique identifier for the Campaign Account in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign Account |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign Account |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign Account |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Accounts"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Campaign Account","content":{"application/json":{"examples":{"default":{"value":{"campaignId":1,"accountId":87,"activityId":5,"completed":true,"deleted":false,"DateCreated":"2021-12-29T16:35:00.667Z","DateDeleted":null,"DateUpdated":null,"SalesRepIdCreated":90,"SalesRepIdUpdated":0,"SalesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-campaign-account","summary":"Update Campaign Account","description":"This endpoint allows you to update a specific Campaign Account. If the specified Campaign Account does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Campaign Account after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Campaign Account.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Integer | The unique and specific identifier of the Campaign Account |\n| id | Integer | The unique and specific identifier of the Campaign |\n\nIn order to update a Campaign Account, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignId | Integer | ID of the corresponding Campaign (see [Campaigns](#) resource) |\n| activityId | Integer | The ID of an Activity done for a sales Campaign (see [Activities](#) resource) |\n| accountId | Integer | ID of the Account targeted by the Campaign (see [Accounts](#) resource) |\n| completed | Boolean | If true, an Activity related to the Account had been done for the corresponding Campaign |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Accounts"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Campaign Account","content":{"application/json":{"examples":{"default":{"value":{"campaignId":1,"accountId":87,"activityId":9,"completed":true,"deleted":false,"DateCreated":"2021-12-29T16:35:00.667Z","DateDeleted":null,"DateUpdated":"2021-12-29T16:36:25.257Z","SalesRepIdCreated":90,"SalesRepIdUpdated":90,"SalesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"activityId":{"type":"integer"},"completed":{"type":"boolean"}}},"examples":{"default":{"value":{"activityId":9,"completed":true}}}}}}},"delete":{"operationId":"delete-campaign-account","summary":"Delete Campaign Account","description":"This endpoint allows you to delete a specific Campaign Account from the user's ForceManager implementation database. If the specified Campaign Account does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Campaign Accounts after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Integer | The unique and specific identifier of the Campaign Account |\n| id | Integer | The unique and specific identifier of the Campaign |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Account just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Accounts"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Campaign Account","content":{"application/json":{"examples":{"default":{"value":{"message":"success"}}}}}}},"security":[{"SessionKey":[]}]}},"/campaignQuestions":{"get":{"operationId":"list-campaign-questions","summary":"List Campaign Questions","description":"Returns all Campaign Questions available in the user's ForceManager implementation database.\n\nYou will only receive the List of Campaign Questions after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou can apply filters. The order of the parameters does not matter.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| offset | Integer | Define position from which the records must be returned |\n| count | Integer | Define the number of results to return |\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/campaignQuestions?offset=VALUE&count=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Campaign Questions available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Campaign Questions attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignId | Integer | ID of the corresponding Campaign (see [Campaigns](#) resource) |\n| textBR | String | Campaign Question topic in Brasilian Portuguese |\n| textDE | String | Campaign Question topic in German |\n| textDK | String | Campaign Question topic in Dutch |\n| textEN | String | Campaign Question topic in English |\n| textES | String | Campaign Question topic in Spanish |\n| textFR | String | Campaign Question topic in French |\n| textIT | String | Campaign Question topic in Italian |\n| textPT | String | Campaign Question topic in Portuguese |\n| textRU | String | Campaign Question topic in Russian |\n| textUS | String | Campaign Question topic in American English |\n| type | String | Campaign Question data type. It can take the following values: `bool`, `date`, `integer`, `multipleValueList`, `singleValueList`, `text` |\n| mandatory | Boolean | True if the Campaign Question is mandatory, false otherwise |\n| order | Integer | The position of the Campaign Question in the Activity fields list |\n| valueListName | String | The API name of the table that the Campaign Question type `multipleValueList` or `singleValueList` refers too |\n| linkedEntity | String | This refers to the case in which the Campaign Question would populate a specific field of an entity through the answer provided by the User. Only `accounts` value is currently supported |\n| linkedEntityField | String | It specifies the API name of the field (standard or custom) present in the `linkedEntity` table that the Campaing Question answer will populate |\n| custom | Boolean | This indicate that for `multipleValueList` and `singleValueList` Campaign Questions, the list is not an existing one but a list created on purpose for the Campaign Question. If it is custom, the consumer of the API has to specify the corresponding list items, via the Campaign Question Values API (see [Question Values](#) resource) |\n| dateCreated | String | Date and time when the Campaign Question was created |\n| dateDeleted | String | Date and time when the Campaign Question was deleted |\n| dateUpdated | String | Date and time when the Campaign Question was last updated |\n| deleted | Boolean | If true, the Campaign Question has been deleted and archived |\n| id | Integer | Unique identifier for the Campaign Question in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign Question |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign Question |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign Question |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Questions"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Campaign Questions","content":{"application/json":{"examples":{"default":{"value":[{"campaignId":1,"textES":"","textEN":"How much money the company earned last year?","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","type":"integer","mandatory":true,"deleted":true,"order":4,"valueListName":"","linkedEntity":"","linkedEntityField":"","dateCreated":"2021-12-29T13:14:47.36Z","dateDeleted":"2021-12-29T14:18:22.737Z","dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":0,"salesRepIdDeleted":90,"id":1,"custom":false},{"campaignId":1,"textES":"","textEN":"How many sales representatives the company has?","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","type":"singleValueList","mandatory":false,"deleted":false,"order":3,"valueListName":"Z_tblEmployeesCountRanges","linkedEntity":"accounts","linkedEntityField":"Z_EmployeesCount","dateCreated":"2021-12-29T13:15:14.36Z","dateDeleted":null,"dateUpdated":"2021-12-29T13:17:09.13Z","salesRepIdCreated":90,"salesRepIdUpdated":90,"salesRepIdDeleted":0,"id":2,"custom":false}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-campaign-question","summary":"Create Campaign Question","description":"This endpoint allows you to create a Campaign Question based on JSON input.\n\nYou will only be able to create a Campaign Question after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignId | Integer | ID of the corresponding Campaign (see [Campaigns](#) resource) |\n| textBR | String | Campaign Question topic in Brasilian Portuguese |\n| textDE | String | Campaign Question topic in German |\n| textDK | String | Campaign Question topic in Dutch |\n| textEN (*Required*) | String | Campaign Question topic in English |\n| textES | String | Campaign Question topic in Spanish |\n| textFR | String | Campaign Question topic in French |\n| textIT | String | Campaign Question topic in Italian |\n| textPT | String | Campaign Question topic in Portuguese |\n| textRU | String | Campaign Question topic in Russian |\n| textUS | String | Campaign Question topic in American English |\n| type (*Required*) | String | Campaign Question data type. It can take the following values: `bool`, `date`, `integer`, `multipleValueList`, `singleValueList`, `text` |\n| mandatory | Boolean | True if the Campaign Question is mandatory, false otherwise |\n| order | Integer | The position of the Campaign Question in the Activity fields list |\n| valueListName | String | The API name of the table that the Campaign Question type `multipleValueList` or `singleValueList` refers too |\n| linkedEntity | String | This refers to the case in which the Campaign Question would populate a specific field of an entity through the answer provided by the User. Only `accounts` value is currently supported |\n| linkedEntityField | String | It specifies the API name of the field (standard or custom) present in the `linkedEntity` table that the Campaing Question answer will populate |\n| custom | Boolean | This indicate that for `multipleValueList` and `singleValueList` Campaign Questions, the list is not an existing one but a list created on purpose for the Campaign Question. If it is custom, the consumer of the API has to specify the corresponding list items, via the Campaign Question Values API (see [Question Values](#) resource) |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Campaign Question |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Questions"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Campaign Question","content":{"application/json":{"examples":{"default":{"value":[{"campaignId":1,"textES":"","textEN":"How many employees the company has?","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","type":"singleValueList","mandatory":true,"deleted":false,"order":4,"valueListName":"Z_tblEmployeesCountRanges","linkedEntity":"accounts","linkedEntityField":"Z_EmployeesCount","dateCreated":"2021-12-29T13:15:14.36Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":0,"salesRepIdDeleted":0,"id":2,"custom":false}]}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"default":{"value":[{"campaignId":1,"textES":"","textEN":"How many employees the company has?","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","type":"singleValueList","mandatory":true,"order":4,"valueListName":"Z_tblEmployeesCountRanges","linkedEntity":"accounts","linkedEntityField":"Z_EmployeesCount","custom":false}]}}}}}}},"/campaignQuestions/{ID}":{"get":{"operationId":"get-campaign-question","summary":"Get Campaign Question","description":"This endpoint retrieves data of a specific Campaign Question based on JSON input. The API returns a single Campaign Question available to the user, according to the unique ID provided. If the specified Campaign Question does not exist, the response will be a \"bad request\".\n\nYou will only receive the Campaign Question after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Campaign Question |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignId | Integer | ID of the corresponding Campaign (see [Campaigns](#) resource) |\n| textBR | String | Campaign Question topic in Brasilian Portuguese |\n| textDE | String | Campaign Question topic in German |\n| textDK | String | Campaign Question topic in Dutch |\n| textEN | String | Campaign Question topic in English |\n| textES | String | Campaign Question topic in Spanish |\n| textFR | String | Campaign Question topic in French |\n| textIT | String | Campaign Question topic in Italian |\n| textPT | String | Campaign Question topic in Portuguese |\n| textRU | String | Campaign Question topic in Russian |\n| textUS | String | Campaign Question topic in American English |\n| type | String | Campaign Question data type. It can take the following values: `bool`, `date`, `integer`, `multipleValueList`, `singleValueList`, `text` |\n| mandatory | Boolean | True if the Campaign Question is mandatory, false otherwise |\n| order | Integer | The position of the Campaign Question in the Activity fields list |\n| valueListName | String | The API name of the table that the Campaign Question type `multipleValueList` or `singleValueList` refers too |\n| linkedEntity | String | This refers to the case in which the Campaign Question would populate a specific field of an entity through the answer provided by the User. Only `accounts` value is currently supported |\n| linkedEntityField | String | It specifies the API name of the field (standard or custom) present in the `linkedEntity` table that the Campaing Question answer will populate |\n| custom | Boolean | This indicate that for `multipleValueList` and `singleValueList` Campaign Questions, the list is not an existing one but a list created on purpose for the Campaign Question. If it is custom, the consumer of the API has to specify the corresponding list items, via the Campaign Question Values API (see [Question Values](#) resource) |\n| dateCreated | String | Date and time when the Campaign Question was created |\n| dateDeleted | String | Date and time when the Campaign Question was deleted |\n| dateUpdated | String | Date and time when the Campaign Question was last updated |\n| deleted | Boolean | If true, the Campaign Question has been deleted and archived |\n| id | Integer | Unique identifier for the Campaign Question in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign Question |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign Question |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign Question |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Questions"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Opportunity Question","content":{"application/json":{"examples":{"default":{"value":{"campaignId":1,"textES":"","textEN":"How many sales representatives the company has?","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","type":"singleValueList","mandatory":false,"deleted":false,"order":3,"valueListName":"Z_tblEmployeesCountRanges","linkedEntity":"accounts","linkedEntityField":"Z_EmployeesCount","dateCreated":"2021-12-29T13:15:14.36Z","dateDeleted":null,"dateUpdated":"2021-12-29T13:17:09.13Z","salesRepIdCreated":90,"salesRepIdUpdated":90,"salesRepIdDeleted":0,"id":2,"custom":false}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-campaign-question","summary":"Update Campaign Question","description":"This endpoint allows you to update a specific Campaign Question. If the specified Campaign Question does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Campaign Question after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Campaign Question. In order to update a Campaign Question, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| campaignId | Integer | ID of the corresponding Campaign (see [Campaigns](#) resource) |\n| textBR | String | Campaign Question topic in Brasilian Portuguese |\n| textDE | String | Campaign Question topic in German |\n| textDK | String | Campaign Question topic in Dutch |\n| textEN | String | Campaign Question topic in English |\n| textES | String | Campaign Question topic in Spanish |\n| textFR | String | Campaign Question topic in French |\n| textIT | String | Campaign Question topic in Italian |\n| textPT | String | Campaign Question topic in Portuguese |\n| textRU | String | Campaign Question topic in Russian |\n| textUS | String | Campaign Question topic in American English |\n| type | String | Campaign Question data type. It can take the following values: `bool`, `date`, `integer`, `multipleValueList`, `singleValueList`, `text` |\n| mandatory | Boolean | True if the Campaign Question is mandatory, false otherwise |\n| order | Integer | The position of the Campaign Question in the Activity fields list |\n| valueListName | String | The API name of the table that the Campaign Question type `multipleValueList` or `singleValueList` refers too |\n| linkedEntity | String | This refers to the case in which the Campaign Question would populate a specific field of an entity through the answer provided by the User. Only `accounts` value is currently supported |\n| linkedEntityField | String | It specifies the API name of the field (standard or custom) present in the `linkedEntity` table that the Campaing Question answer will populate |\n| custom | Boolean | This indicate that for `multipleValueList` and `singleValueList` Campaign Questions, the list is not an existing one but a list created on purpose for the Campaign Question. If it is custom, the consumer of the API has to specify the corresponding list items, via the Campaign Question Values API (see [Question Values](#) resource) |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Questions"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Opportunity Question","content":{"application/json":{"examples":{"default":{"value":{"campaignId":1,"textES":"","textEN":"How many sales representatives the company has?","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","type":"singleValueList","mandatory":false,"deleted":false,"order":3,"valueListName":"Z_tblEmployeesCountRanges","linkedEntity":"accounts","linkedEntityField":"Z_EmployeesCount","dateCreated":"2021-12-29T13:15:14.36Z","dateDeleted":null,"dateUpdated":"2021-12-29T13:17:09.13Z","salesRepIdCreated":90,"salesRepIdUpdated":90,"salesRepIdDeleted":0,"id":2,"custom":false}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"textEN":{"type":"string"},"mandatory":{"type":"boolean"},"order":{"type":"integer"}}},"examples":{"default":{"value":{"textEN":"How many sales representatives the company has?","mandatory":false,"order":3}}}}}}},"delete":{"operationId":"delete-campaign-question","summary":"Delete Campaign Question","description":"This endpoint allows you to delete a specific Campaign Question from the user's ForceManager implementation database. If the specified Campaign Question does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Campaign Questions after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Campaign Question to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Questions"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Campaign Question","content":{"application/json":{"examples":{"default":{"value":{"message":"success"}}}}}}},"security":[{"SessionKey":[]}]}},"/campaignQuestions/VALUE/answers":{"get":{"operationId":"list-question-answers","summary":"List Question Answers","description":"Returns all Campaign Question Answers available in the user's ForceManager implementation database.\n\nYou will only receive the List of Campaign Question Answers after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou can apply filters. The order of the parameters does not matter.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| offset | Integer | Define position from which the records must be returned |\n| count | Integer | Define the number of results to return |\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/campaignQuestions/VALUE/answers?offset=VALUE&count=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Campaign Question Answers available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Campaign Question Answers attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The ID of the Campaign Question that the Answer is referred to (see [Questions](#) resource) |\n| activityId | Integer | The ID of an Activity done for a sales Campaign, in which the Campaign Question Answer is reported (see [Activities](#) resource) |\n| value | String | The answer, determined from a value list choice or a free input of the User |\n| dateCreated | String | Date and time when the Campaign Question Answer was created |\n| dateDeleted | String | Date and time when the Campaign Question Answer was deleted |\n| dateUpdated | String | Date and time when the Campaign Question Answer was last updated |\n| deleted | Boolean | If true, the Campaign Question Answer has been deleted and archived |\n| id | Integer | Unique identifier for the Campaign Question Answer in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign Question Answer |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign Question Answer |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign Question Answer |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Question Answers"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Question Answers","content":{"application/json":{"examples":{"default":{"value":[{"questionId":10,"activityId":35,"value":"5000","deleted":false,"dateCreated":"2021-12-29T13:40:33.96Z","dateDeleted":null,"dateUpdated":"2021-12-29T13:41:45.787Z","salesRepIdCreated":90,"salesRepIdUpdated":90,"salesRepIdDeleted":0,"id":1}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-question-answer","summary":"Create Question Answer","description":"This endpoint allows you to create a Campaign Question Answer based on JSON input.\n\nYou will only be able to create a Campaign Question Answer after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The unique and specific identifier of the Campaign Question |\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| activityId (*Required*) | Integer | The ID of an Activity done for a sales Campaign, in which the Campaign Question Answer Answer is reported (see [Activities](#) resource) |\n| value (*Required*) | String | The answer, determined from a value list choice or a free input of the User |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question Answer just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Campaign Question Answer |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Question Answers"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Question Answer","content":{"application/json":{"examples":{"default":{"value":{"questionId":1,"activityId":35,"value":"10000","deleted":false,"dateCreated":"2021-12-29T13:40:33.96Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":0,"salesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"activityId":{"type":"integer"},"value":{"type":"string"}}},"examples":{"default":{"value":{"activityId":35,"value":"10000"}}}}}}}},"/campaignQuestions/VALUE/answers/{ID}":{"get":{"operationId":"get-question-answer","summary":"Get Question Answer","description":"This endpoint retrieves data of a specific Campaign Question Answer based on JSON input. The API returns a single Campaign Question Answer available to the user, according to the unique ID provided. If the specified Campaign Question Answer does not exist, the response will be a \"bad request\".\n\nYou will only receive the Campaign Question Answer after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The unique and specific identifier of the Campaign Question |\n| id | Integer | The unique and specific identifier of the Campaign Question Answer to get |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The ID of the Campaign Question that the Answer is referred to (see [Questions](#) resource) |\n| activityId | Integer | The ID of an Activity done for a sales Campaign, in which the Campaign Question Answer is reported (see [Activities](#) resource) |\n| value | String | The answer, determined from a value list choice or a free input of the User |\n| dateCreated | String | Date and time when the Campaign Question Answer was created |\n| dateDeleted | String | Date and time when the Campaign Question Answer was deleted |\n| dateUpdated | String | Date and time when the Campaign Question Answer was last updated |\n| deleted | Boolean | If true, the Campaign Question Answer has been deleted and archived |\n| id | Integer | Unique identifier for the Campaign Question Answer in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign Question Answer |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign Question Answer |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign Question Answer |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Question Answers"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Question Answer","content":{"application/json":{"examples":{"default":{"value":{"questionId":2,"activityId":35,"value":"5000","deleted":false,"dateCreated":"2021-12-29T13:40:33.96Z","dateDeleted":null,"dateUpdated":"2021-12-29T13:41:45.787Z","salesRepIdCreated":90,"salesRepIdUpdated":90,"salesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-question-answer","summary":"Update Question Answer","description":"This endpoint allows you to update a specific Campaign Question Answer. If the specified Campaign Question Answer does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Campaign Question Answer after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Campaign Question Answer.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The unique and specific identifier of the Campaign Question |\n| id | Integer | The unique and specific identifier of the Campaign Question Answer to update |\n\nIn order to update a Campaign Question Answer, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| activityId | Integer | The ID of an Activity done for a sales Campaign, in which the Campaign Question Answer is reported (see [Activities](#) resource) |\n| value | String | The answer, determined from a value list choice or a free input of the User |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Question Answers"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Question Answer","content":{"application/json":{"examples":{"default":{"value":{"questionId":2,"activityId":35,"value":"5000","deleted":false,"dateCreated":"2021-12-29T13:40:33.96Z","dateDeleted":null,"dateUpdated":"2021-12-29T13:41:45.787Z","salesRepIdCreated":90,"salesRepIdUpdated":90,"salesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"activityId":{"type":"integer"},"value":{"type":"string"}}},"examples":{"default":{"value":{"activityId":35,"value":"5000"}}}}}}},"delete":{"operationId":"delete-question-answer","summary":"Delete Question Answer","description":"This endpoint allows you to delete a specific Campaign Question Answer from the user's ForceManager implementation database. If the specified Campaign Question Answer does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Campaign Question Answers after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The unique and specific identifier of the Campaign Question |\n| id | Integer | The unique and specific identifier of the Campaign Question Answer to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question Answer just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Question Answers"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Question Answer","content":{"application/json":{"examples":{"default":{"value":{"message":"success"}}}}}}},"security":[{"SessionKey":[]}]}},"/campaignQuestions/VALUE/values":{"get":{"operationId":"list-question-values","summary":"List Question Values","description":"Returns all Campaign Question Values available in the user's ForceManager implementation database.\n\nYou will only receive the List of Campaign Question Values after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou can apply filters. The order of the parameters does not matter.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| offset | Integer | Define position from which the records must be returned |\n| count | Integer | Define the number of results to return |\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/campaignQuestions/VALUE/Values?offset=VALUE&count=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Campaign Question Values available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Campaign Question Values attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The ID of the Campaign Question that the Value is referred to (see [Questions](#) resource) |\n| textBR | String | Campaign Value label in Brasilian Portuguese |\n| textDE | String | Campaign Value label in German |\n| textDK | String | Campaign Value label in Dutch |\n| textEN | String | Campaign Value label in English |\n| textES | String | Campaign Value label in Spanish |\n| textFR | String | Campaign Value label in French |\n| textIT | String | Campaign Value label in Italian |\n| textPT | String | Campaign Value label in Portuguese |\n| textRU | String | Campaign Value label in Russian |\n| textUS | String | Campaign Value label in American English |\n| dateCreated | String | Date and time when the Campaign Question Value was created |\n| dateDeleted | String | Date and time when the Campaign Question Value was deleted |\n| dateUpdated | String | Date and time when the Campaign Question Value was last updated |\n| deleted | Boolean | If true, the Campaign Question Value has been deleted and archived |\n| id | Integer | Unique identifier for the Campaign Question Value in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign Question Value |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign Question Value |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign Question Value |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Question Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"{{Count}]"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Question Values","content":{"application/json":{"examples":{"default":{"value":[{"questionId":4,"textES":"","textEN":"500-1000","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","deleted":true,"dateCreated":"2021-12-29T15:40:45.137Z","dateDeleted":"2021-12-29T16:42:45.377Z","dateUpdated":"2021-12-29T15:42:15.817Z","salesRepIdCreated":90,"salesRepIdUpdated":90,"salesRepIdDeleted":90,"id":1},{"questionId":4,"textES":"","textEN":"50-200","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","deleted":false,"dateCreated":"2021-12-29T15:43:04.903Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":0,"salesRepIdDeleted":0,"id":2}]}}}}}},"security":[{"SessionKey":[]}]}},"/campaignQuestions/{ID}/values":{"post":{"operationId":"create-question-value","summary":"Create Question Value","description":"This endpoint allows you to create a Campaign Question Value based on JSON input.\n\nYou will only be able to create a Campaign Question Value after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| textBR | String | Campaign Value label in Brasilian Portuguese |\n| textDE | String | Campaign Value label in German |\n| textDK | String | Campaign Value label in Dutch |\n| textEN (*Required*) | String | Campaign Value label in English |\n| textES | String | Campaign Value label in Spanish |\n| textFR | String | Campaign Value label in French |\n| textIT | String | Campaign Value label in Italian |\n| textPT | String | Campaign Value label in Portuguese |\n| textRU | String | Campaign Value label in Russian |\n| textUS | String | Campaign Value label in American English |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question Value just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Campaign Question Value |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Question Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Question Value","content":{"application/json":{"examples":{"default":{"value":{"questionId":4,"textES":"","textEN":"50-200","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","deleted":false,"dateCreated":"2021-12-29T15:40:45.137Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":0,"salesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"textEN":{"type":"string"}}},"examples":{"default":{"value":{"textEN":"50-200"}}}}}}}},"/campaignQuestions/VALUE/values/{ID}":{"get":{"operationId":"get-question-value","summary":"Get Question Value","description":"This endpoint retrieves data of a specific Campaign Question Value based on JSON input. The API returns a single Campaign Question Value available to the user, according to the unique ID provided. If the specified Campaign Question Value does not exist, the response will be a \"bad request\".\n\nYou will only receive the Campaign Question Value after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The unique and specific identifier of the Campaign Question |\n| id | Integer | The unique and specific identifier of the Campaign Question Value to get |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The ID of the Campaign Question that the Value is referred to (see [Questions](#) resource) |\n| textBR | String | Campaign Value label in Brasilian Portuguese |\n| textDE | String | Campaign Value label in German |\n| textDK | String | Campaign Value label in Dutch |\n| textEN | String | Campaign Value label in English |\n| textES | String | Campaign Value label in Spanish |\n| textFR | String | Campaign Value label in French |\n| textIT | String | Campaign Value label in Italian |\n| textPT | String | Campaign Value label in Portuguese |\n| textRU | String | Campaign Value label in Russian |\n| textUS | String | Campaign Value label in American English |\n| dateCreated | String | Date and time when the Campaign Question Value was created |\n| dateDeleted | String | Date and time when the Campaign Question Value was deleted |\n| dateUpdated | String | Date and time when the Campaign Question Value was last updated |\n| deleted | Boolean | If true, the Campaign Question Value has been deleted and archived |\n| id | Integer | Unique identifier for the Campaign Question Value in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Campaign Question Value |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Campaign Question Value |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Campaign Question Value |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Question Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Question Value","content":{"application/json":{"examples":{"default":{"value":{"questionId":4,"textES":"","textEN":"50-200","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","deleted":false,"dateCreated":"2021-12-29T15:40:45.137Z","dateDeleted":null,"dateUpdated":null,"salesRepIdCreated":90,"salesRepIdUpdated":0,"salesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-question-value","summary":"Update Question Value","description":"This endpoint allows you to update a specific Campaign Question Value. If the specified Campaign Question Value does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Campaign Question Value after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Campaign Question Value.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The unique and specific identifier of the Campaign Question |\n| id | Integer | The unique and specific identifier of the Campaign Question Value to update |\n\nIn order to update a Campaign Question Value, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| textBR | String | Campaign Value label in Brasilian Portuguese |\n| textDE | String | Campaign Value label in German |\n| textDK | String | Campaign Value label in Dutch |\n| textEN | String | Campaign Value label in English |\n| textES | String | Campaign Value label in Spanish |\n| textFR | String | Campaign Value label in French |\n| textIT | String | Campaign Value label in Italian |\n| textPT | String | Campaign Value label in Portuguese |\n| textRU | String | Campaign Value label in Russian |\n| textUS | String | Campaign Value label in American English |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Question Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Question Value","content":{"application/json":{"examples":{"default":{"value":{"questionId":4,"textES":"","textEN":"500-1000","textIT":"","textFR":"","textDE":"","textPT":"","textUS":"","textBR":"","textRU":"","textDK":"","deleted":false,"dateCreated":"2021-12-29T15:40:45.137Z","dateDeleted":null,"dateUpdated":"2021-12-29T15:42:15.817Z","salesRepIdCreated":90,"salesRepIdUpdated":90,"salesRepIdDeleted":0,"id":1}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"textEN":{"type":"string"}}},"examples":{"default":{"value":{"textEN":"500-1000"}}}}}}},"delete":{"operationId":"delete-question-value","summary":"Delete Question Value","description":"This endpoint allows you to delete a specific Campaign Question Value from the user's ForceManager implementation database. If the specified Campaign Question Value does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Campaign Question Values after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| questionId | Integer | The unique and specific identifier of the Campaign Question |\n| id | Integer | The unique and specific identifier of the Campaign Question Value to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Campaign Question Value just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Campaigns / Question Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Question Value","content":{"application/json":{"examples":{"default":{"value":{"message":"success"}}}}}}},"security":[{"SessionKey":[]}]}},"/contacts/schema":{"get":{"operationId":"contacts-schema","summary":"Contacts schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Contact object.\n\nYou will only receive the Contacts Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Contacts Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Table | String | The name of the values list table |\n| Type | Object, Null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Contacts schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"UseCompanyAddress":{"description":"","readOnly":false,"type":["boolean","null"]},"accountId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"address1":{"description":"","maxLength":180,"readOnly":false,"type":["string","null"]},"birthday":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"city":{"description":"","maxLength":200,"readOnly":false,"type":["string","null"]},"comment":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"countryId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"countries","type":["object","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"email":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"email2":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"email3":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"extId":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"fax":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"firstName":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"gender":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"genre","type":["object","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"lastName":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"linkedin":{"description":"","maxLength":300,"readOnly":false,"type":["string","null"]},"marketingCommunications":{"description":"","readOnly":false,"type":["boolean","null"]},"permissionLevel":{"description":"","readOnly":false,"type":["integer","null"]},"phone1":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"phone2":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"postcode":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"readOnly":{"description":"","readOnly":false,"type":["boolean","null"]},"region":{"description":"","maxLength":200,"readOnly":false,"type":["string","null"]},"salesRepId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"skype":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"typeId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"contactTypes","type":["object","null"]}},"required":["accountId","lastName","firstName"],"title":"contacts","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/contacts":{"get":{"operationId":"list-contacts","summary":"List Contacts","description":"Returns all Contacts available in the user's ForceManager implementation database.\n\nYou will only receive the List of Contacts after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/contacts?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/contacts?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Contacts by `firstName` or `accountId`, or `typeId` for example.\n\nYou can also **organise and view** the results for Contacts in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/contacts?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/contacts?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Contacts available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Contacts attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Object, Null | Account to whom the Contact is linked to (see [Accounts](#) resource) |\n| address1 | String | Contact's first address |\n| city | String | City name |\n| comment | String | Comment added to the Contact profile |\n| countryId | Object, Null | Country ID (see [Countries](#) resource) of the address |\n| dateCreated | String | Date and time when the Contact was created |\n| dateDeleted | String | Date and time when the Contact was deleted |\n| dateUpdated | String | Date and time when the Contact was last updated |\n| deleted | boolean | If true, the Contact has been deleted and archived |\n| email | String | Contact's email address |\n| email2 | String | Contact's second email address |\n| email3 | String | Contact's third email address |\n| extId | String | External ID of the Contact from a third party system (ERP, CRM, Accounting System) |\n| fax | String | Contact's fax number |\n| firstName | String | Contact's first name |\n| gender | Integer | Male -> 0 or female -> 1 |\n| id | Integer | Unique identifier for the Contact in ForceManager |\n| lastName | String | Contact's last name |\n| linkedin | String | Contact's LinkedIn profile name |\n| permissionLevel | String | Defines the visibility of the Contact. Set from 1 to 5 being 5 the highest level of permission |\n| phone1 | String | Contact's first phone number |\n| phone2 | String | Contact's second phone number |\n| postcode | String | Postcode of the Contact address |\n| readOnly | boolean | If true, the Contact cannot be modified or deleted |\n| region | String | Region/State name referred to the address |\n| salesRepId | Object, Null | User responsible for the Contact |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Contact |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Contact |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Contact |\n| skype | String | Contact's Skype name |\n| typeId | Object, Null | Contact Type (see [Type](#) resource) |\n| UseCompanyAddress | Boolean | If true, Contact's address is the one of the associated Account |\n| birthday | String | Contact's birthday |\n| marketingCommunications | Boolean | If true, Contact can receive marketing communications |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Contacts","content":{"application/json":{"examples":{"default":{"value":[{"UseCompanyAddress":true,"accountId":{"id":1,"value":""},"address1":"2765 Smith Street","birthday":null,"city":"St. Louis","comment":"Very professional","countryId":{"id":75,"value":"United States"},"dateCreated":"2021-12-16T14:05:53.027Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"email":"j.doe@email.com","email2":null,"email3":null,"extId":null,"fax":"+39 789-5642","firstName":"John","gender":{"id":0,"value":"Male"},"id":287,"lastName":"Doe","linkedin":"John_Doe","marketingCommunications":true,"permissionLevel":2,"phone1":"+39 687-9234","phone2":"+39 982-6501","postcode":"63124","readOnly":false,"region":"MO","salesRepId":{"id":310,"value":""},"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"skype":"John_Doe","typeId":{"id":9,"value":"Department of Administration"}}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-contact","summary":"Create Contact","description":"This endpoint allows you to create a Contact based on JSON input.\n\nYou will only be able to create a Contact after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId (_Required_) | Integer | Account to whom the Contact is linked to (see [Accounts](#) resource) |\n| address1 | String | Contact's first address |\n| city | String | City name |\n| comment | String | Comment added to the Contact profile |\n| countryId | Integer | Country ID (see [Countries](#) resource) of the address |\n| email | String | Contact's email address |\n| email2 | String | Contact's second email address |\n| email3 | String | Contact's third email address |\n| extId | String | External ID of the Contact from a third party system (ERP, CRM, Accounting System) |\n| fax | String | Contact's fax number |\n| firstName (_Required_) | String | Contact's first name |\n| gender | Integer | Male -> 0 or female -> 1 |\n| lastName (_Required_) | String | Contact's last name |\n| linkedin | String | Contact's LinkedIn profile name |\n| permissionLevel | String | Defines the visibility of the Contact. Set from 1 to 5 being 5 the highest level of permission |\n| phone1 | String | Contact's first phone number |\n| phone2 | String | Contact's second phone number |\n| postcode | String | Postcode of the Contact address |\n| readOnly | boolean | If true, the Contact cannot be modified or deleted |\n| region | String | Region/State name referred to the address |\n| salesRepId (_Required_) | Object, Null | Contact responsible for the Contact |\n| skype | String | Contact's Skype name |\n| typeId | Integer | Contact Type (see [Type](#) resource) |\n| UseCompanyAddress | Boolean | If true, Contact's address is the one of the associated Account |\n| birthday | String | Contact's birthday |\n| marketingCommunications | Boolean | If true, Contact can receive marketing communications |\n\n**RESPONSE**\n\nReturns a JSON with information about the Contact just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Contact |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Contact","content":{"application/json":{"examples":{"default":{"value":{"id":287,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"integer"},"address1":{"type":"string"},"city":{"type":"string"},"comment":{"type":"string"},"countryId":{"type":"integer"},"email":{"type":"string"},"fax":{"type":"string"},"firstName":{"type":"string"},"gender":{"type":"integer"},"lastName":{"type":"string"},"linkedin":{"type":"string"},"permissionLevel":{"type":"integer"},"phone1":{"type":"string"},"phone2":{"type":"string"},"postcode":{"type":"string"},"readOnly":{"type":"boolean"},"region":{"type":"string"},"salesRepId":{"type":"integer"},"skype":{"type":"string"},"typeId":{"type":"integer"},"birthday":{"type":"string"}}},"examples":{"default":{"value":{"accountId":1,"address1":"2765 Smith Street","city":"St. Louis","comment":"Very professional","countryId":75,"email":"j.doe@email.com","fax":"+39 789-5642","firstName":"John","gender":0,"lastName":"Doe","linkedin":"John_Doe","permissionLevel":2,"phone1":"+39 687-9234","phone2":"+39 982-6501","postcode":"63124","readOnly":false,"region":"MO","salesRepId":310,"skype":"John_Doe","typeId":9,"birthday":"2021-10-02"}}}}}}}},"/contacts/{ID}":{"get":{"operationId":"get-contact","summary":"Get Contact","description":"This endpoint retrieves data of a specific Contact based on JSON input. The API returns a single Contact available to the user, according to the unique ID provided. If the specified Contact does not exist, the response will be a \"bad request\".\n\nYou will only receive the Contact after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Contact |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Object, Null | Account to whom the Contact is linked to (see [Accounts](#) resource) |\n| address1 | String | Contact's first address |\n| city | String | City name |\n| comment | String | Comment added to the Contact profile |\n| countryId | Object, Null | Country ID (see [Countries](#) resource) of the address |\n| dateCreated | String | Date and time when the Contact was created |\n| dateDeleted | String | Date and time when the Contact was deleted |\n| dateUpdated | String | Date and time when the Contact was last updated |\n| deleted | boolean | If true, the Contact has been deleted and archived |\n| email | String | Contact's email address |\n| email2 | String | Contact's second email address |\n| email3 | String | Contact's third email address |\n| extId | String | External ID of the Contact from a third party system (ERP, CRM, Accounting System) |\n| fax | String | Contact's fax number |\n| firstName | String | Contact's first name |\n| gender | Integer | Male -> 0 or female -> 1 |\n| id | Integer | Unique identifier for the Contact in ForceManager |\n| lastName | String | Contact's last name |\n| linkedin | String | Contact's LinkedIn profile name |\n| permissionLevel | String | Defines the visibility of the Contact. Set from 1 to 5 being 5 the highest level of permission |\n| phone1 | String | Contact's first phone number |\n| phone2 | String | Contact's second phone number |\n| postcode | String | Postcode of the Contact address |\n| readOnly | boolean | If true, the Contact cannot be modified or deleted |\n| region | String | Region/State name referred to the address |\n| salesRepId | Object, Null | Contact responsible for the Contact |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Contact |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Contact |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Contact |\n| skype | String | Contact's Skype name |\n| typeId | Object, Null | Contact Type (see [Type](#) resource) |\n| UseCompanyAddress | Boolean | If true, Contact's address is the one of the associated Account |\n| birthday | String | Contact's birthday |\n| marketingCommunications | Boolean | If true, Contact can receive marketing communications |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Contact","content":{"application/json":{"examples":{"default":{"value":{"UseCompanyAddress":true,"accountId":{"id":1,"value":""},"address1":"2765 Smith Street","birthday":"2021-10-02T00:00:00Z","city":"St. Louis","comment":"Very professional","countryId":{"id":75,"value":"United States"},"dateCreated":"2021-12-16T14:05:53.027Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"email":"j.doe@email.com","email2":null,"email3":null,"extId":null,"fax":"+39 789-5642","firstName":"John","gender":{"id":0,"value":"Male"},"id":287,"lastName":"Doe","linkedin":"John_Doe","marketingCommunications":true,"permissionLevel":2,"phone1":"+39 687-9234","phone2":"+39 982-6501","postcode":"63124","readOnly":false,"region":"MO","salesRepId":{"id":310,"value":""},"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"skype":"John_Doe","typeId":{"id":9,"value":"Department of Administration"}}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-contact","summary":"Update Contact","description":"This endpoint allows you to update a specific Contact. If the specified Contact does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Contact after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Contact. In order to update a Contact, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Integer | Account to whom the Contact is linked to (see [Accounts](#) resource) |\n| address1 | String | Contact's first address |\n| city | String | City name |\n| comment | String | Comment added to the Contact profile |\n| countryId | Integer | Country ID (see [Countries](#) resource) of the address |\n| email | String | Contact's email address |\n| email2 | String | Contact's second email address |\n| email3 | String | Contact's third email address |\n| extId | String | External ID of the Contact from a third party system (ERP, CRM, Accounting System) |\n| fax | String | Contact's fax number |\n| firstName | String | Contact's first name |\n| gender | Integer | Male -> 0 or female -> 1 |\n| lastName | String | Contact's last name |\n| linkedin | String | Contact's LinkedIn profile name |\n| permissionLevel | String | Defines the visibility of the Contact. Set from 1 to 5 being 5 the highest level of permission |\n| phone1 | String | Contact's first phone number |\n| phone2 | String | Contact's second phone number |\n| postcode | String | Postcode of the Contact address |\n| readOnly | boolean | If true, the Contact cannot be modified or deleted |\n| region | String | Region/State name referred to the address |\n| salesRepId | Object, Null | Contact responsible for the Contact |\n| skype | String | Contact's Skype name |\n| typeId | Integer | Contact Type (see [Type](#) resource) |\n| UseCompanyAddress | Boolean | If true, Contact's address is the one of the associated Account |\n| birthday | String | Contact's birthday |\n| marketingCommunications | Boolean | If true, Contact can receive marketing communications |\n\n**RESPONSE**\n\nReturns a JSON with information about the Contact just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Contact","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"address1":{"type":"string"},"city":{"type":"string"}}},"examples":{"default":{"value":{"address1":"22, Oxford Lane","city":"Chicago"}}}}}}},"delete":{"operationId":"delete-contact","summary":"Delete Contact","description":"This endpoint allows you to delete a specific Contact from the user's ForceManager account database. If the specified Contact does not exist, the response will be a \"bad request\". This operation cannot be undone.\n
You will only be able to delete Contacts after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication.](#)\n\n[\n**HEADERS**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | The acceptance |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n]: <>\n\n
\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| id | Integer | The unique and specific identifier of the Contact to delete |\n\n\n
\n**RESPONSE**\n\nReturns a JSON with information about the Contact just deleted.\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| Message | String | Shows the operation status |\n\n
\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Contact","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/contactTypes/schema":{"get":{"operationId":"contact-types-schema","summary":"Contact Types schema","description":"Returns properties object with the definition of each field in the Contact Types table.\n\nYou will only receive the Contact Types Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Contact Types Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Contact Types schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"order":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]}},"required":[],"title":"contactTypes","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/contactTypes":{"get":{"operationId":"list-contact-types","summary":"List Contact Types","description":"Returns all Contact Types available in the user's ForceManager implementation database.\n\nYou will only receive the List of Contact Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n\n**RESPONSE**\n\nThis endpoint returns information about all Contact Types available in the database. \n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Contact Types attributes:\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| branchVisibility | Object, Null | In which Branch the Contact Type is visible |\n| dateCreated | String | Date and time when the Contact Type was created |\n| dateDeleted | String | Date and time when the Contact Type was deleted |\n| dateUpdated | String | Date and time when the Contact Type was last updated |\n| deleted | Boolean | If true, the Contact Type has been deleted and archived |\n| descriptionBR | String | Contact Type label in Brasilian Portuguese |\n| descriptionDE | String | Contact Type label in German |\n| descriptionDK | String | Contact Type label in Dutch |\n| descriptionEN | String | Contact Type label in English |\n| descriptionES | String | Contact Type label in Spanish |\n| descriptionFR | String | Contact Type label in French |\n| descriptionIT | String | Contact Type label in Italian |\n| descriptionPT | String | Contact Type label in Portuguese |\n| descriptionRU | String | Contact Type label in Russian |\n| descriptionUS | String | Contact Type label in American English |\n| id | Integer | Unique identifier for the Contact Type in ForceManager |\n| order | Integer | The position of the Contact Type in the Contact Types value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Contact Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Contact Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Contact Type |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Contact Types","content":{"application/json":{"examples":{"default":{"value":[{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"Manager","descriptionDK":null,"descriptionEN":"Manager","descriptionES":"Gerente","descriptionFR":"Directeur","descriptionIT":"Manager","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2020-07-15T16:57:32.173Z","deleted":false,"descriptionBR":null,"descriptionDE":"Eigentümer","descriptionDK":null,"descriptionEN":"Owner","descriptionES":"Propietario","descriptionFR":"Propriétaire","descriptionIT":"Proprietario","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":2,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"Chefeinkäufer","descriptionDK":null,"descriptionEN":"Head buyer","descriptionES":"Jefe Compras","descriptionFR":"Directeur des achats","descriptionIT":"Direttore Acquisti","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":3,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"Verkaufsleiter","descriptionDK":null,"descriptionEN":"Sales Director","descriptionES":"Dir. Comercial","descriptionFR":"Directeur Commercial","descriptionIT":"Dir. Commerciale","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":5,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"Abteilung Vertrieb und Verkauf","descriptionDK":null,"descriptionEN":"Commercial Department","descriptionES":"Dpt. Comercial","descriptionFR":"Dpt. Commercial","descriptionIT":"Dipart. Commerciale","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":6,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"EDV-Abteilung","descriptionDK":null,"descriptionEN":"Systems Department","descriptionES":"Dpt. Sistemas","descriptionFR":"Dpt. Systèmes","descriptionIT":"Dipart. Sistemi","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":7,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"Abteilung Einkauf","descriptionDK":null,"descriptionEN":"Purchasing Department","descriptionES":"Dpt. Compras","descriptionFR":"Dpt. Achats","descriptionIT":"Dipart. Acquisti","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":8,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"Verwaltungsabteilung","descriptionDK":null,"descriptionEN":"Department of Administration","descriptionES":"Dpt. Admon","descriptionFR":"Dpt. Administration","descriptionIT":"Dipart. Amministrazione","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":9,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"Marketingabteilung","descriptionDK":null,"descriptionEN":"Marketing department","descriptionES":"Dpt. Marqueting","descriptionFR":"Dpt. Marketing","descriptionIT":"Dipart. Marketing","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":10,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"Sonstige","descriptionDK":null,"descriptionEN":"Other","descriptionES":"Otro","descriptionFR":"Autre","descriptionIT":"Altro","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":11,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"Partner","descriptionDK":null,"descriptionEN":"Partner","descriptionES":"Socio","descriptionFR":"Partenaire","descriptionIT":"Socio","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":12,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.14Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.14Z","deleted":false,"descriptionBR":null,"descriptionDE":"EDV-Leiter","descriptionDK":null,"descriptionEN":"Systems manager","descriptionES":"Dir. Sistemas","descriptionFR":"Directeur des Systèmes","descriptionIT":"Dir. Sistemi","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":13,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2009-05-22T18:15:37Z","dateDeleted":null,"dateUpdated":"2009-05-22T18:15:37Z","deleted":false,"descriptionBR":null,"descriptionDE":"Finanzleiter","descriptionDK":null,"descriptionEN":"Chief Financial Officer","descriptionES":"Dir. Financiero","descriptionFR":"Directeur Administratif et Financier (DAF)","descriptionIT":"Dir. Finanziario","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":14,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-contact-type","summary":"Create Contact Type","description":"This endpoint allows you to create a Contact Type based on JSON input.\n\nYou will only be able to create a Contact Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Contact Type is visible |\n| descriptionBR | String | Contact Type label in Brasilian Portuguese |\n| descriptionDE | String | Contact Type label in German |\n| descriptionDK | String | Contact Type label in Dutch |\n| descriptionEN (*Required*) | String | Contact Type label in English |\n| descriptionES | String | Contact Type label in Spanish |\n| descriptionFR | String | Contact Type label in French |\n| descriptionIT | String | Contact Type label in Italian |\n| descriptionPT | String | Contact Type label in Portuguese |\n| descriptionRU | String | Contact Type label in Russian |\n| descriptionUS | String | Contact Type label in American English |\n| order | Integer | The position of the Contact Type in the Contact Types value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Contact Type just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Contact Type |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Contact Type","content":{"application/json":{"examples":{"default":{"value":{"id":15,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"}}},"examples":{"default":{"value":{"descriptionEN":"Sales Director"}}}}}}}},"/contactTypes/{ID}":{"get":{"operationId":"get-contact-type","summary":"Get Contact Type","description":"This endpoint retrieves data of a specific Contact Type based on JSON input. The API returns a single Contact Type available to the user in the Value List, according to the unique ID provided. If the specified Contact Type does not exist, the response will be a \"bad request\".\n\nYou will only receive the Contact Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| id | Integer | The unique and specific identifier of the Contact Type |\n\n**RESPONSE**\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| branchVisibility | Object, Null | In which Branch the Contact Type is visible |\n| dateCreated | String | Date and time when the Contact Type was created |\n| dateDeleted | String | Date and time when the Contact Type was deleted |\n| dateUpdated | String | Date and time when the Contact Type was last updated |\n| deleted | Boolean | If true, the Contact Type has been deleted and archived |\n| descriptionBR | String | Contact Type label in Brasilian Portuguese |\n| descriptionDE | String | Contact Type label in German |\n| descriptionDK | String | Contact Type label in Dutch |\n| descriptionEN | String | Contact Type label in English |\n| descriptionES | String | Contact Type label in Spanish |\n| descriptionFR | String | Contact Type label in French |\n| descriptionIT | String | Contact Type label in Italian |\n| descriptionPT | String | Contact Type label in Portuguese |\n| descriptionRU | String | Contact Type label in Russian |\n| descriptionUS | String | Contact Type label in American English |\n| id | Integer | Unique identifier for the Contact Type in ForceManager |\n| order | Integer | The position of the Contact Type in the Contact Typees value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Contact Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Contact Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Contact Type |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Contact Type","content":{"application/json":{"examples":{"default":{"value":{"branchVisibility":null,"dateCreated":"2009-05-22T18:15:37Z","dateDeleted":null,"dateUpdated":"2009-05-22T18:15:37Z","deleted":false,"descriptionBR":null,"descriptionDE":"Finanzleiter","descriptionDK":null,"descriptionEN":"Chief Financial Officer","descriptionES":"Dir. Financiero","descriptionFR":"Directeur Administratif et Financier (DAF)","descriptionIT":"Dir. Finanziario","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":14,"order":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-contact-type","summary":"Update Contact Type","description":"This endpoint allows you to update a specific Contact Type. If the specified Contact Type does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Contact Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Contact Type. In order to update a Contact Type, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Contact Type is visible |\n| descriptionBR | String | Contact Type label in Brasilian Portuguese |\n| descriptionDE | String | Contact Type label in German |\n| descriptionDK | String | Contact Type label in Dutch |\n| descriptionEN | String | Contact Type label in English |\n| descriptionES | String | Contact Type label in Spanish |\n| descriptionFR | String | Contact Type label in French |\n| descriptionIT | String | Contact Type label in Italian |\n| descriptionPT | String | Contact Type label in Portuguese |\n| descriptionRU | String | Contact Type label in Russian |\n| descriptionUS | String | Contact Type label in American English |\n| order | Integer | The position of the Contact Type in the Contact Types value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Contact Type just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Contact Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"}}},"examples":{"default":{"value":{"descriptionEN":"Partner"}}}}}}},"delete":{"operationId":"delete-contact-type","summary":"Delete Contact Type","description":"This endpoint allows you to delete a specific Contact Type from the user's ForceManager implementation database. If the specified Contact Type does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Contact Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Contact Type to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Contact Type just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Contacts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Contact Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/countries/schema":{"get":{"operationId":"countries-schema","summary":"Countries schema","description":"Returns properties object with the definition of each field in the Countries table.\n\nYou will only receive the Countries Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Countries Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Countries"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Countries schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"dateCreated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"deleted":{"description":"","readOnly":false,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionde":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionen":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionfr":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionit":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionpt":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":false,"type":["integer","null"]},"iso2":{"description":"","maxLength":2,"readOnly":false,"type":["string","null"]},"iso3":{"description":"","maxLength":3,"readOnly":false,"type":["string","null"]},"isoNum":{"description":"","readOnly":false,"type":["integer","null"]},"phoneCode":{"description":"","maxLength":10,"readOnly":false,"type":["string","null"]},"salesRepIdCreated":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":false,"type":["integer","null"]},"strName":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]}},"required":[],"title":"countries","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/countries":{"get":{"operationId":"list-countries","summary":"List Countries","description":"Returns all Countries available. Countries are basically needed for the geolocalized data (e.g. Accounts, Opportunities, Activities) in which a full address need to be specified.\n\nYou will only receive the Countries after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Countries available for the value list.\n\nList of the supported Countries attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| dateCreated | String | Date and time when the Country was created |\n| dateDeleted | String | Date and time when the Country was deleted |\n| dateUpdated | String | Date and time when the Country was last updated |\n| deleted | Boolean | If true, the Country has been deleted and archived |\n| descriptionBR | String | Country name in Brasilian Portuguese |\n| descriptionDE | String | Country name in German |\n| descriptionDK | String | Country name in Dutch |\n| descriptionEN | String | Country name in English |\n| descriptionES | String | Country name in Spanish |\n| descriptionFR | String | Country name in French |\n| descriptionIT | String | Country name in Italian |\n| descriptionPT | String | Country name in Portuguese |\n| descriptionRU | String | Country name in Russian |\n| descriptionUS | String | Country name in American English |\n| id | Integer | Unique identifier for the Country in ForceManager |\n| iso2 | String | The ISO 3166 alpha-2 code of the Country |\n| iso3 | String | The ISO 3166 alpha-3 code of the Country |\n| isoNum | Integer | The ISO 3166 numeric code of the Country |\n| phoneCode | String | Phone code of the specific the Country |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Country |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Country |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Country |\n| strName | String | Generic Country name |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Countries"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Countries","content":{"application/json":{"examples":{"default":{"value":[{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Afeganistão","descriptionDK":"Afghanistan","descriptionRU":null,"descriptionUS":"Afghanistan","descriptionde":"Afghanistan","descriptionen":"Afghanistan","descriptionfr":"Afghanistan","descriptionit":"Afghanistan","descriptionpt":"Afeganistão","id":1,"iso2":"AF","iso3":"AFG","isoNum":4,"phoneCode":"93","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Afganistán"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Ilhas Alanda","descriptionDK":"Ålandsøerne","descriptionRU":null,"descriptionUS":"Aland Islands","descriptionde":"Ålandinseln","descriptionen":"Aland Islands","descriptionfr":"Îles Åland","descriptionit":"Isole Aland","descriptionpt":"Ilhas Alanda","id":2,"iso2":"AX","iso3":"ALA","isoNum":248,"phoneCode":"358","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Islas Gland"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Albânia","descriptionDK":"Albanien","descriptionRU":null,"descriptionUS":"Albania","descriptionde":"Albanien","descriptionen":"Albania","descriptionfr":"Albanie","descriptionit":"Albania","descriptionpt":"Albânia","id":3,"iso2":"AL","iso3":"ALB","isoNum":8,"phoneCode":"355","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Albania"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Alemanha","descriptionDK":"Tyskland","descriptionRU":null,"descriptionUS":"Germany","descriptionde":"Deutschland","descriptionen":"Germany","descriptionfr":"Allemagne","descriptionit":"Germania","descriptionpt":"Alemanha","id":4,"iso2":"DE","iso3":"DEU","isoNum":276,"phoneCode":"49","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Alemania"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Andorra","descriptionDK":"Andorra","descriptionRU":null,"descriptionUS":"Andorra","descriptionde":"Andorra","descriptionen":"Andorra","descriptionfr":"Andorre","descriptionit":"Andorra","descriptionpt":"Andorra","id":5,"iso2":"AD","iso3":"AND","isoNum":20,"phoneCode":"376","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Andorra"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Angola","descriptionDK":"Angola","descriptionRU":null,"descriptionUS":"Angola","descriptionde":"Angola","descriptionen":"Angola","descriptionfr":"Angola","descriptionit":"Angola","descriptionpt":"Angola","id":6,"iso2":"AO","iso3":"AGO","isoNum":24,"phoneCode":"244","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Angola"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Anguilha","descriptionDK":"Anguilla","descriptionRU":null,"descriptionUS":"Anguilla","descriptionde":"Anguilla","descriptionen":"Anguilla","descriptionfr":"Anguilla","descriptionit":"Anguilla","descriptionpt":"Anguilha","id":7,"iso2":"AI","iso3":"AIA","isoNum":660,"phoneCode":"1264","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Anguilla"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Antárctica","descriptionDK":"Antarktis","descriptionRU":null,"descriptionUS":"Antarctica","descriptionde":"Antarktis","descriptionen":"Antarctica","descriptionfr":"Antarctique","descriptionit":"Antartide","descriptionpt":"Antárctica","id":8,"iso2":"AQ","iso3":"ATA","isoNum":10,"phoneCode":"672","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Antártida"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Antígua e Barbuda","descriptionDK":"Antigua og Barbuda","descriptionRU":null,"descriptionUS":"Antigua and Barbuda","descriptionde":"Antigua und Barbuda","descriptionen":"Antigua and Barbuda","descriptionfr":"Antigua-et-Barbuda","descriptionit":"Antigua e Barbuda","descriptionpt":"Antígua e Barbuda","id":9,"iso2":"AG","iso3":"ATG","isoNum":28,"phoneCode":"1268","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Antigua y Barbuda"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":"2019-03-07T10:30:34.813Z","dateUpdated":"2017-02-06T17:27:58.523Z","deleted":true,"descriptionBR":"Antilhas Holandesas","descriptionDK":"Hollandske Antiller","descriptionRU":null,"descriptionUS":"Antillas Holandesas","descriptionde":null,"descriptionen":"Antillas Holandesas","descriptionfr":"Antilles néerlandaises","descriptionit":"Antille Olandesi","descriptionpt":"Antilhas Holandesas","id":10,"iso2":"AN","iso3":"ANT","isoNum":530,"phoneCode":"599","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Antillas Holandesas"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Arábia Saudita","descriptionDK":"Saudi Arabien","descriptionRU":null,"descriptionUS":"Saudi Arabia","descriptionde":"Saudi-Arabien","descriptionen":"Saudi Arabia","descriptionfr":"Arabie saoudite","descriptionit":"Arabia Saudita","descriptionpt":"Arábia Saudita","id":11,"iso2":"SA","iso3":"SAU","isoNum":682,"phoneCode":"966","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Arabia Saudí"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Argélia","descriptionDK":"Algeriet","descriptionRU":null,"descriptionUS":"Algeria","descriptionde":"Algerien","descriptionen":"Algeria","descriptionfr":"Algérie","descriptionit":"Algeria","descriptionpt":"Argélia","id":12,"iso2":"DZ","iso3":"DZA","isoNum":12,"phoneCode":"213","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Argelia"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Argentina","descriptionDK":"Argentina","descriptionRU":null,"descriptionUS":"Argentina","descriptionde":"Argentinien","descriptionen":"Argentina","descriptionfr":"Argentine","descriptionit":"Argentina","descriptionpt":"Argentina","id":13,"iso2":"AR","iso3":"ARG","isoNum":32,"phoneCode":"54","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Argentina"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Arménia","descriptionDK":"Armenien","descriptionRU":null,"descriptionUS":"Armenia","descriptionde":"Armenien","descriptionen":"Armenia","descriptionfr":"Arménie","descriptionit":"Armenia","descriptionpt":"Arménia","id":14,"iso2":"AM","iso3":"ARM","isoNum":51,"phoneCode":"374","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Armenia"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Aruba","descriptionDK":"Aruba","descriptionRU":null,"descriptionUS":"Aruba","descriptionde":"Aruba","descriptionen":"Aruba","descriptionfr":"Aruba","descriptionit":"Aruba","descriptionpt":"Aruba","id":15,"iso2":"AW","iso3":"ABW","isoNum":533,"phoneCode":"297","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Aruba"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Austrália","descriptionDK":"Australien","descriptionRU":null,"descriptionUS":"Australia","descriptionde":"Australien","descriptionen":"Australia","descriptionfr":"Australie","descriptionit":"Australia","descriptionpt":"Austrália","id":16,"iso2":"AU","iso3":"AUS","isoNum":36,"phoneCode":"61","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Australia"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Áustria","descriptionDK":"Østrig","descriptionRU":null,"descriptionUS":"Austria","descriptionde":"Österreich","descriptionen":"Austria","descriptionfr":"Autriche","descriptionit":"Austria","descriptionpt":"Áustria","id":17,"iso2":"AT","iso3":"AUT","isoNum":40,"phoneCode":"43","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Austria"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Azerbeijão","descriptionDK":"Aserbajdsjan","descriptionRU":null,"descriptionUS":"Azerbaijan","descriptionde":"Aserbaidschan","descriptionen":"Azerbaijan","descriptionfr":"Azerbaïdjan","descriptionit":"Azerbaigian","descriptionpt":"Azerbeijão","id":18,"iso2":"AZ","iso3":"AZE","isoNum":31,"phoneCode":"994","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Azerbaiyán"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Baamas","descriptionDK":"Bahamas","descriptionRU":null,"descriptionUS":"Bahamas","descriptionde":"Bahamas","descriptionen":"Bahamas","descriptionfr":"Bahamas","descriptionit":"Bahamas","descriptionpt":"Baamas","id":19,"iso2":"BS","iso3":"BHS","isoNum":44,"phoneCode":"1242","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Bahamas"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Bahrein","descriptionDK":"Bahrain","descriptionRU":null,"descriptionUS":"Bahrain","descriptionde":"Bahrain","descriptionen":"Bahrain","descriptionfr":"Bahreïn","descriptionit":"Bahrein","descriptionpt":"Bahrein","id":20,"iso2":"BH","iso3":"BHR","isoNum":48,"phoneCode":"973","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Bahréin"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Bangladeche","descriptionDK":"Bangladesh","descriptionRU":null,"descriptionUS":"Bangladesh","descriptionde":"Bangladesch","descriptionen":"Bangladesh","descriptionfr":"Bangladesh","descriptionit":"Bangladesh","descriptionpt":"Bangladeche","id":21,"iso2":"BD","iso3":"BGD","isoNum":50,"phoneCode":"880","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Bangladesh"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Barbados","descriptionDK":"Barbados","descriptionRU":null,"descriptionUS":"Barbados","descriptionde":"Barbados","descriptionen":"Barbados","descriptionfr":"Barbade","descriptionit":"Barbados","descriptionpt":"Barbados","id":22,"iso2":"BB","iso3":"BRB","isoNum":52,"phoneCode":"1246","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Barbados"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Bielorrússia","descriptionDK":"Hviderusland","descriptionRU":null,"descriptionUS":"Belarus","descriptionde":"Belarus (Weißrussland)","descriptionen":"Belarus","descriptionfr":"Bélarus","descriptionit":"Bielorussia","descriptionpt":"Bielorrússia","id":23,"iso2":"BY","iso3":"BLR","isoNum":112,"phoneCode":"375","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Bielorrusia"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Bélgica","descriptionDK":"Belgien","descriptionRU":null,"descriptionUS":"Belgium","descriptionde":"Belgien","descriptionen":"Belgium","descriptionfr":"Belgique","descriptionit":"Belgio","descriptionpt":"Bélgica","id":24,"iso2":"BE","iso3":"BEL","isoNum":56,"phoneCode":"32","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Bélgica"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Belize","descriptionDK":"Belize","descriptionRU":null,"descriptionUS":"Belize","descriptionde":"Belize","descriptionen":"Belize","descriptionfr":"Belize","descriptionit":"Belize","descriptionpt":"Belize","id":25,"iso2":"BZ","iso3":"BLZ","isoNum":84,"phoneCode":"501","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Belice"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Benim","descriptionDK":"Benin","descriptionRU":null,"descriptionUS":"Benin","descriptionde":"Benin","descriptionen":"Benin","descriptionfr":"Bénin","descriptionit":"Benin","descriptionpt":"Benim","id":26,"iso2":"BJ","iso3":"BEN","isoNum":204,"phoneCode":"229","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Benin"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Bermudas","descriptionDK":"Bermuda","descriptionRU":null,"descriptionUS":"Bermuda","descriptionde":"Bermuda","descriptionen":"Bermuda","descriptionfr":"Bermudes","descriptionit":"Bermuda","descriptionpt":"Bermudas","id":27,"iso2":"BM","iso3":"BMU","isoNum":60,"phoneCode":"1441","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Bermudas"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Butão","descriptionDK":"Bhutan","descriptionRU":null,"descriptionUS":"Bhutan","descriptionde":"Bhutan","descriptionen":"Bhutan","descriptionfr":"Bhoutan","descriptionit":"Bhutan","descriptionpt":"Butão","id":28,"iso2":"BT","iso3":"BTN","isoNum":64,"phoneCode":"975","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Bhután"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Bolívia","descriptionDK":"Bolivia","descriptionRU":null,"descriptionUS":"Bolivia, Plurinational State of","descriptionde":"Bolivien, Plurinationaler Staat","descriptionen":"Bolivia, Plurinational State of","descriptionfr":"Bolivie","descriptionit":"Bolivia","descriptionpt":"Bolívia","id":29,"iso2":"BO","iso3":"BOL","isoNum":68,"phoneCode":"591","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Bolivia"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Bósnia-Herzegovina","descriptionDK":"Bosnien Hercegovina","descriptionRU":null,"descriptionUS":"Bosnia and Herzegovina","descriptionde":"Bosnien und Herzegowina","descriptionen":"Bosnia and Herzegovina","descriptionfr":"Bosnie-Herzégovine","descriptionit":"Bosnia Erzegovina","descriptionpt":"Bósnia-Herzegovina","id":30,"iso2":"BA","iso3":"BIH","isoNum":70,"phoneCode":"387","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Bosnia y Herzegovina"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Botswana","descriptionDK":"Botswana","descriptionRU":null,"descriptionUS":"Botswana","descriptionde":"Botsuana","descriptionen":"Botswana","descriptionfr":"Botswana","descriptionit":"Botswana","descriptionpt":"Botswana","id":31,"iso2":"BW","iso3":"BWA","isoNum":72,"phoneCode":"267","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Botsuana"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Ilha Bouvet","descriptionDK":"Bouvetøen","descriptionRU":null,"descriptionUS":"Bouvet Island","descriptionde":"Bouvetinsel","descriptionen":"Bouvet Island","descriptionfr":"Île Bouvet","descriptionit":"Isola Bouvet","descriptionpt":"Ilha Bouvet","id":32,"iso2":"BV","iso3":"BVT","isoNum":74,"phoneCode":"","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Isla Bouvet"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Brasil","descriptionDK":"Brasilien","descriptionRU":null,"descriptionUS":"Brazil","descriptionde":"Brasilien","descriptionen":"Brazil","descriptionfr":"Brésil","descriptionit":"Brasile","descriptionpt":"Brasil","id":33,"iso2":"BR","iso3":"BRA","isoNum":76,"phoneCode":"55","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Brasil"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Brunei","descriptionDK":"Brunei","descriptionRU":null,"descriptionUS":"Brunei Darussalam","descriptionde":"Brunei Darussalam","descriptionen":"Brunei Darussalam","descriptionfr":"Brunéi Darussalam","descriptionit":"Brunei","descriptionpt":"Brunei","id":34,"iso2":"BN","iso3":"BRN","isoNum":96,"phoneCode":"673","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Brunéi"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Bulgária","descriptionDK":"Bulgarien","descriptionRU":null,"descriptionUS":"Bulgaria","descriptionde":"Bulgarien","descriptionen":"Bulgaria","descriptionfr":"Bulgarie","descriptionit":"Bulgaria","descriptionpt":"Bulgária","id":35,"iso2":"BG","iso3":"BGR","isoNum":100,"phoneCode":"359","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Bulgaria"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Burkina-Faso","descriptionDK":"Burkina Faso","descriptionRU":null,"descriptionUS":"Burkina Faso","descriptionde":"Burkina Faso","descriptionen":"Burkina Faso","descriptionfr":"Burkina Faso","descriptionit":"Burkina Faso","descriptionpt":"Burkina-Faso","id":36,"iso2":"BF","iso3":"BFA","isoNum":854,"phoneCode":"226","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Burkina Faso"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Burundi","descriptionDK":"Burundi","descriptionRU":null,"descriptionUS":"Burundi","descriptionde":"Burundi","descriptionen":"Burundi","descriptionfr":"Burundi","descriptionit":"Burundi","descriptionpt":"Burundi","id":37,"iso2":"BI","iso3":"BDI","isoNum":108,"phoneCode":"257","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Burundi"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Cabo Verde","descriptionDK":"Cape Verde","descriptionRU":null,"descriptionUS":"Cape Verde","descriptionde":"Kap Verde","descriptionen":"Cape Verde","descriptionfr":"Cap-Vert","descriptionit":"Capo Verde","descriptionpt":"Cabo Verde","id":38,"iso2":"CV","iso3":"CPV","isoNum":132,"phoneCode":"238","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Cabo Verde"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Ilhas Caimão","descriptionDK":"Cayman Islands","descriptionRU":null,"descriptionUS":"Cayman Islands","descriptionde":"Kaimaninseln","descriptionen":"Cayman Islands","descriptionfr":"Îles Caïmans","descriptionit":"Isole Cayman","descriptionpt":"Ilhas Caimão","id":39,"iso2":"KY","iso3":"CYM","isoNum":136,"phoneCode":"1345","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Islas Caimán"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Camboja","descriptionDK":"Cambodia","descriptionRU":null,"descriptionUS":"Cambodia","descriptionde":"Kambodscha","descriptionen":"Cambodia","descriptionfr":"Cambodge","descriptionit":"Cambogia","descriptionpt":"Camboja","id":40,"iso2":"KH","iso3":"KHM","isoNum":116,"phoneCode":"855","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Camboya"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"República dos Camarões","descriptionDK":"Cameroun","descriptionRU":null,"descriptionUS":"Cameroon","descriptionde":"Kamerun","descriptionen":"Cameroon","descriptionfr":"Cameroun","descriptionit":"Camerun","descriptionpt":"República dos Camarões","id":41,"iso2":"CM","iso3":"CMR","isoNum":120,"phoneCode":"237","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Camerún"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Canadá","descriptionDK":"Canada","descriptionRU":null,"descriptionUS":"Canada","descriptionde":"Kanada","descriptionen":"Canada","descriptionfr":"Canada","descriptionit":"Canada","descriptionpt":"Canadá","id":42,"iso2":"CA","iso3":"CAN","isoNum":124,"phoneCode":"1","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Canadá"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"República Centro-Africana","descriptionDK":"Centralafrikanske Republik","descriptionRU":null,"descriptionUS":"Central African Republic","descriptionde":"Zentralafrikanische Republik","descriptionen":"Central African Republic","descriptionfr":"République centrafricaine","descriptionit":"Repubblica Centrafricana","descriptionpt":"República Centro-Africana","id":43,"iso2":"CF","iso3":"CAF","isoNum":140,"phoneCode":"236","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"República Centroafricana"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Chade","descriptionDK":"Chad","descriptionRU":null,"descriptionUS":"Chad","descriptionde":"Tschad","descriptionen":"Chad","descriptionfr":"Tchad","descriptionit":"Ciad","descriptionpt":"Chade","id":44,"iso2":"TD","iso3":"TCD","isoNum":148,"phoneCode":"235","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Chad"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"República Checa","descriptionDK":"Tjekkiet","descriptionRU":null,"descriptionUS":"Czech Republic","descriptionde":"Tschechische Republik","descriptionen":"Czech Republic","descriptionfr":"République tchèque","descriptionit":"Repubblica Ceca","descriptionpt":"República Checa","id":45,"iso2":"CZ","iso3":"CZE","isoNum":203,"phoneCode":"420","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"República Checa"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Chile","descriptionDK":"Chile","descriptionRU":null,"descriptionUS":"Chile","descriptionde":"Chile","descriptionen":"Chile","descriptionfr":"Chili","descriptionit":"Cile","descriptionpt":"Chile","id":46,"iso2":"CL","iso3":"CHL","isoNum":152,"phoneCode":"56","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Chile"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"China","descriptionDK":"Kina","descriptionRU":null,"descriptionUS":"China","descriptionde":"China","descriptionen":"China","descriptionfr":"Chine","descriptionit":"Cina","descriptionpt":"China","id":47,"iso2":"CN","iso3":"CHN","isoNum":156,"phoneCode":"86","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"China"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Chipre","descriptionDK":"Cypern","descriptionRU":null,"descriptionUS":"Cyprus","descriptionde":"Zypern","descriptionen":"Cyprus","descriptionfr":"Chypre","descriptionit":"Cipro","descriptionpt":"Chipre","id":48,"iso2":"CY","iso3":"CYP","isoNum":196,"phoneCode":"357","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Chipre"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Ilha do Natal","descriptionDK":null,"descriptionRU":null,"descriptionUS":"Christmas Island","descriptionde":"Weihnachtsinsel","descriptionen":"Christmas Island","descriptionfr":"Île Christmas","descriptionit":"Isola di Christmas","descriptionpt":"Ilha do Natal","id":49,"iso2":"CX","iso3":"CXR","isoNum":162,"phoneCode":"61","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Isla de Navidad"},{"dateCreated":"2012-01-27T12:22:54.063Z","dateDeleted":null,"dateUpdated":"2019-03-21T11:39:01.32Z","deleted":false,"descriptionBR":"Vaticano","descriptionDK":"Vatikanstaten","descriptionRU":null,"descriptionUS":"Holy See (Vatican City State)","descriptionde":"Der Heilige Stuhl (Vatikanstaat)","descriptionen":"Holy See (Vatican City State)","descriptionfr":"État de la Cité du Vatican","descriptionit":"Vaticano","descriptionpt":"Vaticano","id":50,"iso2":"VA","iso3":"VAT","isoNum":336,"phoneCode":"397","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1,"strName":"Ciudad del Vaticano"}]}}}}}},"security":[{"SessionKey":[]}]}},"/currencies/schema":{"get":{"operationId":"currencies-schema","summary":"Currencies schema","description":"Returns properties object with the definition of each field in the Currencies table.\n\nYou will only receive the Currencies Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Currencies Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Currencies"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Currencies schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"dateCreated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"deleted":{"description":"","readOnly":false,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":false,"type":["integer","null"]},"isoCode":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"salesRepIdCreated":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":false,"type":["integer","null"]},"symbol":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]}},"required":["descriptionES","symbol","isoCode"],"title":"currencies","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/currencies":{"get":{"operationId":"list-currencies","summary":"List Currencies","description":"Returns all Currencies available. Currencies are needed for defining the measurement unit of the Opportunities.\n\nYou will only receive the Currencies after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Currencies available for the value list.\n\nList of the supported Currencies attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| dateCreated | String | Date and time when the Currency was created |\n| dateDeleted | String | Date and time when the Currency was deleted |\n| dateUpdated | String | Date and time when the Currency was last updated |\n| deleted | Boolean | If true, the Currency has been deleted and archived |\n| descriptionBR | String | Currency name in Brasilian Portuguese |\n| descriptionDE | String | Currency name in German |\n| descriptionDK | String | Currency name in Dutch |\n| descriptionEN | String | Currency name in English |\n| descriptionES | String | Currency name in Spanish |\n| descriptionFR | String | Currency name in French |\n| descriptionIT | String | Currency name in Italian |\n| descriptionPT | String | Currency name in Portuguese |\n| descriptionRU | String | Currency name in Russian |\n| descriptionUS | String | Currency name in American English |\n| id | Integer | Unique identifier for the Currency in ForceManager |\n| isoCode | String | The ISO 4217 code of the Currency |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Currency |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Currency |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Currency |\n| symbol | String | The literal symbol of the Currency |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Currencies"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Currencies","content":{"application/json":{"examples":{"default":{"value":[{"dateCreated":null,"dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"Euro","descriptionDK":null,"descriptionEN":"euro","descriptionES":"euro","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"isoCode":"eur","salesRepIdCreated":null,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"symbol":"€"},{"dateCreated":null,"dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"US-Dollar","descriptionDK":null,"descriptionEN":"dollar usa","descriptionES":"dollar usa","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":2,"isoCode":"usd","salesRepIdCreated":null,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"symbol":"$"},{"dateCreated":null,"dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"Pfund Sterling","descriptionDK":null,"descriptionEN":"pound sterling","descriptionES":"libra esterlina","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":3,"isoCode":"gbp","salesRepIdCreated":null,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"symbol":"£"}]}}}}}},"security":[{"SessionKey":[]}]}},"/documents":{"get":{"operationId":"list-documents","summary":"List Documents","description":"Returns all Documents available in the user's ForceManager implementation database.\n\nYou will only receive the List of Documents after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Documents by `dateCreated` or `dateUpdated`, or `size` for example.\n\nYou can also **organise and view** the results for Documents in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Documents available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Documents attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| \\--- | \\--- | \\--- |\n| accountId | Object, Null | The ID of the Account that Document belongs to (see [Accounts](#) resource) |\n| activityId | Object, Null | The ID of the Activity that Document belongs to (see [Activities](#) resource) |\n| billboardId | Object, Null | The ID of the News that Document belongs to (see [News](#) resource) |\n| campaignId | Object, Null | The ID of the Campaign that Document belongs to (see [Campaigns](#) resource) |\n| contactId | Object, Null | The ID of the Contact that Document belongs to (see [Contacts](#) resource) |\n| opportunityId | Object, Null | The ID of the Opportunity that Document belongs to (see [Opportunities](#) resource) |\n| salesOrderId | Object, Null | The ID of the Order that Document belongs to (see [Orders](#) resource) |\n| folderId | Object, Null | The Folder Id that the Document belongs to (see [Folders](#) resource) |\n| formId | Object, Null | The ID of the Form that Document belongs to to (see [Forms](#) resource) |\n| dateCreated | String | Date and time when the Document was created |\n| dateDeleted | String | Date and time when the Document was deleted |\n| dateUpdated | String | Date and time when the Document was last updated |\n| deleted | boolean | If true, the Document has been deleted and archived |\n| description | String | The Document name. The user is gonna see this name. |\n| extension | String | The Document extension (docx, pptx, pdf, xlsx, jpg, png...) |\n| extId | String | External ID of the Document from a third party system (ERP, CRM, Accounting System) |\n| hidden | Boolean | True if the Document is visible. Otherwise, false |\n| id | Integer | Unique identifier for the Document in ForceManager |\n| name | String | The original Document name. This is the stored name in ForceManager database |\n| level | Integer | Defines the visibility of the Document. Set from 1 to 5 being 5 the highest level of permission |\n| link | String | The url to retrieve the Document |\n| userId | Integer | The ID of the User that upload the Document |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Document |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Document |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Document |\n| size | Integer | The file size in bytes |\n| carrousel | Boolean | True if the Document is a Product Carousel (see [Carousels](#) resource) |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Documents / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Documents","content":{"application/json":{"examples":{"default":{"value":[{"id":14,"description":"local_47a928b","name":"0000014.jpg","extension":"jpg","folderId":-1,"opportunityId":-1,"quoteId":-1,"deleted":false,"dateDeleted":null,"userId":103,"size":3615322,"level":2,"accountId":-1,"contactId":-1,"activityId":-1,"salesRepIdDeleted":null,"salesRepIdCreated":103,"salesRepIdUpdated":103,"dateCreated":"2018-09-18T10:15:25.947Z","dateUpdated":"2018-09-18T10:15:26.473Z","extId":null,"link":"https://forcemanager0001.s3.amazonaws.com/59340/0000014.jpg?AWSAccessKeyId=AKIAJ42UVINUBWRYEMMA&Expires=1567165253&Signature=jNTVTYe5efqavo4A0Asrsp5vDSs=","salesOrderId":-1,"formId":11,"billboardId":-1,"carrousel":false,"campaignId":-1},{"id":19,"description":"Design ticket categories","name":"0000019.docx","extension":"docx","folderId":137,"opportunityId":-1,"quoteId":-1,"deleted":false,"dateDeleted":null,"userId":180,"size":17202,"level":2,"accountId":-1,"contactId":-1,"activityId":-1,"salesRepIdDeleted":null,"salesRepIdCreated":180,"salesRepIdUpdated":180,"dateCreated":"2019-05-17T08:19:04.317Z","dateUpdated":"2019-05-17T08:19:08.01Z","extId":null,"link":"https://forcemanager0001.s3.amazonaws.com/59340/0000019.docx?AWSAccessKeyId=AKIAJ42UVINUBWRYEMMA&Expires=1567165253&Signature=/936mcxdek3PYT9eCuJgN64upo0=","salesOrderId":-1,"formId":-1,"billboardId":-1,"carrousel":false,"campaignId":-1}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"add-document","summary":"Add Document","description":"This endpoint allows you to upload a Document based on JSON input.\n\nYou will only be able to upload a Document after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| folderId (*Required*) | String | Set the value -1 if you want to upload the Document in the Root folder, otherwise set the Folder's ID if you want to upload the file in a specific folder |\n| name (*Required*) | String | The Document's name |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| locator | String | The url you should upload the Document (check table below). |\n| id | Integer | The ID assigned to the Document in the ForceManager Database |\n\nIMPORTANT: To upload your file to ForceManager storage you must do a **PUT request** with the **binary data** you want to upload and set the following headers:\n\n| **Attribute** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/octet-stream | Binary file specification |\n| Content-Length | {file.size} | It is the size of the file you are going to upload, in bytes |\n\nThe endpoint to invoke with the PUT request is the one returned by this API call under the `locator` field.\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Documents / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Upload Document"}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"type":"string"},"name":{"type":"string"}}},"examples":{"default":{"value":{"folderId":"-1","name":"CashFlow_2021.xlsx"}}}}}}}},"/VALUE/VALUE/documents":{"get":{"operationId":"list-documents-of-a-resource","summary":"List Documents of a Resource","description":"Returns all Documents associated to the specific Resource (`accounts`, `opportunities`, `salesOrders`, ...) available in the user's ForceManager implementation database based on JSON input.\n\nYou will only receive the List of Documents after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Documents by `dateCreated` or `dateUpdated`, or `size` for example.\n\nYou can also **organise and view** the results for Documents in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Documents available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Documents attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| \\--- | \\--- | \\--- |\n| accountId | Object, Null | The ID of the Account that Document belongs to (see [Accounts](#) resource) |\n| activityId | Object, Null | The ID of the Activity that Document belongs to (see [Activities](#) resource) |\n| billboardId | Object, Null | The ID of the News that Document belongs to (see [News](#) resource) |\n| campaignId | Object, Null | The ID of the Campaign that Document belongs to (see [Campaigns](#) resource) |\n| contactId | Object, Null | The ID of the Contact that Document belongs to (see [Contacts](#) resource) |\n| opportunityId | Object, Null | The ID of the Opportunity that Document belongs to (see [Opportunities](#) resource) |\n| salesOrderId | Object, Null | The ID of the Order that Document belongs to (see [Orders](#) resource) |\n| folderId | Object, Null | The Folder Id that the Document belongs to (see [Folders](#) resource) |\n| formId | Object, Null | The ID of the Form that Document belongs to to (see [Forms](#) resource) |\n| dateCreated | String | Date and time when the Document was created |\n| dateDeleted | String | Date and time when the Document was deleted |\n| dateUpdated | String | Date and time when the Document was last updated |\n| deleted | boolean | If true, the Document has been deleted and archived |\n| description | String | The Document name. The user is gonna see this name. |\n| extension | String | The Document extension (docx, pptx, pdf, xlsx, jpg, png...) |\n| extId | String | External ID of the Document from a third party system (ERP, CRM, Accounting System) |\n| hidden | Boolean | True if the Document is visible. Otherwise, false |\n| id | Integer | Unique identifier for the Document in ForceManager |\n| name | String | The original Document name. This is the stored name in ForceManager database |\n| level | Integer | Defines the visibility of the Document. Set from 1 to 5 being 5 the highest level of permission |\n| link | String | The url to retrieve the Document |\n| userId | Integer | The ID of the User that upload the Document |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Document |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Document |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Document |\n| size | Integer | The file size in bytes |\n| carrousel | Boolean | True if the Document is a Product Carousel (see [Carousels](#) resource) |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Documents / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Documents of a Resource","content":{"application/json":{"examples":{"default":{"value":[{"id":13,"description":"local_temp_image_1534944044.253842","name":"0000013.jpg","extension":"jpg","folderId":-1,"opportunityId":-1,"quoteId":-1,"deleted":false,"dateDeleted":null,"userId":103,"size":3397,"level":2,"accountId":4,"activityId":-1,"salesRepIdDeleted":null,"salesRepIdCreated":103,"salesRepIdUpdated":103,"dateCreated":"2018-08-22T15:20:34.303Z","dateUpdated":"2018-08-22T15:20:38.39Z","extId":null,"link":"https://api.forcemanager.net/api/v4/download/aHR0cHM6Ly9mb3JjZW1hbmFnZXIwMDAxLnMzLmV1LXdlc3QtMS5hbWF6b25hd3MuY29tLzY3OTIzLzAwMDAwMTMuanBnP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QVNJQTJCVDRISEtYTTZNNEtSQ0UlMkYyMDIxMTIxNSUyRmV1LXdlc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyMTEyMTVUMTc1NzUwWiZYLUFtei1FeHBpcmVzPTYwNDgwMCZYLUFtei1TZWN1cml0eS1Ub2tlbj1Gd29HWlhJdllYZHpFS1AlMkYlMkYlMkYlMkYlMkYlMkYlMkYlMkYlMkYlMkZ3RWFERWpCWjUxSzhBSXRZWk5QaENLV0JFbGVqZlh6NDBGeVRSUjI3NlBiOU5rWWNZWkM1N0U0Y0NPeXBsd2lrZGZYNlEzMWFsdGhKeVk4ME5wQWRqRWRlZXF0WVIwS2dyQVU1VWpsYklXbGZlcktDbzh2JTJCV05NaWl6ZGJxeiUyQlB4dXhhc1dvOW96QW4wTjNPSjQ0dEFWV2FqNzl3UWklMkYybEcwdkhRd2pKWjVyUXhSTHQ4TjBITkVMTHE0MmduakY5SyUyRk1mWE5CM3pxbkc5S0tBMnc2bkduOTBFWHdGeGolMkJQVmhWeElnWWh6c3VEOVhLRnAlMkZabUVVT0t2VUdpVE1SZUQ1WktSQU4wZSUyRjhBbExsQm9RdndndHRlcEUxJTJGeno4dkl5NDRrQXRuR2dVQ0RCQWs5MWNIMUNRZDM3MXRxTWxtJTJCalo0M21hZ1YzRzk1amZ5VG9vV2YwaWplaUl5U3ZiaVlDazk3dWgxUGolMkZIYVdOenZZWjd6c3NBWG8lMkJzbHZ5ZnhlRVkycHY5MzExNjd3UXpvZ0dPJTJGRHQlMkZRZXRvTHNLJTJCVXZjd2g4VVJLVXNXclZnS0trMno5bnU0eGloWGpNbDBVZXFYMk93M1Q0Q0p1cDFURVA1MFBRYmQxaiUyQjAyZW9aOW5PcklZaXlPc0ptWCUyRm1jTHNibkFzQ1ROR2R1OGVxNG5aT1ZJZ3ZRM0djSk1aNHlXZWw3QjdESkNXaEpFV1JWSVVJUnFDQm5WeUF6T2VwSE5mMzZLcDRFTUhHZWF3U0ZmaHMwSHN0bzdDJTJCWVZkb2FOUDJUQmxBSiUyQlA5Z3JyZU9mYUdoc29kdWlIMUEwM2JaZFolMkJSaks3YUNKQkxmaVFrc2ljNnJCdWFoT1l0M2FXN0NxQUFnJTJGMHJwanUlMkZ0Z2tZNEhPNkg5aW9RZDVxWndMcW1tWXBIY0RnOHBid25ZZDdSRzc1NThhU1RYRzlhV2p0SHd1VUE5MFVVcGhOaEs1Q2pNeXVpTkJqSXFCUmolMkJsUXNQeXZyTHhvVEdsSGQ2ZzA1JTJCUmljQkxFcUolMkIwekl0N2syWktuanhXaG15WERnQ09tcyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmWC1BbXotU2lnbmF0dXJlPTk0M2U1OGNiNjIzYTg3M2VlNDU1NzU3NDAyYmFmMmRjMjZhNTBkYjM1YjNhMDFjMDljYTgzNjhiOGY4NDM0M2I=/bG9jYWxfdGVtcF9pbWFnZV8xNTM0OTQ0MDQ0LjI1Mzg0Mg==","salesOrderId":-1,"formId":-1,"billboardId":-1,"campaignId":-1,"contactId":-1,"isCarroussel":false},{"id":14,"description":"local_temp_image_1534944044.253842","name":"0000014.jpg","extension":"jpg","folderId":-1,"opportunityId":-1,"quoteId":-1,"deleted":false,"dateDeleted":null,"userId":103,"size":3397,"level":2,"accountId":4,"activityId":-1,"salesRepIdDeleted":null,"salesRepIdCreated":103,"salesRepIdUpdated":103,"dateCreated":"2018-08-22T15:20:34.327Z","dateUpdated":"2018-08-22T15:20:34.643Z","extId":null,"link":"https://api.forcemanager.net/api/v4/download/aHR0cHM6Ly9mb3JjZW1hbmFnZXIwMDAxLnMzLmV1LXdlc3QtMS5hbWF6b25hd3MuY29tLzY3OTIzLzAwMDAwMTQuanBnP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QVNJQTJCVDRISEtYTTZNNEtSQ0UlMkYyMDIxMTIxNSUyRmV1LXdlc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyMTEyMTVUMTc1NzUwWiZYLUFtei1FeHBpcmVzPTYwNDgwMCZYLUFtei1TZWN1cml0eS1Ub2tlbj1Gd29HWlhJdllYZHpFS1AlMkYlMkYlMkYlMkYlMkYlMkYlMkYlMkYlMkYlMkZ3RWFERWpCWjUxSzhBSXRZWk5QaENLV0JFbGVqZlh6NDBGeVRSUjI3NlBiOU5rWWNZWkM1N0U0Y0NPeXBsd2lrZGZYNlEzMWFsdGhKeVk4ME5wQWRqRWRlZXF0WVIwS2dyQVU1VWpsYklXbGZlcktDbzh2JTJCV05NaWl6ZGJxeiUyQlB4dXhhc1dvOW96QW4wTjNPSjQ0dEFWV2FqNzl3UWklMkYybEcwdkhRd2pKWjVyUXhSTHQ4TjBITkVMTHE0MmduakY5SyUyRk1mWE5CM3pxbkc5S0tBMnc2bkduOTBFWHdGeGolMkJQVmhWeElnWWh6c3VEOVhLRnAlMkZabUVVT0t2VUdpVE1SZUQ1WktSQU4wZSUyRjhBbExsQm9RdndndHRlcEUxJTJGeno4dkl5NDRrQXRuR2dVQ0RCQWs5MWNIMUNRZDM3MXRxTWxtJTJCalo0M21hZ1YzRzk1amZ5VG9vV2YwaWplaUl5U3ZiaVlDazk3dWgxUGolMkZIYVdOenZZWjd6c3NBWG8lMkJzbHZ5ZnhlRVkycHY5MzExNjd3UXpvZ0dPJTJGRHQlMkZRZXRvTHNLJTJCVXZjd2g4VVJLVXNXclZnS0trMno5bnU0eGloWGpNbDBVZXFYMk93M1Q0Q0p1cDFURVA1MFBRYmQxaiUyQjAyZW9aOW5PcklZaXlPc0ptWCUyRm1jTHNibkFzQ1ROR2R1OGVxNG5aT1ZJZ3ZRM0djSk1aNHlXZWw3QjdESkNXaEpFV1JWSVVJUnFDQm5WeUF6T2VwSE5mMzZLcDRFTUhHZWF3U0ZmaHMwSHN0bzdDJTJCWVZkb2FOUDJUQmxBSiUyQlA5Z3JyZU9mYUdoc29kdWlIMUEwM2JaZFolMkJSaks3YUNKQkxmaVFrc2ljNnJCdWFoT1l0M2FXN0NxQUFnJTJGMHJwanUlMkZ0Z2tZNEhPNkg5aW9RZDVxWndMcW1tWXBIY0RnOHBid25ZZDdSRzc1NThhU1RYRzlhV2p0SHd1VUE5MFVVcGhOaEs1Q2pNeXVpTkJqSXFCUmolMkJsUXNQeXZyTHhvVEdsSGQ2ZzA1JTJCUmljQkxFcUolMkIwekl0N2syWktuanhXaG15WERnQ09tcyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmWC1BbXotU2lnbmF0dXJlPTQ1OWY5N2IyZGU2ODRkZTRmNzc4ZTkzMGEwM2E5ZTU0MDY3MDg2Y2Q1MGM4NjE3ODc4YzQ3NjI3NDdlOWQxNmU=/bG9jYWxfdGVtcF9pbWFnZV8xNTM0OTQ0MDQ0LjI1Mzg0Mg==","salesOrderId":-1,"formId":-1,"billboardId":-1,"campaignId":-1,"contactId":-1,"isCarroussel":false}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"add-document-to-a-resource","summary":"Add Document to a Resource","description":"This endpoint allows you to upload a Document linking it to a Resource (`accounts`, `opportunities`, `salesOrders`) based on JSON input.\n\nYou will only be able to upload a Document after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| folderId (*Required*) | String | Set the value -1 if you want to upload the Document in the Root folder, otherwise set the Folder's ID if you want to upload the file in a specific folder |\n| name (*Required*) | String | The Document's name |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| locator | String | The url you should upload the Document to (check the table below) |\n| id | Integer | The ID assigned to the Document in the ForceManager Database |\n\nIMPORTANT: To upload your file to ForceManager storage you must do a **PUT request** with the **binary data** you want to upload and set the following headers:\n\n| **Attribute** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/octet-stream | Binary file specification |\n| Content-Length | {file.size} | It is the size of the file you are going to upload, in bytes |\n\nThe endpoint to invoke with the PUT request is the one returned by this API call under the `locator` field.\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Documents / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Upload Document"}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"type":"string"},"name":{"type":"string"}}},"examples":{"default":{"value":{"folderId":"-1","name":"Filename.pdf"}}}}}}}},"/documents/{ID}":{"delete":{"operationId":"delete-picture","summary":"Delete Picture","description":"This endpoint allows you to delete a specific Picture from the user's ForceManager implementation database. If the specified Picture does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete a Picture after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id (*Required*) | Integer | The unique and specific identifier of the Picture to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Document just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Carousel"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete picture","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/documents/folders":{"get":{"operationId":"list-folders","summary":"List Folders","description":"Returns all Folders available in the user's ForceManager implementation database.\n\nYou will only receive the List of Folders after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents/folders?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents/folders?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Folders by `dateCreated` or `dateUpdated`, or `entityId` for example.\n\nYou can also **organise and view** the results for Folders in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents/folders?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents/folders?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Folders available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Folders attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| folderId | Integer | The folder that contains this folder. If value is -1 means the folder is in the directory root, otherwise, means the folder belongs to another folder |\n| entityId | String | The ID of the entity associated to the folder. Entities can be: `accounts`, `contacts`, `opportunities`, etc. |\n| id | Integer | Unique identifier for the Folder in ForceManager |\n| name | String | The Folder name |\n| level | Integer | Defines the visibility of the Folder. Set from 1 to 5 being 5 the highest level of permission |\n| restrictSucursales | Boolean | True if not all the environment can see this Folder, otherwise False |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Folder |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Folder |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Folder |\n| dateCreated | String | Date and time when the Folder was created |\n| dateDeleted | String | Date and time when the Folder was deleted |\n| dateUpdated | String | Date and time when the Folder was last updated |\n| delete | boolean | If true, the Folder has been deleted and archived |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Documents / Folders"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Folders","content":{"application/json":{"examples":{"default":{"value":[{"id":135,"salesRepIdDeleted":null,"salesRepIdCreated":1,"salesRepIdUpdated":null,"dateCreated":"2018-08-21T15:35:19.673Z","dateUpdated":null,"deleted":false,"dateDeleted":null,"name":"Videos","folderId":-1,"restrictSucursales":false,"level":2,"entityId":null},{"id":136,"salesRepIdDeleted":null,"salesRepIdCreated":1,"salesRepIdUpdated":null,"dateCreated":"2018-08-21T15:35:19.707Z","dateUpdated":null,"deleted":false,"dateDeleted":null,"name":"Presentations","folderId":-1,"restrictSucursales":false,"level":2,"entityId":null},{"id":140,"salesRepIdDeleted":null,"salesRepIdCreated":105,"salesRepIdUpdated":null,"dateCreated":"2018-10-29T11:33:00.54Z","dateUpdated":null,"deleted":false,"dateDeleted":null,"name":"Brochures","folderId":-1,"restrictSucursales":false,"level":2,"entityId":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-folder","summary":"Create Folder","description":"This endpoint allows you to create a Folder based on JSON input.\n\nYou will only be able to create a Folder after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| name (*Required*) | String | The Folder name |\n| folderId (*Required*) | String | The ID of the folder it belongs. -1 if it's gonna be in the root level, otherwise the Folder ID that will contains this Folder |\n| level | Integer | Defines the visibility of the Folder. Set from 1 to 5 being 5 the highest level of permission |\n| restrictSucursales | Boolean | True if not all the environment can see this Folder, otherwise False |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| message | String | \"Entity Created\" if everything it's OK. Otherwise, the error message |\n| id | Integer | The ID assigned to the Folder in the ForceManager Database |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Documents / Folders"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Folder","content":{"application/json":{"examples":{"default":{"value":{"id":137,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"type":"integer"},"name":{"type":"string"}}},"examples":{"default":{"value":{"folderId":-1,"name":"April"}}}}}}}},"/VALUE/VALUE/documents/folders":{"get":{"operationId":"list-folders-of-a-resource","summary":"List Folders of a Resource","description":"Returns all Folders of a specific Entity available in the user's ForceManager implementation database.\n\nYou will only receive the List of Folders after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents/folders?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents/folders?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Folders by `dateCreated` or `dateUpdated`, or `entityId` for example.\n\nYou can also **organise and view** the results for Folders in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents/folders?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/documents/folders?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Folders available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Folders attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| folderId | Integer | The folder that contains this folder. If value is -1 means the folder is in the directory root, otherwise, means the folder belongs to another folder |\n| entityId | String | The ID of the entity associated to the folder. Entities can be: `accounts`, `contacts`, `opportunities`, etc. |\n| id | Integer | Unique identifier for the Folder in ForceManager |\n| name | String | The Folder name |\n| level | Integer | Defines the visibility of the Folder. Set from 1 to 5 being 5 the highest level of permission |\n| restrictSucursales | Boolean | True if not all the environment can see this folder, otherwise False |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Folder |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Folder |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Folder |\n| dateCreated | String | Date and time when the Folder was created |\n| dateDeleted | String | Date and time when the Folder was deleted |\n| dateUpdated | String | Date and time when the Folder was last updated |\n| delete | boolean | If true, the Folder has been deleted and archived |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Documents / Folders"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Folders of a Resource","content":{"application/json":{"examples":{"default":{"value":[{"id":135,"salesRepIdDeleted":null,"salesRepIdCreated":120,"salesRepIdUpdated":null,"dateCreated":"2021-12-15T20:57:25.953Z","dateUpdated":null,"deleted":false,"dateDeleted":null,"name":"Invoices","folderId":-1,"restrictSucursales":false,"level":2,"entityId":null},{"id":136,"salesRepIdDeleted":null,"salesRepIdCreated":120,"salesRepIdUpdated":null,"dateCreated":"2021-12-15T20:57:33.03Z","dateUpdated":null,"deleted":false,"dateDeleted":null,"name":"2021","folderId":135,"restrictSucursales":false,"level":2,"entityId":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-folder-for-a-resource","summary":"Create Folder for a Resource","description":"This endpoint allows you to create a Folder for a specific Entity based on JSON input.\n\nYou will only be able to create a Folder after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| name (*Required*) | String | The Folder name |\n| folderId (*Required*) | String | The ID of the folder it belongs. -1 if it's gonna be in the root level, otherwise the Folder ID that will contains this Folder |\n| level | Integer | Defines the visibility of the Folder. Set from 1 to 5 being 5 the highest level of permission |\n| restrictSucursales | Boolean | True if not all the environment can see this Folder, otherwise False |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| message | String | \"Entity Created\" if everything it's OK. Otherwise, the error message |\n| id | Integer | The ID assigned to the Folder in the ForceManager Database |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Documents / Folders"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Folder for a Resource","content":{"application/json":{"examples":{"default":{"value":{"id":138,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"folderId":{"type":"integer"},"name":{"type":"string"}}},"examples":{"default":{"value":{"folderId":136,"name":"January"}}}}}}}},"/emails/schema":{"get":{"operationId":"emails-schema","summary":"Emails schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Email object.\n\nYou will only receive the Emails Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Emails Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Emails"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Emails schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"accountId":{"readOnly":false,"table":"empresas","type":["integer","null"]},"attachments":{"properties":{"id":{"type":"integer"},"name":{"type":["string","null"]}},"readOnly":false},"body":{"maxLength":4000,"readOnly":false,"type":["string","null"]},"contactId":{"readOnly":false,"table":"contactos","type":["integer","null"]},"date":{"properties":{"time":{"format":"date-time","readOnly":true,"type":["string","null"]},"timeStamp":{"format":"date-time","readOnly":true,"type":["number","null"]},"timeZone":{"readOnly":true,"type":["string","null"]}},"readOnly":false},"date_created":{"format":"date-time","readOnly":true,"type":["string","null"]},"date_deleted":{"format":"date-time","readOnly":true,"type":["string","null"]},"date_updated":{"format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"readOnly":true,"type":["boolean","null"]},"emailFrom":{"maxLength":180,"readOnly":false,"type":["string","null"]},"emailTo":{"maxLength":180,"readOnly":false,"type":["string","null"]},"extId":{"maxLength":100,"readOnly":false,"type":["string","null"]},"id":{"readOnly":true,"type":"integer"},"mailFolder":{"maxLength":180,"readOnly":false,"type":["string","null"]},"opportunityId":{"readOnly":false,"table":"expedientes","type":["integer","null"]},"salesRepId":{"readOnly":false,"table":"tblUsuarios","type":["integer","null"]},"subject":{"maxLength":180,"readOnly":false,"type":["string","null"]},"type":{"readOnly":false,"type":"integer"},"user_created":{"readOnly":true,"type":["integer","null"]},"user_deleted":{"readOnly":true,"type":["integer","null"]},"user_updated":{"readOnly":true,"type":["integer","null"]}},"required":["emailFrom","emailTo","date","type","mailFolder"],"title":"emails","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/emails":{"get":{"operationId":"list-emails","summary":"List Emails","description":"Returns all Emails available in the user's ForceManager implementation database.\n\nYou will only receive the List of Emails after first providing the Session Key. TTo know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/emails?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/emails?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Emails by `emailFrom` or `emailTo` for example.\n\nYou can also **organise and view** the results for Emails in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/emails?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/emails?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Emails available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Emails attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Object, Null | Account to which the Email is linked to |\n| attachments | Object (Array), Null | Attachment's lists |\n| body | String | Email's content |\n| contactId | Object, Null | Contact to which the Email is linked to |\n| date | Object | JSONObject with the time, timestamp and timeZone attributes |\n| dateCreated | String | Date and time when the Email was created |\n| dateDeleted | String | Date and time when the Email was deleted |\n| dateUpdated | String | Date and time when the Email was last updated |\n| deleted | Boolean | If true, the Email has been deleted and archived |\n| emailFrom | String | Email of the person who's sending the email |\n| emailTo | Array | List of Emails, that will receive the mail |\n| extId | String | External ID of the Email from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | Unique identifier for the Email in ForceManager |\n| mailFolder | String | Folder to which the mail belongs. (For example: Inbox) |\n| opportunityId | Object, Null | Opportunity to which the Email is linked to |\n| salesRepId | Object, Null | Id of the User responsible for the Email |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Email |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Email |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Email |\n| subject | String | Email's subject |\n| type | Integer | 0 -> outgoing email and 1 -> incoming email |\n\nList of the supported Attachments attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Unique identifier for the Attachment in ForceManager |\n| name | String | Attachment name (include the file type (.pdf, xls...)) |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Emails"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Emails","content":{"application/json":{"examples":{"default":{"value":[{"id":1,"emailTo":"mark.zuck@domain.com","attachments":[],"extId":null,"accountId":1,"contactId":-1,"opportunityId":null,"salesRepId":-1,"emailFrom":"chris.cruise@domain.com","body":"Hi, as agreed, see here enclosed the quotation.","date":{"time":"2018-10-27T13:43:00Z","timeStamp":1540647780,"timeZone":"UTC"},"type":0,"mailFolder":null,"subject":"RE: updated quotation","salesRepIdDeleted":null,"salesRepIdUpdated":null,"dateCreated":"2018-10-29T11:33:00.4Z","dateUpdated":null,"dateDeleted":null,"deleted":false},{"id":2,"emailTo":"mark.zuck@domain.com","attachments":[],"extId":null,"accountId":2,"contactId":-1,"opportunityId":null,"salesRepId":-1,"emailFrom":"nathalie.london@domain.com","body":"Hi, this is just a reminder to confirm the meeting with your general manager for next week at 9am. Yours sincerely","date":{"time":"2018-10-26T11:43:00Z","timeStamp":1540554180,"timeZone":"UTC"},"type":0,"mailFolder":null,"subject":"Meeting confirmation","salesRepIdDeleted":null,"salesRepIdUpdated":null,"dateCreated":"2018-10-29T11:33:00.42Z","dateUpdated":null,"dateDeleted":null,"deleted":false}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-email","summary":"Create Email","description":"This endpoint allows you to create an Email based on JSON input.\n\nYou will only be able to create an Email after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Integer | Account to which the Email is linked to |\n| attachments | Object (Array), Null | Attachment's lists |\n| body | String | Email's content |\n| contactId | Object, Null | Contact to which the Email is linked to |\n| date | String | Date and time when the Email was sent or received |\n| emailFrom | String | Email of the person who's sending the email |\n| emailTo | Array | List of Emails, that will receive the mail |\n| extId | String | External ID of the Email from a third party system (ERP, CRM, Accounting System) |\n| mailFolder | String | Folder to which the mail belongs. (For example: Inbox) |\n| opportunityId | Integer | Opportunity to which the Email is linked to |\n| salesRepId | Integer | First sales representative responsible for the Email |\n| subject | String | Email's subject |\n| type | Integer | 0 -> outgoing email and 1 -> incoming email |\n\nList of the supported Attachments attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| name | String | Attachment name (include the file type (.pdf, xls...)) |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new WebHook |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows the emails that will receive the email and the operation's id |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Emails"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Email","content":{"application/json":{"examples":{"default":{"value":[{"id":7,"emailTo":"api.test.to1@email.com"},{"id":8,"emailTo":"api.test.to2@email.com"}]}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"emailTo":{"type":"array"},"attachments":{"type":"array"},"extId":{"type":"string"},"accountId":{"type":"integer"},"contactId":{"type":"integer"},"opportunityId":{"type":"integer"},"salesRepId":{"type":"integer"},"emailFrom":{"type":"string"},"body":{"type":"string"},"date":{"type":"string"},"type":{"type":"integer"},"mailFolder":{"type":"string"},"subject":{"type":"string"}}},"examples":{"default":{"value":{"emailTo":["api.test.to1@email.com","api.test.to2@email.com"],"attachments":[{"name":"attachament1.jpeg","size":100},{"name":"attachament2.jpeg","size":100}],"extId":"00000000BD5B2F047F11F44782AD033C4A04EB0FA4354000","accountId":2,"contactId":3,"opportunityId":4,"salesRepId":2,"emailFrom":"api.test.from@email.com","body":"This is just an example of an email addressed to two different recipients, with attachments.","date":"2008-06-04T17:34:56+07:00","type":0,"mailFolder":null,"subject":"Sample email"}}}}}}}},"/emails/{ID}":{"get":{"operationId":"get-email","summary":"Get Email","description":"This endpoint retrieves data of a specific Email based on JSON input. The API returns a single Email available to the user, according to the unique ID provided. If the specified Email does not exist, the response will be a \"bad request\".\n\nYou will only receive the Email after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Email |\n\n**RESPONSE**\n\nThis endpoint returns information about all Emails available in the database.\n\nList of the supported Emails attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Object, Null | Account to which the Email is linked to |\n| attachments | Object (Array), Null | Attachment's lists |\n| body | String | Email's content |\n| contactId | Object, Null | Contact to which the Email is linked to |\n| date | Object | JSONObject with the time, timestamp and timeZone attributes |\n| dateCreated | String | Date and time when the Email was created |\n| dateDeleted | String | Date and time when the Email was deleted |\n| dateUpdated | String | Date and time when the Email was last updated |\n| deleted | Boolean | If true, the Email has been deleted and archived |\n| emailFrom | String | Email of the person who's sending the email |\n| emailTo | Array | List of Emails, that will receive the mail |\n| extId | String | External ID of the Email from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | Unique identifier for the Email in ForceManager |\n| mailFolder | String | Folder to which the mail belongs. (For example: Inbox) |\n| opportunityId | Object, Null | Opportunity to which the Email is linked to |\n| salesRepId | Object, Null | Id of the User responsible for the Email |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Email |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Email |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Email |\n| subject | String | Email's subject |\n| type | Integer | 0 -> outgoing email and 1 -> incoming email |\n\nList of the supported Attachments attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Unique identifier for the Attachment in ForceManager |\n| name | String | Attachment name (include the file type (.pdf, xls...)) |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Emails"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"OK"}},"security":[{"SessionKey":[]}]}},"/contactsEntities/schema":{"get":{"operationId":"entity-contacts-schema","summary":"Entity Contacts schema","description":"Returns properties object with the definition of each field in the Entity Contacts table.\n\nYou will only receive the Entity Contacts Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Entity Contacts Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Entity Contacts"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"OK"}},"security":[{"SessionKey":[]}]}},"/contactsEntities":{"get":{"operationId":"list-entity-contacts","summary":"List Entity Contacts","description":"Returns all Entity Contacts available. Entity Contacts are basically needed to associate more than one User to an Entity (e.g. the Opportunities with more than one sales rep).\n\nYou will only receive the Entity Contacts after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/entityContacts?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/entityContacts?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Entity Contacts by `entityId` or `contactId` for example.\n\n**RESPONSE**\n\nThis endpoint returns all Entity Contacts available for the value list.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Entity Contacts attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| entityId | Integer | The ID of the corresponding Entity that the User is associated to |\n| entityTypeId | Integer | The Entity type: 1 for Opportunity, 2 for Account, 3 for Contact, 4 for Activity, 10 for Event/Task |\n| contactId | Integer | The ID of the Contact to be related to the Entity (see [Contacts](#) resource) |\n| id | Integer | Unique identifier for the Entity Contact in ForceManager |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Entity Contacts"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"OK"}},"security":[{"SessionKey":[]}]}},"/entityOwners/schema":{"get":{"operationId":"entity-owners-schema","summary":"Entity Owners schema","description":"Returns properties object with the definition of each field in the Entity Owners table.\n\nYou will only receive the Entity Owners Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Entity Owners Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n- Description of each property\n \n- Definition of the data type for each property\n \n- Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Entity Owners"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Entity Owners schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"entityId":{"description":"","readOnly":true,"type":["integer","null"]},"entityTypeId":{"description":"","readOnly":true,"type":["integer","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepId":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepOrder":{"description":"","readOnly":true,"type":["integer","null"]}},"required":[],"title":"entityOwners","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/entityOwners":{"get":{"operationId":"list-entity-owners","summary":"List Entity Owners","description":"Returns all Entity Owners available. Entity Owners are basically needed to associate more than one User to an Entity (e.g. the Opportunities with more than one sales rep).\n\nYou will only receive the Entity Owners after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/entityOwners?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/entityOwners?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Entity Owners by `entityId` or `salesRepId` for example.\n\n**RESPONSE**\n\nThis endpoint returns all Entity Owners available for the value list.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Entity Owners attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| entityId | Integer | The ID of the corresponding Entity that the User is associated to |\n| entityTypeId | Integer | The Entity type: 1 for Opportunity, 2 for Account, 3 for Contact, 4 for Activity |\n| salesRepOrder | Integer | The order in which the User has to appear in the Entity Owners list |\n| dateCreated | String | Date and time when the Entity Owner was created |\n| dateDeleted | String | Date and time when the Entity Owner was deleted |\n| dateUpdated | String | Date and time when the Entity Owner was last updated |\n| deleted | Boolean | If true, the Entity Owner has been deleted and archived |\n| id | Integer | Unique identifier for the Entity Owner in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Entity Owner |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Entity Owner |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Entity Owner |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Entity Owners"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Entity Owners","content":{"application/json":{"examples":{"default":{"value":[{"dateCreated":"2021-12-16T23:00:26.993Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"entityId":130,"entityTypeId":1,"id":1,"salesRepId":121,"salesRepIdCreated":120,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"salesRepOrder":2},{"dateCreated":"2021-12-16T23:00:26.997Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"entityId":130,"entityTypeId":1,"id":2,"salesRepId":125,"salesRepIdCreated":120,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"salesRepOrder":3}]}}}}}},"security":[{"SessionKey":[]}]}},"/calendar/schema":{"get":{"operationId":"calendar-schema","summary":"Calendar schema","description":"The Schema is a metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Event/Task object. \nReturns properties object with the definition of each field in the Event/Task table.\n\nYou will only receive the Event/Task Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Event/Task Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Tabla | String | The name of the Value List table |\n| Type | Object, Null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Events/Tasks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Calendar schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"Completed":{"description":"","readOnly":false,"type":["boolean","null"]},"accountId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"allDay":{"description":"","readOnly":false,"type":["boolean","null"]},"branchId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"branches","type":["object","null"]},"comment":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"contactId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"contacts","type":["object","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"endDate":{"description":"","maxLength":10,"readOnly":false,"type":["string","null"]},"endHour":{"description":"","maxLength":10,"readOnly":false,"type":["string","null"]},"extId":{"description":"","maxLength":500,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"opportunityId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"opportunities","type":["object","null"]},"permissionLevel":{"description":"","readOnly":false,"type":["integer","null"]},"readOnly":{"description":"","readOnly":false,"type":["boolean","null"]},"reminder":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"sendNotification":{"description":"","readOnly":false,"type":["boolean","null"]},"startDate":{"description":"","maxLength":10,"readOnly":false,"type":["string","null"]},"startHour":{"description":"","maxLength":10,"readOnly":false,"type":["string","null"]},"subject":{"description":"","maxLength":2000,"readOnly":false,"type":["string","null"]},"task":{"description":"","readOnly":false,"type":["boolean","null"]},"typeId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"activityTypes","type":["object","null"]},"videoCallMeetingDetails":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"videoCallProviderId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"tblVideoCallProviders","type":["object","null"]}},"required":["endDate","salesRepId","startDate","subject"],"title":"calendar","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/calendar":{"get":{"operationId":"list-calendar","summary":"List Calendar","description":"Returns all Events and Tasks available in the user's ForceManager implementation database based on JSON input.\n\nYou will only receive the List of Events and Tasks after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/calendar?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/calendar?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Events and Tasks by `accountId`, `salesRepId`, `startDate` for example.\n\nYou can also **organise and view** the results for Event/Tasks in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/calendar?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/calendar?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Event/Tasks available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Event/Tasks attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Object, Null | Account to which the Event/Task is linked |\n| allDay | Boolean | If true, the Event/Task takes all day, it does not have a start and end time specified |\n| branchId | Object, Null | Branch the Event/Task is assigned to |\n| city | String | City name |\n| comment | String | Comment added to the Event/Task |\n| contactId | Object, Null | Contact to which an Event/Task is linked |\n| dateCreated | String | Date and time when the Event/Task was created |\n| dateDeleted | String | Date and time when the Event/Task was deleted |\n| dateUpdated | String | Date and time when the Event/Task was last updated |\n| deleted | Boolean | If true, the Account has been deleted and archived |\n| endDate | String | End Date and time of the Event/Task |\n| extId | String | External ID of the Event/Task from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The Event/Task's unique identifier |\n| opportunityId | Object, Null | Opportunity to which the Event/Task is linked |\n| permissionLevel | String | Defines the visibility of the Event/Task. Set from 1 to 5 being 5 the highest level of permission |\n| readOnly | Boolean | If true, the Event/Task can not be modified or deleted |\n| reminder | Integer | Time before the Event/Task when you want to be reminded of it: -2: not used, 1: Remind at the start time, 5: 5 minutes before to start, 15: 15 minutes before to start, 30: 30 minutes before to start, 1440: 1 hour before to start, 3600: 1 days before to start, 10080: 1 week before to start |\n| salesRepId | Object, Null | User responsible for this Event/Task |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Event/Task |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Event/Task |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Event/Task |\n| sendNotification | Boolean | If true, an invitation email will be sent to the Contacts of the Event/Task |\n| startDate | String | Start Date of the Event/Task |\n| startHour | String | Start hour of the Event/Task |\n| subject | String | Description or name of the Event/Task |\n| task | Boolean | If true, the entity is a Task. Then `endDate` and `endHour` is not needed |\n| typeId | Object, Null | Type of the Event/Task. e.g. meeting, visit, etc. |\n| completed | Boolean | If true, the Task is considered completed |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Events/Tasks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List calendar","content":{"application/json":{"examples":{"default":{"value":[{"accountId":null,"allDay":false,"branchId":{"id":4380,"value":"ForceManager"},"comment":"Remember to buy ForceManager before the trial expires so I can improve my sales efficiency.","completed":true,"contactId":null,"dateCreated":"2015-07-03T12:05:28.113Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"endDate":null,"endHour":null,"extId":null,"id":446,"opportunityId":null,"permissionLevel":1,"readOnly":false,"reminder":-1,"salesRepId":{"id":5548,"value":"Luis Sánchez"},"salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"sendNotification":false,"startDate":"15/07/16","startHour":"15:00","subject":"Buy ForceManager","task":true,"typeId":{"id":6420,"value":"Comment"}},{"accountId":null,"allDay":false,"branchId":{"id":4380,"value":"ForceManager"},"comment":null,"confirmed":true,"contactId":null,"dateCreated":"2015-07-03T12:05:28.13Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"endDate":"15/07/03","endHour":"13:46","extId":null,"id":447,"opportunityId":null,"permissionLevel":1,"readOnly":false,"reminder":-1,"salesRepId":{"id":5548,"value":"Luis Sánchez"},"salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"sendNotification":false,"startDate":"15/07/03","startHour":"23:59","subject":"Quotation meeting","task":false,"typeId":{"id":6420,"value":"Meeting"}}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-calendar","summary":"Create Calendar","description":"This endpoint allows you to create a Event/Task based on JSON input.\n\nYou will only be able to create an Event after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Integer | Account to which the Event/Task is linked |\n| allDay | Boolean | If true, the Event/Task takes all day, it does not have a start and end time specified |\n| branchId | Integer | Branch the Event/Task is assigned to |\n| city | String | City name |\n| comment | String | Comment added to the Event/Task |\n| contactId | Integer | Contact to which an Event/Task is linked |\n| endDate | String | End Date and time of the Event/Task |\n| extId | String | External ID of the Event/Task from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The Event/Task's unique identifier |\n| opportunityId | Integer | Opportunity to which the Event/Task is linked |\n| permissionLevel | String | Defines the visibility of the Event/Task. Set from 1 to 5 being 5 the highest level of permission |\n| readOnly | Boolean | If true, the Event/Task can not be modified or deleted |\n| reminder | Integer | Time before the Event/Task when you want to be reminded of it: -2: not used, 1: Remind at the start time, 5: 5 minutes before to start, 15: 15 minutes before to start, 30: 30 minutes before to start, 1440: 1 hour before to start, 3600: 1 days before to start, 10080: 1 week before to start |\n| salesRepId | Integer | User responsible for this Event/Task |\n| sendNotification | Boolean | If true, an invitation email will be sent to the Contacts of the Event/Task |\n| startDate | String | Start Date of the Event/Task |\n| startHour | String | Start hour of the Event/Task |\n| subject | String | Description or name of the Event/Task |\n| task | Boolean | If true, the entity is a Task. Then `endDate` and `endHour` is not needed |\n| typeId | Integer | Type of the Event/Task. e.g. meeting, visit, etc. |\n| completed | Boolean | If true, the Task is considered completed |\n\n**RESPONSE**\n\nReturns a JSON with information about the Event/Task just created.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new Event/Task |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Events/Tasks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create calendar","content":{"application/json":{"examples":{"default":{"value":{"id":763,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"integer"},"allDay":{"type":"boolean"},"branchId":{"type":"integer"},"comment":{"type":"string"},"contactId":{"type":"integer"},"endDate":{"type":"string"},"salesRepId":{"type":"integer"},"sendNotification":{"type":"boolean"},"startDate":{"type":"string"},"startHour":{"type":"string"},"subject":{"type":"string"},"task":{"type":"boolean"},"typeId":{"type":"string"}}},"examples":{"default":{"value":{"accountId":56,"allDay":false,"branchId":16,"comment":"Follow-up meeting","contactId":898,"endDate":"07/10/08","salesRepId":365,"sendNotification":true,"startDate":"07/10/08","startHour":"08:30","subject":"Sales Meeting","task":false,"typeId":null}}}}}}}},"/calendar/{ID}":{"get":{"operationId":"get-calendar","summary":"Get Calendar","description":"This endpoint retrieves data of a specific calendar Event or Task based on JSON input. The API returns a single Type available to the user, according to the unique ID provided. If the specified calendar Event or Task does not exist, the response will be a \"bad request\".\n\nYou will only receive the calendar Event or Task after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the calendar Event or Task |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Object, Null | Account to which the Event/Task is linked |\n| allDay | Boolean | If true, the Event/Task takes all day, it does not have a start and end time specified |\n| branchId | Object, Null | Branch the Event/Task is assigned to |\n| city | String | City name |\n| comment | String | Comment added to the Event/Task |\n| contactId | Object, Null | Contact to which an Event/Task is linked |\n| dateCreated | String | Date and time when the Event/Task was created |\n| dateDeleted | String | Date and time when the Event/Task was deleted |\n| dateUpdated | String | Date and time when the Event/Task was last updated |\n| deleted | Boolean | If true, the Account has been deleted and archived |\n| endDate | String | End Date and time of the Event/Task |\n| extId | String | External ID of the Event/Task from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The Event/Task's unique identifier |\n| opportunityId | Object, Null | Opportunity to which the Event/Task is linked |\n| permissionLevel | String | Defines the visibility of the Event/Task. Set from 1 to 5 being 5 the highest level of permission |\n| readOnly | Boolean | If true, the Event/Task can not be modified or deleted |\n| reminder | Integer | Time before the Event/Task when you want to be reminded of it: -2: not used, 1: Remind at the start time, 5: 5 minutes before to start, 15: 15 minutes before to start, 30: 30 minutes before to start, 1440: 1 hour before to start, 3600: 1 days before to start, 10080: 1 week before to start |\n| salesRepId | Object, Null | User responsible for this Event/Task |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Event/Task |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Event/Task |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Event/Task |\n| sendNotification | Boolean | If true, an invitation email will be sent to the Contacts of the Event/Task |\n| startDate | String | Start Date of the Event/Task |\n| startHour | String | Start hour of the Event/Task |\n| subject | String | Description or name of the Event/Task |\n| task | Boolean | If true, the entity is a Task. Then `endDate` and `endHour` is not needed |\n| typeId | Object, Null | Type of the Event/Task. e.g. meeting, visit, etc. |\n| completed | Boolean | If true, the Task is considered completed |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Events/Tasks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"Get calendar","content":{"application/json":{"examples":{"default":{"value":{"accountId":{"id":1757,"value":"Acme Inc."},"allDay":true,"branchId":{"id":4380,"value":"UK Dept."},"comment":"Remember to carry the documentation","completed":false,"contactId":null,"dateCreated":"2018-06-12T16:08:51.973Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"endDate":"15/07/07","endHour":"15:00","extId":null,"id":763,"opportunityId":null,"permissionLevel":2,"readOnly":false,"reminder":-2,"salesRepId":{"id":5548,"value":"Walter White"},"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"sendNotification":false,"startDate":"15/07/07","startHour":"23:59","subject":"Meeting","task":false,"typeId":{"id":6419,"value":"Meeting"}}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-calendar","summary":"Update Calendar","description":"The endpoint allows you to update specific information of a calendar Event or Task from the user's ForceManager implementation database. If the specified Event or Task does not exist, the response will be a \"bad request\".\n\nYou will only receive the Products after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific calendar Event or Task. In order to update an Event or Task, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId | Integer | Account to which the Event/Task is linked |\n| allDay | Boolean | If true, the Event/Task takes all day, it does not have a start and end time specified |\n| branchId | Integer | Branch the Event/Task is assigned to |\n| city | String | City name |\n| comment | String | Comment added to the Event/Task |\n| contactId | Integer | Contact to which an Event/Task is linked |\n| endDate | String | End Date and time of the Event/Task |\n| extId | String | External ID of the Event/Task from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The Event/Task's unique identifier |\n| opportunityId | Integer | Opportunity to which the Event/Task is linked |\n| permissionLevel | String | Defines the visibility of the Event/Task. Set from 1 to 5 being 5 the highest level of permission |\n| readOnly | Boolean | If true, the Event/Task can not be modified or deleted |\n| reminder | Integer | Time before the Event/Task when you want to be reminded of it: -2: not used, 1: Remind at the start time, 5: 5 minutes before to start, 15: 15 minutes before to start, 30: 30 minutes before to start, 1440: 1 hour before to start, 3600: 1 days before to start, 10080: 1 week before to start |\n| salesRepId | Integer | User responsible for this Event/Task |\n| sendNotification | Boolean | If true, an invitation email will be sent to the Contacts of the Event/Task |\n| startDate | String | Start Date of the Event/Task |\n| startHour | String | Start hour of the Event/Task |\n| subject | String | Description or name of the Event/Task |\n| task | Boolean | If true, the entity is a Task. Then `endDate` and `endHour` is not needed |\n| typeId | Integer | Type of the Event/Task. e.g. meeting, visit, etc. |\n| completed | Boolean | If true, the Task is considered completed |\n\n**RESPONSE**\n\nReturns a JSON with information about the Event or Task just updated.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Events/Tasks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update calendar","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"salesRepId":{"type":"string"},"sendNotification":{"type":"boolean"},"startDate":{"type":"string"},"startHour":{"type":"string"},"subject":{"type":"string"}}},"examples":{"default":{"value":{"salesRepId":"Susan North","sendNotification":true,"startDate":"22/10/08","startHour":"09:30","subject":"Meeting"}}}}}}},"delete":{"operationId":"delete-calendar","summary":"Delete Calendar","description":"This endpoint allows you to delete a specific calendar Event or Task from the user's ForceManager implementation database. If the specified calendar Event or Task does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete calendar Event or Tasks after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the calendar Event or Task to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the calendar Event or Task just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Events/Tasks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Calendar","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/extrafields/VALUE/schema":{"get":{"operationId":"extra-fields-schema-by-resource","summary":"Extra Fields schema by Resource","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for an Extra Field object.\n\nYou will only receive the Extra Field's information after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication. \nTo know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| resource | String | The unique and specific identifier for the Entity you to retrieve data. The allowed values are: `accounts`, `activities`, `calendar`, `contacts`, `opportunities`, `products`, `rates`, `salesorders`, `users` |\n\n**RESPONSE**\n\nThe Extra Field Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Extra Fields / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Extra Fields schema by Resource","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branches":{"items":{"maxLength":180,"type":"string"},"type":"array"},"dateCreated":{"format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"format":"date-time","readOnly":true,"type":["string","null"]},"defaultValue":{"readOnly":false,"type":["string","null"]},"deleted":{"readOnly":true,"type":["boolean","null"]},"dependenceField":{"readOnly":false,"type":["string","null"]},"description":{"readOnly":false,"type":["string","null"]},"descriptionBR":{"readOnly":false,"type":["string","null"]},"descriptionDE":{"readOnly":false,"type":["string","null"]},"descriptionDK":{"readOnly":false,"type":["string","null"]},"descriptionEN":{"readOnly":false,"type":["string","null"]},"descriptionFR":{"readOnly":false,"type":["string","null"]},"descriptionIT":{"readOnly":false,"type":["string","null"]},"descriptionPT":{"readOnly":false,"type":["string","null"]},"descriptionRU":{"readOnly":false,"type":["string","null"]},"descriptionUS":{"readOnly":false,"type":["string","null"]},"dynamicField":{"readOnly":false,"type":["string","null"]},"dynamicFieldValues":{"items":{"type":"number"},"readOnly":false,"type":["array","null"]},"entity":{"readOnly":false,"type":["string"]},"fieldName":{"readOnly":false,"type":["string"]},"id":{"readOnly":true,"type":"integer"},"idsDynamism":{"readOnly":false,"type":["integer","null"]},"length":{"readOnly":false,"type":["integer","null"]},"mandatory":{"type":["boolean","null"]},"mobileVisibility":{"type":["boolean","null"]},"multilanguage":{"type":["boolean","null"]},"order":{"readOnly":false,"type":["integer","null"]},"readOnly":{"type":["boolean","null"]},"restApi":{"type":["boolean","null"]},"salesRepIdCreated":{"readOnly":false,"table":"tblUsuarios","type":["integer","null"]},"salesRepIdDeleted":{"readOnly":false,"table":"tblUsuarios","type":["integer","null"]},"salesRepIdUpdated":{"readOnly":false,"table":"tblUsuarios","type":["integer","null"]},"searchable":{"format":"date-time","type":["boolean","null"]},"tabId":{"readOnly":false,"type":["integer","null"]},"type":{"readOnly":false,"type":["string","null"]},"valueListRelated":{"readOnly":false,"type":["string","null"]},"visibleInList":{"type":["boolean","null"]},"visibleInPhoneCallForm":{"readOnly":false,"type":["boolean","null"]},"webVisibility":{"type":["boolean","null"]}},"required":["entity","fieldName","type"],"title":"extrafield","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/extrafields/VALUE":{"get":{"operationId":"list-extra-fields-by-resource","summary":"List Extra Fields by Resource","description":"Returns all Extra Fields available in the user's ForceManager implementation database, for a specific Entity.\n\nYou will only receive the Extra Field's information after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication. \nTo know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**PARAMETERS REQUEST**\n\nYou can 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| resource | String | The unique and specific identifier for the Entity you to retrieve data. The allowed values are: `accounts`, `activities`, `calendar`, `contacts`, `opportunities`, `products`, `rates`, `salesorders`, `users` |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/extrafields/VALUE?page=PAGE_NUMBER\n\n ```\n\nYou can also **organise and view** the results for Extra Fields in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/extrafields/VALUE?order=VALUE\n\n ```\n\n**RESPONSE**\n\nReturns information about all Extra Fields existing in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Extra Fields attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| entity | String | The name of the entity the Extra Field is linked to |\n| description | String | Field name in Spanish |\n| fieldName | String | Field name in the ForceManager database |\n| type | Integer | Define the Extra Field's data type. The allowed types are: `datetime`, `text`, `decimal`, `bit`, `list`, `multivalue` |\n| valueListRelated | String | If `type` is `list` or `multivalue`, it has to contain the database name of table that the Extra Field is sticked to |\n| dateCreated | String | Date and time when the Extra Field was created |\n| dateDeleted | String | Date and time when the Extra Field was deleted |\n| dateUpdated | String | Date and time when the Extra Field was last updated |\n| deleted | Boolean | If true, the Extra Field has been deleted and archived |\n| defaultValue | String | The default value that the field should have |\n| descriptionEN | String | Field name in English |\n| descriptionIT | String | Field name in Italian |\n| descriptionFR | String | Field name in French |\n| descriptionDE | String | Field name in German |\n| descriptionPT | String | Field name in Portuguese |\n| descriptionUS | String | Field name in American English |\n| descriptionRU | String | Field name in Russian |\n| descriptionBR | String | Field name in Brasilian Portuguese |\n| descriptionDK | String | Field name in Dutch |\n| branches | Array | Branches in which the Extra Field is visibile |\n| id | Integer | The Extra Field unique identifier |\n| length | Integer | If Type is Text, define the length of this field |\n| mandatory | Boolean | If true, the Extra Field is mandatory |\n| mandatoryRestApi | Boolean | If true, the Extra Field is mandatory in the API requests |\n| readOnly | Boolean | If true, the Extra Field is read only |\n| order | Integer | Define its position inside the Tab |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Extra Field |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Extra Field |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Extra Field |\n| tabId | Integer | The id of the tab that contains the Extra Field |\n| searchable | Boolean | If true, you can search by the Extra Field |\n| visibleInList | Boolean | If true, the Extra Field is visible in the entity list views of the web app |\n| visibleInPhoneCallForm | Boolean | If true, the Extra Field is visible in the Phone Call form |\n| webVisibility | Boolean | If true, the Extra Field is visible in all the devices |\n| mobileVisibility | Boolean | If true, the Extra Field is visible in the mobile version |\n| restApi | String | If true, the Extra Field will be visible in the API requests |\n| dynamicField | String | The database name of the table that the Extra Field visibility depends from |\n| dynamicFieldValues | Array | The IDs of the values of the table, the one specified in the `dynamicField` field, that make the Extra Field visibile |\n| dependenceField | String | If `type` is `list` or `multivalue`, it has to contain the databae name fo the dependent table. This also requires to fill the `idParent` field of each Value of the `valueListRelated` table, to make the dependency effective |\n| fuzzySearch | Boolean | If `type` is `list` or `multivalue`, a value of the table can be selected through a search input instead of a option drop down menu, inside the entity create/update form |\n| includeTime | Boolean | If `type` is `datetime`, it lets you specify if the field has to include time values |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Extra Fields / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Extra Fields by Resource","content":{"application/json":{"examples":{"default":{"value":[{"id":36,"entity":"opportunities","fieldName":"Z_LossReason","valueListRelated":"Z_tblLossReasons","description":"Loss Reason","deleted":false,"dateDeleted":null,"searchable":true,"salesRepIdDeleted":null,"salesRepIdCreated":51,"salesRepIdUpdated":null,"dateCreated":"2021-11-17T00:53:35.95Z","dateUpdated":null,"visibleInList":true,"order":2,"webVisibility":true,"tabId":-1,"mobileVisibility":true,"mandatory":false,"readOnly":false,"descriptionEN":"","descriptionIT":"","descriptionFR":"","descriptionDE":"","descriptionPT":"","descriptionUS":"","descriptionRU":"","descriptionBR":"","descriptionDK":"","branches":null,"defaultValue":"","restApi":true,"idsDynamism":null,"visibleInPhoneCallForm":false,"type":"list","length":500,"dynamicField":null,"dynamicFieldValues":null,"dependenceField":null,"fuzzySearch":null,"includeTime":false,"mandatoryRestApi":false},{"id":37,"entity":"opportunities","fieldName":"Z_Source","valueListRelated":"Z_tblSources","description":"Source","deleted":false,"dateDeleted":null,"searchable":true,"salesRepIdDeleted":null,"salesRepIdCreated":51,"salesRepIdUpdated":null,"dateCreated":"2021-11-17T00:53:36.337Z","dateUpdated":null,"visibleInList":true,"order":1,"webVisibility":true,"tabId":-1,"mobileVisibility":true,"mandatory":false,"readOnly":false,"descriptionEN":"Source","descriptionIT":"Source","descriptionFR":"Source","descriptionDE":"Source","descriptionPT":"Source","descriptionUS":"Source","descriptionRU":"Source","descriptionBR":"Source","descriptionDK":"Source","branches":null,"defaultValue":"","restApi":true,"idsDynamism":null,"visibleInPhoneCallForm":false,"type":"list","length":500,"dynamicField":null,"dynamicFieldValues":null,"dependenceField":null,"fuzzySearch":null,"includeTime":false,"mandatoryRestApi":false},{"id":46,"entity":"opportunities","fieldName":"Z_Pipeline","valueListRelated":"Z_tblPipelines","description":"Pipelines","deleted":false,"dateDeleted":null,"searchable":true,"salesRepIdDeleted":null,"salesRepIdCreated":51,"salesRepIdUpdated":51,"dateCreated":"2021-11-17T23:45:46.63Z","dateUpdated":"2021-12-08T17:27:22.22Z","visibleInList":true,"order":0,"webVisibility":true,"tabId":-1,"mobileVisibility":true,"mandatory":false,"readOnly":true,"descriptionEN":"","descriptionIT":"","descriptionFR":"","descriptionDE":"","descriptionPT":"","descriptionUS":"","descriptionRU":"","descriptionBR":"","descriptionDK":"","branches":["16"],"defaultValue":"","restApi":true,"idsDynamism":null,"visibleInPhoneCallForm":true,"type":"list","length":500,"dynamicField":"idestadoobra","dynamicFieldValues":[475],"dependenceField":"idsucursal","fuzzySearch":true,"includeTime":false,"mandatoryRestApi":false}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-extra-field-for-resource","summary":"Create Extra Field for Resource","description":"This endpoint allows you to create an Extra Field for a specific entity.\n\nYou will only be able to create an Extra Field after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| entity (*Required*) | String | The name of the entity the Extra Field is linked to |\n| description | String | Field name in Spanish |\n| fieldName (*Required*) | String | Field name in the ForceManager database |\n| type (*Required*) | Integer | Define the Extra Field's data type. The allowed types are: `datetime`, `text`, `decimal`, `bit`, `list`, `multivalue` |\n| valueListRelated | String | If `type` is `list` or `multivalue`, it has to contain the database name of table that the Extra Field is sticked to |\n| defaultValue | String | The default value that the field should have |\n| descriptionEN | String | Field name in English |\n| descriptionIT | String | Field name in Italian |\n| descriptionFR | String | Field name in French |\n| descriptionDE | String | Field name in German |\n| descriptionPT | String | Field name in Portuguese |\n| descriptionUS | String | Field name in American English |\n| descriptionRU | String | Field name in Russian |\n| descriptionBR | String | Field name in Brasilian Portuguese |\n| descriptionDK | String | Field name in Dutch |\n| branches | Array | Branches in which the Extra Field is visibile |\n| id | Integer | The Extra Field unique identifier |\n| length | Integer | If Type is Text, define the length of this field |\n| mandatory | Boolean | If true, the Extra Field is mandatory |\n| mandatoryRestApi | Boolean | If true, the Extra Field is mandatory in the API requests |\n| readOnly | Boolean | If true, the Extra Field is read only |\n| order | Integer | Define its position inside the Tab |\n| tabId | Integer | The id of the tab that contains the Extra Field |\n| searchable | Boolean | If true, you can search by the Extra Field |\n| visibleInList | Boolean | If true, the Extra Field is visible in the entity list views of the web app |\n| visibleInPhoneCallForm | Boolean | If true, the Extra Field is visible in the Phone Call form |\n| webVisibility | Boolean | If true, the Extra Field is visible in all the devices |\n| mobileVisibility | Boolean | If true, the Extra Field is visible in the mobile version |\n| restApi | String | If true, the Extra Field will be visible in the API requests |\n| dynamicField | String | The database name of the table that the Extra Field visibility depends from |\n| dynamicFieldValues | Array | The values of the table that make the Extra Field visibile |\n| dependenceField | String | If `type` is `list` or `multivalue`, it has to contain the databae name fo the dependent table. This also requires to fill the `idParent` field of each Value of the `valueListRelated` table, to make the dependency effective |\n| fuzzySearch | Boolean | If `type` is `list` or `multivalue`, a value of the table can be selected through a search input instead of a option drop down menu, inside the entity create/update form |\n| includeTime | Boolean | If `type` is `datetime`, it lets you specify if the field has to include time values |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new ExtraField |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Extra Fields / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Extra Field for Resource","content":{"application/json":{"examples":{"default":{"value":{"id":50,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"fieldName":{"type":"string"},"valueListRelated":{"type":"string"},"description":{"type":"string"},"searchable":{"type":"boolean"},"visibleInList":{"type":"boolean"},"order":{"type":"integer"},"webVisibility":{"type":"boolean"},"tabId":{"type":"integer"},"multilanguage":{"type":"boolean"},"mobileVisibility":{"type":"boolean"},"mandatory":{"type":"boolean"},"readOnly":{"type":"boolean"},"descriptionEN":{"type":"string"},"descriptionIT":{"type":"string"},"descriptionFR":{"type":"string"},"descriptionDE":{"type":"string"},"descriptionPT":{"type":"string"},"descriptionUS":{"type":"string"},"descriptionRU":{"type":"string"},"descriptionBR":{"type":"string"},"descriptionDK":{"type":"string"},"branches":{"type":"array"},"defaultValue":{"type":"string"},"restApi":{"type":"boolean"},"visibleInPhoneCallForm":{"type":"boolean"},"type":{"type":"string"},"length":{"type":"integer"}}},"examples":{"default":{"value":{"fieldName":"EmployeesNumber","valueListRelated":null,"description":"Número de empleados","searchable":true,"visibleInList":true,"order":3,"webVisibility":true,"tabId":-1,"multilanguage":true,"mobileVisibility":true,"mandatory":true,"readOnly":true,"descriptionEN":"Num. Employees","descriptionIT":"No. Dipendenti","descriptionFR":"Nombre d'employés","descriptionDE":"","descriptionPT":"","descriptionUS":"","descriptionRU":"","descriptionBR":"","descriptionDK":"","branches":["17"],"defaultValue":"0","restApi":true,"visibleInPhoneCallForm":true,"type":"int","length":180}}}}}}}},"/extrafieldsTabs":{"get":{"operationId":"list-tabs","summary":"List Tabs","description":"Returns all Tabs available. Tabs are needed for grouping together Extra Fields of each entity.\n\nYou will only receive the Tabs after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Tabs available for the value list.\n\nList of the supported Tabs attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| dateCreated | String | Date and time when the Tab was created |\n| dateDeleted | String | Date and time when the Tab was deleted |\n| dateUpdated | String | Date and time when the Tab was last updated |\n| deleted | Boolean | If true, the Tab has been deleted and archived |\n| descriptionBR | String | Tab name in Brasilian Portuguese |\n| descriptionDE | String | Tab name in German |\n| descriptionDK | String | Tab name in Dutch |\n| descriptionEN | String | Tab name in English |\n| descriptionES | String | Tab name in Spanish |\n| descriptionFR | String | Tab name in French |\n| descriptionIT | String | Tab name in Italian |\n| descriptionPT | String | Tab name in Portuguese |\n| descriptionRU | String | Tab name in Russian |\n| descriptionUS | String | Tab name in American English |\n| id | Integer | Unique identifier for the Tab in ForceManager |\n| order | Integer | The order of the Tab in the entity detail view |\n| entity | String | The values can be: `account`, `contact`, `opportunity`, `activity`, `calendar`, `salesOrder` |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Tab |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Tab |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Tab |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Extra Fields / Tabs"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Tabs","content":{"application/json":{"examples":{"default":{"value":[{"dateCreated":"2022-01-27T06:32:56.127Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":null,"descriptionES":"GDPR acceptances","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":2,"order":0,"entity":"contacts","salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null},{"dateCreated":"2022-01-27T06:53:16.583Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":null,"descriptionES":"Billing address infos","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":3,"order":4,"entity":"accounts","salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-tabs","summary":"Create Tabs","description":"This endpoint allows you to create a Tab based on JSON input.\n\nYou will only be able to create a Tab after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| descriptionBR | String | Tab name in Brasilian Portuguese |\n| descriptionDE | String | Tab name in German |\n| descriptionDK | String | Tab name in Dutch |\n| descriptionEN | String | Tab name in English |\n| descriptionES (*Required*) | String | Tab name in Spanish |\n| descriptionFR | String | Tab name in French |\n| descriptionIT | String | Tab name in Italian |\n| descriptionPT | String | Tab name in Portuguese |\n| descriptionRU | String | Tab name in Russian |\n| descriptionUS | String | Tab name in American English |\n| order | Integer | The order of the Tab in the entity detail view |\n| entity (*Required*) | String | The values can be: `account`, `contact`, `opportunity`, `activity`, `calendar`, `salesOrder` |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new Tab |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Extra Fields / Tabs"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Tabs","content":{"application/json":{"examples":{"default":{"value":{"id":5,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionES":{"type":"string"},"order":{"type":"integer"},"entity":{"type":"string"}}},"examples":{"default":{"value":{"descriptionES":"Billing address infos","order":4,"entity":"accounts"}}}}}}}},"/extrafieldsTabs/{ID}":{"get":{"operationId":"get-tabs","summary":"Get Tabs","description":"This endpoint retrieves data of a specific Tab based on JSON input. The API returns a single Tab available, according to the unique ID provided. If the specified Tab does not exist, the response will be a \"bad request\".\n\nYou will only receive the Tab after first providing the Session Key. \nTo know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Tab |\n\n**RESPONSE**\n\nThis endpoint returns information about a Tabs available.\n\nList of the supported Tabs attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| dateCreated | String | Date and time when the Tab was created |\n| dateDeleted | String | Date and time when the Tab was deleted |\n| dateUpdated | String | Date and time when the Tab was last updated |\n| deleted | Boolean | If true, the Tab has been deleted and archived |\n| descriptionBR | String | Tab name in Brasilian Portuguese |\n| descriptionDE | String | Tab name in German |\n| descriptionDK | String | Tab name in Dutch |\n| descriptionEN | String | Tab name in English |\n| descriptionES | String | Tab name in Spanish |\n| descriptionFR | String | Tab name in French |\n| descriptionIT | String | Tab name in Italian |\n| descriptionPT | String | Tab name in Portuguese |\n| descriptionRU | String | Tab name in Russian |\n| descriptionUS | String | Tab name in American English |\n| id | Integer | Unique identifier for the Tab in ForceManager |\n| order | Integer | The order of the Tab in the entity detail view |\n| entity | String | The values can be: `account`, `contact`, `opportunity`, `activity`, `calendar`, `salesOrder` |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Tab |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Tab |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Tab |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Extra Fields / Tabs"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Tabs","content":{"application/json":{"examples":{"default":{"value":"{\n \"dateCreated\": \"2022-01-27T06:53:16.583Z\",\n \"dateDeleted\": null,\n \"dateUpdated\": null,\n \"deleted\": false,\n \"descriptionBR\": null,\n \"descriptionDE\": null,\n \"descriptionDK\": null,\n \"descriptionEN\": null\n \"descriptionES\": \"Billing address infos\",\n \"descriptionFR\": null,\n \"descriptionIT\": null,\n \"descriptionPT\": null,\n \"descriptionRU\": null,\n \"descriptionUS\": null,\n \"id\": 3,\n \"order\": 4,\n \"entity\": \"accounts\",\n \"salesRepIdCreated\": 90,\n \"salesRepIdDeleted\": null,\n \"salesRepIdUpdated\": null\n}"}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-tabs","summary":"Update Tabs","description":"This endpoint allows you to update a specific Tab's information. If the specified Tab does not exist, the response will be a \"bad request\".\n\nYou will only be able to update an Tabs after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows you to update the information of a specific Tab. In order to update a Tab, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| descriptionBR | String | Tab name in Brasilian Portuguese |\n| descriptionDE | String | Tab name in German |\n| descriptionDK | String | Tab name in Dutch |\n| descriptionEN | String | Tab name in English |\n| descriptionES | String | Tab name in Spanish |\n| descriptionFR | String | Tab name in French |\n| descriptionIT | String | Tab name in Italian |\n| descriptionPT | String | Tab name in Portuguese |\n| descriptionRU | String | Tab name in Russian |\n| descriptionUS | String | Tab name in American English |\n| order | Integer | The order of the Tab in the entity detail view |\n| entity | String | The values can be: `account`, `contact`, `opportunity`, `activity`, `calendar`, `salesOrder` |\n\n**RESPONSE**\n\nReturns a JSON with information about the Tab just updated.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Extra Fields / Tabs"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Tabs","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionES":{"type":"string"},"order":{"type":"integer"}}},"examples":{"default":{"value":{"descriptionES":"Billing address info","order":2}}}}}}},"delete":{"operationId":"delete-tabs","summary":"Delete Tabs","description":"This endpoint allows you to delete a specific Tab from the user's ForceManager implementation database. If the specified Tab does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete an Tab after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Accept any data of whatever mime type |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Tab to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Tab just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Extra Fields / Tabs"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Tabs","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/forms/{ID}":{"get":{"operationId":"get-form","summary":"Get Form","description":"This endpoint retrieves data of a specific Form based on JSON input. The API returns a single Form available to the user, according to the unique ID provided. If the specified Form does not exist, the response will be a \"bad request\".\n\nYou will only receive the Form after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier for the Form to retrieve data |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| dateCreated | String | Date and time when the Form was created |\n| dateDeleted | String | Date and time when the Form was deleted |\n| dateUpdated | String | Date and time when the Form was last updated |\n| deleted | Boolean | If true, the Form has been deleted and archived |\n| list | String | Form's lists specifications |\n| detail | String | Form's fields specifications |\n| jsonData | String | Form's general specifications |\n| formTemplateId | String | he ID of the Template that Form belongs to (see [Templates](#) resource) |\n| statusId | Integer | The ID of the State that Form belongs to (see [States](#) resource) |\n| id | Integer | Unique identifier for the Form in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Form |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Form |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Form |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Forms / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Form","content":{"application/json":{"examples":{"default":{"value":{"id":40,"list":"{\"pos11\":\"\",\"pos12\":\"\",\"pos13\":\"\",\"pos21\":\"\",\"pos22\":\"\",\"pos23\":\"06\\/04\\/2020 15:07 PM\"}","detail":"[{\"type\":\"title\",\"titleName\":\"Form\",\"key\":\"\",\"value\":\"\",\"entityId\":\"\",\"entityType\":\"\"},{\"type\":\"text\",\"titleName\":\"\",\"key\":\"Provider name\",\"value\":\"\",\"entityId\":\"\",\"entityType\":\"\"},{\"type\":\"text\",\"titleName\":\"\",\"key\":\"Product type\",\"value\":\"\",\"entityId\":\"\",\"entityType\":\"\"},{\"type\":\"text\",\"titleName\":\"\",\"key\":\"Quantity\",\"value\":\"\",\"entityId\":\"\",\"entityType\":\"\"},{\"type\":\"text\",\"titleName\":\"\",\"key\":\"Models\",\"value\":\"\",\"entityId\":\"\",\"entityType\":\"\"}]","jsonData":"{\"formObject\":{\"fechaCreacion\":\"06/04/2020 15:07 PM\",\"stocks\":{\"ProductType\":{\"activitytypeid\":0,\"blnHide\":null,\"blnIsCheckin\":null,\"blnIsFastCheckin\":null,\"blnIsGeneral\":null,\"blnIsPhoneCall\":null,\"blnIsVisibleInActivity\":\"True\",\"blnIsVisibleInAgenda\":\"True\",\"blnIsVisita\":null,\"blnIsWorkflow\":\"False\",\"children\":[],\"defaultStatusId\":-1,\"descripcion\":null,\"extId\":\"\",\"extraFields\":{},\"iconUrl\":null,\"id\":1,\"idCurrency\":-100,\"idParent\":0,\"isLost\":\"0\",\"isParent\":false,\"isWon\":\"0\",\"isoCode\":null,\"label\":\"AOI\",\"order\":0,\"parentEntry\":null,\"ratioStatus\":-1,\"symbol\":null,\"endState\":false,\"intEndStateType\":0,\"value\":1,\"checked\":false},\"Providers\":{\"activitytypeid\":0,\"blnHide\":null,\"blnIsCheckin\":null,\"blnIsFastCheckin\":null,\"blnIsGeneral\":null,\"blnIsPhoneCall\":null,\"blnIsVisibleInActivity\":\"True\",\"blnIsVisibleInAgenda\":\"True\",\"blnIsVisita\":null,\"blnIsWorkflow\":\"False\",\"children\":[],\"defaultStatusId\":-1,\"descripcion\":null,\"extId\":\"\",\"extraFields\":{\"z_stocked\":\"True\"},\"iconUrl\":null,\"id\":132,\"idCurrency\":-100,\"idParent\":0,\"isLost\":\"0\",\"isParent\":false,\"isWon\":\"0\",\"isoCode\":null,\"label\":\"TRI\",\"order\":0,\"parentEntry\":null,\"ratioStatus\":-1,\"symbol\":null,\"endState\":false,\"intEndStateType\":0,\"value\":132,\"checked\":false,\"z_stocked\":\"True\"},\"Models\":{\"activitytypeid\":0,\"blnHide\":null,\"blnIsCheckin\":null,\"blnIsFastCheckin\":null,\"blnIsGeneral\":null,\"blnIsPhoneCall\":null,\"blnIsVisibleInActivity\":\"True\",\"blnIsVisibleInAgenda\":\"True\",\"blnIsVisita\":null,\"blnIsWorkflow\":\"False\",\"children\":[],\"defaultStatusId\":-1,\"descripcion\":null,\"extId\":\"\",\"extraFields\":{},\"iconUrl\":null,\"id\":49,\"idCurrency\":-100,\"idParent\":0,\"isLost\":\"0\",\"isParent\":false,\"isWon\":\"0\",\"isoCode\":null,\"label\":\"ICT\",\"order\":0,\"parentEntry\":null,\"ratioStatus\":-1,\"symbol\":null,\"endState\":false,\"intEndStateType\":0,\"value\":49,\"checked\":false},\"quantity\":\"6\",\"note\":\"\"}},\"idFormType\":1,\"idState\":1,\"endState\":1,\"selectedForm\":null,\"listObject\":{\"pos11\":\"\",\"pos12\":\"\",\"pos13\":\"\",\"pos21\":\"\",\"pos22\":\"\",\"pos23\":\"06/04/2020 15:07 PM\"},\"detailObject\":{\"detailTitle\":\"Detalles\",\"detailValues\":[{\"type\":\"title\",\"titleName\":\"Form\",\"key\":\"\",\"value\":\"\",\"entityId\":\"\",\"entityType\":\"\"},{\"type\":\"text\",\"titleName\":\"\",\"key\":\"Provider name\",\"value\":\"\",\"entityId\":\"\",\"entityType\":\"\"},{\"type\":\"text\",\"titleName\":\"\",\"key\":\"Product type\",\"value\":\"\",\"entityId\":\"\",\"entityType\":\"\"},{\"type\":\"text\",\"titleName\":\"\",\"key\":\"Quantity\",\"value\":\"\",\"entityId\":\"\",\"entityType\":\"\"},{\"type\":\"text\",\"titleName\":\"\",\"key\":\"Models\",\"value\":\"\",\"entityId\":\"\",\"entityType\":\"\"}]},\"idFormSubtype\":\"stocks\"}","formTemplateId":1,"statusId":1,"salesRepIdDeleted":94,"salesRepIdCreated":94,"salesRepIdUpdated":null,"dateCreated":"2020-04-06T15:07:15.93Z","dateUpdated":null,"dateDeleted":"2020-04-06T15:34:13.4Z","deleted":true}}}}}}},"security":[{"SessionKey":[]}]}},"/forms/{ID}/state":{"get":{"operationId":"get-form-state","summary":"Get Form State","description":"This endpoint retrieves data of a specific Form State based on JSON input. The API returns a single Form State available to the user, according to the unique ID provided. If the specified Form State does not exist, the response will be a \"bad request\".\n\nYou will only receive the Form State after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier for the Form State to retrieve data |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Unique identifier for the Form State in ForceManager |\n| intOrder | Integer | \tThe order in which the State has to appear in the Form States list |\n| idParent | Integer | Unique identifier of the parent |\n| blnEndState | Boolean | Set to 1 if the Form is fullfilled 0 otherwise |\n| strIDEnvironment | String | IDs of the Branches (see [Branches](#) resource) associated to the Form State |\n| dateCreated | String | Date and time when the Form State was created |\n| dateDeleted | String | Date and time when the Form State was deleted |\n| dateUpdated | String | Date and time when the Form State was last updated |\n| deleted | Boolean | If true, the Form State has been deleted and archived |\n| description | String | Form State name |\n| descriptionBR | String | Form State name in Brasilian Portuguese |\n| descriptionDE | String | Form State name in German |\n| descriptionDK | String | Form State name in Dutch |\n| descriptionEN | String | Form State name in English |\n| descriptionES | String | Form State name in Spanish |\n| descriptionFR | String | Form State name in French |\n| descriptionIT | String | Form State name in Italian |\n| descriptionPT | String | Form State name in Portuguese |\n| descriptionRU | String | Form State name in Russian |\n| descriptionUS | String | Form State name in American English |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Form State |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Form State |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Form State |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Forms / States"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Form State","content":{"application/json":{"examples":{"default":{"value":{"id":1,"intOrder":1,"idParent":null,"blnEndState":true,"strIdEnvironment":";-1;","descriptionEN":null,"description":"Fullfilled","descriptionIT":null,"descriptionFR":null,"descriptionDE":null,"descriptionPT":null,"descriptionUS":null,"descriptionBR":null,"descriptionRU":null,"descriptionDK":null,"salesRepIdDeleted":null,"salesRepIdCreated":51,"salesRepIdUpdated":null,"dateCreated":"2020-03-26T15:16:45.32Z","dateUpdated":null,"dateDeleted":null,"deleted":false}}}}}}},"security":[{"SessionKey":[]}]}},"/forms/{ID}/template":{"get":{"operationId":"get-form-template","summary":"Get Form Template","description":"This endpoint retrieves data of a specific Form Template based on JSON input. The API returns a single Form Template available to the user, according to the unique ID provided. If the specified Form Template does not exist, the response will be a \"bad request\".\n\nYou will only receive the Form Template after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier for the Form Template to retrieve data |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | String | Globally Unique identifier for the Form Template in ForceManager |\n| type | Integer | Internal type of the Entity associated to the Form Template |\n| typeDescription | Integer | Friendly name of the Entity associated to the Form Template |\n| url | Integer | URL of the Form Template index file |\n| active | Boolean | True if the Form Template is activated, false otherwise |\n| idRole | Integer | ID of the Role (see [Roles](#) resource) associated to the Form Template |\n| extraFields | String | |\n| id | Integer | Unique identifier for the Form Template in ForceManager |\n| dateCreated | String | Date and time when the Form Template was created |\n| dateDeleted | String | Date and time when the Form Template was deleted |\n| dateUpdated | String | Date and time when the Form Template was last updated |\n| deleted | Boolean | If true, the Form Template has been deleted and archived |\n| descriptionBR | String | Form Template name in Brasilian Portuguese |\n| descriptionDE | String | Form Template name in German |\n| descriptionDK | String | Form Template name in Dutch |\n| descriptionEN | String | Form Template name in English |\n| descriptionES | String | Form Template name in Spanish |\n| descriptionFR | String | Form Template name in French |\n| descriptionIT | String | Form Template name in Italian |\n| descriptionPT | String | Form Template name in Portuguese |\n| descriptionRU | String | Form Template name in Russian |\n| descriptionUS | String | Form Template name in American English |\n| id | Integer | Unique identifier for the Form Template in ForceManager |\n| userCreated | Integer | Unique identifier of the user who created the Form Template |\n| userDeleted | Integer | Unique identifier of the user who deleted the Form Template |\n| userUpdated | Integer | Unique identifier of the user who last updated the Form Template |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Forms / Templates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Form Template","content":{"application/json":{"examples":{"default":{"value":{"id":1,"guid":"5EB67696-A67B-4797-AB53-ACEC98667945","type":2,"typeDescription":"Empresa","url":"https://e2fi43u98l79ij.cloudfront.net/code/5EB67696-A67B-4797-AB53-ACEC98667945/index.html","active":true,"idRole":null,"extraFields":null,"deleted":false,"userDeleted":null,"userCreated":51,"userUpdated":51,"dateCreated":"2020-03-26T11:28:22.067Z","dateUpdated":"2021-09-15T13:29:31.03Z","dateDeleted":null,"descriptionEN":null,"description":"Providers","descriptionIT":null,"descriptionFR":null,"descriptionDE":null,"descriptionPT":null,"descriptionUS":null,"descriptionBR":null,"descriptionRU":null,"descriptionDK":null}}}}}}},"security":[{"SessionKey":[]}]}},"/news":{"get":{"operationId":"list-news","summary":"List News","description":"Returns all News available. News are basically messages that you can sent to the whole organization, to your team or to an User. These messages can be tracked in terms of the number of Users that had received, open or read it.\n\nYou will only receive the News after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all News available for the value list.\n\nList of the supported News attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| dateCreated | String | Date and time when the News was created |\n| dateDeleted | String | Date and time when the News was deleted |\n| dateUpdated | String | Date and time when the News was last updated |\n| deleted | Boolean | If true, the News has been deleted and archived |\n| descriptionText | String | The content of the News to be communicated |\n| id | Integer | Unique identifier for the News in ForceManager |\n| idIanaZone | String | Identifier of the News in the IANA database |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the News |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the News |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the News |\n| startDate | Date | When the News is sent |\n| endDate | Date | When the News is going to expire |\n| status | Integer | The status of the News (`1` for `Confirmed`,`2` for `Opened`,`3` for `Received`,`4` for `Sent`) |\n| subject | String | The title of the News |\n| totalUsers | Integer | The number of Users to whom the News is addressed |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["News"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List News","content":{"application/json":{"examples":{"default":{"value":[{"dateCreated":"2022-02-08T14:16:36.103Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionText":"

Dear team, see here enclosed the updated portfolio for this year


I invite you to take a look and work for making this year another successful one!

","endDate":"1900-01-01T00:00:00Z","id":1,"salesRepIDeleted":null,"salesRepIdCreated":120,"salesRepIdUpdated":null,"startDate":"2022-02-08T14:16:36Z","status":2,"subject":"New product portofolio for season 2022","totalUsers":3},{"dateCreated":"2022-02-08T14:17:07.973Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionText":"

Hi all, we are glad to announce that we have started a new marketing campaing in the US.


Expect to receive new leads in the following weeks!

","endDate":"1900-01-01T00:00:00Z","id":2,"salesRepIDeleted":null,"salesRepIdCreated":120,"salesRepIdUpdated":null,"startDate":"2022-02-08T14:17:08Z","status":1,"subject":"Important message","totalUsers":30}]}}}}}},"security":[{"SessionKey":[]}]}},"/opportunities/schema":{"get":{"operationId":"opportunities-schema","summary":"Opportunities schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The Schema defines all the fields that exist for an Opportunity object.\n\nYou will only receive the Opportunity Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Opportunities Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Table | String | The name of the values list table |\n| Type | Object, Null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Opportunities schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"accountId1":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"accountId2":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"accountId3":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"address1":{"description":"","maxLength":180,"readOnly":false,"type":["string","null"]},"address2":{"description":"","maxLength":180,"readOnly":false,"type":["string","null"]},"branchId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"branches","type":["object","null"]},"city":{"description":"","maxLength":200,"readOnly":false,"type":["string","null"]},"closedDate":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"comments":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"countryId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"countries","type":["object","null"]},"currencyId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"currencies","type":["object","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateGeocoded":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"extId":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"geocoded":{"description":"","readOnly":false,"type":["boolean","null"]},"geocodingAccuracy":{"description":"","readOnly":false,"type":["integer","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"latitude":{"description":"","readOnly":false,"type":["number","null"]},"longitude":{"description":"","readOnly":false,"type":["number","null"]},"lostDate":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"permissionLevel":{"description":"","readOnly":false,"type":["integer","null"]},"postcode":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"readOnly":{"description":"","readOnly":false,"type":["boolean","null"]},"reference":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"region":{"description":"","maxLength":200,"readOnly":false,"type":["string","null"]},"salesForecastDate":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"salesProbability":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"statusId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"opportunityStatuses","type":["object","null"]},"total":{"description":"","readOnly":false,"type":["number","null"]},"type_id":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"opportunityTypes","type":["object","null"]},"wonDate":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]}},"required":["branchId","salesProbability","salesRepId","statusId","reference"],"title":"opportunities","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/opportunities":{"get":{"operationId":"list-opportunities","summary":"List Opportunities","description":"Returns all Opportunities available in the user's ForceManager implementation database.\n\nYou will only receive the List of Opportunities after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/opportunities?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/opportunities?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Opportunities by `dateCreated` or `statusId`, or `typeId` for example.\n\nYou can also **organise and view** the results for Opportunities in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/opportunities?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/opportunities?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Opportunities available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Opportunities attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId1 | Object, Null | First Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| accountId2 | Object, Null | Second Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| accountId3 | Object, Null | Third Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| address1 | String | First address to whom the Opportunity is linked |\n| address2 | String | Second address to whom the Opportunity is linked |\n| branchId | Object, Null | Branch to whom the Opportunity has been assigned (see [Branches](#) resource) |\n| city | String | City name |\n| closedDate | String | Date when the Opportunity was closed |\n| comments | String | Comment added to the Opportunity |\n| countryId | Object, Null | Country ID (see [Countries](#) resource) of the Opportunity address |\n| currencyId | Object, Null | Currency ID (see [Currencies](#) resource) related to the Opportunity amount |\n| dateCreated | String | Date and time when the Opportunity was created |\n| dateDeleted | String | Date and time when the Opportunity was deleted |\n| dateUpdated | String | Date and time when the Opportunity was last updated |\n| deleted | Boolean | If true, the Opportunity has been deleted and archived |\n| extId | String | External ID of the Opportunity from a third party system (ERP, CRM, Accounting System) |\n| geocoded | Boolean | If true, the Opportunity has been geolocated |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile client can detect |\n| id | Integer | Unique identifier for the Opportunity in ForceManager |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| lostDate | String | Date when the Opportunity was lost |\n| permissionLevel | String | Defines the visibility of the Opportunity. Set from 1 to 5 being 5 the highest level of permission |\n| postcode | String | The Opportunity's address postal code |\n| readOnly | Boolean | If true, the Opportunity can not be modified or deleted |\n| reference | String | Opportunity's name |\n| region | String | Region/State name |\n| salesForeCastDate | String | Forecast sale date |\n| salesProbability | Object, Null | Probability of sale |\n| salesRepId | Object, Null | Unique identifier of the User associated to the Opportunity (see [Users](#) resource) |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Opportunity |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Opportunity |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Opportunity |\n| type_id | Object, Null | Type of the Opportunity (see [Types](#) resource) |\n| statusId | Object, Null | Status of the Opportunity (see [Statues](#) resource) |\n| total | Number | Total amount of the Opportunity |\n| wonDate | String | Date when the Opportunity was won |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Opportunities","content":{"application/json":{"examples":{"default":{"value":[{"accountId1":{"id":150,"value":"Acme Inc."},"accountId2":null,"accountId3":null,"address1":null,"address2":null,"branchId":{"id":16,"value":"Subsidiary"},"city":null,"closedDate":"2017-05-11T13:51:08Z","comments":null,"countryId":{"id":112,"value":"Italy"},"currencyId":{"id":1,"value":"euro"},"dateCreated":"2021-11-19T15:39:51.19Z","dateDeleted":null,"dateGeocoded":null,"dateUpdated":"2021-11-30T13:08:43.997Z","deleted":false,"extId":"536537-D","geocoded":false,"geocodingAccuracy":null,"id":111,"latitude":null,"longitude":null,"lostDate":null,"permissionLevel":0,"postcode":null,"readOnly":false,"reference":"Closed opportunity","region":null,"salesForecastDate":"2017-05-31T12:59:59Z","salesProbability":10,"salesRepId":{"id":120,"value":"Filippo Zanella"},"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":90,"statusId":{"id":434,"value":"Won"},"total":5000,"type_id":{"id":61,"value":"Sales Pipeline"},"wonDate":null},{"accountId1":{"id":150,"value":"Acme Inc."},"accountId2":null,"accountId3":null,"address1":null,"address2":null,"branchId":{"id":16,"value":"Subsidiary"},"city":null,"closedDate":"2017-05-30T19:13:08Z","comments":null,"countryId":{"id":112,"value":"Italy"},"currencyId":{"id":1,"value":"euro"},"dateCreated":"2021-11-19T15:40:24.22Z","dateDeleted":null,"dateGeocoded":null,"dateUpdated":"2021-11-30T13:09:20.917Z","deleted":false,"extId":"536536-D","geocoded":false,"geocodingAccuracy":null,"id":121,"latitude":null,"longitude":null,"lostDate":null,"permissionLevel":0,"postcode":null,"readOnly":false,"reference":"Your first opportunity","region":null,"salesForecastDate":"2017-05-31T12:59:59Z","salesProbability":10,"salesRepId":{"id":120,"value":"Filippo Zanella"},"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":90,"statusId":{"id":434,"value":"Won"},"total":4000,"type_id":{"id":61,"value":"Sales Pipeline"},"wonDate":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-opportunity","summary":"Create Opportunity","description":"This endpoint allows you to create a Opportunity based on JSON input.\n\nYou will only be able to create a Opportunity after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId1 | Integer | First Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| accountId2 | Integer | Second Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| accountId3 | Integer | Third Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| address1 | String | First address to whom the Opportunity is linked |\n| address2 | String | Second address to whom the Opportunity is linked |\n| branchId (_Required_) | Integer | Branch to whom the Opportunity has been assigned (see [Branches](#) resource) |\n| city | String | City name |\n| closedDate | String | Date when the Opportunity was closed |\n| comments | String | Comment added to the Opportunity |\n| countryId | Integer | Country ID (see [Countries](#) resource) of the Opportunity address |\n| currencyId | Integer | Currency ID (see [Currencies](#) resource) related to the Opportunity amount |\n| extId | String | External ID of the Opportunity from a third party system (ERP, CRM, Accounting System) |\n| geocoded | Boolean | If true, the Opportunity has been geolocated |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile client can detect |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| lostDate | String | Date when the Opportunity was lost |\n| permissionLevel | String | Defines the visibility of the Opportunity. Set from 1 to 5 being 5 the highest level of permission |\n| postcode | String | The Opportunity's address postal code |\n| readOnly | Boolean | If true, the Opportunity can not be modified or deleted |\n| reference (_Required_) | String | Opportunity's name |\n| region | String | Region/State name |\n| salesForeCastDate | String | Forecast sale date |\n| salesProbability (_Required_) | Integer | Probability of sale, it is a number between 0 and 10 |\n| salesRepId (_Required_) | Integer | Unique identifier of the User associated to the Opportunity (see [Users](#) resource) |\n| type_id | Integer | Type of the Opportunity (see [Types](#) resource) |\n| statusId (_Required_) | Integer | Status of the Opportunity (see [Statues](#) resource) |\n| total | Number | Total amount of the Opportunity |\n| wonDate | String | Date when the Opportunity was won |\n\n**RESPONSE**\n\nReturns a JSON with information about the Opportunity just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Opportunity |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Opportunity","content":{"application/json":{"examples":{"default":{"value":{"id":127,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountId1":{"type":"integer"},"address1":{"type":"string"},"branchId":{"type":"integer"},"city":{"type":"string"},"comments":{"type":"string"},"currencyId":{"type":"integer"},"geocoded":{"type":"boolean"},"geocodingAccuracy":{"type":"integer"},"latitude":{"type":"number"},"longitude":{"type":"number"},"lostDate":{"type":"string"},"permissionLevel":{"type":"integer"},"postcode":{"type":"string"},"readOnly":{"type":"boolean"},"reference":{"type":"string"},"salesProbability":{"type":"integer"},"salesRepId":{"type":"integer"},"statusId":{"type":"integer"},"total":{"type":"integer"}}},"examples":{"default":{"value":{"accountId1":1757,"address1":"Street Anthon, 125","branchId":43,"city":"London","comments":"It is an important opportunity","currencyId":1,"geocoded":true,"geocodingAccuracy":20,"latitude":41.3916328,"longitude":2.1293214,"lostDate":null,"permissionLevel":0,"postcode":"08950","readOnly":false,"reference":"10x packages","salesProbability":10,"salesRepId":554,"statusId":7,"total":34560}}}}}}}},"/opportunities/{ID}":{"get":{"operationId":"get-opportunity","summary":"Get Opportunity","description":"This endpoint retrieves data of a specific Opportunity based on JSON input. The API returns a single Opportunity available to the user, according to the unique ID provided. If the specified Opportunity does not exist, the response will be a \"bad request\".\n\nYou will only receive the Opportunity after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Opportunity |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId1 | Object, Null | First Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| accountId2 | Object, Null | Second Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| accountId3 | Object, Null | Third Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| address1 | String | First address to whom the Opportunity is linked |\n| address2 | String | Second address to whom the Opportunity is linked |\n| branchId | Object, Null | Branch to whom the Opportunity has been assigned (see [Branches](#) resource) |\n| city | String | City name |\n| closedDate | String | Date when the Opportunity was closed |\n| comments | String | Comment added to the Opportunity |\n| countryId | Object, Null | Country ID (see [Countries](#) resource) of the Opportunity address |\n| currencyId | Object, Null | Currency ID (see [Currencies](#) resource) related to the Opportunity amount |\n| dateCreated | String | Date and time when the Opportunity was created |\n| dateDeleted | String | Date and time when the Opportunity was deleted |\n| dateUpdated | String | Date and time when the Opportunity was last updated |\n| deleted | Boolean | If true, the Opportunity has been deleted and archived |\n| extId | String | External ID of the Opportunity from a third party system (ERP, CRM, Accounting System) |\n| geocoded | Boolean | If true, the Opportunity has been geolocated |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile client can detect |\n| id | Integer | Unique identifier for the Opportunity in ForceManager |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| lostDate | String | Date when the Opportunity was lost |\n| permissionLevel | String | Defines the visibility of the Opportunity. Set from 1 to 5 being 5 the highest level of permission |\n| postcode | String | The Opportunity's address postal code |\n| readOnly | Boolean | If true, the Opportunity can not be modified or deleted |\n| reference | String | Opportunity's name |\n| region | String | Region/State name |\n| salesForeCastDate | String | Forecast sale date |\n| salesProbability | Object, Null | Probability of sale |\n| salesRepId | Object, Null | Unique identifier of the User associated to the Opportunity (see [Users](#) resource) |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Opportunity |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Opportunity |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Opportunity |\n| type_id | Object, Null | Type of the Opportunity (see [Types](#) resource) |\n| statusId | Object, Null | Status of the Opportunity (see [Statues](#) resource) |\n| total | Number | Total amount of the Opportunity |\n| wonDate | String | Date when the Opportunity was won |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [optional]"}],"responses":{"200":{"description":"Get Opportunity","content":{"application/json":{"examples":{"default":{"value":{"accountId1":{"id":1757,"value":"Universal ltd"},"accountId2":null,"accountId3":null,"address1":"Street Anthon, 125","address2":null,"branchId":{"id":43,"value":"Main unit"},"city":"London","closedDate":null,"comments":"It is an important opportunity","countryId":null,"currencyId":{"id":1,"value":"euro"},"dateCreated":"2021-12-16T21:44:46.333Z","dateDeleted":null,"dateGeocoded":null,"dateUpdated":null,"deleted":false,"extId":null,"geocoded":true,"geocodingAccuracy":20,"id":127,"latitude":41.3916328,"longitude":2.1293214,"lostDate":null,"permissionLevel":0,"postcode":"08950","readOnly":false,"reference":"10x packages","region":null,"salesForecastDate":null,"salesProbability":10,"salesRepId":{"id":558,"value":"Tadala Asnappar"},"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"statusId":{"id":7,"value":"In progress"},"total":34560,"type_id":null,"wonDate":null}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-opportunity","summary":"Update Opportunity","description":"This endpoint allows you to update a specific Opportunity. If the specified Opportunity does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Opportunity after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Opportunity. In order to update an Opportunity, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountId1 | Integer | First Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| accountId2 | Integer | Second Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| accountId3 | Integer | Third Account to whom the Opportunity is linked to (see [Accounts](#) resource) |\n| address1 | String | First address to whom the Opportunity is linked |\n| address2 | String | Second address to whom the Opportunity is linked |\n| branchId | Integer | Branch to whom the Opportunity has been assigned (see [Branches](#) resource) |\n| city | String | City name |\n| closedDate | String | Date when the Opportunity was closed |\n| comments | String | Comment added to the Opportunity |\n| countryId | Integer | Country ID (see [Countries](#) resource) of the Opportunity address |\n| currencyId | Integer | Currency ID (see [Currencies](#) resource) related to the Opportunity amount |\n| extId | String | External ID of the Opportunity from a third party system (ERP, CRM, Accounting System) |\n| geocoded | Boolean | If true, the Opportunity has been geolocated |\n| geocodingAccuracy | Integer | Accuracy radius based on information about cell towers and WiFi nodes that the mobile client can detect |\n| latitude | Number | Geocode address for the latitude coordinates |\n| longitude | Number | Geocode address for the longitude coordinates |\n| lostDate | String | Date when the Opportunity was lost |\n| permissionLevel | String | Defines the visibility of the Opportunity. Set from 1 to 5 being 5 the highest level of permission |\n| postcode | String | The Opportunity's address postal code |\n| readOnly | Boolean | If true, the Opportunity can not be modified or deleted |\n| reference | String | Opportunity's name |\n| region | String | Region/State name |\n| salesForeCastDate | String | Forecast sale date |\n| salesProbability (_Required_) | Integer | Probability of sale, it is a number between 0 and 10 |\n| salesRepId | Integer | Unique identifier of the User associated to the Opportunity (see [Users](#) resource) |\n| type_id | Integer | Type of the Opportunity (see [Types](#) resource) |\n| statusId | Integer | Status of the Opportunity (see [Statues](#) resource) |\n| total | Number | Total amount of the Opportunity |\n| wonDate | String | Date when the Opportunity was won |\n\n**RESPONSE**\n\nReturns a JSON with information about the Opportunity just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Opportunity","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"salesProbability":{"type":"integer"},"total":{"type":"number"},"comments":{"type":"string"}}},"examples":{"default":{"value":{"salesProbability":60,"total":54780.5,"comments":"Fairy deal - 7"}}}}}}},"delete":{"operationId":"delete-opportunity","summary":"Delete Opportunity","description":"This endpoint allows you to delete a specific Opportunity from the user's ForceManager implementation database. If the specified Opportunity does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Opportunities after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Opportunity to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Opportunity just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Opportunity","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/opportunityTypes/schema":{"get":{"operationId":"opportunity-types-schema","summary":"Opportunity Types schema","description":"Returns properties object with the definition of each field in the Opportunity Types table.\n\nYou will only receive the Opportunity Types Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Opportunity Types Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Opportunity Types schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"defaultStatus":{"description":"","readOnly":false,"type":["integer","null"]},"deleted":{"description":"","readOnly":false,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":4000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":4000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":4000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":false,"type":["integer","null"]},"order":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":false,"type":["integer","null"]}},"required":[],"title":"opportunityTypes","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/opportunityTypes/{ID}":{"get":{"operationId":"get-opportunity-types","summary":"Get Opportunity Types","description":"This endpoint retrieves data of a specific Opportunity Type based on JSON input. The API returns a single Opportunity Type available to the user in the Value List, according to the unique ID provided. If the specified Opportunity Type does not exist, the response will be a \"bad request\".\n\nYou will only receive the Opportunity Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Opportunity Type |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Opportunity Type is visible |\n| defaultStatus | Boolean | The ID of the Opportunity Status selected by default for a chosen Opportunity Type, in the multiple pipeline context |\n| dateCreated | String | Date and time when the Opportunity Type was created |\n| dateDeleted | String | Date and time when the Opportunity Type was deleted |\n| dateUpdated | String | Date and time when the Opportunity Type was last updated |\n| deleted | Boolean | If true, the Opportunity Type has been deleted and archived |\n| descriptionBR | String | Opportunity Type label in Brasilian Portuguese |\n| descriptionDE | String | Opportunity Type label in German |\n| descriptionDK | String | Opportunity Type label in Dutch |\n| descriptionEN | String | Opportunity Type label in English |\n| descriptionES | String | Opportunity Type label in Spanish |\n| descriptionFR | String | Opportunity Type label in French |\n| descriptionIT | String | Opportunity Type label in Italian |\n| descriptionPT | String | Opportunity Type label in Portuguese |\n| descriptionRU | String | Opportunity Type label in Russian |\n| descriptionUS | String | Opportunity Type label in American English |\n| id | Integer | Unique identifier for the Opportunity Type in ForceManager |\n| order | Integer | The position of the Opportunity Type in the Opportunity Types value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Opportunity Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Opportunity Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Opportunity Type |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Opportunity Types","content":{"application/json":{"examples":{"default":{"value":{"branchVisibility":[{"id":16,"value":"Sales dept."}],"dateCreated":"2021-12-16T11:12:21.667Z","dateDeleted":null,"dateUpdated":null,"defaultStatus":1,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Food and Beverage","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":69,"order":4,"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":null}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-opportunity-type","summary":"Update Opportunity Type","description":"This endpoint allows you to update a specific Opportunity Status. If the specified Opportunity Status does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Opportunity Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Opportunity Status. In order to update an Opportunity Status, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Opportunity Type is visible |\n| defaultStatus | Boolean | The ID of the Opportunity Status selected by default for a chosen Opportunity Type, in the multiple pipeline context |\n| descriptionBR | String | Opportunity Type label in Brasilian Portuguese |\n| descriptionDE | String | Opportunity Type label in German |\n| descriptionDK | String | Opportunity Type label in Dutch |\n| descriptionEN | String | Opportunity Type label in English |\n| descriptionES | String | Opportunity Type label in Spanish |\n| descriptionFR | String | Opportunity Type label in French |\n| descriptionIT | String | Opportunity Type label in Italian |\n| descriptionPT | String | Opportunity Type label in Portuguese |\n| descriptionRU | String | Opportunity Type label in Russian |\n| descriptionUS | String | Opportunity Type label in American English |\n| order | Integer | The position of the Opportunity Type in the Opportunity Types value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Opportunity Status just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Opportunity Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionES":{"type":"string"}}},"examples":{"default":{"value":{"descriptionES":"Alimentos y Bebidas"}}}}}}},"delete":{"operationId":"delete-opportunity-type","summary":"Delete Opportunity Type","description":"This endpoint allows you to delete a specific Opportunity Type from the user's ForceManager implementation database. If the specified Opportunity Type does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Opportunity Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Opportunity Type to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Opportunity Type just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Opportunity Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/opportunityStatuses/schema":{"get":{"operationId":"opportunity-statuses-schema","summary":"Opportunity Statuses schema","description":"Returns properties object with the definition of each field in the Opportunity Status table.\n\nYou will only receive the Opportunity Status Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Opportunity Status Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Opportunity Statuses schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"endStatus":{"description":"","readOnly":false,"type":["boolean","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"idParent":{"description":"","readOnly":false,"type":["integer","null"]},"order":{"description":"","readOnly":false,"type":["integer","null"]},"salesProbability":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"won":{"description":"","readOnly":false,"type":["integer","null"]}},"required":[],"title":"opportunityStatuses","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/opportunityStatuses":{"get":{"operationId":"list-opportunity-statuses","summary":"List Opportunity Statuses","description":"Returns all Opportunity Statuses available in the user's ForceManager implementation database.\n\nYou will only receive the List of Opportunity Statuses after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**RESPONSE**\n\nThis endpoint returns information about all Opportunity Statuses available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Opportunity Statuses attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Opportunity Status is visible |\n| endStatus | Integer | Set to 1 if the Opportunity is closed 0 otherwise |\n| won | Boolean | If true, the close opportunity has been won |\n| idParent | Integer | This is mostly used to stick an Opportunity Status with an Opportunity Type (see [Types](#) resource), in the case the Opportunity Types are used to represent multiple pipelines |\n| dateCreated | String | Date and time when the Opportunity Status was created |\n| dateDeleted | String | Date and time when the Opportunity Status was deleted |\n| dateUpdated | String | Date and time when the Opportunity Status was last updated |\n| deleted | Boolean | If true, the Opportunity Status has been deleted and archived |\n| descriptionDE | String | Opportunity Status label in German |\n| descriptionDK | String | Opportunity Status label in Dutch |\n| descriptionEN (_Required_) | String | Opportunity Status label in English |\n| descriptionES | String | Opportunity Status label in Spanish |\n| descriptionFR | String | Opportunity Status label in French |\n| descriptionIT | String | Opportunity Status label in Italian |\n| descriptionPT | String | Opportunity Status label in Portuguese |\n| descriptionRU | String | Opportunity Status label in Russian |\n| descriptionUS | String | Opportunity Status label in American English |\n| id | Integer | Unique identifier for the Opportunity Status in ForceManager |\n| order | Integer | The position of the Opportunity Status in the Opportunity Statuses value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Opportunity Status |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Opportunity Status |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Opportunity Status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Opportunity Statuses","content":{"application/json":{"examples":{"default":{"value":[{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.803Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.803Z","deleted":false,"descriptionBR":null,"descriptionDE":"1. In Arbeit","descriptionDK":null,"descriptionEN":"1. In Progress","descriptionES":"1. En tramites","descriptionFR":"1. En cours de démarche","descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"endStatus":false,"id":1,"idParent":null,"order":0,"salesProbability":null,"salesRepIdCreated":1,"salesRepIdDeleted":90,"salesRepIdUpdated":1,"won":0},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.803Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.803Z","deleted":false,"descriptionBR":null,"descriptionDE":"6. Verkauft","descriptionDK":null,"descriptionEN":"6. Sold","descriptionES":"6. Vendido","descriptionFR":"6. Vendu","descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"endStatus":true,"id":8,"idParent":null,"order":0,"salesProbability":null,"salesRepIdCreated":1,"salesRepIdDeleted":90,"salesRepIdUpdated":1,"won":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.803Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.803Z","deleted":false,"descriptionBR":null,"descriptionDE":"7. Verloren","descriptionDK":null,"descriptionEN":"7. Lost","descriptionES":"7. Perdido","descriptionFR":"7. Perdu","descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"endStatus":true,"id":9,"idParent":null,"order":0,"salesProbability":null,"salesRepIdCreated":1,"salesRepIdDeleted":90,"salesRepIdUpdated":1,"won":0},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.803Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.803Z","deleted":false,"descriptionBR":null,"descriptionDE":"2. Genehmigung anhängig","descriptionDK":null,"descriptionEN":"2. Pending Approval","descriptionES":"2. Pendiente de aprobación","descriptionFR":"2. En attente d´approbation","descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"endStatus":false,"id":10,"idParent":null,"order":0,"salesProbability":null,"salesRepIdCreated":1,"salesRepIdDeleted":90,"salesRepIdUpdated":1,"won":0},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.803Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.803Z","deleted":false,"descriptionBR":null,"descriptionDE":"0. Stand-by","descriptionDK":null,"descriptionEN":"0. Stand By","descriptionES":"0. Parada","descriptionFR":"0. Stand-By","descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"endStatus":false,"id":12,"idParent":null,"order":0,"salesProbability":null,"salesRepIdCreated":1,"salesRepIdDeleted":90,"salesRepIdUpdated":1,"won":0}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-opportunity-status","summary":"Create Opportunity Status","description":"This endpoint allows you to create a Opportunity Status based on JSON input.\n\nYou will only be able to create a Opportunity Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Opportunity Status is visible |\n| endStatus | Integer | Set to 1 if the Opportunity is closed 0 otherwise |\n| won | Boolean | If true, the close opportunity has been won |\n| idParent | Integer | This is mostly used to stick an Opportunity Status with an Opportunity Type (see [Types](#) resource), in the case the Opportunity Types are used to represent multiple pipelines |\n| descriptionDE | String | Opportunity Status label in German |\n| descriptionDK | String | Opportunity Status label in Dutch |\n| descriptionEN (*Required*) | String | Opportunity Status label in English |\n| descriptionES | String | Opportunity Status label in Spanish |\n| descriptionFR | String | Opportunity Status label in French |\n| descriptionIT | String | Opportunity Status label in Italian |\n| descriptionPT | String | Opportunity Status label in Portuguese |\n| descriptionRU | String | Opportunity Status label in Russian |\n| descriptionUS | String | Opportunity Status label in American English |\n| order | Integer | The position of the Opportunity Status in the Opportunity Statuses value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Opportunity Status just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Opportunity Status |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Opportunity Status","content":{"application/json":{"examples":{"default":{"value":{"id":478,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionBR":{"type":"string"},"descriptionDE":{"type":"string"},"descriptionDK":{"type":"string"},"descriptionEN":{"type":"string"},"descriptionES":{"type":"string"},"descriptionFR":{"type":"string"},"descriptionIT":{"type":"string"},"descriptionPT":{"type":"string"},"descriptionRU":{"type":"string"},"descriptionUS":{"type":"string"},"endStatus":{"type":"boolean"},"order":{"type":"integer"},"won":{"type":"integer"},"idParent":{"type":"integer"}}},"examples":{"default":{"value":{"descriptionBR":null,"descriptionDE":"","descriptionDK":null,"descriptionEN":"Last visit","descriptionES":"Última visita","descriptionFR":"","descriptionIT":"Ultima visita","descriptionPT":"","descriptionRU":null,"descriptionUS":"","endStatus":true,"order":5,"won":1,"idParent":1}}}}}}}},"/opportunityStatuses/{ID}":{"get":{"operationId":"get-opportunity-status","summary":"Get Opportunity Status","description":"This endpoint retrieves data of a specific Opportunity Status based on JSON input. The API returns a single Opportunity Status available to the user in the Value List, according to the unique ID provided. If the specified Opportunity Status does not exist, the response will be a \"bad request\".\n\nYou will only receive the Opportunity Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Opportunity Status |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Opportunity Status is visible |\n| endStatus | Integer | Set to 1 if the Opportunity is closed 0 otherwise |\n| won | Boolean | If true, the close opportunity has been won |\n| idParent| Integer | This is mostly used to stick an Opportunity Status with an Opportunity Type (see [Types](#) resource), in the case the Opportunity Types are used to represent multiple pipelines |\n| dateCreated | String | Date and time when the Opportunity Status was created |\n| dateDeleted | String | Date and time when the Opportunity Status was deleted |\n| dateUpdated | String | Date and time when the Opportunity Status was last updated |\n| deleted | Boolean | If true, the Opportunity Status has been deleted and archived |\n| descriptionDE | String | Opportunity Status label in German |\n| descriptionDK | String | Opportunity Status label in Dutch |\n| descriptionEN (*Required*) | String | Opportunity Status label in English |\n| descriptionES | String | Opportunity Status label in Spanish |\n| descriptionFR | String | Opportunity Status label in French |\n| descriptionIT | String | Opportunity Status label in Italian |\n| descriptionPT | String | Opportunity Status label in Portuguese |\n| descriptionRU | String | Opportunity Status label in Russian |\n| descriptionUS | String | Opportunity Status label in American English |\n| id | Integer | Unique identifier for the Opportunity Status in ForceManager |\n| order | Integer | The position of the Opportunity Status in the Opportunity Statuses value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Opportunity Status |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Opportunity Status |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Opportunity Status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Opportunity Status","content":{"application/json":{"examples":{"default":{"value":{"branchVisibility":null,"dateCreated":"2021-12-16T10:27:51.753Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"","descriptionDK":null,"descriptionEN":"First visit","descriptionES":"Primera visita","descriptionFR":"","descriptionIT":"Prima visita","descriptionPT":"","descriptionRU":null,"descriptionUS":"","endStatus":true,"id":478,"idParent":1,"order":5,"salesProbability":null,"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":1}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-opportunity-status","summary":"Update Opportunity Status","description":"This endpoint allows you to update a specific Opportunity Status. If the specified Opportunity Status does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Opportunity Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Opportunity Status. In order to update an Opportunity Status, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Array | In which Branch the Opportunity Status is visible |\n| endStatus | Integer | Set to 1 if the Opportunity is closed 0 otherwise |\n| won | Boolean | If true, the close opportunity has been won |\n| idParent | Integer | This is mostly used to stick an Opportunity Status with an Opportunity Type (see [Types](#) resource), in the case the Opportunity Types are used to represent multiple pipelines |\n| descriptionDE | String | Opportunity Status label in German |\n| descriptionDK | String | Opportunity Status label in Dutch |\n| descriptionEN | String | Opportunity Status label in English |\n| descriptionES | String | Opportunity Status label in Spanish |\n| descriptionFR | String | Opportunity Status label in French |\n| descriptionIT | String | Opportunity Status label in Italian |\n| descriptionPT | String | Opportunity Status label in Portuguese |\n| descriptionRU | String | Opportunity Status label in Russian |\n| descriptionUS | String | Opportunity Status label in American English |\n| order | Integer | The position of the Opportunity Status in the Opportunity Statuses value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Opportunity Status just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Opportunity Status","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"branchVisibility":{"type":"array"},"descriptionEN":{"type":"string"},"descriptionES":{"type":"string"},"descriptionFR":{"type":"string"},"descriptionIT":{"type":"string"},"endStatus":{"type":"boolean"},"won":{"type":"integer"}}},"examples":{"default":{"value":{"branchVisibility":[20],"descriptionEN":"2. First visit","descriptionES":"2. Primera visita","descriptionFR":"","descriptionIT":"2. Prima visita","endStatus":false,"won":0}}}}}}},"delete":{"operationId":"delete-opportunity-status","summary":"Delete Opportunity Status","description":"This endpoint allows you to delete a specific Opportunity Status from the user's ForceManager implementation database. If the specified Opportunity Status does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Opportunity Statuses after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Opportunity Status to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Opportunity Status just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Opportunities / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Opportunity Status","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/salesorders/schema":{"get":{"operationId":"order-headers-schema","summary":"Order Headers schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource.\n\nThe Schema defines all the fields that exist for an Order Header object.\n\nYou will only receive the Order Headers Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**RESPONSE**\n\nThe Order Headers Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n\nFields like \"Value list\" have extra information:\n\n| Attribute | Data Type | Description |\n|--|--|--|\n| Table | String | The name of the values list table |\n| Type | Object, Null | The kind of data you will receive in the response |\n\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Order Headers schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"accountAddressId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accountAddresses","type":["object","null"]},"accountId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"archived":{"description":"","readOnly":false,"type":["boolean","null"]},"blocked":{"description":"","readOnly":false,"type":["boolean","null"]},"branchId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"branches","type":["object","null"]},"closedDate":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"comment":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"contactId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"contacts","type":["object","null"]},"currencyId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"currencies","type":["object","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"discount1":{"description":"","readOnly":false,"type":["number","null"]},"discount2":{"description":"","readOnly":false,"type":["number","null"]},"discount3":{"description":"","readOnly":false,"type":["number","null"]},"discount4":{"description":"","readOnly":false,"type":["number","null"]},"extId":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"internalComment":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"internalCommentUpdateDate":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"internalCommentUpdateSalesRepId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"mainSalesorder":{"description":"","readOnly":false,"type":["boolean","null"]},"number":{"description":"","readOnly":false,"type":["integer","null"]},"opportunityId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"opportunities","type":["object","null"]},"rateId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"rates","type":["object","null"]},"readOnly":{"description":"","readOnly":false,"type":["boolean","null"]},"reference":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"salesForcecastDate":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"salesRepId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"statusId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"salesorderStatuses","type":["object","null"]},"total":{"description":"","readOnly":false,"type":["number","null"]},"year":{"description":"","readOnly":false,"type":["integer","null"]}},"required":["statusId"],"title":"salesorders","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/salesorders":{"get":{"operationId":"list-order-headers","summary":"List Order Headers","description":"Returns all Order Headers available in the user's ForceManager implementation database.\n\nYou will only receive the List of Order Headers after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/salesorders?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/salesorders?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Order Headers by `dateCreated` or `accountId`, or `salesRepId` for example.\n\nYou can also **organise and view** the results for Order Headers in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/salesorders?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/salesorders?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Order Headers available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Order Headers attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountAddressId | Object, Null | Account's address to which the Order is linked to (see [Address](#) resource) |\n| accountId | Object, Null | Account to which the Order Header is linked to (see [Accounts](#) resource) |\n| archived | Boolean | If true, the Order has been archived |\n| blocked | Boolean | If true, the Order has been temporary locked to prevent edits (e.g. when a signature is in progress) |\n| branchId | Object, Null | Branch to which the Order has been assigned (see [Branches](#) resource) |\n| closedDate | String | Date when the Order has been closed |\n| comment | String | Comment added to the Order |\n| contactId | Object, Null | Contact to which the Order Header is linked to (see [Contacts](#) resource) |\n| currencyId | Object, Null | Currency type (see [Currencies](#) resource) |\n| discount1 | Number | First discount that can be applied to the Order, in percents |\n| discount2 | Number | Second discount that can be applied to the Order, in percents |\n| discount3 | Number | Third discount that can be applied to the Order, in percents |\n| discount4 | Number | Fourth discount that can be applied to the Order, in percents |\n| extId | String | External ID of the Order from a third party system (ERP, CRM, Accounting System) |\n| internalComment | String | Internal comment |\n| internalCommentUpdateDate | String | Date when the internal comment was updated |\n| internalCommentUpdateSalesRepId | Object, Null | Id of the User who that added the internal comment |\n| mainSalesorder | Boolean | If true, the Order is relevant for the linked opportunity |\n| opportunityId | Object, Null | Opportunity to which the Order is linked to (see [Opportunities](#) resource) |\n| rateId | Object, Null | Rate for the Order Header (see [Rates](#) resource) |\n| readOnly | Boolean | If true, the Order Header cannot be modified or deleted |\n| reference | String | Order Header's label |\n| number | Integer | Order number (should be sequential and unique in general) |\n| salesForcecastDate | String | Forecast date for the Sale |\n| salesRepId | Object, Null | User responsible for the Order |\n| statusId (_Required_) | Object, Null | Status of the Order (see [Statues](#) resource) |\n| salesorderType | Object, Null | Type of the Order (see [Type](#) resource) |\n| total | Number | Total amount of the Order |\n| year | Integer | Year when the Order was created |\n| dateCreated | String | Date and time when the Order Header was created |\n| dateDeleted | String | Date and time when the Order Header was deleted |\n| dateUpdated | String | Date and time when the Order Header was last updated |\n| deleted | Boolean | If true, the Order Header has been deleted and archived |\n| id | Integer | Unique identifier for the Order Header in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Header |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Header |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order Header |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Order Headers","content":{"application/json":{"examples":{"default":{"value":[{"accountAddressId":null,"accountId":null,"archived":null,"blocked":false,"branchId":{"id":18,"value":"Tritium Software SL"},"closedDate":null,"comment":"","contactId":null,"currencyId":null,"dateCreated":"2018-12-03T11:00:39.213Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"discount1":0,"discount2":0,"discount3":0,"discount4":0,"extId":null,"id":1,"internalComment":"","internalCommentUpdateDate":null,"internalCommentUpdateSalesRepId":null,"mainSalesorder":null,"number":1,"opportunityId":6,"rateId":3,"readOnly":true,"reference":"#123","salesForcecastDate":null,"salesRepId":{"id":105,"value":"Clarice Malcolm"},"salesRepIdCreated":105,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"statusId":null,"salesOrderType":{"id":1,"value":"Invoices"},"total":0,"year":2018},{"accountAddressId":null,"accountId":{"id":31,"value":"Dario Bianchi"},"archived":true,"blocked":false,"branchId":{"id":18,"value":"Tritium Software SL"},"closedDate":"2019-03-11T16:13:04Z","comment":"","contactId":null,"currencyId":{"id":1,"value":"Euro"},"dateCreated":"2018-12-20T12:12:45.997Z","dateDeleted":null,"dateUpdated":"2019-03-11T16:13:04.21Z","deleted":false,"discount1":0,"discount2":0,"discount3":0,"discount4":0,"extId":null,"id":33,"internalComment":"","internalCommentUpdateDate":null,"internalCommentUpdateSalesRepId":null,"mainSalesorder":null,"number":1234,"opportunityId":null,"rateId":null,"readOnly":false,"reference":"#999","salesForcecastDate":"2019-02-27T00:00:00Z","salesRepId":{"id":108,"value":"Malika Yaniv"},"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":105,"statusId":{"id":1,"value":"Invoiced"},"total":344,"year":2019}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-order-header","summary":"Create Order Header","description":"This endpoint allows you to create am Order Header based on JSON input.\n\nYou will only be able to create an Order Header after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountAddressId | Integer | Account's address to which the Order is linked to (see [Address](#) resource) |\n| accountId | Integer | Account to which the Order Header is linked to (see [Accounts](#) resource) |\n| archived | Boolean | If true, the Order has been archived |\n| blocked | Boolean | If true, the Order has been temporary locked to prevent edits (e.g. when a signature is in progress) |\n| branchId (_Required_) | Integer | Branch to which the Order has been assigned (see [Branches](#) resource) |\n| closedDate | String | Date when the Order has been closed |\n| comment | String | Comment added to the Order |\n| contactId | Integer | Contact to which the Order Header is linked to (see [Contacts](#) resource) |\n| currencyId | Integer | Currency type (see [Currencies](#) resource) |\n| discount1 | Number | First discount that can be applied to the Order, in percents |\n| discount2 | Number | Second discount that can be applied to the Order, in percents |\n| discount3 | Number | Third discount that can be applied to the Order, in percents |\n| discount4 | Number | Fourth discount that can be applied to the Order, in percents |\n| extId | String | External ID of the Order from a third party system (ERP, CRM, Accounting System) |\n| internalComment | String | Internal comment |\n| mainSalesorder | Boolean | If true, the Order is relevant for the linked opportunity |\n| opportunityId | Integer | Opportunity to which the Order is linked to (see [Opportunities](#) resource) |\n| rateId | Integer | Rate for the Order Header (see [Rates](#) resource) |\n| readOnly | Boolean | If true, the Order Header cannot be modified or deleted |\n| reference (_Required_) | String | Order Header's label |\n| number | Integer | Order number (should be sequential and unique in general) |\n| salesForcecastDate | String | Forecast date for the Sale |\n| salesRepId (_Required_) | Integer | User responsible for the Order |\n| statusId | Integer | Status of the Order (see [Statues](#) resource) |\n| total | Number | Total amount of the Order |\n| year | Integer | Year when the Order was created |\n\n**RESPONSE**\n\nReturns a JSON with information about the Order Header just created.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new Order Header |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Order Header","content":{"application/json":{"examples":{"default":{"value":{"id":23,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountAddressId":{"type":"string"},"accountId":{"type":"integer"},"archived":{"type":"boolean"},"branchId":{"type":"integer"},"closedDate":{"type":"string"},"comment":{"type":"string"},"contactId":{"type":"string"},"currencyId":{"type":"string"},"discount1":{"type":"integer"},"discount2":{"type":"integer"},"discount3":{"type":"integer"},"discount4":{"type":"integer"},"extId":{"type":"string"},"internalComment":{"type":"string"},"internalCommentUpdateDate":{"type":"string"},"internalCommentUpdateSalesRepId":{"type":"string"},"mainSalesorder":{"type":"string"},"number":{"type":"integer"},"opportunityId":{"type":"string"},"rateId":{"type":"integer"},"readOnly":{"type":"boolean"},"reference":{"type":"string"},"salesRepId":{"type":"integer"},"statusId":{"type":"integer"},"total":{"type":"integer"},"year":{"type":"integer"}}},"examples":{"default":{"value":{"accountAddressId":null,"accountId":1234,"archived":false,"branchId":461,"closedDate":"2022-06-10T00:00:00Z","comment":"Contract have to be signed one month from now","contactId":null,"currencyId":null,"discount1":10,"discount2":20,"discount3":0,"discount4":0,"extId":null,"internalComment":"This is a comment just for internal purposes","internalCommentUpdateDate":null,"internalCommentUpdateSalesRepId":null,"mainSalesorder":null,"number":1,"opportunityId":null,"rateId":33,"readOnly":false,"reference":"Order #1","salesRepId":5548,"statusId":18,"total":35,"year":2018}}}}}}}},"/salesorders/{ID}":{"get":{"operationId":"get-order-header","summary":"Get Order Header","description":"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\".\n\nYou will only receive the Order Header after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Order Header |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountAddressId | Object, Null | Account's address to which the Order is linked to (see [Address](#) resource) |\n| accountId | Object, Null | Account to which the Order Header is linked to (see [Accounts](#) resource) |\n| archived | Boolean | If true, the Order has been archived |\n| blocked | Boolean | If true, the Order has been temporary locked to prevent edits (e.g. when a signature is in progress) |\n| branchId | Object, Null | Branch to which the Order has been assigned (see [Branches](#) resource) |\n| closedDate | String | Date when the Order has been closed |\n| comment | String | Comment added to the Order |\n| contactId | Object, Null | Contact to which the Order Header is linked to (see [Contacts](#) resource) |\n| currencyId | Object, Null | Currency type (see [Currencies](#) resource) |\n| discount1 | Number | First discount that can be applied to the Order, in percents |\n| discount2 | Number | Second discount that can be applied to the Order, in percents |\n| discount3 | Number | Third discount that can be applied to the Order, in percents |\n| discount4 | Number | Fourth discount that can be applied to the Order, in percents |\n| extId | String | External ID of the Order from a third party system (ERP, CRM, Accounting System) |\n| internalComment | String | Internal comment |\n| internalCommentUpdateDate | String | Date when the internal comment was updated |\n| internalCommentUpdateSalesRepId | Object, Null | Id of the User who that added the internal comment |\n| mainSalesorder | Boolean | If true, the Order is relevant for the linked opportunity |\n| opportunityId | Object, Null | Opportunity to which the Order is linked to (see [Opportunities](#) resource) |\n| rateId | Object, Null | Rate for the Order Header (see [Rates](#) resource) |\n| readOnly | Boolean | If true, the Order Header cannot be modified or deleted |\n| reference | String | Order Header's label |\n| number | Integer | Order number (should be sequential and unique in general) |\n| salesForcecastDate | String | Forecast date for the Sale |\n| salesRepId | Object, Null | User responsible for the Order |\n| statusId (_Required_) | Object, Null | Status of the Order (see [Statues](#) resource) |\n| total | Number | Total amount of the Order |\n| year | Integer | Year when the Order was created |\n| dateCreated | String | Date and time when the Order Header was created |\n| dateDeleted | String | Date and time when the Order Header was deleted |\n| dateUpdated | String | Date and time when the Order Header was last updated |\n| deleted | Boolean | If true, the Order Header has been deleted and archived |\n| id | Integer | Unique identifier for the Order Header in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Header |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Header |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order Header |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"10"}],"responses":{"200":{"description":"Get Order Header","content":{"application/json":{"examples":{"default":{"value":{"accountAddressId":null,"accountId":{"id":1533,"value":"Acme Inc."},"archived":false,"branchId":{"id":4380,"value":"Financial Dept."},"closedDate":null,"comment":"","contactId":null,"currencyId":{"id":1,"value":"euro"},"dateCreated":"2017-06-02T14:35:30.243Z","dateDeleted":null,"dateUpdated":"2017-10-17T11:17:57.363Z","deleted":false,"discount1":5,"discount2":0,"discount3":0,"discount4":0,"extId":null,"id":6,"internalComment":"","internalCommentUpdateDate":null,"internalCommentUpdateSalesRepId":null,"mainSalesorder":null,"number":6,"opportunityId":null,"rateId":null,"readOnly":false,"reference":"112233","salesForcecastDate":"2017-06-23T00:00:00Z","salesRepId":{"id":5548,"value":"John Jackson"},"salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":5548,"statusId":{"id":4,"value":"Lost"},"total":1000,"year":2021}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-order-header","summary":"Update Order Header","description":"This endpoint allows you to update a specific Order Header. If the specified Header does not exist, the response will be a \"bad request\".\n\nYou 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](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountAddressId | Integer | Account's address to which the Order is linked to (see [Address](#) resource) |\n| accountId | Integer | Account to which the Order Header is linked to (see [Accounts](#) resource) |\n| archived | Boolean | If true, the Order has been archived |\n| blocked | Boolean | If true, the Order has been temporary locked to prevent edits (e.g. when a signature is in progress) |\n| branchId | Integer | Branch to which the Order has been assigned (see [Branches](#) resource) |\n| closedDate | String | Date when the Order has been closed |\n| comment | String | Comment added to the Order |\n| contactId | Integer | Contact to which the Order Header is linked to (see [Contacts](#) resource) |\n| currencyId | Integer | Currency type (see [Currencies](#) resource) |\n| discount1 | Number | First discount that can be applied to the Order, in percents |\n| discount2 | Number | Second discount that can be applied to the Order, in percents |\n| discount3 | Number | Third discount that can be applied to the Order, in percents |\n| discount4 | Number | Fourth discount that can be applied to the Order, in percents |\n| extId | String | External ID of the Order from a third party system (ERP, CRM, Accounting System) |\n| internalComment | String | Internal comment |\n| mainSalesorder | Boolean | If true, the Order is relevant for the linked opportunity |\n| opportunityId | Integer | Opportunity to which the Order is linked to (see [Opportunities](#) resource) |\n| rateId | Integer | Rate for the Order Header (see [Rates](#) resource) |\n| readOnly | Boolean | If true, the Order Header cannot be modified or deleted |\n| reference | String | Order Header's label |\n| number | Integer | Order number (should be sequential and unique in general) |\n| salesForcecastDate | String | Forecast date for the Sale |\n| salesRepId | Integer | User responsible for the Order |\n| statusId | Integer | Status of the Order (see [Statues](#) resource) |\n| total | Number | Total amount of the Order |\n| year | Integer | Year when the Order was created |\n\n**RESPONSE**\n\nReturns a JSON with information about the Order Header just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Order Header","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string"},"discount1":{"type":"integer"},"discount2":{"type":"integer"},"total":{"type":"integer"},"year":{"type":"integer"}}},"examples":{"default":{"value":{"comment":"All right","discount1":10,"discount2":20,"total":35,"year":2018}}}}}}},"delete":{"operationId":"delete-order-header","summary":"Delete Order Header","description":"This endpoint allows you to delete a specific Order Header from the user's ForceManager implementation database. If the specified Order Header does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Order Headers after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Order Header to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Order Header just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Order Header","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/salesordersLines/schema":{"get":{"operationId":"order-lines-schema","summary":"Order Lines schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource.\nThe Schema defines all the fields that exist for an Order Line object.\n\nYou will only receive the Order Line Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Order Line Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n\nFields like \"Value list\" have extra information:\n\n\n| Attribute | Data Type | Description |\n|--|--|--|\n| Table | String | The name of the values list table |\n| Type | Object, Null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Order Lines schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"description":{"description":"","maxLength":2000,"readOnly":false,"type":["string","null"]},"discount1":{"description":"","readOnly":false,"type":["number","null"]},"discount2":{"description":"","readOnly":false,"type":["number","null"]},"discount3":{"description":"","readOnly":false,"type":["number","null"]},"discount4":{"description":"","readOnly":false,"type":["number","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"order":{"description":"","readOnly":false,"type":["integer","null"]},"price":{"description":"","readOnly":false,"type":["number","null"]},"productId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"products","type":["object","null"]},"quantity":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"salesorderId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"salesorders","type":["object","null"]},"total":{"description":"","readOnly":false,"type":["number","null"]}},"required":[],"title":"salesordersLines","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/salesordersLines":{"get":{"operationId":"list-order-lines","summary":"List Order Lines","description":"Returns all Orders Lines available in the user's ForceManager implementation database.\n\nYou will only receive the List of Orders Lines after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/salesordersLines?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/salesordersLines?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Order Lines by `dateCreated` or `total` for example.\n\nYou can also **organise and view** the results for Order Lines in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/salesordersLines?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/salesordersLines?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Order Lines available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Order Lines attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| quantity | Integer | Quantity of Product for the Order Line |\n| price | Number | Price of the Order Line |\n| description | String | Description added to the Order Line |\n| discount1 | Number | First discount that can be applied to the Order Line in percents |\n| discount2 | Number | Second discount that can be applied to the Order Line in percents |\n| discount3 | Number | Third discount that can be applied to the Order Line in percents |\n| discount4 | Number | Forth discount that can be applied to the Order Line in percents |\n| total | Number | Total amount of the Order Line |\n| productId | Object, Null | Id of the Product related to the Order Line (see [Products](#) resource) |\n| salesOrderId | Object, Null | Id of the Order Header (see [Headers](#) resource) |\n| order | Integer | The position of the Order Line in the whole Lines list |\n| dateCreated | String | Date and time when the Order Line was created |\n| dateDeleted | String | Date and time when the Order Line was deleted |\n| dateUpdated | String | Date and time when the Order Line was last updated |\n| deleted | Boolean | If true, the Order Line has been deleted and archived |\n| id | Integer | Unique identifier for the Order Line in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Line |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Line |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order Line |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Order Lines filtered by Order Id","content":{"application/json":{"examples":{"default":{"value":[{"dateCreated":"2017-05-29T13:42:21.57Z","dateDeleted":null,"dateUpdated":"2017-05-31T13:04:59.56Z","deleted":false,"description":"","discount1":0,"discount2":0,"discount3":0,"discount4":5,"id":2,"price":58,"productId":{"id":128,"value":"Enterprise"},"quantity":1,"salesRepIdCreated":5548,"salesRepIdDeleted":null,"salesRepIdUpdated":5548,"salesorderId":{"id":2,"value":"Order-2021#5"},"total":55.1}]}}}}}},"security":[{"SessionKey":[]}]}},"/salesOrdersLines":{"post":{"operationId":"create-order-line","summary":"Create Order Line","description":"This endpoint allows you to create Orders Lines based on JSON input.\n\nYou will only be able to create the Order Line after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication]().\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| quantity (_Required_) | Integer | Quantity of Product for the Order Line |\n| price (_Required_) | Number | Price of the Order Line |\n| description | String | Description added to the Order Line |\n| discount1 | Number | First discount that can be applied to the Order Line in percents |\n| discount2 | Number | Second discount that can be applied to the Order Line in percents |\n| discount3 | Number | Third discount that can be applied to the Order Line in percents |\n| discount4 | Number | Forth discount that can be applied to the Order Line in percents |\n| total | Number | Total amount of the Order Line |\n| productId (_Required_) | Integer | Id of the Product related to the Order Line (see [Products]() resource) |\n| salesOrderId | Integer | Id of the Order Header (see [Headers]() resource) |\n| order | Integer | The position of the Order Line in the whole Lines list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Order Line just created.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new Order Line |\n| Message | String | Shows the operation status |\n\n \n \n**RESPONSE CODES** \n \n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Order Line","content":{"application/json":{"examples":{"default":{"value":{"id":35,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"description":{"type":"string"},"discount1":{"type":"integer"},"price":{"type":"integer"},"productId":{"type":"integer"},"quantity":{"type":"integer"},"salesorderId":{"type":"integer"},"total":{"type":"integer"}}},"examples":{"default":{"value":{"description":"Professional Services","discount1":15,"price":80,"productId":1984,"quantity":4,"salesorderId":93,"total":300}}}}}}}},"/salesordersLines/{ID}":{"get":{"operationId":"get-order-line","summary":"Get Order Line","description":"This endpoint retrieves data of a specific Order Line based on JSON input. The API returns a single Line available to the user, according to the unique ID provided. If the specified Order Line does not exist, the response will be a \"bad request\".\n\nYou will only receive the Order Line after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Order Line |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| quantity | Integer | Quantity of Product for the Order Line |\n| price | Number | Price of the Order Line |\n| description | String | Description added to the Order Line |\n| discount1 | Number | First discount that can be applied to the Order Line in percents |\n| discount2 | Number | Second discount that can be applied to the Order Line in percents |\n| discount3 | Number | Third discount that can be applied to the Order Line in percents |\n| discount4 | Number | Forth discount that can be applied to the Order Line in percents |\n| total | Number | Total amount of the Order Line |\n| productId | Object, Null | Id of the Product related to the Order Line (see [Products](#) resource) |\n| salesOrderId | Object, Null | Id of the Order Header (see [Headers](#) resource) |\n| order | Integer | The position of the Order Line in the whole Lines list |\n| dateCreated | String | Date and time when the Order Line was created |\n| dateDeleted | String | Date and time when the Order Line was deleted |\n| dateUpdated | String | Date and time when the Order Line was last updated |\n| deleted | Boolean | If true, the Order Line has been deleted and archived |\n| id | Integer | Unique identifier for the Order Line in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Line |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Line |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order Line |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [optional]"}],"responses":{"200":{"description":"Get Order Line","content":{"application/json":{"examples":{"default":{"value":{"dateCreated":"2017-10-04T10:14:27.463Z","dateDeleted":"2018-06-14T13:07:40.817Z","dateUpdated":"2018-06-14T13:07:09.807Z","deleted":true,"description":"This is a plan for SMBs","discount1":10,"discount2":0,"discount3":0,"discount4":0,"id":50,"price":30,"productId":{"id":128,"value":"Starter"},"quantity":5,"salesRepIdCreated":5548,"salesRepIdDeleted":51,"salesRepIdUpdated":51,"salesorderId":{"id":15,"value":"33445566"},"total":20}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-order-line","summary":"Update Order Line","description":"This endpoint allows you to update a specific Order Line. If the specified Line does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Order Line after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Order Line. In order to update a Line, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| quantity | Integer | Quantity of Product for the Order Line |\n| price | Number | Price of the Order Line |\n| description | String | Description added to the Order Line |\n| discount1 | Number | First discount that can be applied to the Order Line in percents |\n| discount2 | Number | Second discount that can be applied to the Order Line in percents |\n| discount3 | Number | Third discount that can be applied to the Order Line in percents |\n| discount4 | Number | Forth discount that can be applied to the Order Line in percents |\n| total | Number | Total amount of the Order Line |\n| productId | Integer | Id of the Product related to the Order Line (see [Products](#) resource) |\n| salesOrderId | Integer | Id of the Order Header (see [Headers](#) resource) |\n| order | Integer | The position of the Order Line in the whole Lines list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Order Line just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Order Line","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"discount1":{"type":"integer"},"price":{"type":"integer"},"quantity":{"type":"integer"},"total":{"type":"integer"}}},"examples":{"default":{"value":{"discount1":10,"price":30,"quantity":5,"total":20}}}}}}},"delete":{"operationId":"delete-order-line","summary":"Delete Order Line","description":"This endpoint allows you to delete a specific Order Line from the user's ForceManager implementation database. If the specified Order Line does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Order Lines after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Order Line to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Order Line just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Order Line","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/salesorderStatuses/schema":{"get":{"operationId":"order-statuses-schema","summary":"Order Statuses schema","description":"The Schema is metadata that tells you how the data is structured for this specific Value list. \n\nYou will only receive the Orders Statuses Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\nThe Order Statuses Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Order Statuses schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"lost":{"description":"","readOnly":false,"type":["boolean","null"]},"order":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"won":{"description":"","readOnly":false,"type":["boolean","null"]}},"required":[],"title":"salesorderStatuses","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/salesorderStatuses":{"get":{"operationId":"list-order-statuses","summary":"List Order Statuses","description":"Returns all Orders Statuses available.\n\nYou will only receive the Orders Statuses after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Order Statuses available for the value list.\n\nList of the supported Orders Statuses attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Order Status is visible |\n| dateCreated | String | Date and time when the Order Status was created |\n| dateDeleted | String | Date and time when the Order Status was deleted |\n| dateUpdated | String | Date and time when the Order Status was last updated |\n| deleted | Boolean | If true, the Order Status has been deleted and archived |\n| descriptionBR | String | Order Status label in Brasilian Portuguese |\n| descriptionDE | String | Order Status label in German |\n| descriptionDK | String | Order Status label in Dutch |\n| descriptionEN | String | Order Status label in English |\n| descriptionES | String | Order Status label in Spanish |\n| descriptionFR | String | Order Status label in French |\n| descriptionIT | String | Order Status label in Italian |\n| descriptionPT | String | Order Status label in Portuguese |\n| descriptionRU | String | Order Status label in Russian |\n| descriptionUS | String | Order Status label in American English |\n| id | Integer | Unique identifier for the Order Status in ForceManager |\n| won | Boolean | If true, the Order has been won |\n| lost | Boolean | If true, the Order has been lost |\n| order | Integer | The position of the Order Status in the Order Statuses value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Status |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Status |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order Status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Order Statuses","content":{"application/json":{"examples":{"default":{"value":[{"branchVisibility":[],"dateCreated":"2017-03-16T11:01:57.1Z","dateDeleted":null,"dateUpdated":"2017-10-17T10:37:35.01Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Acquired","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"lost":null,"order":3,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":true},{"branchVisibility":[],"dateCreated":"2017-06-02T14:14:59.387Z","dateDeleted":null,"dateUpdated":"2017-06-02T14:17:40.043Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Sent","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":2,"lost":null,"order":1,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":null},{"branchVisibility":[],"dateCreated":"2017-06-02T14:16:52.52Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Canceled","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":3,"lost":null,"order":0,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":null},{"branchVisibility":[],"dateCreated":"2017-06-02T14:17:26.82Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Lost","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":4,"lost":null,"order":4,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-order-status","summary":"Create Order Status","description":"This endpoint allows you to create an Order Status based on JSON input.\n\nYou will only be able to create an Order Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Order Status is visible |\n| descriptionBR | String | Order Status label in Brasilian Portuguese |\n| descriptionDE | String | Order Status label in German |\n| descriptionDK | String | Order Status label in Dutch |\n| descriptionEN (*Required*) | String | Order Status label in English |\n| descriptionES | String | Order Status label in Spanish |\n| descriptionFR | String | Order Status label in French |\n| descriptionIT | String | Order Status label in Italian |\n| descriptionPT | String | Order Status label in Portuguese |\n| descriptionRU | String | Order Status label in Russian |\n| descriptionUS | String | Order Status label in American English |\n| won | Boolean | If true, the Order has been won |\n| lost | Boolean | If true, the Order has been lost |\n| order | Integer | he position of the Order Status in the Order Statuses value list |\n\n**RESPONSE**\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Order Status |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Order Status","content":{"application/json":{"examples":{"default":{"value":{"id":6,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"order":{"type":"integer"},"won":{"type":"boolean"},"lost":{"type":"boolean"}}},"examples":{"default":{"value":{"descriptionEN":"Drafted","order":0,"won":false,"lost":false}}}}}}}},"/salesorderStatuses/{ID}":{"get":{"operationId":"get-order-status","summary":"Get Order Status","description":"This endpoint retrieves data of a specific Order Status based on JSON input. The API returns a single Status available to the user in the Value List, according to the unique ID provided. If the specified Order Status does not exist, the response will be a \"bad request\".\n\nYou will only receive the Order Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Order Status |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Order Status is visible |\n| dateCreated | String | Date and time when the Order Status was created |\n| dateDeleted | String | Date and time when the Order Status was deleted |\n| dateUpdated | String | Date and time when the Order Status was last updated |\n| deleted | Boolean | If true, the Order Status has been deleted and archived |\n| descriptionBR | String | Order Status label in Brasilian Portuguese |\n| descriptionDE | String | Order Status label in German |\n| descriptionDK | String | Order Status label in Dutch |\n| descriptionEN | String | Order Status label in English |\n| descriptionES | String | Order Status label in Spanish |\n| descriptionFR | String | Order Status label in French |\n| descriptionIT | String | Order Status label in Italian |\n| descriptionPT | String | Order Status label in Portuguese |\n| descriptionRU | String | Order Status label in Russian |\n| descriptionUS | String | Order Status label in American English |\n| id | Integer | Unique identifier for the Order Status in ForceManager |\n| won | Boolean | If true, the Order has been won |\n| lost | Boolean | If true, the Order has been lost |\n| order | Integer | The position of the Order Status in the Order Statuses value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Status |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Status |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order Status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Order Status","content":{"application/json":{"examples":{"default":{"value":{"branchVisibility":[],"dateCreated":"2017-03-16T11:01:57.1Z","dateDeleted":null,"dateUpdated":"2017-10-17T10:37:35.01Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Acquired","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"lost":null,"order":3,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":true}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-order-status","summary":"Update Order Status","description":"This endpoint allows you to update a specific Order Status. If the specified Status does not exist, the response will be a \"bad request\".\n\nYou will only be able to update an Order Status after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Order Status. In order to update a Status, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Order Status is visible |\n| descriptionBR | String | Order Status label in Brasilian Portuguese |\n| descriptionDE | String | Order Status label in German |\n| descriptionDK | String | Order Status label in Dutch |\n| descriptionEN | String | Order Status label in English |\n| descriptionES | String | Order Status label in Spanish |\n| descriptionFR | String | Order Status label in French |\n| descriptionIT | String | Order Status label in Italian |\n| descriptionPT | String | Order Status label in Portuguese |\n| descriptionRU | String | Order Status label in Russian |\n| descriptionUS | String | Order Status label in American English |\n| won | Boolean | If true, the Order has been won |\n| lost | Boolean | If true, the Order has been lost |\n| order | Integer | he position of the Order Status in the Order Statuses value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Order Status just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Order Status","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"lost":{"type":"boolean"},"order":{"type":"integer"}}},"examples":{"default":{"value":{"descriptionEN":"Canceled","lost":true,"order":4}}}}}}},"delete":{"operationId":"delete-order-status","summary":"Delete Order Status","description":"This endpoint allows you to delete a specific Order Status from the user's ForceManager implementation database. If the specified Order Status does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Order Statuss after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Order Status to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Order Status just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Statuses"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Order Status","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/orderTypes/schema":{"get":{"operationId":"order-types-schema","summary":"Order Types schema","description":"The Schema is metadata that tells you how the data is structured for this specific Value list.\n\nYou will only receive the Orders Types Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE** \nThe Order Types Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n- Description of each property\n \n- Definition of the data type for each property\n \n- Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Order Types schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"lost":{"description":"","readOnly":false,"type":["boolean","null"]},"order":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"won":{"description":"","readOnly":false,"type":["boolean","null"]}},"required":[],"title":"salesorderStatuses","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/orderTypes":{"get":{"operationId":"list-order-types","summary":"List Order Types","description":"Returns all Orders Types available.\n\nYou will only receive the Orders Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Order Types available for the value list.\n\nList of the supported Orders Types attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Order Type is visible |\n| dateCreated | String | Date and time when the Order Type was created |\n| dateDeleted | String | Date and time when the Order Type was deleted |\n| dateUpdated | String | Date and time when the Order Type was last updated |\n| deleted | Boolean | If true, the Order Type has been deleted and archived |\n| descriptionBR | String | Order Type label in Brasilian Portuguese |\n| descriptionDE | String | Order Type label in German |\n| descriptionDK | String | Order Type label in Dutch |\n| descriptionEN | String | Order Type label in English |\n| descriptionES | String | Order Type label in Spanish |\n| descriptionFR | String | Order Type label in French |\n| descriptionIT | String | Order Type label in Italian |\n| descriptionPT | String | Order Type label in Portuguese |\n| descriptionRU | String | Order Type label in Russian |\n| descriptionUS | String | Order Type label in American English |\n| id | Integer | Unique identifier for the Order Type in ForceManager |\n| won | Boolean | If true, the Order has been won |\n| lost | Boolean | If true, the Order has been lost |\n| order | Integer | The position of the Order Type in the Order Types value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order Type |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Order Types","content":{"application/json":{"examples":{"default":{"value":[{"branchVisibility":[],"dateCreated":"2017-03-16T11:01:57.1Z","dateDeleted":null,"dateUpdated":"2017-10-17T10:37:35.01Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Acquired","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"lost":null,"order":3,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":true},{"branchVisibility":[],"dateCreated":"2017-06-02T14:14:59.387Z","dateDeleted":null,"dateUpdated":"2017-06-02T14:17:40.043Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Sent","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":2,"lost":null,"order":1,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":null},{"branchVisibility":[],"dateCreated":"2017-06-02T14:16:52.52Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Canceled","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":3,"lost":null,"order":0,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":null},{"branchVisibility":[],"dateCreated":"2017-06-02T14:17:26.82Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Lost","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":4,"lost":null,"order":4,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-order-types","summary":"Create Order Types","description":"This endpoint allows you to create an Order Types based on JSON input.\n\nYou will only be able to create an Order Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Order Status is visible |\n| descriptionBR | String | Order Status label in Brasilian Portuguese |\n| descriptionDE | String | Order Status label in German |\n| descriptionDK | String | Order Status label in Dutch |\n| descriptionEN (_Required_) | String | Order Status label in English |\n| descriptionES | String | Order Status label in Spanish |\n| descriptionFR | String | Order Status label in French |\n| descriptionIT | String | Order Status label in Italian |\n| descriptionPT | String | Order Status label in Portuguese |\n| descriptionRU | String | Order Status label in Russian |\n| descriptionUS | String | Order Status label in American English |\n| won | Boolean | If true, the Order has been won |\n| lost | Boolean | If true, the Order has been lost |\n| order | Integer | he position of the Order Status in the Order Statuses value list |\n\n**RESPONSE**\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Order Status |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Order Types","content":{"application/json":{"examples":{"default":{"value":{"id":6,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"order":{"type":"integer"},"won":{"type":"boolean"},"lost":{"type":"boolean"}}},"examples":{"default":{"value":{"descriptionEN":"Drafted","order":0,"won":false,"lost":false}}}}}}}},"/orderTypes/{ID}":{"get":{"operationId":"get-order-types","summary":"Get Order Types","description":"This endpoint retrieves data of a specific Order Types based on JSON input. The API returns a single Type available to the user in the Value List, according to the unique ID provided. If the specified Order Types does not exist, the response will be a \"bad request\".\n\nYou will only receive the Order Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Order Status |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Order Status is visible |\n| dateCreated | String | Date and time when the Order Status was created |\n| dateDeleted | String | Date and time when the Order Status was deleted |\n| dateUpdated | String | Date and time when the Order Status was last updated |\n| deleted | Boolean | If true, the Order Status has been deleted and archived |\n| descriptionBR | String | Order Status label in Brasilian Portuguese |\n| descriptionDE | String | Order Status label in German |\n| descriptionDK | String | Order Status label in Dutch |\n| descriptionEN | String | Order Status label in English |\n| descriptionES | String | Order Status label in Spanish |\n| descriptionFR | String | Order Status label in French |\n| descriptionIT | String | Order Status label in Italian |\n| descriptionPT | String | Order Status label in Portuguese |\n| descriptionRU | String | Order Status label in Russian |\n| descriptionUS | String | Order Status label in American English |\n| id | Integer | Unique identifier for the Order Status in ForceManager |\n| won | Boolean | If true, the Order has been won |\n| lost | Boolean | If true, the Order has been lost |\n| order | Integer | The position of the Order Status in the Order Statuses value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Order Status |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Order Status |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Order Status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Order Types","content":{"application/json":{"examples":{"default":{"value":{"branchVisibility":[],"dateCreated":"2017-03-16T11:01:57.1Z","dateDeleted":null,"dateUpdated":"2017-10-17T10:37:35.01Z","deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Acquired","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"lost":null,"order":3,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"won":true}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-order-types","summary":"Update Order Types","description":"This endpoint allows you to update a specific Order Types. If the specified Types does not exist, the response will be a \"bad request\".\n\nYou will only be able to update an Order Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Order Types. In order to update a Types, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the Order Type is visible |\n| descriptionBR | String | Order Type label in Brasilian Portuguese |\n| descriptionDE | String | Order Type label in German |\n| descriptionDK | String | Order Type label in Dutch |\n| descriptionEN | String | Order Type label in English |\n| descriptionES | String | Order Type label in Spanish |\n| descriptionFR | String | Order Type label in French |\n| descriptionIT | String | Order Type label in Italian |\n| descriptionPT | String | Order Type label in Portuguese |\n| descriptionRU | String | Order Type label in Russian |\n| descriptionUS | String | Order Type label in American English |\n| won | Boolean | If true, the Order has been won |\n| lost | Boolean | If true, the Order has been lost |\n| order | Integer | he position of the Order Type in the Order Types value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the Order Types just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Order Types","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"lost":{"type":"boolean"},"order":{"type":"integer"}}},"examples":{"default":{"value":{"descriptionEN":"Canceled","lost":true,"order":4}}}}}}},"delete":{"operationId":"delete-order-types","summary":"Delete Order Types","description":"This endpoint allows you to delete a specific Order Types from the user's ForceManager implementation database. If the specified Order Types does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Order Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Order Status to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Order Types just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Orders / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Order Types","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/products/schema":{"get":{"operationId":"products-schema","summary":"Products schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource.\n\nThe Schema defines all the fields that exist for a Product object.\n\nYou will only receive the Products Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Products Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Table | String | The name of the values list table |\n| Type | Object, Null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Products schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"categoryId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"productCategories","type":["object","null"]},"cost":{"description":"","readOnly":false,"type":["number","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"description":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"extId":{"description":"","maxLength":30,"readOnly":false,"type":["string","null"]},"familyId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"productFamilies","type":["object","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"maxDiscount":{"description":"","readOnly":false,"type":["number","null"]},"model":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"notAvailable":{"description":"","readOnly":false,"type":["boolean","null"]},"permissionLevel":{"description":"","readOnly":false,"type":["integer","null"]},"price":{"description":"","readOnly":false,"type":["number","null"]},"readOnly":{"description":"","readOnly":false,"type":["boolean","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"stock":{"description":"","readOnly":false,"type":["integer","null"]}},"required":[],"title":"products","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/products":{"get":{"operationId":"list-products","summary":"List Products","description":"Returns all Products available in the user's ForceManager implementation database.\n\nYou will only receive the Products after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/products?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n``` \nhttps://api.forcemanager.com/api/v4/products?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Products by `dateCreated`, `familyId` and `model` for example.\n\nYou 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.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/products?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/products?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Products available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Products attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| categoryId | Object, Null | Id of the Category that the Product belongs to (see [Categories](#) resource) |\n| cost | Number | Cost of the Product |\n| dateCreated | String | Date and time when the Product was created |\n| dateDeleted | String | Date and time when the Product was deleted |\n| dateUpdated | string | Date and time when the Product was last updated |\n| deleted | Boolean | If true, the Product has been deleted and archived |\n| description | String | Description of the Product |\n| extId | String | External ID of the Product from a third party system (ERP, CRM, Accounting System) |\n| familyId | Object, Null | Id of the Family that the Product belongs to (see [Families](#) resource) |\n| id | Integer | Unique identifier for the Product in ForceManager |\n| maxDiscount | Number | Maximum discount that can be applied to the Product in percents |\n| model | String | Product name |\n| notAvailable | Boolean | If true, the Product is not available |\n| permissionLevel | Integer | Defines the visibility of the Product. Set from 1 to 5 being 5 the highest level of permission |\n| price | Number | Specific price for the Product |\n| stock | Integer | Amount of Product in stock |\n| readOnly | Boolean | If true, the Product can not be modified or deleted |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Product |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Product |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Product |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Products","content":{"application/json":{"examples":{"default":{"value":[{"Z_SKU":"SKU2006-001","categoryId":null,"cost":10,"dateCreated":"2018-12-03T12:09:13.48Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"description":"","extId":null,"familyId":null,"id":128,"maxDiscount":null,"model":"Aviator sunglasses","notAvailable":false,"permissionLevel":0,"price":100,"readOnly":false,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"stock":null},{"Z_SKU":"SKU2006-020","categoryId":null,"cost":0,"dateCreated":"2018-12-03T12:09:14.373Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"description":"","extId":null,"familyId":null,"id":129,"maxDiscount":null,"model":"Rayban sunglasses","notAvailable":false,"permissionLevel":0,"price":200,"readOnly":false,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"stock":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-product","summary":"Create Product","description":"This endpoint allows you to create a Product based on JSON input.\n\nYou will only be able to create a Product after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| categoryId | Object, Null | Id of the Category that the Product belongs to (see [Categories](#) resource) |\n| cost | Number | Cost of the Product |\n| description | String | Description of the Product |\n| extId | String | External ID of the Product from a third party system (ERP, CRM, Accounting System) |\n| familyId | Integer | Id of the Family that the Product belongs to (see [Families](#) resource) |\n| maxDiscount | Number | Maximum discount that can be applied to the Product in percents |\n| model (_Required_) | String | Product name |\n| notAvailable | Boolean | If true, the Product is not available |\n| permissionLevel | Integer | Defines the visibility of the Product. Set from 1 to 5 being 5 the highest level of permission |\n| price | Number | Specific price for the Product |\n| stock | Integer | Amount of Product in stock |\n| readOnly | Boolean | If true, the Product can not be modified or deleted |\n\n**RESPONSE**\n\nReturns a JSON with information about the Product just created.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new Product |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Product","content":{"application/json":{"examples":{"default":{"value":{"id":131,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"categoryId":{"type":"integer"},"cost":{"type":"integer"},"description":{"type":"string"},"familyId":{"type":"integer"},"maxDiscount":{"type":"integer"},"permissionLevel":{"type":"integer"},"price":{"type":"number"}}},"examples":{"default":{"value":{"categoryId":4,"cost":0,"description":"Lens pack","familyId":12,"maxDiscount":15,"permissionLevel":2,"price":1999.99}}}}}}}},"/products/{ID}":{"get":{"operationId":"get-product","summary":"Get Product","description":"This endpoint retrieves data of a specific Product based on JSON input. The API returns a single Product available to the user, according to the unique Product ID provided. If the specified Product does not exist, the response will be a \"bad request\".\n\nYou will only receive the Product after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier for the Product |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| categoryId | Object, Null | Id of the Category that the Product belongs to (see [Categories](#) resource) |\n| cost | Number | Cost of the Product |\n| dateCreated | String | Date and time when the Product was created |\n| dateDeleted | String | Date and time when the Product was deleted |\n| dateUpdated | string | Date and time when the Product was last updated |\n| deleted | Boolean | If true, the Product has been deleted and archived |\n| description | String | Description of the Product |\n| extId | String | External ID of the Product from a third party system (ERP, CRM, Accounting System) |\n| familyId | Object, Null | Id of the Family that the Product belongs to (see [Families](#) resource) |\n| id | Integer | Unique identifier for the Product in ForceManager |\n| maxDiscount | Number | Maximum discount that can be applied to the Product in percents |\n| model | String | Product name |\n| notAvailable | Boolean | If true, the Product is not available |\n| permissionLevel | Integer | Defines the visibility of the Product. Set from 1 to 5 being 5 the highest level of permission |\n| price | Number | Specific price for the Product |\n| stock | Integer | Amount of Product in stock |\n| readOnly | Boolean | If true, the Product can not be modified or deleted |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Product |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Product |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Product |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [optional]"}],"responses":{"200":{"description":"Get Product","content":{"application/json":{"examples":{"default":{"value":{"Z_SKU":"SKU2006-001","categoryId":null,"cost":10,"dateCreated":"2018-12-03T12:09:13.48Z","dateDeleted":null,"dateUpdated":"2021-12-08T22:45:25.753Z","deleted":false,"description":"Unisex model","extId":null,"familyId":null,"id":128,"maxDiscount":15,"model":"Aviator sunglasses","notAvailable":false,"permissionLevel":0,"price":100,"readOnly":false,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":51,"stock":null}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-product","summary":"Update Product","description":"This endpoint allows you to update specific information of a Product from the user's ForceManager implementation database. If the specified Product does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Product after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Product. In order to update a Product, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| categoryId | Object, Null | Id of the Category that the Product belongs to (see [Categories](#) resource) |\n| cost | Number | Cost of the Product |\n| description | String | Description of the Product |\n| extId | String | External ID of the Product from a third party system (ERP, CRM, Accounting System) |\n| familyId | Integer | Id of the Family that the Product belongs to (see [Families](#) resource) |\n| maxDiscount | Number | Maximum discount that can be applied to the Product in percents |\n| model | String | Product name |\n| notAvailable | Boolean | If true, the Product is not available |\n| permissionLevel | Integer | Defines the visibility of the Product. Set from 1 to 5 being 5 the highest level of permission |\n| price | Number | Specific price for the Product |\n| stock | Integer | Amount of Product in stock |\n| readOnly | Boolean | If true, the Product can not be modified or deleted |\n\n**RESPONSE**\n\nReturns a JSON with information about the Product just updated.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Product","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cost":{"type":"integer"},"description":{"type":"string"},"maxDiscount":{"type":"integer"},"price":{"type":"integer"}}},"examples":{"default":{"value":{"cost":10,"description":"Unisex model","maxDiscount":15,"price":100}}}}}}},"delete":{"operationId":"delete-product","summary":"Delete Product","description":"This endpoint allows you to delete a specific Product from the user's ForceManager implementation database. If the specified Product does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete a Product after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Product to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Product just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Product","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/products/bulk":{"post":{"operationId":"bulk-create-products","summary":"Bulk Create Products","description":"This endpoint allows you to create Multiple Products (100 entities for request) based on JSON input.\n\nYou will only be able to create Multiple Products after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nYou have to send a Array with the following JSON data:\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | String | Unique operation identifier |\n| data | Object | JSONObject with the Product data (same data as Create Product method) |\n\nYou can check the \"data\" object in the following table:\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| categoryId | Object, Null | Id of the Category that the Product belongs to (see [Categories](#) resource) |\n| cost | Number | Cost of the Product |\n| description | String | Description of the Product |\n| extId | String | External ID of the Product from a third party system (ERP, CRM, Accounting System) |\n| familyId | Integer | Id of the Family that the Product belongs to (see [Families](#) resource) |\n| maxDiscount | Number | Maximum discount that can be applied to the Product in percents |\n| model (_Required_) | String | Product name |\n| notAvailable | Boolean | If true, the Product is not available |\n| permissionLevel | Integer | Defines the visibility of the Product. Set from 1 to 5 being 5 the highest level of permission |\n| price | Number | Specific price for the Product |\n| stock | Integer | Amount of Product in stock |\n| readOnly | Boolean | If true, the Product can not be modified or deleted |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | Integer | Unique operation identifier |\n| id | Integer | Id assigned to the new Account |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Bulk Create Products","content":{"application/json":{"examples":{"default":{"value":[{"id":125,"message":"Entity create success","guid":"UniqueIdentifierOperation_1","code":1},{"id":126,"message":"Entity create success","guid":"UniqueIdentifierOperation_2","code":1}]}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"default":{"value":[{"guid":"UniqueIdentifierOperation_1","data":{"categoryId":4,"cost":0,"description":"Lens pack","familyId":12,"maxDiscount":15,"permissionLevel":2,"price":1999.99}},{"guid":"UniqueIdentifierOperation_2","data":{"categoryId":1,"cost":0,"description":"Glasses pack","familyId":4,"maxDiscount":10,"permissionLevel":2,"price":399.99}}]}}}}}},"put":{"operationId":"bulk-update-products","summary":"Bulk Update Products","description":"This endpoint allows you to update a Multiple Products (100 entities for request) information from the user's ForceManager implementation database. \nIn order to update Multiple Products, 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.\n\nYou will only be able to update an Account after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of Multiple Products. In order to update an Account, 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.**\n\nYou have to send an Array with the following JSON data:\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | String | Unique operation identifier |\n| data | Object | JSONObject with the Account data (same data as Create Account method) |\n| id | Integer | Unique Account's identifier |\n\nYou can check the \"data\" object in the following table:\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| categoryId | Object, Null | Id of the Category that the Product belongs to (see [Categories](#) resource) |\n| cost | Number | Cost of the Product |\n| description | String | Description of the Product |\n| extId | String | External ID of the Product from a third party system (ERP, CRM, Accounting System) |\n| familyId | Integer | Id of the Family that the Product belongs to (see [Families](#) resource) |\n| maxDiscount | Number | Maximum discount that can be applied to the Product in percents |\n| model | String | Product name |\n| notAvailable | Boolean | If true, the Product is not available |\n| permissionLevel | Integer | Defines the visibility of the Product. Set from 1 to 5 being 5 the highest level of permission |\n| price | Number | Specific price for the Product |\n| stock | Integer | Amount of Product in stock |\n| readOnly | Boolean | If true, the Product can not be modified or deleted |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account just updated.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Bulk Update Products","content":{"application/json":{"examples":{"default":{"value":[{"id":19,"message":"Entity update success","guid":"UniqueOperationIdentifier_1","code":1},{"id":21,"message":"Entity update success","guid":"UniqueOperationIdentifier_2","code":1}]}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object"}},"examples":{"default":{"value":[{"guid":"UniqueOperationIdentifier_1","id":19,"data":{"cost":10,"description":"Unisex model","maxDiscount":15,"price":100}},{"guid":"UniqueOperationIdentifier_2","id":21,"data":{"cost":15,"description":"Winter model","maxDiscount":0,"price":89}}]}}}}}},"delete":{"operationId":"bulk-delete-products","summary":"Bulk Delete Products","description":"This endpoint allows you to delete Multiple Products (100 entities for request) from the user's ForceManager implementation database. If the specified Account does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Multiple Products after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nYou have to send an Array with the following JSON data:\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | String | Unique operation identifier |\n| id | Integer | Unique Account's identifier |\n\n**RESPONSE**\n\nReturns a JSON with information about the Account just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| guid | Integer | Unique operation identifier |\n| id | Integer | Id assigned to the new Account |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Bulk Delete Products","content":{"application/json":{"examples":{"default":{"value":[{"id":19,"message":"Entity delete success","guid":"UniqueOperationIdentifier_1","code":1},{"id":21,"message":"Entity delete success","guid":"UniqueOperationIdentifier_2","code":1}]}}}}}},"security":[{"SessionKey":[]}]}},"/products/VALUE/documents":{"post":{"operationId":"add-picture","summary":"Add Picture","description":"This endpoint allows you to upload a Picture based on JSON input.\n\nYou will only be able to upload a Picture after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| name (*Required*) | String | The picture's name |\n| isCarrousel (*Required*) | Boolean | It has to be set to true to have the picture appearing in the Products carousel |\n| folderId (*Required*) | String | \\-1 if you want to upload the Picture in the Root folder, the Folder's ID if you want to upload the file in a specific folder |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| locator | String | The url you should upload the Picture (check table below). |\n| id | Integer | The ID assigned to the Picture in the ForceManager Database |\n\n* IMPORTANT: You can use whatever you want to upload your file to FM System. Despite of that, you must do a **PUT request** with the **binary data** you want to upload and set the following headers:\n \n\n| **Attribute** | **Value** |\n| --- | --- |\n| Content-Type | application/octet-stream |\n| Content-Length | {file.size} -> file.size is the size of the file you are going to upload |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Carousel"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Add picture","content":{"application/json":{"examples":{"default":{"value":{"locator":"https://forcemanager0001.s3-eu-west-1.amazonaws.com/63613/0000013.pdf?X-Amz-Expires=604800&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAJ42UVINUBWRYEMMA/20181107/eu-west-1/s3/aws4_request&X-Amz-Date=20181107T153333Z&X-Amz-SignedHeaders=content-type;host&X-Amz-Signature=330d5e5b574c4a3389d7b2c8a09284b83e8d2394a3549251e93149b3925414c4","id":"345"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"isCarrousel":{"type":"boolean"},"folderId":{"type":"string"}}},"examples":{"default":{"value":{"name":"example_of_product_image.png","isCarrousel":true,"folderId":"-1"}}}}}}}},"/productFamilies/schema":{"get":{"operationId":"product-families-schema","summary":"Product Families schema","description":"Returns properties object with the definition of each field in the Product Families table. \nWith the Product Family you can classify each Product.\n\nYou will only receive the Product Family Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Product Family Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Families"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"Product Families schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branchRestriction":{"description":"","readOnly":false,"type":["boolean","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"deleted":{"description":"","readOnly":false,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":false,"type":["integer","null"]},"idParent":{"description":"","readOnly":false,"type":["integer","null"]},"notAvailable":{"description":"","readOnly":false,"type":["boolean","null"]},"salesRepIdCreated":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":false,"type":["integer","null"]}},"required":[],"title":"productFamilies","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/productFamilies":{"get":{"operationId":"list-product-families","summary":"List Product Families","description":"Returns all Product Families available.\n\nYou will only receive the Product Families after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Product Families available for the value list.\n\nList of the supported Product Families attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchRestriction | Integer | If true, the User has limited visibility in some branches |\n| descriptionBR | String | Product Family name in Brasilian Portuguese |\n| descriptionDE | String | Product Family name in German |\n| descriptionDK | String | Product Family name in Dutch |\n| descriptionEN | String | Product Family name in English |\n| descriptionES | String | Product Family name in Spanish |\n| descriptionFR | String | Product Family name in French |\n| descriptionIT | String | Product Family name in Italian |\n| descriptionPT | String | Product Family name in Portuguese |\n| descriptionRU | String | Product Family name in Russian |\n| descriptionUS | String | Product Family name in American English |\n| id | Integer | Unique identifier of the Product Family in ForceManager |\n| idParent | Integer | Unique identifier of the parent Product Family, for Product Families hierarchy purposes |\n| notAvailable | Boolean | If true, the Product Family is not available |\n| dateCreated | String | Date and time when the Product Family was created |\n| dateDeleted | String | Date and time when the Product Family was deleted |\n| dateUpdated | String | Date and time when the Product Family was last updated |\n| deleted | Boolean | If true, the Product Family has been deleted and archived |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Product Family |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Product Family |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Product Family |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Families"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Product Families","content":{"application/json":{"examples":{"default":{"value":[{"branchRestriction":false,"dateCreated":"2018-10-29T17:05:31.877Z","dateDeleted":"2018-10-29T17:15:31.803Z","dateUpdated":null,"deleted":true,"descriptionBR":"","descriptionDE":"","descriptionDK":"","descriptionEN":"Packs","descriptionES":"","descriptionFR":"","descriptionIT":"","descriptionPT":"","descriptionRU":"","descriptionUS":"","id":138,"idParent":-1,"notAvailable":false,"salesRepIdCreated":105,"salesRepIdDeleted":null,"salesRepIdUpdated":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-product-family","summary":"Create Product Family","description":"This endpoint allows you to create a Product Family based on JSON input.\n\nYou will only be able to create a Product Family after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchRestriction | Boolean | If true, the User has limited visibility in some branches |\n| descriptionBR | String | Product Family name in Brasilian Portuguese |\n| descriptionDE | String | Product Family name in German |\n| descriptionDK | String | Product Family name in Dutch |\n| descriptionEN (*Required*) | String | Product Family name in English |\n| descriptionES | String | Product Family name in Spanish |\n| descriptionFR | String | Product Family name in French |\n| descriptionIT | String | Product Family name in Italian |\n| descriptionPT | String | Product Family name in Portuguese |\n| descriptionRU | String | Product Family name in Russian |\n| descriptionUS | String | Product Family name in American English |\n| idParent | Integer | Unique identifier of the parent Product Family, for Product Families hierarchy purposes |\n| notAvailable | Boolean | If true, the Product Family is not available |\n\n**RESPONSE** \nReturns a JSON with information about the Product Family just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Product Family |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Families"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Product Family","content":{"application/json":{"examples":{"default":{"value":{"id":139,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"branchRestriction":{"type":"boolean"},"notAvailable":{"type":"boolean"},"idParent":{"type":"integer"}}},"examples":{"default":{"value":{"descriptionEN":"Black Friday Packs","branchRestriction":true,"notAvailable":true,"idParent":-1}}}}}}}},"/productFamilies/{ID}":{"get":{"operationId":"get-product-family","summary":"Get Product Family","description":"This endpoint retrieves data of a specific Product Family based on JSON input. The API returns a single Product Family available to the user in the Value List, according to the unique ID provided. If the specified Family does not exist, the response will be a \"bad request\".\n\nYou will only receive the Product Family after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Product Family |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchRestriction | Integer | If true, the User has limited visibility in some branches |\n| descriptionBR | String | Product Family name in Brasilian Portuguese |\n| descriptionDE | String | Product Family name in German |\n| descriptionDK | String | Product Family name in Dutch |\n| descriptionEN (*Required*) | String | Product Family name in English |\n| descriptionES | String | Product Family name in Spanish |\n| descriptionFR | String | Product Family name in French |\n| descriptionIT | String | Product Family name in Italian |\n| descriptionPT | String | Product Family name in Portuguese |\n| descriptionRU | String | Product Family name in Russian |\n| descriptionUS | String | Product Family name in American English |\n| id | Integer | Unique identifier of the Product Family in ForceManager |\n| idParent | Integer | Unique identifier of the parent Product Family, for Product Families hierarchy purposes |\n| notAvailable | Boolean | If true, the Product Family is not available |\n| dateCreated | String | Date and time when the Product Family was created |\n| dateDeleted | String | Date and time when the Product Family was deleted |\n| dateUpdated | String | Date and time when the Product Family was last updated |\n| deleted | Boolean | If true, the Product Family has been deleted and archived |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Product Family |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Product Family |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Product Family |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Families"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Product Family","content":{"application/json":{"examples":{"default":{"value":{"branchRestriction":false,"dateCreated":"2018-10-29T17:05:31.877Z","dateDeleted":"2018-10-29T17:15:31.803Z","dateUpdated":null,"deleted":true,"descriptionBR":"","descriptionDE":"","descriptionDK":"","descriptionEN":"Packs","descriptionES":"","descriptionFR":"","descriptionIT":"","descriptionPT":"","descriptionRU":"","descriptionUS":"","id":138,"idParent":-1,"notAvailable":false,"salesRepIdCreated":105,"salesRepIdDeleted":null,"salesRepIdUpdated":null}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-product-family","summary":"Update Product Family","description":"This endpoint allows you to update a specific information of a Product Family. If the specified Type does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Product Family after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Product Family. In order to update a Family, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchRestriction | Boolean | If true, the User has limited visibility in some branches |\n| descriptionBR | String | Product Family name in Brasilian Portuguese |\n| descriptionDE | String | Product Family name in German |\n| descriptionDK | String | Product Family name in Dutch |\n| descriptionEN | String | Product Family name in English |\n| descriptionES | String | Product Family name in Spanish |\n| descriptionFR | String | Product Family name in French |\n| descriptionIT | String | Product Family name in Italian |\n| descriptionPT | String | Product Family name in Portuguese |\n| descriptionRU | String | Product Family name in Russian |\n| descriptionUS | String | Product Family name in American English |\n| idParent | Integer | Unique identifier of the parent Product Family, for Product Families hierarchy purposes |\n| notAvailable | Boolean | If true, the Product Family is not available |\n\n**RESPONSE** \nReturns a JSON with information about the Product Family just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Families"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Product Family","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"branchRestriction":{"type":"boolean"},"descriptionEN":{"type":"string"},"idParent":{"type":"integer"}}},"examples":{"default":{"value":{"branchRestriction":false,"descriptionEN":"New Packs","idParent":138}}}}}}}},"/productFamilies/232":{"delete":{"operationId":"delete-product-family","summary":"Delete Product Family","description":"This endpoint allows you to delete a specific Product Family. If the specified Product Family does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete a Product Family after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Product Family to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Product Family just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Families"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Product Family","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/productCategories/schema":{"get":{"operationId":"product-categories-schema","summary":"Product Categories schema","description":"Returns properties object with the definition of each field in the Product Categories table. \nWith the Product Category you can classify each Product.\n\nYou will only receive the Product Category Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Product Category Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Categories"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"Product Categories schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"cLevel2":{"description":"","readOnly":false,"type":["integer","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"deleted":{"description":"","readOnly":false,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":false,"type":["integer","null"]}},"required":[],"title":"productCategories","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/productCategories":{"get":{"operationId":"list-product-categories","summary":"List Product Categories","description":"Returns all Product Categories available.\n\nYou will only receive the Product Categories after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Product Categories available for the value list.\n\nList of the supported Product Categories attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| cLevel2 | Integer | Unique identifier of the Product Family that the Product Category belongs to (see [Families](#) resource) |\n| descriptionBR | String | Product Category name in Brasilian Portuguese |\n| descriptionDE | String | Product Category name in German |\n| descriptionDK | String | Product Category name in Dutch |\n| descriptionEN | String | Product Category name in English |\n| descriptionES | String | Product Category name in Spanish |\n| descriptionFR | String | Product Category name in French |\n| descriptionIT | String | Product Category name in Italian |\n| descriptionPT | String | Product Category name in Portuguese |\n| descriptionRU | String | Product Category name in Russian |\n| descriptionUS | String | Product Category name in American English |\n| id | Integer | Unique identifier for the Product Category in ForceManager |\n| dateCreated | String | Date and time when the Product Category was created |\n| dateDeleted | String | Date and time when the Product Category was deleted |\n| dateUpdated | String | Date and time when the Product Category was last updated |\n| deleted | Boolean | If true, the Product Category has been deleted and archived |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Product Category |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Product Category |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Product Category |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Categories"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Product Categories","content":{"application/json":{"examples":{"default":{"value":[{"cLevel2":57,"dateCreated":"2009-10-15T19:23:32Z","dateDeleted":"2016-05-11T11:03:04.28Z","dateUpdated":"2009-10-15T19:23:32Z","deleted":true,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Business Licenses","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":127,"salesRepIdCreated":1,"salesRepIdDeleted":51,"salesRepIdUpdated":1},{"cLevel2":0,"dateCreated":"2018-10-29T17:09:44.933Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Performance Licenses","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":128,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-product-category","summary":"Create Product Category","description":"This endpoint allows you to create a Product Category based on JSON input.\n\nYou will only be able to create a Product Category after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| cLevel2 | Integer | Unique identifier of the Product Family that the Product Category belongs to (see [Families](#) resource) |\n| descriptionBR | String | Product Category name in Brasilian Portuguese |\n| descriptionDE | String | Product Category name in German |\n| descriptionDK | String | Product Category name in Dutch |\n| descriptionEN (*Required*) | String | Product Category name in English |\n| descriptionES | String | Product Category name in Spanish |\n| descriptionFR | String | Product Category name in French |\n| descriptionIT | String | Product Category name in Italian |\n| descriptionPT | String | Product Category name in Portuguese |\n| descriptionRU | String | Product Category name in Russian |\n| descriptionUS | String | Product Category name in American English |\n\n**RESPONSE** \nReturns a JSON with information about the Product Category just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Product Category |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Categories"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Product Category","content":{"application/json":{"examples":{"default":{"value":{"id":130,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"cLevel2":{"type":"integer"}}},"examples":{"default":{"value":{"descriptionEN":"Enterprise Licenses","cLevel2":20}}}}}}}},"/productCategories/{ID}":{"get":{"operationId":"get-product-category","summary":"Get Product Category","description":"This endpoint retrieves data of a specific Product Category based on JSON input. The API returns a single Product Category available to the user in the Value List, according to the unique ID provided. If the specified Category does not exist, the response will be a \"bad request\".\n\nYou will only receive the Product Category after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Product Category |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| cLevel2 | Integer | Unique identifier of the Product Family that the Product Category belongs to (see [Families](#) resource) |\n| descriptionBR | String | Product Category name in Brasilian Portuguese |\n| descriptionDE | String | Product Category name in German |\n| descriptionDK | String | Product Category name in Dutch |\n| descriptionEN (*Required*) | String | Product Category name in English |\n| descriptionES | String | Product Category name in Spanish |\n| descriptionFR | String | Product Category name in French |\n| descriptionIT | String | Product Category name in Italian |\n| descriptionPT | String | Product Category name in Portuguese |\n| descriptionRU | String | Product Category name in Russian |\n| descriptionUS | String | Product Category name in American English |\n| id | Integer | Unique identifier for the Product Category in ForceManager |\n| dateCreated | String | Date and time when the Product Category was created |\n| dateDeleted | String | Date and time when the Product Category was deleted |\n| dateUpdated | String | Date and time when the Product Category was last updated |\n| deleted | Boolean | If true, the Product Category has been deleted and archived |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Product Category |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Product Category |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Product Category |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Categories"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Product Category","content":{"application/json":{"examples":{"default":{"value":{"cLevel2":20,"dateCreated":"2021-12-09T10:54:20.923Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Enterprise Licenses","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":130,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-product-category","summary":"Update Product Category","description":"This endpoint allows you to update a specific information of a Product Category. If the specified Type does not exist, the response will be a \"bad request\".\n\nYou will only be able to update an Product Category after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Product Category. In order to update a Category, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| cLevel2 | Integer | Unique identifier of the Product Family that the Product Category belongs to (see [Families](#) resource) |\n| descriptionBR | String | Product Category name in Brasilian Portuguese |\n| descriptionDE | String | Product Category name in German |\n| descriptionDK | String | Product Category name in Dutch |\n| descriptionEN | String | Product Category name in English |\n| descriptionES | String | Product Category name in Spanish |\n| descriptionFR | String | Product Category name in French |\n| descriptionIT | String | Product Category name in Italian |\n| descriptionPT | String | Product Category name in Portuguese |\n| descriptionRU | String | Product Category name in Russian |\n| descriptionUS | String | Product Category name in American English |\n\n**RESPONSE** \nReturns a JSON with information about the Product Category just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Categories"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Product Category","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"cLevel2":{"type":"integer"}}},"examples":{"default":{"value":{"cLevel2":32}}}}}}},"delete":{"operationId":"delete-product-category","summary":"Delete Product Category","description":"This endpoint allows you to delete a specific Product Category. If the specified Product Category does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete an Product Category after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Product Category to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Product Category just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Categories"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Product Category","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/productRates/schema":{"get":{"operationId":"product-rates-schema","summary":"Product Rates schema","description":"Returns properties object with the definition of each field in the Product Rates table. \nWith the Product Rate you can associate a Rate to each Product.\n\nYou will only receive the Product Rate Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Product Rate Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"Product Rates schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"costPrice":{"description":"","readOnly":false,"type":["number","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":false,"type":["boolean","null"]},"discount1":{"description":"","readOnly":false,"type":["number","null"]},"discount2":{"description":"","readOnly":false,"type":["number","null"]},"discount3":{"description":"","readOnly":false,"type":["number","null"]},"discount4":{"description":"","readOnly":false,"type":["number","null"]},"productId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"products","type":["object","null"]},"rateId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"rates","type":["object","null"]},"salePrice":{"description":"","readOnly":false,"type":["number","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"tempBuyingPrice":{"description":"","readOnly":false,"type":["number","null"]},"tempListedPrice":{"description":"","readOnly":false,"type":["number","null"]}},"required":[],"title":"productRates","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/productRates":{"get":{"operationId":"list-product-rates","summary":"List Product Rates","description":"Returns all Product Rates available.\n\nYou will only receive the Product Rates after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Product Rates available for the value list.\n\nList of the supported Product Rates attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| costPrice | Number | Cost that can be applied to the Product |\n| discount1 | Number | First discount that can be applied to the Product, in percents |\n| discount2 | Number | Second discount that can be applied to the Product, in percents |\n| discount3 | Number | Third discount that can be applied to the Product, in percents |\n| discount4 | Number | Fourth discount that can be applied to the Product, in percents |\n| productId | Object, Null | ID of the Product to be associated with the Rate (see [Products](#) resource) |\n| rateId | Object, Null | ID of the Rate to be associated with the Product (see [Rates](#) resource) |\n| salePrice | Number | Price that can be applied to the Product |\n| tempBuyingPrice | Number | |\n| tempListedPrice | Number | |\n| id | Integer | Unique identifier for the Product Rate in ForceManager |\n| dateCreated | String | Date and time when the Product Rate was created |\n| dateDeleted | String | Date and time when the Product Rate was deleted |\n| dateUpdated | String | Date and time when the Product Rate was last updated |\n| deleted | Boolean | If true, the Product Rate has been deleted and archived |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Product Rate |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Product Rate |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Product Rate |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"OK"}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-product-rate","summary":"Create Product Rate","description":"This endpoint allows you to create a Product Rate based on JSON input.\n\nYou will only be able to create a Product Rate after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| costPrice | Number | Cost that can be applied to the Product |\n| discount1 | Number | First discount that can be applied to the Product, in percents |\n| discount2 | Number | Second discount that can be applied to the Product, in percents |\n| discount3 | Number | Third discount that can be applied to the Product, in percents |\n| discount4 | Number | Fourth discount that can be applied to the Product, in percents |\n| productId (*Required*) | Object, Null | ID of the Product to be associated with the Rate (see [Products](#) resource) |\n| rateId (*Required*) | Object, Null | ID of the Rate to be associated with the Product (see [Rates](#) resource) |\n| salePrice | Number | Price that can be applied to the Product |\n| tempBuyingPrice | Number | |\n| tempListedPrice | Number | |\n\n**RESPONSE** \nReturns a JSON with information about the Product Rate just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Product Rate |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Product Rate","content":{"application/json":{"examples":{"default":{"value":{"id":1,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"integer"},"discount1":{"type":"integer"},"discount2":{"type":"integer"},"discount3":{"type":"integer"},"discount4":{"type":"integer"},"productId":{"type":"integer"},"rateId":{"type":"integer"},"salePrice":{"type":"integer"},"tempBuyingPrice":{"type":"integer"},"tempListedPrice":{"type":"integer"}}},"examples":{"default":{"value":{"costPrice":1000,"discount1":5,"discount2":0,"discount3":0,"discount4":0,"productId":1,"rateId":2,"salePrice":2500,"tempBuyingPrice":0,"tempListedPrice":0}}}}}}}},"/productRates/{ID}":{"get":{"operationId":"get-product-rate","summary":"Get Product Rate","description":"This endpoint retrieves data of a specific Product Rate based on JSON input. The API returns a single Product Rate available to the user in the Value List, according to the unique ID provided. If the specified Rate does not exist, the response will be a \"bad request\".\n\nYou will only receive the Product Rate after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | */* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Product Rate |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| costPrice | Number | Cost that can be applied to the Product |\n| discount1 | Number | First discount that can be applied to the Product, in percents |\n| discount2 | Number | Second discount that can be applied to the Product, in percents |\n| discount3 | Number | Third discount that can be applied to the Product, in percents |\n| discount4 | Number | Fourth discount that can be applied to the Product, in percents |\n| productId | Object, Null | ID of the Product to be associated with the Rate (see [Products](#) resource) |\n| rateId | Object, Null | ID of the Rate to be associated with the Product (see [Rates](#) resource) |\n| salePrice | Number | Price that can be applied to the Product |\n| tempBuyingPrice | Number | |\n| tempListedPrice | Number | |\n| id | Integer | Unique identifier for the Product Rate in ForceManager |\n| dateCreated | String | Date and time when the Product Rate was created |\n| dateDeleted | String | Date and time when the Product Rate was deleted |\n| dateUpdated | String | Date and time when the Product Rate was last updated |\n| deleted | Boolean | If true, the Product Rate has been deleted and archived |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Product Rate |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Product Rate |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Product Rate |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Product Rate","content":{"application/json":{"examples":{"default":{"value":{"costPrice":1000,"dateCreated":"2021-12-16T23:47:00.44Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"discount1":5,"discount2":0,"discount3":0,"discount4":0,"productId":{"id":1,"value":""},"rateId":{"id":2,"value":""},"salePrice":2500,"salesRepIdCreated":90,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"tempBuyingPrice":0,"tempListedPrice":0}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-product-rate","summary":"Update Product Rate","description":"This endpoint allows you to update a specific information of a Product Rate. If the specified Type does not exist, the response will be a \"bad request\".\n\nYou will only be able to update an Product Rate after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Product 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| costPrice | Number | Cost that can be applied to the Product |\n| discount1 | Number | First discount that can be applied to the Product, in percents |\n| discount2 | Number | Second discount that can be applied to the Product, in percents |\n| discount3 | Number | Third discount that can be applied to the Product, in percents |\n| discount4 | Number | Fourth discount that can be applied to the Product, in percents |\n| productId | Object, Null | ID of the Product to be associated with the Rate (see [Products](#) resource) |\n| rateId | Object, Null | ID of the Rate to be associated with the Product (see [Rates](#) resource) |\n| salePrice | Number | Price that can be applied to the Product |\n| tempBuyingPrice | Number | |\n| tempListedPrice | Number | |\n\n**RESPONSE** \nReturns a JSON with information about the Product Rate just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Product Rate","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"costPrice":{"type":"integer"},"salePrice":{"type":"integer"}}},"examples":{"default":{"value":{"costPrice":800,"salePrice":3000}}}}}}},"delete":{"operationId":"delete-product-rate","summary":"Delete Product Rate","description":"This endpoint allows you to delete a specific Product Rate. If the specified Product Rate does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete an Product Rate after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | */* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Product Rate to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Product Rate just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Products / Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Product Rate","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/rates/schema":{"get":{"operationId":"rates-schema","summary":"Rates schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Rate object.\n\nYou will only receive the Rate Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**RESPONSE**\n\nThe Rates schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n|**Attribute**|**Type**|**Description**|\n| --- | --- | --- |\n| Table | String | The name of the values list table |\n| Type | Object, Null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Rates schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"Comments":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"branchId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"branches","type":["object","null"]},"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"currencyId":{"description":"","readOnly":false,"type":["integer","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"endDate":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"extID":{"description":"","maxLength":50,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"startDate":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]}},"required":[],"title":"rates","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/rates":{"get":{"operationId":"list-rates","summary":"List Rates","description":"Returns all Rates available in the user's ForceManager implementation database.\n\nYou 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](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/rates?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/rates?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Rates by `dateCreated` and `id` for example.\n\nYou 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.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/rates?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/rates?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Rates available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Rates attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchId | Object, Null | Branch the Rate is assigned to |\n| branchVisibility | Object, Null | In which Branch the Rate is visible |\n| comments | String | A comment to be added to the Rate |\n| currencyId | Integer | Currency type e.g. Dollar, Euro, etc. (see [Currencies](#) resource) |\n| dateCreated | String | Date and time when the Rate was created |\n| dateDeleted | String | Date and time when the Rate was deleted |\n| dateUpdated | String | Date and time when the Rate was last updated |\n| deleted | boolean | If true, the Rate has been deleted and archived |\n| descriptionBR | String | Rate label in Brasilian Portuguese |\n| descriptionDE | String | Rate label in German |\n| descriptionDK | String | Rate label in Dutch |\n| descriptionEN (_Required_) | String | Rate label in English |\n| descriptionES | String | Rate label in Spanish |\n| descriptionFR | String | Rate label in French |\n| descriptionIT | String | Rate label in Italian |\n| descriptionPT | String | Rate label in Portuguese |\n| descriptionRU | String | Rate label in Russian |\n| descriptionUS | String | Rate label in American English |\n| endDate | String | Date when the Rate expires |\n| extID | String | External ID of the Rate from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | Unique identifier of the Rate in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Rate |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Rate |\n| salesRepIdUpdated | Integer | Unique identifier of the User who last updated the Rate |\n| startDate | String | Date when the Rate starts |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Rates","content":{"application/json":{"examples":{"default":{"value":[{"Comments":"","branchId":{"id":16,"value":"Main Environment"},"branchVisibility":[{"id":16,"value":"Main Environment"}],"currencyId":1,"dateCreated":"2021-04-26T16:47:10.1Z","dateDeleted":null,"dateUpdated":"2021-04-26T16:47:23.127Z","deleted":false,"descriptionBR":"","descriptionDE":"","descriptionDK":"","descriptionEN":"","descriptionES":"","descriptionFR":"","descriptionIT":"","descriptionPT":"","descriptionRU":"","descriptionUS":"Premium","endDate":null,"extID":null,"id":1,"salesRepIdCreated":105,"salesRepIdDeleted":null,"salesRepIdUpdated":105,"startDate":"2021-04-26T16:47:23.127Z"}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-rate","summary":"Create Rate","description":"This endpoint allows you to create a Rate based on JSON input.\n\nYou will only be able to create a Rate after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchId | Integer | Branch the Rate is assigned to |\n| branchVisibility | Array | In which Branch the Rate is visible |\n| comments | String | A comment to be added to the Rate |\n| currencyId | Integer | Currency type e.g. Dollar, Euro, etc. (see [Currencies](#) resource) |\n| descriptionBR | String | Rate label in Brasilian Portuguese |\n| descriptionDE | String | Rate label in German |\n| descriptionDK | String | Rate label in Dutch |\n| descriptionEN | String | Rate label in English |\n| descriptionES (*Required*) | String | Rate label in Spanish |\n| descriptionFR | String | Rate label in French |\n| descriptionIT | String | Rate label in Italian |\n| descriptionPT | String | Rate label in Portuguese |\n| descriptionRU | String | Rate label in Russian |\n| descriptionUS | String | Rate label in American English |\n| endDate | String | Date when the Rate expires |\n| extID | String | External ID of the Rate from a third party system (ERP, CRM, Accounting System) |\n| startDate | String | Date when the Rate starts |\n\n**RESPONSE**\n\nReturns a JSON with information about the Rate just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Opportunity |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Rate","content":{"application/json":{"examples":{"default":{"value":{"id":14,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionES":{"type":"string"},"branchId":{"type":"integer"},"comments":{"type":"string"},"currencyId":{"type":"integer"},"startDate":{"type":"string"},"endDate":{"type":"string"}}},"examples":{"default":{"value":{"descriptionES":"Gold","branchId":16,"comments":"This is the higher rate","currencyId":1,"startDate":"2020-12-01","endDate":"2021-12-01"}}}}}}}},"/rates/{ID}":{"get":{"operationId":"get-rate","summary":"Get Rate","description":"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\".\n\nYou will only receive the Rate after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | integer | The unique and specific identifier of the Rate |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchId | Object, Null | Branch the Rate is assigned to |\n| branchVisibility | Object, Null | In which Branch the Rate is visible |\n| comments | String | A comment to be added to the Rate |\n| currencyId | Integer | Currency type e.g. Dollar, Euro, etc. (see [Currencies](#) resource) |\n| dateCreated | String | Date and time when the Rate was created |\n| dateDeleted | String | Date and time when the Rate was deleted |\n| dateUpdated | String | Date and time when the Rate was last updated |\n| deleted | boolean | If true, the Rate has been deleted and archived |\n| descriptionBR | String | Rate label in Brasilian Portuguese |\n| descriptionDE | String | Rate label in German |\n| descriptionDK | String | Rate label in Dutch |\n| descriptionEN (*Required*) | String | Rate label in English |\n| descriptionES | String | Rate label in Spanish |\n| descriptionFR | String | Rate label in French |\n| descriptionIT | String | Rate label in Italian |\n| descriptionPT | String | Rate label in Portuguese |\n| descriptionRU | String | Rate label in Russian |\n| descriptionUS | String | Rate label in American English |\n| endDate | String | Date when the Rate expires |\n| extID | String | External ID of the Rate from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | Unique identifier of the Rate in ForceManager |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Rate |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Rate |\n| salesRepIdUpdated | Integer | Unique identifier of the User who last updated the Rate |\n| startDate | String | Date when the Rate starts |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Rate","content":{"application/json":{"examples":{"default":{"value":{"Comments":"","branchId":{"id":16,"value":"Main Environment"},"branchVisibility":[{"id":16,"value":"Main Environment"}],"currencyId":1,"dateCreated":"2021-04-26T16:47:10.1Z","dateDeleted":null,"dateUpdated":"2021-04-26T16:47:23.127Z","deleted":false,"descriptionBR":"","descriptionDE":"","descriptionDK":"","descriptionEN":"","descriptionES":"","descriptionFR":"","descriptionIT":"","descriptionPT":"","descriptionRU":"","descriptionUS":"Premium","endDate":null,"extID":null,"id":1,"salesRepIdCreated":105,"salesRepIdDeleted":null,"salesRepIdUpdated":105,"startDate":"2021-04-26T16:47:23.127Z"}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-rate","summary":"Update Rate","description":"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\".\n\nYou 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](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branchId | Integer | Branch the Rate is assigned to |\n| branchVisibility | Array | In which Branch the Rate is visible |\n| comments | String | A comment to be added to the Rate |\n| currencyId | Integer | Currency type e.g. Dollar, Euro, etc. (see [Currencies](#) resource) |\n| descriptionBR | String | Rate label in Brasilian Portuguese |\n| descriptionDE | String | Rate label in German |\n| descriptionDK | String | Rate label in Dutch |\n| descriptionEN | String | Rate label in English |\n| descriptionES | String | Rate label in Spanish |\n| descriptionFR | String | Rate label in French |\n| descriptionIT | String | Rate label in Italian |\n| descriptionPT | String | Rate label in Portuguese |\n| descriptionRU | String | Rate label in Russian |\n| descriptionUS | String | Rate label in American English |\n| endDate | String | Date when the Rate expires |\n| extID | String | External ID of the Rate from a third party system (ERP, CRM, Accounting System) |\n| startDate | String | Date when the Rate starts |\n\n**RESPONSE**\n\nReturns a JSON with information about the Rate just updated.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Rate","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"branchId":{"type":"integer"},"branchVisibility":{"type":"array"}}},"examples":{"default":{"value":{"descriptionEN":"Gold","branchId":16,"branchVisibility":[16]}}}}}}},"delete":{"operationId":"delete-rate","summary":"Delete Rate","description":"This endpoint allows you to delete a specific Rate from the user's ForceManager implementation database. If the specified Rate does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete a Rate after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Rate to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Rate just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Rates"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Rate","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountsRelated/schema":{"get":{"operationId":"related-accounts-schema","summary":"Related Accounts schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Related Account object.\n\nYou will only receive the Related Accounts Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Related Accounts Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Table | String | The name of the values list table |\n| Type | Object, Null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Related Accounts schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"accountOneId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"accountTwoId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"deleted":{"description":"","readOnly":false,"type":["boolean","null"]},"id":{"description":"","readOnly":false,"type":["integer","null"]},"relationId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accountsRelations","type":["object","null"]},"salesRepIdCreated":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":false,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":false,"type":["integer","null"]}},"required":["accountOneId","accountTwoId","relationId"],"title":"accountsRelated","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountsRelated":{"get":{"operationId":"list-related-accounts","summary":"List Related Accounts","description":"Returns all Related Accounts available in the user's ForceManager implementation database.\n\nYou will only receive the List of Related Accounts after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/accountsRelated?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/accountsRelated?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can also **organise and view** the results for Related Accounts in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/accountsRelated?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/accountsRelated?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Related Accounts available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Related Accounts attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountOneId | Number, Null | First Account to be referred to the relationships |\n| accountTwoId | Number, Null | Second Account to be referred to the relationships |\n| relationId | Number, Null | Related Account Type that defines the type of the relationships (see [Types](#) resource) |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Related Accounts","content":{"application/json":{"examples":{"default":{"value":[{"accountOneId":{"id":963,"value":"ACME INC."},"accountTwoId":{"id":969,"value":"HOLDING S.P.A."},"dateCreated":"2021-10-25T15:32:46.65Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"id":1,"relationId":{"id":1,"value":"Relacionadas"},"salesRepIdCreated":98,"salesRepIdDeleted":null,"salesRepIdUpdated":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-related-account","summary":"Create Related Account","description":"This endpoint allows you to create a Related Account based on JSON input. \n\nYou will only be able to create a Related Account after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| accountOneId (*Required*) | Integer | First Account to be referred to the relationships |\n| accountTwoId (*Required*) | Integer | Second Account to be referred to the relationships |\n| relationId (*Required*) | Integer | Related Account Type that defines the type of the relationships (see [Types](#) resource) |\n
\n\n**RESPONSE**\n\nReturns a JSON with information about the Related Account just created.\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| id | Integer | Id assigned to the new Related Account |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Related Account","content":{"application/json":{"examples":{"default":{"value":{"id":1,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountOneId":{"type":"integer"},"accountTwoId":{"type":"integer"},"relationId":{"type":"integer"}}},"examples":{"default":{"value":{"accountOneId":963,"accountTwoId":969,"relationId":1}}}}}}}},"/accountsRelated/{ID}":{"get":{"operationId":"retrieve-related-account","summary":"Retrieve Related Account","description":"This endpoint retrieves data of a specific Related Account based on JSON input. The API returns a single Related Account available to the user, according to the unique ID provided. If the specified Related Account does not exist, the response will be a \"bad request\".\n\nYou will only receive the Related Account after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier for the Related Account |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountOneId | Number, Null | First Account to be referred to the relationships |\n| accountTwoId | Number, Null | Second Account to be referred to the relationships |\n| relationId | Number, Null | Related Account Type that defines the type of the relationships (see [Types](#) resource) |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Retrieve Related Account","content":{"application/json":{"examples":{"default":{"value":{"accountOneId":{"id":963,"value":"ACME INC."},"accountTwoId":{"id":969,"value":"HOLDING S.P.A."},"dateCreated":"2021-10-25T15:32:46.65Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"id":1,"relationId":{"id":1,"value":"Relacionadas"},"salesRepIdCreated":98,"salesRepIdDeleted":null,"salesRepIdUpdated":null}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-related-account","summary":"Update Related Account","description":"The endpoint allows you to update a specific Related Account information from the user's ForceManager implementation database. If the specified Related Account does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Related Account after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\*| Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Related Account. In order to update a Related Account, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountOneId (*Required*) | Integer | First Account to be referred to the relationships |\n| accountTwoId (*Required*) | Integer | Second Account to be referred to the relationships |\n| relationId (*Required*) | Integer | Related Account Type that defines the type of the relationships (see [Types](#) resource) |\n\n**RESPONSE**\n\nReturns a JSON with information about the Related Account just updated.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Related Account","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountOneId":{"type":"integer"},"accountTwoId":{"type":"integer"},"relationId":{"type":"integer"}}},"examples":{"default":{"value":{"accountOneId":963,"accountTwoId":971,"relationId":2}}}}}}},"delete":{"operationId":"delete-related-account","summary":"Delete Related Account","description":"This endpoint allows you to delete a specific Related Account from the user's ForceManager implementation database. If the specified Related Account does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Related Accounts after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Related Account to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Related Account just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Related Account","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountsRelations/schema":{"get":{"operationId":"related-account-types-schema","summary":"Related Account Types schema","description":"Returns properties object with the definition of each field in the Related Account Type table.\n\nWith the Related Account Type you can differentiate the Type of Relation.\n\nYou will only receive the Related Account Types Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Related Account Types Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"Related Account Types schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"reverseDescriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"reverseDescriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"reverseDescriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"reverseDescriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"reverseDescriptionES":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"reverseDescriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"reverseDescriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"reverseDescriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"reverseDescriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"reverseDescriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]}},"required":[],"title":"accountsRelations","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/accountsRelations":{"get":{"operationId":"list-related-account-types","summary":"List Related Account Types","description":"Returns all Related Account Types available, based on JSON input.\n\nYou will only receive the Related Account Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Related Account Types available.\n\nList of the supported Related Account Types attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| descriptionBR | String | Direct relationship name of the Related Account Type in Brasilian Portuguese |\n| descriptionDE | String | Direct relationship name of the Related Account Type in German |\n| descriptionDK | String | Direct relationship name of the Related Account Type in Dutch |\n| descriptionEN | String | Direct relationship name of the Related Account Type in English |\n| descriptionES | String | Direct relationship name of the Related Account Type in Spanish |\n| descriptionFR | String | Direct relationship name of the Related Account Type in French |\n| descriptionIT | String | Direct relationship name of the Related Account Type in Italian |\n| descriptionPT | String | Direct relationship name of the Related Account Type in Portuguese |\n| descriptionRU | String | Direct relationship name of the Related Account Type in Russian |\n| descriptionUS | String | Direct relationship name of the Related Account Type in American English |\n| reverseDescriptionBR | String | Inverse relationship name of the Related Account Type in Brasilian Portuguese |\n| reverseDescriptionDE | String | Inverse relationship name of the Related Account Type in German |\n| reverseDescriptionDK | String | Inverse relationship name of the Related Account Type in Dutch |\n| reverseDescriptionEN | String | Inverse relationship name of the Related Account Type in English |\n| reverseDescriptionES | String | Inverse relationship name of the Related Account Type in Spanish |\n| reverseDescriptionFR | String | Inverse relationship name of the Related Account Type in French |\n| reverseDescriptionIT | String | Inverse relationship name of the Related Account Type in Italian |\n| reverseDescriptionPT | String | Inverse relationship name of the Related Account Type in Portuguese |\n| reverseDescriptionRU | String | Inverse relationship name of the Related Account Type in Russian |\n| reverseDescriptionUS | String | Inverse relationship name of the Related Account Type in American English |\n| id | Integer | Unique identifier for the Related Account Type in ForceManager |\n| dateCreated | String | Date and time when the Related Account Type was created |\n| dateDeleted | String | Date and time when the Related Account Type was deleted |\n| dateUpdated | String | Date and time when the Related Account Type was last updated |\n| deleted | Boolean | If true, the Related Account Type has been deleted and archived |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Related Account Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Related Account Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Related Account Type |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Related Account Types","content":{"application/json":{"examples":{"default":{"value":[{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"Verwandt","descriptionDK":null,"descriptionEN":"Related","descriptionES":"Relacionadas","descriptionFR":null,"descriptionIT":"Relazionate","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"reverseDescriptionBR":null,"reverseDescriptionDE":null,"reverseDescriptionDK":null,"reverseDescriptionEN":null,"reverseDescriptionES":null,"reverseDescriptionFR":null,"reverseDescriptionIT":null,"reverseDescriptionPT":null,"reverseDescriptionRU":null,"reverseDescriptionUS":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null},{"dateCreated":"2021-10-25T12:46:04.017Z","dateDeleted":"2021-10-25T12:46:14.477Z","dateUpdated":null,"deleted":true,"descriptionBR":null,"descriptionDE":null,"descriptionDK":null,"descriptionEN":"Holding","descriptionES":null,"descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":2,"reverseDescriptionBR":null,"reverseDescriptionDE":null,"reverseDescriptionDK":null,"reverseDescriptionEN":"Subsidiary","reverseDescriptionES":null,"reverseDescriptionFR":null,"reverseDescriptionIT":null,"reverseDescriptionPT":null,"reverseDescriptionRU":null,"reverseDescriptionUS":null,"salesRepIdCreated":98,"salesRepIdDeleted":98,"salesRepIdUpdated":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-related-account-type","summary":"Create Related Account Type","description":"This endpoint allows you to create a Related Account Type based on JSON input.\n\nYou will only be able to create a Related Account Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| descriptionBR | String | Direct relationship name of the Related Account Type in Brasilian Portuguese |\n| descriptionDE | String | Direct relationship name of the Related Account Type in German |\n| descriptionDK | String | Direct relationship name of the Related Account Type in Dutch |\n| descriptionEN (*Required*) | String | Direct relationship name of the Related Account Type in English |\n| descriptionES | String | Direct relationship name of the Related Account Type in Spanish |\n| descriptionFR | String | Direct relationship name of the Related Account Type in French |\n| descriptionIT | String | Direct relationship name of the Related Account Type in Italian |\n| descriptionPT | String | Direct relationship name of the Related Account Type in Portuguese |\n| descriptionRU | String | Direct relationship name of the Related Account Type in Russian |\n| descriptionUS | String | Direct relationship name of the Related Account Type in American English |\n| reverseDescriptionBR | String | Inverse relationship name of the Related Account Type in Brasilian Portuguese |\n| reverseDescriptionDE | String | Inverse relationship name of the Related Account Type in German |\n| reverseDescriptionDK | String | Inverse relationship name of the Related Account Type in Dutch |\n| reverseDescriptionEN | String | Inverse relationship name of the Related Account Type in English |\n| reverseDescriptionES | String | Inverse relationship name of the Related Account Type in Spanish |\n| reverseDescriptionFR | String | Inverse relationship name of the Related Account Type in French |\n| reverseDescriptionIT | String | Inverse relationship name of the Related Account Type in Italian |\n| reverseDescriptionPT | String | Inverse relationship name of the Related Account Type in Portuguese |\n| reverseDescriptionRU | String | Inverse relationship name of the Related Account Type in Russian |\n| reverseDescriptionUS | String | Inverse relationship name of the Related Account Type in American English |\n\n**RESPONSE**\n\nReturns a JSON with information about the Related Account Type just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Related Account Type |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Related Account Type","content":{"application/json":{"examples":{"default":{"value":{"id":2,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"},"reverseDescriptionEN":{"type":"string"}}},"examples":{"default":{"value":{"descriptionEN":"Holding","reverseDescriptionEN":"Subsidiary"}}}}}}}},"/accountsRelations/{ID}":{"get":{"operationId":"retrieve-related-account-type","summary":"Retrieve Related Account Type","description":"This endpoint retrieves data of a specific Related Account Type based on JSON input. The API returns a single Type available to the user in the Value List, according to the unique ID provided. If the specified Related Account Type does not exist, the response will be a \"bad request\".\n\nYou will only receive the Related Account Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Related Account Type |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| descriptionBR | String | Direct relationship name of the Related Account Type in Brasilian Portuguese |\n| descriptionDE | String | Direct relationship name of the Related Account Type in German |\n| descriptionDK | String | Direct relationship name of the Related Account Type in Dutch |\n| descriptionEN | String | Direct relationship name of the Related Account Type in English |\n| descriptionES | String | Direct relationship name of the Related Account Type in Spanish |\n| descriptionFR | String | Direct relationship name of the Related Account Type in French |\n| descriptionIT | String | Direct relationship name of the Related Account Type in Italian |\n| descriptionPT | String | Direct relationship name of the Related Account Type in Portuguese |\n| descriptionRU | String | Direct relationship name of the Related Account Type in Russian |\n| descriptionUS | String | Direct relationship name of the Related Account Type in American English |\n| reverseDescriptionBR | String | Inverse relationship name of the Related Account Type in Brasilian Portuguese |\n| reverseDescriptionDE | String | Inverse relationship name of the Related Account Type in German |\n| reverseDescriptionDK | String | Inverse relationship name of the Related Account Type in Dutch |\n| reverseDescriptionEN | String | Inverse relationship name of the Related Account Type in English |\n| reverseDescriptionES | String | Inverse relationship name of the Related Account Type in Spanish |\n| reverseDescriptionFR | String | Inverse relationship name of the Related Account Type in French |\n| reverseDescriptionIT | String | Inverse relationship name of the Related Account Type in Italian |\n| reverseDescriptionPT | String | Inverse relationship name of the Related Account Type in Portuguese |\n| reverseDescriptionRU | String | Inverse relationship name of the Related Account Type in Russian |\n| reverseDescriptionUS | String | Inverse relationship name of the Related Account Type in American English |\n| id | Integer | Unique identifier for the Related Account Type in ForceManager |\n| dateCreated | String | Date and time when the Related Account Type was created |\n| dateDeleted | String | Date and time when the Related Account Type was deleted |\n| dateUpdated | String | Date and time when the Related Account Type was last updated |\n| deleted | Boolean | If true, the Related Account Type has been deleted and archived |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Related Account Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Related Account Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the Related Account Type |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Retrieve Related Account Type","content":{"application/json":{"examples":{"default":{"value":{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"Verwandt","descriptionDK":null,"descriptionEN":"Related","descriptionES":"Relacionadas","descriptionFR":null,"descriptionIT":"Relazionate","descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"reverseDescriptionBR":null,"reverseDescriptionDE":null,"reverseDescriptionDK":null,"reverseDescriptionEN":null,"reverseDescriptionES":null,"reverseDescriptionFR":null,"reverseDescriptionIT":null,"reverseDescriptionPT":null,"reverseDescriptionRU":null,"reverseDescriptionUS":null,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-related-account-type","summary":"Update Related Account Type","description":"This endpoint allows you to update a specific Related Account Type. If the specified Type does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Related Account Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Related Account Type. In order to update a Type, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| descriptionBR | String | Direct relationship name of the Related Account Type in Brasilian Portuguese |\n| descriptionDE | String | Direct relationship name of the Related Account Type in German |\n| descriptionDK | String | Direct relationship name of the Related Account Type in Dutch |\n| descriptionEN | String | Direct relationship name of the Related Account Type in English |\n| descriptionES | String | Direct relationship name of the Related Account Type in Spanish |\n| descriptionFR | String | Direct relationship name of the Related Account Type in French |\n| descriptionIT | String | Direct relationship name of the Related Account Type in Italian |\n| descriptionPT | String | Direct relationship name of the Related Account Type in Portuguese |\n| descriptionRU | String | Direct relationship name of the Related Account Type in Russian |\n| descriptionUS | String | Direct relationship name of the Related Account Type in American English |\n| reverseDescriptionBR | String | Inverse relationship name of the Related Account Type in Brasilian Portuguese |\n| reverseDescriptionDE | String | Inverse relationship name of the Related Account Type in German |\n| reverseDescriptionDK | String | Inverse relationship name of the Related Account Type in Dutch |\n| reverseDescriptionEN | String | Inverse relationship name of the Related Account Type in English |\n| reverseDescriptionES | String | Inverse relationship name of the Related Account Type in Spanish |\n| reverseDescriptionFR | String | Inverse relationship name of the Related Account Type in French |\n| reverseDescriptionIT | String | Inverse relationship name of the Related Account Type in Italian |\n| reverseDescriptionPT | String | Inverse relationship name of the Related Account Type in Portuguese |\n| reverseDescriptionRU | String | Inverse relationship name of the Related Account Type in Russian |\n| reverseDescriptionUS | String | Inverse relationship name of the Related Account Type in American English |\n\n**RESPONSE**\n\nReturns a JSON with information about the Related Account Type just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Related Account Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"}}},"examples":{"default":{"value":{"descriptionEN":"Related"}}}}}}},"delete":{"operationId":"delete-related-account-type","summary":"Delete Related Account Type","description":"This endpoint allows you to delete a specific Related Account Type from the user's ForceManager implementation database. If the specified Related Account Type does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Related Account Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Related Account Type to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Related Account Type just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Related Accounts / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Related Account Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/resources":{"get":{"operationId":"get-resources","summary":"Get Resources","description":"This endpoint retrieves all the methods available in the API on JSON input.\n\nYou will only receive the Resource's information after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Accept any data of whatever mime type |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| description | String | The endpoint description. (Extra information to get more context) |\n| end_point | String | The method's url |\n| operations | Object | This object contains the CRUD operations available in a JSON Object |\n| schema | String | The schema's url for this method |\n\nThe operations object contains the following structure\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| create | Boolean | True if the create method is available, otherwise False |\n| delete | Boolean | True if the create method is available, otherwise False |\n| read | Boolean | True if the create method is available, otherwise False |\n| update | Boolean | True if the create method is available, otherwise False |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Resources"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"Get Resources","content":{"application/json":{"examples":{"default":{"value":[{"end_point":"/v4/opportunityStatuses","description":"","schema":"/v4/opportunityStatuses/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/activityTypes","description":"","schema":"/v4/activityTypes/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/branches","description":"","schema":"/v4/branches/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/contactTypes","description":"","schema":"/v4/contactTypes/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/accountTypes","description":"","schema":"/v4/accountTypes/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/rates","description":"","schema":"/v4/rates/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/accountSegments","description":"","schema":"/v4/accountSegments/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/quoteTypes","description":"","schema":"/v4/quoteTypes/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/accountStatuses","description":"","schema":"/v4/accountStatuses/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/salesorderStatuses","description":"","schema":"/v4/salesorderStatuses/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/accounts","description":"","schema":"/v4/accounts/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/contacts","description":"","schema":"/v4/contacts/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/opportunities","description":"","schema":"/v4/opportunities/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/activities","description":"","schema":"/v4/activities/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/quotes","description":"","schema":"/v4/quotes/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/lineQuotes","description":"","schema":"/v4/lineQuotes/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/calendar","description":"","schema":"/v4/calendar/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/calendarAttendees","description":"","schema":"/v4/calendarAttendees/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/sales","description":"","schema":"/v4/sales/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/salesorders","description":"","schema":"/v4/salesorders/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/salesordersLines","description":"","schema":"/v4/salesordersLines/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/accountAddresses","description":"","schema":"/v4/accountAddresses/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/products","description":"","schema":"/v4/products/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/mailchimpCampaign","description":"","schema":"/v4/mailchimpCampaign/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/mailchimpEmailActivity","description":"","schema":"/v4/mailchimpEmailActivity/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/tblcustomActivity","description":"","schema":"/v4/tblcustomActivity/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/countries","description":"","schema":"/v4/countries/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/users","description":"","schema":"/v4/users/schema","operations":{"create":true,"read":true,"update":false,"delete":false}},{"end_point":"/v4/externalIds","description":"","schema":"/v4/externalIds/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/externalIntegrationLog","description":"","schema":"/v4/externalIntegrationLog/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/externalProvider","description":"","schema":"/v4/externalProvider/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/currencies","description":"","schema":"/v4/currencies/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/productCategories","description":"","schema":"/v4/productCategories/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/productFamilies","description":"","schema":"/v4/productFamilies/schema","operations":{"create":true,"read":true,"update":true,"delete":true}},{"end_point":"/v4/opportunityTypes","description":"","schema":"/v4/opportunityTypes/schema","operations":{"create":true,"read":true,"update":true,"delete":true}}]}}}}}},"security":[{"SessionKey":[]}]}},"/roles/schema":{"get":{"operationId":"roles-schema","summary":"Roles schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Roles object.\n\nYou will only receive the Roles Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | The acceptance |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Roles schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Table | String | The name of the values list table |\n| Type | Object, null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Roles"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Roles schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branches":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]}},"dataDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"extId":{"maxLength":100,"readOnly":false,"type":["string","null"]},"id":{"readOnly":true,"type":["integer","null"]},"level":{"readOnly":false,"type":["integer","null"]},"name":{"maxLength":180,"readOnly":false,"type":["string","null"]},"salesRepIdCreated":{"readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"readOnly":true,"type":["integer","null"]}},"required":[],"title":"roles","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/roles":{"get":{"operationId":"list-roles","summary":"List Roles","description":"Returns all Roles available in the user's ForceManager account database based on JSON input.\n\nYou will only receive the List of Roles after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/users?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/roles?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Roles by `name` for example.\n\nYou can also **organise and view** the results for Roles in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/roles?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/roles?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Roles available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Roles attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branches | Object, Null | List of the user branches |\n| extId | Integer | External ID of the User from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The unique identifier of the Role in ForceManager |\n| level | Integer | Between 1-5. The priority of this role, being 1 minor and 5 major |\n| name | String | The name of the role |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Roles"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Roles","content":{"application/json":{"examples":{"default":{"value":[{"id":30,"extId":null,"level":2,"name":"Sales Role","branches":[16,18],"salesRepIdDeleted":0,"salesRepIdCreated":1,"salesRepIdUpdated":0,"dateCreated":"2008-01-02T00:21:38Z","dateUpdated":"2021-02-24T12:22:31.357Z","dateDeleted":"1899-12-30T00:00:00Z","deleted":false},{"id":33,"extId":null,"level":3,"name":"Sales Manager Role","branches":[],"salesRepIdDeleted":0,"salesRepIdCreated":1,"salesRepIdUpdated":0,"dateCreated":"2008-01-02T00:21:38Z","dateUpdated":"2021-02-25T18:27:32.847Z","dateDeleted":"1899-12-30T00:00:00Z","deleted":false},{"id":54,"extId":null,"level":5,"name":"WebService Role","branches":[],"salesRepIdDeleted":null,"salesRepIdCreated":51,"salesRepIdUpdated":0,"dateCreated":"2013-01-10T11:14:19.75Z","dateUpdated":"2021-02-24T12:23:22.257Z","dateDeleted":null,"deleted":false},{"id":89,"extId":null,"level":5,"name":"Sales Director","branches":[],"salesRepIdDeleted":null,"salesRepIdCreated":51,"salesRepIdUpdated":null,"dateCreated":"2021-02-25T19:16:44.527Z","dateUpdated":null,"dateDeleted":null,"deleted":false}]}}}}}},"security":[{"SessionKey":[]}]}},"/roles/{ID}":{"get":{"operationId":"get-role","summary":"Get Role","description":"This endpoint retrieves data of a specific Role based on JSON input. The API returns a single Role available to the user, according to the unique ID provided. If the specified Role does not exist, the response will be a \"bad request\".\n\nYou will only receive the Role's information after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | integer | The unique and specific identifier of the Role |\n\n**RESPONSE BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| branches | Object | List of the Role Branches |\n| extId | Integer | External ID of the Role from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The unique identifier of the Role in ForceManager |\n| level | Integer | Between 1-5. The priority of this role, being 1 minor and 5 major |\n| name | String | The name of the role |\n| dateCreated | String | Date and time when the Role was created |\n| dateDeleted | String | Date and time when the Role was deleted |\n| dateUpdated | String | Date and time when the Role was last updated |\n| deleted | Boolean | If true, the Role has been deleted and archived |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Role |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Role |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Role |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Roles"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [optional]"}],"responses":{"200":{"description":"Get Role","content":{"application/json":{"examples":{"default":{"value":{"id":30,"extId":null,"level":2,"name":"Sales Role","branches":null,"salesRepIdDeleted":0,"salesRepIdCreated":1,"salesRepIdUpdated":0,"dateCreated":"2008-01-02T00:21:38Z","dateUpdated":"2021-02-24T12:22:31.357Z","dateDeleted":"1899-12-30T00:00:00Z","deleted":false}}}}}}},"security":[{"SessionKey":[]}]}},"/users/{ID}/roles":{"get":{"operationId":"list-roles-of-user","summary":"List Roles of User","description":"Returns all the Roles assigned to the user in ForceManager account database based on JSON input.\n
You will only receive the List of Roles associated to the defined user after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns information about the Roles associated to the defined user available in the database. \n\nIf you didn't apply any page or count number in the header the default number of records in the response is 100.\n\nList of the supported Users attributes:\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| branches | Object, Null | List of the Role branches |\n| extId | Integer | External ID of the Role from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The unique identifier of the Role in ForceManager |\n| level | Integer | Between 1-5. The priority of this Role, being 1 minor and 5 major |\n| name | String | The name of the Role |\n| dateCreated | String | Date and time when the Role was created |\n| dateDeleted | String | Date and time when the Role was deleted |\n| dateUpdated | String | Date and time when the Role was last updated |\n| deleted | Boolean | If true, the Role has been deleted and archived |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Role |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Role |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Role |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Roles"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Roles in User","content":{"application/json":{"examples":{"default":{"value":[{"id":30,"extId":null,"level":2,"name":"Sales Role","branches":[],"salesRepIdDeleted":0,"salesRepIdCreated":1,"salesRepIdUpdated":0,"dateCreated":"2008-01-02T00:21:38Z","dateUpdated":"2021-02-24T12:22:31.357Z","dateDeleted":"1899-12-30T00:00:00Z","deleted":false},{"id":54,"extId":null,"level":5,"name":"WebService Role","branches":[],"salesRepIdDeleted":null,"salesRepIdCreated":51,"salesRepIdUpdated":0,"dateCreated":"2013-01-10T11:14:19.75Z","dateUpdated":"2021-02-24T12:23:22.257Z","dateDeleted":null,"deleted":false}]}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"add-roles-in-user","summary":"Add Roles in User","description":"This endpoint allows you to update a specific User's Roles information from the user's ForceManager account database. If the specified User does not exist, the response will be a \"bad request\". In order to update the User's Roles, you just have to specify the Role you want to add at.\n\nYou will only be able to update the User's Roles after first providing the Session Key. To know how you can obtain the Session Key, go to [Authentication](#).\n\n**HEADERS**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | The acceptance |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific User's Roles. In order to update the User's Roles, you just have to specify the Role you want to add at.\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| rolesId | Object | Array of the Roles Id that you want to add for a specific User |\n\n**RESPONSE**\n\nReturns a JSON with information with the User Roles.\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| branches | Array| Branch to which the User has been assigned |\n| dateCreated | String | Date and time when the User's Role was associated |\n| dateDeleted | String | Date and time when the User's Role was deleted |\n| dateUpdated | String | Date and time when the User's Role was updated |\n| deleted | Boolean | If true, the User's Role has been deleted and archived |\n| extId | String | External ID of the Role from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The unique identifier of the Role in ForceManager |\n| level | Boolean | If true, the User is billable. ForceManager charges a fee for the user |\n| name | String | The Role name |\n| salesRepIdCreated | Integer | Unique identifier of the user who associated the Role |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Role |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Role |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Roles"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [optional]"}],"responses":{"200":{"description":"Add Roles in User","content":{"application/json":{"examples":{"default":{"value":[{"id":32,"extId":null,"level":5,"name":"Usuario de tipo Administrador","branches":[],"salesRepIdDeleted":0,"salesRepIdCreated":1,"salesRepIdUpdated":48,"dateCreated":"2008-01-02T00:21:38Z","dateUpdated":"2012-05-29T00:04:14Z","dateDeleted":"1899-12-30T00:00:00Z","deleted":false},{"id":68,"extId":null,"level":2,"name":"Demo AppStore","branches":[],"salesRepIdDeleted":0,"salesRepIdCreated":1,"salesRepIdUpdated":48,"dateCreated":"2008-01-02T00:21:38Z","dateUpdated":"2012-07-04T22:32:31Z","dateDeleted":"1899-12-30T00:00:00Z","deleted":false}]}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"rolesId":{"type":"array"}}},"examples":{"default":{"value":{"rolesId":[32]}}}}}}},"delete":{"operationId":"delete-roles-in-user","summary":"Delete Roles in User","description":"This endpoint allows you to delete a specific User's Role from the user's ForceManager account database. If the specified User's Role does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete an User's Role after first providing the Session Key. To know how you can obtain the Session Key, go to [Authentication](#). \n[\n**HEADERS**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | The acceptance |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n]: <>\n
\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| rolesId | Object | Array of the Roles Id that you want to delete for a specific User |\n\n\n
\n**RESPONSE**\n\nReturns a JSON with information with the updated User's Roles.\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| branches | Object, Null | Branch to which the User has been assigned |\n| dateCreated | String | Date and time when the User's Role was associated |\n| dateDeleted | String | Date and time when the User's Role was deleted |\n| dateUpdated | String | Date and time when the User's Role was udpated |\n| deleted | Boolean | If true, the User's Role has been deleted and archived |\n| extId | String | External ID of the Role from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The unique identifier of the Role in ForceManager |\n| level | Boolean | If true, the User is billable. ForceManager charges a fee for the user |\n| name | String | The Role name |\n| salesRepIdCreated | Integer | Unique identifier of the user who associated the Role |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Role |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Role |\n\n
\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Roles"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [optional]"}],"responses":{"200":{"description":"Delete Roles in User","content":{"application/json":{"examples":{"default":{"value":[{"id":68,"extId":null,"level":2,"name":"Demo AppStore","branches":[],"salesRepIdDeleted":0,"salesRepIdCreated":1,"salesRepIdUpdated":48,"dateCreated":"2008-01-02T00:21:38Z","dateUpdated":"2012-07-04T22:32:31Z","dateDeleted":"1899-12-30T00:00:00Z","deleted":false}]}}}}}},"security":[{"SessionKey":[]}]}},"/roles/{ID}/users":{"get":{"operationId":"list-users-in-role","summary":"List Users in Role","description":"Returns all Users assigned to the specific Role available in the user's ForceManager implementation database.\n\nYou will only receive the List of Users assigned to the specific Role after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\nYou 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.\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n
https://api.forcemanager.com/api/v4/roles/:ID/users?page={{number}
\n\nYou can **apply filters**.\n\ne.g.\n
 https://api.forcemanager.com/api/v4/roles/:ID/users?where= param1=value AND/OR param2=value2
\n\nYou can also **organise and view** the results for Users in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n
https://api.forcemanager.com/api/v4/roles/:ID/users?order=VALUE
\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n
 https://api.forcemanager.com/api/v4/roles/:ID/users?lang=VALUE
\n\n**RESPONSE**\n\nThis endpoint returns information about all Users assigned to the specific Role available in the database. \n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Users attributes:\n\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| billable | Boolean | If true, the User is billable. ForceManager charges a fee for the user |\n| branches | Object, Null | Branch to which the User has been assigned |\n| branchRestriction | Boolean | If true, the user has limited visibility in some branches |\n| computeSfm | Boolean | If true, the User counts for the Sales Analytics |\n| dateCreated | String | Date and time when the User was created |\n| dateDeleted | String | Date and time when the User was deleted |\n| dateUpdated | String | Date and time when the User was last updated |\n| deleted | Boolean | If true, the User has been deleted and archived |\n| email | String | User’s email |\n| extId | String | External ID of the User from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The unique identifier of the User in ForceManager |\n| lastName | String | User’s last name |\n| lastPasswordChangeDate | String | Date when the password was last changed |\n| level | Integer | Permission level of the user. Set from 1 to 5 being 5 the highest level of permission and visibility |\n| name | String | User's first name |\n| nic | String | User's name in ForceManager |\n| phone | String | User’s phone number |\n| phoneExtension | String | User's phone number extension |\n| rateId | Object, Null | Rate for the User (Check Rates Values List) |\n| salesRepId | Object, Null | Sales representative responsible for the User |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the User |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the User |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the User |\n| session | Object, Null | If true, the User has access to the app |\n| userType | Object, Null | Type of user in ForceManager |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Roles"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Users in Role","content":{"application/json":{"examples":{"default":{"value":[{"id":46,"extId":"","billable":false,"lastPasswordChangeDate":null,"branches":{"id":16,"description":"FORCEMANAGER"},"userTypeId":{"id":1,"description":"Sales Manager"},"level":2,"name":"Carlos","lastName":"Gomez","email":"carlos.gomez@forcemanager.net","nic":"Carlos Gomez","dateCreated":"1900-01-01T00:00:00Z","dateUpdated":"2014-07-10T12:02:07.317Z","dateDeleted":"1899-12-30T00:00:00Z","salesRepIdCreated":2,"salesRepIdUpdated":46,"salesRepIdDeleted":-1,"deleted":false,"phone":"1234567890","phoneExtension":"","managerId":{"id":-1,"name":null},"rateId":{"id":-1,"name":null},"computeSfm":true}]}}}}}},"security":[{"SessionKey":[]}]}},"/sales/schema":{"get":{"operationId":"sales-schema","summary":"Sales schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a Sales object.\n\nYou will only receive the Sales Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Sales Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Table | String | The name of the values list table |\n| Type | Object, Null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Sales"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"count","in":"header","required":false,"schema":{"type":"string"}},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Sales schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"accountExtId":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"accountId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"accounts","type":["object","null"]},"date":{"description":"","format":"date-time","readOnly":false,"type":["string","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"extId":{"description":"","maxLength":255,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepExtId":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"salesRepId":{"description":"","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]},"total":{"description":"","readOnly":false,"type":["number","null"]}},"required":[],"title":"sales","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/sales":{"get":{"operationId":"list-sales","summary":"List Sales","description":"Returns all Sales available in the user's ForceManager implementation database.\n\nYou will only receive the List of Sales after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/sales?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/sales?where= param1=value AND/OR param2=value2\n\n ```\n\n \nYou can also **organise and view** the results for Sales in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/sales?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/sales?lang=VALUE\n\n ```\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountExtId | String | External ID of the Account from a third party system (ERP, CRM, Accounting System) |\n| accountId | Object, Null | Account to which the Sale is linked to |\n| date | String | The Sale's date |\n| dateCreated | String | Date and time when the Sale was created |\n| dateDeleted | String | Date and time when the Sale was deleted |\n| dateUpdated | String | Date and time when the Sale was last updated |\n| deleted | boolean | If true, the Sale has been deleted and archived |\n| extId | String | External ID of the Sale from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | Unique identifier for the Sale in ForceManager |\n| salesRepExtId | Object, Null | External ID of the User from a third party system (ERP, CRM, Accounting System) |\n| salesRepId | Object, Null | User responsible for the Sale |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Sale |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Sale |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Sale |\n| total | Number | Total amount of the Sale |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Sales"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"List Sales","content":{"application/json":{"examples":{"default":{"value":[{"accountExtId":"A001","accountId":{"id":1,"value":"ICM Industrial S.r.l."},"date":"2018-10-10T00:00:00Z","dateCreated":"2021-12-08T21:47:48.797Z","dateDeleted":null,"dateUpdated":null,"deleted":0,"extId":"SALE10002","id":1,"salesRepExtId":"REP10002","salesRepId":null,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"total":168}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-sale","summary":"Create Sale","description":"This endpoint allows you to create a Sales \nbased on JSON input.\n\nYou will only be able to create a Sale after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountExtId | String | External ID of the Account from a third party system (ERP, CRM, Accounting System) |\n| accountId | Integer | Account to which the Sale is linked to |\n| date | String | The Sale's date |\n| extId | String | External ID of the Sale from a third party system (ERP, CRM, Accounting System) |\n| salesRepExtId | String | External ID of the User from a third party system (ERP, CRM, Accounting System) |\n| total | Number | Total amount of the Sale |\n\n**RESPONSE**\n\nReturns a JSON with information about the Contact just created.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new Contact |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Sales"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Sale","content":{"application/json":{"examples":{"default":{"value":{"id":1,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountExtId":{"type":"string"},"accountId":{"type":"integer"},"date":{"type":"string"},"extId":{"type":"string"},"salesRepExtId":{"type":"string"},"total":{"type":"integer"}}},"examples":{"default":{"value":{"accountExtId":"A001","accountId":1,"date":"2018-10-10 00:00:00","extId":"SALE10002","salesRepExtId":"REP10002","total":168}}}}}}}},"/sales/{ID}":{"get":{"operationId":"get-sale","summary":"Get Sale","description":"This endpoint retrieves data of a specific Sale based on JSON input. The API returns a single Sale available to the user, according to the unique ID provided. If the specified Sale does not exist, the response will be a \"bad request\".\n\nYou will only receive the Sale after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Sale |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountExtId | Object, Null | External ID of the Account from a third party system (ERP, CRM, Accounting System) |\n| accountId | Object, Null | Account to which the Sale is linked to |\n| date | String | The Sale's date |\n| dateCreated | String | Date and time when the Sale was created |\n| dateDeleted | String | Date and time when the Sale was deleted |\n| dateUpdated | String | Date and time when the Sale was last updated |\n| deleted | boolean | If true, the Sale has been deleted and archived |\n| extId | String | External ID of the Sale from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | Unique identifier of the Sale in ForceManager |\n| salesRepExtId | Object, Null | External ID of the User from a third party system (ERP, CRM, Accounting System) |\n| salesRepId | Object, Null | User responsible for the Sale |\n| salesRepIdCreated | Integer | Unique identifier of the User who created the Sale |\n| salesRepIdDeleted | Integer | Unique identifier of the User who deleted the Sale |\n| salesRepIdUpdated | Integer | Unique identifier of the User who updated the Sale |\n| total | Number | Total amount of the Sale |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Sales"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Sale","content":{"application/json":{"examples":{"default":{"value":{"accountExtId":"A001","accountId":{"id":1,"value":"ICM Industrial S.r.l."},"date":"2018-10-10T00:00:00Z","dateCreated":"2021-12-08T21:47:48.797Z","dateDeleted":null,"dateUpdated":null,"deleted":0,"extId":"SALE10002","id":1,"salesRepExtId":"REP10002","salesRepId":null,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"total":168}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-sale","summary":"Update Sale","description":"The endpoint allows you to update a specific Sale information from the user's ForceManager implementation database. If the specified Contact does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a Sale after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific Sale. In order to update a Sale, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| accountExtId | String | External ID of the Account from a third party system (ERP, CRM, Accounting System) |\n| accountId | Integer | Account to which the Sale is linked to |\n| date | String | The Sale's date |\n| extId | String | External ID of the Sale from a third party system (ERP, CRM, Accounting System) |\n| salesRepExtId | String | External ID of the User from a third party system (ERP, CRM, Accounting System) |\n| total | Number | Total amount of the Sale |\n\n**RESPONSE**\n\nReturns a JSON with information about the Sale just updated.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Sales"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Sale","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"accountId":{"type":"integer"},"date":{"type":"string"},"salesRepExtId":{"type":"string"},"total":{"type":"integer"}}},"examples":{"default":{"value":{"accountId":2,"date":"2018-10-10 00:00:00","salesRepExtId":"REP10003","total":320}}}}}}},"delete":{"operationId":"delete-sale","summary":"Delete Sale","description":"This endpoint allows you to delete a specific Sale from the user's ForceManager implementation database. If the specified Sale does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete Sale after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Sale to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Sale just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Sales"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Sale","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/timezones":{"get":{"operationId":"list-timezones","summary":"List TimeZones","description":"Returns all TimeZones available.\n\nYou will only receive the TimeZones after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all TimeZones available for the value list.\n\nList of the supported TimeZones attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| dateCreated | String | Date and time when the TimeZone was created |\n| dateDeleted | String | Date and time when the TimeZone was deleted |\n| dateUpdated | String | Date and time when the TimeZone was last updated |\n| deleted | Boolean | If true, the TimeZone has been deleted and archived |\n| descriptionBR | String | TimeZone name in Brasilian Portuguese |\n| descriptionDE | String | TimeZone name in German |\n| descriptionDK | String | TimeZone name in Dutch |\n| descriptionEN | String | TimeZone name in English |\n| descriptionES | String | TimeZone name in Spanish |\n| descriptionFR | String | TimeZone name in French |\n| descriptionIT | String | TimeZone name in Italian |\n| descriptionPT | String | TimeZone name in Portuguese |\n| descriptionRU | String | TimeZone name in Russian |\n| descriptionUS | String | TimeZone name in American English |\n| fullDescription | String | Full TimeZone name |\n| id | Integer | Unique identifier for the TimeZone in ForceManager |\n| idIanaZone | String | Identifier of the TimeZone in the IANA database |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the TimeZone |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the TimeZone |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the TimeZone |\n| shortDescription | String | TimeZone name only reporting the offset |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["TimeZones"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List TimeZones","content":{"application/json":{"examples":{"default":{"value":[{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-12:00) Datumsgrenze","descriptionDK":null,"descriptionEN":"(GMT-12:00) International Date Line West","descriptionES":"(GMT-12:00) International Date Line West","descriptionFR":"(GMT-12:00) International Date Line West","descriptionIT":"(GMT-12:00) International Date Line West","descriptionPT":"(GMT-12:00) International Date Line West","descriptionRU":null,"descriptionUS":"(GMT-12:00) International Date Line West","fullDescription":"(GMT-12:00) International Date Line West","id":1,"idIanaZone":"Pacific/Auckland","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-12:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-11:00) Midwayinsel, Samoa","descriptionDK":null,"descriptionEN":"(GMT-11:00) Midway Island, Samoa","descriptionES":"(GMT-11:00) Midway Island, Samoa","descriptionFR":"(GMT-11:00) Midway Island, Samoa","descriptionIT":"(GMT-11:00) Midway Island, Samoa","descriptionPT":"(GMT-11:00) Midway Island, Samoa","descriptionRU":null,"descriptionUS":"(GMT-11:00) Midway Island, Samoa","fullDescription":"(GMT-11:00) Midway Island, Samoa","id":2,"idIanaZone":"Pacific/Midway","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-11:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-10:00) Hawaii","descriptionDK":null,"descriptionEN":"(GMT-10:00) Hawaii","descriptionES":"(GMT-10:00) Hawaii","descriptionFR":"(GMT-10:00) Hawaii","descriptionIT":"(GMT-10:00) Hawaii","descriptionPT":"(GMT-10:00) Hawaii","descriptionRU":null,"descriptionUS":"(GMT-10:00) Hawaii","fullDescription":"(GMT-10:00) Hawaii","id":3,"idIanaZone":"Pacific/Honolulu","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-10:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-09:00) Alaska","descriptionDK":null,"descriptionEN":"(GMT-09:00) Alaska","descriptionES":"(GMT-09:00) Alaska","descriptionFR":"(GMT-09:00) Alaska","descriptionIT":"(GMT-09:00) Alaska","descriptionPT":"(GMT-09:00) Alaska","descriptionRU":null,"descriptionUS":"(GMT-09:00) Alaska","fullDescription":"(GMT-09:00) Alaska","id":4,"idIanaZone":"America/Juneau","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-09:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-08:00) Pazifische Zeit (USA und Kanada); Tijuana","descriptionDK":null,"descriptionEN":"(GMT-08:00) Pacific Time (US and Canada); Tijuana","descriptionES":"(GMT-08:00) Pacific Time (US and Canada); Tijuana","descriptionFR":"(GMT-08:00) Pacific Time (US and Canada); Tijuana","descriptionIT":"(GMT-08:00) Pacific Time (US and Canada); Tijuana","descriptionPT":"(GMT-08:00) Pacific Time (US and Canada); Tijuana","descriptionRU":null,"descriptionUS":"(GMT-08:00) Pacific Time (US and Canada); Tijuana","fullDescription":"(GMT-08:00) Pacific Time (US and Canada); Tijuana","id":5,"idIanaZone":"America/Tijuana","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-08:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-07:00) Mountain Time (USA und Kanada)","descriptionDK":null,"descriptionEN":"(GMT-07:00) Mountain Time (US and Canada)","descriptionES":"(GMT-07:00) Mountain Time (US and Canada)","descriptionFR":"(GMT-07:00) Mountain Time (US and Canada)","descriptionIT":"(GMT-07:00) Mountain Time (US and Canada)","descriptionPT":"(GMT-07:00) Mountain Time (US and Canada)","descriptionRU":null,"descriptionUS":"(GMT-07:00) Mountain Time (US and Canada)","fullDescription":"(GMT-07:00) Mountain Time (US and Canada)","id":6,"idIanaZone":"America/Phoenix","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-07:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-07:00) Chihuahua, La Paz, Mazatlan","descriptionDK":null,"descriptionEN":"(GMT-07:00) Chihuahua, La Paz, Mazatlan","descriptionES":"(GMT-07:00) Chihuahua, La Paz, Mazatlan","descriptionFR":"(GMT-07:00) Chihuahua, La Paz, Mazatlan","descriptionIT":"(GMT-07:00) Chihuahua, La Paz, Mazatlan","descriptionPT":"(GMT-07:00) Chihuahua, La Paz, Mazatlan","descriptionRU":null,"descriptionUS":"(GMT-07:00) Chihuahua, La Paz, Mazatlan","fullDescription":"(GMT-07:00) Chihuahua, La Paz, Mazatlan","id":7,"idIanaZone":"America/Chihuahua","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-07:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-07:00) Arizona","descriptionDK":null,"descriptionEN":"(GMT-07:00) Arizona","descriptionES":"(GMT-07:00) Arizona","descriptionFR":"(GMT-07:00) Arizona","descriptionIT":"(GMT-07:00) Arizona","descriptionPT":"(GMT-07:00) Arizona","descriptionRU":null,"descriptionUS":"(GMT-07:00) Arizona","fullDescription":"(GMT-07:00) Arizona","id":8,"idIanaZone":"America/Phoenix","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-07:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-06:00) Saskatchewan","descriptionDK":null,"descriptionEN":"(GMT-06:00) Saskatchewan","descriptionES":"(GMT-06:00) Saskatchewan","descriptionFR":"(GMT-06:00) Saskatchewan","descriptionIT":"(GMT-06:00) Saskatchewan","descriptionPT":"(GMT-06:00) Saskatchewan","descriptionRU":null,"descriptionUS":"(GMT-06:00) Saskatchewan","fullDescription":"(GMT-06:00) Saskatchewan","id":9,"idIanaZone":"America/Regina","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-06:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-06:00) Mittelamerika","descriptionDK":null,"descriptionEN":"(GMT-06:00) Central America","descriptionES":"(GMT-06:00) Central America","descriptionFR":"(GMT-06:00) Central America","descriptionIT":"(GMT-06:00) Central America","descriptionPT":"(GMT-06:00) Central America","descriptionRU":null,"descriptionUS":"(GMT-06:00) Central America","fullDescription":"(GMT-06:00) Central America","id":10,"idIanaZone":"America/El_Salvador","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-06:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-06:00) Central Time (USA und Kanada)","descriptionDK":null,"descriptionEN":"(GMT-06:00) Central Time (US and Canada)","descriptionES":"(GMT-06:00) Central Time (US and Canada)","descriptionFR":"(GMT-06:00) Central Time (US and Canada)","descriptionIT":"(GMT-06:00) Central Time (US and Canada)","descriptionPT":"(GMT-06:00) Central Time (US and Canada)","descriptionRU":null,"descriptionUS":"(GMT-06:00) Central Time (US and Canada)","fullDescription":"(GMT-06:00) Central Time (US and Canada)","id":11,"idIanaZone":"America/Kentucky/Louisville","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-06:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-06:00) Guadalajara, Mexiko-Stadt, Monterrey","descriptionDK":null,"descriptionEN":"(GMT-06:00) Guadalajara, Mexico City, Monterrey","descriptionES":"(GMT-06:00) Guadalajara, Mexico City, Monterrey","descriptionFR":"(GMT-06:00) Guadalajara, Mexico City, Monterrey","descriptionIT":"(GMT-06:00) Guadalajara, Mexico City, Monterrey","descriptionPT":"(GMT-06:00) Guadalajara, Mexico City, Monterrey","descriptionRU":null,"descriptionUS":"(GMT-06:00) Guadalajara, Mexico City, Monterrey","fullDescription":"(GMT-06:00) Guadalajara, Mexico City, Monterrey","id":12,"idIanaZone":"America/Mexico_City","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-06:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-05:00) Eastern Time (USA und Kanada)","descriptionDK":null,"descriptionEN":"(GMT-05:00) Eastern Time (US and Canada)","descriptionES":"(GMT-05:00) Eastern Time (US and Canada)","descriptionFR":"(GMT-05:00) Eastern Time (US and Canada)","descriptionIT":"(GMT-05:00) Eastern Time (US and Canada)","descriptionPT":"(GMT-05:00) Eastern Time (US and Canada)","descriptionRU":null,"descriptionUS":"(GMT-05:00) Eastern Time (US and Canada)","fullDescription":"(GMT-05:00) Eastern Time (US and Canada)","id":13,"idIanaZone":"America/New_York","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-05:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-05:00) Bogota, Lima, Quito","descriptionDK":null,"descriptionEN":"(GMT-05:00) Bogota, Lima, Quito","descriptionES":"(GMT-05:00) Bogota, Lima, Quito","descriptionFR":"(GMT-05:00) Bogota, Lima, Quito","descriptionIT":"(GMT-05:00) Bogota, Lima, Quito","descriptionPT":"(GMT-05:00) Bogota, Lima, Quito","descriptionRU":null,"descriptionUS":"(GMT-05:00) Bogota, Lima, Quito","fullDescription":"(GMT-05:00) Bogota, Lima, Quito","id":14,"idIanaZone":"America/Bogota","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-05:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-05:00) Indiana (Osten)","descriptionDK":null,"descriptionEN":"(GMT-05:00) Indiana (East)","descriptionES":"(GMT-05:00) Indiana (East)","descriptionFR":"(GMT-05:00) Indiana (East)","descriptionIT":"(GMT-05:00) Indiana (East)","descriptionPT":"(GMT-05:00) Indiana (East)","descriptionRU":null,"descriptionUS":"(GMT-05:00) Indiana (East)","fullDescription":"(GMT-05:00) Indiana (East)","id":15,"idIanaZone":"America/Indiana/Indianapolis","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-05:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-04:00) Atlantische Zeit (Kanada)","descriptionDK":null,"descriptionEN":"(GMT-04:00) Atlantic Time (Canada)","descriptionES":"(GMT-04:00) Atlantic Time (Canada)","descriptionFR":"(GMT-04:00) Atlantic Time (Canada)","descriptionIT":"(GMT-04:00) Atlantic Time (Canada)","descriptionPT":"(GMT-04:00) Atlantic Time (Canada)","descriptionRU":null,"descriptionUS":"(GMT-04:00) Atlantic Time (Canada)","fullDescription":"(GMT-04:00) Atlantic Time (Canada)","id":16,"idIanaZone":"America/Halifax","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-04:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-04:00) Manaus","descriptionDK":null,"descriptionEN":"(GMT-04:00) Manaus","descriptionES":"(GMT-04:00) Manaus","descriptionFR":"(GMT-04:00) Manaus","descriptionIT":"(GMT-04:00) Manaus","descriptionPT":"(GMT-04:00) Manaus","descriptionRU":null,"descriptionUS":"(GMT-04:00) Manaus","fullDescription":"(GMT-04:00) Manaus","id":17,"idIanaZone":"America/Manaus","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-04:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-04:00) Santiago","descriptionDK":null,"descriptionEN":"(GMT-04:00) Santiago","descriptionES":"(GMT-04:00) Santiago","descriptionFR":"(GMT-04:00) Santiago","descriptionIT":"(GMT-04:00) Santiago","descriptionPT":"(GMT-04:00) Santiago","descriptionRU":null,"descriptionUS":"(GMT-04:00) Santiago","fullDescription":"(GMT-04:00) Santiago","id":18,"idIanaZone":"America/Santiago","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-04:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-04:00) Caracas, La Paz","descriptionDK":null,"descriptionEN":"(GMT-04:00) Caracas, La Paz","descriptionES":"(GMT-04:00) Caracas, La Paz","descriptionFR":"(GMT-04:00) Caracas, La Paz","descriptionIT":"(GMT-04:00) Caracas, La Paz","descriptionPT":"(GMT-04:00) Caracas, La Paz","descriptionRU":null,"descriptionUS":"(GMT-04:00) Caracas, La Paz","fullDescription":"(GMT-04:00) Caracas, La Paz","id":19,"idIanaZone":"America/La_Paz","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-04:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-03:30) Neufundland und Labrador","descriptionDK":null,"descriptionEN":"(GMT-03:30) Newfoundland and Labrador","descriptionES":"(GMT-03:30) Newfoundland and Labrador","descriptionFR":"(GMT-03:30) Newfoundland and Labrador","descriptionIT":"(GMT-03:30) Newfoundland and Labrador","descriptionPT":"(GMT-03:30) Newfoundland and Labrador","descriptionRU":null,"descriptionUS":"(GMT-03:30) Newfoundland and Labrador","fullDescription":"(GMT-03:30) Newfoundland and Labrador","id":20,"idIanaZone":"America/St_Johns","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-03:30"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-03:00) Brasilia","descriptionDK":null,"descriptionEN":"(GMT-03:00) Brasilia","descriptionES":"(GMT-03:00) Brasilia","descriptionFR":"(GMT-03:00) Brasilia","descriptionIT":"(GMT-03:00) Brasilia","descriptionPT":"(GMT-03:00) Brasilia","descriptionRU":null,"descriptionUS":"(GMT-03:00) Brasilia","fullDescription":"(GMT-03:00) Brasilia","id":21,"idIanaZone":"America/Bahia","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-03:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-03:00) Grönland","descriptionDK":null,"descriptionEN":"(GMT-03:00) Greenland","descriptionES":"(GMT-03:00) Greenland","descriptionFR":"(GMT-03:00) Greenland","descriptionIT":"(GMT-03:00) Greenland","descriptionPT":"(GMT-03:00) Greenland","descriptionRU":null,"descriptionUS":"(GMT-03:00) Greenland","fullDescription":"(GMT-03:00) Greenland","id":22,"idIanaZone":"America/Miquelon","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-03:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-03:00) Buenos Aires, Georgetown","descriptionDK":null,"descriptionEN":"(GMT-03:00) Buenos Aires, Georgetown","descriptionES":"(GMT-03:00) Buenos Aires, Georgetown","descriptionFR":"(GMT-03:00) Buenos Aires, Georgetown","descriptionIT":"(GMT-03:00) Buenos Aires, Georgetown","descriptionPT":"(GMT-03:00) Buenos Aires, Georgetown","descriptionRU":null,"descriptionUS":"(GMT-03:00) Buenos Aires, Georgetown","fullDescription":"(GMT-03:00) Buenos Aires, Georgetown","id":23,"idIanaZone":"America/Argentina/Buenos_Aires","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-03:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-02:00) Mittlerer Atlantik","descriptionDK":null,"descriptionEN":"(GMT-02:00) Mid-Atlantic","descriptionES":"(GMT-02:00) Mid-Atlantic","descriptionFR":"(GMT-02:00) Mid-Atlantic","descriptionIT":"(GMT-02:00) Mid-Atlantic","descriptionPT":"(GMT-02:00) Mid-Atlantic","descriptionRU":null,"descriptionUS":"(GMT-02:00) Mid-Atlantic","fullDescription":"(GMT-02:00) Mid-Atlantic","id":24,"idIanaZone":"Atlantic/South_Georgia","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-02:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-01:00) Azoren","descriptionDK":null,"descriptionEN":"(GMT-01:00) Azores","descriptionES":"(GMT-01:00) Azores","descriptionFR":"(GMT-01:00) Azores","descriptionIT":"(GMT-01:00) Azores","descriptionPT":"(GMT-01:00) Azores","descriptionRU":null,"descriptionUS":"(GMT-01:00) Azores","fullDescription":"(GMT-01:00) Azores","id":25,"idIanaZone":"Atlantic/Azores","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-01:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC-01:00) Kapverdische Inseln","descriptionDK":null,"descriptionEN":"(GMT-01:00) Cape Verde Islands","descriptionES":"(GMT-01:00) Cape Verde Islands","descriptionFR":"(GMT-01:00) Cape Verde Islands","descriptionIT":"(GMT-01:00) Cape Verde Islands","descriptionPT":"(GMT-01:00) Cape Verde Islands","descriptionRU":null,"descriptionUS":"(GMT-01:00) Cape Verde Islands","fullDescription":"(GMT-01:00) Cape Verde Islands","id":26,"idIanaZone":"Atlantic/Cape_Verde","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT-01:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC) Westeuropäische Zeit: Dublin, Edinburgh, Lissabon, London","descriptionDK":null,"descriptionEN":"(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London","descriptionES":"(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London","descriptionFR":"(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London","descriptionIT":"(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London","descriptionPT":"(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London","descriptionRU":null,"descriptionUS":"(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London","fullDescription":"(GMT) Greenwich Mean Time : Dublin, Edinburgh, Lisbon, London","id":27,"idIanaZone":"Europe/London","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT +00:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC) Casablanca, Monrovia","descriptionDK":null,"descriptionEN":"(GMT) Casablanca, Monrovia","descriptionES":"(GMT) Casablanca, Monrovia","descriptionFR":"(GMT) Casablanca, Monrovia","descriptionIT":"(GMT) Casablanca, Monrovia","descriptionPT":"(GMT) Casablanca, Monrovia","descriptionRU":null,"descriptionUS":"(GMT) Casablanca, Monrovia","fullDescription":"(GMT) Casablanca, Monrovia","id":28,"idIanaZone":"Africa/Casablanca","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT +00:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+01:00) Belgrad, Bratislava, Budapest, Ljubljana, Prag","descriptionDK":null,"descriptionEN":"(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague","descriptionES":"(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague","descriptionFR":"(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague","descriptionIT":"(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague","descriptionPT":"(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague","descriptionRU":null,"descriptionUS":"(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague","fullDescription":"(GMT+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague","id":29,"idIanaZone":"Europe/Belgrade","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+01:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+01:00) Sarajewo, Skopje, Warschau, Zagreb","descriptionDK":null,"descriptionEN":"(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb","descriptionES":"(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb","descriptionFR":"(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb","descriptionIT":"(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb","descriptionPT":"(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb","descriptionRU":null,"descriptionUS":"(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb","fullDescription":"(GMT+01:00) Sarajevo, Skopje, Warsaw, Zagreb","id":30,"idIanaZone":"Europe/Sarajevo","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+01:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+01:00) Brüssel, Kopenhagen, Madrid, Paris","descriptionDK":null,"descriptionEN":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris","descriptionES":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris","descriptionFR":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris","descriptionIT":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris","descriptionPT":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris","descriptionRU":null,"descriptionUS":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris","fullDescription":"(GMT+01:00) Brussels, Copenhagen, Madrid, Paris","id":31,"idIanaZone":"Europe/Paris","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+01:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+01:00) Westliches Zentralafrika","descriptionDK":null,"descriptionEN":"(GMT+01:00) West Central Africa","descriptionES":"(GMT+01:00) West Central Africa","descriptionFR":"(GMT+01:00) West Central Africa","descriptionIT":"(GMT+01:00) West Central Africa","descriptionPT":"(GMT+01:00) West Central Africa","descriptionRU":null,"descriptionUS":"(GMT+01:00) West Central Africa","fullDescription":"(GMT+01:00) West Central Africa","id":32,"idIanaZone":"Africa/Brazzaville","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+01:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+01:00) Amsterdam, Berlin, Bern, Rom, Stockholm, Wien","descriptionDK":null,"descriptionEN":"(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna","descriptionES":"(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna","descriptionFR":"(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna","descriptionIT":"(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna","descriptionPT":"(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna","descriptionRU":null,"descriptionUS":"(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna","fullDescription":"(GMT+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna","id":33,"idIanaZone":"Europe/Berlin","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+01:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+02:00) Minsk","descriptionDK":null,"descriptionEN":"(GMT+02:00) Minsk","descriptionES":"(GMT+02:00) Minsk","descriptionFR":"(GMT+02:00) Minsk","descriptionIT":"(GMT+02:00) Minsk","descriptionPT":"(GMT+02:00) Minsk","descriptionRU":null,"descriptionUS":"(GMT+02:00) Minsk","fullDescription":"(GMT+02:00) Minsk","id":34,"idIanaZone":"Europe/Minsk","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+02:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+02:00) Kairo","descriptionDK":null,"descriptionEN":"(GMT+02:00) Cairo","descriptionES":"(GMT+02:00) Cairo","descriptionFR":"(GMT+02:00) Cairo","descriptionIT":"(GMT+02:00) Cairo","descriptionPT":"(GMT+02:00) Cairo","descriptionRU":null,"descriptionUS":"(GMT+02:00) Cairo","fullDescription":"(GMT+02:00) Cairo","id":35,"idIanaZone":"Africa/Cairo","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+02:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+02:00) Helsinki, Kiew, Riga, Sofia, Tallinn, Vilnius","descriptionDK":null,"descriptionEN":"(GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius","descriptionES":"(GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius","descriptionFR":"(GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius","descriptionIT":"(GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius","descriptionPT":"(GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius","descriptionRU":null,"descriptionUS":"(GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius","fullDescription":"(GMT+02:00) Helsinki, Kiev, Riga, Sofia, Tallinn, Vilnius","id":36,"idIanaZone":"Europe/Helsinki","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+02:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+02:00) Athen, Bukarest, Istanbul","descriptionDK":null,"descriptionEN":"(GMT+02:00) Athens, Bucharest, Istanbul","descriptionES":"(GMT+02:00) Athens, Bucharest, Istanbul","descriptionFR":"(GMT+02:00) Athens, Bucharest, Istanbul","descriptionIT":"(GMT+02:00) Athens, Bucharest, Istanbul","descriptionPT":"(GMT+02:00) Athens, Bucharest, Istanbul","descriptionRU":null,"descriptionUS":"(GMT+02:00) Athens, Bucharest, Istanbul","fullDescription":"(GMT+02:00) Athens, Bucharest, Istanbul","id":37,"idIanaZone":"Europe/Athens","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+02:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+02:00) Jerusalem","descriptionDK":null,"descriptionEN":"(GMT+02:00) Jerusalem","descriptionES":"(GMT+02:00) Jerusalem","descriptionFR":"(GMT+02:00) Jerusalem","descriptionIT":"(GMT+02:00) Jerusalem","descriptionPT":"(GMT+02:00) Jerusalem","descriptionRU":null,"descriptionUS":"(GMT+02:00) Jerusalem","fullDescription":"(GMT+02:00) Jerusalem","id":38,"idIanaZone":"Asia/Jerusalem","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+02:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+02:00) Windhoek","descriptionDK":null,"descriptionEN":"(GMT+02:00) Windhoek","descriptionES":"(GMT+02:00) Windhoek","descriptionFR":"(GMT+02:00) Windhoek","descriptionIT":"(GMT+02:00) Windhoek","descriptionPT":"(GMT+02:00) Windhoek","descriptionRU":null,"descriptionUS":"(GMT+02:00) Windhoek","fullDescription":"(GMT+02:00) Windhoek","id":39,"idIanaZone":"Africa/Windhoek","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+02:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+02:00) Harare, Pretoria","descriptionDK":null,"descriptionEN":"(GMT+02:00) Harare, Pretoria","descriptionES":"(GMT+02:00) Harare, Pretoria","descriptionFR":"(GMT+02:00) Harare, Pretoria","descriptionIT":"(GMT+02:00) Harare, Pretoria","descriptionPT":"(GMT+02:00) Harare, Pretoria","descriptionRU":null,"descriptionUS":"(GMT+02:00) Harare, Pretoria","fullDescription":"(GMT+02:00) Harare, Pretoria","id":40,"idIanaZone":"Africa/Harare","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+02:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+03:00) Kuwait, Riad","descriptionDK":null,"descriptionEN":"(GMT+03:00) Kuwait, Riyadh","descriptionES":"(GMT+03:00) Kuwait, Riyadh","descriptionFR":"(GMT+03:00) Kuwait, Riyadh","descriptionIT":"(GMT+03:00) Kuwait, Riyadh","descriptionPT":"(GMT+03:00) Kuwait, Riyadh","descriptionRU":null,"descriptionUS":"(GMT+03:00) Kuwait, Riyadh","fullDescription":"(GMT+03:00) Kuwait, Riyadh","id":41,"idIanaZone":"Asia/Kuwait","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+03:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+03:00) Bagdad","descriptionDK":null,"descriptionEN":"(GMT+03:00) Baghdad","descriptionES":"(GMT+03:00) Baghdad","descriptionFR":"(GMT+03:00) Baghdad","descriptionIT":"(GMT+03:00) Baghdad","descriptionPT":"(GMT+03:00) Baghdad","descriptionRU":null,"descriptionUS":"(GMT+03:00) Baghdad","fullDescription":"(GMT+03:00) Baghdad","id":42,"idIanaZone":"Asia/Baghdad","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+03:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+03:00) Nairobi","descriptionDK":null,"descriptionEN":"(GMT+03:00) Nairobi","descriptionES":"(GMT+03:00) Nairobi","descriptionFR":"(GMT+03:00) Nairobi","descriptionIT":"(GMT+03:00) Nairobi","descriptionPT":"(GMT+03:00) Nairobi","descriptionRU":null,"descriptionUS":"(GMT+03:00) Nairobi","fullDescription":"(GMT+03:00) Nairobi","id":43,"idIanaZone":"Africa/Nairobi","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+03:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+03:00) Moskau, St. Petersburg, Wolgograd","descriptionDK":null,"descriptionEN":"(GMT+03:00) Moscow, St. Petersburg, Volgograd","descriptionES":"(GMT+03:00) Moscow, St. Petersburg, Volgograd","descriptionFR":"(GMT+03:00) Moscow, St. Petersburg, Volgograd","descriptionIT":"(GMT+03:00) Moscow, St. Petersburg, Volgograd","descriptionPT":"(GMT+03:00) Moscow, St. Petersburg, Volgograd","descriptionRU":null,"descriptionUS":"(GMT+03:00) Moscow, St. Petersburg, Volgograd","fullDescription":"(GMT+03:00) Moscow, St. Petersburg, Volgograd","id":44,"idIanaZone":"Europe/Moscow","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+03:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+03:30) Teheran","descriptionDK":null,"descriptionEN":"(GMT+03:30) Tehran","descriptionES":"(GMT+03:30) Tehran","descriptionFR":"(GMT+03:30) Tehran","descriptionIT":"(GMT+03:30) Tehran","descriptionPT":"(GMT+03:30) Tehran","descriptionRU":null,"descriptionUS":"(GMT+03:30) Tehran","fullDescription":"(GMT+03:30) Tehran","id":45,"idIanaZone":"Asia/Tehran","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+03:30"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+04:00) Tiflis","descriptionDK":null,"descriptionEN":"(GMT+04:00) Tblisi","descriptionES":"(GMT+04:00) Tblisi","descriptionFR":"(GMT+04:00) Tblisi","descriptionIT":"(GMT+04:00) Tblisi","descriptionPT":"(GMT+04:00) Tblisi","descriptionRU":null,"descriptionUS":"(GMT+04:00) Tblisi","fullDescription":"(GMT+04:00) Tblisi","id":46,"idIanaZone":"Asia/Tbilisi","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+04:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+04:00) Abu Dhabi, Maskat","descriptionDK":null,"descriptionEN":"(GMT+04:00) Abu Dhabi, Muscat","descriptionES":"(GMT+04:00) Abu Dhabi, Muscat","descriptionFR":"(GMT+04:00) Abu Dhabi, Muscat","descriptionIT":"(GMT+04:00) Abu Dhabi, Muscat","descriptionPT":"(GMT+04:00) Abu Dhabi, Muscat","descriptionRU":null,"descriptionUS":"(GMT+04:00) Abu Dhabi, Muscat","fullDescription":"(GMT+04:00) Abu Dhabi, Muscat","id":47,"idIanaZone":"Asia/Muscat","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+04:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+04:00) Baku","descriptionDK":null,"descriptionEN":"(GMT+04:00) Baku","descriptionES":"(GMT+04:00) Baku","descriptionFR":"(GMT+04:00) Baku","descriptionIT":"(GMT+04:00) Baku","descriptionPT":"(GMT+04:00) Baku","descriptionRU":null,"descriptionUS":"(GMT+04:00) Baku","fullDescription":"(GMT+04:00) Baku","id":48,"idIanaZone":"Asia/Baku","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+04:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+04:00) Jerewan","descriptionDK":null,"descriptionEN":"(GMT+04:00) Yerevan","descriptionES":"(GMT+04:00) Yerevan","descriptionFR":"(GMT+04:00) Yerevan","descriptionIT":"(GMT+04:00) Yerevan","descriptionPT":"(GMT+04:00) Yerevan","descriptionRU":null,"descriptionUS":"(GMT+04:00) Yerevan","fullDescription":"(GMT+04:00) Yerevan","id":49,"idIanaZone":"Asia/Yerevan","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+04:00"},{"dateCreated":"2015-03-02T10:41:46.85Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"(UTC+04:30) Kabul","descriptionDK":null,"descriptionEN":"(GMT+04:30) Kabul","descriptionES":"(GMT+04:30) Kabul","descriptionFR":"(GMT+04:30) Kabul","descriptionIT":"(GMT+04:30) Kabul","descriptionPT":"(GMT+04:30) Kabul","descriptionRU":null,"descriptionUS":"(GMT+04:30) Kabul","fullDescription":"(GMT+04:30) Kabul","id":50,"idIanaZone":"Asia/Kabul","salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"shortDescription":"GMT+04:30"}]}}}}}},"security":[{"SessionKey":[]}]}},"/users/schema":{"get":{"operationId":"users-schema","summary":"Users schema","description":"The Schema is metadata that tells you how the data is structured for a specific resource. The schema defines all the fields that exist for a User object.\n\nYou will only receive the Users Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Users schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\nFields like \"Value list\" have extra information:\n\n|**Attribute**|**Type**|**Description**|\n\n|--|--|--| \n| Table | String | The name of the values list table | \n| Type | Object, null | The kind of data you will receive in the response |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Users schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"billable":{"description":"","readOnly":true,"type":["boolean","null"]},"branch":{"description":"XXXXXXX","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"branches","type":["object","null"]},"branchRestriction":{"description":"XXXXXXX","readOnly":false,"type":["boolean","null"]},"branches":{"description":"","properties":{"description":{"type":["string","null"]},"id":{"type":"integer"},"readOnly":false,"required":["id"],"table":"branches","type":["object","null"]}},"computeInSfm":{"description":"XXXXXXX","readOnly":false,"type":["boolean","null"]},"computeSfm":{"description":"","readOnly":false,"type":["boolean","null"]},"dataDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"XXXXXXX","format":"date-time","readOnly":false,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dbLanguage":{"description":"","readOnly":false,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"email":{"maxLength":100,"readOnly":false,"type":["string","null"]},"extId":{"maxLength":100,"readOnly":false,"type":["string","null"]},"id":{"readOnly":true,"type":["integer","null"]},"idPrefix":{"description":"","properties":{"id":{"type":"integer"},"readOnly":false,"required":["id"],"table":"tblcountries","type":["object","null"],"value":{"type":["string","null"]}}},"isActive":{"description":"","readOnly":false,"type":["boolean","null"]},"lastName":{"maxLength":100,"readOnly":false,"type":["string","null"]},"lastPasswordChangeDate":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"level":{"maxLength":100,"readOnly":false,"type":["string","null"]},"locale":{"description":"","readOnly":false,"type":["string","null"]},"managerId":{"description":"","properties":{"id":{"type":"integer"},"readOnly":false,"required":["id"],"table":"tblUsuarios","type":["object","null"],"value":{"type":["string","null"]}}},"name":{"maxLength":180,"readOnly":false,"type":["string","null"]},"nic":{"maxLength":100,"readOnly":false,"type":["string","null"]},"password":{"description":"","readOnly":false,"type":["string","null"]},"phone":{"maxLength":100,"readOnly":false,"type":["string","null"]},"phoneExtension":{"maxLength":100,"readOnly":false,"type":["string","null"]},"rateId":{"description":"","properties":{"id":{"type":"integer"},"name":{"type":["string","null"]},"readOnly":false,"required":["id"],"table":"tbltarifas","type":["object","null"]}},"responsible":{"description":"XXXXXXX","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"users","type":["object","null"]},"salesRepIdCreated":{"readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"readOnly":true,"type":["integer","null"]},"session":{"description":"XXXXXXX","readOnly":false,"type":["boolean","null"]},"uiLanguage":{"description":"","readOnly":false,"type":["string","null"]},"userType":{"description":"XXXXXXX","properties":{"id":{"type":"integer"},"value":{"type":["string","null"]}},"readOnly":false,"required":["id"],"table":"usertypes","type":["object","null"]},"userTypeId":{"description":"","properties":{"description":{"type":["string","null"]},"id":{"type":"integer"},"readOnly":false,"required":["id"],"table":"userTypes","type":["object","null"]}}},"required":["name","lastName","branches","phone","email"],"title":"users","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/users":{"get":{"operationId":"list-users","summary":"List Users","description":"Returns all Users available in the user's ForceManager implementation database.\n\nYou will only receive the List of Users after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| lang | String | Define the language in which you want to receive the response |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/users?page=PAGE_NUMBER\n\n ```\n\nYou can **apply filters**.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/users?where= param1=value AND/OR param2=value2\n\n ```\n\nYou can filter Users by `firstName` or `salesRepId` for example.\n\nYou can also **organise and view** the results for Users in descendent order - at the top, the most recent results while the oldest results will be down the list.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/users?order=VALUE\n\n ```\n\nIn the request, and using query string parameters, you can also define the **language** in which you want to receive the response.\n\ne.g.\n\n```\nhttps://api.forcemanager.com/api/v4/users?lang=VALUE\n\n ```\n\n**RESPONSE**\n\nThis endpoint returns information about all Users available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported Users attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| isActive | Boolean | If true, the User is activated. It is visible and can login in the apps |\n| billable | Boolean | If true, the User is billable. ForceManager charges a fee for the user |\n| branches | Object, Null | Branches to which the User belongs to (see [Branches](#) resource) |\n| branchRestriction | Boolean | If true, the user has limited visibility in some branches |\n| computeSfm | Boolean | If true, the User counts for the sales analytics |\n| dateCreated | String | Date and time when the User was created |\n| dateDeleted | String | Date and time when the User was deleted |\n| dateUpdated | String | Date and time when the User was last updated |\n| deleted | Boolean | If true, the User has been deleted and archived |\n| email | String | User's email |\n| extId | String | External ID of the User from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The unique identifier of the User in ForceManager |\n| lastName | String | User's last name |\n| lastPasswordChangeDate | String | Date when the password was last changed |\n| level | Integer | Permission level of the User. Set from 1 to 5 being 5 the highest level of permission and visibility |\n| managerId | Object, Null | Unique identifier of the parent of the User (see [Users](#) resource) |\n| name | String | User's first name |\n| nic | String | User's name in ForceManager |\n| phone | String | User's phone number |\n| idPrefix | Integer | User's phone number Country ID (see [Countries](#) resource) |\n| phoneExtension | String | User's phone number extension |\n| rateId | Object, Null | Rate for the Order Header (see [Rates](#) resource) |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the User |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the User |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the User |\n| locale | String | The User locale. The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| dbLanguage | String | The User database language. The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| uiLanguage | String | The User UI language (the language in the mobile apps and webapp). The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| userTypeId | Object, Null | Type of the User (see [Types](#) resource) |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List Users","content":{"application/json":{"examples":{"default":{"value":[{"billable":false,"branches":{"description":"Headquarter","id":16},"computeSfm":true,"dateCreated":"2021-12-14T11:53:29.16Z","dateDeleted":"2021-12-14T12:13:45.097Z","dateUpdated":null,"dbLanguage":null,"deleted":true,"email":"Archana.Emma@forcemanager.io","extId":"ALPHA1","id":123,"idPrefix":null,"isActive":false,"lastName":"Archana","lastPasswordChangeDate":"2021-12-14T10:53:29.163Z","level":5,"locale":null,"managerId":{"description":" ","id":-1},"name":"Emma","nic":"Archana.Emma","phone":"808908565","phoneExtension":null,"rateId":{"description":null,"id":-1},"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"uiLanguage":null,"userTypeId":{"description":"Manager","id":3}}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-user","summary":"Create User","description":"This endpoint allows you to create a User based on JSON input.\n\nYou will only be able to create a User after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| isActive | Boolean | If true, the User is activated. It is visible and can login in the apps |\n| billable | Boolean | If true, the User is billable. ForceManager charges a fee for the user |\n| branches (*Required*) | Array | Branches to which the User belongs to (see [Branches](#) resource) |\n| branchRestriction | Boolean | If true, the user has limited visibility in some branches |\n| computeSfm | Boolean | If true, the User counts for the sales analytics |\n| email (*Required*) | String | User's email |\n| extId | String | External ID of the User from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The unique identifier of the User in ForceManager |\n| lastName (*Required*) | String | User's last name |\n| lastPasswordChangeDate | String | Date when the password was last changed |\n| level | Integer | Permission level of the User. Set from 1 to 5 being 5 the highest level of permission and visibility |\n| managerId | Integer | Unique identifier of the parent of the User (see [Users](#) resource) |\n| name (*Required*) | String | User's first name |\n| nic (*Required*) | String | User's name in ForceManager |\n| phone (*Required*) | String | User's phone number |\n| idPrefix (*Required*) | Integer | User's phone number Country ID (see [Countries](#) resource) |\n| phoneExtension | String | User's phone number extension |\n| rateId | Integer | Rate for the Order Header (see [Rates](#) resource) |\n| session | Object, Null | If true, the User has access to the app |\n| locale | String | The User locale. The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| dbLanguage (*Required*) | String | The User database language. The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| uiLanguage (*Required*) | String | The User UI language (the language in the mobile apps and webapp). The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| userType | Integer | Type of the User (see [Types](#) resource) |\n\n**RESPONSE**\n\nReturns a JSON with information about the User just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new User |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [optional]"}],"responses":{"200":{"description":"Create User","content":{"application/json":{"examples":{"default":{"value":{"billable":false,"branches":{"description":"Headquarter","id":16},"computeSfm":true,"dateCreated":"2021-12-16T12:01:08.033Z","dateDeleted":null,"dateUpdated":null,"dbLanguage":"EN","deleted":false,"email":"Sebastian.Waldedrudis@forcemanager.io","extId":"ALPHA2","id":125,"idPrefix":12,"isActive":true,"lastName":"Waldedrudis","lastPasswordChangeDate":"2021-12-16T11:01:08.033Z","level":5,"locale":"en-GB","managerId":{"description":" ","id":-1},"name":"Sebastian","nic":"Sebastian.Waldedrudis","phone":"009111456","phoneExtension":"+1","rateId":{"description":null,"id":-1},"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"uiLanguage":"EN","userTypeId":{"description":"Manager","id":3}}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"extId":{"type":"string"},"isActive":{"type":"boolean"},"branches":{"type":"integer"},"userTypeId":{"type":"integer"},"level":{"type":"integer"},"name":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"nic":{"type":"string"},"password":{"type":"string"},"phone":{"type":"string"},"phoneExtension":{"type":"string"},"idPrefix":{"type":"integer"},"managerId":{"type":"integer"},"rateId":{"type":"integer"},"computeSfm":{"type":"boolean"},"dbLanguage":{"type":"string"},"uiLanguage":{"type":"string"},"locale":{"type":"string"},"deleted":{"type":"boolean"}}},"examples":{"default":{"value":{"extId":"ALPHA2","isActive":true,"branches":16,"userTypeId":3,"level":5,"name":"Sebastian","lastName":"Waldedrudis","email":"Sebastian.Waldedrudis@forcemanager.io","nic":"Sebastian.Waldedrudis","password":"i2E456T89o","phone":"009111456","phoneExtension":"+1","idPrefix":12,"managerId":-1,"rateId":-1,"computeSfm":true,"dbLanguage":"EN","uiLanguage":"EN","locale":"en-GB","deleted":false}}}}}}}},"/users/{ID}":{"get":{"operationId":"get-user","summary":"Get User","description":"This endpoint retrieves data of a specific User based on JSON input. The API returns a single User available to the user, according to the unique ID provided. If the specified User does not exist, the response will be a \"bad request\".\n\nYou will only receive the User after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the User |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| isActive | Boolean | If true, the User is activated. It is visible and can login in the apps |\n| billable | Boolean | If true, the User is billable. ForceManager charges a fee for the user |\n| branches | Object, Null | Branches to which the User belongs to (see [Branches](#) resource) |\n| branchRestriction | Boolean | If true, the user has limited visibility in some branches |\n| computeSfm | Boolean | If true, the User counts for the sales analytics |\n| dateCreated | String | Date and time when the User was created |\n| dateDeleted | String | Date and time when the User was deleted |\n| dateUpdated | String | Date and time when the User was last updated |\n| deleted | Boolean | If true, the User has been deleted and archived |\n| email | String | User's email |\n| extId | String | External ID of the User from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The unique identifier of the User in ForceManager |\n| lastName | String | User's last name |\n| lastPasswordChangeDate | String | Date when the password was last changed |\n| level | Integer | Permission level of the User. Set from 1 to 5 being 5 the highest level of permission and visibility |\n| managerId | Object, Null | Unique identifier of the parent of the User (see [Users](#) resource) |\n| name | String | User's first name |\n| nic | String | User's name in ForceManager |\n| phone | String | User's phone number |\n| idPrefix | Integer | User's phone number Country ID (see [Countries](#) resource) |\n| phoneExtension | String | User's phone number extension |\n| rateId | Object, Null | Rate for the Order Header (see [Rates](#) resource) |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the User |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the User |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the User |\n| session | Object, Null | If true, the User has access to the app |\n| locale | String | The User locale. The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| dbLanguage | String | The User database language. The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| uiLanguage | String | The User UI language (the language in the mobile apps and webapp). The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| userType | Object, Null | Type of the User (see [Types](#) resource) |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [optional]"}],"responses":{"200":{"description":"Get User","content":{"application/json":{"examples":{"default":{"value":{"billable":false,"branches":{"description":"Headquarter","id":16},"computeSfm":true,"dateCreated":"2021-12-16T12:01:08.033Z","dateDeleted":null,"dateUpdated":null,"dbLanguage":"EN","deleted":false,"email":"Sebastian.Waldedrudis@forcemanager.io","extId":"ALPHA2","id":125,"idPrefix":12,"isActive":true,"lastName":"Waldedrudis","lastPasswordChangeDate":"2021-12-16T11:01:08.033Z","level":5,"locale":"en-GB","managerId":{"description":" ","id":-1},"name":"Sebastian","nic":"Sebastian.Waldedrudis","phone":"009111456","phoneExtension":"+1","rateId":{"description":null,"id":-1},"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null,"uiLanguage":"EN","userTypeId":{"description":"Manager","id":3}}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-user","summary":"Update User","description":"This endpoint allows you to update a specific User. If the specified User does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a User after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific User. In order to update a User, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| isActive | Boolean | If true, the User is activated. It is visible and can login in the apps |\n| billable | Boolean | If true, the User is billable. ForceManager charges a fee for the user |\n| branches | Array | Branches to which the User belongs to (see [Branches](#) resource) |\n| branchRestriction | Boolean | If true, the user has limited visibility in some branches |\n| computeSfm | Boolean | If true, the User counts for the sales analytics |\n| email | String | User's email |\n| extId | String | External ID of the User from a third party system (ERP, CRM, Accounting System) |\n| id | Integer | The unique identifier of the User in ForceManager |\n| lastName | String | User's last name |\n| lastPasswordChangeDate | String | Date when the password was last changed |\n| level | Integer | Permission level of the User. Set from 1 to 5 being 5 the highest level of permission and visibility |\n| managerId | Integer | Unique identifier of the parent of the User (see [Users](#) resource) |\n| name | String | User's first name |\n| nic | String | User's name in ForceManager |\n| phone | String | User's phone number |\n| idPrefix | Integer | User's phone number Country ID (see [Countries](#) resource) |\n| phoneExtension | String | User's phone number extension |\n| rateId | Integer | Rate for the Order Header (see [Rates](#) resource) |\n| session | Object, Null | If true, the User has access to the app |\n| locale | String | The User locale. The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| dbLanguage | String | The User database language. The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| uiLanguage | String | The User UI language (the language in the mobile apps and webapp). The values can be: \"ES\", \"EN\", \"US\", \"IT\", \"DE\", \"PT\", \"BR\", \"RU\" |\n| userType | Integer | Type of the User (see [Types](#) resource) |\n\n**RESPONSE**\n\nReturns a JSON with information about the User just updated.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"Number (e.g. 10) [optional]"}],"responses":{"200":{"description":"Update User","content":{"application/json":{"examples":{"default":{"value":{"billable":false,"branches":{"description":"Headquarter","id":16},"computeSfm":true,"dateCreated":"2021-12-16T12:01:08.033Z","dateDeleted":null,"dateUpdated":"2021-12-16T12:03:16.97Z","dbLanguage":"EN","deleted":false,"email":"Sebastian.Waldedrudis@forcemanager.io","extId":"ALPHA3","id":125,"idPrefix":12,"isActive":false,"lastName":"Waldedrudis","lastPasswordChangeDate":"2021-12-16T11:01:08.033Z","level":5,"locale":"en-GB","managerId":{"description":" ","id":-1},"name":"Sebastian","nic":"Sebastian.Waldedrudis","phone":"009111456","phoneExtension":"+1","rateId":{"description":null,"id":-1},"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":51,"uiLanguage":"EN","userTypeId":{"description":"Manager","id":3}}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"extId":{"type":"string"},"isActive":{"type":"boolean"}}},"examples":{"default":{"value":{"extId":"ALPHA3","isActive":false}}}}}}},"delete":{"operationId":"delete-user","summary":"Delete User","description":"This endpoint allows you to delete a specific User from the user's ForceManager account database. If the specified User does not exist, the response will be a \"bad request\". This operation cannot be undone.\n
You will only be able to delete a User after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login)\n\n\n**HEADERS**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | The acceptance |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n\n
\n\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| id | Integer | The unique and specific identifier of the User to delete |\n\n\n
\n\n**RESPONSE**\n\nReturns a JSON with information about the User just deleted.\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| Message | String | Shows the operation status |\n\n
\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete User","content":{"application/json":{"examples":{"default":{"value":{"id":200,"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/users/{ID}/hierarchy":{"get":{"operationId":"list-user-hierarchy","summary":"List User Hierarchy","description":"This endpoint retrieves the hierarchy of a User based on JSON input. Specifically, an array of JSON data is returned, that reports the `id` and the `name` of each user that are below the requested User, on a hierarchical perspective.\n\nYou will only receive the User hierarchy after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the User |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Object, Null | Unique identifier of the User (see [Users](#) resource) |\n| name | String | User's name |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List User Hierarchy","content":{"application/json":{"examples":{"default":{"value":[{"id":121,"name":"Elmas Cyrillus"},{"id":125,"name":"Sebastian.Waldedrudis"}]}}}}}},"security":[{"SessionKey":[]}]}},"/users/scores":{"get":{"operationId":"list-users-scores","summary":"List Users Scores","description":"This endpoint retrieves the activity and sales Scores of the Users - which measured via the ForceActivity algorithm - based on JSON input. Specifically, an array of JSON data is returned.\n\nYou will only receive the Users Scores after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nYou can apply filters. The order of the parameters does not matter.\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| offset | Integer | Define position from which the records must be returned |\n| count | Integer | Define the number of results to return |\n\ne.g.\n
https://api.forcemanager.com/api/v4/users/scores?offset=VALUE&count=VALUE
\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Object, Null | Unique identifier of the User (see [Users](#) resource) |\n| points | Number | User ForceActivity Activities score |\n| sales | Number | User ForceActivity Sales score |\n| lastUpdate | String | Date in which the score had been updated |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Users Scores","content":{"application/json":{"examples":{"default":{"value":[{"id":121,"points":120,"sales":450,"lastUpdate":"2021-12-16T18:04:11.627Z"},{"id":122,"points":10,"sales":789,"lastUpdate":"2021-12-16T18:04:11.627Z"}]}}}}}},"security":[{"SessionKey":[]}]}},"/userTypes/schema":{"get":{"operationId":"user-types-schema","summary":"User Types schema","description":"Returns properties object with the definition of each field in the User Type table.\n\nYou will only receive the User Types Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe User Types Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"X-FM-Entity-Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"User Types schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"branchVisibility":{"description":"","items":{"properties":{"id":{"type":"integer","value":{"type":["string","null"]}}},"required":["id"],"type":"object"},"readOnly":false,"table":"branches","type":["array","null"]},"dateCreated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateDeleted":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"dateUpdated":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"deleted":{"description":"","readOnly":true,"type":["boolean","null"]},"descriptionBR":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionDE":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionDK":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionEN":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionES":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"descriptionFR":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionIT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionPT":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descriptionRU":{"description":"","maxLength":6000,"readOnly":false,"type":["string","null"]},"descriptionUS":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdCreated":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdDeleted":{"description":"","readOnly":true,"type":["integer","null"]},"salesRepIdUpdated":{"description":"","readOnly":true,"type":["integer","null"]}},"required":[],"title":"userTypes","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/userTypes":{"get":{"operationId":"list-user-types","summary":"List User Types","description":"Returns all User Types available in the user's ForceManager implementation database.\n\nYou will only receive the List of User Types after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n| ExtraFieldDescription | {number} | If equal to \"0\", the response returns only the value of each Extra Fields, if equal to \"1\" also the description is returned |\n\n**RESPONSE**\n\nThis endpoint returns information about all User Types available in the database.\n\nIf you didn't apply any page or count number in the header the default number of records in the response is 50.\n\nList of the supported User Types attributes:\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| branchVisibility | Object, Null | In which Branch the User Type is visible |\n| dateCreated | String | Date and time when the User Type was created |\n| dateDeleted | String | Date and time when the User Type was deleted |\n| dateUpdated | String | Date and time when the User Type was last updated |\n| deleted | Boolean | If true, the User Type has been deleted and archived |\n| descriptionBR | String | User Type label in Brasilian Portuguese |\n| descriptionDE | String | User Type label in German |\n| descriptionDK | String | User Type label in Dutch |\n| descriptionEN | String | User Type label in English |\n| descriptionES | String | User Type label in Spanish |\n| descriptionFR | String | User Type label in French |\n| descriptionIT | String | User Type label in Italian |\n| descriptionPT | String | User Type label in Portuguese |\n| descriptionRU | String | User Type label in Russian |\n| descriptionUS | String | User Type label in American English |\n| id | Integer | Unique identifier for the User Type in ForceManager |\n| order | Integer | The position of the User Type in the User Typees value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the User Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the User Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the User Type |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"},{"name":"Count","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"},{"name":"ExtraFieldDescription","in":"header","required":false,"schema":{"type":"string"},"example":"VALUE"}],"responses":{"200":{"description":"List User Types","content":{"application/json":{"examples":{"default":{"value":[{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.83Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.83Z","deleted":false,"descriptionBR":null,"descriptionDE":"Vertreter","descriptionDK":null,"descriptionEN":"Commercial","descriptionES":"Comercial","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":1,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.83Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.83Z","deleted":false,"descriptionBR":null,"descriptionDE":"Verwaltung","descriptionDK":null,"descriptionEN":"Administration","descriptionES":"Administración","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":2,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.83Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.83Z","deleted":false,"descriptionBR":null,"descriptionDE":"Management","descriptionDK":null,"descriptionEN":"Management","descriptionES":"Dirección","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":3,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.83Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.83Z","deleted":false,"descriptionBR":null,"descriptionDE":"Verkaufsdienst","descriptionDK":null,"descriptionEN":"Sales Service","descriptionES":"SAT","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":4,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1},{"branchVisibility":null,"dateCreated":"2013-01-10T11:12:24.09Z","dateDeleted":null,"dateUpdated":null,"deleted":false,"descriptionBR":null,"descriptionDE":"Systemadministrator","descriptionDK":null,"descriptionEN":"System Administrator","descriptionES":"System Administrator","descriptionFR":"System Administrator","descriptionIT":"System Administrator","descriptionPT":"System Administrator","descriptionRU":null,"descriptionUS":null,"id":5,"salesRepIdCreated":51,"salesRepIdDeleted":null,"salesRepIdUpdated":null}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-user-type","summary":"Create User Type","description":"This endpoint allows you to create a User Type based on JSON input. \n\nYou will only be able to create a User Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| branchVisibility | Array | In which Branch the User Type is visible |\n| descriptionBR | String | User Type label in Brasilian Portuguese |\n| descriptionDE | String | User Type label in German |\n| descriptionDK | String | User Type label in Dutch |\n| descriptionEN (*Required*) | String | User Type label in English |\n| descriptionES | String | User Type label in Spanish |\n| descriptionFR | String | User Type label in French |\n| descriptionIT | String | User Type label in Italian |\n| descriptionPT | String | User Type label in Portuguese |\n| descriptionRU | String | User Type label in Russian |\n| descriptionUS | String | User Type label in American English |\n| order | Integer | The position of the User Type in the User Types value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the User Type just created. \n\n|**Attribute**|**Type**|\n|---|---|\n| Id | Id assigned to the new User Type |\n| Message | The operation status |\n\n\n
\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create User Type","content":{"application/json":{"examples":{"default":{"value":{"id":7,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"}}},"examples":{"default":{"value":{"descriptionEN":"Advisor"}}}}}}}},"/userTypes/{ID}":{"get":{"operationId":"get-user-type","summary":"Get User Type","description":"This endpoint retrieves data of a specific User Type based on JSON input. The API returns a single User Type available to the user in the Value List, according to the unique ID provided. If the specified User Type does not exist, the response will be a \"bad request\".\n\nYou will only receive the User Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| id | Integer | The unique and specific identifier of the User Type |\n\n**RESPONSE**\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| branchVisibility | Array | In which Branch the User Type is visible |\n| dateCreated | String | Date and time when the User Type was created |\n| dateDeleted | String | Date and time when the User Type was deleted |\n| dateUpdated | String | Date and time when the User Type was last updated |\n| deleted | Boolean | If true, the User Type has been deleted and archived |\n| descriptionBR | String | User Type label in Brasilian Portuguese |\n| descriptionDE | String | User Type label in German |\n| descriptionDK | String | User Type label in Dutch |\n| descriptionEN (*Required*) | String | User Type label in English |\n| descriptionES | String | User Type label in Spanish |\n| descriptionFR | String | User Type label in French |\n| descriptionIT | String | User Type label in Italian |\n| descriptionPT | String | User Type label in Portuguese |\n| descriptionRU | String | User Type label in Russian |\n| descriptionUS | String | User Type label in American English |\n| id | Integer | Unique identifier for the User Type in ForceManager |\n| order | Integer | The position of the User Type in the User Typees value list |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the User Type |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the User Type |\n| salesRepIdUpdated | Integer | Unique identifier of the user who last updated the User Type |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get User Type","content":{"application/json":{"examples":{"default":{"value":{"branchVisibility":null,"dateCreated":"2012-01-27T12:22:54.83Z","dateDeleted":null,"dateUpdated":"2012-01-27T12:22:54.83Z","deleted":false,"descriptionBR":null,"descriptionDE":"Management","descriptionDK":null,"descriptionEN":"Management","descriptionES":"Dirección","descriptionFR":null,"descriptionIT":null,"descriptionPT":null,"descriptionRU":null,"descriptionUS":null,"id":3,"salesRepIdCreated":1,"salesRepIdDeleted":null,"salesRepIdUpdated":1}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-user-type","summary":"Update User Type","description":"This endpoint allows you to update a specific User Type. If the specified User Type does not exist, the response will be a \"bad request\".\n\nYou will only be able to update a User Type after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n\n**REQUEST**\n\nThis endpoint allows updating the information of a specific User Type. In order to update an User Type, 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.**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| branchVisibility | Array | In which Branch the User Type is visible |\n| descriptionBR | String | User Type label in Brasilian Portuguese |\n| descriptionDE | String | User Type label in German |\n| descriptionDK | String | User Type label in Dutch |\n| descriptionEN | String | User Type label in English |\n| descriptionES | String | User Type label in Spanish |\n| descriptionFR | String | User Type label in French |\n| descriptionIT | String | User Type label in Italian |\n| descriptionPT | String | User Type label in Portuguese |\n| descriptionRU | String | User Type label in Russian |\n| descriptionUS | String | User Type label in American English |\n| order | Integer | The position of the User Type in the User Types value list |\n\n**RESPONSE**\n\nReturns a JSON with information about the User Type just updated.\n\n|**Attribute**|**Description**|\n|---|---|\n| Message | Shows the operation status |\n\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update User Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionDE":{"type":"string"}}},"examples":{"default":{"value":{"descriptionDE":null}}}}}}}},"/userTypes/7":{"delete":{"operationId":"delete-user-type","summary":"Delete User Type","description":"This endpoint allows you to delete a specific Product Family. If the specified Product Family does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete a Product Family after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Product Family to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Product Family just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Users / Types"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete User Type","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/list":{"get":{"operationId":"list-lists","summary":"List Lists","description":"Returns all Lists available in the user's ForceManager implementation database based on JSON input.\n\nYou will only receive the Lists after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all Lists.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| databaseName (_Required_) | String | Name of the List at database level |\n| description (_Required_) | String | List name in Spanish |\n| descriptionBR | String | List name in Brasilian Portuguese |\n| descriptionDE | String | List name in German |\n| descriptionDK | String | List name in Dutch |\n| descriptionEN | String | List name in English |\n| descriptionFR | String | List name in French |\n| descriptionIT | String | List name in Italian |\n| descriptionPT | String | List name in Portuguese |\n| descriptionRU | String | List name in Russian |\n| descripcionUS | String | List name in American English |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Value Lists / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Lists","content":{"application/json":{"examples":{"default":{"value":[{"databaseName":"Z_tblSources","description":"Sources","descriptionEN":"","descriptionIT":"","descriptionFR":"","descriptionDE":"","descriptionPT":"","descriptionUS":"","descriptionBR":"","descriptionRU":"","descriptionDK":""},{"databaseName":"Z_awesomeTable","description":"Awesome Table","descriptionIT":"","descriptionFR":"","descriptionDE":"","descriptionPT":"","descriptionUS":"","descriptionBR":"","descriptionRU":"","descriptionDK":""}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-list","summary":"Create List","description":"This endpoint allows you to create a List based on JSON input.\n\nYou will only be able to create a List after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| databaseName (*Required*) | String | Name of the List at database level |\n| description (*Required*) | String | List name in Spanish |\n| descriptionBR | String | List name in Brasilian Portuguese |\n| descriptionDE | String | List name in German |\n| descriptionDK | String | List name in Dutch |\n| descriptionEN | String | List name in English |\n| descriptionFR | String | List name in French |\n| descriptionIT | String | List name in Italian |\n| descriptionPT | String | List name in Portuguese |\n| descriptionRU | String | List name in Russian |\n| descripcionUS | String | List name in American English |\n\n**RESPONSE**\n\nReturns a JSON with information about the List just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| databaseName | String |\n| description | String |\n| descriptionBR | String |\n| descriptionDE | String |\n| descriptionDK | String |\n| descriptionEN | String |\n| descriptionFR | String |\n| descriptionIT | String |\n| descriptionPT | String |\n| descriptionRU | String |\n| descripcionUS | String |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Value Lists / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create List","content":{"application/json":{"examples":{"default":{"value":{"databaseName":"Z_awesomeTable","description":"Awesome Table","descriptionEN":"","descriptionIT":"","descriptionFR":"","descriptionDE":"","descriptionPT":"","descriptionUS":"","descriptionBR":"","descriptionRU":"","descriptionDK":""}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"databaseName":{"type":"string"},"description":{"type":"string"}}},"examples":{"default":{"value":{"databaseName":"awesomeTable","description":"Awesome Table"}}}}}}}},"/list/VALUE":{"put":{"operationId":"update-list","summary":"Update List","description":"This endpoint allows you to update a specific List's information. If the specified List does not exist, the response will be a \"bad request\".\n\nYou will only receive the Resource's information after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication. \nTo know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| databaseName | String | Name of the List at database level |\n| description | String | List name in Spanish |\n| descriptionBR | String | List name in Brasilian Portuguese |\n| descriptionDE | String | List name in German |\n| descriptionDK | String | List name in Dutch |\n| descriptionEN | String | List name in English |\n| descriptionFR | String | List name in French |\n| descriptionIT | String | List name in Italian |\n| descriptionPT | String | List name in Portuguese |\n| descriptionRU | String | List name in Russian |\n| descripcionUS | String | List name in American English |\n\n**RESPONSE**\n\nReturns a JSON with information about the List just updated.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| databaseName | String |\n| description | String |\n| descriptionBR | String |\n| descriptionDE | String |\n| descriptionDK | String |\n| descriptionEN | String |\n| descriptionFR | String |\n| descriptionIT | String |\n| descriptionPT | String |\n| descriptionRU | String |\n| descripcionUS | String |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Value Lists / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update List","content":{"application/json":{"examples":{"default":{"value":{"databaseName":"Z_awesomeTable","description":"Extraordinary table","descriptionEN":"","descriptionIT":"","descriptionFR":"","descriptionDE":"","descriptionPT":"","descriptionUS":"","descriptionBR":"","descriptionRU":"","descriptionDK":""}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionEN":{"type":"string"}}},"examples":{"default":{"value":{"descriptionEN":"Extraordinary table"}}}}}}},"delete":{"operationId":"delete-list","summary":"Delete List","description":"This endpoint allows you to delete a specific List. If the specified List does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete a Value after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| resource | Integer | The unique and specific identifier (its database name) of the List to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the List just deleted.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Value Lists / Entity"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete List","content":{"application/json":{"examples":{"default":{"value":{"code":1,"message":"success"}}}}}}},"security":[{"SessionKey":[]}]},"get":{"operationId":"list-values","summary":"List Values","description":"Returns all Values for the Value List available in the user's ForceManager implementation database based on JSON input.\n\nYou will only receive the Values for the Value List after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns all values for the customised Value List.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| UserBorrado | Integer | The id of the user that deleted the value |\n| UserCreado | Integer | The id of the user that created the value |\n| UserModificado | Integer | The id of the user that updated the value |\n| borrado | Boolean | If true, the Value has been deleted |\n| descripcion | String | Value name in Spanish |\n| descripcion_br | String | Value name in Brasilian Portuguese |\n| descripcion_de | String | Value name in German |\n| descripcion_dk | String | Value name in Dutch |\n| descripcion_en | String | Value name in English |\n| descripcion_fr | String | Value name in French |\n| descripcion_it | String | Value name in Italian |\n| descripcion_pt | String | Value name in Portuguese |\n| descripcion_ru | String | Value name in Russian |\n| descripcion_us | String | Value name in American English |\n| extId | String | External unique identifier for the Value |\n| fCreado | String | The date when the value was created |\n| fModificado | String | The date when the value was last updated |\n| fborrado | String | The date when the value was deleted |\n| id | Integer | Unique identifier for the Value in ForceManager |\n| idParent | Integer | The id of the entity that the Value depends to, that determines if the Value is visible or not |\n| intOrder | Integer | The order of the value in the list |\n| strIdEnvironment | String | The branch where this value is visible |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Value Lists / Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Values","content":{"application/json":{"examples":{"default":{"value":[{"UserBorrado":null,"UserCreado":51,"UserModificado":null,"borrado":false,"descripcion":"Webinar","descripcion_br":"Webinar","descripcion_de":"Webinar","descripcion_dk":"Webinar","descripcion_en":"Webinar","descripcion_fr":"Webinar","descripcion_it":"Webinar","descripcion_pt":"Webinar","descripcion_ru":"Webinar","descripcion_us":"Webinar","extId":"","fCreado":"2019-03-04T12:01:50.247Z","fModificado":null,"fborrado":null,"id":2,"idParent":0,"intOrder":0,"strIdEnvironment":";;"},{"UserBorrado":null,"UserCreado":51,"UserModificado":null,"borrado":false,"descripcion":"Referral","descripcion_br":"Referral","descripcion_de":"Referral","descripcion_dk":"Referral","descripcion_en":"Referral","descripcion_fr":"Referral","descripcion_it":"Referral","descripcion_pt":"Referral","descripcion_ru":"Referral","descripcion_us":"Referral","extId":"","fCreado":"2019-03-04T12:02:02.79Z","fModificado":null,"fborrado":null,"id":3,"idParent":0,"intOrder":0,"strIdEnvironment":";;"},{"UserBorrado":null,"UserCreado":51,"UserModificado":null,"borrado":false,"descripcion":"Google AdWords","descripcion_br":"Google AdWords","descripcion_de":"Google AdWords","descripcion_dk":"Google AdWords","descripcion_en":"Google AdWords","descripcion_fr":"Google AdWords","descripcion_it":"Google AdWords","descripcion_pt":"Google AdWords","descripcion_ru":"Google AdWords","descripcion_us":"Google AdWords","extId":"","fCreado":"2019-03-04T12:04:46.08Z","fModificado":null,"fborrado":null,"id":19,"idParent":0,"intOrder":0,"strIdEnvironment":";;"},{"UserBorrado":null,"UserCreado":51,"UserModificado":null,"borrado":false,"descripcion":"Facebook","descripcion_br":"Facebook","descripcion_de":"Facebook","descripcion_dk":"Facebook","descripcion_en":"Facebook","descripcion_fr":"Facebook","descripcion_it":"Facebook","descripcion_pt":"Facebook","descripcion_ru":"Facebook","descripcion_us":"Facebook","extId":"","fCreado":"2019-03-04T12:04:50.657Z","fModificado":null,"fborrado":null,"id":20,"idParent":0,"intOrder":0,"strIdEnvironment":";;"}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-value","summary":"Create Value","description":"This endpoint allows you to create a single Value or a complete Value List based on JSON input.\n\nYou will only be able to create a Value after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| descripcion (*Required*) | String | Value name in Spanish |\n| descripcion_br | String | Value name in Brasilian Portuguese |\n| descripcion_de | String | Value name in German |\n| descripcion_dk | String | Value name in Dutch |\n| descripcion_en | String | Value name in English |\n| descripcion_fr | String | Value name in French |\n| descripcion_it | String | Value name in Italian |\n| descripcion_pt | String | Value name in Portuguese |\n| descripcion_ru | String | Value name in Russian |\n| descripcion_us | String | Value name in American English |\n| extId | String | External unique identifier for the Value |\n| idParent | Integer | The id of the entity that the Value depends to, that determines if the Value is visible or not |\n| intOrder | Integer | The order of the value in the list |\n| strIdEnvironment | String | The branch where this value is visible |\n\n**RESPONSE**\n\nReturns a JSON with information about the Value just created.\n\n| **Attribute** | **Type** |\n| --- | --- |\n| Id | Id assigned to the new Value |\n| Message | The operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Value Lists / Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Value","content":{"application/json":{"examples":{"default":{"value":{"id":21,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionES":{"type":"string"},"order":{"type":"integer"}}},"examples":{"default":{"value":{"descriptionES":"Instagram","order":2}}}}}}}},"/list/VALUE/schema":{"get":{"operationId":"values-list-schema","summary":"Values List schema","description":"The Value List API provides a simple interface to manage your extra or customised Value Lists. Value Lists are personalised and predetermined values that help you unify criteria when entering data into a field and help organise these elements.\n\nThe Schema is metadata that tells you how the data is structured for this specific customised Value List.\n\nYou will only receive the Value List Schema after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**RESPONSE**\n\nThe Value List Schema is a fields structure with the resource. For each property the API Schema will provide you some information:\n\n* Description of each property\n* Definition of the data type for each property\n* Whether each property is required or optional\n \n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Field name | Object | Name of the attribute in ForceManager Schema |\n| Properties | Object | Definition of the entity |\n| Id | Object | Identifier of the value of field name |\n| Value | Object | The value of the field name |\n| Type | Object, String, Integer, Number, Boolean, Null | The kind of data you have to complete the field with |\n| Required | Array | If it’s a mandatory field or not |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Value Lists / Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Values List schema","content":{"application/json":{"examples":{"default":{"value":{"properties":{"UserBorrado":{"description":"","readOnly":true,"type":["integer","null"]},"UserCreado":{"description":"","readOnly":true,"type":["integer","null"]},"UserModificado":{"description":"","readOnly":true,"type":["integer","null"]},"borrado":{"description":"","readOnly":true,"type":["boolean","null"]},"descripcion":{"description":"","maxLength":70,"readOnly":false,"type":["string","null"]},"descripcion_br":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descripcion_de":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descripcion_dk":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descripcion_en":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descripcion_fr":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descripcion_it":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descripcion_pt":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descripcion_ru":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"descripcion_us":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]},"extId":{"description":"","maxLength":100,"readOnly":false,"type":["string","null"]},"fCreado":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"fModificado":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"fborrado":{"description":"","format":"date-time","readOnly":true,"type":["string","null"]},"id":{"description":"","readOnly":true,"type":["integer","null"]},"idParent":{"description":"","readOnly":false,"type":["integer","null"]},"intOrder":{"description":"","readOnly":false,"type":["integer","null"]},"strIdEnvironment":{"description":"","maxLength":150,"readOnly":false,"type":["string","null"]}},"required":["descripcion"],"title":"z_tblsources","type":"object"}}}}}}},"security":[{"SessionKey":[]}]}},"/list/VALUE/{ID}":{"get":{"operationId":"get-value","summary":"Get Value","description":"This endpoint retrieves data of a specific Value from a specific Value List based on JSON input. The API returns a single Value available to the user in the Value List, according to the unique ID provided. If the specified Value or Value List do not exist, the response will be a \"bad request\".\n\nYou will only receive the Value after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Value |\n\n**RESPONSE**\n\nThis endpoint returns just one Value from the Value List.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| UserBorrado | Integer | The id of the user that deleted the value |\n| UserCreado | Integer | The id of the user that created the value |\n| UserModificado | Integer | The id of the user that updated the value |\n| borrado | Boolean | If true, the Value has been deleted |\n| descripcion | String | Value name in Spanish |\n| descripcion_br | String | Value name in Brasilian Portuguese |\n| descripcion_de | String | Value name in German |\n| descripcion_dk | String | Value name in Dutch |\n| descripcion_en | String | Value name in English |\n| descripcion_fr | String | Value name in French |\n| descripcion_it | String | Value name in Italian |\n| descripcion_pt | String | Value name in Portuguese |\n| descripcion_ru | String | Value name in Russian |\n| descripcion_us | String | Value name in American English |\n| extId | String | External unique identifier for the Value |\n| fCreado | String | The date when the value was created |\n| fModificado | String | The date when the value was last updated |\n| fborrado | String | The date when the value was deleted |\n| id | Integer | Unique identifier for the Value in ForceManager |\n| idParent | Integer | The id of the entity that the Value depends to, that determines if the Value is visible or not |\n| intOrder | Integer | The order of the value in the list |\n| strIdEnvironment | String | The branch where this value is visible |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Value Lists / Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Value","content":{"application/json":{"examples":{"default":{"value":{"UserBorrado":null,"UserCreado":51,"UserModificado":null,"borrado":false,"descripcion":"Instagram","descripcion_br":null,"descripcion_de":null,"descripcion_dk":null,"descripcion_en":null,"descripcion_fr":null,"descripcion_it":null,"descripcion_pt":null,"descripcion_ru":null,"descripcion_us":null,"extId":null,"fCreado":"2021-12-08T11:29:49.82Z","fModificado":null,"fborrado":null,"id":21,"idParent":null,"intOrder":null,"strIdEnvironment":null}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-value","summary":"Update Value","description":"This endpoint allows you to update a specific Value List's information. If the specified Value does not exist, the response will be a \"bad request\".\n\nYou will only receive the Resource's information after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication. \nTo know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| descripcion | String | Value name in Spanish |\n| descripcion_br | String | Value name in Brasilian Portuguese |\n| descripcion_de | String | Value name in German |\n| descripcion_dk | String | Value name in Dutch |\n| descripcion_en | String | Value name in English |\n| descripcion_fr | String | Value name in French |\n| descripcion_it | String | Value name in Italian |\n| descripcion_pt | String | Value name in Portuguese |\n| descripcion_ru | String | Value name in Russian |\n| descripcion_us | String | Value name in American English |\n| extId | String | External unique identifier for the Value |\n| idParent | Integer | The id of the entity that the Value depends to, that determines if the Value is visible or not |\n| intOrder | Integer | The order of the value in the list |\n| strIdEnvironment | String | The branch where this value is visible |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Value Lists / Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Value","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"descriptionES":{"type":"string"},"order":{"type":"integer"}}},"examples":{"default":{"value":{"descriptionES":"Facebook","order":3}}}}}}},"delete":{"operationId":"delete-value","summary":"Delete Value","description":"This endpoint allows you to delete a specific Value from a Value List. If the specified Value does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete a Value after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Value to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the Value just deleted.\n\n| **Attribute** | **Description** |\n| --- | --- |\n| Message | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Value Lists / Values"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Value","content":{"application/json":{"examples":{"default":{"value":{"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/VALUE/VALUE/warnings":{"get":{"operationId":"list-warnings-of-a-resource","summary":"List Warnings of a Resource","description":"Returns all Warnings associated to the specific Resource (`accounts`, `opportunities`, `products`, `salesorders`) available in the user's ForceManager implementation database.\n\nYou will only receive the List of Warnings after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\nYou 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.\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| page | Integer | Define the pagination data for the returned objects |\n| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |\n| 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 |\n| resource | String | The Resource name you want to retrieve data (accounts, contacts, opportunities, sales orders, etc) |\n| resourceId | Integer | The unique and specific identifier for the Resource to retrieve data |\n\nYou can define the **pagination** data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.\n\ne.g.\n\n```\n https://api.forcemanager.com/api/v4/accounts/1/warnings?page=PAGE_NUMBER\n\n ```\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The ID of the Warning |\n| text | String | The message that represents the Warning |\n| dateCreated | String | Date and time when the Warning was created |\n| dateDeleted | String | Date and time when the Warning was deleted |\n| dateUpdated | String | Date and time when the Warning was last updated |\n| deleted | boolean | If true, the Warning has been deleted |\n| enabled | boolean | If true, the Warning has been enabled |\n| salesRepIdCreated | Integer | Unique identifier of the user who created the Warning |\n| salesRepIdDeleted | Integer | Unique identifier of the user who deleted the Warning |\n| salesRepIdUpdated | Integer | Unique identifier of the user who updated the Warning |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Warnings"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Warnings of a Resource","content":{"application/json":{"examples":{"default":{"value":[{"id":2,"text":"This is an example of a warning!","dateCreated":"2021-07-02T16:22:52.093Z","dateUpdated":null,"dateDeleted":null,"salesRepIdDeleted":null,"salesRepIdCreated":51,"salesRepIdUpdated":null,"deleted":false,"enabled":true}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-warning-for-a-resource-copy","summary":"Create Warning for a Resource Copy","description":"This endpoint allows you to create a Warning in the specific Resource (`accounts`, `opportunities`, `products`, `salesorders`) based on JSON input.\n\nYou will only be able to create a Warning after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| resource | String | The Resource name you want to create the Warning (`accounts`, `opportunities`, `products`, `salesorders`) |\n| resourceId | Integer | The unique and specific identifier of the Resource |\n| warningId | Integer | The unique and specific identifier of the Warning |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| text | String | The message that represents the Warning |\n| enabled | boolean | If true, the Warning will be enabled |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new Warning |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Warnings"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Warning for a Resource","content":{"application/json":{"examples":{"default":{"value":{"id":2,"Message":"entity created"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"},"enabled":{"type":"boolean"}}},"examples":{"default":{"value":{"text":"This is an example of a warning!","enabled":true}}}}}}}},"/VALUE/VALUE/warnings/VALUE":{"put":{"operationId":"update-warning-of-a-resource","summary":"Update Warning of a Resource","description":"This endpoint allows you to update a Warning in the specific Resource (accounts, opportunities, products, salesorders) based on JSON input. \n
You will only be able to update a Warning after first providing the Session Key. To know how you can obtain the Session Key, go to [Authentication.](#)\n\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n|---|---|---|\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | The acceptance |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| resource | String | The Resource name you want to update the Warning (`accounts`, `opportunities`, `products`, `salesorders`) |\n| resourceId | Integer | The unique and specific identifier of the Resource |\n| warningId | Integer | The unique and specific identifier of the Warning |\n\n\n**REQUEST BODY**\n\n|**Parameter**|**Type**|**Description**|\n|---|---|---|\n| text | String | The message that represents the Warning |\n| enabled | boolean | If true, the Warning will be enabled |\n\n\n**RESPONSE**\n\n|**Attribute**|**Type**|**Description**|\n|---|---|---|\n| id | Integer | Id of the updated Warning |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n|**Status**|**Description**|\n|---|---|\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Warnings"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Warning of a Resource","content":{"application/json":{"examples":{"default":{"value":{"id":1,"Message":"entity updated"}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"text":{"type":"string"},"enabled":{"type":"boolean"}}},"examples":{"default":{"value":{"text":"This is an example of updating a warning","enabled":true}}}}}}},"delete":{"operationId":"delete-warning-of-a-resource","summary":"Delete Warning of a Resource","description":"This endpoint allows you to delete a Warning of a specific Resource (`accounts`, `opportunities`, `products`, `salesorders`) based on JSON input.\n\nYou will only be able to delete a Warning after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n|**Parameter**|**Value**|**Description**|\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| X-FM-Entity-Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| resource | String | The Resource name you want to delete the Warning (`accounts`, `opportunities`, `products`, `salesorders`) |\n| resourceId | Integer | The unique and specific identifier of the Resource |\n| warningId | Integer | The unique and specific identifier of the Warning |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id of the deleted Warning |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Warnings"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Warning of a Resource","content":{"application/json":{"examples":{"default":{"value":{"id":1,"Message":"entity deleted"}}}}}}},"security":[{"SessionKey":[]}]}},"/hooks":{"get":{"operationId":"list-webhooks","summary":"List Webhooks","description":"Returns all Webhooks available in the user's ForceManager implementation database.\n\nYou will only receive the list of Webhooks after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |\n\n**RESPONSE**\n\nThis endpoint returns information about all Webhooks available.\n\nList of the supported Webhooks attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| action | String | The values can be: `insert`, `update` or `delete` |\n| entity | String | The values can be: `account`, `contact`, `opportunity`, `activity`, `calendar`, `salesOrder` |\n| dateCreated | String | Date and time when the Webhook was created |\n| dateDeleted | String | Date and time when the Webhook was deleted |\n| dateUpdated | String | Date and time when the Webhook was last updated |\n| deleted | Boolean | If true, the Webhook has been deleted and archived |\n| id | Integer | Unique identifier for the Webhook in ForceManager |\n| name | String | The name of the Webhook |\n| url | String | The endpoint of the Webhook |\n| user_deleted | Integer | Unique identifier of the user who created the Webhook |\n| user_created | Integer | Unique identifier of the user who deleted the Webhook |\n| user_updated | Integer | Unique identifier of the user who last updated the Webhook |\n| secret_key | String | Webhook Unique identifier. It is used for security to protect the URL access |\n| version | String | The Webhook version |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Webhooks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"List Webhooks","content":{"application/json":{"examples":{"default":{"value":[{"id":1,"name":"Update Contact Hook","url":"www.updateContactHook.com","version":4,"secret_key":"8B38C9CA-EAEA-4300-ABBB-89E6D87B6EC6","action":"update","entity":"account","user_deleted":null,"user_created":51,"user_updated":null,"date_created":"2018-08-08T09:27:51.533Z","date_updated":null,"date_deleted":null,"deleted":false}]}}}}}},"security":[{"SessionKey":[]}]},"post":{"operationId":"create-webhook","summary":"Create Webhook","description":"This endpoint allows you to create an Webhook based on JSON input.\n\nYou will only be able to create an Webhook after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST BODY**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| action (_Required_) | String | The values can be: `insert`, `update` or `delete` |\n| entity (_Required_) | String | The values can be: `account`, `contact`, `opportunity`, `activity`, `calendar`, `salesorder` |\n| name (_Required_) | String | The name of the Webhook |\n| url (_Required_) | String | The endpoint of the Webhook |\n| version | String | The Webhook version |\n\n**RESPONSE**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | Id assigned to the new Webhook |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Webhooks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Create Webhook","content":{"application/json":{"examples":{"default":{"value":{"id":5,"name":"WebHook - Enable process","url":"https://www.putYourUrlHere.com","version":4,"secret_key":"8B38C9CA-EAEA-4300-ABBB-89E6D87B6EC6","action":"insert","entity":"account","user_deleted":null,"user_created":51,"user_updated":null,"date_created":"2018-08-10T11:34:38.987Z","date_updated":null,"date_deleted":null,"deleted":false}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"action":{"type":"string"},"entity":{"type":"string"},"url":{"type":"string"}}},"examples":{"default":{"value":{"name":"WebHook - Enable process","action":"insert","entity":"account","url":"www.putYourUrlHere.com"}}}}}}}},"/hooks/{ID}":{"get":{"operationId":"get-webhook","summary":"Get Webhook","description":"This endpoint retrieves data of a specific Webhook based on JSON input. The API returns a single Webhook available, according to the unique ID provided. If the specified Webhook does not exist, the response will be a \"bad request\".\n\nYou will only receive the Webhook after first providing the Session Key. \nTo know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the Webhook |\n\n**RESPONSE**\n\nThis endpoint returns information about a Webhooks available.\n\nList of the supported Webhooks attributes:\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| action | String | The values can be: `insert`, `update` or `delete` |\n| entity | String | The values can be: `account`, `contact`, `opportunity`, `activity`, `calendar`, `salesorder` |\n| dateCreated | String | Date and time when the Webhook was created |\n| dateDeleted | String | Date and time when the Webhook was deleted |\n| dateUpdated | String | Date and time when the Webhook was last updated |\n| deleted | Boolean | If true, the Webhook has been deleted and archived |\n| id | Integer | Unique identifier for the Webhook in ForceManager |\n| name | String | The name of the Webhook |\n| url | String | The endpoint of the Webhook |\n| user_deleted | Integer | Unique identifier of the user who created the Webhook |\n| user_created | Integer | Unique identifier of the user who deleted the Webhook |\n| user_updated | Integer | Unique identifier of the user who last updated the Webhook |\n| secret_key | String | Webhook Unique identifier. It is used for security to protect the URL access |\n| version | String | The Webhook version |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Webhooks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Get Webhook","content":{"application/json":{"examples":{"default":{"value":{"id":1,"name":"Update Contact Hook","url":"https://www.updateContactHook.com","version":4,"secret_key":"8B38C9CA-EAEA-4300-ABBB-89E6D87B6EC6","action":"update","entity":"account","user_deleted":null,"user_created":51,"user_updated":null,"date_created":"2018-08-08T09:27:51.533Z","date_updated":null,"date_deleted":null,"deleted":false}}}}}}},"security":[{"SessionKey":[]}]},"put":{"operationId":"update-webhook","summary":"Update Webhook","description":"This endpoint allows you to update a specific Webhook's information. If the specified Webhook does not exist, the response will be a \"bad request\".\n\nYou will only be able to update an Webhooks after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Any data of whatever mime type is accepted |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\nThis endpoint allows you to update the information of a specific Webhook. In order to update a Webhook, 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.**\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| action | String | The values can be: `insert`, `update` or `delete` |\n| entity | String | The values can be: `account`, `contact`, `opportunity`, `activity`, `calendar`, `salesorder` |\n| name | String | The name of the WebHook |\n| url | String | The website of the WebHook. Should be an \"http\" request |\n| version | String | The Webhook version |\n\n**RESPONSE**\n\nReturns a JSON with information about the Webhook just updated.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Webhooks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Update Webhook","content":{"application/json":{"examples":{"default":{"value":{"id":5,"name":"WebHook - Update process","url":"https:/www.putYourUrlHere.com","version":null,"secret_key":"8B38C9CA-EAEA-4300-ABBB-89E6D87B6EC6","action":"insert","entity":"contact","user_deleted":null,"user_created":51,"user_updated":51,"date_created":"2018-08-10T11:34:38.987Z","date_updated":"2018-08-10T11:37:20.57Z","date_deleted":null,"deleted":false}}}}}}},"security":[{"SessionKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"},"action":{"type":"string"},"entity":{"type":"string"},"url":{"type":"string"}}},"examples":{"default":{"value":{"name":"WebHook - Update process","action":"update","entity":"contact","url":"www.putYourUrlHere.com"}}}}}}},"delete":{"operationId":"delete-webhook","summary":"Delete Webhook","description":"This endpoint allows you to delete a specific Webhook from the user's ForceManager implementation database. If the specified Webhook does not exist, the response will be a \"bad request\". This operation cannot be undone.\n\nYou will only be able to delete an WebHook after first providing the Session Key. To know how you can obtain the Session Key, [go to Authentication](#tag/authentication/POST/login).\n\n**HEADERS**\n\n| **Parameter** | **Value** | **Description** |\n| --- | --- | --- |\n| Content-Type | application/json | Language in which all request and response bodies are encoded |\n| Accept | \\*/\\* | Accept any data of whatever mime type |\n| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |\n\n**REQUEST**\n\n| **Parameter** | **Type** | **Description** |\n| --- | --- | --- |\n| id | Integer | The unique and specific identifier of the WebHook to delete |\n\n**RESPONSE**\n\nReturns a JSON with information about the WebHook just deleted.\n\n| **Attribute** | **Type** | **Description** |\n| --- | --- | --- |\n| Message | String | Shows the operation status |\n\n**RESPONSE CODES**\n\n| **Status** | **Description** |\n| --- | --- |\n| 200 OK | Shows if operation succeeded |\n| 400 Bad Request | Shows when an invalid request or the requested service is not available |","tags":["Webhooks"],"parameters":[{"name":"Accept","in":"header","required":false,"schema":{"type":"string"},"example":"*/*"}],"responses":{"200":{"description":"Delete Webhook","content":{"application/json":{"examples":{"default":{"value":{"id":2,"Message":"delete success"}}}}}}},"security":[{"SessionKey":[]}]}}},"x-tagGroups":[{"name":"","tags":["Account Addresses"]},{"name":"Accounts","tags":["Accounts / Entity","Accounts / Types","Accounts / Segments","Accounts / Statuses"]},{"name":"Activities","tags":["Activities / Entity","Activities / Types","Activities / Points"]},{"name":"","tags":["Authentication","Branches","Bulks","Calls"]},{"name":"Campaigns","tags":["Campaigns / Entity","Campaigns / Statuses","Campaigns / Accounts","Campaigns / Questions","Campaigns / Question Answers","Campaigns / Question Values"]},{"name":"Opportunities","tags":["Opportunities / Types","Opportunities / Entity","Opportunities / Statuses"]},{"name":"Contacts","tags":["Contacts / Entity","Contacts / Types"]},{"name":"","tags":["Countries","Currencies"]},{"name":"Documents","tags":["Documents / Entity","Documents / Folders"]},{"name":"Products","tags":["Products / Carousel","Products / Entity","Products / Families","Products / Categories","Products / Rates"]},{"name":"","tags":["Emails","Entity Contacts","Entity Owners","Events/Tasks"]},{"name":"Extra Fields","tags":["Extra Fields / Entity","Extra Fields / Tabs"]},{"name":"Forms","tags":["Forms / Entity","Forms / States","Forms / Templates"]},{"name":"","tags":["News"]},{"name":"Orders","tags":["Orders / Entity","Orders / Statuses","Orders / Types"]},{"name":"","tags":["Rates"]},{"name":"Related Accounts","tags":["Related Accounts / Entity","Related Accounts / Types"]},{"name":"","tags":["Resources","Roles","Sales","TimeZones"]},{"name":"Users","tags":["Users / Entity","Users / Types"]},{"name":"Value Lists","tags":["Value Lists / Entity","Value Lists / Values"]},{"name":"","tags":["Warnings","Webhooks"]}]}