{
  "openapi": "3.0.1",
  "info": {
    "title": "Ploomes API",
    "description": {
      "pt": "<div id=\"title-pt\"> <div class=\"collapsible_options\" data-collapsible-index=\"200\"> <h2 class=\"title\">Autenticação - Adquirir a User-Key <i class=\"icon-arrow arrow\"></i></h2> <div class=\"content_itens anime\"> <h3>Para utilizar a API primeiramente é necessário buscar sua User-Key, utilizada no Header de todas as requisições.<br>Somente administradores podem criar ou apagar chaves de integração.</h3><br> <p>1. Vá até o Ploomes e entre na aba de Administração.</p><img src=\"/img/img_go_adm.png\" /> <p><br>2. Na seção de Integrações clique no botão \"Usuários de Integração\".</p><img src=\"/img/img_go_user_integration.png\" /> <p><br>3. Clique em \"Novo usuário\", preencha o nome, e-mail e perfil de acesso do usuário e confirme a criação. </p><img src=\"/img/img_go_new_user.png\" /> <p><br>4. Selecione o usuário criado e no campo \"Chave da API\" copie a sua User-Key.</p><img src=\"/img/img_get_key.png\" /> </div> </div> <h2>OData</h2> <p>Esta API utiliza-se do protocolo OData para a manipulação das respostas. Em todas as requisições há a possibilidade de se utilizar as seguintes querystrings: <i>$top</i>, <i>$skip</i>, <i>$select</i>, <i>$expand</i>, <i>$orderby</i> e <i>$filter</i>. </p> <h3>Resumo sobre o OData utilizado na API</h3> <ul> <li class=\"odata_query\"> <div><i>$top</i>: Selecionar quantos itens devem ser retornados.</div> <span class=\"odata_example\">Exemplo: <i>https://public-api2.ploomes.com/Deals?$top=10</i></span> <span> - Retorna os primeiros 10 negócios.</span> </li> <li class=\"odata_query\"> <div><i>$skip</i>: Pular um determinado número de itens.</div> <span class=\"odata_example\">Exemplo: <i>https://public-api2.ploomes.com/Deals?$top=10&$skip=20</i> </span> <span> - Retorna apenas 10 negócios, mas pulando os 20 primeiros.</span> </li> <li class=\"odata_query\"> <div><i>$select</i>: Selecionar quais campos devem ser retornados do objeto.</div> <span class=\"odata_example\">Exemplo: <i>https://public-api2.ploomes.com/Deals?$select=Title</i> </span> <span> - Seleciona apenas o título dos negócios.</span> </li> <li class=\"odata_query\"> <div><i>$expand</i>: Expandir algum objeto interno.</div> <span class=\"odata_example\">Exemplo: <i>https://public-api2.ploomes.com/Deals?$expand=OtherProperties</i> </span> <span> - Expande os campos personalizados dos negócios.</span> </li> <li class=\"odata_query\"> <div><i>$orderby</i>: Ordenar o retorno de acordo com algum campo específico.</div> <span class=\"odata_example\">Exemplo: <i>https://public-api2.ploomes.com/Deals?$orderby=Amount+asc</i> </span> <span> - Ordena de acordo com o valor do negócio, na ordem ascendente.</span> </li> <li class=\"odata_query\"> <div><i>$filter</i>: Filtrar de acordo com algum campo e valor específico.</div> <span class=\"odata_example\">Exemplo: <i>https://public-api2.ploomes.com/Deals?$filter=Id+eq+13123</i> </span> <span> - Retorna apenas o negócio que tem o Id 13123.</span> </li> </ul> <p> Detalhes completos sobre a sintaxe: <a target=\"blank\" href=\"http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html\">Documentação do OData</a>. Não é garatido o suporte à uso de bibliotecas oData terceiras, recomendamos o uso direto com chamadas http.</p> <h2>Limites da API</h2> <ul> <li> <p>Nossa API atualmente está apta a processar até 120 requisições por minuto, considerando todos os usuários de integração da conta em conjunto, portanto, em caso de a sua solução precisar executar muitas requisições simultâneas, esteja preparado para processar respostas HTTP 429 - Too Many Requests.</p> </li> <li> <p>Algumas entidades possuem um limite de recursos que pode ser obtido em uma solicitação GET. Esse limite é de 300 itens para as entidades: Contacts, Deals, Cities, Tasks, Orders e Quotes.</p> </li> <li> <p>O máximo payload aceito pela API é de 10MB.</p> </li> </ul> <h2>Boas Práticas</h2> <p>Sempre use as boas práticas de consulta OData: $top e $skip para paginação (tente limitar em páginas de até 100 itens) e $select para pegar apenas os dados essenciais. São essas práticas que vão evitar que seu projeto dê timeout ou seja bloqueado por consumir muitos recursos da API.</p> <h3>Dicas rápidas</h3> <ul> <li>Assuma que sua aplicação irá competir por cotas, taxas e recursos de concorrência com outros aplicativos e defina limites de uso conservadores.</li> <li>Evite fazer chamadas de API simultâneas se o seu caso de uso não se beneficiar.</li> <li>Sempre que possível utilize requisições assíncronas para as API, assim você poderá lidar melhor com os limites e erros.</li> </ul> <h2>Campos Customizados</h2> <ul> <li>Algumas entidades têm a possibilidade de criar campos personalizados e por consequência possuem a propriedade OtherProperties na raiz.</li> <li>Para criar um campo customizado, basta realizar uma requisição (POST) em '/Fields', onde será retornada a propriedade Key do campo recém-adicionado.</li> <li>Para salvar um dado de um campo customizado, insira esta chave e o valor dela em OtherProperties como nos exemplo a seguir e nos exemplos disponíveis nas entidades. <textarea class=\"field-text_multiple\" id=\"body_request\">\"{\\r\\n \\\"OtherProperties\\\": [\\r\\n {\\r\\n \\\"FieldKey\\\": \\\"{fieldKey}\\\",\\r\\n \\\"StringValue\\\": \\\"texto exemplo\\\"\\r\\n },\\r\\n {\\r\\n \\\"FieldKey\\\": \\\"{fieldKey}\\\",\\r\\n \\\"IntegerValue\\\": 2\\r\\n }\\r\\n ]\\r\\n}\"</textarea> </li> <li>Para depois visualizá-los utilize a querystring <i>$expand=OtherProperties.</i>.</li> <li class=\"odata_query\"> <div> Para filtrar utilizando um valor de um campo customizado, por questões de performance, é recomendado usar o Id do campo ao invés da sua chave (Essa informação pode ser consultada no endpoint '/Fields', filtrando pela chave do campo), como no exemplo a seguir:</div> <span class=\"odata_example\">Exemplo: <i>https://public-api2.ploomes.com/Deals?filter=((((OtherProperties/any(o:+o/FieldId+eq+245552+and+(o/StringValue+eq+'teste'))))))</i> </span> <span> - Retorna os negócios em que o valor do campo de texto com Id 245552 tenha o valor 'teste'.</span> </li> </ul></div>",
      "en": "<div id=\"title-pt\"> <div class=\"collapsible_options\" data-collapsible-index=\"200\"> <h2 class=\"title\">Autentication - Get the User-Key <i class=\"icon-arrow arrow\"></i></h2> <div class=\"content_itens anime\"> <h3> To use the API, you must first search for your User-Key, used in the Header of all requests. <br>Only admin users can create or delete integration keys </h3><br> <p>1. Go to the Ploomes and enter 'Administration' tab.</p><img src=\"/img/img_go_adm.png\" /> <p><br>2. In the 'Integrations' section, click the \"Integration users\" button.</p><img src=\"/img/img_go_user_integration.png\" /> <p><br>3. Click the \"New User\" button, fill in the user's name, email and profile and confirm the creation. </p><img src=\"/img/img_go_new_user.png\" /> <p><br>4. Select the created user and copy your User-Key, available in the section 'API Key'</p><img src=\"/img/img_get_key.png\" /> </div> </div> <h2>OData</h2> <p> This API uses the OData protocol to handle responses. In all requests you can use the following query strings: <i>$top</i>, <i>$skip</i>, <i>$select</i>, <i>$expand</i>, <i>$orderby</i> e <i>$filter</i>. </p> <h3>Summary about OData used in the API</h3> <ul> <li class=\"odata_query\"> <div><i>$top</i>: Select how many items should be returned.</div> <span class=\"odata_example\">Example: <i>https://public-api2.ploomes.com/Deals?$top=10</i></span> <span> - Returns the first 10 deals.</span> </li> <li class=\"odata_query\"> <div><i>$skip</i>: Skip a number of items.</div> <span class=\"odata_example\">Example: <i>https://public-api2.ploomes.com/Deals?$top=10&$skip=20</i> </span> <span> - Returns only 10 deals, skipping the first 20.</span> </li> <li class=\"odata_query\"> <div><i>$select</i>: Select which fields should be returned in the object.</div> <span class=\"odata_example\">Example: <i>https://public-api2.ploomes.com/Deals?$select=Title</i> </span> <span> - Selects only the deals title.</span> </li> <li class=\"odata_query\"> <div><i>$expand</i>: Expand some internal object.</div> <span class=\"odata_example\">Example: <i>https://public-api2.ploomes.com/Deals?$expand=OtherProperties</i> </span> <span> - Expands the deals custom fields.</span> </li> <li class=\"odata_query\"> <div><i>$orderby</i>: Sort the response according to some specific field.</div> <span class=\"odata_example\">Example: <i>https://public-api2.ploomes.com/Deals?$orderby=Amount+asc</i> </span> <span> - Sorts in ascending order of deals amount.</span> </li> <li class=\"odata_query\"> <div><i>$filter</i>: Filter according to a field value.</div> <span class=\"odata_example\">Example: <i>https://public-api2.ploomes.com/Deals?$filter=Id+eq+13123</i> </span> <span> - Returns only the deal with Id 13123.</span> </li> </ul> <p> Full OData syntax details: <a target=\"blank\" href=\"http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html\">OData documentation</a>.</p> <h2>API Limits</h2> <ul> <li> <p>The API is currently able to process up to 120 requests per minute, considering all account integration users together, so if your solution needs to run many concurrent requests, be prepared to process responses HTTP 429 - Too Many Requests.</p> </li> <li> <p>Some entities have a resource limit that can be obtained in a GET request. That limit is 300 items for the entities: Contacts, Deals, Cities, Tasks, Orders e Quotes.</p> </li> <li> <p>The maximum payload accepted by the API is 10MB.</p> </li> </ul> <h2>Good Practices</h2> <p>Always use OData query best practices: $top and $skip for paging (try to limit pages up to 100 items) and $select to get only essential data. It is these practices that will prevent your project from timeout or be blocked due to consuming too many API resources. </p> <h3>Quick Tips</h3> <ul> <li>Assume that your application will compete for quotas, fees, and resources with other applications. and set conservative usage limits.</li> <li>Avoid making concurrent API calls if your use case doesn't benefit from it.</li> <li>Whenever possible, use asynchronous requests to the API so that you can better handle the limits and errors.</li> </ul> <h2>Custom Fields</h2> <ul> <li>Some entities have the possibility of creating custom fields and consequently have the property OtherProperties in the root.</li> <li>To create a custom field, just make a request (POST) in '/Fields', where the 'Key' property of the newly added field will be returned.</li> <li>To save data from a custom field, enter this key and its value in OtherProperties as demonstrated in the following examples and in the examples available in the entities. <textarea class=\"field-text_multiple\" id=\"body_request\">\"{\\r\\n \\\"OtherProperties\\\": [\\r\\n {\\r\\n \\\"FieldKey\\\": \\\"{fieldKey}\\\",\\r\\n \\\"StringValue\\\": \\\"example text\\\"\\r\\n },\\r\\n {\\r\\n \\\"FieldKey\\\": \\\"{fieldKey}\\\",\\r\\n \\\"IntegerValue\\\": 2\\r\\n }\\r\\n ]\\r\\n}\"</textarea> </li> <li>Use the query string <i>$expand=OtherProperties</i> to get them.</li> <li class=\"odata_query\"> <div> To filter using a custom field value, due to performance reasons, it is recommended to use the Id of the field instead of its key (This information can be consulted in the endpoint '/Fields', filtering by field key), as in the following example:</div> <span class=\"odata_example\">Example: <i>https://public-api2.ploomes.com/Deals?filter=((((OtherProperties/any(o:+o/FieldId+eq+245552+and+(o/StringValue+eq+'test'))))))</i> </span> <span> - Returns deals where the text field with Id 245552 has the value 'test'.</span> </li> </ul></div>",
      "es": "<div id=\"title-es\"> <div class=\"collapsible_options\" data-collapsible-index=\"200\"> <h2 class=\"title\">Autenticación - Obtener la User-Key <i class=\"icon-arrow arrow\"></i></h2> <div class=\"content_itens anime\"> <h3>Para usar la API, primero necesitas obtener tu User-Key, que va en el header de todas las solicitudes.<br>Solo los administradores pueden crear o eliminar claves de integración.</h3><br> <p>1. Entra en Ploomes y abre la pestaña de Administración.</p><img src=\"/img/img_go_adm.png\" /> <p><br>2. En la sección de Integraciones, haz clic en el botón \"Usuarios de integración\".</p><img src=\"/img/img_go_user_integration.png\" /> <p><br>3. Haz clic en \"Nuevo usuario\", completa el nombre, el e-mail y el perfil de acceso del usuario y confirma la creación. </p><img src=\"/img/img_go_new_user.png\" /> <p><br>4. Selecciona el usuario creado y, en el campo \"Clave de la API\", copia tu User-Key.</p><img src=\"/img/img_get_key.png\" /> </div> </div> <h2>OData</h2> <p>Esta API usa el protocolo OData para manipular las respuestas. En todas las solicitudes puedes usar las siguientes query strings: <i>$top</i>, <i>$skip</i>, <i>$select</i>, <i>$expand</i>, <i>$orderby</i> y <i>$filter</i>. </p> <h3>Resumen del OData que usa la API</h3> <ul> <li class=\"odata_query\"> <div><i>$top</i>: Selecciona cuántos ítems deben devolverse.</div> <span class=\"odata_example\">Ejemplo: <i>https://public-api2.ploomes.com/Deals?$top=10</i></span> <span> - Devuelve los primeros 10 negocios.</span> </li> <li class=\"odata_query\"> <div><i>$skip</i>: Salta una cantidad determinada de ítems.</div> <span class=\"odata_example\">Ejemplo: <i>https://public-api2.ploomes.com/Deals?$top=10&$skip=20</i> </span> <span> - Devuelve solo 10 negocios, saltando los primeros 20.</span> </li> <li class=\"odata_query\"> <div><i>$select</i>: Selecciona qué campos del objeto deben devolverse.</div> <span class=\"odata_example\">Ejemplo: <i>https://public-api2.ploomes.com/Deals?$select=Title</i> </span> <span> - Selecciona solo el título de los negocios.</span> </li> <li class=\"odata_query\"> <div><i>$expand</i>: Expande algún objeto interno.</div> <span class=\"odata_example\">Ejemplo: <i>https://public-api2.ploomes.com/Deals?$expand=OtherProperties</i> </span> <span> - Expande los campos personalizados de los negocios.</span> </li> <li class=\"odata_query\"> <div><i>$orderby</i>: Ordena la respuesta según un campo específico.</div> <span class=\"odata_example\">Ejemplo: <i>https://public-api2.ploomes.com/Deals?$orderby=Amount+asc</i> </span> <span> - Ordena por el valor del negocio, en orden ascendente.</span> </li> <li class=\"odata_query\"> <div><i>$filter</i>: Filtra según un campo y un valor específicos.</div> <span class=\"odata_example\">Ejemplo: <i>https://public-api2.ploomes.com/Deals?$filter=Id+eq+13123</i> </span> <span> - Devuelve solo el negocio con Id 13123.</span> </li> </ul> <p> Detalles completos de la sintaxis: <a target=\"blank\" href=\"http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part2-url-conventions.html\">Documentación de OData</a>. No garantizamos el soporte de bibliotecas OData de terceros; recomendamos usar llamadas HTTP directas.</p> <h2>Límites de la API</h2> <ul> <li> <p>Actualmente la API procesa hasta 120 solicitudes por minuto, contando todos los usuarios de integración de la cuenta en conjunto. Si tu solución necesita ejecutar muchas solicitudes simultáneas, prepárate para manejar respuestas HTTP 429 - Too Many Requests.</p> </li> <li> <p>Algunas entidades tienen un límite de recursos por solicitud GET. Ese límite es de 300 ítems para las entidades: Contacts, Deals, Cities, Tasks, Orders y Quotes.</p> </li> <li> <p>El payload máximo que acepta la API es de 10MB.</p> </li> </ul> <h2>Buenas prácticas</h2> <p>Usa siempre las buenas prácticas de consulta OData: $top y $skip para paginar (intenta limitar las páginas a 100 ítems) y $select para traer solo los datos esenciales. Son estas prácticas las que evitan que tu proyecto dé timeout o quede bloqueado por consumir demasiados recursos de la API.</p> <h3>Consejos rápidos</h3> <ul> <li>Asume que tu aplicación va a competir por cuotas, tasas y recursos de concurrencia con otras aplicaciones y define límites de uso conservadores.</li> <li>Evita hacer llamadas simultáneas a la API si tu caso de uso no se beneficia de ello.</li> <li>Siempre que sea posible, usa solicitudes asíncronas a la API; así manejas mejor los límites y los errores.</li> </ul> <h2>Campos personalizados</h2> <ul> <li>Algunas entidades permiten crear campos personalizados y, por eso, tienen la propiedad OtherProperties en la raíz.</li> <li>Para crear un campo personalizado, basta con hacer una solicitud (POST) a '/Fields', que devuelve la propiedad Key del campo recién creado.</li> <li>Para guardar el dato de un campo personalizado, incluye esa clave y su valor en OtherProperties, como en el siguiente ejemplo y en los ejemplos disponibles en las entidades. <textarea class=\"field-text_multiple\" id=\"body_request\">\"{\\r\\n \\\"OtherProperties\\\": [\\r\\n {\\r\\n \\\"FieldKey\\\": \\\"{fieldKey}\\\",\\r\\n \\\"StringValue\\\": \\\"texto de ejemplo\\\"\\r\\n },\\r\\n {\\r\\n \\\"FieldKey\\\": \\\"{fieldKey}\\\",\\r\\n \\\"IntegerValue\\\": 2\\r\\n }\\r\\n ]\\r\\n}\"</textarea> </li> <li>Para verlos después, usa la query string <i>$expand=OtherProperties</i>.</li> <li class=\"odata_query\"> <div> Para filtrar por el valor de un campo personalizado, por rendimiento, se recomienda usar el Id del campo en lugar de su clave (puedes consultarlo en el endpoint '/Fields', filtrando por la clave del campo), como en el siguiente ejemplo:</div> <span class=\"odata_example\">Ejemplo: <i>https://public-api2.ploomes.com/Deals?filter=((((OtherProperties/any(o:+o/FieldId+eq+245552+and+(o/StringValue+eq+'prueba'))))))</i> </span> <span> - Devuelve los negocios en los que el campo de texto con Id 245552 tiene el valor 'prueba'.</span> </li> </ul></div>"
    },
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://public-api2.ploomes.com"
    }
  ],
  "tags": [
    {
      "name": "Account"
    },
    {
      "name": "Cities"
    },
    {
      "name": "Contacts"
    },
    {
      "name": "Currencies"
    },
    {
      "name": "Deals"
    },
    {
      "name": "Documents"
    },
    {
      "name": "DocumentTemplates"
    },
    {
      "name": "Departments"
    },
    {
      "name": "Fields"
    },
    {
      "name": "InteractionRecords"
    },
    {
      "name": "Operations"
    },
    {
      "name": "Orders"
    },
    {
      "name": "PhoneTypes"
    },
    {
      "name": "Products"
    },
    {
      "name": "Quotes"
    },
    {
      "name": "RelativeDates"
    },
    {
      "name": "Roles"
    },
    {
      "name": "Tags"
    },
    {
      "name": "Tasks"
    },
    {
      "name": "Teams"
    },
    {
      "name": "Users"
    },
    {
      "name": "Webhooks"
    }
  ],
  "paths": {
    "/Account": {
      "get": {
        "tags": [
          "Account"
        ],
        "description": {
          "pt": "<div><br>Consulta as informações de sua Empresa, ou seja, as informações relacionadas com a conta que está utilizando, como Id, nome, módulos ativos, alterações nos nomes das entidades, outras customizações, etc.</div>",
          "en": "<div><br>Get your Company information, related to the account you are using, such as Id, name, active modules, changes in entity names, other customizations, etc.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da conta, gerado automaticamente pelo Banco de dados.",
              "en": "Account Id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "O nome da conta.",
              "en": "Account name."
            },
            "required": true
          },
          {
            "name": "Email",
            "type": "string(200)",
            "description": {
              "pt": "O email principal da conta.",
              "en": "Account e-mail."
            },
            "required": false
          },
          {
            "name": "CityId",
            "type": "integer",
            "description": {
              "pt": "O código da cidade do cliente. Se realizar esse preenchimento pelo Front-End existe uma integração com o Google Maps que permite selecionar o endereço correto mais facilmente, por isso é recomendado realizar esse tipo de alteração pela Web. Além disso, para consultar esse código basta utilizar o Endpoint de /Cities.",
              "en": "Account's city Id. If you fill in via the Ploomes Front-End, there is an integration with Google Maps that allows you to select the correct address easily, so it is recommended to change it via the Web Form. Also, to get this Id, just use the Endpoint '/Cities'."
            },
            "required": false
          },
          {
            "name": "Phone",
            "type": "string(80)",
            "description": {
              "pt": "O telefone da conta.",
              "en": "Account telephone."
            },
            "required": false
          },
          {
            "name": "Website",
            "type": "string(100)",
            "description": {
              "pt": "O link para o accesso ao website da conta.",
              "en": "The link to access the account website."
            },
            "required": false
          },
          {
            "name": "Register",
            "type": "string(50)",
            "description": {
              "pt": "O CNPJ da conta.",
              "en": "Account CNPJ."
            },
            "required": false
          },
          {
            "name": "StreetAddress",
            "type": "string(200)",
            "description": {
              "pt": "O endereço da conta. Se realizar esse preenchimento pelo Front-End existe uma integração com o Google Maps que permite selecionar o endereço correto mais facilmente, por isso é recomendade realizar esse tipo de alteração pela Web.",
              "en": "Account address. If you fill in via the Ploomes Front-End, there is an integration with Google Maps that allows you to select the correct address easily, so it is recommended to change it via the Web Form."
            },
            "required": false
          },
          {
            "name": "StreetAddressLine2",
            "type": "string(200)",
            "description": {
              "pt": "O complemento do endereço da conta.",
              "en": "Account address Number Suffix."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Email, CityId, Phone, StreetAddress, Website",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "OtherProperties, Plan",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Account({Id})": {
      "patch": {
        "tags": [
          "Account"
        ],
        "description": {
          "pt": "<div><br>Atualizar as informações de sua Empresa, ou seja, as informações relacionadas com a conta que está utilizando, como o nome da empresa. <br> Neste endpoint qualquer Id enviado no parâmetro 'Id' realizará a alteração na conta da User Key informada, mas é necessário passar algum número.</div>",
          "en": "<div><br>Update your Company information, related to the account you are using, such as your company name. <br> In this endpoint, any Id sent in the 'Id' parameter will change the account related to the User Key inputed, but it is necessary to fill with some number.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da conta, gerado automaticamente pelo Banco de dados.",
              "en": "Account Id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "O nome da conta.",
              "en": "Account name."
            },
            "required": true
          },
          {
            "name": "Email",
            "type": "string(200)",
            "description": {
              "pt": "O email principal da conta.",
              "en": "Account e-mail."
            },
            "required": false
          },
          {
            "name": "CityId",
            "type": "integer",
            "description": {
              "pt": "O código da cidade do cliente. Se realizar esse preenchimento pelo Front-End existe uma integração com o Google Maps que permite selecionar o endereço correto mais facilmente, por isso é recomendado realizar esse tipo de alteração pela Web. Além disso, para consultar esse código basta utilizar o Endpoint de /Cities.",
              "en": "Account's city Id. If you fill in via the Ploomes Front-End, there is an integration with Google Maps that allows you to select the correct address easily, so it is recommended to change it via the Web Form. Also, to get this Id, just use the Endpoint '/Cities'."
            },
            "required": false
          },
          {
            "name": "Phone",
            "type": "string(80)",
            "description": {
              "pt": "O telefone da conta.",
              "en": "Account telephone."
            },
            "required": false
          },
          {
            "name": "Website",
            "type": "string(100)",
            "description": {
              "pt": "O link para o accesso ao website da conta.",
              "en": "The link to access the account website."
            },
            "required": false
          },
          {
            "name": "Register",
            "type": "string(50)",
            "description": {
              "pt": "O CNPJ da conta.",
              "en": "Account CNPJ."
            },
            "required": false
          },
          {
            "name": "StreetAddress",
            "type": "string(200)",
            "description": {
              "pt": "O endereço da conta. Se realizar esse preenchimento pelo Front-End existe uma integração com o Google Maps que permite selecionar o endereço correto mais facilmente, por isso é recomendade realizar esse tipo de alteração pela Web.",
              "en": "Account address. If you fill in via the Ploomes Front-End, there is an integration with Google Maps that allows you to select the correct address easily, so it is recommended to change it via the Web Form."
            },
            "required": false
          },
          {
            "name": "StreetAddressLine2",
            "type": "string(200)",
            "description": {
              "pt": "O complemento do endereço da conta.",
              "en": "Account address Number Suffix."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "*Id",
            "in": "path",
            "description": "0",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Email, CityId, Phone, StreetAddress, Website",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "OtherProperties, Plan",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_7"
              },
              "examples": {
                "0": {
                  "summary": "TESTE",
                  "value": "{\"Name\":\"Empresa\"}"
                }
              }
            }
          }
        }
      }
    },
    "/Cities": {
      "get": {
        "tags": [
          "Cities"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de cidades da conta, de acordo com a <a href='https://pt.wikipedia.org/wiki/ISO_3166-1'>ISO 3166-1</a></div>",
          "en": "<div><br>Query the account cities base, according to the <a href='https://pt.wikipedia.org/wiki/ISO_3166-1'>ISO 3166-1</a></div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da cidade, gerado automaticamente pelo Banco de dados.",
              "en": "City Id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(180)",
            "description": {
              "pt": "Nome da cidade.",
              "en": "City Name."
            },
            "required": true
          },
          {
            "name": "CountryId",
            "type": "integer",
            "description": {
              "pt": "Id do país da cidade. Essa informação está disponível no endpoint de '/Cities@Countries'.",
              "en": "City country id. This information is available on the '/Cities@Countries' endpoint."
            },
            "required": true
          },
          {
            "name": "StateId",
            "type": "integer",
            "description": {
              "pt": "Id do estado da cidade. Essa informação está disponível no endpoint de '/Cities@Countries@States'.",
              "en": "City state id. This information is available on the '/Cities@Countries@States' endpoint."
            },
            "required": true
          },
          {
            "name": "IBGECode",
            "type": "integer",
            "description": {
              "pt": "Código do IBGE da cidade.",
              "en": "City IBGE code."
            },
            "required": false
          },
          {
            "name": "Latitude",
            "type": "string(20)",
            "description": {
              "pt": "Latitude da cidade.",
              "en": "City Latitude."
            },
            "required": false
          },
          {
            "name": "Longitude",
            "type": "string(20)",
            "description": {
              "pt": "Longitude da cidade.",
              "en": "City longitude."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id,Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Country,State",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Cities@Countries": {
      "get": {
        "tags": [
          "Cities"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de países da conta, de acordo com a <a href='https://pt.wikipedia.org/wiki/ISO_3166-1'>ISO 3166-1</a></div>",
          "en": "<div><br>Query account countries base, according to the <a href='https://pt.wikipedia.org/wiki/ISO_3166-1'>ISO 3166-1</a></div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do país, gerado automaticamente pelo Banco de dados.",
              "en": "Country Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Short",
            "type": "string(15)",
            "description": {
              "pt": "Código Alpha-3. Representa a sigla do país, com 3 letras.",
              "en": "Alpha-3 code. Represents the abbreviation of the country, with 3 letters."
            },
            "required": true
          },
          {
            "name": "Short2",
            "type": "string(10)",
            "description": {
              "pt": "Código Alpha-2. Representa a sigla do país, com 2 letras.",
              "en": "Alpha-2 code. Represents the abbreviation of the country, with 2 letters."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(60)",
            "description": {
              "pt": "Nome do País.",
              "en": "Country Name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id,Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "States",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Cities@Countries@States": {
      "get": {
        "tags": [
          "Cities"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de estados da conta, de acordo com a <a href='https://pt.wikipedia.org/wiki/ISO_3166-1'>ISO 3166-1</a></div>",
          "en": "<div><br>Query account states base, according to the <a href='https://pt.wikipedia.org/wiki/ISO_3166-1'>ISO 3166-1</a></div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do estado, gerado automaticamente pelo Banco de dados.",
              "en": "State Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Short",
            "type": "string(120)",
            "description": {
              "pt": "Sigla do estado.",
              "en": "State abbreviation."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(120)",
            "description": {
              "pt": "Nome do estado.",
              "en": "State name."
            },
            "required": true
          },
          {
            "name": "CountryId",
            "type": "integer",
            "description": {
              "pt": "Id do país desse estado. Essa informação está disponível no endpoint de '/Cities@Countries'",
              "en": "State Country Id. This information is available on the '/Cities@Countries' endpoint"
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id,Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Country",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Contacts": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Consulta os clientes da conta.</div>",
          "en": "<div><br>Query account customers.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do cliente, gerado automaticamente pelo Banco de dados.",
              "en": "Customer Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo do cliente, podendo ser um cliente do tipo pessoa ou do tipo empresa. Isso pode ser consultado no endpoint '/Contacts@Types'.",
              "en": "Customer type id, which can be a person or company type customer. This can be consulted in the '/Contacts@Types' endpoint."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do cliente.",
              "en": "Customer name."
            },
            "required": false
          },
          {
            "name": "LegalName",
            "type": "string(200)",
            "description": {
              "pt": "Razão social do cliente.",
              "en": "Legal company name."
            },
            "required": false
          },
          {
            "name": "Register",
            "type": "string(50)",
            "description": {
              "pt": "CNPJ ou CPF do cliente, a escolha do tipo do campo é de acordo com o tipo do cliente.",
              "en": "CNPJ or CPF of the customer, the choice of field type depends on the type of customer."
            },
            "required": false
          },
          {
            "name": "StatusId",
            "type": "integer",
            "description": {
              "pt": "Id do status do cliente. Se não estiver preenchido, assume um valor padrão. As opções disponíveis podem ser consultadas no endpoint '/Contacts@Status'.",
              "en": "Customer status id. If not filled in, it assumes a default value. The available options can be consulted in the '/Contacts@Status' endpoint."
            },
            "required": true
          },
          {
            "name": "CompanyId",
            "type": "integer",
            "description": {
              "pt": "Id da empresa do cliente (Se aplica para clientes do tipo pessoa).",
              "en": "Customer's company id (Applies to person-type customers)."
            },
            "required": false
          },
          {
            "name": "RelationshipId",
            "type": "integer",
            "description": {
              "pt": "Id da relação do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@Relationships'.",
              "en": "Customer relationship id. The available options can be consulted in the endpoint '/Contacts@Relationships'."
            },
            "required": false
          },
          {
            "name": "LineOfBusinessId",
            "type": "integer",
            "description": {
              "pt": "Id do segmento do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@LinesOfBusiness'.",
              "en": "Customer line of business id. The available options can be consulted in the '/Contacts@LinesOfBusiness' endpoint."
            },
            "required": false
          },
          {
            "name": "OriginId",
            "type": "integer",
            "description": {
              "pt": "Id da origem do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@Origins'.",
              "en": "Customer's origin id. The available options can be consulted in the '/Contacts@Origins' endpoint."
            },
            "required": false
          },
          {
            "name": "NumberOfEmployeesId",
            "type": "integer",
            "description": {
              "pt": "Id do número de funcionários do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@NumbersOfEmployees'.",
              "en": "Customer number of employees Id. The available options can be consulted in the endpoint '/Contacts@NumbersOfEmployees.'"
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do usuário responsável do cliente. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Customer owner user id. This information is available via the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "Note",
            "type": "string(max)",
            "description": {
              "pt": "Observações sobre o cliente.",
              "en": "Customer Notes."
            },
            "required": false
          },
          {
            "name": "Email",
            "type": "string(200)",
            "description": {
              "pt": "Email do cliente.",
              "en": "Customer email."
            },
            "required": false
          },
          {
            "name": "Website",
            "type": "string(150)",
            "description": {
              "pt": "Site do cliente.",
              "en": "Customer website."
            },
            "required": false
          },
          {
            "name": "RoleId",
            "type": "integer",
            "description": {
              "pt": "Id do cargo do cliente. As opções disponíveis podem ser consultadas no endpoint '/Roles'.",
              "en": "Customer role id. The available options can be consulted in the '/Roles' endpoint."
            },
            "required": false
          },
          {
            "name": "DepartmentId",
            "type": "integer",
            "description": {
              "pt": "Id do departamento do cliente. As opções disponíveis podem ser consultadas no endpoint '/Deparments'.",
              "en": "Customer department id. The available options can be consulted in the '/Deparments' endpoint."
            },
            "required": false
          },
          {
            "name": "Skype",
            "type": "string(100)",
            "description": {
              "pt": "Skype do cliente.",
              "en": "Customer's Skype."
            },
            "required": false
          },
          {
            "name": "Facebook",
            "type": "string(500)",
            "description": {
              "pt": "Facebook do cliente.",
              "en": "Customer's Facebook."
            },
            "required": false
          },
          {
            "name": "StreetAddress",
            "type": "string(200)",
            "description": {
              "pt": "Endereço do cliente.",
              "en": "Customer Address."
            },
            "required": false
          },
          {
            "name": "StreetAddressNumber",
            "type": "string(150)",
            "description": {
              "pt": "Número do endereço do cliente.",
              "en": "Customer Address Number."
            },
            "required": false
          },
          {
            "name": "StreetAddressLine2",
            "type": "string(150)",
            "description": {
              "pt": "Complemento do endereço do cliente.",
              "en": "Customer Address Number Suffix."
            },
            "required": false
          },
          {
            "name": "Neighborhood",
            "type": "string(100)",
            "description": {
              "pt": "Bairro do cliente.",
              "en": "Customer Neighborhood."
            },
            "required": false
          },
          {
            "name": "ZipCode",
            "type": "integer",
            "description": {
              "pt": "CEP do cliente.",
              "en": "Customer Brazilian Zip Code."
            },
            "required": false
          },
          {
            "name": "ForeignZipCode",
            "type": "string(100)",
            "description": {
              "pt": "Código postal internacional do cliente.",
              "en": "Customer Zip Code"
            },
            "required": false
          },
          {
            "name": "CityId",
            "type": "integer",
            "description": {
              "pt": "Id da cidade do cliente. As opções disponíveis podem ser consultadas no endpoint '/Cities' .",
              "en": "Customer's city id. The available options can be consulted in the '/Cities' endpoint."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do cliente. As opções disponíveis podem ser consultadas no endpoint '/Currencies'.",
              "en": "Customer's currency id. The available options can be consulted in the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "EmailMarketing",
            "type": "boolean",
            "description": {
              "pt": "Boleano sobre o recebimento de email marketing.",
              "en": "Boolean about receiving email marketing."
            },
            "required": false
          },
          {
            "name": "CNAECode",
            "type": "string(50)",
            "description": {
              "pt": "Código CNAE do cliente.",
              "en": "Customer CNAE Code."
            },
            "required": false
          },
          {
            "name": "CNAEName",
            "type": "string(350)",
            "description": {
              "pt": "Descrição do CNAE do cliente.",
              "en": "Customer CNAE description."
            },
            "required": false
          },
          {
            "name": "Latitude",
            "type": "decimal",
            "description": {
              "pt": "Latitude do cliente.",
              "en": "Customer latitude."
            },
            "required": false
          },
          {
            "name": "Longitude",
            "type": "decimal",
            "description": {
              "pt": "Longitude do cliente.",
              "en": "Customer Longitude."
            },
            "required": false
          },
          {
            "name": "Key",
            "type": "string(300)",
            "description": {
              "pt": "Chave externa do cliente.",
              "en": "Customer's foreign key."
            },
            "required": false
          },
          {
            "name": "AvatarUrl",
            "type": "string(300)",
            "description": {
              "pt": "URL do avatar do cliente (Ícone).",
              "en": "Customer avatar URL (Icon)."
            },
            "required": false
          },
          {
            "name": "IdentityDocument",
            "type": "string(200)",
            "description": {
              "pt": "Documento de identidade internacional do cliente.",
              "en": "Customer's identity document."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, LegalName, Register, Email, StreetAddress",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Type, Company, Tags, OtherProperties, InteractionRecords, Attachments, Documents, Products, Contacts",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Criar um cliente</div>",
          "en": "<div><br>Create a customers.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do cliente, gerado automaticamente pelo Banco de dados.",
              "en": "Customer Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo do cliente, podendo ser um cliente do tipo pessoa ou do tipo empresa. Isso pode ser consultado no endpoint '/Contacts@Types'.",
              "en": "Customer type id, which can be a person or company type customer. This can be consulted in the '/Contacts@Types' endpoint."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do cliente.",
              "en": "Customer name."
            },
            "required": false
          },
          {
            "name": "LegalName",
            "type": "string(200)",
            "description": {
              "pt": "Razão social do cliente.",
              "en": "Legal company name."
            },
            "required": false
          },
          {
            "name": "Register",
            "type": "string(50)",
            "description": {
              "pt": "CNPJ ou CPF do cliente, a escolha do tipo do campo é de acordo com o tipo do cliente.",
              "en": "CNPJ or CPF of the customer, the choice of field type depends on the type of customer."
            },
            "required": false
          },
          {
            "name": "StatusId",
            "type": "integer",
            "description": {
              "pt": "Id do status do cliente. Se não estiver preenchido, assume um valor padrão. As opções disponíveis podem ser consultadas no endpoint '/Contacts@Status'.",
              "en": "Customer status id. If not filled in, it assumes a default value. The available options can be consulted in the '/Contacts@Status' endpoint."
            },
            "required": true
          },
          {
            "name": "CompanyId",
            "type": "integer",
            "description": {
              "pt": "Id da empresa do cliente (Se aplica para clientes do tipo pessoa).",
              "en": "Customer's company id (Applies to person-type customers)."
            },
            "required": false
          },
          {
            "name": "RelationshipId",
            "type": "integer",
            "description": {
              "pt": "Id da relação do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@Relationships'.",
              "en": "Customer relationship id. The available options can be consulted in the endpoint '/Contacts@Relationships'."
            },
            "required": false
          },
          {
            "name": "LineOfBusinessId",
            "type": "integer",
            "description": {
              "pt": "Id do segmento do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@LinesOfBusiness'.",
              "en": "Customer line of business id. The available options can be consulted in the '/Contacts@LinesOfBusiness' endpoint."
            },
            "required": false
          },
          {
            "name": "OriginId",
            "type": "integer",
            "description": {
              "pt": "Id da origem do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@Origins'.",
              "en": "Customer's origin id. The available options can be consulted in the '/Contacts@Origins' endpoint."
            },
            "required": false
          },
          {
            "name": "NumberOfEmployeesId",
            "type": "integer",
            "description": {
              "pt": "Id do número de funcionários do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@NumbersOfEmployees'.",
              "en": "Customer number of employees Id. The available options can be consulted in the endpoint '/Contacts@NumbersOfEmployees.'"
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do usuário responsável do cliente. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Customer owner user id. This information is available via the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "Note",
            "type": "string(max)",
            "description": {
              "pt": "Observações sobre o cliente.",
              "en": "Customer Notes."
            },
            "required": false
          },
          {
            "name": "Email",
            "type": "string(200)",
            "description": {
              "pt": "Email do cliente.",
              "en": "Customer email."
            },
            "required": false
          },
          {
            "name": "Website",
            "type": "string(150)",
            "description": {
              "pt": "Site do cliente.",
              "en": "Customer website."
            },
            "required": false
          },
          {
            "name": "RoleId",
            "type": "integer",
            "description": {
              "pt": "Id do cargo do cliente. As opções disponíveis podem ser consultadas no endpoint '/Roles'.",
              "en": "Customer role id. The available options can be consulted in the '/Roles' endpoint."
            },
            "required": false
          },
          {
            "name": "DepartmentId",
            "type": "integer",
            "description": {
              "pt": "Id do departamento do cliente. As opções disponíveis podem ser consultadas no endpoint '/Deparments'.",
              "en": "Customer department id. The available options can be consulted in the '/Deparments' endpoint."
            },
            "required": false
          },
          {
            "name": "Skype",
            "type": "string(100)",
            "description": {
              "pt": "Skype do cliente.",
              "en": "Customer's Skype."
            },
            "required": false
          },
          {
            "name": "Facebook",
            "type": "string(500)",
            "description": {
              "pt": "Facebook do cliente.",
              "en": "Customer's Facebook."
            },
            "required": false
          },
          {
            "name": "StreetAddress",
            "type": "string(200)",
            "description": {
              "pt": "Endereço do cliente.",
              "en": "Customer Address."
            },
            "required": false
          },
          {
            "name": "StreetAddressNumber",
            "type": "string(150)",
            "description": {
              "pt": "Número do endereço do cliente.",
              "en": "Customer Address Number."
            },
            "required": false
          },
          {
            "name": "StreetAddressLine2",
            "type": "string(150)",
            "description": {
              "pt": "Complemento do endereço do cliente.",
              "en": "Customer Address Number Suffix."
            },
            "required": false
          },
          {
            "name": "Neighborhood",
            "type": "string(100)",
            "description": {
              "pt": "Bairro do cliente.",
              "en": "Customer Neighborhood."
            },
            "required": false
          },
          {
            "name": "ZipCode",
            "type": "integer",
            "description": {
              "pt": "CEP do cliente.",
              "en": "Customer Brazilian Zip Code."
            },
            "required": false
          },
          {
            "name": "ForeignZipCode",
            "type": "string(100)",
            "description": {
              "pt": "Código postal internacional do cliente.",
              "en": "Customer Zip Code"
            },
            "required": false
          },
          {
            "name": "CityId",
            "type": "integer",
            "description": {
              "pt": "Id da cidade do cliente. As opções disponíveis podem ser consultadas no endpoint '/Cities' .",
              "en": "Customer's city id. The available options can be consulted in the '/Cities' endpoint."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do cliente. As opções disponíveis podem ser consultadas no endpoint '/Currencies'.",
              "en": "Customer's currency id. The available options can be consulted in the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "EmailMarketing",
            "type": "boolean",
            "description": {
              "pt": "Boleano sobre o recebimento de email marketing.",
              "en": "Boolean about receiving email marketing."
            },
            "required": false
          },
          {
            "name": "CNAECode",
            "type": "string(50)",
            "description": {
              "pt": "Código CNAE do cliente.",
              "en": "Customer CNAE Code."
            },
            "required": false
          },
          {
            "name": "CNAEName",
            "type": "string(350)",
            "description": {
              "pt": "Descrição do CNAE do cliente.",
              "en": "Customer CNAE description."
            },
            "required": false
          },
          {
            "name": "Latitude",
            "type": "decimal",
            "description": {
              "pt": "Latitude do cliente.",
              "en": "Customer latitude."
            },
            "required": false
          },
          {
            "name": "Longitude",
            "type": "decimal",
            "description": {
              "pt": "Longitude do cliente.",
              "en": "Customer Longitude."
            },
            "required": false
          },
          {
            "name": "Key",
            "type": "string(300)",
            "description": {
              "pt": "Chave externa do cliente.",
              "en": "Customer's foreign key."
            },
            "required": false
          },
          {
            "name": "AvatarUrl",
            "type": "string(300)",
            "description": {
              "pt": "URL do avatar do cliente (Ícone).",
              "en": "Customer avatar URL (Icon)."
            },
            "required": false
          },
          {
            "name": "IdentityDocument",
            "type": "string(200)",
            "description": {
              "pt": "Documento de identidade internacional do cliente.",
              "en": "Customer's identity document."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, LegalName, Register, Email, StreetAddress",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Type, Company, Tags, OtherProperties, InteractionRecords, Attachments, Documents, Products, Contacts",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_2"
              },
              "examples": {
                "0": {
                  "value": "{\"Name\":\"Pessoa Nova\",\"Neighborhood\":\"Pinheiros\",\"ZipCode\":0,\"Register\":\"69.971.558/0001-10\",\"OriginId\":0,\"CompanyId\":null,\"StreetAddressNumber\":\"XXX\",\"TypeId\":0,\"Phones\":[{\"PhoneNumber\":\"(XX) XXXX-XXXX\",\"TypeId\":0,\"CountryId\":0}],\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Contacts({Id})": {
      "delete": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Deletar um cliente</div>",
          "en": "<div><br>Delete a customer</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Atualizar um cliente</div>",
          "en": "<div><br>Update a customer</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do cliente, gerado automaticamente pelo Banco de dados.",
              "en": "Customer Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo do cliente, podendo ser um cliente do tipo pessoa ou do tipo empresa. Isso pode ser consultado no endpoint '/Contacts@Types'.",
              "en": "Customer type id, which can be a person or company type customer. This can be consulted in the '/Contacts@Types' endpoint."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do cliente.",
              "en": "Customer name."
            },
            "required": false
          },
          {
            "name": "LegalName",
            "type": "string(200)",
            "description": {
              "pt": "Razão social do cliente.",
              "en": "Legal company name."
            },
            "required": false
          },
          {
            "name": "Register",
            "type": "string(50)",
            "description": {
              "pt": "CNPJ ou CPF do cliente, a escolha do tipo do campo é de acordo com o tipo do cliente.",
              "en": "CNPJ or CPF of the customer, the choice of field type depends on the type of customer."
            },
            "required": false
          },
          {
            "name": "StatusId",
            "type": "integer",
            "description": {
              "pt": "Id do status do cliente. Se não estiver preenchido, assume um valor padrão. As opções disponíveis podem ser consultadas no endpoint '/Contacts@Status'.",
              "en": "Customer status id. If not filled in, it assumes a default value. The available options can be consulted in the '/Contacts@Status' endpoint."
            },
            "required": true
          },
          {
            "name": "CompanyId",
            "type": "integer",
            "description": {
              "pt": "Id da empresa do cliente (Se aplica para clientes do tipo pessoa).",
              "en": "Customer's company id (Applies to person-type customers)."
            },
            "required": false
          },
          {
            "name": "RelationshipId",
            "type": "integer",
            "description": {
              "pt": "Id da relação do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@Relationships'.",
              "en": "Customer relationship id. The available options can be consulted in the endpoint '/Contacts@Relationships'."
            },
            "required": false
          },
          {
            "name": "LineOfBusinessId",
            "type": "integer",
            "description": {
              "pt": "Id do segmento do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@LinesOfBusiness'.",
              "en": "Customer line of business id. The available options can be consulted in the '/Contacts@LinesOfBusiness' endpoint."
            },
            "required": false
          },
          {
            "name": "OriginId",
            "type": "integer",
            "description": {
              "pt": "Id da origem do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@Origins'.",
              "en": "Customer's origin id. The available options can be consulted in the '/Contacts@Origins' endpoint."
            },
            "required": false
          },
          {
            "name": "NumberOfEmployeesId",
            "type": "integer",
            "description": {
              "pt": "Id do número de funcionários do cliente. As opções disponíveis podem ser consultadas no endpoint '/Contacts@NumbersOfEmployees'.",
              "en": "Customer number of employees Id. The available options can be consulted in the endpoint '/Contacts@NumbersOfEmployees.'"
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do usuário responsável do cliente. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Customer owner user id. This information is available via the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "Note",
            "type": "string(max)",
            "description": {
              "pt": "Observações sobre o cliente.",
              "en": "Customer Notes."
            },
            "required": false
          },
          {
            "name": "Email",
            "type": "string(200)",
            "description": {
              "pt": "Email do cliente.",
              "en": "Customer email."
            },
            "required": false
          },
          {
            "name": "Website",
            "type": "string(150)",
            "description": {
              "pt": "Site do cliente.",
              "en": "Customer website."
            },
            "required": false
          },
          {
            "name": "RoleId",
            "type": "integer",
            "description": {
              "pt": "Id do cargo do cliente. As opções disponíveis podem ser consultadas no endpoint '/Roles'.",
              "en": "Customer role id. The available options can be consulted in the '/Roles' endpoint."
            },
            "required": false
          },
          {
            "name": "DepartmentId",
            "type": "integer",
            "description": {
              "pt": "Id do departamento do cliente. As opções disponíveis podem ser consultadas no endpoint '/Deparments'.",
              "en": "Customer department id. The available options can be consulted in the '/Deparments' endpoint."
            },
            "required": false
          },
          {
            "name": "Skype",
            "type": "string(100)",
            "description": {
              "pt": "Skype do cliente.",
              "en": "Customer's Skype."
            },
            "required": false
          },
          {
            "name": "Facebook",
            "type": "string(500)",
            "description": {
              "pt": "Facebook do cliente.",
              "en": "Customer's Facebook."
            },
            "required": false
          },
          {
            "name": "StreetAddress",
            "type": "string(200)",
            "description": {
              "pt": "Endereço do cliente.",
              "en": "Customer Address."
            },
            "required": false
          },
          {
            "name": "StreetAddressNumber",
            "type": "string(150)",
            "description": {
              "pt": "Número do endereço do cliente.",
              "en": "Customer Address Number."
            },
            "required": false
          },
          {
            "name": "StreetAddressLine2",
            "type": "string(150)",
            "description": {
              "pt": "Complemento do endereço do cliente.",
              "en": "Customer Address Number Suffix."
            },
            "required": false
          },
          {
            "name": "Neighborhood",
            "type": "string(100)",
            "description": {
              "pt": "Bairro do cliente.",
              "en": "Customer Neighborhood."
            },
            "required": false
          },
          {
            "name": "ZipCode",
            "type": "integer",
            "description": {
              "pt": "CEP do cliente.",
              "en": "Customer Brazilian Zip Code."
            },
            "required": false
          },
          {
            "name": "ForeignZipCode",
            "type": "string(100)",
            "description": {
              "pt": "Código postal internacional do cliente.",
              "en": "Customer Zip Code"
            },
            "required": false
          },
          {
            "name": "CityId",
            "type": "integer",
            "description": {
              "pt": "Id da cidade do cliente. As opções disponíveis podem ser consultadas no endpoint '/Cities' .",
              "en": "Customer's city id. The available options can be consulted in the '/Cities' endpoint."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do cliente. As opções disponíveis podem ser consultadas no endpoint '/Currencies'.",
              "en": "Customer's currency id. The available options can be consulted in the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "EmailMarketing",
            "type": "boolean",
            "description": {
              "pt": "Boleano sobre o recebimento de email marketing.",
              "en": "Boolean about receiving email marketing."
            },
            "required": false
          },
          {
            "name": "CNAECode",
            "type": "string(50)",
            "description": {
              "pt": "Código CNAE do cliente.",
              "en": "Customer CNAE Code."
            },
            "required": false
          },
          {
            "name": "CNAEName",
            "type": "string(350)",
            "description": {
              "pt": "Descrição do CNAE do cliente.",
              "en": "Customer CNAE description."
            },
            "required": false
          },
          {
            "name": "Latitude",
            "type": "decimal",
            "description": {
              "pt": "Latitude do cliente.",
              "en": "Customer latitude."
            },
            "required": false
          },
          {
            "name": "Longitude",
            "type": "decimal",
            "description": {
              "pt": "Longitude do cliente.",
              "en": "Customer Longitude."
            },
            "required": false
          },
          {
            "name": "Key",
            "type": "string(300)",
            "description": {
              "pt": "Chave externa do cliente.",
              "en": "Customer's foreign key."
            },
            "required": false
          },
          {
            "name": "AvatarUrl",
            "type": "string(300)",
            "description": {
              "pt": "URL do avatar do cliente (Ícone).",
              "en": "Customer avatar URL (Icon)."
            },
            "required": false
          },
          {
            "name": "IdentityDocument",
            "type": "string(200)",
            "description": {
              "pt": "Documento de identidade internacional do cliente.",
              "en": "Customer's identity document."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, LegalName, Register, Email, StreetAddress",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Type, Company, Tags, OtherProperties, InteractionRecords, Attachments, Documents, Products, Contacts",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_7"
              },
              "examples": {
                "0": {
                  "value": "{\"Name\":\"Pessoa Nova\",\"Neighborhood\":\"Pinheiros\",\"ZipCode\":0,\"Register\":\"262.531.940-20\",\"OriginId\":0,\"CompanyId\":null,\"StreetAddressNumber\":\"XXX\",\"TypeId\":0,\"Phones\":[{\"PhoneNumber\":\"(XX) XXXX-XXXX\",\"TypeId\":0,\"CountryId\":0}],\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Contacts@NumbersOfEmployees": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Consulta o número de funcionários da conta, um campo de opções pré cadastradas.</div>.",
          "en": "<div><br>Query the number of employees in the account, a field of pre-registered options type.</div>."
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da opção de número de funcionários, gerado automaticamente pelo Banco de Dados.",
              "en": "Id of the number of employees option, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome da opção de número de funcionários.",
              "en": "Number of employees option name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Criar uma opção do número de funcionários da conta, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Create an option for the number of employees on the account, a field of pre-registered options type.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da opção de número de funcionários, gerado automaticamente pelo Banco de Dados.",
              "en": "Id of the number of employees option, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome da opção de número de funcionários.",
              "en": "Number of employees option name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_2"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"1 a 5\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Contacts@NumbersOfEmployees({Id})": {
      "delete": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Apagar uma opção do número de funcionários da conta, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Delete an option of the number of employees of the account, a field of pre-registered options.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Atualizar uma opção do número de funcionários da conta, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Update an option of the number of employees of the account, a field of pre-registered options.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da opção de número de funcionários, gerado automaticamente pelo Banco de Dados.",
              "en": "Id of the number of employees option, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome da opção de número de funcionários.",
              "en": "Number of employees option name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_7"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"1 a 5\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Contacts@Origins": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Consulta origens de cliente, um campo de opções pré cadastradas</div>.",
          "en": "<div><br>Query customer origins, a field of pre-registered options</div>."
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da origem, gerado automaticamente pelo banco de dados.",
              "en": "Origin Id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome da origem.",
              "en": "Origin name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Cria origens de cliente, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Create customer origins, a field of pre-registered options.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da origem, gerado automaticamente pelo banco de dados.",
              "en": "Origin Id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome da origem.",
              "en": "Origin name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_2"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Original\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Contacts@Origins({Id})": {
      "delete": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Apaga uma origem de cliente, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Delete a customer origin, a field of pre-registered options.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Atualiza uma origem de cliente, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Update a customer origin, a field of pre-registered options.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da origem, gerado automaticamente pelo banco de dados.",
              "en": "Origin Id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome da origem.",
              "en": "Origin name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_7"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Original\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Contacts@LinesOfBusiness": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Consulta segmentos de cliente, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Query customer Lines Of Business, a field of pre-registered options.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do Segmento , gerado automaticamente pelo Banco de Dados.",
              "en": "Line of Business Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome do Segmento.",
              "en": "Line of Business Name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Cria segmentos de cliente, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Create customer Line of Business, a field of pre-registered options.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do Segmento , gerado automaticamente pelo Banco de Dados.",
              "en": "Line of Business Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome do Segmento.",
              "en": "Line of Business Name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_2"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Papelaria\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Contacts@LinesOfBusiness({Id})": {
      "delete": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Apaga segmentos de cliente, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Delete customer Line of Business, a field of pre-registered options.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Atualiza segmentos de cliente, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Update customer Line of Business, a field of pre-registered options.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do Segmento , gerado automaticamente pelo Banco de Dados.",
              "en": "Line of Business Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome do Segmento.",
              "en": "Line of Business Name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_7"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Papelaria\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Contacts@Relationships": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Consulta as relações de clientes, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Query customer relations, a field of pre-registered options.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da relação, gerado automaticamente pelo Banco de Dados.",
              "en": "Relation Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome da relação.",
              "en": "Relation Id."
            },
            "required": true
          }
        ]
      }
    },
    "/Contacts@Status": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Consulta os status dos clientes, um campo de opções pré cadastradas.</div>",
          "en": "<div><br>Query the available customer status, a field of pre-registered options.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do status do cliente, gerado automaticamente pelo Banco de Dados.",
              "en": "Customer status id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do status do cliente.",
              "en": "Customer status name."
            },
            "required": true
          }
        ]
      }
    },
    "/Contacts@Types": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Consulta os tipos de clientes.</div>",
          "en": "<div><br>Query the customer types</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do tipo de cliente.",
              "en": "Customer type Id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do tipo de cliente.",
              "en": "Customer type name"
            },
            "required": true
          }
        ]
      }
    },
    "/Contacts@Products": {
      "get": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Consulta os produtos de cliente da conta (Se o módulo estiver disponível na conta).</div>",
          "en": "<div><br>Query the account's customer products (If the module is available in the account).</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do produto de cliente, gerado automaticamente pelo Banco de dados.",
              "en": "Customer product id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do produto de cliente. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Customer product contact Id. This information is available through the '/Contacts' endpoint."
            },
            "required": true
          },
          {
            "name": "ProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto do produto de cliente. Essa informação está disponível pelo endpoint '/Products'.",
              "en": "Customer product's product id. This information is available via the '/Products' endpoint."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do produto de cliente.",
              "en": "Customer product name."
            },
            "required": false
          },
          {
            "name": "Code",
            "type": "string(100)",
            "description": {
              "pt": "Código do produto de cliente.",
              "en": "Customer Product Code."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, ContactId, ProductId, Code",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Product, OtherProperties, Creator, Updater",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Cria um produtos de cliente na conta (Se o módulo estiver disponível na conta).</div>",
          "en": "<div><br>Create a customer product in the account (If the module is available in the account).</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do produto de cliente, gerado automaticamente pelo Banco de dados.",
              "en": "Customer product id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do produto de cliente. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Customer product contact Id. This information is available through the '/Contacts' endpoint."
            },
            "required": true
          },
          {
            "name": "ProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto do produto de cliente. Essa informação está disponível pelo endpoint '/Products'.",
              "en": "Customer product's product id. This information is available via the '/Products' endpoint."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do produto de cliente.",
              "en": "Customer product name."
            },
            "required": false
          },
          {
            "name": "Code",
            "type": "string(100)",
            "description": {
              "pt": "Código do produto de cliente.",
              "en": "Customer Product Code."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, ContactId, ProductId, Code",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Product, OtherProperties, Creator, Updater",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_2"
              },
              "examples": {
                "0": {
                  "value": "{\r\n    \"Name\": \"Produto teste\",\r\n    \"ContactId\": 233,\r\n    \"ProductId\": 52344,\r\n    \"Code\": \"1234\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Contacts@Products({Id})": {
      "delete": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Apaga um produtos de cliente na conta (Se o módulo estiver disponível na conta).</div>",
          "en": "<div><br>Delete a customer product in the account (If the module is available in the account).</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Contacts"
        ],
        "description": {
          "pt": "<div><br>Atualiza um produtos de cliente na conta (Se o módulo estiver disponível na conta).</div>",
          "en": "<div><br>Update a customer product in the account (If the module is available in the account).</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do produto de cliente, gerado automaticamente pelo Banco de dados.",
              "en": "Customer product id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do produto de cliente. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Customer product contact Id. This information is available through the '/Contacts' endpoint."
            },
            "required": true
          },
          {
            "name": "ProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto do produto de cliente. Essa informação está disponível pelo endpoint '/Products'.",
              "en": "Customer product's product id. This information is available via the '/Products' endpoint."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do produto de cliente.",
              "en": "Customer product name."
            },
            "required": false
          },
          {
            "name": "Code",
            "type": "string(100)",
            "description": {
              "pt": "Código do produto de cliente.",
              "en": "Customer Product Code."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, ContactId, ProductId, Code",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Product, OtherProperties, Creator, Updater",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_7"
              },
              "examples": {
                "0": {
                  "value": "{\r\n    \"Name\": \"Produto teste\",\r\n    \"ContactId\": 233,\r\n    \"ProductId\": 52344,\r\n    \"Code\": \"1234\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Currencies": {
      "get": {
        "tags": [
          "Currencies"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de moedas.</div>",
          "en": "<div><br>Query the currency base.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da moeda, gerado automaticamente pelo Banco de dados.",
              "en": "Currency Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Symbol",
            "type": "string(10)",
            "description": {
              "pt": "Símbolo da moeda.",
              "en": "Currency symbol."
            },
            "required": true
          },
          {
            "name": "Code",
            "type": "string(10)",
            "description": {
              "pt": "Código da moeda.",
              "en": "Currency code."
            },
            "required": true
          }
        ]
      }
    },
    "/Deals": {
      "get": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de negócios.</div>",
          "en": "<div><br>Query the deals base.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do negócio, gerado automaticamente pelo Banco de Dados.",
              "en": "Deal Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Title",
            "type": "string(200)",
            "description": {
              "pt": "Título do negócio.",
              "en": "Deal title."
            },
            "required": false
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do negócio. Se o negócio não possuir nenhum cliente, o cliente Fantasma da conta será adicionado (É um id de cliente que todas as contas possuem para representar um cliente vazio). Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Deal customer id. If the business does not have any customers, the account ghost customer will be added (It is a customer id that all accounts have to represent an empty customer). This information is available through the '/Contacts' endpoint ."
            },
            "required": true
          },
          {
            "name": "PersonId",
            "type": "integer",
            "description": {
              "pt": "Id da pessoa do negócio. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Deal person id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "StageId",
            "type": "integer",
            "description": {
              "pt": "Id do estágio do negócio. Se o estágio não for informado, esse campo será preenchido com o primeiro estágio de um funil não arquivado. Os estágios existentes podem ser consultados no endpoint de '/Deals@Stages'.",
              "en": "Deal stage Id. If the stage is not informed, this field will be filled with the first stage of an unarchived funnel. Existing stages can be consulted in the endpoint of '/Deals@Stages'."
            },
            "required": true
          },
          {
            "name": "LastStageId",
            "type": "integer",
            "description": {
              "pt": "Id do último estágio do negócio.",
              "en": "Deal last stage id."
            },
            "required": false
          },
          {
            "name": "LossReasonId",
            "type": "integer",
            "description": {
              "pt": "Id do motivo de perda do negócio.",
              "en": "Deal loss reason id."
            },
            "required": false
          },
          {
            "name": "OriginId",
            "type": "integer",
            "description": {
              "pt": "Id da origem do negócio.",
              "en": "Deal origin id."
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do responsável do negócio. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Deal owner Id. This information is available through the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do negócio. Será inserido nesse campo a moeda do cliente ou a moeda padrão da conta.. Essa informação está disponível no endpoint de '/Currencies''.",
              "en": "Deal currency Id. The customer's currency or the default currency of the account will be inserted in this field. This information is available in the endpoint of '/Currencies''."
            },
            "required": true
          },
          {
            "name": "Amount",
            "type": "decimal",
            "description": {
              "pt": "Valor do negócio. Esse campo tem um valor padrão de 0.",
              "en": "Deal price. This field has a default value of 0."
            },
            "required": true
          },
          {
            "name": "OriginDealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio origem desse negócio. Esse campo estará preenchido se esse negócio for um negócio derivado de outro.",
              "en": "Deal origin deal id. This field will be filled in if this deal is derived from another deal."
            },
            "required": false
          },
          {
            "name": "DealNumber",
            "type": "integer",
            "description": {
              "pt": "Número do negócio.",
              "en": "Deal number."
            },
            "required": false
          },
          {
            "name": "ContactProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto de cliente do negócio.",
              "en": "Deal contact product id."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Title, StageId, ContactId, PersonId, OwnerId, Amount",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Stage, Status, Tags, Tasks, Products, Quotes, Origin, InteractionRecords, Orders, OtherProperties, Documents",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Cria um negócio</div>",
          "en": "<div><br>Create a deal</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do negócio, gerado automaticamente pelo Banco de Dados.",
              "en": "Deal Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Title",
            "type": "string(200)",
            "description": {
              "pt": "Título do negócio.",
              "en": "Deal title."
            },
            "required": false
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do negócio. Se o negócio não possuir nenhum cliente, o cliente Fantasma da conta será adicionado (É um id de cliente que todas as contas possuem para representar um cliente vazio). Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Deal customer id. If the business does not have any customers, the account ghost customer will be added (It is a customer id that all accounts have to represent an empty customer). This information is available through the '/Contacts' endpoint ."
            },
            "required": true
          },
          {
            "name": "PersonId",
            "type": "integer",
            "description": {
              "pt": "Id da pessoa do negócio. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Deal person id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "StageId",
            "type": "integer",
            "description": {
              "pt": "Id do estágio do negócio. Se o estágio não for informado, esse campo será preenchido com o primeiro estágio de um funil não arquivado. Os estágios existentes podem ser consultados no endpoint de '/Deals@Stages'.",
              "en": "Deal stage Id. If the stage is not informed, this field will be filled with the first stage of an unarchived funnel. Existing stages can be consulted in the endpoint of '/Deals@Stages'."
            },
            "required": true
          },
          {
            "name": "LastStageId",
            "type": "integer",
            "description": {
              "pt": "Id do último estágio do negócio.",
              "en": "Deal last stage id."
            },
            "required": false
          },
          {
            "name": "LossReasonId",
            "type": "integer",
            "description": {
              "pt": "Id do motivo de perda do negócio.",
              "en": "Deal loss reason id."
            },
            "required": false
          },
          {
            "name": "OriginId",
            "type": "integer",
            "description": {
              "pt": "Id da origem do negócio.",
              "en": "Deal origin id."
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do responsável do negócio. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Deal owner Id. This information is available through the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do negócio. Será inserido nesse campo a moeda do cliente ou a moeda padrão da conta.. Essa informação está disponível no endpoint de '/Currencies''.",
              "en": "Deal currency Id. The customer's currency or the default currency of the account will be inserted in this field. This information is available in the endpoint of '/Currencies''."
            },
            "required": true
          },
          {
            "name": "Amount",
            "type": "decimal",
            "description": {
              "pt": "Valor do negócio. Esse campo tem um valor padrão de 0.",
              "en": "Deal price. This field has a default value of 0."
            },
            "required": true
          },
          {
            "name": "OriginDealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio origem desse negócio. Esse campo estará preenchido se esse negócio for um negócio derivado de outro.",
              "en": "Deal origin deal id. This field will be filled in if this deal is derived from another deal."
            },
            "required": false
          },
          {
            "name": "DealNumber",
            "type": "integer",
            "description": {
              "pt": "Número do negócio.",
              "en": "Deal number."
            },
            "required": false
          },
          {
            "name": "ContactProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto de cliente do negócio.",
              "en": "Deal contact product id."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Title, StageId, ContactId, PersonId, OwnerId, Amount",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Stage, Status, Tags, Tasks, Products, Quotes, Origin, InteractionRecords, Orders, OtherProperties, Documents",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_1"
              },
              "examples": {
                "0": {
                  "value": "{\"Title\":\"Novo Neg\u00f3cio\",\"ContactId\":0,\"Amount\":20,\"StageId\":0,\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Deals({Id})": {
      "delete": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Apaga um negócio</div>",
          "en": "<div><br>Delete a deal</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Atualiza um negócio</div>",
          "en": "<div><br>Update a deal</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do negócio, gerado automaticamente pelo Banco de Dados.",
              "en": "Deal Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Title",
            "type": "string(200)",
            "description": {
              "pt": "Título do negócio.",
              "en": "Deal title."
            },
            "required": false
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do negócio. Se o negócio não possuir nenhum cliente, o cliente Fantasma da conta será adicionado (É um id de cliente que todas as contas possuem para representar um cliente vazio). Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Deal customer id. If the business does not have any customers, the account ghost customer will be added (It is a customer id that all accounts have to represent an empty customer). This information is available through the '/Contacts' endpoint ."
            },
            "required": true
          },
          {
            "name": "PersonId",
            "type": "integer",
            "description": {
              "pt": "Id da pessoa do negócio. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Deal person id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "StageId",
            "type": "integer",
            "description": {
              "pt": "Id do estágio do negócio. Se o estágio não for informado, esse campo será preenchido com o primeiro estágio de um funil não arquivado. Os estágios existentes podem ser consultados no endpoint de '/Deals@Stages'.",
              "en": "Deal stage Id. If the stage is not informed, this field will be filled with the first stage of an unarchived funnel. Existing stages can be consulted in the endpoint of '/Deals@Stages'."
            },
            "required": true
          },
          {
            "name": "LastStageId",
            "type": "integer",
            "description": {
              "pt": "Id do último estágio do negócio.",
              "en": "Deal last stage id."
            },
            "required": false
          },
          {
            "name": "LossReasonId",
            "type": "integer",
            "description": {
              "pt": "Id do motivo de perda do negócio.",
              "en": "Deal loss reason id."
            },
            "required": false
          },
          {
            "name": "OriginId",
            "type": "integer",
            "description": {
              "pt": "Id da origem do negócio.",
              "en": "Deal origin id."
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do responsável do negócio. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Deal owner Id. This information is available through the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do negócio. Será inserido nesse campo a moeda do cliente ou a moeda padrão da conta.. Essa informação está disponível no endpoint de '/Currencies''.",
              "en": "Deal currency Id. The customer's currency or the default currency of the account will be inserted in this field. This information is available in the endpoint of '/Currencies''."
            },
            "required": true
          },
          {
            "name": "Amount",
            "type": "decimal",
            "description": {
              "pt": "Valor do negócio. Esse campo tem um valor padrão de 0.",
              "en": "Deal price. This field has a default value of 0."
            },
            "required": true
          },
          {
            "name": "OriginDealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio origem desse negócio. Esse campo estará preenchido se esse negócio for um negócio derivado de outro.",
              "en": "Deal origin deal id. This field will be filled in if this deal is derived from another deal."
            },
            "required": false
          },
          {
            "name": "DealNumber",
            "type": "integer",
            "description": {
              "pt": "Número do negócio.",
              "en": "Deal number."
            },
            "required": false
          },
          {
            "name": "ContactProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto de cliente do negócio.",
              "en": "Deal contact product id."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Title, StageId, ContactId, PersonId, OwnerId, Amount",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Stage, Status, Tags, Tasks, Products, Quotes, Origin, InteractionRecords, Orders, OtherProperties, Documents",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_4"
              },
              "examples": {
                "0": {
                  "value": "{\"Title\":\"Novo Neg\u00f3cio\",\"ContactId\":0,\"Amount\":20,\"StageId\":0,\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Deals({Id})/Win": {
      "post": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Ganhar um negócio. Lembre-se de garantir que o negócio pode ser ganho, considerando checklists e regras de funil.</div>",
          "en": "<div><br>Win a deal. Remember to ensure the deal is winnable by considering checklists and funnel rules.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Title, StageId, ContactId, PersonId, OwnerId, Amount",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Stage, Status, Tags, Tasks, Products, Quotes, Origin, InteractionRecords, Orders, OtherProperties, Documents",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_1"
              },
              "examples": {
                "0": {
                  "value": "{}"
                }
              }
            }
          }
        }
      }
    },
    "/Deals({Id})/Lose": {
      "post": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Perder um negócio. Lembre-se de garantir que o negócio pode ser perdido, considerando checklists e regras de funil.</div>",
          "en": "<div><br>Lose a deal. Remember to ensure the deal can be lost by considering checklists and funnel rules.</div>"
        },
        "fields": [
          {
            "name": "LossReasonId",
            "type": "integer",
            "description": {
              "pt": "Id do motivo de perda. As opções disponível podem ser consultadas no endpoint '/Deals@LossReasons'.",
              "en": "Loss reason Id. The available options can be consulted in the endpoint '/Deals@LossReasons'."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Title, StageId, ContactId, PersonId, OwnerId, Amount",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Stage, Status, Tags, Tasks, Products, Quotes, Origin, InteractionRecords, Orders, OtherProperties, Documents",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_1"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"LossReasonId\": 176\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Deals({Id})/Reopen": {
      "post": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Reabrir um negócio. Lembre-se de garantir que o negócio pode ser reaberto, considerando checklists e regras de funil.</div>",
          "en": "<div><br>Reopening a deal. Remember to ensure that the deal can be reopened, considering checklists and funnel rules.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Title, StageId, ContactId, PersonId, OwnerId, Amount",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Stage, Status, Tags, Tasks, Products, Quotes, Origin, InteractionRecords, Orders, OtherProperties, Documents",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_1"
              },
              "examples": {
                "0": {
                  "value": "{}"
                }
              }
            }
          }
        }
      }
    },
    "/Deals@Stages": {
      "get": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Consulta os estágios do funil.</div>",
          "en": "<div><br>Query the stages of the funnel.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da estágio do negócio, gerado automaticamente pelo Banco de Dados.",
              "en": "Deal Stage Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do estágio do negócio.",
              "en": "Deal Stage Name."
            },
            "required": true
          },
          {
            "name": "PipelineId",
            "type": "integer",
            "description": {
              "pt": "Funil do estágio do negócio. Essa informação pode ser consultada no endpoint '/Deals@Pipelines'.",
              "en": "Deal stage funnel. This information can be found in the '/Deals@Pipelines' endpoint."
            },
            "required": true
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação do estágio do negócio. Esse é o número que define a ordem entre os estágios dentro de um funil, indo do menor para o maior. Não é possível inserir estágios com ordenação igual dentro do mesmo funil.",
              "en": "Deal stage ordination. This is the number that defines the order between the stages within a funnel, going from the smallest to the largest. It is not possible to insert stages with the same order within the same funnel."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, PipelineId, Ordination",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Pipeline, Deals, Checklists, Automations",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Deals@Status": {
      "get": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de status dos negócios disponíveis.</div>",
          "en": "<div><br>Query the status base of available deals.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do status do negócio.",
              "en": "Deal status id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do status do negócio.",
              "en": "Deal status name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id,Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Deals@LossReasons": {
      "get": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de motivos de perda disponíveis.</div>",
          "en": "<div><br>Query the available loss reasons base.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do motivo de perda, gerado automaticamente pelo Banco de dados.",
              "en": "Loss reason Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do motivo de perda.",
              "en": "Loss reason name."
            },
            "required": true
          },
          {
            "name": "PipelineId",
            "type": "integer",
            "description": {
              "pt": "Id do funil do motivo de perda.",
              "en": "Loss reason funnel Id."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id,Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Pipeline",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Deals@Pipelines": {
      "get": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Consulta os funis de negócios.</div>",
          "en": "<div><br>Query the deals funnels.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do Funil de negócio, gerado automaticamente pelo Banco de Dados.",
              "en": "Deal funnel id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do funil de negócio.",
              "en": "Deal funnel name."
            },
            "required": true
          },
          {
            "name": "MustPassAllStages",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se a passagem por todos os estágios é obrigatória neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether passing through all stages is mandatory in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "ForbiddenStageReturn",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é proibido voltar de etapa neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether it is forbidden to go back to a stage in the funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayCreateQuotes",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode gerar propostas neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether quotes can be generated in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayCreateOrders",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode gerar vendas neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether it can generate orders in the funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayCreateDocuments",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode gerar documentos neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether documents can be generated in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayWinDeals",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode ganhar negócios neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates if you can win deals in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayLoseDeals",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode perder propostas neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates if you can lose quotes in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "FormId",
            "type": "integer",
            "description": {
              "pt": "Id do formulário do funil de negócio.",
              "en": "Deal funnel form id."
            },
            "required": false
          },
          {
            "name": "QuickFormId",
            "type": "integer",
            "description": {
              "pt": "Id do formulário mini do funil de negócio.",
              "en": "Deal funnel quick form id."
            },
            "required": false
          },
          {
            "name": "Archived",
            "type": "boolean",
            "description": {
              "pt": "Indica de o formulário está arquivado. Assume o valor de falso inicialmente.",
              "en": "Indicates that the form is archived. It assumes the value of false initially."
            },
            "required": true
          },
          {
            "name": "NewOrderOnWonDeal",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve gerar uma nova venda ao ganhar um negócio neste funil (Abrindo a janela de criação de uma nova venda). Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether to generate a new order when winning a deal in this funnel (Opening the form for creating a new sale). It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "CreateOrderOnWonDeal",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve gerar uma nova venda automaticamente ao ganhar um negócio neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether a new order should be automatically generated when winning a deal in this funnel. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "WinDealOnLastStage",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é possível ganhar um negócio apenas na última etapa neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether it is possible to win a deal only in the last stage of this funnel. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "SingularUnitName",
            "type": "string(50)",
            "description": {
              "pt": "Nome da unidade no singular desse funil.",
              "en": "Unit name in the singular of this funnel."
            },
            "required": false
          },
          {
            "name": "PluralUnitName",
            "type": "string(50)",
            "description": {
              "pt": "Nome da unidade no plural desse funil.",
              "en": "Plural Unit name of this funnel."
            },
            "required": false
          },
          {
            "name": "GenderId",
            "type": "integer",
            "description": {
              "pt": "Gênero da unidade desse funil.",
              "en": "Unit gender of this funnel."
            },
            "required": false
          },
          {
            "name": "EnableTableViewMode",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se a visualização de tabela está disponível.",
              "en": "Boolean indicating whether the table view is enabled."
            },
            "required": true
          },
          {
            "name": "EnableFunnelViewMode",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se a visualização de Funil/Kanban está disponível.",
              "en": "Boolean indicating whether the Funnel/Kanban view is available."
            },
            "required": true
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação do funil.",
              "en": "Funnel ordination."
            },
            "required": false
          },
          {
            "name": "QuotesUseERPFormat",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve usar formato de tela cheia para criação/edição de propostas neste funil.",
              "en": "Boolean that indicates whether to use full screen format for creating/editing quotes in this funnel."
            },
            "required": false
          },
          {
            "name": "OrdersUseERPFormat",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve usar formato de tela cheia para criação/edição de vendas neste funil.",
              "en": "Boolean that indicates whether to use full screen format for creating/editing orders in this funnel."
            },
            "required": false
          },
          {
            "name": "DocumentsUseERPFormat",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve usar formato de tela cheia para criação/edição de documentos neste funil.",
              "en": "Boolean that indicates whether to use full screen format for creating/editing documents in this funnel."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Ordination",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Form, Stages, AllowedUsers, AllowedTeams, LossReasons, AllowedDocumentTemplates",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Criar um funil de negócio. É recomendado criar um funil pela web</div>",
          "en": "<div><br>Create a deal funnel. It is recommended to create funnel using the web version of Ploomes</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do Funil de negócio, gerado automaticamente pelo Banco de Dados.",
              "en": "Deal funnel id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do funil de negócio.",
              "en": "Deal funnel name."
            },
            "required": true
          },
          {
            "name": "MustPassAllStages",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se a passagem por todos os estágios é obrigatória neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether passing through all stages is mandatory in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "ForbiddenStageReturn",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é proibido voltar de etapa neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether it is forbidden to go back to a stage in the funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayCreateQuotes",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode gerar propostas neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether quotes can be generated in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayCreateOrders",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode gerar vendas neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether it can generate orders in the funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayCreateDocuments",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode gerar documentos neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether documents can be generated in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayWinDeals",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode ganhar negócios neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates if you can win deals in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayLoseDeals",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode perder propostas neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates if you can lose quotes in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "FormId",
            "type": "integer",
            "description": {
              "pt": "Id do formulário do funil de negócio.",
              "en": "Deal funnel form id."
            },
            "required": false
          },
          {
            "name": "QuickFormId",
            "type": "integer",
            "description": {
              "pt": "Id do formulário mini do funil de negócio.",
              "en": "Deal funnel quick form id."
            },
            "required": false
          },
          {
            "name": "Archived",
            "type": "boolean",
            "description": {
              "pt": "Indica de o formulário está arquivado. Assume o valor de falso inicialmente.",
              "en": "Indicates that the form is archived. It assumes the value of false initially."
            },
            "required": true
          },
          {
            "name": "NewOrderOnWonDeal",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve gerar uma nova venda ao ganhar um negócio neste funil (Abrindo a janela de criação de uma nova venda). Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether to generate a new order when winning a deal in this funnel (Opening the form for creating a new sale). It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "CreateOrderOnWonDeal",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve gerar uma nova venda automaticamente ao ganhar um negócio neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether a new order should be automatically generated when winning a deal in this funnel. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "WinDealOnLastStage",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é possível ganhar um negócio apenas na última etapa neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether it is possible to win a deal only in the last stage of this funnel. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "SingularUnitName",
            "type": "string(50)",
            "description": {
              "pt": "Nome da unidade no singular desse funil.",
              "en": "Unit name in the singular of this funnel."
            },
            "required": false
          },
          {
            "name": "PluralUnitName",
            "type": "string(50)",
            "description": {
              "pt": "Nome da unidade no plural desse funil.",
              "en": "Plural Unit name of this funnel."
            },
            "required": false
          },
          {
            "name": "GenderId",
            "type": "integer",
            "description": {
              "pt": "Gênero da unidade desse funil.",
              "en": "Unit gender of this funnel."
            },
            "required": false
          },
          {
            "name": "EnableTableViewMode",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se a visualização de tabela está disponível.",
              "en": "Boolean indicating whether the table view is enabled."
            },
            "required": true
          },
          {
            "name": "EnableFunnelViewMode",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se a visualização de Funil/Kanban está disponível.",
              "en": "Boolean indicating whether the Funnel/Kanban view is available."
            },
            "required": true
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação do funil.",
              "en": "Funnel ordination."
            },
            "required": false
          },
          {
            "name": "QuotesUseERPFormat",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve usar formato de tela cheia para criação/edição de propostas neste funil.",
              "en": "Boolean that indicates whether to use full screen format for creating/editing quotes in this funnel."
            },
            "required": false
          },
          {
            "name": "OrdersUseERPFormat",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve usar formato de tela cheia para criação/edição de vendas neste funil.",
              "en": "Boolean that indicates whether to use full screen format for creating/editing orders in this funnel."
            },
            "required": false
          },
          {
            "name": "DocumentsUseERPFormat",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve usar formato de tela cheia para criação/edição de documentos neste funil.",
              "en": "Boolean that indicates whether to use full screen format for creating/editing documents in this funnel."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Ordination",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Form, Stages, AllowedUsers, AllowedTeams, LossReasons, AllowedDocumentTemplates",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_1"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Funil inserido pelo Postman\",\r\n  \"MayCreateQuotes\": true,\r\n  \"Stages\": [\r\n    {\r\n      \"Name\": \"Estágio 1\",\r\n      \"Ordination\": 1\r\n    },\r\n    {\r\n      \"Name\": \"Estágio 2\",\r\n      \"Ordination\": 2\r\n    }\r\n  ]\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Deals@Pipelines({Id})": {
      "delete": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Apaga um funil de negócio</div>",
          "en": "<div><br>Delete a deal funnel</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Deals"
        ],
        "description": {
          "pt": "<div><br>Atualizar um funil de negócio. É recomendado criar um funil pela web</div>",
          "en": "<div><br>Update a deal funnel. It is recommended to create funnel using the web version of Ploomes</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do Funil de negócio, gerado automaticamente pelo Banco de Dados.",
              "en": "Deal funnel id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do funil de negócio.",
              "en": "Deal funnel name."
            },
            "required": true
          },
          {
            "name": "MustPassAllStages",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se a passagem por todos os estágios é obrigatória neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether passing through all stages is mandatory in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "ForbiddenStageReturn",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é proibido voltar de etapa neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether it is forbidden to go back to a stage in the funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayCreateQuotes",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode gerar propostas neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether quotes can be generated in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayCreateOrders",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode gerar vendas neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether it can generate orders in the funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayCreateDocuments",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode gerar documentos neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether documents can be generated in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayWinDeals",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode ganhar negócios neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates if you can win deals in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "MayLoseDeals",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se pode perder propostas neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates if you can lose quotes in this funnel. It assumes false if not informed."
            },
            "required": true
          },
          {
            "name": "FormId",
            "type": "integer",
            "description": {
              "pt": "Id do formulário do funil de negócio.",
              "en": "Deal funnel form id."
            },
            "required": false
          },
          {
            "name": "QuickFormId",
            "type": "integer",
            "description": {
              "pt": "Id do formulário mini do funil de negócio.",
              "en": "Deal funnel quick form id."
            },
            "required": false
          },
          {
            "name": "Archived",
            "type": "boolean",
            "description": {
              "pt": "Indica de o formulário está arquivado. Assume o valor de falso inicialmente.",
              "en": "Indicates that the form is archived. It assumes the value of false initially."
            },
            "required": true
          },
          {
            "name": "NewOrderOnWonDeal",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve gerar uma nova venda ao ganhar um negócio neste funil (Abrindo a janela de criação de uma nova venda). Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether to generate a new order when winning a deal in this funnel (Opening the form for creating a new sale). It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "CreateOrderOnWonDeal",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve gerar uma nova venda automaticamente ao ganhar um negócio neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether a new order should be automatically generated when winning a deal in this funnel. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "WinDealOnLastStage",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é possível ganhar um negócio apenas na última etapa neste funil. Assume o valor de falso se não for informado.",
              "en": "Boolean that indicates whether it is possible to win a deal only in the last stage of this funnel. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "SingularUnitName",
            "type": "string(50)",
            "description": {
              "pt": "Nome da unidade no singular desse funil.",
              "en": "Unit name in the singular of this funnel."
            },
            "required": false
          },
          {
            "name": "PluralUnitName",
            "type": "string(50)",
            "description": {
              "pt": "Nome da unidade no plural desse funil.",
              "en": "Plural Unit name of this funnel."
            },
            "required": false
          },
          {
            "name": "GenderId",
            "type": "integer",
            "description": {
              "pt": "Gênero da unidade desse funil.",
              "en": "Unit gender of this funnel."
            },
            "required": false
          },
          {
            "name": "EnableTableViewMode",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se a visualização de tabela está disponível.",
              "en": "Boolean indicating whether the table view is enabled."
            },
            "required": true
          },
          {
            "name": "EnableFunnelViewMode",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se a visualização de Funil/Kanban está disponível.",
              "en": "Boolean indicating whether the Funnel/Kanban view is available."
            },
            "required": true
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação do funil.",
              "en": "Funnel ordination."
            },
            "required": false
          },
          {
            "name": "QuotesUseERPFormat",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve usar formato de tela cheia para criação/edição de propostas neste funil.",
              "en": "Boolean that indicates whether to use full screen format for creating/editing quotes in this funnel."
            },
            "required": false
          },
          {
            "name": "OrdersUseERPFormat",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve usar formato de tela cheia para criação/edição de vendas neste funil.",
              "en": "Boolean that indicates whether to use full screen format for creating/editing orders in this funnel."
            },
            "required": false
          },
          {
            "name": "DocumentsUseERPFormat",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se deve usar formato de tela cheia para criação/edição de documentos neste funil.",
              "en": "Boolean that indicates whether to use full screen format for creating/editing documents in this funnel."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Ordination",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Form, Stages, AllowedUsers, AllowedTeams, LossReasons, AllowedDocumentTemplates",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_4"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Funil inserido pelo Postman\",\r\n  \"MayCreateQuotes\": true,\r\n  \"Stages\": [\r\n    {\r\n      \"Name\": \"Estágio 1\",\r\n      \"Ordination\": 1\r\n    },\r\n    {\r\n      \"Name\": \"Estágio 2\",\r\n      \"Ordination\": 2\r\n    }\r\n  ]\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Documents": {
      "get": {
        "tags": [
          "Documents"
        ],
        "description": {
          "pt": "<div><br>Consulta os documentos da conta.</div>",
          "en": "<div><br>Query the account documents.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do documento, gerado automaticamente pelo Bando de Dados.",
              "en": "Document Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do documento.",
              "en": "Document name."
            },
            "required": false
          },
          {
            "name": "DocumentNumber",
            "type": "integer",
            "description": {
              "pt": "Número do documento.",
              "en": "Document number"
            },
            "required": false
          },
          {
            "name": "Date",
            "type": "datetime",
            "description": {
              "pt": "Data do documento, prenchida automaticamente com a data atual se nenhum valor for infomado. ",
              "en": "Document date, automatically filled in with the current date if no value is entered. "
            },
            "required": true
          },
          {
            "name": "TemplateId",
            "type": "integer",
            "description": {
              "pt": "Id do modelo do documento. Essa informação pode ser consultada no endpoint '/DocumentTemplates'.",
              "en": "Document template id. This information can be consulted in the '/DocumentTemplates' endpoint."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do documento. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Document contact id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "PersonId",
            "type": "integer",
            "description": {
              "pt": "Id da pessoa do documento. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Document person id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio do documento. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Document deal id. This information is available in the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do responsável do documento. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Document owner id. This information is available through the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "Key",
            "type": "string(22)",
            "description": {
              "pt": "Chave do documento.",
              "en": "Document Key"
            },
            "required": false
          },
          {
            "name": "Shared",
            "type": "boolean",
            "description": {
              "pt": "Indica se o documento foi compartilhado.",
              "en": "Indicates whether the document has been shared."
            },
            "required": false
          },
          {
            "name": "ExternallyAccepted",
            "type": "boolean",
            "description": {
              "pt": "Indica se o documento foi aceito externamente.",
              "en": "Indicates whether the document has been externally accepted."
            },
            "required": false
          },
          {
            "name": "ExternalNotifications",
            "type": "boolean",
            "description": {
              "pt": "Indica o recebimento de notificações externas.",
              "en": "Indicates receipt of external notifications."
            },
            "required": false
          },
          {
            "name": "ExternalSharingDate",
            "type": "datetime",
            "description": {
              "pt": "Data de compartilhamento do documento.",
              "en": "Document external sharing date."
            },
            "required": false
          },
          {
            "name": "DocumentUrl",
            "type": "string(500)",
            "description": {
              "pt": "URL do documento (Quando compartilhado externamente).",
              "en": "Document URL (When shared externally)."
            },
            "required": false
          },
          {
            "name": "ApprovalStatusId",
            "type": "integer",
            "description": {
              "pt": "Id do status da aprovação do documento.",
              "en": "The approval status id of the document."
            },
            "required": false
          },
          {
            "name": "ApprovalLevelId",
            "type": "integer",
            "description": {
              "pt": "Indica o nível de aprovação do documento.",
              "en": "Indicates the approval level of the document."
            },
            "required": false
          },
          {
            "name": "OriginQuoteId",
            "type": "integer",
            "description": {
              "pt": "Id da proposta origem do documento.",
              "en": "Document origin quote id."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do documento. Essa informação está disponível no endpoint de '/Currencies'.",
              "en": "Document currency id. This information is available on the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "FileName",
            "type": "string(200)",
            "description": {
              "pt": "Nome do arquivo do documento.",
              "en": "Document file name."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Date, DocumentNumber, TemplateId, ContactId, DealId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Template, Pages, Sections, Products, OtherProperties, Comments, ExternalComments,Installments, RelatedPeople",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Documents"
        ],
        "description": {
          "pt": "<div><br>Cria um documento.</div>",
          "en": "<div><br>Create a document.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do documento, gerado automaticamente pelo Bando de Dados.",
              "en": "Document Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do documento.",
              "en": "Document name."
            },
            "required": false
          },
          {
            "name": "DocumentNumber",
            "type": "integer",
            "description": {
              "pt": "Número do documento.",
              "en": "Document number"
            },
            "required": false
          },
          {
            "name": "Date",
            "type": "datetime",
            "description": {
              "pt": "Data do documento, prenchida automaticamente com a data atual se nenhum valor for infomado. ",
              "en": "Document date, automatically filled in with the current date if no value is entered. "
            },
            "required": true
          },
          {
            "name": "TemplateId",
            "type": "integer",
            "description": {
              "pt": "Id do modelo do documento. Essa informação pode ser consultada no endpoint '/DocumentTemplates'.",
              "en": "Document template id. This information can be consulted in the '/DocumentTemplates' endpoint."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do documento. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Document contact id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "PersonId",
            "type": "integer",
            "description": {
              "pt": "Id da pessoa do documento. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Document person id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio do documento. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Document deal id. This information is available in the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do responsável do documento. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Document owner id. This information is available through the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "Key",
            "type": "string(22)",
            "description": {
              "pt": "Chave do documento.",
              "en": "Document Key"
            },
            "required": false
          },
          {
            "name": "Shared",
            "type": "boolean",
            "description": {
              "pt": "Indica se o documento foi compartilhado.",
              "en": "Indicates whether the document has been shared."
            },
            "required": false
          },
          {
            "name": "ExternallyAccepted",
            "type": "boolean",
            "description": {
              "pt": "Indica se o documento foi aceito externamente.",
              "en": "Indicates whether the document has been externally accepted."
            },
            "required": false
          },
          {
            "name": "ExternalNotifications",
            "type": "boolean",
            "description": {
              "pt": "Indica o recebimento de notificações externas.",
              "en": "Indicates receipt of external notifications."
            },
            "required": false
          },
          {
            "name": "ExternalSharingDate",
            "type": "datetime",
            "description": {
              "pt": "Data de compartilhamento do documento.",
              "en": "Document external sharing date."
            },
            "required": false
          },
          {
            "name": "DocumentUrl",
            "type": "string(500)",
            "description": {
              "pt": "URL do documento (Quando compartilhado externamente).",
              "en": "Document URL (When shared externally)."
            },
            "required": false
          },
          {
            "name": "ApprovalStatusId",
            "type": "integer",
            "description": {
              "pt": "Id do status da aprovação do documento.",
              "en": "The approval status id of the document."
            },
            "required": false
          },
          {
            "name": "ApprovalLevelId",
            "type": "integer",
            "description": {
              "pt": "Indica o nível de aprovação do documento.",
              "en": "Indicates the approval level of the document."
            },
            "required": false
          },
          {
            "name": "OriginQuoteId",
            "type": "integer",
            "description": {
              "pt": "Id da proposta origem do documento.",
              "en": "Document origin quote id."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do documento. Essa informação está disponível no endpoint de '/Currencies'.",
              "en": "Document currency id. This information is available on the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "FileName",
            "type": "string(200)",
            "description": {
              "pt": "Nome do arquivo do documento.",
              "en": "Document file name."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Date, DocumentNumber, TemplateId, ContactId, DealId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Template, Pages, Sections, Products, OtherProperties, Comments, ExternalComments,Installments, RelatedPeople",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_8"
              },
              "examples": {
                "0": {
                  "value": "{\"Name\":\"Documento teste\",\"TemplateId\":0,\"ContactId\":0,\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Documents({Id})": {
      "delete": {
        "tags": [
          "Documents"
        ],
        "description": {
          "pt": "<div><br>Apaga um documento.</div>",
          "en": "<div><br>Delete a document.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Documents"
        ],
        "description": {
          "pt": "<div><br>Atualiza um documento.</div>",
          "en": "<div><br>Update a document.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do documento, gerado automaticamente pelo Bando de Dados.",
              "en": "Document Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do documento.",
              "en": "Document name."
            },
            "required": false
          },
          {
            "name": "DocumentNumber",
            "type": "integer",
            "description": {
              "pt": "Número do documento.",
              "en": "Document number"
            },
            "required": false
          },
          {
            "name": "Date",
            "type": "datetime",
            "description": {
              "pt": "Data do documento, prenchida automaticamente com a data atual se nenhum valor for infomado. ",
              "en": "Document date, automatically filled in with the current date if no value is entered. "
            },
            "required": true
          },
          {
            "name": "TemplateId",
            "type": "integer",
            "description": {
              "pt": "Id do modelo do documento. Essa informação pode ser consultada no endpoint '/DocumentTemplates'.",
              "en": "Document template id. This information can be consulted in the '/DocumentTemplates' endpoint."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do documento. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Document contact id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "PersonId",
            "type": "integer",
            "description": {
              "pt": "Id da pessoa do documento. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Document person id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio do documento. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Document deal id. This information is available in the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do responsável do documento. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Document owner id. This information is available through the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "Key",
            "type": "string(22)",
            "description": {
              "pt": "Chave do documento.",
              "en": "Document Key"
            },
            "required": false
          },
          {
            "name": "Shared",
            "type": "boolean",
            "description": {
              "pt": "Indica se o documento foi compartilhado.",
              "en": "Indicates whether the document has been shared."
            },
            "required": false
          },
          {
            "name": "ExternallyAccepted",
            "type": "boolean",
            "description": {
              "pt": "Indica se o documento foi aceito externamente.",
              "en": "Indicates whether the document has been externally accepted."
            },
            "required": false
          },
          {
            "name": "ExternalNotifications",
            "type": "boolean",
            "description": {
              "pt": "Indica o recebimento de notificações externas.",
              "en": "Indicates receipt of external notifications."
            },
            "required": false
          },
          {
            "name": "ExternalSharingDate",
            "type": "datetime",
            "description": {
              "pt": "Data de compartilhamento do documento.",
              "en": "Document external sharing date."
            },
            "required": false
          },
          {
            "name": "DocumentUrl",
            "type": "string(500)",
            "description": {
              "pt": "URL do documento (Quando compartilhado externamente).",
              "en": "Document URL (When shared externally)."
            },
            "required": false
          },
          {
            "name": "ApprovalStatusId",
            "type": "integer",
            "description": {
              "pt": "Id do status da aprovação do documento.",
              "en": "The approval status id of the document."
            },
            "required": false
          },
          {
            "name": "ApprovalLevelId",
            "type": "integer",
            "description": {
              "pt": "Indica o nível de aprovação do documento.",
              "en": "Indicates the approval level of the document."
            },
            "required": false
          },
          {
            "name": "OriginQuoteId",
            "type": "integer",
            "description": {
              "pt": "Id da proposta origem do documento.",
              "en": "Document origin quote id."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do documento. Essa informação está disponível no endpoint de '/Currencies'.",
              "en": "Document currency id. This information is available on the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "FileName",
            "type": "string(200)",
            "description": {
              "pt": "Nome do arquivo do documento.",
              "en": "Document file name."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Date, DocumentNumber, TemplateId, ContactId, DealId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Template, Pages, Sections, Products, OtherProperties, Comments, ExternalComments,Installments, RelatedPeople",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_9"
              },
              "examples": {
                "0": {
                  "value": "{\"Name\":\"Documento teste\",\"TemplateId\":0,\"ContactId\":0,\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/DocumentTemplates": {
      "get": {
        "tags": [
          "DocumentTemplates"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de modelos para propostas, vendas e documentos.</div>",
          "en": "<div><br>Query the base of templates for quotes, orders and documents.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do modelo.",
              "en": "Document template id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do modelo.",
              "en": "Document template."
            },
            "required": false
          },
          {
            "name": "EntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade do modelo. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Document template entity Id. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": true
          },
          {
            "name": "SecondaryEntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade secundária do modelo. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Document template secondary entity id. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": false
          },
          {
            "name": "Default",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se esse é o modelo padrão da entidade.",
              "en": "Boolean indicating whether this is the entity's default model."
            },
            "required": true
          },
          {
            "name": "HeaderSourceCode",
            "type": "string(max)",
            "description": {
              "pt": "Código-Fonte do cabeçalho.",
              "en": "Header Source Code."
            },
            "required": false
          },
          {
            "name": "HeaderHeight",
            "type": "integer",
            "description": {
              "pt": "Altura do cabeçalho.",
              "en": "Header Height."
            },
            "required": false
          },
          {
            "name": "FooterSourceCode",
            "type": "string(max)",
            "description": {
              "pt": "Código-Fonte do rodapé.",
              "en": "Footer Source Code."
            },
            "required": false
          },
          {
            "name": "FooterHeight",
            "type": "integer",
            "description": {
              "pt": "Altura do rodapé.",
              "en": "Footer Height"
            },
            "required": false
          },
          {
            "name": "BodySourceCode",
            "type": "string(-1)",
            "description": {
              "pt": "Código-Fonte do corpo.",
              "en": "Body Source Code."
            },
            "required": false
          },
          {
            "name": "TopMargin",
            "type": "integer",
            "description": {
              "pt": "Margem superior.",
              "en": "Top margin."
            },
            "required": true
          },
          {
            "name": "BottomMargin",
            "type": "integer",
            "description": {
              "pt": "Margem inferior.",
              "en": "Bottom margin."
            },
            "required": true
          },
          {
            "name": "SideMargin",
            "type": "integer",
            "description": {
              "pt": "Margem lateral.",
              "en": "Side margin."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, EntityId, Default",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Entity, SecondaryEntity, Form, Pages, AllowedUsers, AllowedTeams",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Departments": {
      "get": {
        "tags": [
          "Departments"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de departamentos da conta.</div>",
          "en": "<div><br>Query the account's department base.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do departamento, gerado automaticamente pelo Banco de Dados.",
              "en": "Department ID, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome do departamento.",
              "en": "Department name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id,Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Departments"
        ],
        "description": {
          "pt": "<div><br>Cria um novo departamento na base de departamentos da conta</div>",
          "en": "<div><br>Create a new department in the account's department base</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do departamento, gerado automaticamente pelo Banco de Dados.",
              "en": "Department ID, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome do departamento.",
              "en": "Department name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id,Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_8"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Depart\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Departments({Id})": {
      "delete": {
        "tags": [
          "Departments"
        ],
        "description": "<div><div id='title-pt'><br>Apaga um departamento na base de departamentos da conta</div></div>",
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Departments"
        ],
        "description": "<div><div id='title-pt'><br>Atualiza um departamento na base de departamentos da conta</div></div>",
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do departamento, gerado automaticamente pelo Banco de Dados.",
              "en": "Department ID, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome do departamento.",
              "en": "Department name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id,Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_9"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Depart\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Fields": {
      "get": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Consulta os campos da conta. <br> Todos os campos dinâmicos da conta vem para essa entidade.</div>",
          "en": "<div><br>Query the account fields. <br> All custom fields are created in this entity.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do campo, gerado automaticamente pelo banco de dados.",
              "en": "Field id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Key",
            "type": "string(100)",
            "description": {
              "pt": "Chave do campo, gerada automaticamente pelo banco de dados. É a chave que é normalmente utilizada nas relações dos campos com outras entidades, como um identificador do campo.",
              "en": "Field key, automatically generated by the database. It is the key that is usually used in the field relationships with other entities, as a field identifier."
            },
            "required": true
          },
          {
            "name": "Dynamic",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é customizado/dinâmico ou não. Novos campos sempre são dinâmicos/customizados.",
              "en": "Boolean indicating whether the field is custom/dynamic or not. New fields are always dynamic/custom."
            },
            "required": true
          },
          {
            "name": "EntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade do campo. Essa informação está disponível no endpoint de '/Fields@Entities'.",
              "en": "Field's entity id. This information is available on the '/Fields@Entities' endpoint."
            },
            "required": true
          },
          {
            "name": "OptionsTableId",
            "type": "integer",
            "description": {
              "pt": "Id da tabela de opções do campo (Apenas campos do tipo 'Opções pré cadastradas' possuem uma tabela de opções). Essa informação está disponível no endpoint '/Fields@OptionsTable'.",
              "en": "Field options table Id (Only fields of the type 'Pre-registered options' have an options table). This information is available in the '/Fields@OptionsTable' endpoint."
            },
            "required": false
          },
          {
            "name": "SecondaryEntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade secundária do campos (Exemplo: Um campo do tipo usuário tem a entidade secundária de usuários.). Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Id of the secondary entity of the fields (Example: A field of type user has the secondary entity of users.). This information is available in the endpoint '/Fields@Entities'."
            },
            "required": false
          },
          {
            "name": "Name",
            "type": "string(60)",
            "description": {
              "pt": "Nome do campo.",
              "en": "Field name."
            },
            "required": true
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo do campo. Essa informação está disponível no endpoint '/Fields@Types'.",
              "en": "Field type id. This information is available in the '/Fields@Types' endpoint."
            },
            "required": true
          },
          {
            "name": "Required",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é obrigatório. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is mandatory. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Unique",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é único (Campo chave). Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is unique (A Key field). It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Multiple",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é múltiplo. O tipo de campo deve permitir que ele seja múltiplo. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is multiple. The field type must allow it to be multiple. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Disabled",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo está desabilitado. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is disabled. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Wide",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um campo de duas colunas. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if it is a two-column field. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "FormFilterable",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo pode ser filtrado nos formulários. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates whether the field can be filtered in forms. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "InternalFormula",
            "type": "string(max)",
            "description": {
              "pt": "Fórmula interna do campo.",
              "en": "Field's internal formula."
            },
            "required": false
          },
          {
            "name": "FieldHideFormula",
            "type": "string(max)",
            "description": {
              "pt": "Fórmula com as regras de exibição do campo.",
              "en": "Formula with field display rules."
            },
            "required": false
          },
          {
            "name": "FieldDisableFormula",
            "type": "string(max)",
            "description": {
              "pt": "Fórmula com as regras de bloqueio do campo.",
              "en": "Formula with field blocking rules."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaUrl",
            "type": "string(2000)",
            "description": {
              "pt": "Url da fórmula externa (utilizada em fórmula integrada).",
              "en": "External Formula Url (used in request formula)."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaMethod",
            "type": "string(20)",
            "description": {
              "pt": "Método da formulá externa (utilizada em fórmula integrada).",
              "en": "External formula method (used in request formula)."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaHeaders",
            "type": "string(1000)",
            "description": {
              "pt": "Cabeçalho da fórmula externa (utilizada em fórmula integrada).",
              "en": "Header of external formula (used in request formula)."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaRequestBody",
            "type": "string(max)",
            "description": {
              "pt": "Corpo da requisição da fórmula externa (utilizada em fórmula integrada).",
              "en": "External formula request body (used in request formula)."
            },
            "required": false
          },
          {
            "name": "DefaultStringValue",
            "type": "string(100)",
            "description": {
              "pt": "Valor padrão de texto simples.",
              "en": "Default value of plain text."
            },
            "required": false
          },
          {
            "name": "DefaultBigStringValue",
            "type": "string(max)",
            "description": {
              "pt": "Valor padrão de texto multilinha.",
              "en": "Default value of multiline text."
            },
            "required": false
          },
          {
            "name": "DefaultIntegerValue",
            "type": "integer",
            "description": {
              "pt": "Valor padrão de número inteiro.",
              "en": "Default integer value."
            },
            "required": false
          },
          {
            "name": "DefaultDecimalValue",
            "type": "double",
            "description": {
              "pt": "Valor padrão de número com cadas decimais ilimitadas.",
              "en": "Default number value with unlimited decimal places."
            },
            "required": false
          },
          {
            "name": "DefaultDateTimeValue",
            "type": "datetime",
            "description": {
              "pt": "Valor padrão de data.",
              "en": "Default date value."
            },
            "required": false
          },
          {
            "name": "DefaultBoolValue",
            "type": "boolean",
            "description": {
              "pt": "Valor padrão Boleano.",
              "en": "Boolean default value."
            },
            "required": false
          },
          {
            "name": "SendExternalKey",
            "type": "string(200)",
            "description": {
              "pt": "Chave de envio externa. Essa é uma chave utilizada por integrações externas para conseguirem identificar campos semelhantes em diferentes contas.",
              "en": "Send external key. This is a key used by external integrations to be able to identify similar fields across different accounts."
            },
            "required": false
          },
          {
            "name": "ReceiveExternalKey",
            "type": "string(200)",
            "description": {
              "pt": "Chave de recebimento externa. Essa é uma chave utilizada por integrações externas para conseguirem identificar campos semelhantes em diferentes contas.",
              "en": "External Receive Key. This is a key used by external integrations to be able to identify similar fields across different accounts."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Key, EntityId, Name, TypeId, Required, Multiple, Wide",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Entity,SecondaryEntity,Type,OptionsTable",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Key+eq+'contact_280F5581-A4B9-4E4E-984D-A285153A6744'",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Key+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Criar um campo customizado na conta. <br> Todos os campos dinâmicos da conta vem para essa entidade.</div>",
          "en": "<div><br>Create a custom field in the account. <br> All custom fields in the account come to this entity.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do campo, gerado automaticamente pelo banco de dados.",
              "en": "Field id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Key",
            "type": "string(100)",
            "description": {
              "pt": "Chave do campo, gerada automaticamente pelo banco de dados. É a chave que é normalmente utilizada nas relações dos campos com outras entidades, como um identificador do campo.",
              "en": "Field key, automatically generated by the database. It is the key that is usually used in the field relationships with other entities, as a field identifier."
            },
            "required": true
          },
          {
            "name": "Dynamic",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é customizado/dinâmico ou não. Novos campos sempre são dinâmicos/customizados.",
              "en": "Boolean indicating whether the field is custom/dynamic or not. New fields are always dynamic/custom."
            },
            "required": true
          },
          {
            "name": "EntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade do campo. Essa informação está disponível no endpoint de '/Fields@Entities'.",
              "en": "Field's entity id. This information is available on the '/Fields@Entities' endpoint."
            },
            "required": true
          },
          {
            "name": "OptionsTableId",
            "type": "integer",
            "description": {
              "pt": "Id da tabela de opções do campo (Apenas campos do tipo 'Opções pré cadastradas' possuem uma tabela de opções). Essa informação está disponível no endpoint '/Fields@OptionsTable'.",
              "en": "Field options table Id (Only fields of the type 'Pre-registered options' have an options table). This information is available in the '/Fields@OptionsTable' endpoint."
            },
            "required": false
          },
          {
            "name": "SecondaryEntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade secundária do campos (Exemplo: Um campo do tipo usuário tem a entidade secundária de usuários.). Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Id of the secondary entity of the fields (Example: A field of type user has the secondary entity of users.). This information is available in the endpoint '/Fields@Entities'."
            },
            "required": false
          },
          {
            "name": "Name",
            "type": "string(60)",
            "description": {
              "pt": "Nome do campo.",
              "en": "Field name."
            },
            "required": true
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo do campo. Essa informação está disponível no endpoint '/Fields@Types'.",
              "en": "Field type id. This information is available in the '/Fields@Types' endpoint."
            },
            "required": true
          },
          {
            "name": "Required",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é obrigatório. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is mandatory. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Unique",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é único (Campo chave). Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is unique (A Key field). It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Multiple",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é múltiplo. O tipo de campo deve permitir que ele seja múltiplo. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is multiple. The field type must allow it to be multiple. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Disabled",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo está desabilitado. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is disabled. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Wide",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um campo de duas colunas. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if it is a two-column field. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "FormFilterable",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo pode ser filtrado nos formulários. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates whether the field can be filtered in forms. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "InternalFormula",
            "type": "string(max)",
            "description": {
              "pt": "Fórmula interna do campo.",
              "en": "Field's internal formula."
            },
            "required": false
          },
          {
            "name": "FieldHideFormula",
            "type": "string(max)",
            "description": {
              "pt": "Fórmula com as regras de exibição do campo.",
              "en": "Formula with field display rules."
            },
            "required": false
          },
          {
            "name": "FieldDisableFormula",
            "type": "string(max)",
            "description": {
              "pt": "Fórmula com as regras de bloqueio do campo.",
              "en": "Formula with field blocking rules."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaUrl",
            "type": "string(2000)",
            "description": {
              "pt": "Url da fórmula externa (utilizada em fórmula integrada).",
              "en": "External Formula Url (used in request formula)."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaMethod",
            "type": "string(20)",
            "description": {
              "pt": "Método da formulá externa (utilizada em fórmula integrada).",
              "en": "External formula method (used in request formula)."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaHeaders",
            "type": "string(1000)",
            "description": {
              "pt": "Cabeçalho da fórmula externa (utilizada em fórmula integrada).",
              "en": "Header of external formula (used in request formula)."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaRequestBody",
            "type": "string(max)",
            "description": {
              "pt": "Corpo da requisição da fórmula externa (utilizada em fórmula integrada).",
              "en": "External formula request body (used in request formula)."
            },
            "required": false
          },
          {
            "name": "DefaultStringValue",
            "type": "string(100)",
            "description": {
              "pt": "Valor padrão de texto simples.",
              "en": "Default value of plain text."
            },
            "required": false
          },
          {
            "name": "DefaultBigStringValue",
            "type": "string(max)",
            "description": {
              "pt": "Valor padrão de texto multilinha.",
              "en": "Default value of multiline text."
            },
            "required": false
          },
          {
            "name": "DefaultIntegerValue",
            "type": "integer",
            "description": {
              "pt": "Valor padrão de número inteiro.",
              "en": "Default integer value."
            },
            "required": false
          },
          {
            "name": "DefaultDecimalValue",
            "type": "double",
            "description": {
              "pt": "Valor padrão de número com cadas decimais ilimitadas.",
              "en": "Default number value with unlimited decimal places."
            },
            "required": false
          },
          {
            "name": "DefaultDateTimeValue",
            "type": "datetime",
            "description": {
              "pt": "Valor padrão de data.",
              "en": "Default date value."
            },
            "required": false
          },
          {
            "name": "DefaultBoolValue",
            "type": "boolean",
            "description": {
              "pt": "Valor padrão Boleano.",
              "en": "Boolean default value."
            },
            "required": false
          },
          {
            "name": "SendExternalKey",
            "type": "string(200)",
            "description": {
              "pt": "Chave de envio externa. Essa é uma chave utilizada por integrações externas para conseguirem identificar campos semelhantes em diferentes contas.",
              "en": "Send external key. This is a key used by external integrations to be able to identify similar fields across different accounts."
            },
            "required": false
          },
          {
            "name": "ReceiveExternalKey",
            "type": "string(200)",
            "description": {
              "pt": "Chave de recebimento externa. Essa é uma chave utilizada por integrações externas para conseguirem identificar campos semelhantes em diferentes contas.",
              "en": "External Receive Key. This is a key used by external integrations to be able to identify similar fields across different accounts."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Key, EntityId, Name, TypeId, Required, Multiple, Wide",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Entity, SecondaryEntity, Type, OptionsTable",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_16"
              },
              "examples": {
                "0": {
                  "value": "{\n\"Name\": \"Nome da propriedade\",\n    \"EntityId\": 0,\n    \"SecondaryEntityId\": null,\n    \"TypeId\": 0,\n    \"Required\": false\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Fields({Key})": {
      "patch": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Alterar um campo customizado (Somente campos com 'Dynamic' true podem ser alterados).</div>",
          "en": "<div><br>Update a custom field (Only fields with 'Dynamic' true can be changed).</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do campo, gerado automaticamente pelo banco de dados.",
              "en": "Field id, automatically generated by the database."
            },
            "required": true
          },
          {
            "name": "Key",
            "type": "string(100)",
            "description": {
              "pt": "Chave do campo, gerada automaticamente pelo banco de dados. É a chave que é normalmente utilizada nas relações dos campos com outras entidades, como um identificador do campo.",
              "en": "Field key, automatically generated by the database. It is the key that is usually used in the field relationships with other entities, as a field identifier."
            },
            "required": true
          },
          {
            "name": "Dynamic",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é customizado/dinâmico ou não. Novos campos sempre são dinâmicos/customizados.",
              "en": "Boolean indicating whether the field is custom/dynamic or not. New fields are always dynamic/custom."
            },
            "required": true
          },
          {
            "name": "EntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade do campo. Essa informação está disponível no endpoint de '/Fields@Entities'.",
              "en": "Field's entity id. This information is available on the '/Fields@Entities' endpoint."
            },
            "required": true
          },
          {
            "name": "OptionsTableId",
            "type": "integer",
            "description": {
              "pt": "Id da tabela de opções do campo (Apenas campos do tipo 'Opções pré cadastradas' possuem uma tabela de opções). Essa informação está disponível no endpoint '/Fields@OptionsTable'.",
              "en": "Field options table Id (Only fields of the type 'Pre-registered options' have an options table). This information is available in the '/Fields@OptionsTable' endpoint."
            },
            "required": false
          },
          {
            "name": "SecondaryEntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade secundária do campos (Exemplo: Um campo do tipo usuário tem a entidade secundária de usuários.). Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Id of the secondary entity of the fields (Example: A field of type user has the secondary entity of users.). This information is available in the endpoint '/Fields@Entities'."
            },
            "required": false
          },
          {
            "name": "Name",
            "type": "string(60)",
            "description": {
              "pt": "Nome do campo.",
              "en": "Field name."
            },
            "required": true
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo do campo. Essa informação está disponível no endpoint '/Fields@Types'.",
              "en": "Field type id. This information is available in the '/Fields@Types' endpoint."
            },
            "required": true
          },
          {
            "name": "Required",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é obrigatório. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is mandatory. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Unique",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é único (Campo chave). Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is unique (A Key field). It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Multiple",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo é múltiplo. O tipo de campo deve permitir que ele seja múltiplo. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is multiple. The field type must allow it to be multiple. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Disabled",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo está desabilitado. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if the field is disabled. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "Wide",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um campo de duas colunas. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates if it is a two-column field. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "FormFilterable",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o campo pode ser filtrado nos formulários. Assume o valor falso se não for informado.",
              "en": "Boolean that indicates whether the field can be filtered in forms. It assumes the value false if not informed."
            },
            "required": true
          },
          {
            "name": "InternalFormula",
            "type": "string(max)",
            "description": {
              "pt": "Fórmula interna do campo.",
              "en": "Field's internal formula."
            },
            "required": false
          },
          {
            "name": "FieldHideFormula",
            "type": "string(max)",
            "description": {
              "pt": "Fórmula com as regras de exibição do campo.",
              "en": "Formula with field display rules."
            },
            "required": false
          },
          {
            "name": "FieldDisableFormula",
            "type": "string(max)",
            "description": {
              "pt": "Fórmula com as regras de bloqueio do campo.",
              "en": "Formula with field blocking rules."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaUrl",
            "type": "string(2000)",
            "description": {
              "pt": "Url da fórmula externa (utilizada em fórmula integrada).",
              "en": "External Formula Url (used in request formula)."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaMethod",
            "type": "string(20)",
            "description": {
              "pt": "Método da formulá externa (utilizada em fórmula integrada).",
              "en": "External formula method (used in request formula)."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaHeaders",
            "type": "string(1000)",
            "description": {
              "pt": "Cabeçalho da fórmula externa (utilizada em fórmula integrada).",
              "en": "Header of external formula (used in request formula)."
            },
            "required": false
          },
          {
            "name": "ExternalFormulaRequestBody",
            "type": "string(max)",
            "description": {
              "pt": "Corpo da requisição da fórmula externa (utilizada em fórmula integrada).",
              "en": "External formula request body (used in request formula)."
            },
            "required": false
          },
          {
            "name": "DefaultStringValue",
            "type": "string(100)",
            "description": {
              "pt": "Valor padrão de texto simples.",
              "en": "Default value of plain text."
            },
            "required": false
          },
          {
            "name": "DefaultBigStringValue",
            "type": "string(max)",
            "description": {
              "pt": "Valor padrão de texto multilinha.",
              "en": "Default value of multiline text."
            },
            "required": false
          },
          {
            "name": "DefaultIntegerValue",
            "type": "integer",
            "description": {
              "pt": "Valor padrão de número inteiro.",
              "en": "Default integer value."
            },
            "required": false
          },
          {
            "name": "DefaultDecimalValue",
            "type": "double",
            "description": {
              "pt": "Valor padrão de número com cadas decimais ilimitadas.",
              "en": "Default number value with unlimited decimal places."
            },
            "required": false
          },
          {
            "name": "DefaultDateTimeValue",
            "type": "datetime",
            "description": {
              "pt": "Valor padrão de data.",
              "en": "Default date value."
            },
            "required": false
          },
          {
            "name": "DefaultBoolValue",
            "type": "boolean",
            "description": {
              "pt": "Valor padrão Boleano.",
              "en": "Boolean default value."
            },
            "required": false
          },
          {
            "name": "SendExternalKey",
            "type": "string(200)",
            "description": {
              "pt": "Chave de envio externa. Essa é uma chave utilizada por integrações externas para conseguirem identificar campos semelhantes em diferentes contas.",
              "en": "Send external key. This is a key used by external integrations to be able to identify similar fields across different accounts."
            },
            "required": false
          },
          {
            "name": "ReceiveExternalKey",
            "type": "string(200)",
            "description": {
              "pt": "Chave de recebimento externa. Essa é uma chave utilizada por integrações externas para conseguirem identificar campos semelhantes em diferentes contas.",
              "en": "External Receive Key. This is a key used by external integrations to be able to identify similar fields across different accounts."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Key",
            "in": "path",
            "description": "'contact_280F5581-A4B9-4E4E-984D-A285153A6744'",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "string"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Key, EntityId, Name, TypeId, Required, Multiple, Wide",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Entity,SecondaryEntity,Type,OptionsTable",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_16"
              },
              "examples": {
                "0": {
                  "value": "{\n\"Name\": \"Nome da propriedade\",\n    \"EntityId\": 0,\n    \"SecondaryEntityId\": null,\n    \"TypeId\": 0,\n    \"Required\": false\n}"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Deletar um campo customizado.</div>",
          "en": "<div><br>Delete a custom field..</div>"
        },
        "parameters": [
          {
            "name": "Key",
            "in": "path",
            "description": "'contact_280F5581-A4B9-4E4E-984D-A285153A6744'",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Fields@Entities": {
      "get": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Consulta as entidades do sistema.</div>",
          "en": "<div><br>Query system entities.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da entidade.",
              "en": "Entity id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome da entidade.",
              "en": "Entity name."
            },
            "required": true
          },
          {
            "name": "ApiUrl",
            "type": "string(100)",
            "description": {
              "pt": "Url que representa essa entidade na Api.",
              "en": "Url that represents this entity in the Api."
            },
            "required": false
          },
          {
            "name": "SingularUnitName",
            "type": "string(50)",
            "description": {
              "pt": "Nome da entidade no singular.",
              "en": "Entity name in singular."
            },
            "required": false
          },
          {
            "name": "PluralUnitName",
            "type": "string(50)",
            "description": {
              "pt": "Nome da entidade no plural.",
              "en": "Entity name in plural form."
            },
            "required": false
          },
          {
            "name": "GenderId",
            "type": "integer",
            "description": {
              "pt": "Gênero da entidade.",
              "en": "Entity gender."
            },
            "required": false
          }
        ]
      }
    },
    "/Fields@OptionsTables": {
      "get": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Consultar uma tabela de opções (Usadas em campos do tipo 'opções pré cadastradas').</div>",
          "en": "<div><br>Query a table of options (Used in fields like 'pre-registered options').</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da tabela de opções, gerado automaticamente pelo Banco de Dados.",
              "en": "Id of the options table, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(60)",
            "description": {
              "pt": "Nome da tabela de opções.",
              "en": "Option table name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Options",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Criar uma tabela de opções (Usadas em campos do tipo 'opções pré cadastradas').</div>",
          "en": "<div><br>Create a table of options (Used in fields like 'pre-registered options').</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da tabela de opções, gerado automaticamente pelo Banco de Dados.",
              "en": "Id of the options table, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(60)",
            "description": {
              "pt": "Nome da tabela de opções.",
              "en": "Option table name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,ContactName"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Options",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "OtherProperties,Contact"
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_5"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Opções aleatórias\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Fields@OptionsTables@Options": {
      "get": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Consulta as opções da tabela de opção de um campo (Campo de opções pré cadastradas).</div>",
          "en": "<div><br>Query the options of an option table of a field (Field of pre-registered options).</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da opção da tabela de opções, gerada automaticamente pelo Banco de Dados.",
              "en": "Option id from the options table, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "TableId",
            "type": "integer",
            "description": {
              "pt": "Id da tabela de opções.",
              "en": "Option table id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome da opção da tabela de opções.",
              "en": "Option table option name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, TableId, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Table",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Cria uma opção na tabela de opção de um campo (Campo de opções pré cadastradas).</div>",
          "en": "<div><br>Create an option in the option table of a field (Field of pre-registered options).</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da opção da tabela de opções, gerada automaticamente pelo Banco de Dados.",
              "en": "Option id from the options table, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "TableId",
            "type": "integer",
            "description": {
              "pt": "Id da tabela de opções.",
              "en": "Option table id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome da opção da tabela de opções.",
              "en": "Option table option name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, TableId, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Table",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_16"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"TableId\": 28,\r\n  \"Name\": \"Maçã\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Fields@OptionsTables@Options({Id})": {
      "patch": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Atualiza uma opção na tabela de opção de um campo (Campo de opções pré cadastradas).</div>",
          "en": "<div><br>Update an option in the option table of a field (Field of pre-registered options).</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da opção da tabela de opções, gerada automaticamente pelo Banco de Dados.",
              "en": "Option id from the options table, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "TableId",
            "type": "integer",
            "description": {
              "pt": "Id da tabela de opções.",
              "en": "Option table id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome da opção da tabela de opções.",
              "en": "Option table option name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, TableId, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Table",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_16"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"TableId\": 28,\r\n  \"Name\": \"Maçã\"\r\n}"
                }
              }
            }
          }
        }
      },
      "delete": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Apaga uma opção na tabela de opção de um campo (Campo de opções pré cadastradas).</div>",
          "en": "<div><br>Delete an option in the option table of a field (Field of pre-registered options).</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Fields@Types": {
      "get": {
        "tags": [
          "Fields"
        ],
        "description": {
          "pt": "<div><br>Consulta os tipos de campos.</div>",
          "en": "<div><br>Query the field types.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do tipo de campo.",
              "en": "Field type id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do tipo de campo.",
              "en": "Field type name."
            },
            "required": true
          },
          {
            "name": "Icon",
            "type": "string(100)",
            "description": {
              "pt": "Ícone do tipo de campo.",
              "en": "Field type icon."
            },
            "required": false
          },
          {
            "name": "NativeType",
            "type": "string(20)",
            "description": {
              "pt": "Tipo nativo do campo.",
              "en": "Native type."
            },
            "required": false
          },
          {
            "name": "Listable",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se o tipo de campo é listável.",
              "en": "Boolean indicating whether the field type is listable."
            },
            "required": true
          },
          {
            "name": "Multipliable",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se esse campo pode ser múltiplo.",
              "en": "Boolean that indicates whether this field can be multiple."
            },
            "required": true
          },
          {
            "name": "StandardFormat",
            "type": "string(30)",
            "description": {
              "pt": "Formato padrão do tipo de campo.",
              "en": "Standard field type format."
            },
            "required": false
          }
        ]
      }
    },
    "/InteractionRecords": {
      "get": {
        "tags": [
          "InteractionRecords"
        ],
        "description": {
          "pt": "<div><br>Consulta os registros de interação da conta.</div>",
          "en": "<div><br>Query account interaction records.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do registro de interação, gerado automaticamente pelo Banco de Dados.",
              "en": "Interaction record Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do registro de interação. Se for informado algum Id de negócio, o Id do cliente passa a ser o mesmo do cliente desse negócio. Caso contrário, o id do cliente deve ser válido para a criação do registro se completar. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Interaction record contact Id. If a deal Id is entered, the contact Id becomes the same as the customer of that business. Otherwise, the contact Id must be valid for the record to be created. This information is available through the '/Contacts' endpoint."
            },
            "required": true
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio do registro de interação. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Interaction record deal id. This information is available through the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "Date",
            "type": "datetime",
            "description": {
              "pt": "Data do registro de interação. Se estiver vazia, recebe a data atual da criação.",
              "en": "Interaction record date. If it is empty, it receives the current creation date."
            },
            "required": true
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo de registro de interação. As opções disponíveis podem ser consultadas no endpoint '/Tasks@Types'. Se estiver vazio, recebe o tipo 1.",
              "en": "Interaction record type Id. The available options can be consulted at the '/Tasks@Types' enpoint. If it is empty, it receives type 1."
            },
            "required": true
          },
          {
            "name": "Title",
            "type": "string(100)",
            "description": {
              "pt": "Título do registro de interação.",
              "en": "Interaction record title."
            },
            "required": false
          },
          {
            "name": "Content",
            "type": "string(max)",
            "description": {
              "pt": "Conteúdo do registro de interação.",
              "en": "Interaction record content."
            },
            "required": true
          },
          {
            "name": "Latitude",
            "type": "decimal",
            "description": {
              "pt": "Latitude do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Latitude of the interaction record (If it fits with his type)."
            },
            "required": false
          },
          {
            "name": "Longitude",
            "type": "decimal",
            "description": {
              "pt": "Longitude do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Longitude of interaction record (If it fits with his type)."
            },
            "required": false
          },
          {
            "name": "EmailRecipients",
            "type": "string(2000)",
            "description": {
              "pt": "Destinatários do email do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Email recipients of the interaction record (If it fits with his type)."
            },
            "required": false
          },
          {
            "name": "EmailSubject",
            "type": "string(500)",
            "description": {
              "pt": "Assunto do email do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Subject of the interaction record email (If it fits with his type)."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, ContactId, DealId, Date, TypeId, Content, Title",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Deal, Tags, Comments, NotifiedUsers, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "InteractionRecords"
        ],
        "description": {
          "pt": "<div><br>Cria um novo registro de interação na conta.</div>",
          "en": "<div><br>Create a new interaction record on the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do registro de interação, gerado automaticamente pelo Banco de Dados.",
              "en": "Interaction record Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do registro de interação. Se for informado algum Id de negócio, o Id do cliente passa a ser o mesmo do cliente desse negócio. Caso contrário, o id do cliente deve ser válido para a criação do registro se completar. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Interaction record contact Id. If a deal Id is entered, the contact Id becomes the same as the customer of that business. Otherwise, the contact Id must be valid for the record to be created. This information is available through the '/Contacts' endpoint."
            },
            "required": true
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio do registro de interação. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Interaction record deal id. This information is available through the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "Date",
            "type": "datetime",
            "description": {
              "pt": "Data do registro de interação. Se estiver vazia, recebe a data atual da criação.",
              "en": "Interaction record date. If it is empty, it receives the current creation date."
            },
            "required": true
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo de registro de interação. As opções disponíveis podem ser consultadas no endpoint '/Tasks@Types'. Se estiver vazio, recebe o tipo 1.",
              "en": "Interaction record type Id. The available options can be consulted at the '/Tasks@Types' enpoint. If it is empty, it receives type 1."
            },
            "required": true
          },
          {
            "name": "Title",
            "type": "string(100)",
            "description": {
              "pt": "Título do registro de interação.",
              "en": "Interaction record title."
            },
            "required": false
          },
          {
            "name": "Content",
            "type": "string(max)",
            "description": {
              "pt": "Conteúdo do registro de interação.",
              "en": "Interaction record content."
            },
            "required": true
          },
          {
            "name": "Latitude",
            "type": "decimal",
            "description": {
              "pt": "Latitude do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Latitude of the interaction record (If it fits with his type)."
            },
            "required": false
          },
          {
            "name": "Longitude",
            "type": "decimal",
            "description": {
              "pt": "Longitude do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Longitude of interaction record (If it fits with his type)."
            },
            "required": false
          },
          {
            "name": "EmailRecipients",
            "type": "string(2000)",
            "description": {
              "pt": "Destinatários do email do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Email recipients of the interaction record (If it fits with his type)."
            },
            "required": false
          },
          {
            "name": "EmailSubject",
            "type": "string(500)",
            "description": {
              "pt": "Assunto do email do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Subject of the interaction record email (If it fits with his type)."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, ContactId, DealId, Date, TypeId, Content, Title",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,ContactName"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Deal, Tags, Comments, NotifiedUsers, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "OtherProperties,Contact"
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_5"
              },
              "examples": {
                "0": {
                  "value": "{\r\n    \"ContactId\": 23,\r\n    \"DealId\": null,\r\n    \"Date\": \"2023-01-17T21:31:28.69-03:00\",\r\n    \"Content\": \"Comentário aleatório\",\r\n    \"TypeId\": 1,\r\n    \"OtherProperties\": [\r\n        {\r\n            \"FieldKey\": \"interaction_record_250E00F0-0DF7-4026-96F8-9029A7D76D8F\",\r\n            \"IntegerValue\": 13\r\n        }\r\n    ]\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/InteractionRecords({Id})": {
      "delete": {
        "tags": [
          "InteractionRecords"
        ],
        "description": {
          "pt": "<div><br>Apaga um novo registro de interação na conta.</div>",
          "en": "<div><br>Delete an interaction record on the account.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "description": "The User Key of User",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "InteractionRecords"
        ],
        "description": {
          "pt": "<div><br>Atualiza um novo registro de interação na conta.</div>",
          "en": "<div><br>Update an interaction record on the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do registro de interação, gerado automaticamente pelo Banco de Dados.",
              "en": "Interaction record Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente do registro de interação. Se for informado algum Id de negócio, o Id do cliente passa a ser o mesmo do cliente desse negócio. Caso contrário, o id do cliente deve ser válido para a criação do registro se completar. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Interaction record contact Id. If a deal Id is entered, the contact Id becomes the same as the customer of that business. Otherwise, the contact Id must be valid for the record to be created. This information is available through the '/Contacts' endpoint."
            },
            "required": true
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio do registro de interação. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Interaction record deal id. This information is available through the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "Date",
            "type": "datetime",
            "description": {
              "pt": "Data do registro de interação. Se estiver vazia, recebe a data atual da criação.",
              "en": "Interaction record date. If it is empty, it receives the current creation date."
            },
            "required": true
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo de registro de interação. As opções disponíveis podem ser consultadas no endpoint '/Tasks@Types'. Se estiver vazio, recebe o tipo 1.",
              "en": "Interaction record type Id. The available options can be consulted at the '/Tasks@Types' enpoint. If it is empty, it receives type 1."
            },
            "required": true
          },
          {
            "name": "Title",
            "type": "string(100)",
            "description": {
              "pt": "Título do registro de interação.",
              "en": "Interaction record title."
            },
            "required": false
          },
          {
            "name": "Content",
            "type": "string(max)",
            "description": {
              "pt": "Conteúdo do registro de interação.",
              "en": "Interaction record content."
            },
            "required": true
          },
          {
            "name": "Latitude",
            "type": "decimal",
            "description": {
              "pt": "Latitude do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Latitude of the interaction record (If it fits with his type)."
            },
            "required": false
          },
          {
            "name": "Longitude",
            "type": "decimal",
            "description": {
              "pt": "Longitude do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Longitude of interaction record (If it fits with his type)."
            },
            "required": false
          },
          {
            "name": "EmailRecipients",
            "type": "string(2000)",
            "description": {
              "pt": "Destinatários do email do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Email recipients of the interaction record (If it fits with his type)."
            },
            "required": false
          },
          {
            "name": "EmailSubject",
            "type": "string(500)",
            "description": {
              "pt": "Assunto do email do registro de interação (Se fizer sentido para o tipo dele).",
              "en": "Subject of the interaction record email (If it fits with his type)."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, ContactId, DealId, Date, TypeId, Content, Title",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Deal, Tags, Comments, NotifiedUsers, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_3"
              },
              "examples": {
                "0": {
                  "value": "{\r\n    \"ContactId\": 23,\r\n    \"DealId\": null,\r\n    \"Date\": \"2023-01-17T21:31:28.69-03:00\",\r\n    \"Content\": \"Comentário aleatório\",\r\n    \"TypeId\": 1,\r\n    \"OtherProperties\": [\r\n        {\r\n            \"FieldKey\": \"interaction_record_250E00F0-0DF7-4026-96F8-9029A7D76D8F\",\r\n            \"IntegerValue\": 13\r\n        }\r\n    ]\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Operations": {
      "get": {
        "tags": [
          "Operations"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de operações.</div>",
          "en": "<div><br>Query the base of operations.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da operação.",
              "en": "Operation id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome da operação.",
              "en": "Operation name."
            },
            "required": true
          },
          {
            "name": "Identifier",
            "type": "string(5)",
            "description": {
              "pt": "Identificador da operação (Utilizado nas consultas oData).",
              "en": "Operation identifier (Used in oData queries)."
            },
            "required": true
          }
        ]
      }
    },
    "/Orders": {
      "get": {
        "tags": [
          "Orders"
        ],
        "description": {
          "pt": "<div><br>Consultar as vendas da conta.</div>",
          "en": "<div><br>Query account orders.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da venda, gerado automaticamente pelo Bando de Dados.",
              "en": "Order Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "OrderNumber",
            "type": "integer",
            "description": {
              "pt": "Número da venda.",
              "en": "Order number."
            },
            "required": false
          },
          {
            "name": "Date",
            "type": "datetime",
            "description": {
              "pt": "Data da venda, prenchida automaticamente com a data atual se nenhum valor for infomado.",
              "en": "Order date, automatically filled in with the current date if no value is entered."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente da venda. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Order customer id. This information is available through the '/Contacts' endpoint."
            },
            "required": true
          },
          {
            "name": "PersonId",
            "type": "integer",
            "description": {
              "pt": "Id da pessoa da venda. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Order person id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "StageId",
            "type": "integer",
            "description": {
              "pt": "Id do estágio da venda. Assume um valor de um estágio padrão se não for informado. Essa informação está disponível no endpoint '/Order@Stages'.",
              "en": "Order stage Id. It assumes a value of a standard stage if not informed. This information is available in the endpoint '/Order@Stages'."
            },
            "required": true
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio da venda. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Order deal Id. This information is available in the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do responsável da venda. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Order owner Id. This information is available through the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda da venda. Assume o valor da moeda do cliente ou da conta se não for informado. Essa informação está disponível no endpoint de '/Currencies'.",
              "en": "Order currency Id. Assumes the value of the customer's or account's currency if not informed. This information is available in the '/Currencies' endpoint."
            },
            "required": true
          },
          {
            "name": "Amount",
            "type": "decimal",
            "description": {
              "pt": "Valor da venda.",
              "en": "Order Amount."
            },
            "required": true
          },
          {
            "name": "Discount",
            "type": "double",
            "description": {
              "pt": "Disconto da venda.",
              "en": "Order dicount."
            },
            "required": false
          },
          {
            "name": "InternalComments",
            "type": "string(max)",
            "description": {
              "pt": "Comentários internos da venda.",
              "en": "Order internal comments."
            },
            "required": false
          },
          {
            "name": "Description",
            "type": "string(max)",
            "description": {
              "pt": "Descrição da venda.",
              "en": "Order description."
            },
            "required": false
          },
          {
            "name": "Key",
            "type": "string(22)",
            "description": {
              "pt": "Chave da venda.",
              "en": "Order Key."
            },
            "required": false
          },
          {
            "name": "AgentId",
            "type": "integer",
            "description": {
              "pt": "Id do comissionado da venda.",
              "en": "Order agent Id."
            },
            "required": false
          },
          {
            "name": "Commission",
            "type": "double",
            "description": {
              "pt": "Comissão da venda.",
              "en": "Order commission."
            },
            "required": false
          },
          {
            "name": "TemplateId",
            "type": "integer",
            "description": {
              "pt": "Id do modelo da venda. Essa informação pode ser consultada no endpoint '/DocumentTemplates'. Assume o valor do primeiro modelo dessa entidade se nenhum valor for informado.",
              "en": "Order template Id. This information can be consulted in the '/DocumentTemplates' endpoint. It assumes the value of the first template of this entity if no value is informed."
            },
            "required": true
          },
          {
            "name": "Shared",
            "type": "boolean",
            "description": {
              "pt": "Indica se a venda foi compartilhada.",
              "en": "Indicates whether the sale was shared."
            },
            "required": false
          },
          {
            "name": "ExternallyAccepted",
            "type": "boolean",
            "description": {
              "pt": "Indica se a venda foi aceita externamente.",
              "en": "Indicates whether the sale was accepted externally."
            },
            "required": false
          },
          {
            "name": "ExternalNotifications",
            "type": "boolean",
            "description": {
              "pt": "Indica o recebimento de notificações externas.",
              "en": "Indicates receipt of external notifications."
            },
            "required": false
          },
          {
            "name": "ExternalSharingDate",
            "type": "datetime",
            "description": {
              "pt": "Data de compartilhamento da venda.",
              "en": "Order share date."
            },
            "required": false
          },
          {
            "name": "DocumentUrl",
            "type": "string(500)",
            "description": {
              "pt": "URL da venda (Quando compartilhada externamente).",
              "en": "Order URL (When shared externally)."
            },
            "required": false
          },
          {
            "name": "ApprovalStatusId",
            "type": "integer",
            "description": {
              "pt": "Indica o status da aprovação da venda.",
              "en": "Indicates the approval status of the order."
            },
            "required": false
          },
          {
            "name": "ApprovalLevelId",
            "type": "integer",
            "description": {
              "pt": "Indica o nível de aprovação da venda.",
              "en": "Indicates the approval level of the sale."
            },
            "required": false
          },
          {
            "name": "OriginQuoteId",
            "type": "integer",
            "description": {
              "pt": "Id da proposta origem da venda.",
              "en": "Order origin quote Id."
            },
            "required": false
          },
          {
            "name": "FileName",
            "type": "string(200)",
            "description": {
              "pt": "Nome do arquivo da venda.",
              "en": "Order file name."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, OrderNumber, Date, ContactId, StageId, Amount",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Person, Deal, Template, Pages, Products, Sections, Attachments, OtherProperties, Comments",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Orders"
        ],
        "description": {
          "pt": "<div><br>Criar uma venda.</div>",
          "en": "<div><br>Create an order.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da venda, gerado automaticamente pelo Bando de Dados.",
              "en": "Order Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "OrderNumber",
            "type": "integer",
            "description": {
              "pt": "Número da venda.",
              "en": "Order number."
            },
            "required": false
          },
          {
            "name": "Date",
            "type": "datetime",
            "description": {
              "pt": "Data da venda, prenchida automaticamente com a data atual se nenhum valor for infomado.",
              "en": "Order date, automatically filled in with the current date if no value is entered."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente da venda. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Order customer id. This information is available through the '/Contacts' endpoint."
            },
            "required": true
          },
          {
            "name": "PersonId",
            "type": "integer",
            "description": {
              "pt": "Id da pessoa da venda. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Order person id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "StageId",
            "type": "integer",
            "description": {
              "pt": "Id do estágio da venda. Assume um valor de um estágio padrão se não for informado. Essa informação está disponível no endpoint '/Order@Stages'.",
              "en": "Order stage Id. It assumes a value of a standard stage if not informed. This information is available in the endpoint '/Order@Stages'."
            },
            "required": true
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio da venda. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Order deal Id. This information is available in the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do responsável da venda. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Order owner Id. This information is available through the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda da venda. Assume o valor da moeda do cliente ou da conta se não for informado. Essa informação está disponível no endpoint de '/Currencies'.",
              "en": "Order currency Id. Assumes the value of the customer's or account's currency if not informed. This information is available in the '/Currencies' endpoint."
            },
            "required": true
          },
          {
            "name": "Amount",
            "type": "decimal",
            "description": {
              "pt": "Valor da venda.",
              "en": "Order Amount."
            },
            "required": true
          },
          {
            "name": "Discount",
            "type": "double",
            "description": {
              "pt": "Disconto da venda.",
              "en": "Order dicount."
            },
            "required": false
          },
          {
            "name": "InternalComments",
            "type": "string(max)",
            "description": {
              "pt": "Comentários internos da venda.",
              "en": "Order internal comments."
            },
            "required": false
          },
          {
            "name": "Description",
            "type": "string(max)",
            "description": {
              "pt": "Descrição da venda.",
              "en": "Order description."
            },
            "required": false
          },
          {
            "name": "Key",
            "type": "string(22)",
            "description": {
              "pt": "Chave da venda.",
              "en": "Order Key."
            },
            "required": false
          },
          {
            "name": "AgentId",
            "type": "integer",
            "description": {
              "pt": "Id do comissionado da venda.",
              "en": "Order agent Id."
            },
            "required": false
          },
          {
            "name": "Commission",
            "type": "double",
            "description": {
              "pt": "Comissão da venda.",
              "en": "Order commission."
            },
            "required": false
          },
          {
            "name": "TemplateId",
            "type": "integer",
            "description": {
              "pt": "Id do modelo da venda. Essa informação pode ser consultada no endpoint '/DocumentTemplates'. Assume o valor do primeiro modelo dessa entidade se nenhum valor for informado.",
              "en": "Order template Id. This information can be consulted in the '/DocumentTemplates' endpoint. It assumes the value of the first template of this entity if no value is informed."
            },
            "required": true
          },
          {
            "name": "Shared",
            "type": "boolean",
            "description": {
              "pt": "Indica se a venda foi compartilhada.",
              "en": "Indicates whether the sale was shared."
            },
            "required": false
          },
          {
            "name": "ExternallyAccepted",
            "type": "boolean",
            "description": {
              "pt": "Indica se a venda foi aceita externamente.",
              "en": "Indicates whether the sale was accepted externally."
            },
            "required": false
          },
          {
            "name": "ExternalNotifications",
            "type": "boolean",
            "description": {
              "pt": "Indica o recebimento de notificações externas.",
              "en": "Indicates receipt of external notifications."
            },
            "required": false
          },
          {
            "name": "ExternalSharingDate",
            "type": "datetime",
            "description": {
              "pt": "Data de compartilhamento da venda.",
              "en": "Order share date."
            },
            "required": false
          },
          {
            "name": "DocumentUrl",
            "type": "string(500)",
            "description": {
              "pt": "URL da venda (Quando compartilhada externamente).",
              "en": "Order URL (When shared externally)."
            },
            "required": false
          },
          {
            "name": "ApprovalStatusId",
            "type": "integer",
            "description": {
              "pt": "Indica o status da aprovação da venda.",
              "en": "Indicates the approval status of the order."
            },
            "required": false
          },
          {
            "name": "ApprovalLevelId",
            "type": "integer",
            "description": {
              "pt": "Indica o nível de aprovação da venda.",
              "en": "Indicates the approval level of the sale."
            },
            "required": false
          },
          {
            "name": "OriginQuoteId",
            "type": "integer",
            "description": {
              "pt": "Id da proposta origem da venda.",
              "en": "Order origin quote Id."
            },
            "required": false
          },
          {
            "name": "FileName",
            "type": "string(200)",
            "description": {
              "pt": "Nome do arquivo da venda.",
              "en": "Order file name."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, OrderNumber, Date, ContactId, StageId, Amount",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,ContactName"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Person, Deal, Template, Pages, Products, Sections, Attachments, OtherProperties, Comments",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "OtherProperties,Contact"
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_5"
              },
              "examples": {
                "0": {
                  "value": "{\"ContactId\":0,\"Products\":[{\"ProductId\":0,\"CurrencyId\":1,\"Quantity\":10,\"UnitPrice\":90.5,\"Total\":905}],\"CurrencyId\":1,\"Amount\":905,\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Orders({Id})": {
      "delete": {
        "tags": [
          "Orders"
        ],
        "description": {
          "pt": "<div><br>Deletar uma venda.</div>",
          "en": "<div><br>Delete an order.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "description": "The User Key of User",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Orders"
        ],
        "description": {
          "pt": "<div><br>Atualizar uma venda.</div>",
          "en": "<div><br>Update an order.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da venda, gerado automaticamente pelo Bando de Dados.",
              "en": "Order Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "OrderNumber",
            "type": "integer",
            "description": {
              "pt": "Número da venda.",
              "en": "Order number."
            },
            "required": false
          },
          {
            "name": "Date",
            "type": "datetime",
            "description": {
              "pt": "Data da venda, prenchida automaticamente com a data atual se nenhum valor for infomado.",
              "en": "Order date, automatically filled in with the current date if no value is entered."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do cliente da venda. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Order customer id. This information is available through the '/Contacts' endpoint."
            },
            "required": true
          },
          {
            "name": "PersonId",
            "type": "integer",
            "description": {
              "pt": "Id da pessoa da venda. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Order person id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "StageId",
            "type": "integer",
            "description": {
              "pt": "Id do estágio da venda. Assume um valor de um estágio padrão se não for informado. Essa informação está disponível no endpoint '/Order@Stages'.",
              "en": "Order stage Id. It assumes a value of a standard stage if not informed. This information is available in the endpoint '/Order@Stages'."
            },
            "required": true
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio da venda. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Order deal Id. This information is available in the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "OwnerId",
            "type": "integer",
            "description": {
              "pt": "Id do responsável da venda. Essa informação está disponível pelo endpoint '/Users'.",
              "en": "Order owner Id. This information is available through the '/Users' endpoint."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda da venda. Assume o valor da moeda do cliente ou da conta se não for informado. Essa informação está disponível no endpoint de '/Currencies'.",
              "en": "Order currency Id. Assumes the value of the customer's or account's currency if not informed. This information is available in the '/Currencies' endpoint."
            },
            "required": true
          },
          {
            "name": "Amount",
            "type": "decimal",
            "description": {
              "pt": "Valor da venda.",
              "en": "Order Amount."
            },
            "required": true
          },
          {
            "name": "Discount",
            "type": "double",
            "description": {
              "pt": "Disconto da venda.",
              "en": "Order dicount."
            },
            "required": false
          },
          {
            "name": "InternalComments",
            "type": "string(max)",
            "description": {
              "pt": "Comentários internos da venda.",
              "en": "Order internal comments."
            },
            "required": false
          },
          {
            "name": "Description",
            "type": "string(max)",
            "description": {
              "pt": "Descrição da venda.",
              "en": "Order description."
            },
            "required": false
          },
          {
            "name": "Key",
            "type": "string(22)",
            "description": {
              "pt": "Chave da venda.",
              "en": "Order Key."
            },
            "required": false
          },
          {
            "name": "AgentId",
            "type": "integer",
            "description": {
              "pt": "Id do comissionado da venda.",
              "en": "Order agent Id."
            },
            "required": false
          },
          {
            "name": "Commission",
            "type": "double",
            "description": {
              "pt": "Comissão da venda.",
              "en": "Order commission."
            },
            "required": false
          },
          {
            "name": "TemplateId",
            "type": "integer",
            "description": {
              "pt": "Id do modelo da venda. Essa informação pode ser consultada no endpoint '/DocumentTemplates'. Assume o valor do primeiro modelo dessa entidade se nenhum valor for informado.",
              "en": "Order template Id. This information can be consulted in the '/DocumentTemplates' endpoint. It assumes the value of the first template of this entity if no value is informed."
            },
            "required": true
          },
          {
            "name": "Shared",
            "type": "boolean",
            "description": {
              "pt": "Indica se a venda foi compartilhada.",
              "en": "Indicates whether the sale was shared."
            },
            "required": false
          },
          {
            "name": "ExternallyAccepted",
            "type": "boolean",
            "description": {
              "pt": "Indica se a venda foi aceita externamente.",
              "en": "Indicates whether the sale was accepted externally."
            },
            "required": false
          },
          {
            "name": "ExternalNotifications",
            "type": "boolean",
            "description": {
              "pt": "Indica o recebimento de notificações externas.",
              "en": "Indicates receipt of external notifications."
            },
            "required": false
          },
          {
            "name": "ExternalSharingDate",
            "type": "datetime",
            "description": {
              "pt": "Data de compartilhamento da venda.",
              "en": "Order share date."
            },
            "required": false
          },
          {
            "name": "DocumentUrl",
            "type": "string(500)",
            "description": {
              "pt": "URL da venda (Quando compartilhada externamente).",
              "en": "Order URL (When shared externally)."
            },
            "required": false
          },
          {
            "name": "ApprovalStatusId",
            "type": "integer",
            "description": {
              "pt": "Indica o status da aprovação da venda.",
              "en": "Indicates the approval status of the order."
            },
            "required": false
          },
          {
            "name": "ApprovalLevelId",
            "type": "integer",
            "description": {
              "pt": "Indica o nível de aprovação da venda.",
              "en": "Indicates the approval level of the sale."
            },
            "required": false
          },
          {
            "name": "OriginQuoteId",
            "type": "integer",
            "description": {
              "pt": "Id da proposta origem da venda.",
              "en": "Order origin quote Id."
            },
            "required": false
          },
          {
            "name": "FileName",
            "type": "string(200)",
            "description": {
              "pt": "Nome do arquivo da venda.",
              "en": "Order file name."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, OrderNumber, Date, ContactId, StageId, Amount",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Contact, Person, Deal, Template, Pages, Products, Sections, Attachments, OtherProperties, Comments",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_3"
              },
              "examples": {
                "0": {
                  "value": "{\"ContactId\":0,\"Products\":[{\"ProductId\":0,\"CurrencyId\":1,\"Quantity\":10,\"UnitPrice\":90.5,\"Total\":905}],\"CurrencyId\":1,\"Amount\":905,\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Orders@Stages": {
      "get": {
        "tags": [
          "Orders"
        ],
        "description": {
          "pt": "<div><br>Consulta os estágios das vendas <br> Os estágios das vendas estão disponíveis na aba de configuração das vendas pela Web.</div>",
          "en": "<div><br>Query the order stages <br> The orders stages are available in the web order configuration tab.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do estágio da venda, gerado automaticamente pelo Banco de Dados.",
              "en": "Id of the order stage, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do estágio da venda.",
              "en": "Order stage name."
            },
            "required": true
          },
          {
            "name": "Icon",
            "type": "string(50)",
            "description": {
              "pt": "Ícone do estágio da venda.",
              "en": "Order stage icon."
            },
            "required": false
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação do estágio da venda. Esse é o número que define a ordem entre os estágios dentro de um funil, indo do menor para o maior.",
              "en": "Orders stage ordination. This is the number that defines the order between stages within a funnel, going from lowest to highest."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Orders"
        ],
        "description": {
          "pt": "<div><br>Cria um estágio das vendas <br> Os estágios das vendas estão disponíveis na aba de configuração das vendas pela Web.</div>",
          "en": "<div><br>Create a orders stage <br> Orders stages are available in the web order configuration tab.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do estágio da venda, gerado automaticamente pelo Banco de Dados.",
              "en": "Id of the order stage, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do estágio da venda.",
              "en": "Order stage name."
            },
            "required": true
          },
          {
            "name": "Icon",
            "type": "string(50)",
            "description": {
              "pt": "Ícone do estágio da venda.",
              "en": "Order stage icon."
            },
            "required": false
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação do estágio da venda. Esse é o número que define a ordem entre os estágios dentro de um funil, indo do menor para o maior.",
              "en": "Orders stage ordination. This is the number that defines the order between stages within a funnel, going from lowest to highest."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,ContactName"
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_5"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"Name\": \"Entrega\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Orders@Stages({Id})": {
      "delete": {
        "tags": [
          "Orders"
        ],
        "description": {
          "pt": "<div><br>Apaga um estágio das vendas <br> Os estágios das vendas estão disponíveis na aba de configuração das vendas pela Web.</div>",
          "en": "<div><br>Delete a orders stage <br> Orders stages are available in the web orders configuration tab.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "description": "The User Key of User",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Orders"
        ],
        "description": {
          "pt": "<div><br>Atualiza um estágio das vendas <br> Os estágios das vendas estão disponíveis na aba de configuração das vendas pela Web.</div>",
          "en": "<div><br>Update a orders stage <br> Orders stages are available in the web orders configuration tab.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do estágio da venda, gerado automaticamente pelo Banco de Dados.",
              "en": "Id of the order stage, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do estágio da venda.",
              "en": "Order stage name."
            },
            "required": true
          },
          {
            "name": "Icon",
            "type": "string(50)",
            "description": {
              "pt": "Ícone do estágio da venda.",
              "en": "Order stage icon."
            },
            "required": false
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação do estágio da venda. Esse é o número que define a ordem entre os estágios dentro de um funil, indo do menor para o maior.",
              "en": "Orders stage ordination. This is the number that defines the order between stages within a funnel, going from lowest to highest."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id,Amount",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_3"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"Ordination\": 10\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/PhoneTypes": {
      "get": {
        "tags": [
          "PhoneTypes"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de tipos de telefone.</div>",
          "en": "<div><br>Query the base of phone types.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do tipo de telefone.",
              "en": "Phone Type Id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do tipo de telefone.",
              "en": "Phone type name."
            },
            "required": true
          }
        ]
      }
    },
    "/Products": {
      "get": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Consulta os produtos da conta.</div>",
          "en": "<div><br>Query the products of the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do produto, gerado automaticamente pelo Banco de Dados.",
              "en": "Product Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "GroupId",
            "type": "integer",
            "description": {
              "pt": "Id do grupo do produto. Esse informação pode ser consultada no endpoint de '/Products@Groups'. Se o grupo não for informado, será criado um novo grupo com o mesmo nome do produto.",
              "en": "Product group id. This information can be consulted in the '/Products@Groups' endpoint. If the group is not informed, a new group will be created with the same name as the product."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do produto.",
              "en": "Product name."
            },
            "required": true
          },
          {
            "name": "Code",
            "type": "string(100)",
            "description": {
              "pt": "Código do produto.",
              "en": "Product code"
            },
            "required": false
          },
          {
            "name": "MeasurementUnit",
            "type": "string(100)",
            "description": {
              "pt": "Unidade de medida do produto.",
              "en": "Product measurement unit"
            },
            "required": false
          },
          {
            "name": "ImageUrl",
            "type": "string(300)",
            "description": {
              "pt": "Imagem do produto.",
              "en": "Product image Url"
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do produto. Essa informação pode ser consultada no endpoint de '/Currencies'.",
              "en": "Product currency id. This information can be queried in the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "UnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Unit value of the product.",
              "en": "Product unit price"
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Code, GroupId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Group, Family, Currency, Parts, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Cria um produto na conta.</div>",
          "en": "<div><br>Create a product in the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do produto, gerado automaticamente pelo Banco de Dados.",
              "en": "Product Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "GroupId",
            "type": "integer",
            "description": {
              "pt": "Id do grupo do produto. Esse informação pode ser consultada no endpoint de '/Products@Groups'. Se o grupo não for informado, será criado um novo grupo com o mesmo nome do produto.",
              "en": "Product group id. This information can be consulted in the '/Products@Groups' endpoint. If the group is not informed, a new group will be created with the same name as the product."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do produto.",
              "en": "Product name."
            },
            "required": true
          },
          {
            "name": "Code",
            "type": "string(100)",
            "description": {
              "pt": "Código do produto.",
              "en": "Product code"
            },
            "required": false
          },
          {
            "name": "MeasurementUnit",
            "type": "string(100)",
            "description": {
              "pt": "Unidade de medida do produto.",
              "en": "Product measurement unit"
            },
            "required": false
          },
          {
            "name": "ImageUrl",
            "type": "string(300)",
            "description": {
              "pt": "Imagem do produto.",
              "en": "Product image Url"
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do produto. Essa informação pode ser consultada no endpoint de '/Currencies'.",
              "en": "Product currency id. This information can be queried in the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "UnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Unit value of the product.",
              "en": "Product unit price"
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Code, GroupId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Group, Family, Currency, Parts, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body"
              },
              "examples": {
                "0": {
                  "value": "{\"Name\": \"Produto exemplo\", \"OtherProperties\": [{\"FieldKey\": \"{fieldKey}\", \"StringValue\": \"texto exemplo\"}, {\"FieldKey\": \"{fieldKey}\", \"IntegerValue\": 2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Products({Id})": {
      "delete": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Apaga um produto na conta.</div>",
          "en": "<div><br>Delete a product in the account.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Atualiza um produto na conta.</div>",
          "en": "<div><br>Update a product in the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do produto, gerado automaticamente pelo Banco de Dados.",
              "en": "Product Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "GroupId",
            "type": "integer",
            "description": {
              "pt": "Id do grupo do produto. Esse informação pode ser consultada no endpoint de '/Products@Groups'. Se o grupo não for informado, será criado um novo grupo com o mesmo nome do produto.",
              "en": "Product group id. This information can be consulted in the '/Products@Groups' endpoint. If the group is not informed, a new group will be created with the same name as the product."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do produto.",
              "en": "Product name."
            },
            "required": true
          },
          {
            "name": "Code",
            "type": "string(100)",
            "description": {
              "pt": "Código do produto.",
              "en": "Product code"
            },
            "required": false
          },
          {
            "name": "MeasurementUnit",
            "type": "string(100)",
            "description": {
              "pt": "Unidade de medida do produto.",
              "en": "Product measurement unit"
            },
            "required": false
          },
          {
            "name": "ImageUrl",
            "type": "string(300)",
            "description": {
              "pt": "Imagem do produto.",
              "en": "Product image Url"
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do produto. Essa informação pode ser consultada no endpoint de '/Currencies'.",
              "en": "Product currency id. This information can be queried in the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "UnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Unit value of the product.",
              "en": "Product unit price"
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Code, GroupId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,Name"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Group, Family, Currency, Parts, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "OtherProperties,Group"
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_6"
              },
              "examples": {
                "0": {
                  "value": "{\"Name\": \"Produto exemplo\", \"OtherProperties\": [{\"FieldKey\": \"{fieldKey}\", \"StringValue\": \"texto exemplo\"}, {\"FieldKey\": \"{fieldKey}\", \"IntegerValue\": 2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Products@Families": {
      "get": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Consulta as famílias de produtos da conta.</div>",
          "en": "<div><br>Query the product families of the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da família de produto, gerado automaticamente pelo Banco de Dados.",
              "en": "Product family id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome da família de produto.",
              "en": "Product family name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Cria uma família de produtos da conta.</div>",
          "en": "<div><br>Create an account product family.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da família de produto, gerado automaticamente pelo Banco de Dados.",
              "en": "Product family id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome da família de produto.",
              "en": "Product family name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"Name\": \"Produtos Industriais\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Products@Families({Id})": {
      "delete": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Apaga uma família de produtos da conta.</div>",
          "en": "<div><br>Delete an account product family.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Atualiza uma família de produtos da conta.</div>",
          "en": "<div><br>Update an account product family.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da família de produto, gerado automaticamente pelo Banco de Dados.",
              "en": "Product family id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome da família de produto.",
              "en": "Product family name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,Name"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "OtherProperties,Group"
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_6"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"Name\": \"Produtos Industriais\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Products@Groups": {
      "get": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Consulta os grupos de produto da conta.</div>",
          "en": "<div><br>Query the account's product groups.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do grupo de produto, gerado automaticamente pelo Banco de Dados.",
              "en": "Product group id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do grupo de produto.",
              "en": "Product group name."
            },
            "required": true
          },
          {
            "name": "FamilyId",
            "type": "integer",
            "description": {
              "pt": "Id da família do grupo de produto. Essa informação está disponível no endpoint de '/Products@Families'.",
              "en": "Product group family id. This information is available from the '/Products@Families' endpoint."
            },
            "required": false
          },
          {
            "name": "FixedPrice",
            "type": "boolean",
            "description": {
              "pt": "Indica se o preço é fixado nesse grupo de produto.",
              "en": "Indicates whether the price is fixed on this product group."
            },
            "required": true
          },
          {
            "name": "Default",
            "type": "boolean",
            "description": {
              "pt": "Indica se esse grupo de produto é padrão.",
              "en": "Indicates whether this product group is default."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, FamilyId, FixedPrice",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Family, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Cria um grupo de produto da conta.</div>",
          "en": "<div><br>Create an account product group.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do grupo de produto, gerado automaticamente pelo Banco de Dados.",
              "en": "Product group id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do grupo de produto.",
              "en": "Product group name."
            },
            "required": true
          },
          {
            "name": "FamilyId",
            "type": "integer",
            "description": {
              "pt": "Id da família do grupo de produto. Essa informação está disponível no endpoint de '/Products@Families'.",
              "en": "Product group family id. This information is available from the '/Products@Families' endpoint."
            },
            "required": false
          },
          {
            "name": "FixedPrice",
            "type": "boolean",
            "description": {
              "pt": "Indica se o preço é fixado nesse grupo de produto.",
              "en": "Indicates whether the price is fixed on this product group."
            },
            "required": true
          },
          {
            "name": "Default",
            "type": "boolean",
            "description": {
              "pt": "Indica se esse grupo de produto é padrão.",
              "en": "Indicates whether this product group is default."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, FamilyId, FixedPrice",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Family, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"Name\": \"Agrupamento\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Products@Groups({Id})": {
      "delete": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Apaga um grupo de produto da conta.</div>",
          "en": "<div><br>Delete an account product group.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Atualiza um grupo de produto da conta.</div>",
          "en": "<div><br>Update an account product group.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do grupo de produto, gerado automaticamente pelo Banco de Dados.",
              "en": "Product group id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do grupo de produto.",
              "en": "Product group name."
            },
            "required": true
          },
          {
            "name": "FamilyId",
            "type": "integer",
            "description": {
              "pt": "Id da família do grupo de produto. Essa informação está disponível no endpoint de '/Products@Families'.",
              "en": "Product group family id. This information is available from the '/Products@Families' endpoint."
            },
            "required": false
          },
          {
            "name": "FixedPrice",
            "type": "boolean",
            "description": {
              "pt": "Indica se o preço é fixado nesse grupo de produto.",
              "en": "Indicates whether the price is fixed on this product group."
            },
            "required": true
          },
          {
            "name": "Default",
            "type": "boolean",
            "description": {
              "pt": "Indica se esse grupo de produto é padrão.",
              "en": "Indicates whether this product group is default."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, FamilyId, FixedPrice",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,Name"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Family, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "OtherProperties,Group"
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_6"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"Name\": \"Agrupamento\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Products@Parts": {
      "get": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Consulta os vínculos(ou partes) da conta.</div>",
          "en": "<div><br>Query the links (or parts) of the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do vínculo, gerado automaticamente pelo Banco de Dados.",
              "en": "Link Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "ProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto do vínculo. Essa informação está disponível no endpoint de '/Products'.",
              "en": "Link product id. This information is available on the '/Products' endpoint."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(300)",
            "description": {
              "pt": "Identificação do vínculo.",
              "en": "Link identification."
            },
            "required": false
          },
          {
            "name": "ProductPartId",
            "type": "integer",
            "description": {
              "pt": "Id do vínculo do produto do vínculo do produto.",
              "en": "Product link id of product link."
            },
            "required": false
          },
          {
            "name": "GroupPartId",
            "type": "integer",
            "description": {
              "pt": "Id do grupo de vínculo do vínculo do produto.",
              "en": "Link group id of Product link."
            },
            "required": false
          },
          {
            "name": "ListPartId",
            "type": "integer",
            "description": {
              "pt": "Id da lista do vínculo.",
              "en": "Link list id."
            },
            "required": false
          },
          {
            "name": "ContactProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto de cliente.",
              "en": "Contact product id."
            },
            "required": false
          },
          {
            "name": "Default",
            "type": "boolean",
            "description": {
              "pt": "Indica se o vínculo é padrão. Assume o valor de falso se não for informado.",
              "en": "Indicates if the link is default. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "MinimumQuantity",
            "type": "double",
            "description": {
              "pt": "Quantidade mínima do vínculo de produto.",
              "en": "Product Link Minimum Quantity."
            },
            "required": false
          },
          {
            "name": "MaximumQuantity",
            "type": "double",
            "description": {
              "pt": "Quantidade máxima do vínculo de produto.",
              "en": "Product Link Maximum Quantity."
            },
            "required": false
          },
          {
            "name": "DefaultQuantity",
            "type": "double",
            "description": {
              "pt": "Quantidade padrão do vínculo de produto.",
              "en": "Product Link Default Quantity."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do vínculo de produto. Essa informação está disponível no endpoint de '/Currencies'.",
              "en": "Product link currency id. This information is available in the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "MinimumUnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Valor unitário mínimo do vínculo de produto.",
              "en": "Product link minimum unit price."
            },
            "required": false
          },
          {
            "name": "MaximumUnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Valor unitário máximo do vínculo de produto.",
              "en": "Product link maximum unit price."
            },
            "required": false
          },
          {
            "name": "DefaultUnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Valor unitário padrão do vínculo de produto.",
              "en": "Product link default unit price."
            },
            "required": false
          },
          {
            "name": "GroupId",
            "type": "integer",
            "description": {
              "pt": "Id do grupo do vínculo de produto.",
              "en": "Product link group id."
            },
            "required": false
          },
          {
            "name": "Required",
            "type": "boolean",
            "description": {
              "pt": "Indica de esse vínculo de produto é obrigatório. Assume o valor de falso se não for informado.",
              "en": "Indicates whether this product link is required. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação do vínculo de produto.",
              "en": "Product link ordination."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, ProductId, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Product, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Cria um vínculo(ou parte) da conta.</div>",
          "en": "<div><br>Creates a link (or part) of the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do vínculo, gerado automaticamente pelo Banco de Dados.",
              "en": "Link Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "ProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto do vínculo. Essa informação está disponível no endpoint de '/Products'.",
              "en": "Link product id. This information is available on the '/Products' endpoint."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(300)",
            "description": {
              "pt": "Identificação do vínculo.",
              "en": "Link identification."
            },
            "required": false
          },
          {
            "name": "ProductPartId",
            "type": "integer",
            "description": {
              "pt": "Id do vínculo do produto do vínculo do produto.",
              "en": "Product link id of product link."
            },
            "required": false
          },
          {
            "name": "GroupPartId",
            "type": "integer",
            "description": {
              "pt": "Id do grupo de vínculo do vínculo do produto.",
              "en": "Link group id of Product link."
            },
            "required": false
          },
          {
            "name": "ListPartId",
            "type": "integer",
            "description": {
              "pt": "Id da lista do vínculo.",
              "en": "Link list id."
            },
            "required": false
          },
          {
            "name": "ContactProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto de cliente.",
              "en": "Contact product id."
            },
            "required": false
          },
          {
            "name": "Default",
            "type": "boolean",
            "description": {
              "pt": "Indica se o vínculo é padrão. Assume o valor de falso se não for informado.",
              "en": "Indicates if the link is default. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "MinimumQuantity",
            "type": "double",
            "description": {
              "pt": "Quantidade mínima do vínculo de produto.",
              "en": "Product Link Minimum Quantity."
            },
            "required": false
          },
          {
            "name": "MaximumQuantity",
            "type": "double",
            "description": {
              "pt": "Quantidade máxima do vínculo de produto.",
              "en": "Product Link Maximum Quantity."
            },
            "required": false
          },
          {
            "name": "DefaultQuantity",
            "type": "double",
            "description": {
              "pt": "Quantidade padrão do vínculo de produto.",
              "en": "Product Link Default Quantity."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do vínculo de produto. Essa informação está disponível no endpoint de '/Currencies'.",
              "en": "Product link currency id. This information is available in the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "MinimumUnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Valor unitário mínimo do vínculo de produto.",
              "en": "Product link minimum unit price."
            },
            "required": false
          },
          {
            "name": "MaximumUnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Valor unitário máximo do vínculo de produto.",
              "en": "Product link maximum unit price."
            },
            "required": false
          },
          {
            "name": "DefaultUnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Valor unitário padrão do vínculo de produto.",
              "en": "Product link default unit price."
            },
            "required": false
          },
          {
            "name": "GroupId",
            "type": "integer",
            "description": {
              "pt": "Id do grupo do vínculo de produto.",
              "en": "Product link group id."
            },
            "required": false
          },
          {
            "name": "Required",
            "type": "boolean",
            "description": {
              "pt": "Indica de esse vínculo de produto é obrigatório. Assume o valor de falso se não for informado.",
              "en": "Indicates whether this product link is required. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação do vínculo de produto.",
              "en": "Product link ordination."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, ProductId, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Product, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"ProductId\": 417,\r\n\t\"ProductPartId\": 416,\r\n    \"MinimumQuantity\": 2,\r\n    \"MaximumQuantity\": 2,\r\n    \"DefaultQuantity\": 2,\r\n    \"CurrencyId\": 1,\r\n    \"MinimumUnitPrice\": 20,\r\n    \"MaximumUnitPrice\": 20,\r\n    \"DefaultUnitPrice\": 20\r\n\t\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Products@Parts({Id})": {
      "delete": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Apaga um vínculo(ou parte) da conta.</div>",
          "en": "<div><br>Delete a link (or part) of the account.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Products"
        ],
        "description": {
          "pt": "<div><br>Atualiza um vínculo(ou parte) da conta.</div>",
          "en": "<div><br>Update a link (or part) of the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do vínculo, gerado automaticamente pelo Banco de Dados.",
              "en": "Link Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "ProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto do vínculo. Essa informação está disponível no endpoint de '/Products'.",
              "en": "Link product id. This information is available on the '/Products' endpoint."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(300)",
            "description": {
              "pt": "Identificação do vínculo.",
              "en": "Link identification."
            },
            "required": false
          },
          {
            "name": "ProductPartId",
            "type": "integer",
            "description": {
              "pt": "Id do vínculo do produto do vínculo do produto.",
              "en": "Product link id of product link."
            },
            "required": false
          },
          {
            "name": "GroupPartId",
            "type": "integer",
            "description": {
              "pt": "Id do grupo de vínculo do vínculo do produto.",
              "en": "Link group id of Product link."
            },
            "required": false
          },
          {
            "name": "ListPartId",
            "type": "integer",
            "description": {
              "pt": "Id da lista do vínculo.",
              "en": "Link list id."
            },
            "required": false
          },
          {
            "name": "ContactProductId",
            "type": "integer",
            "description": {
              "pt": "Id do produto de cliente.",
              "en": "Contact product id."
            },
            "required": false
          },
          {
            "name": "Default",
            "type": "boolean",
            "description": {
              "pt": "Indica se o vínculo é padrão. Assume o valor de falso se não for informado.",
              "en": "Indicates if the link is default. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "MinimumQuantity",
            "type": "double",
            "description": {
              "pt": "Quantidade mínima do vínculo de produto.",
              "en": "Product Link Minimum Quantity."
            },
            "required": false
          },
          {
            "name": "MaximumQuantity",
            "type": "double",
            "description": {
              "pt": "Quantidade máxima do vínculo de produto.",
              "en": "Product Link Maximum Quantity."
            },
            "required": false
          },
          {
            "name": "DefaultQuantity",
            "type": "double",
            "description": {
              "pt": "Quantidade padrão do vínculo de produto.",
              "en": "Product Link Default Quantity."
            },
            "required": false
          },
          {
            "name": "CurrencyId",
            "type": "integer",
            "description": {
              "pt": "Id da moeda do vínculo de produto. Essa informação está disponível no endpoint de '/Currencies'.",
              "en": "Product link currency id. This information is available in the '/Currencies' endpoint."
            },
            "required": false
          },
          {
            "name": "MinimumUnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Valor unitário mínimo do vínculo de produto.",
              "en": "Product link minimum unit price."
            },
            "required": false
          },
          {
            "name": "MaximumUnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Valor unitário máximo do vínculo de produto.",
              "en": "Product link maximum unit price."
            },
            "required": false
          },
          {
            "name": "DefaultUnitPrice",
            "type": "decimal",
            "description": {
              "pt": "Valor unitário padrão do vínculo de produto.",
              "en": "Product link default unit price."
            },
            "required": false
          },
          {
            "name": "GroupId",
            "type": "integer",
            "description": {
              "pt": "Id do grupo do vínculo de produto.",
              "en": "Product link group id."
            },
            "required": false
          },
          {
            "name": "Required",
            "type": "boolean",
            "description": {
              "pt": "Indica de esse vínculo de produto é obrigatório. Assume o valor de falso se não for informado.",
              "en": "Indicates whether this product link is required. It assumes the value of false if not informed."
            },
            "required": true
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação do vínculo de produto.",
              "en": "Product link ordination."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, ProductId, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,Name"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Product, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "OtherProperties,Group"
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_6"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"ProductId\": 417,\r\n\t\"ProductPartId\": 416,\r\n    \"MinimumQuantity\": 2,\r\n    \"MaximumQuantity\": 2,\r\n    \"DefaultQuantity\": 2,\r\n    \"CurrencyId\": 1,\r\n    \"MinimumUnitPrice\": 20,\r\n    \"MaximumUnitPrice\": 20,\r\n    \"DefaultUnitPrice\": 20\r\n\t\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Quotes": {
      "get": {
        "tags": [
          "Quotes"
        ],
        "description": {
          "pt": "<div><br>Consulta as propostas da conta.</div>",
          "en": "<div><br>Query the quotes of the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da proposta, gerado automaticamente pelo Banco de Dados.",
              "en": "Quote Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio da proposta. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Quote deal id. This information is available in the '/Deals' endpoint."
            },
            "required": true
          },
          {
            "name": "TemplateId",
            "type": "integer",
            "description": {
              "pt": "Id do modelo da proposta. Essa informação pode ser consultada no endpoint '/DocumentTemplates'.",
              "en": "Quote template Id. This information can be consulted in the '/DocumentTemplates' endpoint."
            },
            "required": true
          },
          {
            "name": "QuoteNumber",
            "type": "integer",
            "description": {
              "pt": "Número da proposta.",
              "en": "Quote number."
            },
            "required": false
          },
          {
            "name": "Shared",
            "type": "boolean",
            "description": {
              "pt": "Indica se a proposta foi compartilhado.",
              "en": "Indicates whether the quote has been shared."
            },
            "required": false
          },
          {
            "name": "ExternalNotifications",
            "type": "boolean",
            "description": {
              "pt": "Indica o recebimento de notificações externas.",
              "en": "Indicates the receipt of external notifications."
            },
            "required": false
          },
          {
            "name": "ExternalSharingDate",
            "type": "datetime",
            "description": {
              "pt": "Data de compartilhamento da proposta.",
              "en": "Quote share date."
            },
            "required": false
          },
          {
            "name": "LastReviewId",
            "type": "integer",
            "description": {
              "pt": "Id da última revisão.",
              "en": "Last revision id."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, DealId, QuoteNumber",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Template, ApprovalStatus, Approvals, Pages, Comments, ExternalComments, Sections, Products, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Quotes"
        ],
        "description": {
          "pt": "<div><br>Criar uma proposta.</div>",
          "en": "<div><br>Create a quote.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da proposta, gerado automaticamente pelo Banco de Dados.",
              "en": "Quote Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio da proposta. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Quote deal id. This information is available in the '/Deals' endpoint."
            },
            "required": true
          },
          {
            "name": "TemplateId",
            "type": "integer",
            "description": {
              "pt": "Id do modelo da proposta. Essa informação pode ser consultada no endpoint '/DocumentTemplates'.",
              "en": "Quote template Id. This information can be consulted in the '/DocumentTemplates' endpoint."
            },
            "required": true
          },
          {
            "name": "QuoteNumber",
            "type": "integer",
            "description": {
              "pt": "Número da proposta.",
              "en": "Quote number."
            },
            "required": false
          },
          {
            "name": "Shared",
            "type": "boolean",
            "description": {
              "pt": "Indica se a proposta foi compartilhado.",
              "en": "Indicates whether the quote has been shared."
            },
            "required": false
          },
          {
            "name": "ExternalNotifications",
            "type": "boolean",
            "description": {
              "pt": "Indica o recebimento de notificações externas.",
              "en": "Indicates the receipt of external notifications."
            },
            "required": false
          },
          {
            "name": "ExternalSharingDate",
            "type": "datetime",
            "description": {
              "pt": "Data de compartilhamento da proposta.",
              "en": "Quote share date."
            },
            "required": false
          },
          {
            "name": "LastReviewId",
            "type": "integer",
            "description": {
              "pt": "Id da última revisão.",
              "en": "Last revision id."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, DealId, QuoteNumber",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Template, ApprovalStatus, Approvals, Pages, Comments, ExternalComments, Sections, Products, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_14"
              },
              "examples": {
                "0": {
                  "value": "{\"Deal\":{\"Title\":\"Novo Neg\u00f3cio\",\"ContactId\":0},\"TemplateId\":0,\"Sections\":[{\"Products\":[{\"ProductId\":0,\"CurrencyId\":0,\"Total\":10000,\"Parts\":[{\"ProductId\":0,\"CurrencyId\":0,\"Total\":10000}]}],\"Code\":1,\"CurrencyId\":0,\"Total\":1000}],\"CurrencyId\":0,\"Amount\":1000,\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Quotes({Id})": {
      "delete": {
        "tags": [
          "Quotes"
        ],
        "description": {
          "pt": "<div><br>Deleta uma proposta.</div>",
          "en": "<div><br>Delete a quote.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Quotes"
        ],
        "description": {
          "pt": "<div><br>Atualizar uma proposta.</div>",
          "en": "<div><br>Update a quote.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da proposta, gerado automaticamente pelo Banco de Dados.",
              "en": "Quote Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio da proposta. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Quote deal id. This information is available in the '/Deals' endpoint."
            },
            "required": true
          },
          {
            "name": "TemplateId",
            "type": "integer",
            "description": {
              "pt": "Id do modelo da proposta. Essa informação pode ser consultada no endpoint '/DocumentTemplates'.",
              "en": "Quote template Id. This information can be consulted in the '/DocumentTemplates' endpoint."
            },
            "required": true
          },
          {
            "name": "QuoteNumber",
            "type": "integer",
            "description": {
              "pt": "Número da proposta.",
              "en": "Quote number."
            },
            "required": false
          },
          {
            "name": "Shared",
            "type": "boolean",
            "description": {
              "pt": "Indica se a proposta foi compartilhado.",
              "en": "Indicates whether the quote has been shared."
            },
            "required": false
          },
          {
            "name": "ExternalNotifications",
            "type": "boolean",
            "description": {
              "pt": "Indica o recebimento de notificações externas.",
              "en": "Indicates the receipt of external notifications."
            },
            "required": false
          },
          {
            "name": "ExternalSharingDate",
            "type": "datetime",
            "description": {
              "pt": "Data de compartilhamento da proposta.",
              "en": "Quote share date."
            },
            "required": false
          },
          {
            "name": "LastReviewId",
            "type": "integer",
            "description": {
              "pt": "Id da última revisão.",
              "en": "Last revision id."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, DealId, QuoteNumber",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Template, ApprovalStatus, Approvals, Pages, Comments, ExternalComments, Sections, Products, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_12"
              },
              "examples": {
                "0": {
                  "value": "{\"Deal\":{\"Title\":\"Novo Neg\u00f3cio\",\"ContactId\":0},\"TemplateId\":0,\"Sections\":[{\"Products\":[{\"ProductId\":0,\"CurrencyId\":0,\"Total\":10000,\"Parts\":[{\"ProductId\":0,\"CurrencyId\":0,\"Total\":10000}]}],\"Code\":1,\"CurrencyId\":0,\"Total\":1000}],\"CurrencyId\":0,\"Amount\":1000,\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Quotes@ApprovalStatus": {
      "get": {
        "tags": [
          "Quotes"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de status de aprovação da proposta.</div>",
          "en": "<div><br>Query the quote approval status base.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do status de aprovação da proposta.",
              "en": "Quote approval status id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do status de aprovação da proposta.",
              "en": "Proposal Approval Status Name."
            },
            "required": true
          }
        ]
      }
    },
    "/Quotes({Id})/Review": {
      "post": {
        "tags": [
          "Quotes"
        ],
        "description": {
          "pt": "<div><br>Criar uma nova revisão em uma proposta.</div>",
          "en": "<div><br>Create a new review in a quote.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da proposta, gerado automaticamente pelo Banco de Dados.",
              "en": "Quote Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio da proposta. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Quote deal id. This information is available in the '/Deals' endpoint."
            },
            "required": true
          },
          {
            "name": "TemplateId",
            "type": "integer",
            "description": {
              "pt": "Id do modelo da proposta. Essa informação pode ser consultada no endpoint '/DocumentTemplates'.",
              "en": "Quote template Id. This information can be consulted in the '/DocumentTemplates' endpoint."
            },
            "required": true
          },
          {
            "name": "QuoteNumber",
            "type": "integer",
            "description": {
              "pt": "Número da proposta.",
              "en": "Quote number."
            },
            "required": false
          },
          {
            "name": "Shared",
            "type": "boolean",
            "description": {
              "pt": "Indica se a proposta foi compartilhado.",
              "en": "Indicates whether the quote has been shared."
            },
            "required": false
          },
          {
            "name": "ExternalNotifications",
            "type": "boolean",
            "description": {
              "pt": "Indica o recebimento de notificações externas.",
              "en": "Indicates the receipt of external notifications."
            },
            "required": false
          },
          {
            "name": "ExternalSharingDate",
            "type": "datetime",
            "description": {
              "pt": "Data de compartilhamento da proposta.",
              "en": "Quote share date."
            },
            "required": false
          },
          {
            "name": "LastReviewId",
            "type": "integer",
            "description": {
              "pt": "Id da última revisão.",
              "en": "Last revision id."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, DealId, QuoteNumber",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Template, ApprovalStatus, Approvals, Pages, Comments, ExternalComments, Sections, Products, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_1"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Sections\":[\r\n    {\r\n      \"Products\":[\r\n      {  \r\n        \"ProductId\": 414,\r\n        \"CurrencyId\": 1,\r\n        \"Total\": 10000\r\n      }\r\n      ],\r\n      \"Code\": 1,\r\n      \"CurrencyId\": 1,\r\n      \"Total\": 1000\r\n    }\r\n  ],\r\n  \"CurrencyId\": 1,\r\n  \"Amount\": 1000\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/RelativeDates": {
      "get": {
        "tags": [
          "RelativeDates"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de datas relativas.</div>",
          "en": "<div><br>Query the relative dates base.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da data relativa.",
              "en": "Relative date Id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome da data relativa.",
              "en": "Relative date name."
            },
            "required": true
          },
          {
            "name": "Identifier",
            "type": "string(20)",
            "description": {
              "pt": "Identificador da data relativa.",
              "en": "Relative date idnetifier."
            },
            "required": true
          },
          {
            "name": "Countable",
            "type": "boolean",
            "description": {
              "pt": "Indica se a data relativa é contável.",
              "en": "Indicates whether the relative date is countable."
            },
            "required": true
          },
          {
            "name": "Ordination",
            "type": "integer",
            "description": {
              "pt": "Ordenação da data relativa.",
              "en": "Relative date ordering."
            },
            "required": true
          }
        ]
      }
    },
    "/Roles": {
      "get": {
        "tags": [
          "Roles"
        ],
        "description": {
          "pt": "<div><br>Consulta os cargos da conta.</div>",
          "en": "<div><br>Query the roles of the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do cargo.",
              "en": "Role Id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome do cargo.",
              "en": "Role Name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Roles"
        ],
        "description": {
          "pt": "<div><br>Cria um novo cargo na conta.</div>",
          "en": "<div><br>Create a new role in the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do cargo.",
              "en": "Role Id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(150)",
            "description": {
              "pt": "Nome do cargo.",
              "en": "Role Name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_20"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Carregador de papel\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Tags": {
      "get": {
        "tags": [
          "Tags"
        ],
        "description": {
          "pt": "<div><br>Consulta os marcadores da conta.</div>",
          "en": "<div><br>Query account tags.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do marcador, gerado automaticamente pelo Banco de Dados.",
              "en": "Tag Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do marcador.",
              "en": "Tag Name."
            },
            "required": true
          },
          {
            "name": "Color",
            "type": "string(10)",
            "description": {
              "pt": "Cor do marcador.",
              "en": "Tag Color."
            },
            "required": false
          },
          {
            "name": "EntityId",
            "type": "integer",
            "description": {
              "pt": "Id da Entidade do marcador. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Tag Entity ID. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Color, EntityId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Entity",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Tags"
        ],
        "description": {
          "pt": "<div><br>Cria um marcador.</div>",
          "en": "<div><br>Create a tag.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do marcador, gerado automaticamente pelo Banco de Dados.",
              "en": "Tag Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do marcador.",
              "en": "Tag Name."
            },
            "required": true
          },
          {
            "name": "Color",
            "type": "string(10)",
            "description": {
              "pt": "Cor do marcador.",
              "en": "Tag Color."
            },
            "required": false
          },
          {
            "name": "EntityId",
            "type": "integer",
            "description": {
              "pt": "Id da Entidade do marcador. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Tag Entity ID. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Color, EntityId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Entity",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_20"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Marcador teste\",\r\n  \"EntityId\": 2,\r\n  \"Color\": \"#000000\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Tags({Id})": {
      "delete": {
        "tags": [
          "Tags"
        ],
        "description": {
          "pt": "<div><br>Apaga um marcador.</div>",
          "en": "<div><br>Delete a tag.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Tags"
        ],
        "description": {
          "pt": "<div><br>Atualiza um marcador.</div>",
          "en": "<div><br>Update a tag.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do marcador, gerado automaticamente pelo Banco de Dados.",
              "en": "Tag Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do marcador.",
              "en": "Tag Name."
            },
            "required": true
          },
          {
            "name": "Color",
            "type": "string(10)",
            "description": {
              "pt": "Cor do marcador.",
              "en": "Tag Color."
            },
            "required": false
          },
          {
            "name": "EntityId",
            "type": "integer",
            "description": {
              "pt": "Id da Entidade do marcador. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Tag Entity ID. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Color, EntityId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Entity",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_19"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Name\": \"Marcador teste\",\r\n  \"EntityId\": 2,\r\n  \"Color\": \"#000000\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Tasks": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "description": {
          "pt": "<div><br>Consulta as tarefas da conta.</div>",
          "en": "<div><br>Query the account's tasks.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da tarefa, gerada automaticamente pelo Banco de Dados.",
              "en": "Task Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Title",
            "type": "string(100)",
            "description": {
              "pt": "Título da tarefa.",
              "en": "Task title."
            },
            "required": false
          },
          {
            "name": "Description",
            "type": "string(max)",
            "description": {
              "pt": "Descrição da tarefa.",
              "en": "Task description"
            },
            "required": false
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo de tarefa. Essa informação está disponível no endpoint de '/Tasks@Types'. Assume um valor padrão se não for informado.",
              "en": "Task type id. This information is available in the '/Tasks@Types' endpoint. It assumes a default value if not informed."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do contato da tarefa. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Task contact id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio da tarefa. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Task deal Id. This information is available in the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "Lenght",
            "type": "integer",
            "description": {
              "pt": "Duração da tarefa.",
              "en": "Task Lenght."
            },
            "required": false
          },
          {
            "name": "RepeatIntervalLength",
            "type": "integer",
            "description": {
              "pt": "Duração do intervalo de repetição da tarefa.",
              "en": "Task repeat interval lenght."
            },
            "required": false
          },
          {
            "name": "RepeatIntervalUnitId",
            "type": "integer",
            "description": {
              "pt": "Id do intervalo de repetição da Task. Essa informação está disponível no endpoint de '/Tasks@RepeatIntervalUnits'. Assume um valor padrão se não for informado.",
              "en": "Id of the Task's repeat interval unit. This information is available in the '/Tasks@RepeatIntervalUnits' endpoint. It assumes a default value if not informed."
            },
            "required": true
          },
          {
            "name": "EmailReminderId",
            "type": "integer",
            "description": {
              "pt": "Id do lembrete por email. Essa informação está disponível no endpoint de '/Tasks/EmailReminders'.",
              "en": "Email Reminder Id. This information is available on the '/Tasks/EmailReminders' endpoint."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Title, Description, ContactId, DealId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Type,Contact,Users,RepeatIntervalUnit,EmailReminder,Contacts,Tags,Comments,InteractionRecord,InteractionRecords,Creator,NotifiedUsers,OtherProperties,Attachments",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$orderby",
            "in": "query",
            "description": "Id+desc",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Tasks"
        ],
        "description": {
          "pt": "<div><br>Cria uma tarefa.</div>",
          "en": "<div><br>Create a task.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da tarefa, gerada automaticamente pelo Banco de Dados.",
              "en": "Task Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Title",
            "type": "string(100)",
            "description": {
              "pt": "Título da tarefa.",
              "en": "Task title."
            },
            "required": false
          },
          {
            "name": "Description",
            "type": "string(max)",
            "description": {
              "pt": "Descrição da tarefa.",
              "en": "Task description"
            },
            "required": false
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo de tarefa. Essa informação está disponível no endpoint de '/Tasks@Types'. Assume um valor padrão se não for informado.",
              "en": "Task type id. This information is available in the '/Tasks@Types' endpoint. It assumes a default value if not informed."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do contato da tarefa. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Task contact id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio da tarefa. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Task deal Id. This information is available in the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "Lenght",
            "type": "integer",
            "description": {
              "pt": "Duração da tarefa.",
              "en": "Task Lenght."
            },
            "required": false
          },
          {
            "name": "RepeatIntervalLength",
            "type": "integer",
            "description": {
              "pt": "Duração do intervalo de repetição da tarefa.",
              "en": "Task repeat interval lenght."
            },
            "required": false
          },
          {
            "name": "RepeatIntervalUnitId",
            "type": "integer",
            "description": {
              "pt": "Id do intervalo de repetição da Task. Essa informação está disponível no endpoint de '/Tasks@RepeatIntervalUnits'. Assume um valor padrão se não for informado.",
              "en": "Id of the Task's repeat interval unit. This information is available in the '/Tasks@RepeatIntervalUnits' endpoint. It assumes a default value if not informed."
            },
            "required": true
          },
          {
            "name": "EmailReminderId",
            "type": "integer",
            "description": {
              "pt": "Id do lembrete por email. Essa informação está disponível no endpoint de '/Tasks/EmailReminders'.",
              "en": "Email Reminder Id. This information is available on the '/Tasks/EmailReminders' endpoint."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Title, Description, ContactId, DealId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Type,Contact,Users,RepeatIntervalUnit,EmailReminder,Contacts,Tags,Comments,InteractionRecord,InteractionRecords,Creator,NotifiedUsers,OtherProperties,Attachments",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_20"
              },
              "examples": {
                "0": {
                  "value": "{\"Title\":\"T\u00edtulo da tarefa\",\"Description\":\"Descri\u00e7\u00e3o teste\",\"DateTime\":\"2016-11-03T15:00:00\",\"ContactId\":0,\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Tasks({Id})": {
      "delete": {
        "tags": [
          "Tasks"
        ],
        "description": {
          "pt": "<div><br>Apaga uma tarefa.</div>",
          "en": "<div><br>Delete a task.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Tasks"
        ],
        "description": {
          "pt": "<div><br>Atualiza uma tarefa.</div>",
          "en": "<div><br>Update a task.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da tarefa, gerada automaticamente pelo Banco de Dados.",
              "en": "Task Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Title",
            "type": "string(100)",
            "description": {
              "pt": "Título da tarefa.",
              "en": "Task title."
            },
            "required": false
          },
          {
            "name": "Description",
            "type": "string(max)",
            "description": {
              "pt": "Descrição da tarefa.",
              "en": "Task description"
            },
            "required": false
          },
          {
            "name": "TypeId",
            "type": "integer",
            "description": {
              "pt": "Id do tipo de tarefa. Essa informação está disponível no endpoint de '/Tasks@Types'. Assume um valor padrão se não for informado.",
              "en": "Task type id. This information is available in the '/Tasks@Types' endpoint. It assumes a default value if not informed."
            },
            "required": true
          },
          {
            "name": "ContactId",
            "type": "integer",
            "description": {
              "pt": "Id do contato da tarefa. Essa informação está disponível pelo endpoint '/Contacts'.",
              "en": "Task contact id. This information is available through the '/Contacts' endpoint."
            },
            "required": false
          },
          {
            "name": "DealId",
            "type": "integer",
            "description": {
              "pt": "Id do negócio da tarefa. Essa informação está disponível no endpoint '/Deals'.",
              "en": "Task deal Id. This information is available in the '/Deals' endpoint."
            },
            "required": false
          },
          {
            "name": "Lenght",
            "type": "integer",
            "description": {
              "pt": "Duração da tarefa.",
              "en": "Task Lenght."
            },
            "required": false
          },
          {
            "name": "RepeatIntervalLength",
            "type": "integer",
            "description": {
              "pt": "Duração do intervalo de repetição da tarefa.",
              "en": "Task repeat interval lenght."
            },
            "required": false
          },
          {
            "name": "RepeatIntervalUnitId",
            "type": "integer",
            "description": {
              "pt": "Id do intervalo de repetição da Task. Essa informação está disponível no endpoint de '/Tasks@RepeatIntervalUnits'. Assume um valor padrão se não for informado.",
              "en": "Id of the Task's repeat interval unit. This information is available in the '/Tasks@RepeatIntervalUnits' endpoint. It assumes a default value if not informed."
            },
            "required": true
          },
          {
            "name": "EmailReminderId",
            "type": "integer",
            "description": {
              "pt": "Id do lembrete por email. Essa informação está disponível no endpoint de '/Tasks/EmailReminders'.",
              "en": "Email Reminder Id. This information is available on the '/Tasks/EmailReminders' endpoint."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Title, Description, ContactId, DealId",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Type,Contact,Users,RepeatIntervalUnit,EmailReminder,Contacts,Tags,Comments,InteractionRecord,InteractionRecords,Creator,NotifiedUsers,OtherProperties,Attachments",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_19"
              },
              "examples": {
                "0": {
                  "value": "{\"Title\":\"T\u00edtulo da tarefa\",\"Description\":\"Descri\u00e7\u00e3o teste\",\"DateTime\":\"2016-11-03T15:00:00\",\"ContactId\":0,\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Tasks@Types": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de tipos de tarefas.</div>",
          "en": "<div><br>Query the base of task types.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do tipo de tarefa.",
              "en": "Task type Id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do tipo de tarefa.",
              "en": "Task type name."
            },
            "required": true
          },
          {
            "name": "Icon",
            "type": "string(50)",
            "description": {
              "pt": "Ícone do tipo de tarefa.",
              "en": "Task type icon."
            },
            "required": false
          },
          {
            "name": "Color",
            "type": "string(50)",
            "description": {
              "pt": "Cor do tipo de tarefa.",
              "en": "Task Type color."
            },
            "required": true
          }
        ]
      }
    },
    "/Tasks@RepeatIntervalUnits": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "description": {
          "pt": "<div><br>Consulta a base de intervalos de repetição das tarefas.</div>",
          "en": "<div><br>Query the base of task repeat interval units.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do intervalo de repetição.",
              "en": "Repeat Interval Id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do intervalo de repetição.",
              "en": "Repeat Interval Name."
            },
            "required": true
          },
          {
            "name": "Datepart",
            "type": "string(10)",
            "description": {
              "pt": "Parte da data.",
              "en": "Date part."
            },
            "required": true
          },
          {
            "name": "DatepartLength",
            "type": "integer",
            "description": {
              "pt": "Tamanho da parte da data.",
              "en": "Date part length"
            },
            "required": true
          }
        ]
      }
    },
    "/Tasks@EmailReminders": {
      "get": {
        "tags": [
          "Tasks"
        ],
        "description": {
          "pt": "<div><br>Consulta os tipos de lembrete de email das tarefas.</div>",
          "en": "<div><br>Query the email reminder types for tasks.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do lembrete de email.",
              "en": "Email Reminder Id."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do lembrete de email.",
              "en": "Email Reminder Name."
            },
            "required": true
          }
        ]
      }
    },
    "/Tasks({Id})/Finish": {
      "post": {
        "tags": [
          "Tasks"
        ],
        "description": {
          "pt": "<div><br>Finalizar uma tarefa.</div>",
          "en": "<div><br>Finish a task.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_1"
              },
              "examples": {
                "0": {
                  "value": "{\r\n  \"Finished\": true\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Teams": {
      "get": {
        "tags": [
          "Teams"
        ],
        "description": {
          "pt": "<div><br>Consulta as equipes da conta.</div>",
          "en": "<div><br>Query account teams.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da equipe, gerado automaticamente pelo Banco de Dados.",
              "en": "Team Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome da equipe.",
              "en": "Team name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Creator, Updater, Users, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Teams"
        ],
        "description": {
          "pt": "<div><br>Cria uma equipe na conta.</div>",
          "en": "<div><br>Create a team on the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da equipe, gerado automaticamente pelo Banco de Dados.",
              "en": "Team Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome da equipe.",
              "en": "Team name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Creator, Updater, Users, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_11"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"Name\": \"Team Red\",\r\n\t\"Users\":[\r\n\t\t{\r\n\t\t\t\"UserId\": 116\r\n\t\t}\r\n\t]\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Teams({Id})": {
      "delete": {
        "tags": [
          "Teams"
        ],
        "description": {
          "pt": "<div><br>Apaga uma equipe na conta.</div>",
          "en": "<div><br>Delete a team on the account.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Teams"
        ],
        "description": {
          "pt": "<div><br>Atualiza uma equipe na conta.</div>",
          "en": "<div><br>Update a team on the account.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da equipe, gerado automaticamente pelo Banco de Dados.",
              "en": "Team Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome da equipe.",
              "en": "Team name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,Name"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Creator, Updater, Users, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_10"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"Name\": \"Team Red\",\r\n\t\"Users\":[\r\n\t\t{\r\n\t\t\t\"UserId\": 116\r\n\t\t}\r\n\t]\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Users": {
      "get": {
        "tags": [
          "Users"
        ],
        "description": {
          "pt": "<div><br>Consulta os usuários da conta.</div>",
          "en": "<div><br>Query account users.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do usuário, gerado automaticamente pelo Banco de Dados.",
              "en": "User Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do usuário.",
              "en": "Username."
            },
            "required": true
          },
          {
            "name": "Email",
            "type": "string(200)",
            "description": {
              "pt": "Email do usuário.",
              "en": "User email."
            },
            "required": true
          },
          {
            "name": "RoleId",
            "type": "integer",
            "description": {
              "pt": "Id do cargo do usuário. Essa informação está disponível no endpoint '/Roles'.",
              "en": "User's role id. This information is available on the '/Roles' endpoint."
            },
            "required": false
          },
          {
            "name": "ProfileId",
            "type": "integer",
            "description": {
              "pt": "Id do perfil do usuário. Essa informação está disponível no endpont '/Users@Profiles'.",
              "en": "User profile id. This information is available in the '/Users@Profiles' endpoint."
            },
            "required": true
          },
          {
            "name": "AvatarUrl",
            "type": "string(300)",
            "description": {
              "pt": "Url do avatar do usuário (Foto).",
              "en": "Url of user avatar (Photo)."
            },
            "required": false
          },
          {
            "name": "Phone",
            "type": "string(150)",
            "description": {
              "pt": "Telefone do usuário.",
              "en": "User Phone."
            },
            "required": false
          },
          {
            "name": "Language",
            "type": "string(10)",
            "description": {
              "pt": "Língua do usuário.",
              "en": "User language."
            },
            "required": false
          },
          {
            "name": "Facebook",
            "type": "string(500)",
            "description": {
              "pt": "Facebook do usuário.",
              "en": "User's Facebook."
            },
            "required": false
          },
          {
            "name": "LinkedIn",
            "type": "string(500)",
            "description": {
              "pt": "LinkedIn do usuário.",
              "en": "User's LinkedIn."
            },
            "required": false
          },
          {
            "name": "SuspensionReasonId",
            "type": "integer",
            "description": {
              "pt": "Id do mostivo de suspensão do usuário.",
              "en": "Id of the user's suspension reason."
            },
            "required": false
          },
          {
            "name": "SuspensionReasonComments",
            "type": "string(2000)",
            "description": {
              "pt": "Comentário sobre a suspensão do usuário.",
              "en": "User suspension reason comment."
            },
            "required": false
          },
          {
            "name": "Integration",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um usuário de integração (UserKey fixa).",
              "en": "Boolean that indicates if it is an integration user (fixed User Key)."
            },
            "required": true
          },
          {
            "name": "NativeIntegration",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um usuário de integração nativa (Utilizado pelas integrações Plug-In-Play).",
              "en": "Boolean indicating whether it is a native integration user (Used by Plug-In-Play integrations)."
            },
            "required": true
          },
          {
            "name": "Courtesy",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um usuário cortesia (Não conta no pagamento). Usuários que não são de integração terão o valor de falso.",
              "en": "Boolean that indicates if it is a courtesy user (Does not count in the payment). Non-integration users will have a value of false."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Email",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Role, Profile, Teams, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Users"
        ],
        "description": {
          "pt": "<div><br>Cria um usuário.</div>",
          "en": "<div><br>Create an user.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do usuário, gerado automaticamente pelo Banco de Dados.",
              "en": "User Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do usuário.",
              "en": "Username."
            },
            "required": true
          },
          {
            "name": "Email",
            "type": "string(200)",
            "description": {
              "pt": "Email do usuário.",
              "en": "User email."
            },
            "required": true
          },
          {
            "name": "RoleId",
            "type": "integer",
            "description": {
              "pt": "Id do cargo do usuário. Essa informação está disponível no endpoint '/Roles'.",
              "en": "User's role id. This information is available on the '/Roles' endpoint."
            },
            "required": false
          },
          {
            "name": "ProfileId",
            "type": "integer",
            "description": {
              "pt": "Id do perfil do usuário. Essa informação está disponível no endpont '/Users@Profiles'.",
              "en": "User profile id. This information is available in the '/Users@Profiles' endpoint."
            },
            "required": true
          },
          {
            "name": "AvatarUrl",
            "type": "string(300)",
            "description": {
              "pt": "Url do avatar do usuário (Foto).",
              "en": "Url of user avatar (Photo)."
            },
            "required": false
          },
          {
            "name": "Phone",
            "type": "string(150)",
            "description": {
              "pt": "Telefone do usuário.",
              "en": "User Phone."
            },
            "required": false
          },
          {
            "name": "Language",
            "type": "string(10)",
            "description": {
              "pt": "Língua do usuário.",
              "en": "User language."
            },
            "required": false
          },
          {
            "name": "Facebook",
            "type": "string(500)",
            "description": {
              "pt": "Facebook do usuário.",
              "en": "User's Facebook."
            },
            "required": false
          },
          {
            "name": "LinkedIn",
            "type": "string(500)",
            "description": {
              "pt": "LinkedIn do usuário.",
              "en": "User's LinkedIn."
            },
            "required": false
          },
          {
            "name": "SuspensionReasonId",
            "type": "integer",
            "description": {
              "pt": "Id do mostivo de suspensão do usuário.",
              "en": "Id of the user's suspension reason."
            },
            "required": false
          },
          {
            "name": "SuspensionReasonComments",
            "type": "string(2000)",
            "description": {
              "pt": "Comentário sobre a suspensão do usuário.",
              "en": "User suspension reason comment."
            },
            "required": false
          },
          {
            "name": "Integration",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um usuário de integração (UserKey fixa).",
              "en": "Boolean that indicates if it is an integration user (fixed User Key)."
            },
            "required": true
          },
          {
            "name": "NativeIntegration",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um usuário de integração nativa (Utilizado pelas integrações Plug-In-Play).",
              "en": "Boolean indicating whether it is a native integration user (Used by Plug-In-Play integrations)."
            },
            "required": true
          },
          {
            "name": "Courtesy",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um usuário cortesia (Não conta no pagamento). Usuários que não são de integração terão o valor de falso.",
              "en": "Boolean that indicates if it is a courtesy user (Does not count in the payment). Non-integration users will have a value of false."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Email",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Role, Profile, Teams, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_11"
              },
              "examples": {
                "0": {
                  "value": "{\"Name\":\"Nome do Usu\u00e1rio\",\"Email\":\"XXXXXXX@XXXX.com\",\"ProfileId\":0,\"Password\":\"XXXXX\",\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Users({Id})": {
      "delete": {
        "tags": [
          "Users"
        ],
        "description": {
          "pt": "<div><br>Apaga um usuário.</div>",
          "en": "<div><br>Delete an user.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Users"
        ],
        "description": {
          "pt": "<div><br>Atualiza um usuário.</div>",
          "en": "<div><br>Update an user.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do usuário, gerado automaticamente pelo Banco de Dados.",
              "en": "User Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(100)",
            "description": {
              "pt": "Nome do usuário.",
              "en": "Username."
            },
            "required": true
          },
          {
            "name": "Email",
            "type": "string(200)",
            "description": {
              "pt": "Email do usuário.",
              "en": "User email."
            },
            "required": true
          },
          {
            "name": "RoleId",
            "type": "integer",
            "description": {
              "pt": "Id do cargo do usuário. Essa informação está disponível no endpoint '/Roles'.",
              "en": "User's role id. This information is available on the '/Roles' endpoint."
            },
            "required": false
          },
          {
            "name": "ProfileId",
            "type": "integer",
            "description": {
              "pt": "Id do perfil do usuário. Essa informação está disponível no endpont '/Users@Profiles'.",
              "en": "User profile id. This information is available in the '/Users@Profiles' endpoint."
            },
            "required": true
          },
          {
            "name": "AvatarUrl",
            "type": "string(300)",
            "description": {
              "pt": "Url do avatar do usuário (Foto).",
              "en": "Url of user avatar (Photo)."
            },
            "required": false
          },
          {
            "name": "Phone",
            "type": "string(150)",
            "description": {
              "pt": "Telefone do usuário.",
              "en": "User Phone."
            },
            "required": false
          },
          {
            "name": "Language",
            "type": "string(10)",
            "description": {
              "pt": "Língua do usuário.",
              "en": "User language."
            },
            "required": false
          },
          {
            "name": "Facebook",
            "type": "string(500)",
            "description": {
              "pt": "Facebook do usuário.",
              "en": "User's Facebook."
            },
            "required": false
          },
          {
            "name": "LinkedIn",
            "type": "string(500)",
            "description": {
              "pt": "LinkedIn do usuário.",
              "en": "User's LinkedIn."
            },
            "required": false
          },
          {
            "name": "SuspensionReasonId",
            "type": "integer",
            "description": {
              "pt": "Id do mostivo de suspensão do usuário.",
              "en": "Id of the user's suspension reason."
            },
            "required": false
          },
          {
            "name": "SuspensionReasonComments",
            "type": "string(2000)",
            "description": {
              "pt": "Comentário sobre a suspensão do usuário.",
              "en": "User suspension reason comment."
            },
            "required": false
          },
          {
            "name": "Integration",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um usuário de integração (UserKey fixa).",
              "en": "Boolean that indicates if it is an integration user (fixed User Key)."
            },
            "required": true
          },
          {
            "name": "NativeIntegration",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um usuário de integração nativa (Utilizado pelas integrações Plug-In-Play).",
              "en": "Boolean indicating whether it is a native integration user (Used by Plug-In-Play integrations)."
            },
            "required": true
          },
          {
            "name": "Courtesy",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um usuário cortesia (Não conta no pagamento). Usuários que não são de integração terão o valor de falso.",
              "en": "Boolean that indicates if it is a courtesy user (Does not count in the payment). Non-integration users will have a value of false."
            },
            "required": false
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name, Email",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,Name"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Role, Profile, Teams, OtherProperties",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_10"
              },
              "examples": {
                "0": {
                  "value": "{\"Name\":\"Nome do Usu\u00e1rio\",\"Email\":\"XXXXXXX@XXXX.com\",\"ProfileId\":0,\"Password\":\"XXXXX\",\"OtherProperties\":[{\"FieldKey\":\"{fieldKey}\",\"StringValue\":\"texto exemplo\"},{\"FieldKey\":\"{fieldKey}\",\"IntegerValue\":2}]}"
                }
              }
            }
          }
        }
      }
    },
    "/Users@Profiles": {
      "get": {
        "tags": [
          "Users"
        ],
        "description": {
          "pt": "<div><br>Consulta os perfis de usuários <br> É recomendado realizar essa configuração pela Web, já que são muitas opções e campos diferentes, por esse motivo a descrição dos campos não foi detalhada.</div>",
          "en": "<div><br>Query user profiles <br> It is recommended to carry out this configuration via the Web, since there are many different options and fields, for this reason the description of the fields was not detailed.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id do perfil de usuário, gerado automaticamente pelo Banco de Dados.",
              "en": "User profile id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome do perfil de usuário.",
              "en": "User profile name."
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, Name",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Creator, Updater",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    },
    "/Webhooks": {
      "get": {
        "tags": [
          "Webhooks"
        ],
        "description": {
          "pt": "<div><br>Consulta os webhooks da conta. <br> <br> Algumas observações: <ul><li>O máximo de tentativas é 10 após o primeiro erro (11 no total). </li> <li> A cada erro o intervalo para uma nova tentativa aumenta. </li> <li>É importante implementar uma fila e retornar 200 em todas as requisições como uma boa prática. </li></ul></div>",
          "en": "<div><br>Checks the account's webhooks. <br> <br> A few notes: <ul><li>Maximum attempts are 10 after the first error (11 total). </li> <li > With each error, the interval for a new attempt increases. </li> <li>It is important to implement a queue and return 200 in all requests as a good practice. </li></ul></div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da webhook, gerado automaticamente pelo Banco de Dados.",
              "en": "Webhook Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "EntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade do webhook. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Entity Id of the webhook. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": true
          },
          {
            "name": "SecondaryEntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade secundária do webhook. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Secondary entity id of the webhook. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": false
          },
          {
            "name": "ActionId",
            "type": "integer",
            "description": {
              "pt": "Id da ação do webhook. Essa informação está disponível no endpoint '/Webhooks@Actions'.",
              "en": "Id of the webhook action. This information is available in the '/Webhooks@Actions' endpoint."
            },
            "required": false
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do webhook.",
              "en": "Webhook name."
            },
            "required": false
          },
          {
            "name": "CallbackUrl",
            "type": "string(1000)",
            "description": {
              "pt": "Url de callback do webhook",
              "en": "Webhook callback url"
            },
            "required": false
          },
          {
            "name": "ValidationKey",
            "type": "string(50)",
            "description": {
              "pt": "Chave de validação do webhook",
              "en": "Webhook Validation Key"
            },
            "required": false
          },
          {
            "name": "UserWebhook",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um webhook de usuário",
              "en": "Boolean that indicates whether it is a user webhook"
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$top",
            "in": "query",
            "description": "10",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$skip",
            "in": "query",
            "description": "0",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, EntityId, SecondaryEntityId, ActionId, Name, CallBackUrl, ValidationKey",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Entity, SecondaryEntity, Action",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$filter",
            "in": "query",
            "description": "Id+eq+12345",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "post": {
        "tags": [
          "Webhooks"
        ],
        "description": {
          "pt": "<div><br>Cria um Webhook. <br> <br> Algumas observações: <ul><li>O máximo de tentativas é 10 após o primeiro erro (11 no total). </li> <li> A cada erro o intervalo para uma nova tentativa aumenta. </li> <li>É importante implementar uma fila e retornar 200 em todas as requisições como uma boa prática. </li></ul></div>",
          "en": "<div><br>Create a webhook. <br> <br> A few notes: <ul><li>Maximum attempts are 10 after the first error (11 total). </li> <li > With each error, the interval for a new attempt increases. </li> <li>It is important to implement a queue and return 200 in all requests as a good practice. </li></ul></div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da webhook, gerado automaticamente pelo Banco de Dados.",
              "en": "Webhook Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "EntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade do webhook. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Entity Id of the webhook. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": true
          },
          {
            "name": "SecondaryEntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade secundária do webhook. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Secondary entity id of the webhook. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": false
          },
          {
            "name": "ActionId",
            "type": "integer",
            "description": {
              "pt": "Id da ação do webhook. Essa informação está disponível no endpoint '/Webhooks@Actions'.",
              "en": "Id of the webhook action. This information is available in the '/Webhooks@Actions' endpoint."
            },
            "required": false
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do webhook.",
              "en": "Webhook name."
            },
            "required": false
          },
          {
            "name": "CallbackUrl",
            "type": "string(1000)",
            "description": {
              "pt": "Url de callback do webhook",
              "en": "Webhook callback url"
            },
            "required": false
          },
          {
            "name": "ValidationKey",
            "type": "string(50)",
            "description": {
              "pt": "Chave de validação do webhook",
              "en": "Webhook Validation Key"
            },
            "required": false
          },
          {
            "name": "UserWebhook",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um webhook de usuário",
              "en": "Boolean that indicates whether it is a user webhook"
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "$select",
            "in": "query",
            "description": "Id, EntityId, SecondaryEntityId, ActionId, Name, CallBackUrl, ValidationKey",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Entity, SecondaryEntity, Action",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_11"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"EntityId\": 1,\r\n    \"ActionId\": 2,\r\n    \"CallbackUrl\": \"url\",\r\n    \"ValidationKey\": \"7654\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Webhooks({Id})": {
      "delete": {
        "tags": [
          "Webhooks"
        ],
        "description": {
          "pt": "<div><br>Apaga um webhook.</div>",
          "en": "<div><br>Delete a webhook.</div>"
        },
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ]
      },
      "patch": {
        "tags": [
          "Webhooks"
        ],
        "description": {
          "pt": "<div><br>Atualiza um Webhook. <br> <br> Algumas observações: <ul><li>O máximo de tentativas é 10 após o primeiro erro (11 no total). </li> <li> A cada erro o intervalo para uma nova tentativa aumenta. </li> <li>É importante implementar uma fila e retornar 200 em todas as requisições como uma boa prática. </li></ul></div>",
          "en": "<div><br>Update a webhook. <br> <br> A few notes: <ul><li>Maximum attempts are 10 after the first error (11 total). </li> <li > With each error, the interval for a new attempt increases. </li> <li>It is important to implement a queue and return 200 in all requests as a good practice. </li></ul></div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da webhook, gerado automaticamente pelo Banco de Dados.",
              "en": "Webhook Id, automatically generated by the Database."
            },
            "required": true
          },
          {
            "name": "EntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade do webhook. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Entity Id of the webhook. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": true
          },
          {
            "name": "SecondaryEntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade secundária do webhook. Essa informação está disponível no endpoint '/Fields@Entities'.",
              "en": "Secondary entity id of the webhook. This information is available in the '/Fields@Entities' endpoint."
            },
            "required": false
          },
          {
            "name": "ActionId",
            "type": "integer",
            "description": {
              "pt": "Id da ação do webhook. Essa informação está disponível no endpoint '/Webhooks@Actions'.",
              "en": "Id of the webhook action. This information is available in the '/Webhooks@Actions' endpoint."
            },
            "required": false
          },
          {
            "name": "Name",
            "type": "string(200)",
            "description": {
              "pt": "Nome do webhook.",
              "en": "Webhook name."
            },
            "required": false
          },
          {
            "name": "CallbackUrl",
            "type": "string(1000)",
            "description": {
              "pt": "Url de callback do webhook",
              "en": "Webhook callback url"
            },
            "required": false
          },
          {
            "name": "ValidationKey",
            "type": "string(50)",
            "description": {
              "pt": "Chave de validação do webhook",
              "en": "Webhook Validation Key"
            },
            "required": false
          },
          {
            "name": "UserWebhook",
            "type": "boolean",
            "description": {
              "pt": "Boleano que indica se é um webhook de usuário",
              "en": "Boolean that indicates whether it is a user webhook"
            },
            "required": true
          }
        ],
        "parameters": [
          {
            "name": "Id",
            "in": "path",
            "description": "12345",
            "required": true,
            "style": "simple",
            "explode": false,
            "schema": {
              "minimum": 1,
              "type": "integer"
            }
          },
          {
            "name": "$select",
            "in": "query",
            "description": "Id, EntityId, SecondaryEntityId, ActionId, Name, CallBackUrl, ValidationKey",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            },
            "example": "Id,Name"
          },
          {
            "name": "$expand",
            "in": "query",
            "description": "Entity, SecondaryEntity, Action",
            "required": false,
            "style": "form",
            "explode": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "User-Key",
            "in": "header",
            "required": false,
            "style": "simple",
            "explode": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/body_10"
              },
              "examples": {
                "0": {
                  "value": "{\r\n\t\"EntityId\": 1,\r\n    \"ActionId\": 2,\r\n    \"CallbackUrl\": \"url\",\r\n    \"ValidationKey\": \"7654\"\r\n}"
                }
              }
            }
          }
        }
      }
    },
    "/Webhooks@Actions": {
      "get": {
        "tags": [
          "Webhooks"
        ],
        "description": {
          "pt": "<div><br>Consulta as ações de webhooks.</div>",
          "en": "<div><br>Queries the actions of webhooks.</div>"
        },
        "fields": [
          {
            "name": "Id",
            "type": "integer",
            "description": {
              "pt": "Id da ação do webhook.'",
              "en": "Id of the webhook action."
            },
            "required": true
          },
          {
            "name": "RestrictedEntityId",
            "type": "integer",
            "description": {
              "pt": "Id da entidade restrita.",
              "en": "Restricted entity id."
            },
            "required": false
          },
          {
            "name": "Name",
            "type": "string(50)",
            "description": {
              "pt": "Nome da ação do webhook.",
              "en": "Webhook action name."
            },
            "required": true
          }
        ]
      }
    }
  }
}