Nessa coleção estão documentadas as API's disponibilizadas pela Voalle agrupadas por seus relativos módulos do ERP e funcionalidades.
\nTodas as API's desta coleção estão em um ambiente separado do ERP Voalle e devido a isso o usuário que será utilizado na API de autenticação para obter o access_token a ser informado nas demais requisições, deve ser identificado como um usuário de Integração e assim, não será possível usar esse usuário para acessar a interface do ERP.
\nAo acessar a rotina Configurações / Usuários e cadastrar um novo usuário, marcar a opção Usuário integrador. Quando marcado esse campo, esse usuário não irá conseguir logar no ERP, apenas na API Third Party. Caso não marcado, a API de autenticação irá retornar o status Não Autorizado.
\nTodas as requisições feitas via API ao ERP Voalle irão gerar um log da transação e da ação realizada em nome do usuário autenticado. Com isso, é altamente indicado que seja criado um novo usuário para cada integração que irá acessar o ERPVoalle.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"16282829","collectionId":"fab82460-8195-4bc8-a769-b21548e86d11","publishedId":"TzzBqFw1","public":true,"customColor":{"top-bar":"303030","right-sidebar":"303030","highlight":"FA5239"},"publishDate":"2025-01-03T18:15:20.000Z"},"item":[{"name":"Autenticação","item":[{"name":"Autenticação - Legado","id":"79ef3c32-0a67-4beb-88a0-83c375bc26ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text","description":"Valor Fixo
\n"},{"key":"scope","value":"syngw synpaygw offline_access","type":"text","description":"Valor Fixo
\n"},{"key":"client_id","value":"synauth","type":"text","description":"Valor Fixo
\n"},{"key":"client_secret","value":"df956154024a425eb80f1a2fc12fef0c","type":"text","description":"Valor Fixo
\n"},{"key":"username","value":"{{user}}","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa”
\n"},{"key":"password","value":"{{password}}","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa”
\n"},{"key":"syndata","value":"{{token}}","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa”
\n"}]},"url":"{{URL}}:45700/connect/token","description":"Obs: Caso queira realizar testes no ambiente de Staging/Homologa, utilizar as informações de username, password e syndata desse ambiente e utilizar o link do ambiente de produção para a requisição somente de autenticação.
\n","urlObject":{"port":"45700","path":["connect","token"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"1d7571e8-194e-48d4-8ddd-7a981f03b95f","name":"Autenticação - Legado","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"password","type":"text","description":"Valor Fixo"},{"key":"scope","value":"syngw synpaygw offline_access","type":"text","description":"Valor Fixo"},{"key":"client_id","value":"synauth","type":"text","description":"Valor Fixo"},{"key":"client_secret","value":"df956154024a425eb80f1a2fc12fef0c","type":"text","description":"Valor Fixo"},{"key":"password","value":"Senha","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa”"},{"key":"syndata","value":"Token SynData","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa”"},{"key":"username","value":"Usuário","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa”"}]},"url":"https://erp.cliente.com.br:45700/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"expires_in\": 3600,\n \"refresh_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"token_type\": \"Bearer\"\n}"}],"_postman_id":"79ef3c32-0a67-4beb-88a0-83c375bc26ce"},{"name":"Autenticação","id":"8676cab9-4932-40a7-9a09-5214aed37653","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text","description":"Valor Fixo
\n"},{"key":"scope","value":"syngw","type":"text","description":"Valor Fixo
\n"},{"key":"client_id","value":"{{client_id}}","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Usuários”, campo \"Client Id\" do usuário marcado como Integrador
\n"},{"key":"client_secret","value":"{{client_secret}}","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Usuários”, campo \"Client Secret\" do usuário marcado como Integrador
\n"},{"key":"syndata","value":"{{token}}","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Parâmetros” menu “Integração/Mapa” ou solicitado a Voalle via protocolo
\n"}]},"url":"{{URL}}:45700/connect/token","description":"Obs: Caso queira realizar testes no ambiente de Staging/Homologa, utilizar as informações de client_id, client_secret e syndata desse ambiente e utilizar o link do ambiente de produção para a requisição somente de autenticação.
\n","urlObject":{"port":"45700","path":["connect","token"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"dedef76e-3d9a-4d75-a7d4-996650f475de","name":"Autenticação","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"client_credentials","type":"text","description":"Valor Fixo"},{"key":"scope","value":"syngw","type":"text","description":"Valor Fixo"},{"key":"client_id","value":"Token Client_id","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Usuários”, campo \"Client Id\" do usuário marcado como Integrador"},{"key":"client_secret","value":"Token Client_secret","type":"text","description":"Informado pelo cliente - “Suíte / Configurações / Usuários”, campo \"Client Secret\" do usuário marcado como Integrador"},{"key":"syndata","value":"Token SynData","type":"text","description":"Informado pelo cliente - “Configurações / Usuários” quando o campo estiver marcado como Integrador"}]},"url":"https://erp.cliente.com.br:45700/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"expires_in\": 3600,\n \"refresh_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"token_type\": \"Bearer\"\n}"}],"_postman_id":"8676cab9-4932-40a7-9a09-5214aed37653"},{"name":"Refresh Token","id":"0f8416e2-b0b3-424c-b476-6809d0a6fd2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","type":"text","description":"Valor Fixo
\n"},{"key":"client_id","value":"synauth","type":"text","description":"Valor Fixo
\n"},{"key":"client_secret","value":"df956154024a425eb80f1a2fc12fef0c","type":"text","description":"Valor Fixo
\n"},{"key":"refresh_token","value":"Refresh Token","type":"text","description":"Obtido no método de autenticação
\n"}]},"url":"{{URL}}:45700/connect/token","urlObject":{"port":"45700","path":["connect","token"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"afcb4eab-ceb5-4c6d-9a5b-4b57d1d79aa5","name":"Refresh Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"grant_type","value":"refresh_token","type":"text"},{"key":"client_id","value":"synauth","type":"text"},{"key":"client_secret","value":"df956154024a425eb80f1a2fc12fef0c","type":"text"},{"key":"refresh_token","value":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx","type":"text"}]},"url":"https://erp.cliente.com.br:45700/connect/token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"access_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"expires_in\": 3600,\n \"refresh_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n \"token_type\": \"Bearer\"\n}"}],"_postman_id":"0f8416e2-b0b3-424c-b476-6809d0a6fd2b"}],"id":"9ef28731-5e42-4eca-a039-d3754998a9ce","_postman_id":"9ef28731-5e42-4eca-a039-d3754998a9ce","description":""},{"name":"Suite","item":[{"name":"Cadastrar Pessoa","id":"669d8e95-b62a-44c5-ad05-da89c8d2fbea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"typeTxId\": \"string\",\n \"txId\": \"string\",\n \"name\": \"string\",\n \"email\": \"string\",\n \"client\": true,\n \"situation\": 1,\n \"streetType\": \"string\",\n \"postalCode\": \"string\",\n \"street\": \"string\",\n \"number\": \"string\",\n \"addressComplement\": \"string\",\n \"addressReference\": \"string\",\n \"neighborhood\": \"string\",\n \"city\": \"string\",\n \"codeCityId\": 0,\n \"state\": \"string\",\n \"codeCountry\": \"string\"\n}"},"url":"{{URL}}:45715/external/integrations/thirdparty/people","description":"Cria uma nova pessoa.
\ntypeTxId:
\nsituation:
\ncodeCountry
\nTabela de Países - Relacionada à NT, disponível no site da Fazenda e pode ser encontrada aqui.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","people"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"393bbafc-0616-46be-8d94-8763265fe77c","name":"Cadastrar Pessoa","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"typeTxId\": 2,\n \"txId\": 123456789,\n \"name\": \"teste\",\n \"email\": \"teste@teste.com\",\n \"client\": true,\n \"situation\": 1,\n \"streetType\": \"Rua\",\n \"postalCode\": 123456789,\n \"street\": \"Rua\",\n \"number\": \"00\",\n \"addressComplement\": \"Complemento\",\n \"addressReference\": \"Referencia\",\n \"neighborhood\": \"Bairro\",\n \"city\": \"Cidade\",\n \"codeCityId\": 123456,\n \"state\": \"BA\",\n \"codeCountry\": \"1058\" // Código para o país Brasil\n}","options":{"raw":{"language":"json"}}},"url":"https://cliente.synsuite.com.br:45715/external/integrations/thirdparty/people"},"code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": [\n {\n \"message\": \"Registro criado com sucesso.\",\n \"code\": null,\n \"type\": \"Success\"\n }\n ],\n \"response\": null,\n \"dataResponseType\": null,\n \"elapsedTime\": null\n}"}],"_postman_id":"669d8e95-b62a-44c5-ad05-da89c8d2fbea"},{"name":"Atualização de Pessoa","id":"30077d5b-2ce9-4b89-b50a-48d254f4fa07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 99,\n \"email\": {\n \"email\": \"teste@teste.com.br\",\n \"emailNfe\": \"testenfe@teste.com.br\"\n },\n \"phone\": {\n \"phone\": \"55999999999\",\n \"cellPhone\": \"55999999999\",\n \"cellPhoneHasWhatsapp\": true\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/people/{id_pessoa}","description":"API permite atualização de E-mail e Telefone a pessoa.
\nDeve ser utilizado o Id da Pessoa na URL da requisição e também no corpo da requisição;
\nCaso não informado o objeto email ou phone não será atualizado os dados do cliente;
\nCaso informado algum dos campos como vazio, será feito a limpeza dos respectivos campos;
\nAo realizar alteração, um log será gravado na Pessoa editada.
\nAtualiza ou adiciona endereço da pessoa.
\nPara atualizar um endereçi, o campo peopleAddressId deve ser preenchido com ID do endereço da pessoa que deseja atualizar;
\nCaso o campo peopleAddressId não for informado, será realizado o cadastro de um novo endereço para a pessoa;
\nBusca uma lista com todos os clientes.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","getclient"],"host":["{{URL}}"],"query":[{"description":{"content":"Quantidade de páginas
\n","type":"text/plain"},"key":"page","value":"{{page}}"},{"description":{"content":"Quantidade de itens por página
\n","type":"text/plain"},"key":"pageSize","value":"{{pageSize}}"}],"variable":[]}},"response":[{"id":"022217f5-93dd-4afb-88c4-f9c4679b9fbb","name":"Lista Clientes","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/getclient?page=1&pageSize=2","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","getclient"],"query":[{"key":"page","value":"1"},{"key":"pageSize","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"id\": \"xx\",\n \"addressComplement\": \"xxxxxxxxxxxxxxxx\",\n \"addressReference\": \"xxxxxx\",\n \"birthDate\": \"1984-05-30T00:00:00\",\n \"candidate\": false,\n \"carrier\": false,\n \"cellPhone1\": \"(xx)xxxx-xxxx\",\n \"cellPhone2\": null,\n \"city\": \"xxxxxxxxxx\",\n \"civilStatus\": 1,\n \"client\": true,\n \"codeCityId\": 12345,\n \"codeCountry\": \"123\",\n \"collaborator\": false,\n \"companyPlaceId\": null,\n \"competitor\": false,\n \"country\": \"Brasil\",\n \"email\": \"teste@syntesis.com.br\",\n \"emailNfe\": \"teste@syntesis.com.br\",\n \"expert\": false,\n \"gender\": 2,\n \"houseLawyer\": false,\n \"identity\": \"123456\",\n \"municipalRegistration\": \"\",\n \"name\": \"xxxxxx xxxxxx\",\n \"name2\": \"xxxxx xxxxxx\",\n \"neighborhood\": \"xxxxxx\",\n \"number\": \"xxxxx\",\n \"parentsName\": \"xxxxx xxxxxx\",\n \"peopleAddressMainId\": 5,\n \"phone\": \"(xx)xxxx-xxxx\",\n \"postalCode\": \"xxxxx-xxx\",\n \"ruralProducer\": false,\n \"situation\": 3,\n \"state\": \"xx\",\n \"stateRegistration\": \"\",\n \"stateRegistrationType\": 9,\n \"status\": 1,\n \"street\": \"xxxxx xxxxxx\",\n \"streetType\": \"Rua\",\n \"supervisor\": false,\n \"supplier\": false,\n \"syndicate\": false,\n \"technical\": false,\n \"txId\": \"xxxxxxxxxxx\",\n \"txIdFormated\": \"xxx.xxx.xxx-xx\",\n \"typeTxId\": 2,\n \"unlikeLawyer\": false,\n \"userId\": 4,\n \"vendor\": false\n },\n {\n \"id\": 17,\n \"addressComplement\": \"\",\n \"addressReference\": \"\",\n \"birthDate\": null,\n \"candidate\": false,\n \"carrier\": false,\n \"cellPhone1\": \"(xx)xxxxx-xxxx\",\n \"cellPhone2\": null,\n \"city\": \"xxxxxxxxxx\",\n \"civilStatus\": null,\n \"client\": true,\n \"codeCityId\": 123456,\n \"codeCountry\": \"xxxx\",\n \"collaborator\": true,\n \"companyPlaceId\": null,\n \"competitor\": false,\n \"country\": \"Brasil\",\n \"email\": \"teste@syntesis.com.br\",\n \"emailNfe\": \"teste@syntesis.com.br\",\n \"expert\": false,\n \"gender\": null,\n \"houseLawyer\": false,\n \"identity\": \"\",\n \"municipalRegistration\": \"\",\n \"name\": \"xxxxxx xxxx xxxxxxx\",\n \"name2\": \"xxxxxx xxxx xxxxxxx\",\n \"neighborhood\": \"xxxxx\",\n \"number\": \"xxxx\",\n \"parentsName\": \"\",\n \"peopleAddressMainId\": 8,\n \"phone\": \"(xx)xxxxx-xxxx\",\n \"postalCode\": \"xxxxx-xxx\",\n \"ruralProducer\": false,\n \"situation\": 3,\n \"state\": \"xx\",\n \"stateRegistration\": \"\",\n \"stateRegistrationType\": 9,\n \"status\": 1,\n \"street\": \"xxxxx xxxxxxx\",\n \"streetType\": \"Rua\",\n \"supervisor\": true,\n \"supplier\": true,\n \"syndicate\": false,\n \"technical\": true,\n \"txId\": \"xxxxxxxxxx\",\n \"txIdFormated\": \"xxx.xxx.xxx-xx\",\n \"typeTxId\": 2,\n \"unlikeLawyer\": false,\n \"userId\": 7,\n \"vendor\": false\n }\n ],\n \"totalRecords\": 21986,\n \"page\": 1,\n \"pageSize\": 2,\n \"totalizers\": null,\n \"totalPages\": 10993\n },\n \"dataResponseType\": \"DataPage`1\",\n \"elapsedTime\": null\n}"}],"_postman_id":"d54cc3f7-9085-4fa6-831b-b3981b1fea00"},{"name":"Lista Locais","id":"68e31c59-7e06-4826-8d4f-f9b70e08828b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Obtido no método de autenticação
\n"}],"url":"{{URL}}:45715/external/integrations/thirdparty/companiesplacespaged?Page={{page}}&PageSize={{page_size}}&Filter={{filter}}&OrderBy={{order_by}}","urlObject":{"port":"45715","path":["external","integrations","thirdparty","companiesplacespaged"],"host":["{{URL}}"],"query":[{"description":{"content":"Quantidade de páginas
\n","type":"text/plain"},"key":"Page","value":"{{page}}"},{"description":{"content":"Quantidade de itens por páginas
\n","type":"text/plain"},"key":"PageSize","value":"{{page_size}}"},{"description":{"content":"Filtros (Opcional)
\n","type":"text/plain"},"key":"Filter","value":"{{filter}}"},{"description":{"content":"Ordenação (Opcional)
\n","type":"text/plain"},"key":"OrderBy","value":"{{order_by}}"}],"variable":[]}},"response":[{"id":"da8dd8b6-af9f-4931-b354-92b6aadf51ed","name":"Lista Locais","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/companiesplacespaged?Page=1&PageSize=2&Filter={{filter}}&OrderBy={{order_by}}","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","companiesplacespaged"],"query":[{"key":"Page","value":"1"},{"key":"PageSize","value":"2"},{"key":"Filter","value":"{{filter}}"},{"key":"OrderBy","value":"{{order_by}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"id\": 1,\n \"description\": \"Local 1\",\n \"code\": \"01\",\n \"txId\": \"0000000000000000\",\n \"txIdFormated\": \"00.111.222/0001-00\",\n \"city\": \"Cidade\",\n \"street\": \"Rua\"\n },\n {\n \"id\": 2,\n \"description\": \"Local 2\",\n \"code\": \"02\",\n \"txId\": \"00000000000000\",\n \"txIdFormated\": \"00.000.444/0001-00\",\n \"city\": \"Cidade\",\n \"street\": \"Avenida\"\n }\n ],\n \"totalRecords\": 2,\n \"page\": 1,\n \"pageSize\": 2,\n \"totalizers\": null,\n \"totalPages\": 1\n },\n \"dataResponseType\": \"DataPage`1\",\n \"elapsedTime\": null\n}"}],"_postman_id":"68e31c59-7e06-4826-8d4f-f9b70e08828b"},{"name":"Busca Cliente por CPF/CNPJ","id":"2a029f58-f20d-45cf-b8e0-862cfba60779","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Obtido no método de autenticação
\n"}],"url":"{{url}}:45715/external/integrations/thirdparty/people/txid/{{txId}}","description":"Busca pessoa pelo documento.
\nSão retornados apenas registros de cadastro com atributo cliente marcado.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","people","txid","{{txId}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2f34ac59-6d55-4df0-bdfe-62e5abc5f793","name":"Busca Cliente por CPF/CNPJ","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/people/txid/00000000000"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"id\": 123456,\n \"name\": \"xxxxx xxx xxxxxxx \",\n \"name2\": \"\",\n \"txId\": \"0000000000\",\n \"email\": \"teste@syntesis.com.br\",\n \"status\": 1,\n \"phone\": \"(55) 3220-1350\",\n \"birthDate\": \"2021-07-07\", // Quando CPF, irá retornar a data de nascimento. Quando CNPJ, irá retornar null.\n \"cellPhone\": \"(55) 3220-1350\",\n \"mainAddress\": {\n \"streetType\": \"Rua\",\n \"street\": \"Rua das laranjeiras\",\n \"number\": \"123\",\n \"addressComplement\": \"ap 01\",\n \"neighborhood\": \"Centro\",\n \"city\": \"Santa Maria\",\n \"codeCityId\": 4316907,\n \"addressReference\": \"Portão verde\",\n \"state\": \"RS\",\n \"postalCode\": \"00000-000\",\n \"longitude\": \"00.0000\",\n \"latitude\": \"00.0000\"\n },\n \"titles\": [\n {\n \"id\": 123456,\n \"billet\": {\n \"bankTitleNumber\": null,\n \"balance\": 0.00,\n \"title\": \"FAT00000000000000\",\n \"issueDate\": \"2019-07-19\",\n \"expirationDate\": \"2019-08-15\",\n \"processingDate\": \"2021-07-07\",\n \"amount\": {\n \"value\": 0.00,\n \"finalValue\": 0.00,\n \"discount\": 0,\n \"fine\": 0,\n \"interest\": 0\n }\n }\n },\n {\n \"id\": 654321,\n \"billet\": {\n \"bankTitleNumber\": null,\n \"balance\": 0.00,\n \"title\": \"FAT00000000000000\",\n \"issueDate\": \"2019-08-20\",\n \"expirationDate\": \"2019-09-15\",\n \"processingDate\": \"2021-07-07\",\n \"amount\": {\n \"value\": 0.00,\n \"finalValue\": 0.00,\n \"discount\": 0,\n \"fine\": 0,\n \"interest\": 0\n }\n }\n }\n \n ]\n },\n \"dataResponseType\": \"ListBusca uma lista com todos tipos de documentos.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","getdocumentationtypes"],"host":["{{URL}}"],"query":[{"description":{"content":"Opcional
\n","type":"text/plain"},"key":"Filter","value":"{{filter}}"},{"description":{"content":"Opcional
\n","type":"text/plain"},"key":"OrderBy","value":"{{orderBy}}"}],"variable":[]}},"response":[{"id":"fca44f66-c29b-410a-8afc-f1a4f4b79701","name":"Lista Tipos de Documentos","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/getdocumentationtypes?Filter={{FILTER}}&OrderBy={{ORDERBY}}","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","getdocumentationtypes"],"query":[{"key":"Filter","value":"{{FILTER}}"},{"key":"OrderBy","value":"{{ORDERBY}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"active\": true,\n \"code\": \"1.01\",\n \"id\": 1,\n \"title\": \"Documentos Adminsitrativos\",\n \"description\": \"Documentos Adminsitrativos\",\n \"defaultText\": \"\",\n \"useType\": {\n \"value\": 1,\n \"label\": \"Padrão\"\n },\n \"synsuiteCode\": null\n },\n {\n \"active\": true,\n \"code\": \"2.01\",\n \"id\": 2,\n \"title\": \"Documentos Técnicos\",\n \"description\": \"Documentos Técnicos\",\n \"defaultText\": \"\",\n \"useType\": {\n \"value\": 1,\n \"label\": \"Padrão\"\n },\n \"synsuiteCode\": null\n },\n {\n \"active\": true,\n \"code\": \"1.02\",\n \"id\": 3,\n \"title\": \"Contrato\",\n \"description\": \"\",\n \"defaultText\": \"\",\n \"useType\": {\n \"value\": 1,\n \"label\": \"Padrão\"\n },\n \"synsuiteCode\": null\n },\n {\n \"active\": true,\n \"code\": \"001\",\n \"id\": 4,\n \"title\": \"IP de Gerência\",\n \"description\": \"IP de Gerência\",\n \"defaultText\": null,\n \"useType\": {\n \"value\": 1,\n \"label\": \"Padrão\"\n },\n \"synsuiteCode\": 1\n },\n {\n \"active\": true,\n \"code\": \"002.1\",\n \"id\": 5,\n \"title\": \"CPA - Documentos\",\n \"description\": \"Anexos relacionados a Títulos à Pagar\",\n \"defaultText\": null,\n \"useType\": {\n \"value\": 1,\n \"label\": \"Padrão\"\n },\n \"synsuiteCode\": 2\n }\n ],\n \"totalRecords\": 5,\n \"page\": 1,\n \"pageSize\": 10,\n \"totalizers\": null,\n \"totalPages\": 1\n },\n \"dataResponseType\": \"DataPage`1\",\n \"elapsedTime\": null\n}"}],"_postman_id":"ecedb2d1-1880-4ee8-bb67-629408169ec3"},{"name":"Busca um documento de assinatura eletrônica","id":"a79815e8-3757-44b7-8a44-1cbc15480447","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/suite/electronicsignatures/getdocumentlinktosignbycontract/123456","description":"Busca uma lista com todos tipos de documentos.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","suite","electronicsignatures","getdocumentlinktosignbycontract","123456"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"5745d263-9bcd-4b5a-a679-4f9e52dc0741","name":"Sucesso","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/suite/electronicsignatures/getdocumentlinktosignbycontract/123456"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": true,\n \"response\": [\n {\n \"signatureId\": 1,\n \"description\": \"Documento gerado para assinatura eletronica\",\n \"contractId\": 1234,\n \"assignmentId\": null,\n \"integrationCode\": \"5432ae4d-4e32-4e2a-9036-49d226dfa8f2\",\n \"personId\": 1234,\n \"personName\": \"JOAO DA SILVA\",\n \"integrationType\": 0,\n \"integrationTypeDescription\": \"V-DS\",\n \"status\": \"Aguardando Assinaturas\",\n \"created\": \"2025-05-21T17:26:38.641107\",\n \"expirationDate\": null,\n \"linkToSign\": \"\"\n }\n ]\n}"},{"id":"25ea262f-79e8-4461-b514-ea5da1967efd","name":"Insucesso","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/suite/electronicsignatures/getdocumentlinktosignbycontract/123456"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"messages\": [\n {\n \"message\": \"Não foi possível encontrar o contrato\",\n \"code\": 300,\n \"type\": \"Error\"\n }\n ]\n}"}],"_postman_id":"a79815e8-3757-44b7-8a44-1cbc15480447"},{"name":"Reenvia um documento de assinatura eletrônica","id":"fff0eb4a-12fe-4fb1-a3c8-7d28e46a89a3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assignmentId\": 0, //Id do tipo de solicitação vinculado ao documento\n \"signatureId\": 0, //Id do documento de assinatura eletrônica\n \"dispatchType\": 0 //Tipo de reenvio, pode variar conforme a integradora de assinatura eletrônica\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/suite/electronicsignatures/resend","description":"Busca uma lista com todos tipos de documentos.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","suite","electronicsignatures","resend"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fff0eb4a-12fe-4fb1-a3c8-7d28e46a89a3"},{"name":"Validar se data é feriado","id":"e8990e90-6bf1-48f3-a7e0-f54debda8430","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"date\":\"AAAA-MM-DD\",\n \"UF\":\"RS\",\n \"city\":\"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}:45715/external/integrations/thirdparty/isholiday","urlObject":{"port":"45715","path":["external","integrations","thirdparty","isholiday"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"cdab20d9-d502-43c8-bd7f-5b018723cbe7","name":"É feriado","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"date\":\"2023-12-31\",\n \"UF\":\"RS\",\n \"city\":\"Santa Maria\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}:45715//external/integrations/thirdparty/isholiday"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"isHoliday\": true,\n \"name\": \"Feriado em Santa Maria\",\n \"date\": \"2024-05-13\",\n \"city\": \"Santa Maria\",\n \"scope\": \"Municipal\",\n \"uf\": \"RS\"\n },\n \"dataResponseType\": null,\n \"elapsedTime\": null\n}"},{"id":"e58ce032-63bc-4714-9f09-3ef5d60ca8ee","name":"Não é feriado","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"date\":\"2023-12-31\",\n \"UF\":\"RS\",\n \"city\":\"Santa Maria\"\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}:45715//external/integrations/thirdparty/isholiday"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"isHoliday\": false,\n \"name\": \"\",\n \"date\": \"2024-05-13\",\n \"city\": \"\",\n \"scope\": \"\",\n \"uf\": \"\"\n },\n \"dataResponseType\": null,\n \"elapsedTime\": null\n}"}],"_postman_id":"e8990e90-6bf1-48f3-a7e0-f54debda8430"}],"id":"c7032a6d-cb31-4c43-a8ec-fb84c91c902f","_postman_id":"c7032a6d-cb31-4c43-a8ec-fb84c91c902f","description":""},{"name":"CRM Voalle","item":[{"name":"Criar lead","id":"451f499c-e3e2-4157-b184-2c9c7262717f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":"{\n \"personalData\": {\n \"name\": \"string\",\n \"name2\": \"string\",\n \"typeTxId\": 0,\n \"txId\": \"string\",\n \"birthDate\": \"2022-06-13T17:01:08.158Z\",\n \"identity\": \"string\",\n \"civilStatus\": null,\n \"gender\": null,\n \"parentsName\": \"string\"\n },\n \"contact\": {\n \"phone\": \"string\",\n \"cellPhone\": \"string\",\n \"cellPhoneHasWhatsApp\": true,\n \"cellPhoneHasTelegram\": true,\n \"email\": \"string\",\n \"website\": \"string\"\n },\n \"address\": {\n \"postalCode\": \"string\",\n \"street\": \"string\",\n \"streetType\": \"string\",\n \"number\": \"string\",\n \"neighborhood\": \"string\",\n \"addressComplement\": \"string\",\n \"addressReference\": \"string\",\n \"codeCityId\": 0,\n \"city\": \"string\",\n \"state\": \"string\",\n \"country\": \"string\"\n },\n \"integratorData\": {\n \"crmContactOriginCode\": \"string\",\n \"crmFormCode\": \"string\",\n \"integratorAlias\": \"string\",\n \"integrationCode\": \"string\",\n \"integrationTeamCode\": \"string\",\n \"integrationSellerTxId\": \"string\"\n }\n}"},"url":"{{URL_ERP}}:45715/external/crm/leads/create","description":"A API disponibilizada tem como objetivo possibilitar a criação de novos leads para o CRM Voalle
\nParametrização necessária
\nVinculo da Equipe e do Vendedor para Geração de Leads por Sistema de Terceiros.
\nÉ possível enviar a equipe e o vendedor na requisição, mas caso não seja enviado ou o código da equipe/vendedor não seja legivel para ser vinculado ao Lead, será atribuiro o padrão configruado.
\nRotina:
CRM Voalle / Operações / Dashboard – Parâmetros do CRM, menu Parâmetros Gerais
Premissa para utilização da API, pois os leads cadastrados à partir da API serão vinculados no CRM Voalle à equipe e ao vendedor definidos nos parâmetros Geração de Leads por Sistemas Terceiros.
\n","urlObject":{"port":"45715","path":["external","crm","leads","create"],"host":["{{URL_ERP}}"],"query":[],"variable":[]}},"response":[{"id":"cebf0824-be7a-442c-b4d4-51962091ea8c","name":"Criar lead - erros","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"personalData\": {\n \"name\": \"string\", //Obrigatório, nome do lead, nome da pessoa, quando pessoa física ou a razão social quando pessoa jurídica\n \"name2\": \"string\", // Nome 2, apelido do lead, quando pessoa física ou o nome fantasia, quando pessoa jurídica\n \"typeTxId\": 0, // Tipo de lead, 1 p/ pessoa jurídica e 2 p/ pessoa física\n \"txId\": \"string\", // CPF/CNPJ\n \"birthDate\": \"2022-06-13\", //Data de nascimento da pessoa ou data de abertura da empresa\n \"identity\": \"string\", // RG dp Lead, apenas usado em pessoa física\n \"civilStatus\": null, // Estado civil do Lead, apenas para pessoa física, campo opcional onde 1 solteiro(a), 2 casado(a), 3 divorciado(a), 4 viúvo(a), 5 união estável e 6 separado(a)\n \"gender\": null, // Gênero do lead, apenas quando pessoa física, campo opcional onde 1 masculino e 2 feminino\n \"parentsName\": \"string\" // Nome da mãe do lead, apenas quando pessoa física\n },\n \"contact\": {\n \"phone\": \"string\", // preferencia p/ o número de telefone fixo do lead, apenas números entre 10 e 11 caracteres sendo 2 para o DDD e 8 para um telefone fixo ou 9 caracteres para um telefone celular\n \"cellPhone\": \"string\", //Celular do lead, 11 caracteres, sendo os 2 primeiros caracteres para o DDD e 9 restante para o número\n \"cellPhoneHasWhatsApp\": true, // Define se o cellPhone informado possui WhatsApp, 0 para Não e 1 para Sim\n \"cellPhoneHasTelegram\": true, // Define se o cellPhone informado possui Telegram, 0 para Não e 1 para Sim\n \"email\": \"string\", // E-mail principal do lead, é possível informar um único e-mail no formato “nome@email.com.br”\n \"website\": \"string\" // Website principal do lead, é possível informar um único website no formato “www.siteempresa.com” (exemplo)\n },\n \"address\": {\n \"postalCode\": \"string\", // CEP do endereço do lead, informar apenas números sem a máscara\n \"street\": \"string\", // Logradouro do endereço do lead (será preenchido automaticamente a partir do CEP, caso seja um CEP específico)\n \"streetType\": \"string\", // Tipo de Logradouro do endereço do lead, exemplo: Rua, Avenida, Travessa, etc\n \"number\": \"string\", // Número do endereço do lead, ou seja, o número da casa, prédio, condomínio, ou outros\n \"neighborhood\": \"string\", // Bairro do endereço do lead (será preenchido automaticamente a partir do CEP, caso seja um CEP específico)\n \"addressComplement\": \"string\", // complemento do endereço do lead, utilize este campo para informar o bloco, apartamento e etc\n \"addressReference\": \"string\", // Referência do endereço do lead, utilize este campo para informar algo referente ao endereço ou às proximidades\n \"codeCityId\": 0, // Código do IBGE para o município do endereço do lead (deve ser preenchido a partir do CEP informado)\n \"city\": \"string\", // Município do endereço do lead (deve ser preenchido a partir do CEP informado)\n \"state\": \"string\", // Estado do endereço do lead (deve ser preenchido a partir do CEP informado)\n \"country\": \"string\" // País do endereço do lead (deve ser preenchido a partir do CEP informado)\n },\n \"integratorData\": {\n \"crmContactOriginCode\": \"string\", // Obrigatório, código da Origem de Contato cadastrado no ERP\n \"integratorAlias\": \"string\", // Obrigatório, aliás do Integrador cadastrado no ERP em Manutenção / Integração / Integradores\n \"integrationCode\": \"string\", // Obrigatório, código de referência do Lead na empresa integradora\n \"integrationTeamCode\": \"string\", //Opcional, equipe que será atribuído o Lead no ERP.\n \"integrationSellerTxId\": \"string\" //Opcional, vendedor que será responsável pelo Lead no ERP.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_ERP}}:45715/external/crm/leads/create"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"messages\": [\n {\n \"message\": \"Origem de contato inválida.\",\n \"code\": 300,\n \"type\": \"Error\"\n },\n {\n \"message\": \"Integrador inválido.\",\n \"code\": 300,\n \"type\": \"Error\"\n }\n ],\n \"response\": null,\n \"dataResponseType\": null,\n \"elapsedTime\": null\n}"},{"id":"2ec818df-7e13-487b-b371-a868dba30ec4","name":"Criar lead - sucesso","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"personalData\": {\n \"name\": \"string\", //Obrigatório, nome do lead, nome da pessoa, quando pessoa física ou a razão social quando pessoa jurídica\n \"name2\": \"string\", // Nome 2, apelido do lead, quando pessoa física ou o nome fantasia, quando pessoa jurídica\n \"typeTxId\": 0, // Tipo de lead, 1 p/ pessoa jurídica e 2 p/ pessoa física\n \"txId\": \"string\", // CPF/CNPJ\n \"birthDate\": \"2022-06-13\", //Data de nascimento da pessoa ou data de abertura da empresa\n \"identity\": \"string\", // RG dp Lead, apenas usado em pessoa física\n \"civilStatus\": null, // Estado civil do Lead, apenas para pessoa física, campo opcional onde 1 solteiro(a), 2 casado(a), 3 divorciado(a), 4 viúvo(a), 5 união estável e 6 separado(a)\n \"gender\": null, // Gênero do lead, apenas quando pessoa física, campo opcional onde 1 masculino e 2 feminino\n \"parentsName\": \"string\" // Nome da mãe do lead, apenas quando pessoa física\n },\n \"contact\": {\n \"phone\": \"string\", // preferencia p/ o número de telefone fixo do lead, apenas números entre 10 e 11 caracteres sendo 2 para o DDD e 8 para um telefone fixo ou 9 caracteres para um telefone celular\n \"cellPhone\": \"string\", //Celular do lead, 11 caracteres, sendo os 2 primeiros caracteres para o DDD e 9 restante para o número\n \"cellPhoneHasWhatsApp\": true, // Define se o cellPhone informado possui WhatsApp, 0 para Não e 1 para Sim\n \"cellPhoneHasTelegram\": true, // Define se o cellPhone informado possui Telegram, 0 para Não e 1 para Sim\n \"email\": \"string\", // E-mail principal do lead, é possível informar um único e-mail no formato “nome@email.com.br”\n \"website\": \"string\" // Website principal do lead, é possível informar um único website no formato “www.siteempresa.com” (exemplo)\n },\n \"address\": {\n \"postalCode\": \"string\", // CEP do endereço do lead, informar apenas números sem a máscara\n \"street\": \"string\", // Logradouro do endereço do lead (será preenchido automaticamente a partir do CEP, caso seja um CEP específico)\n \"streetType\": \"string\", // Tipo de Logradouro do endereço do lead, exemplo: Rua, Avenida, Travessa, etc\n \"number\": \"string\", // Número do endereço do lead, ou seja, o número da casa, prédio, condomínio, ou outros\n \"neighborhood\": \"string\", // Bairro do endereço do lead (será preenchido automaticamente a partir do CEP, caso seja um CEP específico)\n \"addressComplement\": \"string\", // complemento do endereço do lead, utilize este campo para informar o bloco, apartamento e etc\n \"addressReference\": \"string\", // Referência do endereço do lead, utilize este campo para informar algo referente ao endereço ou às proximidades\n \"codeCityId\": 0, // Código do IBGE para o município do endereço do lead (deve ser preenchido a partir do CEP informado)\n \"city\": \"string\", // Município do endereço do lead (deve ser preenchido a partir do CEP informado)\n \"state\": \"string\", // Estado do endereço do lead (deve ser preenchido a partir do CEP informado)\n \"country\": \"string\" // País do endereço do lead (deve ser preenchido a partir do CEP informado)\n },\n \"integratorData\": {\n \"crmContactOriginCode\": \"string\", // Obrigatório, código da Origem de Contato cadastrado no ERP\n \"integratorAlias\": \"string\", // Obrigatório, aliás do Integrador cadastrado no ERP em Manutenção / Integração / Integradores\n \"integrationCode\": \"string\", // Obrigatório, código de referência do Lead na empresa integradora\n \"integrationTeamCode\": \"string\", //Opcional, equipe que será atribuído o Lead no ERP.\n \"integrationSellerTxId\": \"string\" //Opcional, vendedor que será responsável pelo Lead no ERP.\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_ERP}}:45715/external/crm/leads/create"},"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": [\n {\n \"message\": \"Lead criado com sucesso.\",\n \"code\": null,\n \"type\": \"Success\"\n }\n ],\n \"response\": [],\n \"dataResponseType\": null,\n \"elapsedTime\": null\n}"}],"_postman_id":"451f499c-e3e2-4157-b184-2c9c7262717f"},{"name":"Nova negociação","id":"a1f669c1-a913-4c20-8f56-7d0e9abaeca0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":"{\r\n \"txId\": \"string\", // CPF/CNPJ do lead\r\n \"companyPlaceTxId\": \"string\", // CNPJ do local de venda\r\n \"thirdSellerTxId\": \"string\", // CPF do vendedor terceiro (ganho) da negociação\r\n \"responsibleSellerTxId\": \"string\", // CPF do vendedor proprietário da negociação\r\n \"TeamCode\": \"string\", // Código da equipe para a negociação\r\n \"contractType\": \"string\", // Código do tipo de contrato - obtido no método contracttypesandservices\r\n \"crmCampaignCode\": \"string\", // Código da campanha - obtido no método campaignsandpricelistservices\r\n \"crmPriceListCode\": \"string\", // Código da lista de preço - obtido no método campaignsandpricelistservices\r\n \"contractPaymentFormCode\": \"string\", // Código da forma de pagamento\r\n \"contractFinancialCollectionTypeCode\": \"string\", // Código do tipo de cobrança\r\n \"contractDateManagementCode\": \"string\", // Código do ciclo de faturamento\r\n \"contractCollectionDay\": \"string\", // Data de vencimento\r\n \"activationIncidentTypeCode\": \"string\", // Código da solicitação de ativação\r\n \"activationGroupInMonthlyFee\": true, // Agrupar os títulos na fatura mensal\r\n \"activationFirstParcelDate\": \"2025-12-12\", // Data da primeira parcela\r\n \"activationPaymentFormCode\": \"string\", // Forma de pagamento\r\n \"activationFinancialCollectionTypeCode\": \"string\", // Tipo de cobrança\r\n \"activationPaymentConditionCode\": \"string\", // Condição de pagamento\r\n \"serviceProducts\": [\r\n {\r\n \"code\": \"string\", // Código do serviço - obtido no método contracttypesandservices\r\n \"quantity\": 0, // Quantidade\r\n \"amount\": 0.0, // Valor do serviço\r\n \"paymentFormCode\": \"string\", // Código da forma de pagamento\r\n \"phoneGroupId\": \"string\", // Id publico do grupo de telefone\r\n \"PhoneNumberInformations\": [\r\n {\r\n \"PhoneNumber\": \"55999999999\", // Número a ser vinculado ao item de contrato\r\n \"PhoneNumberType\": \"0\", // Tipo de número 0 - Fixo, 1 - Celular, 2 - Outro\r\n \"IsPortability\": false // Identifica se é uma portabilidade ou não\r\n }\r\n ]\r\n }\r\n ],\r\n \"clientSaleInfo\": { // Dados do cliente/lead\r\n \"name\": \"string\", // Nome\r\n \"typeTxId\": 0, // Tipo de pessoa sendo: 1 - jurídica; 2 - física; 3 - estrangeiro\r\n \"phone\": \"string\", // Número do Telefone sendo 10 caracateres para DDD+telefone e 11 caracteres para DDD+celular\r\n \"cellPhone1\": \"string\", // Número do Celular sendo 11 caracteres para DDD+celular\r\n \"email\": \"string\", // E-mail\r\n \"emailNfe\": \"string\", // E-mail de faturamento\r\n \"birthDate\": \"2021-09-16\", // Data de nascimento para Pessoa Física ou data de fundação para Pessoa Jurídica - formato AAAA-MM-DD\r\n \"gender\": 0, // Genêro sendo: 1 - masculino; 2 - feminino\r\n \"civilStatus\": 0, // Estado civil sendo: 1 - solteiro; 2 - casado; 3 - divorciado; 4 - viuvo; 5 - união estável; 6 - divorciado\r\n \"identity\": \"string\", // Número do RG\r\n \"parentsName\": \"string\", // Nome da mãe\r\n \"stateRegistration\": \"string\", // Número da Inscrição estadual\r\n \"municipalRegistration\": \"string\", // Número da Inscrição municipal\r\n \"stateRegistrationType\": 0, // Tipo de inscrição estadual sendo: 1 - Contribuinte; 2 - Isento; 3 - Não contribuinte\r\n \"addressSaleInfo\": {\r\n \"postalCode\": \"string\", // CEP do endereço\r\n \"street\": \"string\", // Loradouro do endereço\r\n \"streetType\": 0, // Tipo de logradouro sendo: 0 - Não Informado, 1 - Alameda, 2 - Aeroporto, 3 - Área, 4 - Avenida, 5 - Campo, 6 - Chácara, 7 - Colônia, 8 - Condomínio, 9 - Conjunto, 10 - Distrito, 11 - Esplanada, 12 - Estação, 13 - Estrada, 14 - Favela, 15 - Fazenda, 16 - Feira, 17 - Jardim, 18 - Ladeira, 19 - Lago, 20 - Lagoa, 21 - Largo, 22 - Loteamento, 23 - Morro, 24 - Núcleo, 25 - Parque, 26 - Passarela, 27 - Pátio, 28 - Praça, 29 - Quadra, 30 - Recanto, 31 - Residencial, 32 - Rua, 33 - Rodovia, 34 - Setor, 35 - Sítio, 36 - Travessa, 37 - Trecho, 38 - Trevo, 39 - Vale, 40 - Vereda, 41 - Via, 42 - Viaduto, 43 - Beco, 44 - Vila, \r\n \"number\": \"string\", // Numero da residência\r\n \"neighborhood\": \"string\", // Bairro do endereço\r\n \"state\": \"string\", // Sigla do estado (UF)\r\n \"city\": \"string\", // Nome da Cidade\r\n \"addressComplement\": \"string\", // Complemento para o endereço\r\n \"addressReference\": \"string\", // Ponto de referência do endereço\r\n \"residenceTypeCode\": \"string\" // Tipo de propriedade, sendo: 01 - casa madeira; 02 - casa alvenaria; 03 - casa mista; 04 - apartamento\r\n }\r\n },\r\n \"activationInformation\": { // Dados da solicitação de ativação\r\n \"teamCode\": \"string\", // Código da Equipe de ativação\r\n \"description\": \"string\", // Descrição da solicitação de ativação\r\n \"catalogServiceCode\": \"string\", // Código do catálogo de serviços\r\n \"categoryMatrixCode\": \"string\" // Código da aatriz de categoria\r\n },\r\n \"integratorInformation\": { // Dados do integrador origem da requisição\r\n \"integratorIdentification\": \"string\", // Identificação do Integrador\r\n \"negotiationId\": \"string\", // Identificação da negociação\r\n \"viabilityId\": 0 // Identificação da viabilidade técnica realizada\r\n },\r\n \"gainInformation\": { // Dados do ganho da negociação\r\n \"crmOpportunityReasonCode\": \"string\", // Código do motivo do ganho\r\n \"contactForm\": \"string\", // Código da forma de contato\r\n \"reportDescription\": 0, // Descrição do ganho\r\n \"automatic\": true // informação se o ganho da negociação deve ocorrer automaticamente (true) ou não (false)\r\n },\r\n \"contacts\": [ // Possibilidade de enviar um ou mais contatos a serem vinculados ao cliente\r\n {\r\n \"name\": \"string\", // Nome do contato\r\n \"typeTxId\": 0, // Tipo de pessoa sendo: 1 - juridica; 2 - fisica; 3 - estrangeiro\r\n \"txId\": \"string\", // CPF do contato caso seja pessoa física ou CNPJ do contato caso seja pessoa jurídica\r\n \"email\": \"string\", // E-mail do contato\r\n \"phone\": \"string\", // Telefone do contato\r\n \"crmFunctionCode\": \"string\", // Código do cargo ocupacional do contato\r\n \"classification\": 10, // Código da classificação do contato (assinador), sendo: 1 - Responsável Legal; 2 - Procurador; 3 - Representante; 4 - Testemunha; 5 - Decisor Geral; 6 - Responsável Financeiro; 7 - Diretor; 8 - Validado por; 9 - Gerente de Contas; 10 - Cliente\r\n \"order\": 1, // Ordem de assinatura do contato (assinador),\r\n \"isSigner\": true // Flag para indicar que o conato é assinador (para assinatura ANTERIOR ao ganho)\r\n }\r\n ],\r\n \"observations\": \"string\" // Campo de texto para inserir informações extras sobre a negociação\r\n}"},"url":"{{url}}:45715/external/integrations/thirdparty/crm/startsale","description":"Inicia uma venda/negociação via API.
\nPara negociação através do novo CRM é necessário que o módulo CRM - Voalle esteja habilitado no ERP;
\nÉ possível apenas vincular serviços ao contrato, sendo estes apenas serviços mensais e de ativação para a venda.
\nCaso o cliente não tenha cadastro, será usado as informações enviadas na requisição para criar um cadastro e um endereço para esta pessoa;
\nCaso o cliente já possua cadastro, essas informações serão usadas para atualizar o cadastro e o endereço já existentes da pessoa, preenchendo todos os campos necessários. Para realizar a busca das informações, pode ser utilizado o CPF/CNPJ do cliente.
\nCampos:
\ncontractType: Código do Tipo de Contrato que será definido para a negociação. A API irá seguir as mesmas regras do CRM - Voalle, assim, aceitando os mesmos Tipos de Contrato em tela.
\ncrmCampaignCode: Valor obtido no método Consulta campanhas e serviços;
\ncrmPriceListCode: Valor obtido no método Consulta campanhas e serviços;
\ncontractPaymentFormCode: Código da Forma de Pagamento que será definido para a negociação. A API irá seguir as mesmas regras do CRM - Voalle, assim, aceitando as mesmas Forma de Pagamento em tela.
\ncontractFinancialCollectionTypeCode: Código do Tipo de Cobrança que será definido para a negociação. A API irá seguir as mesmas regras do CRM - Voalle, assim, aceitando o mesmo Tipo de Cobrança em tela.
\ncontractDateManagementCode: Código do Ciclo de faturamento que será definido para a negociação. A API irá seguir as mesmas regras do CRM - Voalle, assim, aceitando o mesmo Ciclo de faturamento em tela. Será esse a prioridade para definir o vencimento, ignorando o campo do Dia de Cobrança.
\nresidenceTypeCode: Código do tipo de residência do cliente. Será obrigatório conforme parametrizado no CRM.
\npaymentFormCode: Código da Forma de pagamento, para encontrar especificamente qual serviço da lista de preço será incluído. Caso não enviado, irá pegar o primeiro serviço encontrado.
\namount: Valor do serviço a ser incluído na negociação, caso não enviado, será utilizado o padrão e, quando enviado, será validado se é maior do que o valor mínimo estipulado na lista de preço. Caso o serviço use fidelização, será utilizado o valor da fidelização e ignorado esse campo.
\nstreetType:
\n1 - Alameda
\n2 - Aeroporto
\n3 - Área
\n4 - Avenida
\n5 - Campo
\n6 - Chácara
\n7 - Colônia
\n8 - Condomínio
\n9 - Conjunto
\n10 - Distrito
\n11 - Esplanada
\n12 - Estação
\n13 - Estrada
\n14 - Favela
\n15 - Fazenda
\n16 - Feira
\n17 - Jardim
\n18 - Ladeira
\n19 - Lago
\n20 - Lagoa
\n21 - Largo
\n22 - Loteamento
\n23 - Morro
\n24 - Núcleo
\n25 - Parque
\n26 - Passarela
\n27 - Pátio
\n28 - Praça
\n29 - Quadra
\n30 - Recanto
\n31 - Residencial
\n32 - Rua
\n33 - Rodovia
\n34 - Setor
\n35 - Sítio
\n36 - Travessa
\n37 - Trecho
\n38 - Trevo
\n39 - Vale
\n40 - Vereda
\n41 - Via
\n42 - Viaduto
\n43 - Viela
\n44 - Vila
\nPara a criação de um contrato com serviço STFC, deve ser informado um número de telefone para o vínculo com o item de contrato, sendo que:
\nO número enviado deve existir cadastrado no Grupo de Telefone identificado no campo phoneGroupId; O valor a ser inserindo no campo phoneGroupId é o seu ID Público. Esta informação é exibida nos detalhes do registro.
\nCaso seja uma portabilidade e o número não existir, o número enviado será cadastrado no GRupo de Telefone identificado no campo phoneGroupId;
\nphoneNumberType (Tipos de telefone):
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","crm","startsale"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"7a098346-c352-4817-96a9-d6538432a467","name":"Nova negociação","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"txId\": \"string\",\r\n \"companyPlaceTxId\": \"string\",\r\n \"thirdSellerTxId\": \"string\",\r\n \"contractType\": \"string\",\r\n \"crmCampaignCode\": \"string\",\r\n \"crmPriceListCode\": \"string\",\r\n \"contractPaymentFormCode\": \"string\",\r\n \"contractFinancialCollectionTypeCode\": \"string\",\r\n \"contractDateManagementCode\": \"string\",\r\n \"contractCollectionDay\": \"string\",\r\n \"activationIncidentTypeCode\": \"string\",\r\n \"activationGroupInMonthlyFee\": true,\r\n \"activationFirstParcelDate\": \"2025-12-12\",\r\n \"activationPaymentFormCode\": \"string\",\r\n \"activationFinancialCollectionTypeCode\": \"string\",\r\n \"activationPaymentConditionCode\": \"string\",\r\n \"serviceProducts\": [\r\n {\r\n \"code\": \"string\",\r\n \"quantity\": 0,\r\n \"amount\": 0.0,\r\n \"paymentFormCode\": \"string\"\r\n }\r\n ],\r\n \"clientSaleInfo\": {\r\n \"name\": \"string\",\r\n \"typeTxId\": 0,\r\n \"phone\": \"string\",\r\n \"cellPhone1\": \"string\",\r\n \"email\": \"string\",\r\n \"emailNfe\": \"string\",\r\n \"birthDate\": \"2024-02-09\",\r\n \"gender\": null,\r\n \"civilStatus\": null,\r\n \"identity\": \"string\",\r\n \"parentsName\": \"string\",\r\n \"stateRegistration\": \"string\",\r\n \"municipalRegistration\": \"string\",\r\n \"stateRegistrationType\": 0,\r\n \"addressSaleInfo\": {\r\n \"postalCode\": \"string\",\r\n \"street\": \"string\",\r\n \"streetType\": 0,\r\n \"number\": \"string\",\r\n \"neighborhood\": \"string\",\r\n \"state\": \"string\",\r\n \"city\": \"string\",\r\n \"addressComplement\": \"string\",\r\n \"addressReference\": \"string\",\r\n \"residenceTypeCode\": \"string\"\r\n }\r\n },\r\n \"observations\": \"string\",\r\n \"gainInformation\": {\r\n \"crmOpportunityReasonCode\": \"string\",\r\n \"contactForm\": \"string\",\r\n \"reportDescription\": \"string\",\r\n \"automatic\": true\r\n },\r\n \"activationInformation\": {\r\n \"teamCode\": \"string\",\r\n \"description\": \"string\",\r\n \"catalogServiceCode\": \"string\",\r\n \"categoryMatrixCode\": \"string\"\r\n },\r\n \"integratorInformation\": {\r\n \"integratorIdentification\": \"string\",\r\n \"negotiationId\": \"string\",\r\n \"viabilityId\": 0,\r\n \"contacts\": [\r\n {\r\n \"name\": \"string\",\r\n \"typeTxId\": 0,\r\n \"txId\": \"string\",\r\n \"email\": \"string\",\r\n \"phone\": \"string\",\r\n \"crmFunctionCode\": \"string\",\r\n \"classification\": \"string\",\r\n \"order\": \"string\",\r\n \"isSigner\": true\r\n }\r\n ]\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"htps://erp.cliente.com.br:45715/external/integrations/thirdparty/crm/startsale"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"protocolId\": 123456\n },\n \"dataResponseType\": \"ReturnMessageInfo\",\n \"elapsedTime\": null\n}"}],"_postman_id":"a1f669c1-a913-4c20-8f56-7d0e9abaeca0"},{"name":"Incluir serviço no contrato","id":"904d5e0b-4619-4961-befe-4074af662b96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"contractNumber\": \"string\", // Número do contrato\n \"crmCampaignCode\": \"string\", // Código da campanha. Obrigatório para quem utiliza CRM Voalle\n \"crmPriceListCode\": \"string\", // Código da lista de preço. Obrigatório para quem utiliza CRM Voalle\n \"generateProportionality\": false, // Gera valor promocional. true - Sim, false = Não\n \"newServices\": [\n {\n \"code\": \"string\", // Código do serviço\n \"quantity\": 0, // Quantidade do serviço\n \"price\": 10.0, // Preço de venda\n \"paymentFormCode\": \"string\", // Código da forma de pagamento\n \"serviceTagOption\": 0, // Opção de gerar etiqueta\n \"contractServiceTag\": \"string\", // Etiqueta existente\n \"contractServiceTagDescription\": \"string\", // Nova etiqueta\n \"phoneGroupId\": \"string\", // Id publico do grupo de telefone\n \"phoneNumberInformations\": [\n {\n \"phoneNumber\": \"55999999999\", // Número a ser vinculado ao item de contrato\n \"phoneNumberType\": 0, // Tipo de número 0 - Fixo, 1 - Celular, 2 - Outro\n \"isPortability\": true // Identifica se é uma portabilidade ou não\n }\n ]\n }\n ]\n}"},"url":"{{URL}}:45715/external/integrations/thirdparty/contract/addcontractservices","description":"serviceTagOption
\n| Opção de geração da etiqueta | Ação |
| 0 | Não Vincula Etiqueta |
| 1 | Gera Nova Etiqueta |
| 2 | Utiliza Etiqueta Existente |
| 3 | Utiliza Etiqueta Existente e Atualiza Descrição |
Para a inclusão de um serviço STFC, deve ser informado um número de telefone para ser vinculado ao item de contrato, sendo que:
\nO número enviado deve existir cadastrado no Grupo de Telefone identificado no campo phoneGroupId;
\nCaso seja uma portabilidade e o número não existir, o número enviado será cadastrado no GRupo de Telefone identificado no campo phoneGroupId;
\nphoneNumberType
\n| Tipo de telefone | Descrição | Regra |
| 0 | Fixo | DDD + 8 dígitos |
| 1 | Celular | DDD + 9 dígitos |
| 2 | Outro | 11 dígitos |
serviceTagOption
\n| Opção de geração da etiqueta | Ação |
| 0 | Não Vincula Etiqueta |
| 1 | Gera Nova Etiqueta |
| 2 | Utiliza Etiqueta Existente |
| 3 | Utiliza Etiqueta Existente e Atualiza Descrição |
Para a inclusão de um serviço STFC, deve ser informado um número de telefone para ser vinculado ao item de contrato, sendo que:
\nO número enviado deve existir cadastrado no Grupo de Telefone identificado no campo phoneGroupId;
\nCaso seja uma portabilidade e o número não existir, o número enviado será cadastrado no GRupo de Telefone identificado no campo phoneGroupId;
\nphoneNumberType
\n| Tipo de telefone | Descrição | Regra |
| 0 | Fixo | DDD + 8 dígitos |
| 1 | Celular | DDD + 9 dígitos |
| 2 | Outro | 11 dígitos |
Através do CPF/CNPJ será validado se já existe um cliente cadastrado no ERP ou se é necessário cadastrar um novo.
\nCaso não enviada a descrição do contrato, será gerado no padrão Contrato {número} - {Tipo de contrato} - {Nome do Cliente}
\nCaso não seja enviado o campo Meses de duração, será assumido o valor parametrizado no tipo de contrato.
\nOs ciclos de cobrança só serão aceitos quando forem vinculados ao tipo de contrato enviado.
\nO bloqueio automático e notificação de faturamento por padrão, caso não informados, serão assumidos como true (Sim).
\nCaso não informado o campo Tipo de faturamento especial será usado o padrão “Tipo Padrão”.
\nOs tipos de contratos permitidos serão os mesmos configurados no cadastro de Locais.
\nOs serviços (servicesInformation), são uma lista, ou seja, podem ser enviados diversos serviços.
\nOs campos expirationDocket, collectionDay e cutDay apenas serão obrigatórios caso não seja enviado o campo contractDateManagementCode. Caso seja enviado na API, deve ser considerado os campos do ciclo de faturamento do ERP.
\nOs serviços serão aceitos caso estejam no Tipo de contrato enviado.
\nSão aceitos apenas serviços SVA e de internet.
\nCaso não seja informado o estágio do contrato (contractStage), será gerado o contrato conforme o parâmetro do CRM.
\nPara que a solicitação caia no fluxo do Field Service Management, é obrigatório o uso de Matrizes na categorização do protocolo (matrixCode).
\nSerá validado se o campo solicitationTypeCode da ativação tem permissão para abertura de protocolo no local do contrato, com base no companyPlaceTxId, caso não, será impedido a abertura do protocolo de ativação, assim como, no uso de matrizes, se para a matriz enviada não for permitido o tipo de solicitação enviado.
\nO solicitationTypeCode deve ser referente ao Tipo de Solicitação Externa, caso contrário, irá retornar a mensagem: \"A solicitação de ativação exige um tipo de solicitação do tipo Externo.\"
\nCódigo dos Tipos de Clientes do contrato
\nCódigo dos Tipos de Logradouro
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","contract","removecontractitems"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"b510d0f2-fd1d-4f25-be07-963dc43d7531","name":"Remover serviço no contrato - Sucesso","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"contractNumber\": \"123\",\n \"removeService\": [\n {\n \"contractItem\": 897\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/contract/removecontractitems"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Sucess\": true,\n \"Message\": \"Remoção de serviço realizada com sucesso.\"\n}"},{"id":"bbce031f-b999-41a8-b5be-3be66862e573","name":"Remover serviço no contrato - Erro - EM CONSTRUÇÃO","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"contractNumber\": \"123\",\n \"removeService\": [\n {\n \"contractItem\": 897\n },\n {\n \"contractItem\": 654\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/contract/removecontractitems"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"Sucess\": false,\n \"Message\": \"Não foi possível remover o serviço no contrato, contrato possui pendências financeiras .\"\n}\n"}],"_postman_id":"4c467f4f-a89c-471c-ad30-8838471033c8"},{"name":"Consulta viabilidade - via integração com mapas","id":"cddd65da-a6bc-449f-94b1-37d345ef0218","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":"{\r\n \"fullAddress\": {\r\n \"address\": \"string\", //Endereço\r\n \"number\": \"string\", //Número\r\n \"neighborhood\": \"string\", // Bairro\r\n \"city\": \"string\", // Cidade\r\n \"state\": \"string\", // Estado\r\n \"postalCode\": \"string\" // CEP\r\n },\r\n \"distance\": \"string\", // Raio para consulta\r\n //informações adicionais não obrigatórias\r\n \"lead\": { // Informações do Lead na integradora\r\n \"id\": \"string\",\r\n \"name\": \"string\", // Nome do cliente\r\n \"txIdType\": \"string\", // 1-CPF e 2-CNPJ\r\n \"txId\": \"string\", // CPF/CNPJ\r\n \"phone\": \"string\" // Telefone\r\n },\r\n \"seller\": { // Informações do vendedor na integradora\r\n \"id\": \"string\", \r\n \"name\": \"string\", // Nome do vendedor\r\n \"txIdType\": \"string\", // 1-CPF e 2-CNPJ\r\n \"txId\": \"string\", // CPF/CNPJ\r\n \"phone\": \"string\" // Telefone\r\n },\r\n \"campaign\": { // Informações da campanha na integradora\r\n \"id\": \"string\", // Id da campanha\r\n \"description\": \"string\" // Descrição\r\n }\r\n}"},"url":"{{URL}}:45715/external/integrations/thirdparty/verifyviability","description":"Através desse método é possível realizar, via integração com um sistema de documentação de redes, a viabilidade técnica para um determinado endereço.
\nNesse modelo o ERP irá ser uma ponte entre o sistema terceiro que está realizando a requisição e o sistema de documentação de rede integrado ao ERP Voalle, dando em sua resposta a informação de se há viabilidade técnica e quantas portas disponíveis.
\nNa API de gerar negociação também existe um campo para identificar o registro da consulta de viabilidade, que será vinculado a negociação para identificar se a consulta de viabilidade foi convertida em uma nova venda.
\nOs registros de viabilidade são encontrados na rotina CRM Voalle / Operações / Dashboard - Gerente, menu Acompanhamento - Consulta de Viabilidade.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","verifyviability"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"8d3df6fd-bc5b-4b3b-a904-58ae4fc405e2","name":"Nova negociação","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"fullAddress\": {\r\n \"address\": \"Rua de teste\",\r\n \"number\": \"1000\",\r\n \"neighborhood\": \"Centro\",\r\n \"city\": \"Santa Maria\",\r\n \"state\": \"RS\",\r\n \"postalCode\": \"97050-001\"\r\n },\r\n \"distance\": 300,\r\n \"lead\": {\r\n \"id\": 11111,\r\n \"name\": \"Lead de teste\",\r\n \"txidtype\": \"1\",\r\n \"txid\": \"999.999.999-99\",\r\n \"phone\": \"99999999999\"\r\n },\r\n \"campaign\": {\r\n \"id\": \"99999\",\r\n \"description\": \"Campanha de teste\"\r\n },\r\n \"seller\": {\r\n \"id\": \"123\",\r\n \"name\": \"Vendedor de teste\",\r\n \"txidtype\": \"1\",\r\n \"txid\": \"999.999.999-99\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"htps://erp.cliente.com.br:45715/external/integrations/thirdparty/verifyviability"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true, \n \"messages\": null,\n \"response\": {\n \"viability\": true, // Indica que existe viabilidade para o endereço informado dentro da distância enviada\n \"ctos\": 37, // Número de CTP's na área\n \"ports\": 11 // Número de portas disponíves\n },\n \"dataResponseType\": \"<>f__AnonymousType760`3\",\n \"elapsedTime\": null\n}"}],"_postman_id":"cddd65da-a6bc-449f-94b1-37d345ef0218"},{"name":"Cancela Negociação","id":"63bbd6a1-648c-4947-8f1f-2759e2e57fc8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json-patch+json"}],"body":{"mode":"raw","raw":"{ \n \"protocolId\": 0, \n \"description\": \"string\"\n}"},"url":"{{URL}}:45715/external/integrations/thirdparty/crm/cancelsale","description":"Método para cancelamento da negociação.
\nRegras:
\nMétodo que retorna os tipos de contratos e seus respectivos serviços.
\nPara que os tipos de contratos sejam disponibilizados neste método é necessário que:
\nLembrando que, para que o serviço seja válido para o start de venda é necessário que:
\nBusca as campanhas de negociação e os serviços da lista de preço atrelada a ela.
\nValores possíveis para o campo campaignPriceListProductServices**.Type**
\nValores possíveis para o campo campaignPriceListProductServices.use
\nValores possíveis para o campo campaignPriceListProductServices.priceListUseType
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","crm","campaignsandpricelistservices"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"eedfd0a2-0cc6-4603-bf3b-3dd26050053e","name":"Consulta Campanhas e Serviços","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/crm/campaignsandpricelistservices"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": [\n {\n \"code\": \"2\",\n \"title\": \"Campanha Teste API\",\n \"description\": \"Campanha para testes de venda via API\",\n \"objective\": \"Testes\",\n \"status\": \"Em Execução\",\n \"beginningDate\": \"2022-08-24T00:00:00\",\n \"finalDate\": \"2025-08-27T00:00:00\",\n \"campaignRegions\": [\n {\n \"id\": 1,\n \"code\": \"1.01\",\n \"title\": \"Região Central\",\n \"description\": \"Região Central do Estado do RS\",\n \"campaignRegionCities\": [\n {\n \"code\": 4316907,\n \"name\": \"Santa Maria\",\n \"state\": \"RS\"\n }\n ]\n }\n ],\n \"campaignPriceList\": [\n {\n \"id\": 1,\n \"code\": \"321\",\n \"title\": \"L.P. PADRAO \",\n \"description\": \"Lista de preço padrão\",\n \"campaignPriceListProductServices\": [\n {\n \"code\": \"00018\",\n \"title\": \"Serviço 1\",\n \"description\": \"\",\n \"sellingPrice\": 5.00,\n \"type\": 1,\n \"use\": \"A\",\n \"priceListUseType\": \"V\",\n \"MinimumPromotionalPrice\": \"\",\n \"LoyaltyPrice\": \"\",\n \"MonthDurationLoyalty\": 0,\n \"IsLoyalty\": 0,\n \"PaymentFormCode\": \"\",\n \"PaymentFormTitle\": \"\"\n },\n {\n \"code\": \"00014\",\n \"title\": \"Serviço 2\",\n \"description\": \"\",\n \"sellingPrice\": 10.0,\n \"type\": 2,\n \"use\": \"R\",\n \"priceListUseType\": \"T\"\n },\n {\n \"code\": \"00028\",\n \"title\": \"Serviço 3\",\n \"description\": \"\",\n \"sellingPrice\": 29.9,\n \"type\": 3,\n \"use\": \"P\",\n \"priceListUseType\": \"A\"\n },\n {\n \"code\": \"0045\",\n \"title\": \"Combo 4\",\n \"description\": null,\n \"sellingPrice\": 0.02,\n \"type\": 4,\n \"use\": \"A\",\n \"priceListUseType\": \"A\"\n },\n {\n \"code\": \"00043\",\n \"title\": \"Serviço 5\",\n \"description\": \"\",\n \"sellingPrice\": 0.01,\n \"type\": 5, \n \"use\": \"P\",\n \"priceListUseType\": \"T\"\n }\n ]\n }\n ]\n }\n ],\n \"dataResponseType\": \"ListAPI's que possibilitam a criação de Lead e a geração de uma negociação no CRM Voalle.
\nPara que a negociação seja aberta corretamente deve-se atentar para as seguintes regras:
\nToken obtido no método de autenticação
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}:45715/external/integrations/thirdparty/projects/getsolicitationdata?assignmentId={{assignmentId}}&protocol={{protocol}}","description":"Busca as informações gerais de uma determinada solicitação.
\nID do protocolo
\n","type":"text/plain"},"key":"assignmentId","value":"{{assignmentId}}"},{"description":{"content":"Número do protocolo
\n","type":"text/plain"},"key":"protocol","value":"{{protocol}}"}],"variable":[]}},"response":[{"id":"6eb0f120-3a12-46f7-93e0-b243c03ce0cc","name":"Busca os detalhes da solicitação - busca pelo numero do protocolo","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer","description":"Token obtido no método de autenticação","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"httpd://erp.cliente.com.br:45715/external/integrations/thirdparty/projects/getsolicitationdata?protocol=123","protocol":"httpd","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","projects","getsolicitationdata"],"query":[{"key":"assignmentId","value":"","description":"ID do protocolo","disabled":true},{"key":"protocol","value":"123","description":"Número do protocolo"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"protocol\": 484,\n \"assignmentId\": 493,\n \"incidentTypeId\": 21,\n \"incidentType\": {\n \"id\": 21,\n \"title\": \"Atendimento\"\n },\n \"incidentStatusId\": 1,\n \"incidentStatus\": {\n \"id\": 1,\n \"title\": \"Abertura\"\n },\n \"requestorId\": 116,\n \"requestor\": {\n \"id\": 116,\n \"name\": \"Teste\",\n \"name2\": \"Teste\"\n },\n \"clientId\": 116,\n \"client\": {\n \"id\": 116,\n \"name\": \"Teste\",\n \"name2\": \"Teste\"\n },\n \"beginningDate\": \"2022-08-01T17:22:17.650367\",\n \"finalDate\": \"2022-08-01T17:37:17.65037\",\n \"criticity\": 8,\n \"contractServiceTagId\": 273,\n \"contractServiceTag\": {\n \"id\": 273,\n \"title\": \"Serviço de Internet - SCM - 10Mega\",\n \"serviceTag\": \"ABCDE123\"\n },\n \"catalogServiceId\": null,\n \"catalogService\": null,\n \"catalogServiceItemId\": null,\n \"catalogServiceItem\": null,\n \"catalogServiceItemClassId\": null,\n \"catalogServiceItemClass\": null,\n \"sectorAreaId\": 2,\n \"sectorArea\": {\n \"id\": 2,\n \"title\": \"Técnica\"\n },\n \"teamId\": 3,\n \"team\": {\n \"id\": 3,\n \"title\": \"Suporte\"\n },\n \"responsibleId\": 101,\n \"responsible\": {\n \"id\": 101,\n \"name\": \"Suporte à Clientes\",\n \"name2\": \"Teste\"\n },\n \"companyPlaceId\": 1,\n \"companyPlace\": {\n \"id\": 1,\n \"description\": \"EMPRESA\"\n }\n },\n \"dataResponseType\": \"<>f__AnonymousType1021`29\",\n \"elapsedTime\": null\n}"},{"id":"491fed1d-5ed3-4698-8669-b2cf8af9f38f","name":"Busca os detalhes da solicitação - busca pelo ID do protocolo","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer","description":"Token obtido no método de autenticação","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/projects/getsolicitationdata?assignmentId=321","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","projects","getsolicitationdata"],"query":[{"key":"assignmentId","value":"321","description":"ID do protocolo"},{"key":"protocol","value":"","description":"Número do protocolo","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"protocol\": 484,\n \"assignmentId\": 493,\n \"incidentTypeId\": 21,\n \"incidentType\": {\n \"id\": 21,\n \"title\": \"Atendimento\"\n },\n \"incidentStatusId\": 1,\n \"incidentStatus\": {\n \"id\": 1,\n \"title\": \"Abertura\"\n },\n \"requestorId\": 116,\n \"requestor\": {\n \"id\": 116,\n \"name\": \"Teste\",\n \"name2\": \"Teste\"\n },\n \"clientId\": 116,\n \"client\": {\n \"id\": 116,\n \"name\": \"Teste\",\n \"name2\": \"Teste\"\n },\n \"beginningDate\": \"2022-08-01T17:22:17.650367\",\n \"finalDate\": \"2022-08-01T17:37:17.65037\",\n \"criticity\": 8,\n \"contractServiceTagId\": 273,\n \"contractServiceTag\": {\n \"id\": 273,\n \"title\": \"Serviço de Internet - SCM - 10Mega\",\n \"serviceTag\": \"ABCDE123\"\n },\n \"catalogServiceId\": null,\n \"catalogService\": null,\n \"catalogServiceItemId\": null,\n \"catalogServiceItem\": null,\n \"catalogServiceItemClassId\": null,\n \"catalogServiceItemClass\": null,\n \"sectorAreaId\": 2,\n \"sectorArea\": {\n \"id\": 2,\n \"title\": \"Técnica\"\n },\n \"teamId\": 3,\n \"team\": {\n \"id\": 3,\n \"title\": \"Suporte\"\n },\n \"responsibleId\": 101,\n \"responsible\": {\n \"id\": 101,\n \"name\": \"Suporte à Clientes\",\n \"name2\": \"Teste\"\n },\n \"companyPlaceId\": 1,\n \"companyPlace\": {\n \"id\": 1,\n \"description\": \"EMPRESA\"\n }\n },\n \"dataResponseType\": \"<>f__AnonymousType1021`29\",\n \"elapsedTime\": null\n}"}],"_postman_id":"afaeb435-6af5-4f9d-a024-b157e342c943"},{"name":"Busca Relatos por Solicitação","id":"1c08635e-632c-4a78-8647-6d872b2037b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/getsolicitationhistory?assignmentId={{idDaSolicitacao}}","description":"Busca a lista de relatos de uma determinada solicitação.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","getsolicitationhistory"],"host":["{{URL}}"],"query":[{"key":"assignmentId","value":"{{idDaSolicitacao}}"}],"variable":[]}},"response":[{"id":"b7c2283c-87a3-4d6b-9eff-e96375d497d7","name":"Busca Relatos por Solicitação","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/getsolicitationhistory?assignmentId=XXXXXXXX","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","getsolicitationhistory"],"query":[{"key":"assignmentId","value":"XXXXXXXX"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"[\n {\n \"typeOperation\": 1,\n \"id\": 123456,\n \"title\": \"Atendimento de Solicitação - Primeiro Relato\",\n \"description\": \"\\r\\nContato: XXX \\r\\nFone 1: XXXXXXXXXX\\r\\nAssinante: XXXXXXXXXXXXX \\r\\nAtendente: XXXXXXX\\r\\n\\r\\n- Situação normalizada durante o atendimento. \\r\\n\\r\\nATENDIMENTO ENCERRADO.\",\n \"beginningDate\": \"2017-12-13T07:53:51\",\n \"finalDate\": \"2017-12-13T07:56:20\",\n \"private\": false,\n \"personId\": 123,\n \"person\": {\n \"id\": 123,\n \"name\": \"XXXXXX\"\n },\n \"teamId\":321,\n \"team\": {\n \"id\": 321,\n \"name\": \"XXXXX\"\n }\n }\n]"}],"_postman_id":"1c08635e-632c-4a78-8647-6d872b2037b8"},{"name":"Lista Solicitações por Cliente","id":"7fdbd11c-06af-4ab1-ba88-5cda5e49ad42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/solicitationlist/{{clientId}}?allAssignments={{True/False}}","description":"Lista as solicitações de um cliente.
\nQuando o parametro allAssignments não é enviado ou é enviado como False traz apenas as solicitações em aberto do cliente. Quando enviado como True, traz todas as solicitações do cliente, independente do status.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","solicitationlist","{{clientId}}"],"host":["{{URL}}"],"query":[{"key":"allAssignments","value":"{{True/False}}"}],"variable":[]}},"response":[{"id":"f6d6cdb3-29a8-45d5-ad33-5852c7263b61","name":"Lista Solicitações por Cliente","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/solicitationlist/000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"status\": \"OK\",\n \"count\": 1,\n \"data\": [\n {\n \"assignmentId\": 123456,\n \"title\": \"Solicitação\",\n \"protocol\": 123456,\n \"status\": \"Abertura\",\n \"team\": \"Comercial\",\n \"sectorArea\": \"Negócio\",\n \"beginningData\": \"2021-07-02T08:52:04\",\n \"finalData\": \"2021-07-02T10:31:00\"\n }\n ]\n },\n \"dataResponseType\": \"ListToken obtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/incidenttypespaged?Page={{page}}&PageSize={{page_size}}&Filter={{filter}}&OrderBy={{order_by}}&incident={{true/false}}&onlyWithUser={{true/false}}&changeServiceIncidentTypes={{true/false}}","description":"Método que retorna a lista paginada dos tipos de solicitação cadastrados na rotina na rotina Serviço / Cadastros / Solicitações - Tipos.
\nAo acessar o tipo de solicitação, ou realizar o cadastro, no menu \"Parâmetros\" aba \"Abertura Solicitação\" encontram-se os itens a serem parametrizados para a abertura de uma nova solicitação.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","incidenttypespaged"],"host":["{{URL}}"],"query":[{"description":{"content":"Quantidade de Páginas
\n","type":"text/plain"},"key":"Page","value":"{{page}}"},{"description":{"content":"Quantidade de itens por página
\n","type":"text/plain"},"key":"PageSize","value":"{{page_size}}"},{"description":{"content":"Filtros (Opcional)
\n","type":"text/plain"},"key":"Filter","value":"{{filter}}"},{"description":{"content":"Ordenação (Opcional)
\n","type":"text/plain"},"key":"OrderBy","value":"{{order_by}}"},{"description":{"content":"Verifica se a solicitação possui agendamento. Os agendamentos são parametrizados na rotina “Service Desk / Utilitários / Solicitação - Agendamento”.
\n","type":"text/plain"},"key":"incident","value":"{{true/false}}"},{"description":{"content":"Apenas tipos de solicitações em que o usuário logado faz parte da equipe.
\n","type":"text/plain"},"key":"onlyWithUser","value":"{{true/false}}"},{"description":{"content":"Filtrar apenas solicitações para troca de serviço.
\n","type":"text/plain"},"key":"changeServiceIncidentTypes","value":"{{true/false}}"}],"variable":[]}},"response":[{"id":"e54d0abc-6a7c-4b9f-b1d2-707b21444ffa","name":"Tipos de Solicitação","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/incidenttypespaged?Page=1&PageSize=10&Filter={{filter}}&OrderBy={{order_by}}&incident=false&onlyWithUser=false&changeServiceIncidentTypes=false","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","incidenttypespaged"],"query":[{"key":"Page","value":"1"},{"key":"PageSize","value":"10"},{"key":"Filter","value":"{{filter}}"},{"key":"OrderBy","value":"{{order_by}}"},{"key":"incident","value":"false"},{"key":"onlyWithUser","value":"false"},{"key":"changeServiceIncidentTypes","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"activationType\": false,\n \"id\": 11,\n \"code\": \"1.1.01\",\n \"classRequires\": false,\n \"allCatalogs\": 0,\n \"title\": \"Pessoal - Contratração\",\n \"beginningChecklist\": null,\n \"requiresCatalogService\": 0,\n \"teamId\": 7,\n \"solicitationType\": 2,\n \"solicitationTypeDescription\": \"Interna\",\n \"requiresCatalogServicesItem\": false,\n \"forceRequestor\": false,\n \"requiresLabel\": false,\n \"availableSla\": [],\n \"tagRequires\": false,\n \"hasProcess\": false,\n \"active\": true,\n \"defaultText\": \"Criação de Usuário Novo Para Funcionário Novo \\r\\n\\r\\nNome do Funcionário: \\r\\n\\r\\n Sistema ERP Voalle \\r\\n E-mail / AD - \\r\\n Biometria Portão \\r\\n Usuário Sistema\",\n \"appOpeningStatusId\": 9\n },\n {\n \"activationType\": false,\n \"id\": 12,\n \"code\": \"1.1.02\",\n \"classRequires\": false,\n \"allCatalogs\": 0,\n \"title\": \"Pessoal - Desligamento\",\n \"beginningChecklist\": null,\n \"requiresCatalogService\": 0,\n \"teamId\": 7,\n \"solicitationType\": 2,\n \"solicitationTypeDescription\": \"Interna\",\n \"requiresCatalogServicesItem\": false,\n \"forceRequestor\": false,\n \"requiresLabel\": false,\n \"availableSla\": [],\n \"tagRequires\": false,\n \"hasProcess\": false,\n \"active\": true,\n \"defaultText\": \"Bloqueio Acessos do Funcionário :\\r\\n\\r\\nNome do Funcionário: \\r\\n\\r\\nBloquear Sistema ERP Voalle \\r\\nBloquear E-mail / AD - \\r\\nBloqueio Biometria Portão \\r\\nBloquear Usuário Sistema\",\n \"appOpeningStatusId\": 9\n },\n {\n \"activationType\": false,\n \"id\": 13,\n \"code\": \"1.2.11\",\n \"classRequires\": false,\n \"allCatalogs\": 0,\n \"title\": \"Contratos - Upgrade\",\n \"beginningChecklist\": null,\n \"requiresCatalogService\": 0,\n \"teamId\": 8,\n \"solicitationType\": 1,\n \"solicitationTypeDescription\": \"Externa\",\n \"requiresCatalogServicesItem\": false,\n \"forceRequestor\": false,\n \"requiresLabel\": true,\n \"availableSla\": [],\n \"tagRequires\": true,\n \"hasProcess\": false,\n \"active\": true,\n \"defaultText\": \"\",\n \"appOpeningStatusId\": 9\n }\n ]\n }\n}"}],"_postman_id":"4b48dda0-70e4-4946-93ec-6a97d3d23092"},{"name":"Lista SLAs por tipo de solicitação","id":"ad2796eb-4a30-482a-8c60-eaa33b0ade40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{url_do_ERP}}:45715/external/integrations/thirdparty/servicelevelagreementpaged?incidentTypeId={{incidentTypeId}}&Page={{page}}&PageSize={{pageSIze}}&Filter={{filter}}&OrderBy={{orderBy}}","description":"Lista paginada dos SLAs das solicitações.
\nCaso seja informado o ID de uma solicitação no parâmetro \"incidentTypeId\", são retornadas as informações do SLA para este tipo de solicitação.
\nCaso não seja informado o ID de uma solicitação, são retornadas as informações dos tipos de SLAs disponíveis. No ERP essa informação pode ser verificada na rotina \"Service Desk / Cadastros / Situações de Solicitações\"
\nID do tipo de solicitação
\n","type":"text/plain"},"key":"incidentTypeId","value":"{{incidentTypeId}}"},{"description":{"content":"Quantidade de páginas
\n","type":"text/plain"},"key":"Page","value":"{{page}}"},{"description":{"content":"Quantidade de itens por página
\n","type":"text/plain"},"key":"PageSize","value":"{{pageSIze}}"},{"description":{"content":"Filtro
\n","type":"text/plain"},"key":"Filter","value":"{{filter}}"},{"description":{"content":"Ordenação
\n","type":"text/plain"},"key":"OrderBy","value":"{{orderBy}}"}],"variable":[]}},"response":[{"id":"d43477be-2186-4687-8e06-3632aeeb4369","name":"Lista SLAs das Solicitações - Informando um tipo de solicitação","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação"}],"url":{"raw":"https://erp.cliente.com,br:45715/external/integrations/thirdparty/servicelevelagreementpaged?incidentTypeId=1133&Page=&PageSize=&Filter=&OrderBy=","protocol":"https","host":["erp","cliente","com,br"],"port":"45715","path":["external","integrations","thirdparty","servicelevelagreementpaged"],"query":[{"key":"incidentTypeId","value":"1133","description":"ID do tipo de solicitação"},{"key":"Page","value":"","description":"Quantidade de páginas"},{"key":"PageSize","value":"","description":"Quantidade de itens por página"},{"key":"Filter","value":"","description":"Filtro"},{"key":"OrderBy","value":"","description":"Ordenação"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"active\": true, //Ativo?\n \"clientHours\": 1, //Prazo em horas\n \"clientMinutes\": 30, //Prazo em minutos\n \"code\": \"99\", //Código do SLA\n \"description\": \"Manual\", //Situação\n \"id\": 99, //ID\n \"priority\": { //Prioridade\n \"value\": 0, //Numerador\n \"label\": \"Normal\" //Titulo\n },\n \"title\": \"SLA Manual\", //Titulo do SLA\n \"serviceLevelAgreementTypeId\": 9, //ID do tipo do SLA\n \"serviceLevelAgreementType\": {\n \"id\": 9, //ID dp tipo do sla\n \"title\": \"Manual\" //Titulo\n },\n \"synsuiteCode\": null,\n \"weight\": { //Peso (criticidade) do SLA\n \"value\": 6,\n \"label\": \"6\"\n }\n }\n ],\n \"totalRecords\": 1,\n \"page\": 1,\n \"pageSize\": 10,\n \"totalizers\": null,\n \"totalPages\": 1\n },\n \"dataResponseType\": \"DataPage`1\",\n \"elapsedTime\": null\n}"},{"id":"70cfd0d7-14d4-4561-ae18-cebe6a9249e4","name":"Lista SLAs das Solicitações - SLAs em geral","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/servicelevelagreementpaged?Page=1&PageSize=5&Filter=&OrderBy=","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","servicelevelagreementpaged"],"query":[{"key":"Page","value":"1","description":"Quantidade de páginas"},{"key":"PageSize","value":"5","description":"Quantidade de itens por página"},{"key":"Filter","value":"","description":"Filtro"},{"key":"OrderBy","value":"","description":"Ordenação"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"active\": true, //Ativo?\n \"clientHours\": 4, //Prazo em horas\n \"clientMinutes\": 0, //Prazo em minutos\n \"code\": \"6\", //Código\n \"description\": \"Parado\", //Situação\n \"id\": 6, //ID\n \"priority\": { //Prioridade\n \"value\": 3, //Numerador\n \"label\": \"Urgente\" //Titulo\n },\n \"title\": null, //Titulo do SLA \n \"serviceLevelAgreementTypeId\": 1, //ID do SLA\n \"serviceLevelAgreementType\": {\n \"id\": 1, //ID do SLA\n \"title\": \"24x7\" //Titulo\n },\n \"synsuiteCode\": null,\n \"weight\": { //Peso (Criticidade)\n \"value\": 0,\n \"label\": \"0\"\n }\n },\n {\n \"active\": true,\n \"clientHours\": 48,\n \"clientMinutes\": 0,\n \"code\": \"7\",\n \"description\": \"Prejudicado\",\n \"id\": 7,\n \"priority\": {\n \"value\": 2,\n \"label\": \"Alta\"\n },\n \"title\": null,\n \"serviceLevelAgreementTypeId\": 1,\n \"serviceLevelAgreementType\": {\n \"id\": 1,\n \"title\": \"24x7\"\n },\n \"synsuiteCode\": null,\n \"weight\": {\n \"value\": 0,\n \"label\": \"0\"\n }\n },\n {\n \"active\": true,\n \"clientHours\": 48,\n \"clientMinutes\": 0,\n \"code\": \"8\",\n \"description\": \"Duvida\",\n \"id\": 8,\n \"priority\": {\n \"value\": 1,\n \"label\": \"Média\"\n },\n \"title\": null,\n \"serviceLevelAgreementTypeId\": 1,\n \"serviceLevelAgreementType\": {\n \"id\": 1,\n \"title\": \"24x7\"\n },\n \"synsuiteCode\": null,\n \"weight\": {\n \"value\": 0,\n \"label\": \"0\"\n }\n },\n {\n \"active\": true,\n \"clientHours\": 16,\n \"clientMinutes\": 0,\n \"code\": \"10\",\n \"description\": \"SLA - 16 H PJ\",\n \"id\": 10,\n \"priority\": {\n \"value\": 3,\n \"label\": \"Urgente\"\n },\n \"title\": null,\n \"serviceLevelAgreementTypeId\": 1,\n \"serviceLevelAgreementType\": {\n \"id\": 1,\n \"title\": \"24x7\"\n },\n \"synsuiteCode\": null,\n \"weight\": {\n \"value\": 8,\n \"label\": \"8\"\n }\n },\n {\n \"active\": true,\n \"clientHours\": 168,\n \"clientMinutes\": 0,\n \"code\": \"100\",\n \"description\": \"Solicitação Ativação - SLA 7 dias \",\n \"id\": 100,\n \"priority\": {\n \"value\": 0,\n \"label\": \"Normal\"\n },\n \"title\": null,\n \"serviceLevelAgreementTypeId\": 1,\n \"serviceLevelAgreementType\": {\n \"id\": 1,\n \"title\": \"24x7\"\n },\n \"synsuiteCode\": null,\n \"weight\": {\n \"value\": 10,\n \"label\": \"10\"\n }\n }\n ],\n \"totalRecords\": 16,\n \"page\": 1,\n \"pageSize\": 5,\n \"totalizers\": null,\n \"totalPages\": 4\n },\n \"dataResponseType\": \"DataPage`1\",\n \"elapsedTime\": null\n}"}],"_postman_id":"ad2796eb-4a30-482a-8c60-eaa33b0ade40"},{"name":"Lista Etiquetas, Catalogo, itens e Subitens de Serviço por Cliente/Contrato","id":"f29ac4f6-4fcb-46d7-97d2-5bd132af2505","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação.
\n"}],"url":"{{url_do_ERP}}:45715/external/integrations/thirdparty/servicetagsinfopaged?txId={{CPF/CNPJ}}&Page={{Paginas}}&PageSize={{Itens_por_pagina}}&OrderBy={{OrderBy}}","description":"Endpoint para listagem paginada das informações detalhadas das etiquetas de um cliente. O método retorna todas as etiquetas de um cliente que:
\nJunto com as informações das etiquetas, são retornados seus respectivos catálogos, itens de serviço e subitens de serviço.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","servicetagsinfopaged"],"host":["{{url_do_ERP}}"],"query":[{"key":"txId","value":"{{CPF/CNPJ}}"},{"key":"Page","value":"{{Paginas}}"},{"key":"PageSize","value":"{{Itens_por_pagina}}"},{"key":"OrderBy","value":"{{OrderBy}}"}],"variable":[]}},"response":[{"id":"6e807937-82fa-4389-af44-85e4940fab4d","name":"Lista Etiquetas, catalogo, itens e subitens de serviço","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/servicetagsinfopaged?txId=01234567891&Page=1&PageSize=15&OrderBy=","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","servicetagsinfopaged"],"query":[{"key":"txId","value":"01234567891"},{"key":"Page","value":"1"},{"key":"PageSize","value":"15"},{"key":"OrderBy","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"id\": 123, //ID da Etiqueta\n \"contractId\": 1000, //ID do Contrato\n \"title\": \"FIBER HOME : Com Fidelidade : Promo \", //Titulo\n \"tag\": \"XXXXXXXX\", //Tag da Etiqueta\n \"description\": \"FAMÍLIA 240Mbps com fidelidade\", //Descrição\n \"catalogServices\": []\n },\n {\n \"id\": 1234, //ID da Etiqueta\n \"contractId\": 1000, //ID do Contrato\n \"title\": null, //Titulo\n \"tag\": \"XXXXXXX\", //TAG\n \"description\": \"Teste\", //Descrição\n \"catalogServices\": [ //Catálogo de Serviço\n {\n \"contractServiceTagId\": 1234, //ID da Etiqueta\n \"id\": 1, //ID do catálogo\n \"code\": \"1.01\", //Código\n \"title\": \"Suporte\", //Titulo\n \"shortDescription\": \"Suporte\", //Descrição\n \"serviceType\": 1, //Tipo de Serviço: Hardware = 1 / Software = 2 / Outro = 3\n \"weight\": 5, //Peso (Criticidade)\n \"amountStandard\": 1, //Valor padrão\n \"sectorId\": null,\n \"companyPlace\": { //Local\n \"id\": 1,\n \"code\": \"01\",\n \"description\": \"Testes\",\n \"name\": \"HTEC TELECOMUNICACOES EIRELI\"\n },\n \"serviceLevelAgreement\": { //SLA\n \"id\": 9,\n \"title\": \"Manual\"\n },\n \"sectorArea\": { //Área\n \"id\": 1,\n \"title\": \"Administrativa\"\n },\n \"catalogServiceItems\": [ //Itens de Serviço\n {\n \"catalogServiceId\": 1, //ID do Catálogo\n \"id\": 1, //ID do Item \n \"code\": \"Comercial\", //Código\n \"title\": \"Comercial\", //Titulo\n \"description\": \"Setor responsável por assuntos relacionado a seu fluxo de trabalho\", //DDescrição\n \"weight\": 1, //Peso (Criticidade)\n \"synsuiteCode\": null,\n \"catalogServiceItemClasses\": [ //Subitens de Serviço\n {\n \"catalogServiceItemId\": 1, //ID do Item de Serviço\n \"id\": 1, //ID do Subitem\n \"code\": \"1234\", //Código\n \"title\": \"teste subitem\", //Titulo\n \"description\": \"teste\", //Descrição\n \"weight\": 2, //Peso (Criticidade)\n \"synsuiteCode\": null\n },\n {\n \"catalogServiceItemId\": 1, //ID do Item de Serviço\n \"id\": 2, //ID do Subitem\n \"code\": \"teste 2\", //Código\n \"title\": \"teste 2\", //Título\n \"description\": \"teste\", //Descrição\n \"weight\": 0, //Peso (Criticidade)\n \"synsuiteCode\": null\n }\n ]\n },\n {\n \"catalogServiceId\": 1, //ID do Catálogo\n \"id\": 2, //ID do Item\n \"code\": \"123123\",\n \"title\": \"teste\",\n \"description\": \"teste\",\n \"weight\": 1,\n \"synsuiteCode\": null,\n \"catalogServiceItemClasses\": [ //Subitens de Serviço\n {\n \"catalogServiceItemId\": 2, //ID do Item de Serviço\n \"id\": 1, //ID do Subitem\n \"code\": \"1234\",\n \"title\": \"teste subitem\",\n \"description\": \"teste\",\n \"weight\": 2,\n \"synsuiteCode\": null\n },\n {\n \"catalogServiceItemId\": 2,\n \"id\": 2,\n \"code\": \"teste 2\",\n \"title\": \"teste 2\",\n \"description\": \"teste\",\n \"weight\": 0,\n \"synsuiteCode\": null\n },\n {\n \"catalogServiceItemId\": 2,\n \"id\": 3,\n \"code\": \"teste 3\",\n \"title\": \"teste 3\",\n \"description\": \"teste\",\n \"weight\": 0,\n \"synsuiteCode\": null\n }\n ]\n },\n {\n \"catalogServiceId\": 1,\n \"id\": 3,\n \"code\": \"321\",\n \"title\": \"teste2\",\n \"description\": \"teste\",\n \"weight\": 0,\n \"synsuiteCode\": null,\n \"catalogServiceItemClasses\": [\n {\n \"catalogServiceItemId\": 3,\n \"id\": 4,\n \"code\": \"12345\",\n \"title\": \"teste 4\",\n \"description\": \"teste\",\n \"weight\": 1,\n \"synsuiteCode\": null\n }\n ]\n }\n ]\n }\n ]\n }\n ],\n \"totalRecords\": 2,\n \"page\": 1,\n \"pageSize\": 15,\n \"totalizers\": null,\n \"totalPages\": 1\n },\n \"dataResponseType\": \"DataPage`1\",\n \"elapsedTime\": null\n}"}],"_postman_id":"f29ac4f6-4fcb-46d7-97d2-5bd132af2505"},{"name":"Lista Etiquetas por Cliente/Contrato","id":"66fdb8df-0303-4015-8e65-544f3106f931","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Token obtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/contractservicetagspaged?txId={{tx_id}}&Page={{page}}&PageSize={{page_size}}&Filter={{filter}}&OrderBy={{order_by}}","description":"Método utilizado para obter as etiquetas de serviço disponíveis.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","contractservicetagspaged"],"host":["{{URL}}"],"query":[{"description":{"content":"CPF ou CNPJ
\n","type":"text/plain"},"key":"txId","value":"{{tx_id}}"},{"description":{"content":"Quantidade de páginas
\n","type":"text/plain"},"key":"Page","value":"{{page}}"},{"description":{"content":"Quantidade de itens por página
\n","type":"text/plain"},"key":"PageSize","value":"{{page_size}}"},{"description":{"content":"Filtros (Opcional)
\n","type":"text/plain"},"key":"Filter","value":"{{filter}}"},{"description":{"content":"Ordenação (Opcional)
\n","type":"text/plain"},"key":"OrderBy","value":"{{order_by}}"}],"variable":[]}},"response":[{"id":"2a7f57ea-3a59-485d-9696-57fc0f72520f","name":"Lista Etiquetas Contrato","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/contractservicetagspaged?txId=00000000000&Page=1&PageSize=10&Filter={{filter}}&OrderBy={{order_by}}","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","contractservicetagspaged"],"query":[{"key":"txId","value":"00000000000"},{"key":"Page","value":"1"},{"key":"PageSize","value":"10"},{"key":"Filter","value":"{{filter}}"},{"key":"OrderBy","value":"{{order_by}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"id\": 123456\n },\n {\n \"id\": 0\n },\n {\n \"id\": 111111\n },\n {\n \"id\": 222222\n },\n {\n \"id\": 333333\n },\n {\n \"id\": 444444\n },\n {\n \"id\": 666666\n },\n {\n \"id\": 777777\n },\n {\n \"id\": 888888\n },\n {\n \"id\": 999999\n }\n ],\n \"totalRecords\": 10,\n \"page\": 1,\n \"pageSize\": 10,\n \"totalizers\": null,\n \"totalPages\": 1\n },\n \"dataResponseType\": \"DataPage`1\",\n \"elapsedTime\": null\n}"}],"_postman_id":"66fdb8df-0303-4015-8e65-544f3106f931"},{"name":"Lista Catálogo de Serviços por Etiqueta do Contrato","id":"fda3c720-74af-46a8-b232-29be5e80c7dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Token obtido no métoo de autenticação
\n"}],"url":"{{URL}}:45715/external/integrations/thirdparty/catalogservicespaged?serviceTagId={{service_tag_id}}&Page={{page}}&PageSize={{page_size}}&Filter={{filter}}&OrderBy={{order_by}}","description":"Lista tipo de atendimento disponível para a etiqueta informada.
\nAs etiquetas do contrato são obtidas através do método \"Lista etiqueta de Contrato\"
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","catalogservicespaged"],"host":["{{URL}}"],"query":[{"description":{"content":"Obtido no método \"Lista etiqueta de Contrato\"
\n","type":"text/plain"},"key":"serviceTagId","value":"{{service_tag_id}}"},{"description":{"content":"Quantidade de páginas
\n","type":"text/plain"},"key":"Page","value":"{{page}}"},{"description":{"content":"Quantidade de itens por página
\n","type":"text/plain"},"key":"PageSize","value":"{{page_size}}"},{"description":{"content":"Filtros (Opcional)
\n","type":"text/plain"},"key":"Filter","value":"{{filter}}"},{"description":{"content":"Ordenação (Opcional)
\n","type":"text/plain"},"key":"OrderBy","value":"{{order_by}}"}],"variable":[]}},"response":[{"id":"298435f4-f7c5-4d78-b33c-54be1f458d04","name":"Lista Catálogo de Serviços","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/catalogservicespaged?serviceTagId=123456&Page=1&PageSize=5&Filter={{filter}}&OrderBy={{order_by}}","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","catalogservicespaged"],"query":[{"key":"serviceTagId","value":"123456","description":"Obtido no método \"Lista etiqueta de Contrato\""},{"key":"Page","value":"1"},{"key":"PageSize","value":"5"},{"key":"Filter","value":"{{filter}}"},{"key":"OrderBy","value":"{{order_by}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"id\": \"123456-eeea-11e9-4444-000abcdefg\",\n \"catalogServices\": {\n \"id\": 1,\n \"code\": \"1.01\",\n \"title\": \"Suporte\",\n \"active\": true,\n \"shortDescription\": \"Suporte\",\n \"description\": \"\",\n \"typeService\": 3,\n \"amountStandard\": null,\n \"weight\": 5,\n \"created\": \"2016-04-12T19:15:06\",\n \"modified\": \"2016-04-12T19:15:06\",\n \"companyPlace\": null,\n \"sector\": null,\n \"serviceLevelAgreementType\": {\n \"id\": 2,\n \"title\": \"8x5\"\n },\n \"sectorArea\": null\n }\n }\n ],\n \"totalRecords\": 1,\n \"page\": 1,\n \"pageSize\": 10,\n \"totalizers\": null,\n \"totalPages\": 1\n },\n \"dataResponseType\": \"DataPage`1\",\n \"elapsedTime\": null\n}"}],"_postman_id":"fda3c720-74af-46a8-b232-29be5e80c7dd"},{"name":"Lista Itens do Serviço por Catálogo de Serviço","id":"1417ed7d-1e00-4271-8545-bae2e9fa25d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Token obtido no método de autenticação
\n"}],"url":"{{URL}}:45715/external/integrations/thirdparty/catalogservicesitemspaged?catalogServiceId={{catalog_service_id}}&Page={{page}}&PageSize={{page_size}}&Filter={{filter}}&OrderBy={{order_by}}","description":"Lista os itens do catalogo de serviço informado.
\nOs itens do catálogo é obtido através do método \"Lista Catálogo de Serviços\"
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","catalogservicesitemspaged"],"host":["{{URL}}"],"query":[{"description":{"content":"Obtido no método \"Lista catálogo de serviços\"
\n","type":"text/plain"},"key":"catalogServiceId","value":"{{catalog_service_id}}"},{"description":{"content":"Quantidade de páginas
\n","type":"text/plain"},"key":"Page","value":"{{page}}"},{"description":{"content":"Quantidades de itens por página
\n","type":"text/plain"},"key":"PageSize","value":"{{page_size}}"},{"description":{"content":"Filtros (Opcional)
\n","type":"text/plain"},"key":"Filter","value":"{{filter}}"},{"description":{"content":"Ordenação (Opcional)
\n","type":"text/plain"},"key":"OrderBy","value":"{{order_by}}"}],"variable":[]}},"response":[{"id":"030b5561-af64-4672-b189-b77a8fc9f8cd","name":"Lista Itens de Serviços do Catálogo","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/catalogservicesitemspaged?catalogServiceId=1&Page=1&PageSize=5&Filter={{filter}}&OrderBy={{order_by}}","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","catalogservicesitemspaged"],"query":[{"key":"catalogServiceId","value":"1","description":"Obtido no método \"Lista catálogo de serviços\""},{"key":"Page","value":"1"},{"key":"PageSize","value":"5"},{"key":"Filter","value":"{{filter}}"},{"key":"OrderBy","value":"{{order_by}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"code\": \"123123\",\n \"title\": \"teste\",\n \"active\": true,\n \"weight\": 1,\n \"description\": \"teste\",\n \"id\": 2,\n \"synsuiteCode\": null,\n \"catalogServiceItem\": {\n \"code\": \"123123\",\n \"title\": \"teste\",\n \"active\": true,\n \"weight\": 1,\n \"description\": \"teste\",\n \"id\": 2\n },\n \"catalogServiceIds\": [\n 1\n ]\n }\n ],\n \"totalRecords\": 1,\n \"page\": 1,\n \"pageSize\": 10,\n \"totalizers\": null,\n \"totalPages\": 1\n },\n \"dataResponseType\": \"DataPage`1\",\n \"elapsedTime\": null\n}"}],"_postman_id":"1417ed7d-1e00-4271-8545-bae2e9fa25d8"},{"name":"Lista Subitens do Serviço por Item de Serviço","id":"e7a29346-e3f7-4ed3-a1b4-42ba451293d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Token obtido no método de autenticação
\n"}],"url":"{{URL}}:45715/external/integrations/thirdparty/catalogservicesitemsclassespaged?catalogServiceItemId={{catalog_servic_item_id}}&Filter={{filter}}&OrderBy={{order_by}}","description":"Lista os subitens do catalogo de serviço informado.
\nOs itens do catálogo é obtido através do método \"Lista Itens de Serviços do Catálogo\"
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","catalogservicesitemsclassespaged"],"host":["{{URL}}"],"query":[{"description":{"content":"Obtido no método \"Lista Itens de Serviço do Catálogo\"
\n","type":"text/plain"},"key":"catalogServiceItemId","value":"{{catalog_servic_item_id}}"},{"description":{"content":"Filtros (Opcional)
\n","type":"text/plain"},"key":"Filter","value":"{{filter}}"},{"description":{"content":"Ordenação (Opcional)
\n","type":"text/plain"},"key":"OrderBy","value":"{{order_by}}"}],"variable":[]}},"response":[{"id":"736d85c5-8eac-41df-ada2-9c7184c64351","name":"Lista subitens do item de serviço","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/catalogservicesitemsclassespaged?catalogServiceItemId=2&Filter={{filter}}&OrderBy={{order_by}}","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","catalogservicesitemsclassespaged"],"query":[{"key":"catalogServiceItemId","value":"2"},{"key":"Filter","value":"{{filter}}"},{"key":"OrderBy","value":"{{order_by}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"data\": [\n {\n \"code\": \"1234\",\n \"title\": \"teste subitem\",\n \"active\": true,\n \"weight\": 2,\n \"description\": \"teste\",\n \"id\": 1,\n \"synsuiteCode\": null,\n \"catalogServiceItemClass\": {\n \"code\": \"1234\",\n \"title\": \"teste subitem\",\n \"active\": true,\n \"weight\": 2,\n \"description\": \"teste\",\n \"id\": 1\n },\n \"catalogServicesItemsIds\": [\n 2\n ]\n },\n {\n \"code\": \"teste 2\",\n \"title\": \"teste 2\",\n \"active\": true,\n \"weight\": 0,\n \"description\": \"teste\",\n \"id\": 2,\n \"synsuiteCode\": null,\n \"catalogServiceItemClass\": {\n \"code\": \"teste 2\",\n \"title\": \"teste 2\",\n \"active\": true,\n \"weight\": 0,\n \"description\": \"teste\",\n \"id\": 2\n },\n \"catalogServicesItemsIds\": [\n 2\n ]\n },\n {\n \"code\": \"teste 3\",\n \"title\": \"teste 3\",\n \"active\": true,\n \"weight\": 0,\n \"description\": \"teste\",\n \"id\": 3,\n \"synsuiteCode\": null,\n \"catalogServiceItemClass\": {\n \"code\": \"teste 3\",\n \"title\": \"teste 3\",\n \"active\": true,\n \"weight\": 0,\n \"description\": \"teste\",\n \"id\": 3\n },\n \"catalogServicesItemsIds\": [\n 2\n ]\n }\n ],\n \"totalRecords\": 3,\n \"page\": 1,\n \"pageSize\": 10,\n \"totalizers\": null,\n \"totalPages\": 1\n },\n \"dataResponseType\": \"DataPage`1\",\n \"elapsedTime\": null\n}"}],"_postman_id":"e7a29346-e3f7-4ed3-a1b4-42ba451293d7"},{"name":"Busca de anexos de uma solicitação","id":"40a6c8f5-5b81-4e43-81a0-9a253f429d16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Token obtido no método de autenticação
\n"}],"url":"{{URL}}:45715/external/integrations/thirdparty/projects/assignmentsuploads?protocol={{Número do protocolo}}&pageNumber={{Página}}&pageSize={{Registros por página}}","description":"Lista os subitens do catalogo de serviço informado.
\nOs itens do catálogo é obtido através do método \"Lista Itens de Serviços do Catálogo\"
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","projects","assignmentsuploads"],"host":["{{URL}}"],"query":[{"key":"protocol","value":"{{Número do protocolo}}"},{"key":"pageNumber","value":"{{Página}}"},{"key":"pageSize","value":"{{Registros por página}}"}],"variable":[]}},"response":[{"id":"2f701e69-7e37-409e-83cf-dedda9ed4b7b","name":"Busca de anexos de uma solicitação","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/projects/assignmentsuploads?protocol=123&pageNumber=1&pageSize=5","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","projects","assignmentsuploads"],"query":[{"key":"protocol","value":"123"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"40a6c8f5-5b81-4e43-81a0-9a253f429d16"},{"name":"Consultar agendamentos do FSM","id":"8506fda3-a797-4c3a-9f64-d17ac4cb6854","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{URL}}:45715/external/fieldservicemanagement/integrations/getschedules?date={{2024-01-01}}&finalDate={{2024-12-09}}&fieldTechnicianTxId={{CPF}}&protocol={{Número do protocolo}}&routingStatus={{Status do agendamento}}®ionCode={{Códgio da região}}","description":"Regras:
\nÚnico campo obrigatório é o date, quando for o único informado irá trazer todos os agendamentos daquele dia.
\nQuando passado o campo finalDate, a consulta será irá retornar todos os agendamentos no intervalo de data, respeitando o máximo de 15 dias entre cada consulta.
\nOs campos fieldTechnicianTxId, protocol e routingStatus serão filtros complementares, buscando todos os agendamentos de um técnico de FSM que esteja configurado no ERPVoalle, todos os agendamentos de um protocolo ou todos os agendamentos em um determinado status, sendo os status possíveis:
\n0 - Não Atribuída (pré-agendamento);
\n1 - Atribuída;
\n2 - Pendente;
\n3 - Sincronizada;
\n4 - Deslocamento;
\n5 - Em Atendimento;
\n6 - Finalizada;
\n7 - Deslocamento Finalizado;
\n8 - Improdutivo.
\nData inicial da consulta
\n","type":"text/plain"},"key":"date","value":"{{2024-01-01}}"},{"description":{"content":"Data final da consulta (Intervalo máximo de 15 dias)
\n","type":"text/plain"},"key":"finalDate","value":"{{2024-12-09}}"},{"description":{"content":"Filtro por técnico
\n","type":"text/plain"},"key":"fieldTechnicianTxId","value":"{{CPF}}"},{"description":{"content":"Filtro por protocolo
\n","type":"text/plain"},"key":"protocol","value":"{{Número do protocolo}}"},{"description":{"content":"Filtro por status de roterização
\n","type":"text/plain"},"key":"routingStatus","value":"{{Status do agendamento}}"},{"description":{"content":"Filtro por região de FSM
\n","type":"text/plain"},"key":"regionCode","value":"{{Códgio da região}}"}],"variable":[]}},"response":[{"id":"b937bbfd-25da-4cc3-b568-c82e36008818","name":"Consultar agendamentos do FSM - Sucesso","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"{{URL}}:45715/external/fieldservicemanagement/integrations/getschedules?date=2024-01-01&finalDate=2024-01-15&fieldTechnicianTxId=12345678900&protocol=123&routingStatus=0®ionCode=00123","host":["{{URL}}"],"port":"45715","path":["external","fieldservicemanagement","integrations","getschedules"],"query":[{"key":"date","value":"2024-01-01","description":"Data inicial da consulta"},{"key":"finalDate","value":"2024-01-15","description":"Filtro por intervalo de data da consulta (máximo de 15 dias entre data inical e final)"},{"key":"fieldTechnicianTxId","value":"12345678900","description":"Filtro por técnico"},{"key":"protocol","value":"123","description":"Filtro por protocolo"},{"key":"routingStatus","value":"0","description":"Filtro por status de roterização"},{"key":"regionCode","value":"00123","type":"text"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": [\n {\n \"protocol\": 123,\n \"shift\": 1,\n \"beginDate\": \"2024-01-01T08:30:00\",\n \"endDate\": \"2024-01-11T18:30:00\",\n \"activationType\": true,\n \"routingStatus\": 0,\n \"regionCode\": \"1.02\",\n \"regionTitle\": \"Atibaia\",\n \"teamCode\": \"15\",\n \"teamTitle\": \"Instalação Fibra\",\n \"reservedSkills\": [\n \"Instalação\",\n \"Mudança de endereço\",\n \"Troca de tecnologia\",\n \"Fibra - Instalação + Segundo ponto\",\n \"Fibra - Instalação + Tv\"\n ],\n \"fieldTechnicianName\": \"Técnico de teste\",\n \"fieldTechnicianTxId\": \"12345678900\"\n },\n {\n \"protocol\": 123,\n \"shift\": 1,\n \"beginDate\": \"2024-01-03T08:30:00\",\n \"endDate\": \"2024-01-03T18:30:00\",\n \"activationType\": true,\n \"routingStatus\": 0,\n \"regionCode\": \"1.02\",\n \"regionTitle\": \"Atibaia\",\n \"teamCode\": \"15\",\n \"teamTitle\": \"Instalação Fibra\",\n \"reservedSkills\": [\n \"Instalação\",\n \"Mudança de endereço\",\n \"Troca de tecnologia\",\n \"Fibra - Instalação + Segundo ponto\",\n \"Fibra - Instalação + Tv\"\n ],\n \"fieldTechnicianName\": \"Técnico de teste\",\n \"fieldTechnicianTxId\": \"12345678900\"\n },\n {\n \"protocol\": 123,\n \"shift\": 1,\n \"beginDate\": \"2024-01-07T08:30:00\",\n \"endDate\": \"2024-01-07T18:30:00\",\n \"activationType\": true,\n \"routingStatus\": 0,\n \"regionCode\": \"1.02\",\n \"regionTitle\": \"Atibaia\",\n \"teamCode\": \"15\",\n \"teamTitle\": \"Instalação Fibra\",\n \"reservedSkills\": [\n \"Instalação de Câmeras\",\n \"Suporte Cameras\"\n ],\n \"fieldTechnicianName\": \"Técnico de teste\",\n \"fieldTechnicianTxId\": \"12345678900\"\n },\n {\n \"protocol\": 123,\n \"shift\": 1,\n \"beginDate\": \"2024-01-09T08:30:00\",\n \"endDate\": \"2024-01-09T18:30:00\",\n \"activationType\": false,\n \"routingStatus\": 1,\n \"regionCode\": \"1.02\",\n \"regionTitle\": \"Atibaia\",\n \"teamCode\": \"15\",\n \"teamTitle\": \"Instalação Fibra\",\n \"reservedSkills\": [\n \"Troca de cabeamento\",\n \"Troca de roteador de local\",\n \"Segundo Ponto\",\n \"Rompimento\"\n ],\n \"fieldTechnicianName\": \"Técnico de teste\",\n \"fieldTechnicianTxId\": \"12345678900\"\n },\n {\n \"protocol\": 123,\n \"shift\": 2,\n \"beginDate\": \"2024-01-11T08:30:00\",\n \"endDate\": \"2024-01-19T18:30:00\",\n \"activationType\": true,\n \"routingStatus\": 1,\n \"regionCode\": \"1.02\",\n \"regionTitle\": \"Atibaia\",\n \"teamCode\": \"15\",\n \"teamTitle\": \"Instalação Fibra\",\n \"reservedSkills\": [\n \"Instalação de Câmeras\",\n \"Suporte Cameras\"\n ],\n \"fieldTechnicianName\": \"Técnico de teste\",\n \"fieldTechnicianTxId\": \"12345678900\"\n }\n ],\n \"dataResponseType\": \"ListGenerated from cURL: curl --location 'https://erp.cliente.com.br:45715/external/integrations/thirdparty/projects/solicitation/forward/teams?assignmentId=123'
--header 'Authorization: Bearer {{access_token}}'
--header 'Content-Type: application/json'
Generated from cURL: curl --location 'https://erp.cliente.com.br:45715/external/integrations/thirdparty/projects/solicitation/forward/incident-status'
--header 'Authorization: Bearer {{access_token}}'
--header 'Content-Type: application/json'
Generated from cURL: curl --location 'https://erp.cliente.com.br:45715/external/integrations/thirdparty/projects/solicitation/forward/motives'
--header 'Authorization: Bearer {{access_token}}'
--header 'Content-Type: application/json'
Generated from cURL: curl --location 'https://erp.cliente.com.br:45715/external/integrations/thirdparty/projects/solicitation/forward'
--header 'Authorization: Bearer {{access_token}}'
--header 'Content-Type: application/json'
--data '{\n \"assignmentId\": 0, \n \"routingMotiveId\": 0, \n \"teamId\": 0, \n \"responsibleId\": 0, \n \"motive\": \"\", \n \"incidentStatusId\": 0 \n}'
Abertura de solicitação - detalhada.
\nincidentStatusId: Status da solicitação (Campo obrigatório):
\nLembrete: ao usar o objeto “report” para criar uma solicitação já com um relato inicial, o status da solicitação não pode ser 1, 8 e 9.
Para criar uma solicitação com status de Abertura ou Ag. Classificação, é necessário passar “null” como valor do “description” do objeto “report”.
Exemplo:
\n\n\n\"report\": {
\n
\"beginningDate\":\"2021-03-12 14:26:00.0\",
”finalDate\": \"2021-03-12 14:27:00.0\",
\"description\": null
}
ou
\n\n\n\"report\":{ }
\n
personid: Id do solicitante da solicitação. Pode ser o próprio cliente ou colaborador da empresa. Para solicitações externas devem possuir o mesmo valor do cliente. Obrigatório o uso quando for passado um relato em “report.description”.
\nclientid: Id do cliente da solicitação. O id pode ser obtido através do método “Busca Pessoa por CPF/CNPJ”.
\nincidentTypeId: Id do tipo de solicitação. Disponível no método “Tipos de Solicitação”.
\ncontractServiceTagId: Id da etiqueta de serviço do contrato. Disponível no método “Lista Etiquetas de Contrato”. Obrigatório quando o tipo de solicitação for \"Externa\".
\ncatalogServiceId: Id do catálogo de serviço da solicitação. Disponível no método “Lista Catálogo de Serviços”. Obrigatório quando o tipo de solicitação estiver marcado como Obriga Catalogo de Serviço.
\nserviceLevelAgreementId: Id do Service Level Agreement (SLA). Disponível no método “Lista Catálogo de Serviços”. Os SLA são cadastrados na rotina \"Service Desk / Cadastros / Situações de Solicitações\".
\ncatalogServiceItemId: Id dos itens de serviços do catálogo. Disponível no método “Lista Itens do Serviço”.
\ncatalogServiceItemClassId: Id dos subitens de serviços do catálogo. Disponível no método “Lista Subitens do Serviço”.
\nassignment.beginningDate: Data de abertura da solicitação. Necessário marcar a opção “DT Abertura” nos Parâmetros, aba Abertura Solicitação, para informar a data de abertura.
\nreport: Estrutura obrigatória para o tipo o status 4 - Encerrado e não deve ser passada na abertura do protocolo. Caso não seja informado relato, enviar a estrutura desta forma - \"report\": { },
\ncompanyPlaceId: Id do local de atendimento da solicitação. Disponível no método “Lista Locais”. Quando um serviço já possuir um local, está variável estará disponível no método “Lista Catálogo de Serviço”.
\ncontractServiceTagCategory: Etiqueta que possui amaração com serviço, para ser usada na consulta da matriz.
\nsolicitationServiceCategory1, solicitationServiceCategory2, solicitationServiceCategory3, solicitationServiceCategory4 e solicitationServiceCategory5: Código das categorias para a consulta da matriz.
\nValidações e retornos:
\nMensagem: Solicitante inválido para esta solicitação.
\n\n\nPersonId não é um recurso ou colaborador.
\n
\n\nPersonId é de uma pessoa que não pode atender a solicitação, pois não está na equipe parametrizada para atender este tipo;
\n
\n\nA opção Forçar solicitante interno não está selecionado nos parâmetros da solicitação;
\n
Mensagem: Catálogo de serviço não presente na etiqueta selecionada.
\n\n\ncatalogServiceTagId não está vinculado ao contractServiceTagId no ERP.
\n
Mensagem: Usuário não pode atender este tipo de solicitação
\n\n\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","opendetailedsolicitation"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"b13db38a-cf39-475f-be8f-f8d4e588c4e9","name":"Nova Solicitação - Detalhada","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"incidentStatusId\": 1,\n \"personId\": 1234,\n \"clientId\": 311234,\n \"incidentTypeId\": 1,\n \"contractServiceTagId\": 12345,\n \"catalogServiceId\": 1,\n \"serviceLevelAgreementId\": 6,\n \"catalogServiceItemId\": 2,\n \"catalogServiceItemClassId\": 1,\n \"assignment\": {\n \"title\": \"teste\",\n \"description\": \"teste\",\n \"priority\": 1,\n \"beginningDate\": \"\",\n \"finalDate\": \"\",\n \"report\": {\n \"beginningDate\": \"\",\n \"finalDate\": \"\",\n \"description\": \"teste\"\n },\n \"companyPlaceId\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/opendetailedsolicitation"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"protocol\": 123,\n \"assignmentId\": 456\n },\n \"dataResponseType\": \"<>f__AnonymousType887`3\",\n \"elapsedTime\": null\n}"},{"id":"b1bde248-4840-493f-91bd-64d9130afe2e","name":"Nova Solicitação - Detalhada informando local diferente do local do contrato","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"incidentStatusId\": 1,\n \"personId\": 1234,\n \"clientId\": 311234,\n \"incidentTypeId\": 1,\n \"contractServiceTagId\": 12345,\n \"catalogServiceId\": 1,\n \"serviceLevelAgreementId\": 6,\n \"catalogServiceItemId\": 2,\n \"catalogServiceItemClassId\": 1,\n \"assignment\": {\n \"title\": \"teste\",\n \"description\": \"teste\",\n \"priority\": 1,\n \"beginningDate\": \"\",\n \"finalDate\": \"\",\n \"report\": {\n \"beginningDate\": \"\",\n \"finalDate\": \"\",\n \"description\": \"teste\"\n },\n \"companyPlaceId\": 1\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/opendetailedsolicitation"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"protocol\": 123,\n \"assignmentId\": 456,\n \"message\": \"Protocolo aberto para o local \\\"001 - Empresa Teste\\\", pois é o local vinculado ao contrato/etiqueta.\"\n },\n \"dataResponseType\": \"<>f__AnonymousType887`3\",\n \"elapsedTime\": null\n}"},{"id":"6503492d-be4d-4825-88e7-f308333e111a","name":"Nova Solicitação com Categorias - Detalhada","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"incidentStatusId\": 1,\n \"personId\": 1234,\n \"clientId\": 311234,\n \"incidentTypeId\": 1,\n \"contractServiceTagId\": 12345,\n \"catalogServiceId\": 1,\n \"serviceLevelAgreementId\": 6,\n \"catalogServiceItemId\": 2,\n \"catalogServiceItemClassId\": 1,\n \"assignment\": {\n \"title\": \"teste\",\n \"description\": \"teste\",\n \"priority\": 1,\n \"beginningDate\": \"\",\n \"finalDate\": \"\",\n \"report\": {\n \"beginningDate\": \"\",\n \"finalDate\": \"\",\n \"description\": \"teste\"\n },\n \"companyPlaceId\": 1\n },\n \"contractServiceTagCategory\": \"string\", \n \"solicitationServiceCategory1\": \"string\",\n \"solicitationServiceCategory2\": \"string\",\n \"solicitationServiceCategory3\": \"string\",\n \"solicitationServiceCategory4\": \"string\",\n \"solicitationServiceCategory5\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/opendetailedsolicitation"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"protocol\": 123,\n \"assignmentId\": 456\n },\n \"dataResponseType\": \"<>f__AnonymousType887`3\",\n \"elapsedTime\": null\n}"}],"_postman_id":"32d52b6c-0946-424c-892f-e315f8d450e8"},{"name":"Nova Solicitação Interna- Detalhada","id":"59607a23-49bb-4e79-a1e6-ad90444f4e8c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"incidentStatusId\": 1,\n \"personId\": 123,\n \"catalogServiceId\": 2,\n \"incidentTypeId\": 112,\n \"serviceLevelAgreementId\": 123,\n \"matrixType\": 2,\n \"teamCode\": \"0123\",\n \"solicitationServiceCategory1\": \"121\",\n \"solicitationServiceCategory2\": \"abc\",\n \"solicitationServiceCategory3\": \"a2c\",\n \"solicitationServiceCategory4\": \"1b3\",\n \"solicitationServiceCategory5\": \"0\",\n \"authenticationAccessPointCode\": \"string\",\n \"authenticationSiteCode\": \"string\",\n \"assignment\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"priority\": 0,\n \"beginningDate\": \"2023-08-01T12:15:26.086Z\",\n \"finalDate\": \"2023-08-01T12:15:26.086Z\",\n \"companyPlaceId\": 0,\n \"report\": {\n \"beginningDate\": \"2023-08-01T12:15:26.086Z\",\n \"finalDate\": \"2023-08-01T12:15:26.086Z\",\n \"description\": \"string\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/opendetailedsolicitation","description":"Usuário logado na autenticação não faz parte da equipe que a solicitação será encaminhada.
\n
Abertura de solicitação Interna - detalhada.
\nAqui estão documentadas as regras para abertura de um protocolo Interno no ERP Voalle;
\nNão é possível a abertura de solicitação que necessite de checklist inicial.
\nincidentStatusId: Status da solicitação (Campo obrigatório):
\n1 - Abertura
\n2 - Andamento
\n3 - Fechamento
\n4 - Encerramento
\n8 - Cancelado
\n9 - Ag. Classificação
\nLembrete: ao usar o objeto “report” para criar uma solicitação já com um relato inicial, o status da solicitação não pode ser 1, 8 e 9.
Para criar uma solicitação com status de Abertura ou Ag. Classificação, é necessário passar “null” como valor do “description” do objeto “report”.
Exemplo:
\n\n\n\"report\": {
\n
\"beginningDate\":\"2021-03-12 14:26:00.0\",
”finalDate\": \"2021-03-12 14:27:00.0\",
\"description\": null
}
ou
\n\n\n\"report\":{ }
\n
Não existe uma parametrização para uma matriz padrão para solicitação interna.
matrixType: enviar o valor 2 para solicitação interna
teamCode: Enviar o código da equipe que possui vínculo com o catálogo e a matriz encontrada através das categorias.
\ncompanyPlaceId: Id do local de atendimento da solicitação. Disponível no método “Lista Locais”. Quando um serviço já possuir um local, está variável estará disponível no método “Lista Catálogo de Serviço”.
\nPara que a solicitação respeite as regras de abertura por local definidas no tipo de solicitação, a seguinte configuração deve ser realizada no ERP:
\nO tipo de solicitação deve possuir regra de abertura para o local;
\nO local enviado na API deve ter vínculo com a equipe na regra de abertura do tipo de solicitação;
\nA equipe enviada também precisa estar vinculada ao Catálogo de Serviço enviado na API, para que o protocolo possa ser direcionado a ela.
\nCaso alguma das condições não sejam contempladas, o protocolo será aberto para o Local enviado e a Equipe definida como padrão no Tipo de solicitação.
\nA solicitação interna pode ser vinculada a um ponto de acesso ou site.
Caso o tipo de solicitação tenha o parâmetro Obriga site marcado, o campo authenticationSiteCode deve ser preenchido.
Caso o tipo de solicitação tenha o parâmetro Obriga ponto de acesso, o campo authenticationAccessPointCode deve ser preenchido.
personid: Id do solicitante da solicitação. Pode ser o próprio cliente ou colaborador da empresa. Para solicitações externas devem possuir o mesmo valor do cliente. Obrigatório o uso quando for passado um relato em “report.description”.
\nPara que a solicitação possa ser aberta por um colaborador, no tipo de solicitação deve estar parametrizado o seguinte campo:
\nRotina Serviço / Cadastros / Solicitações - Tipos, ao acessar a solicitação, selecionar o menu parâmetros.
\nNa aba \"Abertura de Solicitação\" habilitar o parâmetro \"Força Solicitante Interno: Possibilita modificar o Solicitante na abertura de uma Solicitação para um solicitante interno, mesmo quando um cliente foi selecionado.\"
\nincidentTypeId: Id do tipo de solicitação. Disponível no método “Tipos de Solicitação”.
\nserviceLevelAgreementId: Id do Service Level Agreement (SLA). Disponível no método “Lista Catálogo de Serviços”. Os SLA são cadastrados na rotina \"Service Desk / Cadastros / Situações de Solicitações\".
\nassignment.beginningDate: Data de abertura da solicitação. Necessário marcar a opção “DT Abertura” nos Parâmetros, aba Abertura Solicitação, para informar a data de abertura.
\nreport: Estrutura obrigatória para o tipo o status 4 - Encerrado e não deve ser passada na abertura do protocolo. Caso não seja informado relato, enviar a estrutura desta forma - \"report\": { },
\nsolicitationServiceCategory1, solicitationServiceCategory2, solicitationServiceCategory3, solicitationServiceCategory4 e solicitationServiceCategory5: Código das categorias para a consulta da matriz.
\nValidações e retornos:
\nMensagem: Solicitante inválido para esta solicitação.
\n\n\nPersonId não é um recurso ou colaborador.
\n
\n\nPersonId é de uma pessoa que não pode atender a solicitação, pois não está na equipe parametrizada para atender este tipo;
\n
\n\nA opção Forçar solicitante interno não está selecionado nos parâmetros da solicitação;
\n
Mensagem: Catálogo de serviço não presente na etiqueta selecionada.
\n\n\ncatalogServiceTagId não está vinculado ao contractServiceTagId no ERP.
\n
Mensagem: Usuário não pode atender este tipo de solicitação
\n\n\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","opendetailedsolicitation"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"d8f850c0-5cf7-4b63-900c-46f04e72d82f","name":"Nova Solicitação Interna - Detalhada","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"incidentStatusId\": 1,\n \"personId\": 123,\n \"incidentTypeId\": 112,\n \"catalogServiceId\": 2,\n \"serviceLevelAgreementId\": 123,\n \"matrixType\": 2,\n \"teamCode\":\"0123\",\n \"solicitationServiceCategory1\": \"121\",\n \"solicitationServiceCategory2\": \"abc\",\n \"solicitationServiceCategory3\": \"a2c\",\n \"solicitationServiceCategory4\": \"1b3\",\n \"solicitationServiceCategory5\": \"0\",\n \"assignment\": {\n \"title\": \"string\",\n \"description\": \"string\",\n \"priority\": 0,\n \"beginningDate\": \"2023-08-01T12:15:26.086Z\",\n \"finalDate\": \"2023-08-01T12:15:26.086Z\",\n \"report\": {\n \"beginningDate\": \"2023-08-01T12:15:26.086Z\",\n \"finalDate\": \"2023-08-01T12:15:26.086Z\",\n \"description\": \"string\"\n },\n \"companyPlaceId\": 0\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/opendetailedsolicitation"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"protocol\": 123,\n \"assignmentId\": 456\n },\n \"dataResponseType\": \"<>f__AnonymousType887`3\",\n \"elapsedTime\": null\n}"}],"_postman_id":"59607a23-49bb-4e79-a1e6-ad90444f4e8c"},{"name":"Nova Solicitação - Simplificado","id":"e4da416c-29cd-4c88-9369-d3ce5c46b8eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Usuário logado na autenticação não faz parte da equipe que a solicitação será encaminhada.
\n
Obtido no método de autenticação
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"teste\",\n \"clientId\": 1,\n \"contractId\": 1,\n \"contractServiceTagId\": 1,\n \"close\": false\n}"},"url":"{{URL}}:45715/external/integrations/thirdparty/opensolicitation","description":"Gera nova solicitação.
\nPara que este tipo de solicitação possa ser aberta via API, é necessário a parametrização da abertura na rotina \"Suíte / Configurações / Parâmetros\" menu \"Service Desk\" no Item \"Abre Solicitação - Via API\":
\ncontract_service_tag_id
\nPara que seja utilizada a etiqueta de serviço do contrato do cliente na abertura de solicitação, são feitas as seguintes validações:
\nCaso não seja necessário a abertura utilizando a etiqueta, basta enviar o campo vazio.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","opensolicitation"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"677c5130-127e-4be8-b943-7ef2daf0ca02","name":"Nova Solicitação","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"teste\",\n \"clientId\": 1,\n \"contractId\": 1,\n \"contractServiceTagId\": 1,\n \"close\": false\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/opensolicitation"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"status\": \"OK\",\n \"protocol\": 111111\n },\n \"dataResponseType\": \"<>f__AnonymousType490`2\",\n \"elapsedTime\": null\n}"}],"_postman_id":"e4da416c-29cd-4c88-9369-d3ce5c46b8eb"},{"name":"Nova Solicitação CRM","id":"31418936-e13d-467b-910e-6b446a83a7b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Obtido no método de autenticação
\n"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"teste\",\n \"contractId\": 1,\n \"contractServiceTagId\": 1\n}"},"url":"{{URL}}:45715/external/integrations/thirdparty/opensolicitationcrm","description":"Gera nova solicitação para o Comercial.
\nPara que este tipo de solicitação possa ser aberta via API, é necessário a parametrização da abertura na rotina \"Suíte / Configurações / Parâmetros\" menu \"CRM\" no Item \"Abre Solicitação para o Comercial - Via API\":
\ncontract_service_tag_id
\nPara que seja utilizada a etiqueta de serviço do contrato do cliente na abertura de solicitação, são feitas as seguintes validações:
\nCaso não seja necessário a abertura utilizando a etiqueta, basta enviar o campo vazio.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","opensolicitationcrm"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"51b5360b-7a6f-4249-acff-998252a48fbb","name":"Nova Solicitação CRM","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"description\": \"teste\",\n \"contractId\": 1,\n \"contractServiceTagId\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/opensolicitationcrm"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"status\": \"OK\",\n \"protocol\": 111111\n },\n \"dataResponseType\": \"<>f__AnonymousType490`2\",\n \"elapsedTime\": null\n}"}],"_postman_id":"31418936-e13d-467b-910e-6b446a83a7b9"},{"name":"Nova Solicitação para Ponto de Acesso","id":"15078573-b230-4485-8b98-fbd0716c250f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/opensolicitationpopeventerror/{{integrationCode}}","urlObject":{"port":"45715","path":["external","integrations","thirdparty","opensolicitationpopeventerror","{{integrationCode}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"8a73170e-587a-4cfc-a37f-f678ef66979d","name":"Nova Solicitação para Ponto de Acesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/opensolicitationpopeventerror/123456"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"status\": \"OK\",\n \"protocol\": 654321\n },\n \"dataResponseType\": \"<>f__AnonymousType524`2\",\n \"elapsedTime\": null\n}"}],"_postman_id":"15078573-b230-4485-8b98-fbd0716c250f"},{"name":"Realiza manutenção em solicitação","id":"6ef21253-d9d3-46c9-b19d-1a418b0f6492","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"string\", // Número do protocolo\n \"solicitationServiceMatrixCode\": \"string\", // Código da matriz\n \"incidentTypeCode\": \"string\", // Código do novo tipo de solicitação\n \"report\": \"string \" // Texto para ser incluído no relato de manutenção\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/solicitationmaintenance","description":"Através dessa API é possível alterar a matriz de categorização de um protocolo. Essa alteração irá alterar também o tipo de solicitação, SLA e matriz GUT do protocolo.
\nOs campos protocol e solicitationServiceMatrixCode são obrigatórios para realizar essa ação.
\nCaso o campo incidentTypeCode não seja informado, será utilizado o primeiro tipo de solicitação vinculado a matriz.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","solicitationmaintenance"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"feb924bf-77a5-48f5-a790-0c0fb14e01c8","name":"Realiza manutenção em solicitação - Sucesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação","type":"text"}],"body":{"mode":"raw","raw":"{\n \"protocol\": \"12345\",\n \"solicitationServiceMatrixCode\": \"001\", \n \"incidentTypeCode\": \"1.2.3\",\n \"report\": \"Manutenção realizada via API - Documentação \"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/solicitationmaintenance"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": [\n {\n \"message\": \"Manutenção de solicitação efetuada com sucesso.\",\n \"code\": null,\n \"type\": \"Success\"\n }\n ],\n \"response\": null,\n \"dataResponseType\": null,\n \"elapsedTime\": null\n}"}],"_postman_id":"6ef21253-d9d3-46c9-b19d-1a418b0f6492"},{"name":"Encerra Solicitação para Ponto de Acesso","id":"376a71e9-108f-4487-b954-141e6577d3fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/closesolicitationpopeventerror/{{integrationCode}}","urlObject":{"port":"45715","path":["external","integrations","thirdparty","closesolicitationpopeventerror","{{integrationCode}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"a56029f2-7990-4f23-a2f2-b6ecdeb35a08","name":"Encerra solicitação para Ponto de Acesso","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/closesolicitationpopeventerror/123456"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"status\": \"OK\",\n \"protocol\": 123456\n },\n \"dataResponseType\": \"<>f__AnonymousType524`2\",\n \"elapsedTime\": null\n}"}],"_postman_id":"376a71e9-108f-4487-b954-141e6577d3fd"},{"name":"Nova Solicitação para Cliente","id":"127919dd-fdcc-4df7-bdc4-3d029b783813","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/opensolicitationclienteventerror/{{clientId}}","urlObject":{"port":"45715","path":["external","integrations","thirdparty","opensolicitationclienteventerror","{{clientId}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"18c73df5-6d2c-4001-922a-2d20e9b8fa6f","name":"Nova Solicitação para Cliente","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/opensolicitationclienteventerror/123456"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": \"Solicitação aberta com sucesso\",\n \"dataResponseType\": \"String\",\n \"elapsedTime\": null\n}"}],"_postman_id":"127919dd-fdcc-4df7-bdc4-3d029b783813"},{"name":"Encerra Solicitação para Cliente","id":"baca389e-e793-43ec-9ea1-b68159d63d52","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/closesolicitationclienteventerror/{{clientId}}","urlObject":{"port":"45715","path":["external","integrations","thirdparty","closesolicitationclienteventerror","{{clientId}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"1cce2479-cf5e-4f6d-9e71-292013db14cd","name":"Encerra Solicitação para Cliente","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/closesolicitationclienteventerror/123456"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": \"Solicitação encerrada com sucesso\",\n \"dataResponseType\": \"String\",\n \"elapsedTime\": null\n}"}],"_postman_id":"baca389e-e793-43ec-9ea1-b68159d63d52"},{"name":"Adiciona Apontamento em Solicitação","id":"09416dd0-2942-4654-8518-fe7d8763eefc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assignmentId\": 0,\n \"personId\": 0,\n \"title\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/solicitationnewnote","urlObject":{"port":"45715","path":["external","integrations","thirdparty","solicitationnewnote"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"a87f3f98-6c9e-48d8-80d5-8194866a70b1","name":"Adiciona Apontamento em Solicitação","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assignmentId\": 0,\n \"personId\": 0,\n \"title\": \"string\",\n \"description\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/solicitationnewnote"},"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"status\": \"OK\",\n \"message\": \"Apontamento realizado com sucesso\"\n },\n \"dataResponseType\": \"<>f__AnonymousType485`2\",\n \"elapsedTime\": null\n}"}],"_postman_id":"09416dd0-2942-4654-8518-fe7d8763eefc"},{"name":"Adiciona Relato e altera Status da Solicitação","id":"7601412f-dba6-4a6a-820a-cbd7435b3d30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Token obtido no método de autenticação
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assignmentId\": 0,\n \"protocol\": 0,\n \"incidentStatusId\": 0,\n \"description\": \"string\",\n \"progress\": 0,\n \"priority\": 0,\n \"notificationTarget\": 0,\n \"privateReport\": true\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/projects/createsolicitationreport","description":"Método utilizado para fazer um relato no protocolo e alterar seu status.
\nassignmentId: ID do protocolo
\nprotocol: Número do protocolo
\nIds dos status da solicitação (incidentestatusid)
\n1 - Abertura
2 - Andamento
3 - Fechamento
4 - Encerramento
8 - Cancelado
9 - Ag. Classificação
description: descrição do relato
\nprogress: Progresso, de 0 a 100, só usado para tarefas
\npriority: prioridade do relato
\nnotificationTarget: Indica se será enviado ou não notificação sobre o relato para o atendente atual.
\nprivateReport: Indica se o relato é privado ou não. Relato privado apensa a empresa pode ver e o cliente não.
\nAtenção: esse método não realiza reabertura de protocolo.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","projects","createsolicitationreport"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"14b0c3c6-15d3-43f4-8e1a-fec57145c7c5","name":"Adiciona relato e altera status da solicitação - Utilizando assignmentId","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"assignmentId\": 418335,\n \"incidentStatusId\": 3,\n \"description\": \"Texto de relato\",\n \"progress\": 0,\n \"priority\": 35,\n \"notificationTarget\": 0,\n \"privateReport\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/projects/createsolicitationreport"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": [\n {\n \"message\": \"Relato criado com sucesso\",\n \"code\": null,\n \"type\": \"Success\"\n }\n ],\n \"response\": null,\n \"dataResponseType\": null,\n \"elapsedTime\": null\n}"},{"id":"4524b05b-3eef-4ccb-a42b-060d52f99c93","name":"Adiciona relato e altera status da solicitação - Utilizando \"protocol\"","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Token obtido no método de autenticação","type":"text"}],"body":{"mode":"raw","raw":"{\n \"protocol\": 398520,\n \"incidentStatusId\": 2,\n \"description\": \"Teste\",\n \"progress\": 20,\n \"priority\": 3,\n \"notificationTarget\": 1,\n \"privateReport\": true\n}","options":{"raw":{"language":"json"}}},"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/projects/createsolicitationreport"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": [\n {\n \"message\": \"Relato criado com sucesso\",\n \"code\": null,\n \"type\": \"Success\"\n }\n ],\n \"response\": null,\n \"dataResponseType\": null,\n \"elapsedTime\": null\n}"}],"_postman_id":"7601412f-dba6-4a6a-820a-cbd7435b3d30"},{"name":"Upload de anexo em uma solicitação","id":"f8708378-3ea3-49ae-bf82-01edea159c5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text","description":"Token obtido no método de autenticação
\n"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","value":null}]},"url":"{{URL}}:45715/external/integrations/thirdparty/projects/assignmentsuploads?protocol={{Número do protocolo}}&documentationTypeCode={{Código do tipo de documento}}","description":"Formatos de arquivo suportados pela API são csv, docx, gif, doc, gz, jpeg, jpg, pdf, png, ppt, pptx, rar, tar, txt, xls, xlsx, zip.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","projects","assignmentsuploads"],"host":["{{URL}}"],"query":[{"key":"protocol","value":"{{Número do protocolo}}"},{"key":"documentationTypeCode","value":"{{Código do tipo de documento}}"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"5f150afe-a174-4670-8c37-4d9c2463c647","name":"Upload de anexo em um contrato","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"{{URL}}:45715/external/integrations/thirdparty/projects/assignmentsuploads?protocol={{Número do protocolo}}&documentationTypeCode={{Código do tipo de documento}}","host":["{{URL}}"],"port":"45715","path":["external","integrations","thirdparty","projects","assignmentsuploads"],"query":[{"key":"protocol","value":"{{Número do protocolo}}"},{"key":"documentationTypeCode","value":"{{Código do tipo de documento}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f8708378-3ea3-49ae-bf82-01edea159c5f"},{"name":"Download de um anexo de uma solicitação","id":"eda43514-3dfe-4fdd-b12a-8c1d01b2e38c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Token obtido no método de autenticação
\n","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","value":null}]},"url":"{{URL}}:45715/external/integrations/thirdparty/projects/assignmentsuploads/getfile?id={{Id do Anexo}}&assignmentId={{Id da Solicitação}}","description":"Realiza download de um anexo vinculado a solicitação.
\nid: Identificador do anexo junto ao solicitação (obrigatório).
\nassignmentId: Identificador do solicitação (obrigatório).
\nPor padrão irá ser validado se o identificador do anexo enviado pertence ao solicitação, caso contrário será retornado uma mensagem de erro. Caso pertencer e for válido o anexo, será retornado os binários do arquivo.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","projects","assignmentsuploads","getfile"],"host":["{{URL}}"],"query":[{"disabled":true,"key":"","value":""},{"key":"id","value":"{{Id do Anexo}}"},{"key":"assignmentId","value":"{{Id da Solicitação}}"}],"variable":[]}},"response":[{"id":"86907f46-95c6-498d-a1ae-acf59682e380","name":"Insucesso","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Token obtido no método de autenticação","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","value":null}]},"url":{"raw":"{{URL}}:45715/external/integrations/thirdparty/projects/assignmentsuploads/getfile?id={{Id do Anexo}}&assignmentId={{Id da Solicitação}}","host":["{{URL}}"],"port":"45715","path":["external","integrations","thirdparty","projects","assignmentsuploads","getfile"],"query":[{"key":"","value":"","disabled":true},{"key":"id","value":"{{Id do Anexo}}"},{"key":"assignmentId","value":"{{Id da Solicitação}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"b33a1398-3ec6-4d21-8833-9774cd669b0e","name":"Download de um anexo de uma solicitação","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Token obtido no método de autenticação","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","value":null}]},"url":{"raw":"{{URL}}:45715/external/integrations/thirdparty/projects/assignmentsuploads/getfile?id={{Id do Anexo}}&assignmentId={{Id da Solicitação}}","host":["{{URL}}"],"port":"45715","path":["external","integrations","thirdparty","projects","assignmentsuploads","getfile"],"query":[{"key":"","value":"","disabled":true},{"key":"id","value":"{{Id do Anexo}}"},{"key":"assignmentId","value":"{{Id da Solicitação}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"eda43514-3dfe-4fdd-b12a-8c1d01b2e38c"}],"id":"7015eb4e-5332-4f8d-9375-76123688176f","_postman_id":"7015eb4e-5332-4f8d-9375-76123688176f","description":""},{"name":"ISP | Telecom","item":[{"name":"Atualiza Conexão","id":"72035b8b-82cb-4a42-a8a9-53f70fb3db97","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": 0,\n \"fiberMac\": \"string\",\n \"mac\": \"string\",\n \"password\": \"string\",\n \"equipmentType\": 0,\n \"oltId\": 0,\n \"slotOlt\": 0,\n \"portOlt\": 0,\n \"equipmentSerialNumber\": \"string\",\n \"ipType\": 0,\n \"equipmentUser\": \"string\",\n \"equipmentPassword\": \"string\",\n \"authenticationSplitterId\": 0,\n \"port\": 0,\n \"wifiName\": \"string\",\n \"wifiPassword\": \"string\",\n \"technologyType\": 0,\n \"authenticationAccessPointId\": 0,\n \"updateConnectionParameter\": true,\n \"shouldMacUpdate\": true,\n \"user\": \"string\",\n \"isIPoE\": true,\n \"complement\": \"string\"\n}"},"url":"{{URL}}:45715/external/integrations/thirdparty/updateconnection/{{ID}}","description":"Atualiza as informações de uma conexão.
\nequipmentType: Fabricante do equipamento. Utilizar os seguintes códigos:
\noltId: Só aparece em tela quando o tipo de equipamento for diferente de Mikrotik, Ubiquiti e Digistar.
\nipType: Tipo do IP:
\ntechnologyType: Tipo de tecnologia:
\nSetMacClean: Caso informado True, o número do MAC é limpo;
\nObtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/getaccesspointstatusbycontract/{{contractId}}","description":"Busca status do ponto de acesso de um contrato especifico.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","getaccesspointstatusbycontract","{{contractId}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"62a9db6f-e32d-4159-a786-1219c58ccc21","name":"Busca Status do PE por Contrato","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/getaccesspointstatusbycontract/0000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"title\": \"Ponto de Acesso Padrão\",\n \"inMaintenance\": false,\n \"maintenance\": null,\n \"active\": false\n },\n \"dataResponseType\": \"<>f__AnonymousType514`4\",\n \"elapsedTime\": null\n}"}],"_postman_id":"a28c15fe-6a2b-4603-b026-1aa5dd25c164"},{"name":"Busca Status do PE por Usuário","id":"fb4c731f-1ba2-45e6-9e63-e7b7a14291dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/getaccesspointstatusbyclient/{{clientId}}","description":"Busca status dos pontos de acesso de um usuário especifico
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","getaccesspointstatusbyclient","{{clientId}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"ed9229f1-0a43-4e83-945f-e181011fc99f","name":"Busca Status do PE por Cliente","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.br:45715/external/integrations/thirdparty/getaccesspointstatusbyclient/00000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": [\n {\n \"title\": \"OLT-FIBERHOMEGTC\",\n \"inMaintenance\": false,\n \"maintenance\": null,\n \"active\": true\n }\n ],\n \"dataResponseType\": \"ListRegistra ou atualiza os dados de tráfego (upload/download) de um usuário autenticado em um contrato ISP. Este endpoint permite que sistemas externos (ERP) enviem informações de consumo de banda dos clientes.
\n{\n \"user\": \"cliente@provedor\",\n \"date\": \"2025-12-11T10:30:00.000Z\",\n \"download\": 524288000,\n \"upload\": 104857600,\n \"totalDownload\": 10737418240,\n \"totalUpload\": 2147483648\n}\n\nCriação ou Atualização:
\nSe já existir um registro para o mesmo usuário na mesma data (considerando início e fim do dia), o registro será atualizado.
\nCaso contrário, um novo registro será criado.
\nValidação de Data:
\n00:00:00) e fim do dia (23:59:59) da data informada.Valores em Bytes:
\nTodos os valores de tráfego devem ser enviados em bytes.
\nExemplo: 500 MB = 524.288.000 bytes
\nEste endpoint retorna um objeto:
\nReturnData<AuthenticationContractTrafficRecordsModel>\n\n{\n \"success\": true,\n \"data\": {\n \"user\": \"cliente@provedor\",\n \"date\": \"2025-12-11T00:00:00\",\n \"download\": 524288000,\n \"upload\": 104857600,\n \"totalDownload\": 10737418240,\n \"totalUpload\": 2147483648\n },\n \"messages\": [\n {\n \"message\": \"Registro atualizado com sucesso\",\n \"code\": 200,\n \"type\": \"Success\"\n }\n ],\n \"elapsedTime\": 15.42\n}\n\n{\n \"success\": false,\n \"messages\": [\n {\n \"message\": \"O campo 'User' é obrigatório\",\n \"code\": 400,\n \"type\": \"Error\"\n }\n ]\n}\n\n{\n \"success\": false,\n \"messages\": [\n {\n \"message\": \"Erro ao processar registro de tráfego\",\n \"code\": 500,\n \"type\": \"Error\"\n }\n ]\n}\n\ncurl -X POST '{{URL}}:45715/external/integrations/thirdparty/isp/authentication_contracts/traffic' \\\n --header 'Content-Type: application/json' \\\n --header 'Authorization: Bearer {{access_token}}' \\\n --data '{\n \"user\": \"cliente@provedor\",\n \"date\": \"2025-12-11T10:30:00.000Z\",\n \"download\": 524288000,\n \"upload\": 104857600,\n \"totalDownload\": 10737418240,\n \"totalUpload\": 2147483648\n }'\n\nEndpoint requer autenticação via Bearer Token
\nValidação de permissões de integração Third-Party
\nISP Tráfego RADIUS Monitoramento Third-Party Integração ERP
Token obtido no método de autenticação
\n"}],"url":"{{URL}}:45715/external/integrations/thirdparty/contract/contractuploads?contractNumber={{Número do contrato}}&pageNumber={{Página}}&pageSize={{Registros por página}}","description":"Lista os subitens do catalogo de serviço informado.
\nOs itens do catálogo é obtido através do método \"Lista Itens de Serviços do Catálogo\"
\n","urlObject":{"port":"45715","path":["","external","integrations","thirdparty","contract","contractuploads"],"host":["{{URL}}"],"query":[{"key":"contractNumber","value":"{{Número do contrato}}"},{"key":"pageNumber","value":"{{Página}}"},{"key":"pageSize","value":"{{Registros por página}}"}],"variable":[]}},"response":[{"id":"edfe7816-d6f2-4656-b9eb-9a971f59a07c","name":"Busca de anexos de um contrato","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/contract/contractuploads?contractNumber=123&pageNumber=1&pageSize=10","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["","external","integrations","thirdparty","contract","contractuploads"],"query":[{"key":"contractNumber","value":"123"},{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4380bef3-7770-40d1-89cc-c0a623158a82"},{"name":"Busca de contratos paginada","id":"e5d7186e-7a2d-42a6-87b1-6fa2fb73ff7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Token obtido no método de autenticação
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"txId\": \"string\", // CPF/CNPJ do cliente do contrato\n \"txIdType\": 0, // 1 - Pessoa jurídica 2 - Pessoa Física\n \"companyPlaceTxId\": \"string\", // Local do contrato\n \"contractNumber\": \"string\", // Número do contrato\n \"contractTypeCode\": \"string\", // Código do tipo de contrato\n \"serviceProductCode\": \"string\", // Código do serviço\n \"onlyActiveContracts\": true, // Apenas contratos ativos\n \"page\": 0, // Página da consulta\n \"pageSize\": 0 // Número de registros por página\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/contract/getpaged","description":"Essa API permite a busca de contratos na base do ERPVoalle de forma paginada, porém para realizar essa consulta, algumas regras precisam ser seguidas para otimizar o desempenho da API e não onerar o servidor do cliente.
\nPara consultar todos os contratos da base, os parâmetros de page e pageSize são obrigatórios, sendo o pageSize limitado aos valores 5, 10, 20, 25, 50 e 100.
\nPara uma consulta mais afunilada, os campos contractNumber e txId podem ser passados, consultando os contratos e buscando através do número de contrato ou do cliente do contrato, através do seu CPF/CNPJ. Quando a realizada a consulta utilizando esses parâmetros, os campos page e pageSize não são mais obrigatórios.
\nOs demais campos da API podem ser utilizados como filtros de pesquisa, não sendo obrigatórios em nenhuma situação, sendo eles:
\nonlyActiveContracts: Apenas contratos ativos;
\nserviceProductCode: Apenas contratos que possuam um serviço em específico;
\ncontractTypeCode: Apenas contratos com um determinado Tipo de Contrato;
\ncompanyPlaceTxId: Apenas contratos de um determinado Local;
\ntxIdType: Apenas contratos com um determinado tipo de cliente assossiado.
\nAtravés do CPF/CNPJ será validado se já existe um cliente cadastrado no ERP ou se é necessário cadastrar um novo.
\nCaso não enviada a descrição do contrato, será gerado no padrão Contrato {número} - {Tipo de contrato} - {Nome do Cliente}
\nCaso não seja enviado o campo Meses de duração, será assumido o valor parametrizado no tipo de contrato.
\nOs ciclos de cobrança só serão aceitos quando forem vinculados ao tipo de contrato enviado.
\nO bloqueio automático e notificação de faturamento por padrão, caso não informados, serão assumidos como true (Sim).
\nCaso não informado o campo Tipo de faturamento especial será usado o padrão “Tipo Padrão”.
\nOs tipos de contratos permitidos serão os mesmos configurados no cadastro de Locais.
\nOs serviços (servicesInformation), são uma lista, ou seja, podem ser enviados diversos serviços.
\nOs campos expirationDocket, collectionDay e cutDay apenas serão obrigatórios caso não seja enviado o campo contractDateManagementCode. Caso seja enviado na API, deve ser considerado os campos do ciclo de faturamento do ERP.
\nOs serviços serão aceitos caso estejam no Tipo de contrato enviado.
\nSão aceitos apenas serviços SVA e de internet.
\nCaso não seja informado o estágio do contrato (contractStage), será gerado o contrato conforme o parâmetro do CRM.
\nPara que a solicitação caia no fluxo do Field Service Management, é obrigatório o uso de Matrizes na categorização do protocolo (matrixCode).
\nSerá validado se o campo solicitationTypeCode da ativação tem permissão para abertura de protocolo no local do contrato, com base no companyPlaceTxId, caso não, será impedido a abertura do protocolo de ativação, assim como, no uso de matrizes, se para a matriz enviada não for permitido o tipo de solicitação enviado.
\nO solicitationTypeCode deve ser referente ao Tipo de Solicitação Externa, caso contrário, irá retornar a mensagem: \"A solicitação de ativação exige um tipo de solicitação do tipo Externo.\"
\nCódigo dos Tipos de Clientes do contrato
\nCódigo dos Tipos de Logradouro
\nPara a criação de um contrato com serviço STFC, deve ser informado um número de telefone para ser vinculado ao item de contrato, sendo que:
\nO número enviado deve existir cadastrado no Grupo de Telefone identificado no campo phoneGroupId;
\nCaso seja uma portabilidade e o número não existir, o número enviado será cadastrado no GRupo de Telefone identificado no campo phoneGroupId;
\nphoneNumberType
\n| Tipo de telefone | Descrição | Regra |
| 0 | Fixo | DDD + 8 dígitos |
| 1 | Celular | DDD + 9 dígitos |
| 2 | Outro | 11 dígitos |
Essa API irá gerar um pedido de venda no ERPVoalle, vinculado a um cliente ou a um contrato, já faturado conforme as regras de faturamento por local de cada item incluído no pedido.
\nRegras:
\nO cliente deve ser uma pessoa já cadastrada no ERPVoalle, ativa, efetiva e com o atributo cliente marcado.
\nO número de contrato não é obrigatório e caso não informado, será gerado o pedido vinculado apenas ao cliente.
\nO Local e o Tipo de cobrança informados devem ser vinculados.
\nO pedido de venda sempre irá gerar uma cobrança e nunca irá gerar Apenas Títulos, então o Tipo de Cobrança informado precisa ser diferente de Fatura.
\nO Produto ou Serviço informado nos itens devem possuir Regras de Faturamento para o Local do pedido.
\nPara ser utilizado um Produto nos itens, ele precisa estar com o atributo Vendável marcado e possuir saldo, a menos que esteja marcado como Não Controla Estoque.
\nApenas é possível gerar pedido de venda para contratos com as situações \"Aprovado\" ou \"Em Aprovação\".
\nNão é possível gerar um pedido de venda para um Objeto.
\nObtido no método de autenticação
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"type\": 0, // Tipo do valor eventual a ser lançado. 1 - Acréscimo, 2 - Desconto ( Se vazio/não enviado assumir como 1, padrão anterior da api)\n \"contractId\": 12345, //ID do contrato\n \"contracItemtId\": 12345, // Id do item de contrato. Obrigatório quando 2 no type - Quando enviado 1 no type será desconsiderado esse campo\n \"contractConfigurationBillingId\": 0, // Id do agrupador de contrato. Obrigatório quando 2 no type - Quando enviado 1 no type será desconsiderado esse campo\n \"serviceProductCode\": \"01004\", // Código do serviço. Obrigatório quando 1 no type - Quando enviado 2 no type será desconsiderado esse campo\n \"monthYearType\": 4, //Tipo de competência\n \"monthYear\": \"2021-12-01\", //Competência\n \"initialMonthYear\": \"2021-12-15\", //Data inicial\n \"finalMonthYear\": \"2021-12-16\", //Data final\n \"description\": \"Teste\", //Descrição\n \"presentInvoiceNote\": true, //Informações serão apresentadas no documento?\n \"unitAmount\": 10.00, //Valor\n \"units\": 2 //Quantidade\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/contract/contracteventualvalues","description":"Cria um novo valor eventual.
\ntype: Tipo do valor eventual a ser gerado. (Se vazio/não enviado assumir como 1 padrão)
\n1: Acréscimo;
\n2: Desconto;
\ncontractId: Identificador do contrato (obrigatório).
\ncontracItemtId: Identificador do item de contrato.
\ncontractConfigurationBillingId: Identificador do agrupador de contrato. Quando campo type for igual a 2, será obrigatório, caso não informado será gerado exceção. Quando campo type for igual a 1, será desconsiderado esse campo (opcional conforme regra).
\nserviceProductCode: Código do serviço.
\nmonthYearType: Competência que o eventual se refere (obrigatório):
\n1: Atual;
\n2: Próxima;
\n3: Manual;
\n4: Recorrente;
\ninitialMonthYear: Data inicial para geração recorrente.
\nfinalMonthYear: Datas final para geração recorrente.
\ndescription: Descrição do eventual (obrigatório).
\npresentInvoiceNote: Indicador para mostrar as informações no documento fiscal (valor padrão \"false\").
\nunitAmount: Valor eventual (obrigatório).
\nunits: Quantidade do eventual (obrigatório).
\nObtido no método de autenticação
\n","type":"text"}],"url":"{{URL}}:45715/external/integrations/thirdparty/getfilesbycontract/{{contractNumber}}/documentationtype/{{documentionTypeId}}","description":"Busca arquivos de um contrato especifico.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","getfilesbycontract","{{contractNumber}}","documentationtype","{{documentionTypeId}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"c12329cc-f920-4e9c-bcd7-bbee3eccb9ad","name":"Lista Documentos por Contrato","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/getfilesbycontract/xxxxxxx/documentationtype/x"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": [\n {\n \"title\": \"teste\",\n \"description\": \"Documento teste
\",\n \"documentationType\": \"Documentos Técnicos\",\n \"validity\": {\n \"begin\": null,\n \"final\": null\n },\n \"file\": \"https://xxx.xxxxx.com.br\"\n },\n {\n \"title\": \"Teste2\",\n \"description\": \"Documento teste2
\",\n \"documentationType\": \"Documentos Técnicos\",\n \"validity\": {\n \"begin\": null,\n \"final\": null\n },\n \"file\": \"https://xxx.xxxxx.com.br\"\n }\n ],\n \"dataResponseType\": \"ListToken obtido no método de autenticação
\n"}],"body":{"mode":"formdata","formdata":[{"key":"File","type":"file","value":null}]},"url":"{{URL}}:45715/external/integrations/thirdparty/contract/contractuploads?contractNumber={{Número do contrato}}&documentationTypeCode={{Código do tipo de documento}}","description":"Formatos de arquivo suportados pela API são csv, docx, gif, doc, gz, jpeg, jpg, pdf, png, ppt, pptx, rar, tar, txt, xls, xlsx, zip.
\n","urlObject":{"port":"45715","path":["","external","integrations","thirdparty","contract","contractuploads"],"host":["{{URL}}"],"query":[{"key":"contractNumber","value":"{{Número do contrato}}"},{"key":"documentationTypeCode","value":"{{Código do tipo de documento}}"},{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[{"id":"1d0f57a4-95c9-44d8-bd09-2d67eb3222b8","name":"Upload de anexo em um contrato","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{URL}}:45715/external/integrations/thirdparty/contract/contractuploads?contractNumber={{Número do contrato}}&documentationTypeCode={{Código do tipo de documento}}","host":["{{URL}}"],"port":"45715","path":["","external","integrations","thirdparty","contract","contractuploads"],"query":[{"key":"contractNumber","value":"{{Número do contrato}}"},{"key":"documentationTypeCode","value":"{{Código do tipo de documento}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"015d3b9c-b265-4eb0-9764-3422557d41b7"},{"name":"Desbloquear contrato","id":"84511597-5518-4232-8c0b-9f2caf7147ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{URL}}:45715/external/integrations/thirdparty/contracts/unlock/123456","urlObject":{"port":"45715","path":["external","integrations","thirdparty","contracts","unlock","123456"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"d616c252-05f1-4f00-af8a-990c74279bee","name":"Insucesso","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{URL}}:45715/external/integrations/thirdparty/contracts/unlock/123456"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"success\": false,\n \"messages\": [\n {\n \"message\": \"Não possui conexão em aviso de bloqueio ou bloqueada\",\n \"code\": null,\n \"type\": \"Error\"\n }\n ]\n}"},{"id":"4e1a9d3f-a1bf-4413-965c-748798064814","name":"Sucesso","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{URL}}:45715/external/integrations/thirdparty/contracts/unlock/123456"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": [\n {\n \"message\": \"Contrato desbloqueado com sucesso\",\n \"code\": null,\n \"type\": \"Success\"\n }\n ]\n}"}],"_postman_id":"84511597-5518-4232-8c0b-9f2caf7147ad"},{"name":"Download de um anexo de um contrato","id":"5d38bdfb-2cb3-44d7-9b3b-159946f4c9c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":"{{URL}}:45715/external/integrations/thirdparty/contract/contractuploads/getfile?id={{Id do Anexo}}&contractId={{Id do Contrato}}","description":"Realiza download de um anexo vinculado a contrato.
\nid: Identificador do anexo junto ao contrato (obrigatório).
\ncontractId: Identificador do contrato (obrigatório).
\nPor padrão irá ser validado se o identificador do anexo enviado pertence ao contrato, caso contrário será retornado uma mensagem de erro. Caso pertencer e for válido o anexo, será retornado os binários do arquivo.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","contract","contractuploads","getfile"],"host":["{{URL}}"],"query":[{"key":"id","value":"{{Id do Anexo}}"},{"key":"contractId","value":"{{Id do Contrato}}"}],"variable":[]}},"response":[{"id":"b8909015-32bd-49b0-bf29-c85917866e47","name":"Download de um anexo de um contrato","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"{{URL}}:45715/external/integrations/thirdparty/contract/contractuploads/getfile?id={{Id do Anexo}}&contractId={{Id do Contrato}}","host":["{{URL}}"],"port":"45715","path":["external","integrations","thirdparty","contract","contractuploads","getfile"],"query":[{"key":"id","value":"{{Id do Anexo}}"},{"key":"contractId","value":"{{Id do Contrato}}"}]}},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""},{"id":"e98a8310-1679-4b02-a96e-7ef0cf703eda","name":"Insucesso","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"url":{"raw":"{{URL}}:45715/external/integrations/thirdparty/contract/contractuploads/getfile?id={{Id do Anexo}}&contractId={{Id do Contrato}}","host":["{{URL}}"],"port":"45715","path":["external","integrations","thirdparty","contract","contractuploads","getfile"],"query":[{"key":"id","value":"{{Id do Anexo}}"},{"key":"contractId","value":"{{Id do Contrato}}"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5d38bdfb-2cb3-44d7-9b3b-159946f4c9c4"},{"name":"Aprovar Contrato","id":"4b7fe482-260b-4152-bbdc-ad234cdab8ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"proportionalityType\": 0,\n \"changeBeginningDateOnApproval\": true,\n \"changeLoyaltyDateOnApproval\": true,\n \"approvalDate\": \"2025-11-15T19:31:19.544Z\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/contracts/approve/:contractId","description":"Aprova um contrato externo e gera proporcionalidades e atualizações de datas conforme regras configuradas.
\n{\n \"proportionalityType\": 0,\n \"changeBeginningDateOnApproval\": true,\n \"changeLoyaltyDateOnApproval\": true,\n \"approvalDate\": \"2025-11-15T19:31:19.544Z\"\n}\n\nEste endpoint retorna um objeto:
\nReturnData<ContractApprovalReturn>\n\n{\n \"success\": true,\n \"data\": {\n \"personUsers\": [],\n \"proportionalities\": [\n {\n \"description\": \"Proporcionalidade gerada na competência atual\",\n \"amount\": 49.90,\n \"competence\": \"2025-11-01T00:00:00\",\n \"serviceDescription\": \"Mensalidade Plano X\",\n \"type\": 1,\n \"competenceType\": 1\n }\n ]\n },\n \"elapsedTime\": 12.54\n}\n\n{\n \"success\": false,\n \"messages\": [\n {\n \"message\":\"Contrato não encontrado\",\n \"code\":300,\n \"type\":\"Error\"\n }\n ]\n}\n\ncurl -X PUT '{{URL}}:45715/external/integrations/thirdparty/contracts/approve/5806' \\\n --header 'Content-Type: application/json' \\\n --header 'Authorization: Bearer {{access_token}}' \\\n --data '{\n \"proportionalityType\": 0,\n \"changeBeginningDateOnApproval\": true,\n \"changeLoyaltyDateOnApproval\": true,\n \"approvalDate\": \"2025-11-15T19:31:19.544Z\"\n }'\n\nEsta API permite o download do DANFE (Documento Auxiliar da Nota Fiscal Eletrônica) de documentos fiscais já emitidos no sistema. API disponível em ambietes de homologação.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","billings","invoices","download","{{id do documento}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ab61b59c-9ffb-4365-b03d-62743df4af17"}],"id":"8d061160-adfa-479f-8b76-386ca11fa429","_postman_id":"8d061160-adfa-479f-8b76-386ca11fa429","description":""},{"name":"Financeiro","item":[{"name":"Busca faturas em aberto por CPF/CNPJ","id":"91737ea8-0073-45d2-b169-a5e730d64681","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","description":"Obtido no método de autenticação
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}:45715/external/integrations/thirdparty/getopentitlesbytxid/{{txId}}","description":"São listadas faturas em aberto e em atraso ou com vencimento para o próximo mês da consulta.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","getopentitlesbytxid","{{txId}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"1c8cf302-8d64-4fa1-8688-4f08bcb17336","name":"Busca faturas em aberto por CPF/CNPJ","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/getopentitlesbytxid/000000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": [\n {\n \"id\": 123456,\n \"billet\": {\n \"bankTitleNumber\": null,\n \"barcode\": null,\n \"typefulLine\": \"00000.00000 00000.000000 00000.00000 0 000000000000\",\n \"pixQRCode\":\"0123456br.gov.bcb.pix2563qrcodepix.bb.com.br/pix/v2/799be0ed-xxxx-xxxx-9xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx7VOALLE TECHNOLOGY6011SANTA MARIAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxDFE\",\n \"title\": \"FAT000000000000000\",\n \"issueDate\": \"2018-07-30\",\n \"expirationDate\": \"2018-08-20\",\n \"processingDate\": \"2021-07-07\",\n \"amount\": {\n \"value\": 0.00,\n \"finalValue\": 0.00,\n \"discount\": 0.00,\n \"fine\": 0.00,\n \"interest\": 0.00\n }\n },\n \"client\": {\n \"txId\": \"0000000000000\",\n \"name\": \"xxxxxxxxx xxxxxxxxxxx xxxxxx\",\n \"address\": {\n \"street\": \"xxxxx xxxxxxxxxxxx\",\n \"number\": \"1234\",\n \"codeCityId\": 123456,\n \"city\": \"xxxxxx\",\n \"state\": \"Rxx\",\n \"postalCode\": \"0000-000\",\n \"addressComplement\": \"\"\n }\n },\n \"companyPlace\": {\n \"txId\": \"123456\",\n \"name\": \"xxxx\",\n \"address\": {\n \"street\": \"xxx xxxxxx xxxxx\",\n \"number\": \"123456\",\n \"codeCityId\": 123456,\n \"city\": \"xxxxxxxxx\",\n \"state\": \"xx\",\n \"postalCode\": \"00000-000\",\n \"addressComplement\": \"\"\n }\n },\n \"bank\": {\n \"code\": \"001\",\n \"name\": \"Banco do Brasil S.A.\",\n \"agency\": {\n \"number\": \"0000\",\n \"digit\": \"0\"\n },\n \"account\": {\n \"number\": \"000000\",\n \"digit\": \"0\"\n },\n \"bankUse\": \"\"\n },\n \"collectionType\": {\n \"specieTitle\": \"DMI\",\n \"loanPortfolio\": \"17\",\n \"quantity\": \"\",\n \"accept\": \"N\"\n }\n }\n ],\n \"dataResponseType\": \"ListObtido no método de autenticação
\n","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}:45715/external/integrations/thirdparty/gettitlesbytxid/{{txId}}","urlObject":{"port":"45715","path":["external","integrations","thirdparty","gettitlesbytxid","{{txId}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"f59a15ea-2a80-4d0c-844a-5b33446d46d9","name":"Busca todas as faturas de um cliente por CPF/CNPJ","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/gettitlesbytxid/000000000000000"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": [\n {\n \"id\": 123456,\n \"billet\": {\n \"bankTitleNumber\": null,\n \"barcode\": null,\n \"typefulLine\": \"00000.00000 00000.000000 00000.00000 0 000000000000\",\n \"pixQRCode\":\"0123456br.gov.bcb.pix2563qrcodepix.bb.com.br/pix/v2/799be0ed-xxxx-xxxx-9xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx7VOALLE TECHNOLOGY6011SANTA MARIAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxDFE\",\n \"title\": \"FAT000000000000000\",\n \"issueDate\": \"2018-07-30\",\n \"expirationDate\": \"2018-08-20\",\n \"processingDate\": \"2021-07-07\",\n \"status\":\"Em aberto\", // Possiveis retornos: Em aberto, Paga, Cancelada, Vencida\n \"amount\": {\n \"value\": 0.00,\n \"finalValue\": 0.00,\n \"discount\": 0.00,\n \"fine\": 0.00,\n \"interest\": 0.00,\n \"originalValue\":0.00\n },\n \"receipts\": {\n \"ammount\": 0.00, // total recebido\n \"discount\": 0.00, // desconto registrado para este recebimento\n \"fine\": 0.00, // multa registrada no recebimento\n \"interest\": 0.00, // juros registrado do recebimento \n \"receiptDate\": \"2026-07-07\" // Data do recebimento\n }\n },\n \"client\": {\n \"txId\": \"0000000000000\",\n \"name\": \"xxxxxxxxx xxxxxxxxxxx xxxxxx\",\n \"address\": {\n \"street\": \"xxxxx xxxxxxxxxxxx\",\n \"number\": \"1234\",\n \"codeCityId\": 123456,\n \"city\": \"xxxxxx\",\n \"state\": \"Rxx\",\n \"postalCode\": \"0000-000\",\n \"addressComplement\": \"\"\n }\n },\n \"companyPlace\": {\n \"txId\": \"123456\",\n \"name\": \"xxxx\",\n \"address\": {\n \"street\": \"xxx xxxxxx xxxxx\",\n \"number\": \"123456\",\n \"codeCityId\": 123456,\n \"city\": \"xxxxxxxxx\",\n \"state\": \"xx\",\n \"postalCode\": \"00000-000\",\n \"addressComplement\": \"\"\n }\n },\n \"bank\": {\n \"code\": \"001\",\n \"name\": \"Banco do Brasil S.A.\",\n \"agency\": {\n \"number\": \"0000\",\n \"digit\": \"0\"\n },\n \"account\": {\n \"number\": \"000000\",\n \"digit\": \"0\"\n },\n \"bankUse\": \"\"\n },\n \"collectionType\": {\n \"specieTitle\": \"DMI\",\n \"loanPortfolio\": \"17\",\n \"quantity\": \"\",\n \"accept\": \"N\"\n }\n }\n ],\n \"dataResponseType\": \"ListObtido no método de autenticação
\n"}],"body":{"mode":"raw","raw":""},"url":"{{URL}}:45715/external/integrations/thirdparty/getcontractbillets/{{contractId}}","description":"São listadas faturas em aberto e em atraso ou com vencimento para o próximo mês da consulta.
\n","urlObject":{"port":"45715","path":["external","integrations","thirdparty","getcontractbillets","{{contractId}}"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"03276fb8-1532-45a2-bfb4-8f3e2fbd5f04","name":"Busca faturas em aberto por contrato","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"url":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/getcontractbillets/123"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": [\n {\n \"id\": 123123,\n \"title\": \"FAT123456789\",\n \"expirationDate\": \"2021-05-30T00:00:00\",\n \"parcel\": 1,\n \"typefulLine\": \"00000.00000 00000.000000 00000.000000 0 00000000000000\",\n \"link\": \"https://d03.synsuite.com.br/financial_receivable_titles/boletos/a1b2c3d4e5\",\n \"pixQRCode\":\"0123456br.gov.bcb.pix2563qrcodepix.bb.com.br/pix/v2/799be0ed-xxxx-xxxx-9xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx7VOALLE TECHNOLOGY6011SANTA MARIAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxDFE\"\n },\n {\n \"id\": 123456,\n \"title\": \"FAT987654321\",\n \"expirationDate\": \"2021-06-30T00:00:00\",\n \"parcel\": 1,\n \"typefulLine\": \"00000.00000 00000.000000 00000.000000 0 00000000000000\",\n \"link\": \"https://d03.synsuite.com.br/financial_receivable_titles/boletos/abcd123fgh456\",\n \"pixQRCode\":\"\"\n }\n ],\n \"dataResponseType\": \"ListObtido no método de autenticação
\n","type":"text"}],"url":"{{URL_ERP_CLIENTE}}:45715/external/integrations/thirdparty/consultpayment?syngwtransactionid={{UUID retornado na liquidação}}","urlObject":{"port":"45715","path":["external","integrations","thirdparty","consultpayment"],"host":["{{URL_ERP_CLIENTE}}"],"query":[{"description":{"content":"Obtido no método de liquidação de um título
\n","type":"text/plain"},"key":"syngwtransactionid","value":"{{UUID retornado na liquidação}}"}],"variable":[]}},"response":[{"id":"22220c7d-75bf-4b47-9047-971498090a04","name":"Consulta o status de um pagamento","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"Bearer","type":"text"}],"url":{"raw":"https://erp.cliente.com.br:45715/external/integrations/thirdparty/consultpayment?syngwtransactionid=a1b2c3d4e5","protocol":"https","host":["erp","cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","consultpayment"],"query":[{"key":"syngwtransactionid","value":"a1b2c3d4e5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"integratorTransactionId\": \"1eb56ef0-dfa1-11eb-8d19-0242ac130003\",\n \"status\": {\n \"value\": 1,\n \"label\": \"Processado com sucesso\"\n },\n \"processed\": \"2021-07-01T16:11:52\",\n \"message\": \"Teste de recebimento 3\"\n },\n \"dataResponseType\": \"<>f__AnonymousType461`4\",\n \"elapsedTime\": null\n}"}],"_postman_id":"f9647c64-5d30-41e6-a354-37a75d81525b"},{"name":"Realiza a liquidação de uma fatura","id":"c674ecd4-af70-438d-a415-d2717fd0378d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer","description":"Obtido no método de autenticação
\n","type":"text"}],"body":{"mode":"raw","raw":"{\n \"transactionId\": \"guid\", // UUID identificado da transação na integradora\n \"financialReceivableTitleId\": 0, // ID da fatura \n \"paidAmount\":0, // Valor pago pelo cliente\n \"message\": \"string\", // Mensagem/evento para ser salva no histórico da fatura\n \"BankAccountCode\":\"string\", // Código da conta em que o recebimento deve ocorrer\n \"PaymentFormCode\":\"string\", // Código da forma de pagamento utilizada pelo cliente\n \"ReceiptDate\":\"2024-09-01\", // Data em que o recebimento será registrado\n \"ClientPaidDate\":\"2024-09-02\" // Data em que ocorreu o pagamento pelo cliente\n}","options":{"raw":{"language":"json"}}},"url":"{{URL_ERP_CLIENTE}}:45715/external/integrations/thirdparty/receivepayment","description":"Método utilizado para realizar a liquidação de uma fatura no ERP, sendo feito sempre de forma total. Caso seja enviado ao ERP um valor menor que o total da fatura a diferença será lançada como desconto e se o valor for maior, será lançado como acréscimo.
\nNo campo \"transactionId\" deve ser informado um GUID válido, exemplo:
\nNo campo BankAccountCode deve ser informado o código de uma Conta existente e válida para recebimento no ERPVoalle.
\nNo campo PaymmentFormCode deve ser informado o código de uma Forma de Pagamento existente e válida para recebimento no ERPVoalle.
\nObtido atraveś do método de autenticação
\n"}],"url":"{{URL}}:45715/external/integrations/thirdparty/billings/registerpix?receivableId={{id_da_fatura}}","description":"Registra um Pix através de um Id.
\nPara utilizar este endpoint, é necessária a parametrização do PIX Voalle na base do cliente (Cadastro de Locais - Integrações - Nova Integração - Financeiro-PIX Voalle);
\nO id do título deve ser obtido através do método \"Busca títulos em aberto de uma pessoa\";
\nObtido através do método \"Busca faturas em aberto por contrato\" ou \"Busca faturas em aberto por CPF/CNPJ\"
\n","type":"text/plain"},"key":"receivableId","value":"{{id_da_fatura}}"}],"variable":[]}},"response":[{"id":"be8b3d59-d8b9-4cc5-852c-fd4bf147ed3a","name":"Gera PIX para pagamento","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"Authorization","value":"Bearer","description":"Obtido atraveś do método de autenticação"}],"url":{"raw":"https://erp;cliente.com.br:45715/external/integrations/thirdparty/billings/registerpix?receivableId=123456","protocol":"https","host":["erp;cliente","com","br"],"port":"45715","path":["external","integrations","thirdparty","billings","registerpix"],"query":[{"key":"receivableId","value":"123456","description":"Obtido através do método \"Busca títulos em aberto de uma pessoa\""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": [\n {\n \"message\": \"Processo realizado com sucesso.\",\n \"code\": null,\n \"type\": \"Success\"\n }\n ],\n \"response\": {\n \"registerId\": 11,\n \"qrCode\": \"0123456br.gov.bcb.pix2563qrcodepix.bb.com.br/pix/v2/799be0ed-xxxx-xxxx-9xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx7VOALLE TECHNOLOGY6011SANTA MARIAxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxDFE\",\n \"totalAmount\": 101.03,\n \"interestAmount\": 1.17,\n \"fineAmount\": 1.96,\n \"transactionId\": \"xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx\",\n \"hybridBillet\": false\n },\n \"dataResponseType\": null,\n \"elapsedTime\": null\n}"}],"_postman_id":"b322ae5f-e9ab-418b-a7ad-b0b9cb6d8d4a"},{"name":"Consulta renegociação","id":"e381e344-2996-4ded-934d-66db69fea0bd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"receivableIds\": [\n 1,\n 2\n ],\n \"date\": \"2023-12-31\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/financial/getrenegotiationsinformations","urlObject":{"port":"45715","path":["external","integrations","thirdparty","financial","getrenegotiationsinformations"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"37040eb2-8815-4712-98e6-6ef4aef999c3","name":"Consulta renegociação","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"receivableIds\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"date\": \"2023-11-10\"\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/financial/getrenegotiationsinformations"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"messages\": null,\n \"response\": {\n \"totalFine\": 0,\n \"totalInterest\": 0,\n \"receivables\": [\n {\n \"id\": 1, // ID\n \"title\": \"FAT0000\", // Fatura\n \"fine\": 0, // Valor calculado em multa\n \"interest\": 0 // Valor calculado em multa\n },\n {\n \"id\": 2,\n \"title\": \"FAT1111\",\n \"fine\": 0,\n \"interest\": 0\n },\n {\n \"id\": 3,\n \"title\": \"FAT1111\",\n \"fine\": 0,\n \"interest\": 0\n },\n {\n \"id\": 4,\n \"title\": \"FAT1111\",\n \"fine\": 0,\n \"interest\": 0\n }\n ],\n \"date\": \"2023-12-31\"\n },\n \"dataResponseType\": \"RenegotiationsInformationsDto\",\n \"elapsedTime\": null\n}"}],"_postman_id":"e381e344-2996-4ded-934d-66db69fea0bd"},{"name":"Efetiva renegociação","id":"3c53fa9b-85be-4632-8af5-1385cce8aaaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"receivableIds\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"discount\": 0,\n \"fine\": 0,\n \"interest\": 0,\n \"financialCollectionTypeCode\": 0,\n \"observation\": \"\",\n \"billingInvoiceAntecipad\": false,\n \"parcels\":[\n {\n \"number\": 1,\n \"amount\": 0, // [Não obrigatório] Se não informado deverá ser calculado o proporcional\n \"expirationDate\": \"2023-11-01\"\n },\n {\n \"number\": 2,\n \"amount\": null, // O valor desta parcela será calculado com base no valor total, divido pelas parcelas menos as parcelas fixas\n \"expirationDate\": \"2023-11-01\"\n } \n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/financial/registerrenegotiations","urlObject":{"port":"45715","path":["external","integrations","thirdparty","financial","registerrenegotiations"],"host":["{{URL}}"],"query":[],"variable":[]}},"response":[{"id":"4e2e433f-0b29-4ee1-ad96-4a24722da4ee","name":"Efetiva renegociação","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer {{access_token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"receivableIds\": [\n 1,\n 2,\n 3,\n 4\n ],\n \"discount\": 0,\n \"fine\": 0,\n \"interest\": 0,\n \"financialCollectionTypeCode\": 0,\n \"observation\": \"\",\n \"billingInvoiceAntecipad\": false,\n \"parcels\":[\n {\n \"number\": 1,\n \"amount\": 0, // [Não obrigatório] Se não informado deverá ser calculado o proporcional\n \"expirationDate\": \"2023-11-01\"\n },\n {\n \"number\": 2,\n \"amount\": null, // O valor desta parcela será calculado com base no valor total, divido pelas parcelas menos as parcelas fixas\n \"expirationDate\": \"2023-11-01\"\n } \n ]\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}:45715/external/integrations/thirdparty/financial/registerrenegotiations"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"parcels\": [\n {\n \"id\": 1, // ID da nova fatura\n \"title\": \"FAT000\", // Título da nova fatura\n \"expirationDate\": \"2023-11-01\", // Dada de vencimento da nova fatura\n \"amount\": 0 // Valor da nova fatura\n },\n {\n \"id\": 1,\n \"title\": \"FAT111\",\n \"expirationDate\": \"2023-11-01\",\n \"amount\": 0\n }\n ]\n}"}],"_postman_id":"3c53fa9b-85be-4632-8af5-1385cce8aaaa"}],"id":"a83c2bcb-e499-4b37-8fd3-a14ff0113b7f","_postman_id":"a83c2bcb-e499-4b37-8fd3-a14ff0113b7f","description":""},{"name":"Faturamento Terceiro/Cofaturamento","item":[{"name":"Webhook","item":[{"name":"Webhook de emissão de documento fiscal","id":"c1335074-cb2d-4618-92f1-65056a6377c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"Bearer {{access_token}}"}],"body":{"mode":"raw","raw":"{\n \"id\": \"fe8bf662-11e9-4448-85d7-e611b8341ec3\", // Identificador da emissão de terceiros/co-faturamento no elleven\n \"accessKey\": \"\", // Chave de acesso do documento fiscal gerado\n \"documentNumber\": 58334, // Número do documento\n \"serie\": \"62\", // Série\n \"status\": 1, // Status do documento fiscal. 1 = Autorizado ou 9= Cancelado\n \"amount\": 99.9, // Valor do item\n \"issueDate\": \"0000-00-00\", // Data de emissão do documento\n \"competence\": \"0000-00-00\", // Competencia\n \"person\": { // Destinátario do documento\n \"typeTxId\": 2, // Tipo do documento. 1 = CNPJ ou 2 = CPF\n \"txId\": \"08507405924\", // Numero do documento (CNPJ ou CPF)\n \"name\": \"\", // Nome do cliente\n \"type\": 0, // Tipo do cliente. 1 - Comercial, 2 - Industrial, 3 - Residencial/Pessoa Física, 4 - Produtor Rural, 5 - Órgão da administração pública estadual direta e suas fundações e autarquias, quando mantidas pelo poder público estadual e regidas por normas de direito público, nos termos do Convênio ICMS 107/95, 6 - Prestador de serviço de telecomunicação responsável pelo recolhimento do imposto incidente sobre a cessão dos meios de rede do prestador do serviço ao usuário final, nos termos do Convênio ICMS 17/13, 7 - Missões Diplomáticas, Repartições Consulares e Organismos Internacionais, nos termos do Convênio ICMS 158/94, 8 - Igrejas e Templos de qualquer natureza, 99 - Outros não especificados anteriormente\n \"stateRegistration\": \"\", // Inscrição estadual\n \"stateRegistrationType\": 0, // Tipo da inscrição estadual. 1 - Contribuinte, 2 - Isento, 9 - Não Contribuinte\n \"address\": {\n \"street\": \"\", // Endereço\n \"number\": \"\", // Numero\n \"neighborhood\": \"\", // Bairro\n \"city\": \"\", // Código da cidade (conforme ibge)\n \"postalCode\": \"\" // CEP\n },\n \"phone\": \"\", // Telefone\n \"mail\": \"\" // Email\n },\n \"integrationCode\": \"\" // Código de integração (vinculado ao item do contrato)\n}"},"url":"{{URL_INTEGRADOR}}","description":"Este endpoint é utilizado para notificar o integrador sobre a geração de um documento fiscal relacionado a faturamento de terceiros ou cofaturamento.
\nO campo id deve ser utilizado posteriormente pelo integrador para confirmar a emissão do documento fiscal no Elleven.
Este endpoint deve ser utilizado pelo integrador para confirmar a emissão de um documento fiscal previamente notificado via integração de faturamento de terceiros ou cofaturamento.
\nA confirmação deve ser feita utilizando o mesmo id recebido na notificação inicial.