{"info":{"_postman_id":"c041bbe0-96cb-446f-a459-0ca8cedf396e","name":"APIs Integração BomControle","description":"

Segue abaixo a documentação das APIs utilizadas para a integração com o sistema BomControle.

Informações:

Todas as nossas APIs são padrão RESTful e utilizam JSON para a comunicação.
Para utilizar elas é necessário sempre enviar o Token de Autenticação.
Mantemos as informações da documentação atualizada, por isso qualquer divergencia da documentação na utilização das APIs deve ser desconsiderada.

Em caso de dúvidas ou sugestões entre em contato com nossa equipe através do chat em nosso site BomControle.

LEGAL

Ao acessar essa documentação você esta concordando com os seguintes termos:

A empresa BomControle possui os direitos totais sobre a documentação.
A documentação não pode ser utilizada por terceiros sem a autorização da empresa BomControle, seja copia das informações ou qualquer outra forma indevida de utilização das informações aqui contidas.
A empresa BomControle se reserva o direito de remover ou alterar a documentação sem aviso prévio.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"1797561","collectionId":"c041bbe0-96cb-446f-a459-0ca8cedf396e","publishedId":"SWT7BKWo","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-01-21T14:43:21.000Z"},"item":[{"name":"Autenticação","item":[],"id":"74afaba8-09a6-4536-9526-759739a646c0","description":"

Para utilizar as APIs listadas nessa documentação é necessário informar nas chamadas uma chave de API válida.
Essa chave de API pode ser obtida no BomControle seguindo os seguintes passos:

No menu superior direito, clique em Configurações (ícone de engrenagem) e Configuração de API Key.

\n $\"Imagem%201\"$ \n\n

Na tela de configuração clicar no botão do canto inferior direito, \"Cadastrar Novo\".
\n
Informar um nome para identificação da Chave, qual empresa pode acessar ela e qual o módulo que ela possui permissão para acesso, isso define quais APIs essa chave possui permissão efetivamente.
\n
Após isso localize o cadastro e clique no botão \"Copiar API Key para o Clipboard\". Após clicar nesse botão uma janela será aberta para fazer a copia da chave para a area de transferência, com isso ela pode ser colada (geralmente com a combinação das teclas CTRL + V simultaneamente) por exemplo dentro de um e-mail e enviado para utilização pelo desenvolvedor.
\n

\n","event":[{"listen":"prerequest","script":{"id":"6145a9ed-5fce-49e0-8685-a9dc6b246b06","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"73b27481-b428-4cea-bdfb-da3e9dffe957","type":"text/javascript","exec":[""]}}],"_postman_id":"74afaba8-09a6-4536-9526-759739a646c0"},{"name":"AtividadeCRM","item":[{"name":"AtividadeCRM - Pesquisar","id":"cb1706dd-f840-4c6c-aa53-748bc9c9f694","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/AtividadeCrm/Pesquisar","description":"

Pesquisa as Atividade das Oportunidades conforme os filtros utilizados.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no sistema BomControle.

\n\n

Paramêtros

textoPesquisa: Buscar com base na descrição da Atividade. (Opcional. Tipo do Dado: Texto.)
realizada: Filtrar se a Atividade foi ou não Realizada. (Opcional. Tipo do Dado: Booleano.)
idsOportunidades: Buscar as atividades pelos Ids BomControle das Oportunidades. (Opcional. Tipo do Dado: Array de Inteiros.)
dataInicial: Filtrar pela Data Inicial da Atividade. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
dataFinal: Filtrar pela Data Final da Atividade. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
idTipoAtividade: Filtra pelo Tipo da Atividade. (Opcional. Tipo do Dado: Inteiro.)
statusAtividade: Filtra pelo Status da Atividade. (Opcional. Opções: Realizada, Agendada, Atrasada. Tipo do Dado: Array de Texto. )\n

\n\n

Response

Retorna um array de objetos com os dados das Atividades:

[\n  {\n    \"Id\": {param1},\n    \"Descricao\": {param2},\n    \"Data\": {param3},\n    \"DataFim\": {param4},\n    \"HoraInicio\": {param5},\n    \"HoraFim\": {param6},\n    \"Titulo\": {param7},\n    \"TipoLead\": {param8},\n    \"IdLead\": {param9},\n    \"NomeLead\": {param10},\n    \"DocumentoLead\": {param11},\n    \"IdTipoAtividade\": {param12},\n    \"NomeTipoAtividade\": {param13},\n    \"IconeTipoAtividade\": {param14},\n    \"Realizada\": {param15},\n    \"IdUsuario\": {param16},\n    \"LoginUsuario\": {param17},\n    \"NomeUsuarioResponsavel\": {param18},\n    \"Atrasado\": {param19}\n  }\n]\n

Paramêtros

{param1}: Id BomControle da Atividade da Oportunidade. (Tipo do Dado: Inteiro.)
{param2}: Descrição da Atividade. (Tipo do Dado: Texto.)
{param3}: Data de inicio da atividade. (Tipo do Dado: Texto.)
{param4}: Data do fim da atividade. (Tipo do Dado: Texto.)
{param5}: Hora de inicio da atividade. (Tipo do Dado: Texto.)
{param6}: Hora do fim da atividade. (Tipo do Dado: Texto.)
{param7}: Titulo da Oportunidade. (Tipo do Dado: Texto.)
{param8}: Tipo de Lead. (Opções: 0 - Pessoa Jurídica, 1 - Pessoa Física. Tipo do Dado: Inteiro.)
{param9}: Id BomControle do Lead. (Tipo do Dado: Inteiro.)
{param10}: Nome do Lead. (Tipo do Dado: Texto.)
{param11}: Documento do Lead, cpf ou cnpj. (Tipo do Dado: Texto.)
{param12}: Id BomControle do Tipo da Atividade. (Tipo do Dado: Inteiro.)
{param13}: Nome do Tipo da Atividade. (Tipo do Dado: Texto.)
{param14}: Ícone do Tipo da Atividade. (Tipo do Dado: Texto.)
{param15}: Indica se a Atividade foi realizada. (Tipo do Dado: Booleano.)
{param16}: Id BomControle do Vendedor da Oportunidade. (Tipo do Dado: Inteiro.)
{param17}: Login do Vendedor da Oportunidade no BomControle. (Tipo do Dado: Texto.)
{param18}: Nome do usuário do BomControle resposável pela Atividade. (Tipo do Dado: Texto.)
{param19}: Se a data de inicio da Atividade for inferior a data atual indicando atraso da Atividade. (Tipo do Dado: Booleano.)

","urlObject":{"protocol":"https","path":["integracao","AtividadeCrm","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"50771d71-bb39-45ad-8535-e5fede0b722f","name":"Pesquisar","originalRequest":{"method":"GET","header":[{"description":"Chave API (`ApiKey {chave}`) obtido no sistema BomControle.","key":"Authorization","type":"text","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA=="}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/AtividadeCrm/Pesquisar?textoPesquisa=teste&realizada=true&idsOportunidades=1&dataInicial=2020-01-01&dataFinal=2020-01-01&tipo=Reuniao&statusAtividade=Realizada","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","AtividadeCrm","Pesquisar"],"query":[{"key":"textoPesquisa","value":"teste","description":"Buscar com base na descrição da Atividade. `Campo Opcional. Tipo do Dado: Texto`"},{"key":"realizada","value":"true","description":"Filtrar se a Atividade foi ou não Realizada. `Campo Opcional. Tipo do Dado: Booleano`"},{"key":"idsOportunidades","value":"1","description":"Buscar as atividades pelos Ids BomControle das Oportunidades. `Campo Opcional. Tipo do Dado: Array de Inteiros`"},{"key":"dataInicial","value":"2020-01-01","description":"Filtrar pela Data Inicial da Atividade. `Campo Opcional. Tipo do Dado: Data. Formato: aaaa-mm-dd hh24:mi:ss`"},{"key":"dataFinal","value":"2020-01-01","description":"Filtrar pela Data Final da Atividade. `Campo Opcional. Tipo do Dado: Data. Formato: aaaa-mm-dd hh24:mi:ss`"},{"key":"tipo","value":"Reuniao","description":"Filtra pelo Tipo da Atividade. `Campo Opcional. Tipo do Dado: Texto. Opções: Reuniao, Ligar, Anotacao, ConferenciaOnline, Outros`"},{"key":"statusAtividade","value":"Realizada","description":"Filtra pelo Status da Atividade. `Campo Opcional. Tipo do Dado: Array de Texto. Opções: Realizada, Agendada, Atrasada`"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 20 Jan 2020 16:54:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"31262"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"Descricao\": \"Reunião com Fornecedor Teste dia 01/01/2020 09:00\",\r\n \"Data\": \"2020-01-01T09:00:00\",\r\n \"DataFim\": \"2020-01-01T11:15:00\",\r\n \"HoraInicio\": \"09:00\",\r\n \"HoraFim\": \"11:15\",\r\n \"Titulo\": \"Teste\",\r\n \"TipoLead\": 0,\r\n \"IdLead\": 4,\r\n \"NomeLead\": \"Fornecedor Teste\",\r\n \"DocumentoLead\": \"1111111111111\",\r\n\t\"IdTipoAtividade\": 1,\r\n\t\"NomeTipoAtividade\": \"Tipo Teste\",\r\n\t\"IconeTipoAtividade\": null,\r\n \"Realizada\": true,\r\n \"IdUsuario\": 1,\r\n \"LoginUsuario\": \"teste@teste.com.br\",\r\n \"NomeUsuarioResponsavel\": \"Teste\",\r\n \"Atrasado\": false\r\n }\r\n]"}],"_postman_id":"cb1706dd-f840-4c6c-aa53-748bc9c9f694"},{"name":"AtividadeCRM - Obter","event":[{"listen":"prerequest","script":{"id":"1f0e2c1d-9a1a-4684-b53b-e6e15120f8a5","exec":[""],"type":"text/javascript"}}],"id":"92bf266d-ca3b-41eb-99ff-75743c94d5c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/AtividadeCrm/Obter/{id}","description":"

Obtem informações da Atividade pesquisada.

Request

O request para essa API é feito informando a identificação da Atividade a ser pesquisado diretamente na URL.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no sistema BomControle.

\n\n

Paramêtros

{id}: Id da Atividade no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados da Atividade:

{\n  \"Id\": {param1},\n  \"Descricao\": {param2},\n  \"IdLead\": {param3},\n  \"IdOportunidade\": {param4},\n  \"Observacao\": {param5},\n  \"Realizada\": {param6},\n  \"IdResponsavel\": {param7},\n  \"LoginResponsavel\": {param8},\n  \"Data\": {param9},\n  \"DataInicio\": {param10},\n  \"DataFim\": {param11},\n  \"HoraInicio\": {param12},\n  \"HoraFim\": {param13},\n  \"NomeOportunidade\": {param14},\n  \"NomeLead\": {param15},\n  \"NomeResponsavel\": {param16},\n  \"IdTipoAtividadeOportunidade\": {param17},\n  \"NomeTipoAtividadeOportunidade\": {param18},\n  \"IconeTipoAtividadeOportunidade\": {param19},\n  \"Contatos\": {param20}[\n        {\n            \"Id\": {param21},\n            \"Nome\": {param22},\n            \"InformacoesContato\": {param23}[\n                {\n                    \"Tipo\": {param24},\n                    \"Valor\": {param25}\n                }\n            ]\n        }\n    ]\n}\n

Paramêtros

{param1}: Id BomControle da Atividade da Oportunidade. (Tipo do Dado: Inteiro.)
{param2}: Descrição da Atividade. (Tipo do Dado: Texto.)
{param3}: Id BomControle do Lead. (Tipo do Dado: Inteiro.)
{param4}: Id BomControle da Oportunidade. (Tipo do Dado: Inteiro.)
{param5}: Observação da Atividade. (Tipo do Dado: Texto.)
{param6}: Indica se a Atividade foi realizada. (Tipo do Dado: Booleano.)
{param7}: Id do usuário do BomControle responsável pela Atividade. (Tipo do Dado: Inteiro.)
{param8}: Login do usuário do BomControle responsável pela Atividade. (Tipo do Dado: Texto.)
{param9}: Data de inicio da atividade caso informada senão retorna a Data \"0001-01-01 00:00:00\". (Tipo do Dado: Texto.)
{param10}: Data de inicio da atividade. (Tipo do Dado: Texto.)
{param11}: Data do fim da atividade. (Tipo do Dado: Texto.)
{param12}: Hora de inicio da atividade. (Tipo do Dado: Texto.)
{param13}: Hora do fim da atividade. (Tipo do Dado: Texto.)
{param14}: Nome da Oportunidade. (Tipo do Dado: Texto.)
{param15}: Nome do Lead. (Tipo do Dado: Texto.)
{param16}: Nome do usuário do BomControle responsável pela Atividade. (Tipo do Dado: Texto.)
{param17}: Id BomControle do Tipo da Atividade. (Tipo do Dado: Inteiro.)
{param18}: Nome do Tipo da Atividade. (Tipo do Dado: Texto.)
{param19}: Ícone do Tipo da Atividade. (Tipo do Dado: Texto.)
{param20}: Array de Objetos com os dados dos contatos da Atividade. (Tipo do Dado: Array Objetos.)
{param21}: Id do contato comercial no BomControle pertencente a Atividade. (Tipo do Dado: Inteiro.)
{param22}: Nome do contato comercial pertencente a Atividade. (Tipo do Dado: Texto.)
{param23}: Array de Objetos com as informações pertencentes ao contato comercial. (Tipo do Dado: Array Objetos.)
{param24}: Tipo da informação do contato comercial. (Opções: Email, Telefone, Celular, Fax. Tipo do Dado: Texto.)
{param25}: Valor referente ao tipo da informação do contato comercial. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","AtividadeCrm","Obter","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"33a9f4e4-a17a-49bf-8787-43e8d7c4b1be","name":"Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","description":"Chave API (`ApiKey {chave}`) obtido no sistema BomControle.","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/AtividadeCrm/Obter/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 21 Jan 2020 19:46:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"562"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"Descricao\": \"Reunião com Fornecedor Teste dia 01/01/2020 09:00\",\r\n \"IdLead\": 4,\r\n \"IdOportunidade\": 1,\r\n \"Observacao\": null,\r\n \"Realizada\": true,\r\n \"IdResponsavel\": 1,\r\n \"LoginResponsavel\": \"teste@teste.com.br\",\r\n \"Data\": \"2020-01-01T09:00:00\",\r\n \"DataInicio\": \"2020-01-01T09:00:00\",\r\n \"DataFim\": \"2020-01-01T11:15:00\",\r\n \"HoraInicio\": \"09:00\",\r\n \"HoraFim\": \"11:15\",\r\n \"NomeOportunidade\": \"Venda Teste\",\r\n \"NomeLead\": \"Lead Teste\",\r\n \"NomeResponsavel\": \"Teste\",\r\n \"IdTipoAtividadeOportunidade\": 1,\r\n \"NomeTipoAtividadeOportunidade\": \"Tipo Teste\",\r\n \"IconeTipoAtividadeOportunidade\": null,\r\n \"Contatos\": [\r\n\t\t{\r\n\t\t\t\"Id\": 1,\r\n\t\t\t\"Nome\": \"Teste1\",\r\n\t\t\t\"InformacoesContato\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"Tipo\": \"Telefone\",\r\n\t\t\t\t\t\"Valor\": \"1111111111\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"Id\": 2,\r\n\t\t\t\"Nome\": \"Teste2\",\r\n\t\t\t\"InformacoesContato\": [\r\n\t\t\t\t{\r\n\t\t\t\t\t\"Tipo\": \"Telefone\",\r\n\t\t\t\t\t\"Valor\": \"1122222222\"\r\n\t\t\t\t}\r\n\t\t\t]\r\n\t\t}\r\n\t]\r\n}"}],"_postman_id":"92bf266d-ca3b-41eb-99ff-75743c94d5c8"},{"name":"AtividadeCRM - Criar","id":"66f0cfd6-d6c2-44a2-9949-c55b86004661","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/AtividadeCrm/Criar","description":"

Realiza o cadastro de uma nova Atividade associada a uma Oportunidade no BomControle.

Request

Os dados enviados para a API devem ser informados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Body

{\n  \"Titulo\": {param1},\n  \"Descricao\": {param2},\n  \"IdOportunidade\": {param3},\n  \"Realizada\": {param4},\n  \"IdAtividadeOportunidade\": {param5},\n  \"DataInicio\": {param6},\n  \"DataFim\": {param7},\n  \"TipoAgenda\": {param8}\n  \"TipoRepeticao\": {param9}\n}\n\n

Paramêtros

{param1}: Título para Atividade. (Obrigatório. Tipo do Dado: Texto.)
{param2}: Descrição para Atividade. (Opcional. Tipo do Dado: Texto.)
{param3}: Id da Oportunidade no BomControle o qual será criado a Atividade. (Obrigatório. Tipo do Dado: Inteiro.)
{param4}: Indicação se a Atividade foi realizada. (Opcional. Tipo do Dado: Booleano.)
{param5}: Id BomControle do Tipo da Atividade. (Obrigatório. Tipo do Dado: Inteiro.)
{param6}: Data de inicio da Atividade. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param7}: Data de fim da Atividade. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param8}: Id do Tipo da Agenda. (Opcional. Tipo do Dado: Inteiro.)
{param9}: Id do Tipo de Repetição: 0 = Sem Repetição, 1 = Diária, 2 = Semanal, 3 = Mensal, 4 = Anual. (Opcional. Tipo do Dado: Inteiro)

\n\n

Response

Retorna o Id da Atividade criada para a Oportunidade solicitada dentro do BomControle. (Tipo do Dado: Inteiro.)

\n","urlObject":{"protocol":"https","path":["integracao","AtividadeCrm","Criar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"60e793eb-b695-4e7c-8206-7c5cda626bcc","name":"Criar","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Descricao\": \"Teste\",\r\n \"IdOportunidade\": 1,\r\n \"Observacao\": \"Observacao Teste\",\r\n \"Realizada\": true,\r\n \"IdAtividadeOportunidade\": 1,\r\n \"Contatos\": [\r\n {\r\n \"Nome\": \"Contato Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": \"1111111111\",\r\n \"Celular\": \"11222222222\",\r\n \"Fax\": \"1133333333\"\r\n }\r\n ],\r\n \"DataInicio\": \"2020-01-01 10:00:00\",\r\n \"DataFim\": \"2020-01-01 15:00:00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/AtividadeCrm/Criar"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 22 Jan 2020 15:35:56 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"1"}],"_postman_id":"66f0cfd6-d6c2-44a2-9949-c55b86004661"}],"id":"ab673635-8916-4101-b0bf-a4825f5166c4","description":"

APIs referentes as Atividades de CRM no BomControle.

\n","event":[{"listen":"prerequest","script":{"id":"3fd88459-d8b4-4cae-8c96-948dce26050c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2914a28b-32b7-4099-82b3-e53816fb9ff4","type":"text/javascript","exec":[""]}}],"_postman_id":"ab673635-8916-4101-b0bf-a4825f5166c4"},{"name":"CategoriaFinanceira","item":[{"name":"CategoriaFinanceira - Pesquisar Categorias Filhas","id":"90dd33ce-0ef8-40c6-8494-1ce685f2bac2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/CategoriaFinanceira/PesquisarCategoriasFilhas","description":"

Pesquisa as Categorias Financeiras do BomControle.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no sistema BomControle.

\n\n

Paramêtros

textoPesquisa: Pesquisa todas as Categorias contendo esse nome. (Opcional. Tipo do Dado: Texto.)
despesa: Filtrar apenas Categorias de despesa ou receita. (Opcional. Tipo do Dado: Booleano.)

\n\n

Response

Retorna um array de objetos com os dados das Categorias Financeiras:

[\n  {\n    \"Id\": {param1},\n    \"IdCategoriaPai\": {param2},\n    \"Nome\": {param3},\n    \"Despesa\": {param4},\n    \"Transferencia\": {param5},\n    \"Inicial\": {param6},\n    \"Icone\": {param7},\n    \"CodigoContabil\": {param8},\n    \"Padrao\": {param9},\n    \"OrcamentoMensal\": {param10},\n    \"OrcadoPorValor\": {param11},\n    \"DestacarFluxoCaixa\": {param12},\n    \"Desconto\": {param13},\n    \"Acrescimo\": {param14},\n    \"Aporte\": {param15},\n    \"DivisaoLucro\": {param16},\n    \"Fixa\": {param17}\n  }\n]\n

Paramêtros

{param1}: Id BomControle da Categoria Financeira. (Tipo do Dado: Inteiro.)
{param2}: Não utilizado. (Tipo do Dado: Inteiro.)
{param3}: Nome da Categoria Financeira. (Tipo do Dado: Texto.)
{param4}: Indica se é uma Categoria de despesa. (Tipo do Dado: Booleano.)
{param5}: Não utilizado. (Tipo do Dado: Booleano.)
{param6}: Não utilizado. (Tipo do Dado: Booleano.)
{param7}: Não utilizado. (Tipo do Dado: Texto.)
{param8}: Não utilizado. (Tipo do Dado: Texto.)
{param9}: Não utilizado. (Tipo do Dado: Booleano.)
{param10}: Não utilizado. (Tipo do Dado: Inteiro.)
{param11}: Não utilizado. (Tipo do Dado: Booleano.)
{param12}: Não utilizado. (Tipo do Dado: Booleano.)
{param13}: Não utilizado. (Tipo do Dado: Booleano.)
{param14}: Não utilizado. (Tipo do Dado: Booleano.)
{param15}: Não utilizado. (Tipo do Dado: Booleano.)
{param16}: Não utilizado. (Tipo do Dado: Booleano.)
{param17}: Não utilizado. (Tipo do Dado: Booleano.)

","urlObject":{"protocol":"https","path":["integracao","CategoriaFinanceira","PesquisarCategoriasFilhas"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"9904a5e5-5987-47ab-8b5e-ddb028d1daf3","name":"CategoriaFinanceira - PesquisarCategoriasFilhas","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/CategoriaFinanceira/PesquisarCategoriasFilhas?textoPesquisa=teste&despesa=true","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","CategoriaFinanceira","PesquisarCategoriasFilhas"],"query":[{"key":"textoPesquisa","value":"teste"},{"key":"despesa","value":"true"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Thu, 30 Jan 2020 18:30:48 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"877"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"IdCategoriaPai\": null,\r\n \"Nome\": \"teste\",\r\n \"Despesa\": true,\r\n \"Transferencia\": false,\r\n \"Inicial\": false,\r\n \"Icone\": null,\r\n \"CodigoContabil\": null,\r\n \"Padrao\": false,\r\n \"OrcamentoMensal\": null,\r\n \"OrcadoPorValor\": null,\r\n \"DestacarFluxoCaixa\": null,\r\n \"Desconto\": false,\r\n \"Acrescimo\": false,\r\n \"Aporte\": false,\r\n \"DivisaoLucro\": false,\r\n \"Fixa\": false\r\n }\r\n]"}],"_postman_id":"90dd33ce-0ef8-40c6-8494-1ce685f2bac2"}],"id":"be7b71d5-ac52-45a3-b70b-de629b179a16","description":"

API para obter os dados das categorias financeiras do BomControle.

\n","_postman_id":"be7b71d5-ac52-45a3-b70b-de629b179a16"},{"name":"Cliente","item":[{"name":"Cliente - Obter","id":"d4310fa4-587b-4471-b918-65e2eb3a26f7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/Obter/{id}","description":"

Obtem os dados de cadastro no BomControle do Cliente pesquisado.

Request

O request para essa API é feito informando a identificação do Cliente a ser pesquisado diretamente na URL.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: Id do Cliente no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados do Cliente.

{\n  \"Id\": {param1},\n  \"TipoPessoa\": {param2},\n  \"PaisOrigem\": {param3},\n  \"PessoaFisica\": {param4}{\n    \"Documento\": {param5},\n    \"Nome\": {param6},\n    \"Sexo\": {param7},\n    \"DataNascimento\": {param8}\n  },\n  \"PessoaJuridica\": {param9}{\n    \"Documento\": {param10},\n    \"NomeFantasia\": {param11},\n    \"RazaoSocial\": {param12},\n    \"IsentoInscricaoEstadual\": {param13},\n    \"InscricaoEstadual\": {param14},\n    \"UFInscricaoEstadual\": {param15},\n    \"InscricaoMunicipal\": {param16},\n    \"RamoAtividade\": {param17}\n  },\n  \"Bloqueado\": {param18},\n  \"Endereco\": {param19}{\n    \"Id\": {param20},\n    \"TipoLogradouro\": {param21},\n    \"Logradouro\": {param22},\n    \"Numero\": {param23},\n    \"Complemento\": {param24},\n    \"Bairro\": {param25},\n    \"Cep\": {param26},\n    \"Cidade\": {param27},\n    \"Uf\": {param28}\n  },\n  \"Contatos\": {param29}[\n    {\n      \"Id\": {param30},\n      \"IdCliente\": {param31},\n      \"IdFornecedor\": {param32},\n      \"IdFuncionario\": {param33},\n      \"Nome\": {param34},\n      \"Email\": {param35},\n      \"Telefone\": {param36},\n      \"Padrao\": {param37},\n      \"Cobranca\": {param38}\n    }\n  ],\n  \"DataCriacao\": {param39}\n}\n\n

Paramêtros

{param1}: Id BomControle do Cliente. (Tipo do Dado: Inteiro.)
{param2}: Tipo do cadastro do Cliente. (Opções: Fisica, Juridica. Tipo do Dado: Texto.)
{param3}: Nome do pais de origem do Cliente. (Tipo do Dado: Texto.)
{param4}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Física. Nullo caso seja TipoPessoa Jurídica. (Tipo do Dado: Objeto.)
{param5}: Cpf do Cliente. (Tipo do Dado: Texto.)
{param6}: Nome do Cliente. (Tipo do Dado: Texto.)
{param7}: Sexo do Cliente. (Opções: M, F, O. Tipo do Dado: Texto.)
{param8}: Data de nascimento do Cliente. (Tipo do Dado: Texto.)
{param9}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Jurídica. Nullo caso seja TipoPessoa Física. (Tipo do Dado: Objeto.)
{param10}: Cnpj do Cliente. (Tipo do Dado: Texto.)
{param11}: Nome Fantasia do Cliente. (Tipo do Dado: Texto.)
{param12}: Razão Social do Cliente. (Tipo do Dado: Texto.)
{param13}: Indica se o Cliente é isento da Inscricao Estadual. (Tipo do Dado: Texto.)
{param14}: Número da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param15}: Estado da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param16}: Número da Inscricao Municipal do Cliente. (Tipo do Dado: Texto.)
{param17}: Ramo de atividade do Cliente. (Tipo do Dado: Texto.)
{param18}: Indica se o Cliente esta bloqueado no BomControle. (Tipo do Dado: Booleano.)
{param19}: Objeto com os dados de endereço do Cliente. (Tipo do Dado: Objeto.)
{param20}: Id do endereço do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param21}: Tipo de logradouro do Cliente. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param22}: Logradouro do Cliente. (Tipo do Dado: Texto.)
{param23}: Número do logradouro do Cliente. (Tipo do Dado: Texto.)
{param24}: Complemento do logradouro do Cliente. (Tipo do Dado: Texto.)
{param25}: Bairro do logradouro do Cliente. (Tipo do Dado: Texto.)
{param26}: Cep do logradouro do Cliente. (Tipo do Dado: Texto.)
{param27}: Cidade do logradouro do Cliente. (Tipo do Dado: Texto.)
{param28}: Sigla do Estado do logradouro do Cliente. (Tipo do Dado: Texto.)
{param29}: Array de Objetos com os dados de contatos do Cliente. (Tipo do Dado: Array de Objetos.)
{param30}: Id do contato do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param31}: Id do Cliente no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param32}: Não utilizado. (Tipo do Dado: Inteiro.)
{param33}: Não utilizado. (Tipo do Dado: Inteiro.)
{param34}: Nome do contato do Cliente. (Tipo do Dado: Texto.)
{param35}: E-mail do contato do Cliente. (Tipo do Dado: Texto.)
{param36}: Telefone do contato do Cliente. (Tipo do Dado: Texto.)
{param37}: Indica se é o contato principal do Cliente. (Tipo do Dado: Booleano.)
{param38}: Indica se o contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)
{param39}: Data de Criação do Cliete. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Cliente","Obter","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"7d27f749-d3ec-438d-b4e3-573be82bb0c9","name":"Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/Obter/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 22 Jan 2020 16:55:53 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"461"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"TipoPessoa\": \"Juridica\",\r\n \"PaisOrigem\": \"Brasil\",\r\n \"PessoaFisica\": null,\r\n \"PessoaJuridica\": {\r\n \"Documento\": \"123456789000100\",\r\n \"NomeFantasia\": \"Cliente Teste\",\r\n \"RazaoSocial\": \"Cliente Teste\",\r\n \"IsentoInscricaoEstadual\": false,\r\n \"InscricaoEstadual\": null,\r\n \"UFInscricaoEstadual\": \"1\",\r\n \"InscricaoMunicipal\": null,\r\n \"RamoAtividade\": null\r\n },\r\n \"Bloqueado\": false,\r\n \"Endereco\": {\r\n \"Id\": 1,\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niteroi\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": \"3 Andar\",\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510-210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdCliente\": 1,\r\n \"IdFornecedor\": 0,\r\n \"IdFuncionario\": 0,\r\n \"Nome\": \"Contato Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": \"1111111111\",\r\n \"Padrao\": true,\r\n \"Cobranca\": true\r\n }\r\n ]\r\n}"}],"_postman_id":"d4310fa4-587b-4471-b918-65e2eb3a26f7"},{"name":"Cliente - Pesquisar","id":"3b4077ce-7489-4c23-8a01-3d5039b01b94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/Pesquisar","description":"

Pesquisa de Clientes conforme a condição informada no filtro.

Request

O request para essa API é feito através de Querystring usando o paramêtro informado abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{pesquisa}: Parte do nome ou documento (cpf ou cnpj) dos Clientes a serem pesquisados. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Retorna um arrays de objetos com os dados dos clientes.

[\n    {\n      \"Id\": {param1},\n      \"TipoPessoa\": {param2},\n      \"PaisOrigem\": {param3},\n      \"PessoaFisica\": {param4}{\n        \"Documento\": {param5},\n        \"Nome\": {param6},\n        \"Sexo\": {param7},\n        \"DataNascimento\": {param8}\n      },\n      \"PessoaJuridica\": {param9}{\n        \"Documento\": {param10},\n        \"NomeFantasia\": {param11},\n        \"RazaoSocial\": {param12},\n        \"IsentoInscricaoEstadual\": {param13},\n        \"InscricaoEstadual\": {param14},\n        \"UFInscricaoEstadual\": {param15},\n        \"InscricaoMunicipal\": {param16},\n        \"RamoAtividade\": {param17}\n      },\n      \"Bloqueado\": {param18},\n      \"Endereco\": {param19}{\n        \"Id\": {param20},\n        \"TipoLogradouro\": {param21},\n        \"Logradouro\": {param22},\n        \"Numero\": {param23},\n        \"Complemento\": {param24},\n        \"Bairro\": {param25},\n        \"Cep\": {param26},\n        \"Cidade\": {param27},\n        \"Uf\": {param28}\n      },\n      \"Contatos\": {param29}[\n        {\n          \"Id\": {param30},\n          \"IdCliente\": {param31},\n          \"IdFornecedor\": {param32},\n          \"IdFuncionario\": {param33},\n          \"Nome\": {param34},\n          \"Email\": {param35},\n          \"Telefone\": {param36},\n          \"Padrao\": {param37},\n          \"Cobranca\": {param38}\n        }\n      ],\n      \"DataCriacao\": {param39}\n    }\n]\n\n

Paramêtros

{param1}: Id BomControle do Cliente. (Tipo do Dado: Inteiro.)
{param2}: Tipo do cadastro do Cliente. (Opções: Fisica, Juridica. Tipo do Dado: Texto.)
{param3}: Nome do pais de origem do Cliente. (Tipo do Dado: Texto.)
{param4}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Fisica. Nullo caso seja TipoPessoa Juridica. (Tipo do Dado: Objeto.)
{param5}: Cpf do Cliente. (Tipo do Dado: Texto.)
{param6}: Nome do Cliente. (Tipo do Dado: Texto.)
{param7}: Sexo do Cliente. (Opções: M, F, O. Tipo do Dado: Texto.)
{param8}: Data de nascimento do Cliente. (Tipo do Dado: Texto.)
{param9}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Juridica. Nullo caso seja TipoPessoa Fisica. (Tipo do Dado: Objeto.)
{param10}: Cnpj do Cliente. (Tipo do Dado: Texto.)
{param11}: Nome Fantasia do Cliente. (Tipo do Dado: Texto.)
{param12}: Razão Social do Cliente. (Tipo do Dado: Texto.)
{param13}: Indica se o Cliente é isento da Inscricao Estadual. (Tipo do Dado: Texto.)
{param14}: Número da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param15}: Estado da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param16}: Número da Inscricao Municipal do Cliente. (Tipo do Dado: Texto.)
{param17}: Ramo de atividade do Cliente. (Tipo do Dado: Texto.)
{param18}: Indica se o Cliente esta bloqueado no BomControle. (Tipo do Dado: Booleano.)
{param19}: Objeto com os dados de endereço do Cliente. (Tipo do Dado: Objeto.)
{param20}: Id do endereço do Cliente no BomControle. (Tipo do Dado: Inteiro)
{param21}: Tipo de logradouro doCliente. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param22}: Logradouro do Cliente. (Tipo do Dado: Texto.)
{param23}: Número do logradouro do Cliente. (Tipo do Dado: Texto.)
{param24}: Complemento do logradouro do Cliente. (Tipo do Dado: Texto.)
{param25}: Bairro do logradouro do Cliente. (Tipo do Dado: Texto.)
{param26}: Cep do logradouro do Cliente. (Tipo do Dado: Texto.)
{param27}: Cidade do logradouro do Cliente. (Tipo do Dado: Texto.)
{param28}: Sigla do Estado do logradouro do Cliente. (Tipo do Dado: Texto.)
{param29}: Array de Objetos com os dados de contatos do Cliente. (Tipo do Dado: Array de Objetos.)
{param30}: Id do contato do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param31}: Id do Cliente no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param32}: Não utilizado. (Tipo do Dado: Inteiro.)
{param33}: Não utilizado. (Tipo do Dado: Inteiro.)
{param34}: Nome do contato do Cliente. (Tipo do Dado: Texto.)
{param35}: E-mail do contato do Cliente. (Tipo do Dado: Texto.)
{param36}: Telefone do contato do Cliente. (Tipo do Dado: Texto.)
{param37}: Indica se é o contato principal do Cliente. (Tipo do Dado: Booleano.)
{param38}: Indica se o contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)
{param39}: Data de Criação do Cliente. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Cliente","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"c75eae82-348a-4b38-81be-09167be97faf","name":"Cliente - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/Pesquisar?pesquisa=teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Cliente","Pesquisar"],"query":[{"key":"pesquisa","value":"teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Thu, 23 Jan 2020 18:13:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"1972"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"TipoPessoa\": \"Juridica\",\r\n \"PaisOrigem\": \"Brasil\",\r\n \"PessoaFisica\": null,\r\n \"PessoaJuridica\": {\r\n \"Documento\": \"123456789000100\",\r\n \"NomeFantasia\": \"Cliente Teste\",\r\n \"RazaoSocial\": \"Cliente Teste\",\r\n \"IsentoInscricaoEstadual\": false,\r\n \"InscricaoEstadual\": null,\r\n \"UFInscricaoEstadual\": 1,\r\n \"InscricaoMunicipal\": null,\r\n \"RamoAtividade\": null\r\n },\r\n \"Bloqueado\": false,\r\n \"Endereco\": {\r\n\t \"Id\": 1,\r\n\t \"TipoLogradouro\": \"Rua\",\r\n\t \"Logradouro\": \"Niteroi\",\r\n\t \"Numero\": \"265\",\r\n\t \"Complemento\": \"3 Andar\",\r\n\t \"Bairro\": \"Centro\",\r\n\t \"Cep\": \"09510-210\",\r\n\t \"Cidade\": \"São Caetano do Sul\",\r\n\t \"Uf\": \"SP\"\r\n\t },\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdCliente\": 1,\r\n \"Nome\": \"Teste 1\",\r\n \"Email\": null,\r\n \"Telefone\": \"1111111111\",\r\n \"Padrao\": true,\r\n \"Cobranca\": false\r\n },\r\n {\r\n \"Id\": 2,\r\n \"IdCliente\": 1,\r\n \"IdFornecedor\": 0,\r\n\t\t\"IdFuncionario\": 0,\r\n \"Nome\": \"Teste 2\",\r\n \"Email\": \"teste2@teste.com.br\",\r\n \"Telefone\": null,\r\n \"Padrao\": false,\r\n \"Cobranca\": true\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"3b4077ce-7489-4c23-8a01-3d5039b01b94"},{"name":"Cliente - Criar","id":"e5010e52-ec32-4caf-9c72-d1acf6af717f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/Criar","description":"

Realiza o cadastro de um novo Cliente no BomControle.

Request

Os dados enviados para a API devem ser informados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Body

{\n  \"Endereco\":{param1}{\n    \"TipoLogradouro\": {param2},\n    \"Logradouro\": {param3},\n    \"Numero\": {param4},\n    \"Complemento\": {param5},\n    \"Bairro\": {param6},\n    \"Cep\": {param7},\n    \"Cidade\": {param8},\n    \"Uf\": {param9}\n  },\n  \"Contatos\": {param10}[\n    {\n      \"Nome\": {param11},\n      \"Email\": {param12},\n      \"Telefone\": {param13},\n      \"Padrao\": {param14},\n      \"Cobranca\": {param15}\n    }\n  ],\n  \"PessoaFisica\": {param16} {\n    \"Documento\": {param17},\n    \"Nome\": {param18},\n    \"Sexo\": {param19}\n  },\n  \"PessoaJuridica\": {param20}{\n    \"Documento\": {param21},\n    \"NomeFantasia\": {param22},\n    \"RazaoSocial\": {param23},\n    \"IsentoInscricaoEstadual\": {param24},\n    \"InscricaoEstadual\": {param25},\n    \"UFInscricaoEstadual\": {param26},\n    \"InscricaoMunicipal\": {param27}\n  }\n}\n

Paramêtros

{param1}: Objeto com os dados de endereço do Cliente. (Opcional. Tipo do Dado: Objeto.)
{param2}: Tipo de logradouro do Cliente. Caso não informado o sistema utiliza o tipo padrão \"Rua\". (Opcional. Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param3}: Logradouro do Cliente. (Opcional. Tipo do Dado: Texto.)
{param4}: Número do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param5}: Complemento do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param6}: Bairro do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param7}: Cep do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param8}: Cidade do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param9}: Sigla do Estado do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param10}: Array de Objetos com os dados de contatos do Cliente. (Opcional. Tipo do Dado: Array de Objetos.)
{param11}: Nome do Contato do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param12}: E-mail do Contato do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param13}: Telefone do Contato do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param14}: Indica se é o Contato principal do Cliente. (Opcional. Tipo do Dado: Booleano.)
{param15}: Indica se o Contato esta cadastrado para recebimento de cobranças do BomControle. (Opcional. Tipo do Dado: Booleano.)
{param16}: Objeto com os dados do Cliente caso ele seja pessoa Física. (Opcional. Tipo do Dado: Objeto.)
{param17}: Cpf do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param18}: Nome do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param19}: Sexo do Cliente. (Opcional. Opções: M, MASCULINO, F, FEMININO, O, OUTROS. Tipo do Dado: Texto.)
{param20}: Objeto com os dados do Cliente caso ele seja pessoa Juridica. (Opcional. Tipo do Dado: Objeto.)
{param21}: Cnpj do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param22}: Nome Fantasia do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param23}: Razão Social do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param24}: Indica se o Cliente é isento da Inscricao Estadual. (Opcional. Tipo do Dado: Texto.)
{param25}: Número da Inscricao Estadual do Cliente. (Opcional. Tipo do Dado: Texto.)
{param26}: Estado da Inscricao Estadual do Cliente. (Opcional. Tipo do Dado: Texto.)
{param27}: Número da Inscricao Municipal do Cliente. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Retorna o Id do Cliente cadastrado no BomControle. (Tipo do Dado: Inteiro.)

\n","urlObject":{"protocol":"https","path":["integracao","Cliente","Criar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"9ecb013d-d989-4512-9a5a-561edb5cfb98","name":"Cliente - Criar","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t \"Endereco\": {\r\n\t\t\"TipoLogradouro\": \"Rua\",\r\n\t \"Logradouro\": \"Niteroi\",\r\n\t \"Numero\": \"265\",\r\n\t \"Complemento\": \"3 Andar\",\r\n\t \"Bairro\": \"Centro\",\r\n\t \"Cep\": \"09510-210\",\r\n\t \"Cidade\": \"São Caetano do Sul\",\r\n\t \"Uf\": \"SP\"\r\n\t },\r\n\t \"Contatos\": [\r\n\t\t{\r\n\t\t \"Nome\": \"Teste 1\",\r\n\t\t \"Email\": \"teste1@teste.com.br\",\r\n\t\t \"Telefone\": \"1111111111\",\r\n\t\t \"Padrao\": true,\r\n\t\t \"Cobranca\": true\r\n\t\t}\r\n\t ],\r\n\t \"PessoaJuridica\": {\r\n\t\t\"Documento\": \"123456789000100\",\r\n\t\t\"NomeFantasia\": \"Cliente Teste\",\r\n\t\t\"RazaoSocial\": \"Cliente Teste\",\r\n\t\t\"IsentoInscricaoEstadual\": false,\r\n\t\t\"InscricaoEstadual\": null,\r\n\t\t\"UFInscricaoEstadual\": null,\r\n\t\t\"InscricaoMunicipal\": null\r\n\t }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/Criar"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Thu, 23 Jan 2020 19:37:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"3"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"1"}],"_postman_id":"e5010e52-ec32-4caf-9c72-d1acf6af717f"},{"name":"Cliente - Alterar","id":"cd3cef4f-5d9e-46e3-998c-197e9e596b11","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/Alterar/{id}","description":"

Altera os dados de cadastro do Cliente no BomControle.

Request

O request para essa API é feito informando o Id do Cliente do BomControle na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do cliente dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"PessoaFisica\": {param1} {\n    \"Documento\": {param2},\n    \"Nome\": {param3},\n    \"Sexo\": {param4}\n  },\n  \"PessoaJuridica\": {param5} {\n    \"Documento\": {param6},\n    \"NomeFantasia\": {param7},\n    \"RazaoSocial\": {param8},\n    \"IsentoInscricaoEstadual\": {param9},\n    \"InscricaoEstadual\": {param10},\n    \"UFInscricaoEstadual\": {param11},\n    \"InscricaoMunicipal\": {param12}\n  }\n}\n

Paramêtros

{param1}: Objeto com os dados do Cliente caso ele seja pessoa Física. (Opcional. Tipo do Dado: Objeto.)
{param2}: Cpf do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param3}: Nome do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param4}: Sexo do Cliente. (Opcional. Opções: M, MASCULINO, F, FEMININO, O, OUTROS. Tipo do Dado: Texto.)
{param5}: Objeto com os dados do Cliente caso ele seja pessoa Juridica. (Opcional. Tipo do Dado: Objeto.)
{param6}: Cnpj do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param7}: Nome Fantasia do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param8}: Razão Social do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param9}: Indica se o Cliente é isento da Inscricao Estadual. (Opcional. Tipo do Dado: Texto.)
{param10}: Número da Inscricao Estadual do Cliente. (Opcional. Tipo do Dado: Texto.)
{param11}: Estado da Inscricao Estadual do Cliente. (Opcional. Tipo do Dado: Texto.)
{param12}: Número da Inscricao Municipal do Cliente. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Cliente","Alterar","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"0aa2cd3e-c106-4027-9df8-42d5ee3f9847","name":"Cliente - Alterar","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"PessoaFisica\": null,\r\n \"PessoaJuridica\": {\r\n\t\"Documento\": \"123456789000100\",\r\n\t\"NomeFantasia\": \"Cliente Teste\",\r\n\t\"RazaoSocial\": \"Cliente Teste\",\r\n\t\"IsentoInscricaoEstadual\": false,\r\n\t\"InscricaoEstadual\": null,\r\n\t\"UFInscricaoEstadual\": null,\r\n\t\"InscricaoMunicipal\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/Alterar/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 24 Jan 2020 14:04:16 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"cd3cef4f-5d9e-46e3-998c-197e9e596b11"},{"name":"Cliente - Alterar Contatos","id":"ec9dcfe1-1c8a-434a-b813-346949a2f8af","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/AlterarContatos/{id}","description":"

Adiciona novos Contatos ao cadastro do Cliente no BomControle.

Request

O request para essa API é feito informando o Id do Cliente no BomControle na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do cliente no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"Contatos\": {param1} [\n    {\n      \"Nome\": {param2},\n      \"Email\": {param3},\n      \"Telefone\": {param4},\n      \"Padrao\": {param5},\n      \"Cobranca\": {param6}\n    }\n  ]\n}\n

Paramêtros

{param1}: Array de Objetos com os dados dos Contatos a serem adicionados ao Cliente. (Obrigatorio. Tipo do Dado: Array de Objetos.)
{param2}: Nome do Contato do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param3}: E-mail do Contato do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param4}: Telefone do Contato do Cliente. (Obrigatório. Tipo do Dado: Texto.)
{param5}: Indica se é o Contato principal do Cliente. (Opcional. Tipo do Dado: Booleano.)
{param6}: Indica se o Contato esta cadastrado para recebimento de cobranças do BomControle. (Opcional. Tipo do Dado: Booleano.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Cliente","AlterarContatos","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"8b6946a0-ea67-49b2-a812-f30884ba0be1","name":"Cliente - Alterar Contatos","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA=="},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Contatos\": [\r\n {\r\n \"Nome\": \"Teste3\",\r\n \"Email\": \"teste3@teste.com.br\",\r\n \"Telefone\": \"1133333333\",\r\n \"Padrao\": false,\r\n \"Cobranca\": false\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/AlterarContatos/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 24 Jan 2020 14:31:49 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"ec9dcfe1-1c8a-434a-b813-346949a2f8af"},{"name":"Cliente - Alterar Endereco","id":"786a9e30-7a0a-4918-a765-f4189ec84af4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/AlterarEndereco/{id}","description":"

Atualiza os dados de Endereço do cadastro do Cliente no BomControle.

Request

O request para essa API é feito informando o Id do Cliente no BomControle na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do cliente no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n    \"TipoLogradouro\": {param1},\n    \"Logradouro\": {param2},\n    \"Numero\": {param3},\n    \"Complemento\": {param4},\n    \"Bairro\": {param5},\n    \"Cep\": {param6},\n    \"Cidade\": {param7},\n    \"Uf\": {param8}\n}\n

Paramêtros

{param1}: Tipo de logradouro do Cliente. Caso não informado o sistema utiliza o tipo padrão \"Rua\". (Opcional. Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param2}: Logradouro do Cliente. (Opcional. Tipo do Dado: Texto.)
{param3}: Número do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param4}: Complemento do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param5}: Bairro do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param6}: Cep do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param7}: Cidade do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)
{param8}: Sigla do Estado do logradouro do Cliente. (Opcional.Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Cliente","AlterarEndereco","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"1d35b1a5-15e2-45cf-b69f-c7702732c063","name":"Cliente - Alterar Endereco","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n\t\"TipoLogradouro\": \"Rua\",\r\n\t\"Logradouro\": \"Niteroi\",\r\n\t\"Numero\": \"265\",\r\n\t\"Complemento\": \"3 Andar\",\r\n\t\"Bairro\": \"Centro\",\r\n\t\"Cep\": \"09510-210\",\r\n\t\"Cidade\": \"São Caetano do Sul\",\r\n\t\"Uf\": \"SP\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/AlterarEndereco/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 24 Jan 2020 14:51:25 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"786a9e30-7a0a-4918-a765-f4189ec84af4"},{"name":"Cliente - Alterar Bloqueio","id":"5d180dfa-861d-499c-9d02-f66aacb5644e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/AlterarBloqueio/{id}","description":"

Efetua o Bloqueio/Desbloqueio do cadastro do Cliente no BomControle.

Request

O request para essa API é feito informando o Id do Cliente no BomControle na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do cliente no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"Bloquear\": {param1}\n}\n

Paramêtros

{param1}: Indica se deve ser feito o Bloqueio/Desbloqueio do Cliente. (Obrigatório. Tipo do Dado: Booleano.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Cliente","AlterarBloqueio","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"5394c7f1-76dd-4331-9625-066a1ccf33b8","name":"Cliente - Bloqueio","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Bloquear\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Cliente/AlterarBloqueio/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 24 Jan 2020 15:09:22 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"5d180dfa-861d-499c-9d02-f66aacb5644e"}],"id":"2c7a3a5f-72ac-43cd-ab36-8b01d0536c11","description":"

APIs para a criação e manipulação de cadastros de clientes no BomControle.

\n","event":[{"listen":"prerequest","script":{"id":"a4c3793b-9278-490f-aa19-be9849b07692","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"0e7fe597-a247-4d6c-829e-402817855435","type":"text/javascript","exec":[""]}}],"_postman_id":"2c7a3a5f-72ac-43cd-ab36-8b01d0536c11"},{"name":"ContaFinanceira","item":[{"name":"ContaFinanceira - Pesquisar","id":"1087e039-2fc3-4328-afb9-178dd218b297","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/ContaFinanceira/Pesquisar","description":"

Pesquisa as Contas Financeiras conforme os filtros utilizados.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no sistema BomControle.

\n\n

Paramêtros

idEmpresa: Id BomControle da Empresa relacionada as contas a serem pesquisadas. (Obrigatório. Tipo do Dado: Inteiro.)
textoPesquisa: Pesquisa as contas contendo o nome informado. (Opcional. Tipo do Dado: Texto.)
permiteRecebimento: Pesquisa apenas contas que permitem o recebimento. (Opcional. Tipo do Dado: Booleano.)
permitePagamento: Pesquisa apenas contas que permitem o pagamento. (Opcional. Tipo do Dado: Booleano.)
emiteBoleto: Pesquisa contas que podem emitir boletos. (Opcional. Tipo do Dado: Booleano.)
tipoConta: Pesquisa contas pelo tipo. (Opcional. Opções: Dinheiro, Bancaria, Credito, MeiosPagamento. Tipo do Dado: Texto.)

\n\n

Response

Retorna um array de objetos com os dados das Contas Financeiras:

[\n  {\n    \"Id\": {param1},\n    \"Nome\": {param2},\n    \"Tipo\": {param3},\n    \"NomeTipo\": {param4},\n    \"Agencia\": {param5},\n    \"Conta\": {param6},\n    \"DigitoAgencia\": {param7},\n    \"DigitoConta\": {param8},\n    \"NomeBanco\": {param9},\n    \"NumeroBanco\": {param10},\n    \"PermiteRecebimento\": {param11},\n    \"PermitePagamento\": {param12},\n    \"EmiteBoleto\": {param13}\n  }\n]\n

Paramêtros

{param1}: Id BomControle da Conta Financeira. (Tipo do Dado: Inteiro.)
{param2}: Nome da Conta Financeira. (Tipo do Dado: Texto.)
{param3}: Tipo da Conta Financeira. (Opções: 1 - Dinheiro, 2 - Bancaria, 3 - Credito, 4 - MeiosPagamento. Tipo do Dado: Inteiro.)
{param4}: Nome do Tipo da Conta Financeira. (Tipo do Dado: Texto.)
{param5}: Agência da Conta Financeira. (Tipo do Dado: Texto.)
{param6}: Número da Conta da Conta Financeira. (Tipo do Dado: Texto.)
{param7}: Dígito da Agência da Conta Financeira. (Tipo do Dado: Texto.)
{param8}: Dígito do Número da Conta da Conta Financeira. (Tipo do Dado: Texto.)
{param9}: Nome do Banco na Febraban. (Tipo do Dado: Texto.)
{param10}: Número do Banco na Febraban. (Tipo do Dado: Texto.)
{param11}: Indica se a Conta Financeira permite recebimentos. (Tipo do Dado: Booleano.)
{param12}: Indica se a Conta Financeira permite pagamentos. (Tipo do Dado: Booleano.)
{param13}: Indica se a Conta Financeira permite emissão de boletos. (Tipo do Dado: Booleano.)

","urlObject":{"protocol":"https","path":["integracao","ContaFinanceira","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"af9f95bf-b80a-49cc-8cd5-be82a03606bf","name":"ContaFinanceira - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/ContaFinanceira/Pesquisar?idEmpresa=1&textoPesquisa=teste&permiteRecebimento=true&permitePagamento=true&emiteBoleto=true&tipoConta=Bancaria","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","ContaFinanceira","Pesquisar"],"query":[{"key":"idEmpresa","value":"1"},{"key":"textoPesquisa","value":"teste"},{"key":"permiteRecebimento","value":"true"},{"key":"permitePagamento","value":"true"},{"key":"emiteBoleto","value":"true"},{"key":"tipoConta","value":"Bancaria"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 31 Jan 2020 15:56:58 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"390"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"Nome\": \"TESTE\",\r\n \"Tipo\": 2,\r\n \"NomeTipo\": \"Bancária\",\r\n \"Agencia\": \"1111\",\r\n \"Conta\": \"111111\",\r\n \"DigitoAgencia\": \"0\",\r\n \"DigitoConta\": \"1\",\r\n \"NomeBanco\": \"Banco Santander (Brasil) S.A.\",\r\n \"NumeroBanco\": \"033\",\r\n \"PermiteRecebimento\": true,\r\n \"PermitePagamento\": true,\r\n \"EmiteBoleto\": true\r\n }\r\n]"}],"_postman_id":"1087e039-2fc3-4328-afb9-178dd218b297"}],"id":"f1845477-11f6-4a92-8f86-f1f3bb69326f","description":"

API para obter os dados das contas financeiras do BomControle.

\n","_postman_id":"f1845477-11f6-4a92-8f86-f1f3bb69326f"},{"name":"Departamento","item":[{"name":"Departamento - Pesquisar","id":"1fb613d8-2099-42b8-ae78-16771da0fd45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Departamento/Pesquisar","description":"

Pesquisa ao Departamento conforme o filtro utilizado.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no sistema BomControle.

\n\n

Paramêtros

textoPesquisa: Pesquisa os departamentos contendo o nome informado. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Retorna um array de objetos com os dados dos Departamentos:

[\n  {\n    \"Id\": {param1},\n    \"Nome\": {param2},\n    \"Tipo\": {param3},\n    \"NomeTipo\": {param4}\n  }\n]\n

Paramêtros

{param1}: Id BomControle do Departamento. (Tipo do Dado: Inteiro.)
{param2}: Nome do Departamento. (Tipo do Dado: Texto.)
{param3}: Tipo do Departamento. (Opções: 1 - Administrativo, 2 - Produtivo. Tipo do Dado: Inteiro.)
{param4}: Nome do Tipo do Departamento. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Departamento","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"b2890643-7202-4f5c-8b9a-3e90ab59b93a","name":"Departamento - Pesquisa","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Departamento/Pesquisar?textoPesquisa=teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Departamento","Pesquisar"],"query":[{"key":"textoPesquisa","value":"teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 31 Jan 2020 16:25:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"109"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"Nome\": \"Teste\",\r\n \"Tipo\": 1,\r\n \"NomeTipo\": \"Administrativo\"\r\n }\r\n]"}],"_postman_id":"1fb613d8-2099-42b8-ae78-16771da0fd45"}],"id":"649070e6-fa43-4f7d-8e00-076fb9f76df7","description":"

API para pesquisa de Departamentos no BomControle.

\n","_postman_id":"649070e6-fa43-4f7d-8e00-076fb9f76df7"},{"name":"Empresa","item":[{"name":"Empresa - Pesquisar","id":"c3d7ec1b-0b41-4b71-b7ad-d620d48f9835","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Empresa/Pesquisar","description":"

Pesquisa as Empresas cadastradas no BomControle conforme o filtro utilizado.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

pesquisa: Localiza as Empresas do BomControle contendo o CNPJ ou Nome Fantasia informado. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Retorna um array de objetos com os dados das Empresas:

[\n  {\n    \"Id\": {param1},\n    \"Documento\": {param2},\n    \"Nome\": {param3},\n    \"Padrao\": {param4}\n  }\n]\n

Paramêtros

{param1}: Id BomControle da Empresa. (Tipo do Dado: Inteiro.)
{param2}: Cnpj da Empresa. (Tipo do Dado: Texto.)
{param3}: Nome Fantasia da Empresa. (Tipo do Dado: Texto.)
{param4}: Indica se é Empresa padrão do BomControle. (Tipo do Dado: Booleano.)

","urlObject":{"protocol":"https","path":["integracao","Empresa","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"ee5cf196-ec64-4ad1-87c9-28c2b61847e8","name":"Empresa - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Empresa/Pesquisar?pesquisa=Teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Empresa","Pesquisar"],"query":[{"key":"pesquisa","value":"Teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 24 Jan 2020 15:27:40 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"561"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"Documento\": \"1234567890000100\",\r\n \"Nome\": \"Testes\",\r\n \"Padrao\": false\r\n }\r\n]"}],"_postman_id":"c3d7ec1b-0b41-4b71-b7ad-d620d48f9835"}],"id":"1b6501d8-11ac-4d00-b2fc-d6a2f6507a5f","description":"

APIs para consulta das Empresas no BomControle.

\n","event":[{"listen":"prerequest","script":{"id":"6d71e4ec-29a8-4d00-9679-b2a5a02473d1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2c1e3462-6cac-4202-88b2-45114b867aa2","type":"text/javascript","exec":[""]}}],"_postman_id":"1b6501d8-11ac-4d00-b2fc-d6a2f6507a5f"},{"name":"Fatura","item":[{"name":"Fatura - Obter","id":"b6655e34-c67b-4408-bcc6-88f9e371236e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/Obter/{id}","description":"

Obtem os dados da Fatura do BomControle pesquisada.

Request

O request para essa API é feito informando a identificação da Fatura a ser pesquisada diretamente na URL.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: Id da Fatura dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados da Fatura:

{\n  \"Id\": {param1},\n  \"IdParcela\": {param2},\n  \"IdMovimentacaoFinanceira\": {param3},\n  \"TipoFatura\": {param4},\n  \"NomeTipoFatura\": {param5},\n  \"DataVencimento\": {param6},\n  \"DataCompetencia\": {param7},\n  \"Valor\": {param8},\n  \"DataPagamento\": {param9},\n  \"ValorPagamento\": {param10},\n  \"NumeroParcela\": {param11},\n  \"Quitado\": {param12},\n  \"Conciliado\": {param13},\n  \"FormaPagamento\": {param14},\n  \"NomeFormaPagamento\": {param15},\n  \"EmiteBoleto\": {param16},\n  \"ObservacaoBoleto\": {param17},\n  \"IdBoleto\": {param18},\n  \"LinkBoleto\": {param19},\n  \"EmiteNotaFiscal\": {param20},\n  \"ObservacaoNotaFiscal\": {param21},\n  \"LinkNotaFiscal\": {param22},\n  \"LinkXmlNotaFiscal\": {param23},\n  \"DataPromessaPagamento\": {param24},\n  \"ClienteNaoVaiPagar\": {param25}\n}\n

Paramêtros

{param1}: Id BomControle da Fatura. (Tipo do Dado: Inteiro.)
{param2}: Id da Parcela no BomControle o qual a Fatura pertence. (Tipo do Dado: Texto.)
{param3}: Id da Movimentação no BomControle o qual a Fatura pertence. (Tipo do Dado: Texto.)
{param4}: Indica o tipo da Fatura. (Opções: 0 - Faturamento, 1 - Renegociacao. Tipo do Dado: Inteiro.)
{param5}: Indica o tipo da Fatura. (Opções: Faturamento, Renegociacao. Tipo do Dado: Texto.)
{param6}: Data de vencimento da Fatura. (Tipo do Dado: Texto.)
{param7}: Data de competência da Fatura. (Tipo do Dado: Texto.)
{param8}: Valor da Fatura. (Tipo do Dado: Decimal.)
{param9}: Data de pagamento da Fatura. (Tipo do Dado: Texto.)
{param10}: Valor do pagamento da Fatura. (Tipo do Dado: Decimal.)
{param11}: Número da Parcela o qual a Fatura pertence. (Tipo do Dado: Inteiro.)
{param12}: Indica se a Parcela o qual a Fatura pertence foi quitada. (Tipo do Dado: Booleano.)
{param13}: Indica se a Parcela o qual a Fatura pertence foi conciliada. (Tipo do Dado: Booleano.)
{param14}: Forma de pagamento da Fatura. (Opções: 1 - Dinheiro,2 - Deposito,3 - Cheque,4 - DebitoEmContaCorrente,5 - TransferenciaBancaria,6 - CartaoCredito,7 - CartaoDebito,8 - DOC,9 - TED,10 - TransferenciaAplicativo,11 - TransferenciaMoedaVirtual,12 - InternetBanking,13 - BoletoBancario,14 - DescontoEmFolha,15 - Outros,16 - DebitoConta. Tipo do Dado: Inteiro.)
{param15}: Forma de pagamento da Fatura. (Opções: Dinheiro,Deposito,Cheque,DebitoEmContaCorrente,TransferenciaBancaria,CartaoCredito,CartaoDebito,DOC,TED,TransferenciaAplicativo,TransferenciaMoedaVirtual,InternetBanking,BoletoBancario,DescontoEmFolha,Outros,DebitoConta. Tipo do Dado: Texto.)
{param16}: Indica se a Fatura emite boleto. (Tipo do Dado: Booleano.)
{param17}: Observação do boleto da Fatura. (Tipo do Dado: Texto.)
{param18}: Id BomControle do boleto da Fatura. (Tipo do Dado: Inteiro.)
{param19}: Link para o PDF do boleto da Fatura. (Tipo do Dado: Texto.)
{param20}: Indica se a Fatura emite nota fiscal. (Tipo do Dado: Booleano.)
{param21}: Observação da nota fiscal da Fatura. (Tipo do Dado: Texto.)
{param22}: Link para o acesso ao PDF da nota fiscal da Fatura. (Tipo do Dado: Texto.)
{param23}: Link para o acesso ao XML da nota fiscal da Fatura. (Tipo do Dado: Texto.)
{param24}: Não utilizado. (Tipo do Dado: Texto.)
{param25}: Indica se o cliente não vai pagar a Fatura. (Tipo do Dado: Booleano.)

","urlObject":{"protocol":"https","path":["integracao","Fatura","Obter","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"7d529e8b-1c6e-4c6e-9711-e9d90efb6d0b","name":"Fatura - Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/Obter/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 24 Jan 2020 15:50:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"1004"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"IdParcela\": \"0f086972-eb94-4f7b-99bc-6cf6a6412758\",\r\n \"IdMovimentacaoFinanceira\": \"80ae7963-7b4b-4747-8ad8-db90011673d4\",\r\n \"TipoFatura\": 0,\r\n \"NomeTipoFatura\": \"Faturamento\",\r\n \"DataVencimento\": \"2020-01-01T10:00:00\",\r\n \"DataCompetencia\": \"2020-01-01T00:00:00\",\r\n \"Valor\": 1.00000,\r\n \"DataPagamento\": null,\r\n \"ValorPagamento\": 0.0,\r\n \"NumeroParcela\": 1,\r\n \"Quitado\": false,\r\n \"Conciliado\": false,\r\n \"FormaPagamento\": 13,\r\n \"NomeFormaPagamento\": \"BoletoBancario\",\r\n \"EmiteBoleto\": true,\r\n \"ObservacaoBoleto\": null,\r\n \"IdBoleto\": 1,\r\n \"LinkBoleto\": null,\r\n \"EmiteNotaFiscal\": false,\r\n \"ObservacaoNotaFiscal\": null,\r\n \"LinkNotaFiscal\": null,\r\n \"LinkXmlNotaFiscal\": null,\r\n \"DataPromessaPagamento\": null,\r\n \"ClienteNaoVaiPagar\": false\r\n}"}],"_postman_id":"b6655e34-c67b-4408-bcc6-88f9e371236e"},{"name":"Fatura - Alterar Vencimento","id":"305eebbb-f823-4868-9861-9bc7f85611db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/AlterarVencimento/{id}","description":"

Altera a data de vencimento da Fatura no BomControle.

Request

O request para essa API é feito informando a identificação da Fatura diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id da Fatura dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"DataVencimento\": {param1}\n}\n

Paramêtros

{param1}: Data do novo vencimento da Fatura. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Fatura","AlterarVencimento","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"7312f172-b644-4b65-b29a-2fabe006ad58","name":"Fatura - Alterar Vencimento","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"DataVencimento\": \"2020-01-01 15:10:01\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/AlterarVencimento/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 24 Jan 2020 16:39:48 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"305eebbb-f823-4868-9861-9bc7f85611db"},{"name":"Fatura - Alterar Valor","id":"295c749d-ab1c-4f3f-a3e6-f87a427fe629","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/AlterarValor/{id}","description":"

Altera o valor da Fatura no BomControle.

Request

O request para essa API é feito informando a identificação da Fatura diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id da Fatura no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"Valor\": {param1}\n}\n

Paramêtros

{param1}: Valor da Fatura. (Obrigatório. Tipo do Dado: Decimal.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Fatura","AlterarValor","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"bf660339-3c95-44b1-9ac9-87983900f392","name":"Fatura - Alterar Valor","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Valor\": 11.55\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/AlterarValor/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 24 Jan 2020 19:10:24 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"295c749d-ab1c-4f3f-a3e6-f87a427fe629"},{"name":"Fatura - Efetuar Pagamento","id":"21539b82-b285-4521-ad9b-2efe0e646227","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"ValorLiquido\": 11.55,\r\n \"DataQuitacao\": \"2020-01-01 16:20:08\",\r\n \"DataConciliacao\": \"2020-01-01 16:20:08\",\r\n \"GerarResiduo\": false\r\n}"},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/EfeturarPagamento/{id}","description":"

Realiza a quitação da Parcela referente a Fatura no BomControle.

Request

O request para essa API é feito informando a identificação da Fatura diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id da Fatura dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"ValorLiquido\": 11.55,\n  \"DataQuitacao\": \"2020-01-01 16:20:08\",\n  \"DataConciliacao\": \"2020-01-01 16:20:08\",\n  \"GerarResiduo\": false\n}\n

Paramêtros

{param1}: Valor da Quitação. (Obrigatório. Tipo do Dado: Decimal.)
{param2}: Data da Quitação. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param3}: Data da Conciliação. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param4}: Indica se a diferença entre o valor da quitação e o valor da fatura deve gerar uma nova parcela. (Opcional. Tipo do Dado: Booleano.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Fatura","EfeturarPagamento","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"d34b6402-d715-4a29-88da-21f6cd593564","name":"Fatura - Efetuar Pagamento","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ValorLiquido\": 11.55,\r\n \"DataQuitacao\": \"2020-01-01 16:20:08\",\r\n \"GerarResiduo\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/EfeturarPagamento/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 24 Jan 2020 19:29:09 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"21539b82-b285-4521-ad9b-2efe0e646227"},{"name":"Fatura - Cancelar","id":"f35b6ba1-d752-4ed9-892c-b50fcd18f8ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/Cancelar/{id}","description":"

Realiza o cancelamento da Fatura no BomControle.

Request

O request para essa API é feito informando a identificação da Fatura diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id da Fatura no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"Motivo\": {param1}\n}\n

Paramêtros

{param1}: Motivo para o cancelamento da Fatura. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Fatura","Cancelar","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"2602b24e-b61e-4713-813c-f6d618b4e583","name":"Fatura - Cancelar","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Motivo\": \"Cancelamento Teste.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/Cancelar/1"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 27 Jan 2020 14:41:51 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"47"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f35b6ba1-d752-4ed9-892c-b50fcd18f8ca"},{"name":"Fatura - Gerar Boleto","id":"8087af66-ea18-41de-86dc-c55c3c9f4149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/GerarBoleto/{id}","description":"

Realiza a geração do Boleto da Fatura no BomControle.

Request

O request para essa API é feito informando a identificação da Fatura diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id da Fatura no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"DataVencimento\": {param1}\n}\n

Paramêtros

{param1}: Caso a data de vencimento da Fatura seja superior ou igual a data atual e não exista um boleto emitido é feito o faturamento da Fatura. Caso a data de vencimento da Fatura seja inferior a data atual é feito a reemissão do boleto com a nova data de vencimento informada e marcada a Fatura como renegociação. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mm:ss\". Tipo do Dado: Texto.)

\n\n

Response

Retorna um objeto com os dados do boleto da Fatura:

{\n\"Id\": {param1},\n\"DataVencimento\": {param2},\n\"Valor\": {param3},\n\"LinkArquivo\": {param4}\n}\n

Paramêtros

{param1}: Id BomControle do boleto da Fatura. (Tipo do Dado: Inteiro.)
{param2}: Data de vencimento do boleto da Fatura. (Tipo do Dado: Texto.)
{param3}: Valor do boleto da Fatura. (Tipo do Dado: Decimal.)
{param4}: Link para o arquivo PDF do boleto da Fatura. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Fatura","GerarBoleto","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"cbbec3d8-3f0e-4eee-afb0-be1982cdb239","name":"Fatura - Gerar Boleto","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"DataVencimento\": \"2020-01-01 00:00:00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/GerarBoleto/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 27 Jan 2020 15:01:07 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"330"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"DataVencimento\": \"2020-01-01T00:00:00\",\r\n \"Valor\": 50.00000,\r\n \"LinkArquivo\": \"https://bom-controle-arquivos.s3-sa-east-1.amazonaws.com/1/financeiro/boletos/boleto_3105ceff-3f65-4df9-8bd2-6acc17473afe.pdf\"\r\n}"}],"_postman_id":"8087af66-ea18-41de-86dc-c55c3c9f4149"},{"name":"Fatura - Upload Anexo","id":"33b67405-ac00-44de-ba16-4fb069a8fc9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/UploadAnexo","description":"

Realiza o upload de arquivo como anexo a Movimentação da Fatura no BomControle.

Request

O request para essa API é feito através de Querystring usando o paramêtro informado abaixo, o arquivo deve ser enviado no form-data da comunicação.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

idFatura: Id da Fatura no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Fatura","UploadAnexo"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"8828ea90-c442-4979-b257-181173d92e7c","name":"Fatura - Upload Anexo","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"","type":"file","src":"/C:/TEMP/teste.png"}]},"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/UploadAnexo?idFatura=1","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Fatura","UploadAnexo"],"query":[{"key":"idFatura","value":"1"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Length","value":"53"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-SourceFiles","value":"=?UTF-8?B?QzpcRGVzZW52b2x2aW1lbnRvXEJvbUNvbnRyb2xlXGJvbWNvbnRyb2xlLWFwaV9NQVNURVJcc3JjXEFwcGxpY2F0aW9uLkFwaUludGVncmFjYW9caW50ZWdyYWNhb1xGYXR1cmFcVXBsb2FkQW5leG8=?="},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Mon, 27 Jan 2020 16:39:38 GMT"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"33b67405-ac00-44de-ba16-4fb069a8fc9d"},{"name":"Fatura - Verificar Situação Cliente","id":"a7c8f60f-4f78-4973-844d-c8b0286782a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/VerificarSituacaoCliente/{id}","description":"

Obtem a Fatura pendente do Cliente no BomControle.

Request

O request para essa API é feito informando a identificação da Fatura diretamente na URL.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: Id do Cliente no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados do boleto da Fatura:

{\n    \"IdFatura\": {param1},\n    \"DataPrevista\": {param2},\n    \"ValorPrevisto\": {param3}\n}\n

Paramêtros

{param1}: Id BomControle da Fatura. (Tipo do Dado: Inteiro.)
{param2}: Data de vencimento da Fatura. (Tipo do Dado: Texto.)
{param3}: Valor da Fatura. (Tipo do Dado: Decimal.)

","urlObject":{"protocol":"https","path":["integracao","Fatura","VerificarSituacaoCliente","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"a60fbea1-237d-4418-bb48-4859251f841a","name":"Fatura - Verificar Situação Cliente","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fatura/VerificarSituacaoCliente/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 27 Jan 2020 17:03:13 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"96"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"IdFatura\": 1,\r\n \"DataPrevista\": \"2020-01-01T00:00:00\",\r\n \"ValorPrevisto\": 10.00000\r\n}"}],"_postman_id":"a7c8f60f-4f78-4973-844d-c8b0286782a9"}],"id":"ca5215d1-34d9-48a3-945f-7b9f2ed2f84a","description":"

APIs para consulta e alteração de dados de Faturas no BomControle.

\n","event":[{"listen":"prerequest","script":{"id":"32e78839-8de7-4165-964b-920ad460e8a9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"df2e3978-11e5-4632-95f5-6d944898a2d7","type":"text/javascript","exec":[""]}}],"_postman_id":"ca5215d1-34d9-48a3-945f-7b9f2ed2f84a"},{"name":"Financeiro","item":[{"name":"Financeiro - Criar Outro Recebimento","id":"a1e477ab-c22e-47f9-8312-a167268267ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/CriarOutroRecebimento","description":"

Cria uma movimentação de recebimento no BomControle.

Request

O request para essa API é feito informando os dados no Body do request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Body

{\n      \"IdCliente\": {param1},\n      \"IdContaFinanceira\": {param2},\n      \"IdCategoriaFinanceira\": {param3},\n      \"IdDepartamento\": {param4},\n      \"FormaPagamento\": {param5} {\n        \"Boleto\": {param6} {\n          \"Observacao\": {param7}\n        },\n        \"DepositoConta\": {param8} {\n          \"NumeroBanco\": {param9},\n          \"NumeroAgencia\": {param10},\n          \"NumeroConta\": {param11}\n        },\n        \"Outros\": {param12} {\n          \"Nome\": {param13}\n        }\n      },\n      \"PrimeiroVencimento\": {param14},\n      \"DataCompetencia\": {param15},\n      \"QuantidadeParcelas\": {param16},\n      \"Valor\": {param17},\n      \"NumeroDocumento\": {param18},\n      \"Observacao\": {param19},\n      \"ValorDefinitivo\": {param20}\n}\n\n

Paramêtros

{param1}: Id BomControle do Cliente. (Obrigatório. Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Conta Financeira. (Obrigatório. Tipo do Dado: Inteiro.)
{param3}: Id BomControle da Categoria Financeira. (Obrigatório. Tipo do Dado: Inteiro.)
{param4}: Id BomControle do Departamento. (Opcional. Tipo do Dado: Inteiro.)
{param5}: Objeto contendo os dados da Forma de Pagamento da Movimentação. (Obrigatório. Tipo do Dado: Objeto.)
{param6}: Objeto contendo os dados da Forma de Pagamento de Boleto. Informar apenas quando houver emissão. (Opcional. Tipo do Dado: Objeto.)
{param7}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param8}: Objeto contendo os dados da Forma de Pagamento de Depósito em Conta. (Opcional. Tipo do Dado: Objeto.)
{param9}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param10}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param11}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param12}: Objeto contendo os dados de Outras Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param13}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param14}: Data de Vencimento da primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\" Tipo do Dado: Texto.)
{param15}: Data de Competência da primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\" Tipo do Dado: Texto.)
{param16}: Quantidade de Parcelas. (Obrigatório. Tipo do Dado: Inteiro.)
{param17}: Valor das Parcelas. (Obrigatório. Tipo do Dado: Decimal.)
{param18}: Número do documento da Movimentação. (Opcional. Tipo do Dado: Inteiro.)
{param19}: Observação da Movimentação. (Opcional. Tipo do Dado: Texto.)
{param20}: Indica se o valor é definitivo (Opcional. Tipo do Dado: Boleano.)

\n\n

Response

Retorna um objeto com os dados da Fatura:

{\n      \"IdMovimentacaoFinanceira\": {param1},\n      \"IdMovimentacaoFinanceiraParcela\": {param2}\n}\n\n

Paramêtros

{param1}: Id BomControle da Movimentação. (Tipo do Dado: Texto.)
{param2}: Id BomControle da primeira Parcela. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Financeiro","CriarOutroRecebimento"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"a0988cc0-94ae-4c30-a9de-84ef5723c2c0","name":"Financeiro - CriarOutroRecebimento","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"IdCliente\": 1,\r\n \"IdContaFinanceira\": 1,\r\n \"IdCategoriaFinanceira\": 1,\r\n \"IdDepartamento\": 0,\r\n \"FormaPagamento\": {\r\n \"Boleto\": {\r\n \"Observacao\": \"teste\"\r\n }\r\n },\r\n \"PrimeiroVencimento\": \"2020-01-01 00:00:00\",\r\n \"DataCompetencia\": \"2020-01-01 00:00:00\",\r\n \"QuantidadeParcelas\": 1,\r\n \"Valor\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/CriarOutroRecebimento"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 31 Jan 2020 18:23:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"152"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"IdMovimentacaoFinanceira\": \"cf33b3df-79cd-41ce-bb52-7d61a7cd7821\",\r\n \"IdMovimentacaoFinanceiraParcela\": \"d10ff939-b69f-4973-bfe7-0e2986515fcc\"\r\n}"}],"_postman_id":"a1e477ab-c22e-47f9-8312-a167268267ec"},{"name":"Financeiro - Criar Despesa Fornecedor","id":"0b605450-17ff-4c25-968d-f1da1b8d67e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/CriarDespesaFornecedor","description":"

Cria uma movimentação de pagamento no BomControle.

Request

O request para essa API é feito informando os dados no Body do request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Body

{\n      \"IdFornecedor\": {param1},\n      \"IdContaFinanceira\": {param2},\n      \"IdCategoriaFinanceira\": {param3},\n      \"IdDepartamento\": {param4},\n      \"FormaPagamento\": {param5} {\n        \"Boleto\": {param6} {\n          \"Observacao\": {param7},\n          \"EmiteBoleto\": {param8}\n        },\n        \"DepositoConta\": {param9} {\n          \"NumeroBanco\": {param10},\n          \"NumeroAgencia\": {param11},\n          \"NumeroConta\": {param12}\n        },\n        \"Outros\": {param13} {\n          \"Nome\": {param14}\n        }\n      },\n      \"PrimeiroVencimento\": {param15},\n      \"DataCompetencia\": {param16},\n      \"QuantidadeParcelas\": {param17},\n      \"Valor\": {param18},\n      \"NumeroDocumento\": {param19},\n      \"Observacao\": {param20},\n      \"ValorDefinitivo\": {param21}\n}\n\n

Paramêtros

{param1}: Id BomControle do Fornecedor. (Obrigatório. Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Conta Financeira. (Obrigatório. Tipo do Dado: Inteiro.)
{param3}: Id BomControle da Categoria Financeira. (Obrigatório. Tipo do Dado: Inteiro.)
{param4}: Id BomControle do Departamento. (Opcional. Tipo do Dado: Inteiro.)
{param5}: Objeto contendo os dados da Forma de Pagamento da Movimentação. (Obrigatório. Tipo do Dado: Objeto.)
{param6}: Objeto contendo os dados da Forma de Pagamento de Boleto. (Opcional. Tipo do Dado: Objeto.)
{param7}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param8}: Indica se emite o Boleto. (Opcional. Tipo do Dado: Booleano.)
{param9}: Objeto contendo os dados da Forma de Pagamento de Depósito em Conta. (Opcional. Tipo do Dado: Objeto.)
{param10}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param11}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param12}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param13}: Objeto contendo os dados de Outras Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param14}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param15}: Data de Vencimento da primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\" Tipo do Dado: Texto.)
{param16}: Data de Competência da primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\" Tipo do Dado: Texto.)
{param17}: Quantidade de Parcelas. (Obrigatório. Tipo do Dado: Inteiro.)
{param18}: Valor das Parcelas. (Obrigatório. Tipo do Dado: Decimal.)
{param19}: Número do documento da Movimentação. (Opcional. Tipo do Dado: Inteiro.)
{param20}: Observação da Movimentação. (Opcional. Tipo do Dado: Texto.)
{param21}: Indica se o valor é definitivo (Opcional. Tipo do Dado: Boleano.)

\n\n

Response

Retorna um objeto com os dados da Fatura:

{\n      \"IdMovimentacaoFinanceira\": {param1},\n      \"IdMovimentacaoFinanceiraParcela\": {param2}\n}\n\n

Paramêtros

{param1}: Id BomControle da Movimentação. (Tipo do Dado: Texto.)
{param2}: Id BomControle da primeira Parcela. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Financeiro","CriarDespesaFornecedor"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"5ebf3608-757f-4455-a234-13682aba0797","name":"Financeiro - CriarDespesaFornecedor","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"IdFornecedor\": 1,\r\n \"IdContaFinanceira\": 1,\r\n \"IdCategoriaFinanceira\": 1,\r\n \"IdDepartamento\": 0,\r\n \"FormaPagamento\": {\r\n \"Boleto\": {\r\n \"Observacao\": \"teste\",\r\n \"EmiteBoleto\": true\r\n }\r\n },\r\n \"PrimeiroVencimento\": \"2020-01-01 00:00:00\",\r\n \"DataCompetencia\": \"2020-01-01 00:00:00\",\r\n \"QuantidadeParcelas\": 1,\r\n \"Valor\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/CriarDespesaFornecedor"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 31 Jan 2020 19:36:02 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"152"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"IdMovimentacaoFinanceira\": \"8a63b439-266e-4957-9786-91474dac2b68\",\r\n \"IdMovimentacaoFinanceiraParcela\": \"97175bcb-b552-4341-959a-6141760d8c79\"\r\n}"}],"_postman_id":"0b605450-17ff-4c25-968d-f1da1b8d67e0"},{"name":"Financeiro - Criar Despesa Imposto","id":"e4af69ca-8286-4221-ad5f-5e2b7b38e4ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/CriarDespesaImposto","description":"

Cria uma movimentação de pagamento no BomControle.

Request

O request para essa API é feito informando os dados no Body do request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Body

{\n      \"IdFornecedor\": {param1},\n      \"IdContaFinanceira\": {param2},\n      \"IdCategoriaFinanceira\": {param3},\n      \"IdDepartamento\": {param4},\n      \"FormaPagamento\": {param5} {\n        \"Boleto\": {param6} {\n          \"Observacao\": {param7},\n          \"EmiteBoleto\": {param8}\n        },\n        \"DepositoConta\": {param9} {\n          \"NumeroBanco\": {param10},\n          \"NumeroAgencia\": {param11},\n          \"NumeroConta\": {param12}\n        },\n        \"Outros\": {param13} {\n          \"Nome\": {param14}\n        }\n      },\n      \"PrimeiroVencimento\": {param15},\n      \"DataCompetencia\": {param16},\n      \"QuantidadeParcelas\": {param17},\n      \"Valor\": {param18},\n      \"NumeroDocumento\": {param19},\n      \"Observacao\": {param20},\n      \"ValorDefinitivo\": {param21}\n}\n\n

Paramêtros

{param1}: Id BomControle do Fornecedor. (Obrigatório. Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Conta Financeira. (Obrigatório. Tipo do Dado: Inteiro.)
{param3}: Id BomControle da Categoria Financeira. (Obrigatório. Tipo do Dado: Inteiro.)
{param4}: Id BomControle do Departamento. (Opcional. Tipo do Dado: Inteiro.)
{param5}: Objeto contendo os dados da Forma de Pagamento da Movimentação. (Obrigatório. Tipo do Dado: Objeto.)
{param6}: Objeto contendo os dados da Forma de Pagamento de Boleto. (Opcional. Tipo do Dado: Objeto.)
{param7}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param8}: Indica se emite o Boleto. (Opcional. Tipo do Dado: Booleano.)
{param9}: Objeto contendo os dados da Forma de Pagamento de Depósito em Conta. (Opcional. Tipo do Dado: Objeto.)
{param10}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param11}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param12}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param13}: Objeto contendo os dados de Outras Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param14}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param15}: Data de Vencimento da primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\" Tipo do Dado: Texto.)
{param16}: Data de Competência da primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\" Tipo do Dado: Texto.)
{param17}: Quantidade de Parcelas. (Obrigatório. Tipo do Dado: Inteiro.)
{param18}: Valor das Parcelas. (Obrigatório. Tipo do Dado: Decimal.)
{param19}: Número do documento da Movimentação. (Opcional. Tipo do Dado: Inteiro.)
{param20}: Observação da Movimentação. (Opcional. Tipo do Dado: Texto.)
{param21}: Indica se o valor é definitivo (Opcional. Tipo do Dado: Boleano.)

\n\n

Response

Retorna um objeto com os dados da Fatura:

{\n      \"IdMovimentacaoFinanceira\": {param1},\n      \"IdMovimentacaoFinanceiraParcela\": {param2}\n}\n\n

Paramêtros

{param1}: Id BomControle da Movimentação. (Tipo do Dado: Texto.)
{param2}: Id BomControle da primeira Parcela. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Financeiro","CriarDespesaImposto"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"f8288428-4fd3-42c4-a506-ac7960c9554d","name":"Financeiro - CriarDespesaImposto","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"IdFornecedor\": 1,\r\n \"IdContaFinanceira\": 1,\r\n \"IdCategoriaFinanceira\": 1,\r\n \"IdDepartamento\": 0,\r\n \"FormaPagamento\": {\r\n \"Boleto\": {\r\n \"Observacao\": \"teste\",\r\n \"EmiteBoleto\": true\r\n }\r\n },\r\n \"PrimeiroVencimento\": \"2020-01-01 00:00:00\",\r\n \"DataCompetencia\": \"2020-01-01 00:00:00\",\r\n \"QuantidadeParcelas\": 1,\r\n \"Valor\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/CriarDespesaImposto"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"IdMovimentacaoFinanceira\": \"8a63b439-266e-4957-9786-91474dac2b68\",\r\n \"IdMovimentacaoFinanceiraParcela\": \"97175bcb-b552-4341-959a-6141760d8c79\"\r\n}"}],"_postman_id":"e4af69ca-8286-4221-ad5f-5e2b7b38e4ce"},{"name":"Financeiro - Criar Despesa Funcionario","id":"542489d7-55b0-4353-b3cc-6f841a480369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/CriarDespesaFuncionario","description":"

Cria uma movimentação de pagamento no BomControle.

Request

O request para essa API é feito informando os dados no Body do request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Body

{\n      \"IdFuncionario\": {param1},\n      \"IdContaFinanceira\": {param2},\n      \"IdCategoriaFinanceira\": {param3},\n      \"IdDepartamento\": {param4},\n      \"FormaPagamento\": {param5} {\n        \"Boleto\": {param6} {\n          \"Observacao\": {param7},\n          \"EmiteBoleto\": {param8}\n        },\n        \"DepositoConta\": {param9} {\n          \"NumeroBanco\": {param10},\n          \"NumeroAgencia\": {param11},\n          \"NumeroConta\": {param12}\n        },\n        \"Outros\": {param13} {\n          \"Nome\": {param14}\n        }\n      },\n      \"PrimeiroVencimento\": {param15},\n      \"DataCompetencia\": {param16},\n      \"QuantidadeParcelas\": {param17},\n      \"Valor\": {param18},\n      \"NumeroDocumento\": {param19},\n      \"Observacao\": {param20},\n      \"ValorDefinitivo\": {param21}\n}\n\n

Paramêtros

{param1}: Id BomControle do Funcionário. (Obrigatório. Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Conta Financeira. (Obrigatório. Tipo do Dado: Inteiro.)
{param3}: Id BomControle da Categoria Financeira. (Obrigatório. Tipo do Dado: Inteiro.)
{param4}: Id BomControle do Departamento. (Opcional. Tipo do Dado: Inteiro.)
{param5}: Objeto contendo os dados da Forma de Pagamento da Movimentação. (Obrigatório. Tipo do Dado: Objeto.)
{param6}: Objeto contendo os dados da Forma de Pagamento de Boleto. (Opcional. Tipo do Dado: Objeto.)
{param7}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param8}: Indica se emite o Boleto. (Opcional. Tipo do Dado: Booleano.)
{param9}: Objeto contendo os dados da Forma de Pagamento de Depósito em Conta. (Opcional. Tipo do Dado: Objeto.)
{param10}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param11}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param12}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param13}: Objeto contendo os dados de Outras Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param14}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param15}: Data de Vencimento da primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\" Tipo do Dado: Texto.)
{param16}: Data de Competência da primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\" Tipo do Dado: Texto.)
{param17}: Quantidade de Parcelas. (Obrigatório. Tipo do Dado: Inteiro.)
{param18}: Valor das Parcelas. (Obrigatório. Tipo do Dado: Decimal.)
{param19}: Número do documento da Movimentação. (Opcional. Tipo do Dado: Inteiro.)
{param20}: Observação da Movimentação. (Opcional. Tipo do Dado: Texto.)
{param21}: Indica se o valor é definitivo (Opcional. Tipo do Dado: Boleano.)

\n\n

Response

Retorna um objeto com os dados da Fatura:

{\n      \"IdMovimentacaoFinanceira\": {param1},\n      \"IdMovimentacaoFinanceiraParcela\": {param2}\n}\n\n

Paramêtros

{param1}: Id BomControle da Movimentação. (Tipo do Dado: Texto.)
{param2}: Id BomControle da primeira Parcela. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Financeiro","CriarDespesaFuncionario"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"1a9aa88c-5077-49fb-ad8e-93a0e361bb84","name":"Financeiro - CriarDespesaFuncionario","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"IdFuncionario\": 1,\r\n \"IdContaFinanceira\": 1,\r\n \"IdCategoriaFinanceira\": 1,\r\n \"IdDepartamento\": 0,\r\n \"FormaPagamento\": {\r\n \"Boleto\": {\r\n \"Observacao\": \"teste\",\r\n \"EmiteBoleto\": true\r\n }\r\n },\r\n \"PrimeiroVencimento\": \"2020-01-01 00:00:00\",\r\n \"DataCompetencia\": \"2020-01-01 00:00:00\",\r\n \"QuantidadeParcelas\": 1,\r\n \"Valor\": 10\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/CriarDespesaFuncionario"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"IdMovimentacaoFinanceira\": \"8a63b439-266e-4957-9786-91474dac2b68\",\r\n \"IdMovimentacaoFinanceiraParcela\": \"97175bcb-b552-4341-959a-6141760d8c79\"\r\n}"}],"_postman_id":"542489d7-55b0-4353-b3cc-6f841a480369"},{"name":"Financeiro - Pesquisar","id":"854e5b89-19b7-4c39-9bcd-1a17987122ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/Pesquisar","description":"

Pesquisa as Movimentações conforme os filtros utilizados.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no sistema BomControle.

\n\n

Paramêtros

idsEmpresa: Ids BomControle das Empresas. (Opcional. Tipo do Dado: Array de Inteiros.)
idsCliente: Ids BomControle dos Clientes. (Opcional. Tipo do Dado: Array de Inteiros.)
idsFornecedor: Ids BomControle dos Fornecedores. (Opcional. Tipo do Dado: Array de Inteiros.)
textoPesquisa: Pesquisa pelo Nome da Parcela. (Opcional. Tipo do Dado: Texto.)
dataInicio: Filtra pela Data Inicial. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
dataTermino: Filtra pela Data Final. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
tipoData: Utilizado em conjunto com as datas para definir qual data a ser utilizada. (Obrigatório. Opções: DataPadrao, DataPrevista, DataPagamento, DataCompetencia, DataConciliacao, Criacao, UltimaAlteracao. Tipo do Dado: Texto. )
paginacao.itensPorPagina: Usado para definir a paginação da pesquisa, se não informado utiliza valor padrão 50. Numero maximo permitido é de 100 itens. (Opcional. Tipo do Dado: Inteiro.)
paginacao.numeroDaPagina: Usado para definir a paginação da pesquisa, se não informado utiliza valor padrão 1. (Opcional. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados das Movimentações:

{\n  \"Itens\": {param1} [\n    {\n      \"IdMovimentacaoFinanceiraParcela\": {param2},\n      \"Debito\": {param3},\n      \"DataVencimento\": {param4},\n      \"DataCompetencia\": {param5},\n      \"DataQuitacao\": {param6},\n      \"DataConciliacao\": {param7},\n      \"Valor\": {param8},\n      \"FormaPagamento\": {param9},\n      \"NomeFormaPagamento\": {param10},\n      \"TipoMovimentacao\": {param11},\n      \"NomeTipoMovimentacao\": {param12},\n      \"Nome\": {param13},\n      \"Observacao\": {param14},\n      \"NumeroParcela\": {param15},\n      \"QuantidadeParcela\": {param16},\n      \"IdCategoriaFinanceira\": {param17},\n      \"NomeCategoriaFinanceira\": {param18},\n      \"IconeCategoriaFinanceira\": {param19},\n      \"IdContaFinanceira\": {param20},\n      \"NomeContaFinanceira\": {param21},\n      \"NumeroConta\": {param22},\n      \"DigitoConta\": {param23},\n      \"NumeroAgencia\": {param24},\n      \"DigitoAgencia\": {param25},\n      \"NomeBanco\": {param26},\n      \"NumeroBanco\": {param27},\n      \"IdEmpresa\": {param28},\n      \"NomeEmpresa\": {param29},\n      \"DocumentoEmpresa\": {param30},\n      \"IdCliente\": {param31},\n      \"IdFornecedor\": {param32},\n      \"IdFuncionario\": {param33},\n      \"NomeClienteFornecedor\": {param34},\n      \"NomeFantasiaClienteFornecedor\": {param35},\n      \"DocumentoClienteFornecedor\": {param36},\n      \"LinkBoletoBancario\": {param37},\n      \"LinkNotaFiscalServico\": {param38},\n      \"IdDepartamento\": {param39},\n      \"NomeDepartamento\": {param40},\n      \"TipoDepartamento\": {param41},\n      \"NomeTipoDepartamento\": {param42},\n      \"TemRateio\": {param43},\n      \"ValorDefinitivo\": {param44},\n      \"TotalItens\": {param45},\n      \"DataCriacaoParcela\": {param46},\n      \"ValorAcrescimo\": {param47},\n      \"ValorDesconto\": {param48},\n      \"ValorBruto\": {param49},\n      \"DataUltimaAlteracao\": {param50},\n      \"DataFaturamento\": {param51},\n      \"EtiquetasMovimentacao\": {param52},\n      \"IdFatura\": {param53},\n      \"NumeroDocumento\": {param54},\n      \"NotaFiscalServicoParcela\": {param55},\n      \"NotaFiscalServicoVenda\": {param56},\n      \"NotaFiscalProduto\": {param57},\n      \"NotaFiscalConsumidor\": {param58}     \n    }\n  ],\n  \"TotalItens\": {param59}\n}\n\n

Paramêtros

{param1}: Array de Objetos contendo os dados pesquisados. (Tipo do Dado: Array de Objetos.)
{param2}: Id BomControle da Parcela. (Tipo do Dado: Texto.)
{param3}: Indica se é uma Movimentação de Débito. (Tipo do Dado: Booleano.)
{param4}: Data de Vencimento da Parcela. (Tipo do Dado: Texto.)
{param5}: Data de Competência da Parcela. (Tipo do Dado: Texto.)
{param6}: Data de Quitação da Parcela. (Tipo do Dado: Texto.)
{param7}: Data de Conciliação da Parcela. (Tipo do Dado: Texto.)
{param8}: Valor da Parcela. (Tipo do Dado: Decimal.)
{param9}: Forma de Pagamento da Parcela. (Opções: 1 - Dinheiro, 2 - Deposito, 3 - Cheque, 4 - DebitoEmContaCorrente, 5 - TransferenciaBancaria, 6 - CartaoCredito, 7 - CartaoDebito, 8 - DOC, 9 - TED, 10 - TransferenciaAplicativo, 11 - TransferenciaMoedaVirtual, 12 - InternetBanking, 13 - BoletoBancario, 14 - DescontoEmFolha, 15 - Outros, 16 - DebitoConta. Tipo do Dado: Inteiro.)
{param10}: Nome da Forma de Pagamento. (Tipo do Dado: Texto.)
{param11}: Tipo da Movimentação. (Dados: 15 - AporteCapital, 16 - ReceitaProduto, 17 - ReceitaServico, 18 - OutrasReceitas, 19 - DespesaFornecedor, 20 - DespesaFuncionario, 21 - DespesaImposto, 22 - DivisaoLucro. Tipo do Dado: Texto.)
{param12}: Nome do Tipo da Movimentação. (Tipo do Dado: Texto.)
{param13}: Nome da Parcela da Movimentação. (Tipo do Dado: Texto.)
{param14}: Observação da Parcela da Movimentação. (Tipo do Dado: Texto.)
{param15}: Número da Parcela da Movimentação. (Tipo do Dado: Inteiro.)
{param16}: Quantidade de Parcelas da Movimentação. (Tipo do Dado: Inteiro.)
{param17}: Id BomControle da Categoria Financeira da Parcela. Valor zerado caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Inteiro.)
{param18}: Nome da Categoria Financeira da Parcela. Nullo caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Texto.)
{param19}: Ícone da Categoria Financeira da Parcela. Nullo caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Texto.)
{param20}: Id BomControle da Conta Financeira da Parcela. (Tipo do Dado: Inteiro.)
{param21}: Nome da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param22}: Número da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param23}: Dígito da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param24}: Número da Agencia da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param25}: Dígito da Agencia da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param26}: Nome do Banco da Conta Financeira da Parcela na Febraban. (Tipo do Dado: Texto.)
{param27}: Número do Banco da Conta Financeira da Parcela na Febraban. (Tipo do Dado: Texto.)
{param28}: Id BomControle da Empresa da Parcela. (Tipo do Dado: Inteiro.)
{param29}: Nome da Empresa da Parcela. (Tipo do Dado: Texto.)
{param30}: Cnpj da Empresa da Parcela. (Tipo do Dado: Texto.)
{param31}: Id BomControle do Cliente da Parcela para contas a Receber. (Tipo do Dado: Inteiro.)
{param32}: Id BomControle do Fornecedor da Parcela para contas a Pagar. (Tipo do Dado: Inteiro.)
{param33}: Id BomControle do Funcionário da Parcela para contas a Pagar. (Tipo do Dado: Inteiro.)
{param34}: Nome do Cliente/Fornecedor/Funcionário da Parcela. (Tipo do Dado: Texto.)
{param35}: Nome Fantasia do Cliente/Fornecedor da Parcela. (Tipo do Dado: Texto.)
{param36}: Documento do Cliente/Fornecedor/Funcionário da Parcela. (Tipo do Dado: Texto.)
{param37}: Link do Boleto Bancário da Parcela. (Tipo do Dado: Texto.)
{param38}: Link da Nota Fiscal da Parcela. (Tipo do Dado: Texto.)
{param39}: Id BomControle do Departamento da Parcela. Valor zerado caso a Parcela possua mais de um Departamento. (Tipo do Dado: Inteiro.)
{param40}: Nome do Departamento da Parcela. Nullo caso a Parcela possua mais de um Departamento. (Tipo do Dado: Texto.)
{param41}: Id BomControle do Tipo do Departamento. (Opções: 1 - Administrativo, 2 - Produtivo. Tipo do Dado: Inteiro.)
{param42}: Nome do Tipo do Departamento. (Tipo do Dado: Texto.)
{param43}: Indica se a Parcela possui rateio. (Tipo do Dado: Booleano.)
{param44}: Indica se o valor da Parcela é definitivo (Tipo do Dado: Booleano.)
{param45}: Total de Itens Pesquisados. (Tipo do Dado: Inteiro.)
{param46}: Data de Criação da Parcela. (Tipo do Dado: Texto.)
{param47}: Valor de Acréscimo da Parcela. (Tipo do Dado: Decimal.)
{param48}: Valor de Desconto da Parcela. (Tipo do Dado: Decimal.)
{param49}: Valor Bruto da Parcela. (Tipo do Dado: Decimal.)
{param50}: Data de Última Alteração da Parcela. (Tipo do Dado: Texto.)
{param51}: Data do Faturamento. (Tipo do Dado: Texto.)
{param52}: Etiquetas da Movimentação. (Tipo do Dado: Texto.)
{param53}: Id da Fatura no BomControle. (Tipo do Dado: Inteiro.)
{param54}: Número do Documento informado na Movimentação. (Tipo do Dado: Inteiro.)
{param55}: Número da Nota Fiscal de Serviço vinculada à parcela. (Tipo do Dado: Texto.)
{param56}: Número da Nota Fiscal de Serviço vinculada à venda. (Tipo do Dado: Texto.)
{param57}: Número da Nota Fiscal de Produto. (Tipo do Dado: Texto.)
{param58}: Número da Nota Fiscal de Consumidor. (Tipo do Dado: Texto.)
{param59}: Total de Itens Pesquisados. (Tipo do Dado: Inteiro.)

","urlObject":{"protocol":"https","path":["integracao","Financeiro","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"62519e85-18b5-4b28-9b97-bc8d33f525e2","name":"Financeiro - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/Pesquisar?idsEmpresa=1&idsCliente=1&idsFornecedor=1&textoPesquisa=teste&dataInicio=2020-01-01&dataTermino=2020-01-01&tipoData=DataCriacao&paginacao.itensPorPagina=1&paginacao.numeroDaPagina=1","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Financeiro","Pesquisar"],"query":[{"key":"idsEmpresa","value":"1"},{"key":"idsCliente","value":"1"},{"key":"idsFornecedor","value":"1"},{"key":"textoPesquisa","value":"teste"},{"key":"dataInicio","value":"2020-01-01"},{"key":"dataTermino","value":"2020-01-01"},{"key":"tipoData","value":"DataCriacao"},{"key":"paginacao.itensPorPagina","value":"1"},{"key":"paginacao.numeroDaPagina","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Fri, 31 Jan 2020 19:53:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"84348"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Itens\": [\r\n {\r\n \"IdMovimentacaoFinanceiraParcela\": \"6d330157-9f59-46c6-b4e3-0012d07f1d0d\",\r\n \"Debito\": false,\r\n \"DataVencimento\": \"2020-01-01T02:00:00\",\r\n \"DataCompetencia\": \"2020-01-01T13:39:41.5\",\r\n \"DataQuitacao\": null,\r\n \"DataConciliacao\": null,\r\n \"Valor\": 10.00000,\r\n \"FormaPagamento\": 13,\r\n \"NomeFormaPagamento\": \"Boleto Bancário\",\r\n \"TipoMovimentacao\": 17,\r\n \"NomeTipoMovimentacao\": \"Venda de serviço\",\r\n \"Nome\": \"Recebimento DO(A) CLIENTE TESTE NO VALOR R$ 10,00 (PARCELA FIXA TODO DIA 20)\",\r\n \"Observacao\": null,\r\n \"NumeroParcela\": 1,\r\n \"QuantidadeParcela\": 0,\r\n \"IdCategoriaFinanceira\": 1,\r\n \"NomeCategoriaFinanceira\": \"Categoria Teste\",\r\n \"IconeCategoriaFinanceira\": \"fa-dollar\",\r\n \"IdContaFinanceira\": 1,\r\n \"NomeContaFinanceira\": \"Conta Teste\",\r\n \"NumeroConta\": \"11111\",\r\n \"DigitoConta\": \"1\",\r\n \"NumeroAgencia\": \"1111\",\r\n \"DigitoAgencia\": null,\r\n \"NomeBanco\": \"Banco do Nordeste do Brasil S.A.\",\r\n \"NumeroBanco\": \"004\",\r\n \"IdEmpresa\": 1,\r\n \"NomeEmpresa\": \"Empresa Teste\",\r\n \"DocumentoEmpresa\": \"12345678000100\",\r\n \"IdCliente\": 1,\r\n \"IdFornecedor\": null,\r\n \"IdFuncionario\": null,\r\n \"NomeClienteFornecedor\": \"Cliente Teste\",\r\n \"NomeFantasiaClienteFornecedor\": \"Cliente Teste\",\r\n \"DocumentoClienteFornecedor\": \"87654321000100\",\r\n \"LinkBoletoBancario\": null,\r\n \"LinkNotaFiscalServico\": null,\r\n \"IdDepartamento\": null,\r\n \"NomeDepartamento\": null,\r\n \"TipoDepartamento\": null,\r\n \"NomeTipoDepartamento\": \"\"\r\n }\r\n ],\r\n \"TotalItens\": 1\r\n}"}],"_postman_id":"854e5b89-19b7-4c39-9bcd-1a17987122ca"},{"name":"Financeiro - Pesquisa Detalhada","id":"68609bb6-cc64-490e-9259-ab541a346728","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/PesquisaDetalhada","description":"

Semelhante a API integracao/Financeiro/Pesquisar, esta API pesquisa as movimentações conforme os filtros utilizados com mais opções de filtro.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no sistema BomControle.

\n\n

Paramêtros

despesa: Filtra apenas despesas ou apenas receitas. (Opcional. Tipo do Dado: Boleano.)
renegociacoesAtivas: Filtra por renegociações ativas ou não, o sistema considera uma renegociação ativa quando a receita passou por uma renegociação e tem uma nova data prevista no futuro, quando a data prevista não se cumpre a movimentação volta a não ter uma renegociação ativa. (Opcional. Tipo do Dado: Boleano.)
status: Filtra pelo status da movimentação. (Opcional. Opções: Atrasado, Agendado, Quitado. Tipo do Dado: Texto.)
idsEmpresa: Ids BomControle das Empresas. (Opcional. Tipo do Dado: Array de Inteiros.)
idsCliente: Ids BomControle dos Clientes. (Opcional. Tipo do Dado: Array de Inteiros.)
idsFornecedor: Ids BomControle dos Fornecedores. (Opcional. Tipo do Dado: Array de Inteiros.)
textoPesquisa: Pesquisa pelo Nome da Parcela. (Opcional. Tipo do Dado: Texto.)
dataInicio: Filtra pela Data Inicial. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
dataTermino: Filtra pela Data Final. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
tipoData: Utilizado em conjunto com as datas para definir qual data a ser utilizada. (Obrigatório. Opções: DataPadrao, DataPrevista, DataPagamento, DataCompetencia, DataConciliacao, Criacao, UltimaAlteracao. Tipo do Dado: Texto. )
paginacao.itensPorPagina: Usado para definir a paginação da pesquisa, se não informado utiliza valor padrão 50. Numero máximo permitido é de 100 itens. (Opcional. Tipo do Dado: Inteiro.)
paginacao.numeroDaPagina: Usado para definir a paginação da pesquisa, se não informado utiliza valor padrão 1. (Opcional. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados das Movimentações:

{\n  \"Itens\": {param1} [\n    {\n      \"RenegociacaoAtiva\": {param2},\n      \"DataPrevistaRenegociada\": {param3},\n      \"IdMovimentacaoFinanceiraParcela\": {param4},\n      \"Debito\": {param5},\n      \"DataVencimento\": {param6},\n      \"DataCompetencia\": {param7},\n      \"DataQuitacao\": {param8},\n      \"DataConciliacao\": {param9},\n      \"Valor\": {param10},\n      \"FormaPagamento\": {param11},\n      \"NomeFormaPagamento\": {param12},\n      \"TipoMovimentacao\": {param13},\n      \"NomeTipoMovimentacao\": {param14},\n      \"Nome\": {param15},\n      \"Observacao\": {param16},\n      \"NumeroParcela\": {param17},\n      \"QuantidadeParcela\": {param18},\n      \"IdCategoriaFinanceira\": {param19},\n      \"NomeCategoriaFinanceira\": {param20},\n      \"IconeCategoriaFinanceira\": {param21},\n      \"IdContaFinanceira\": {param22},\n      \"NomeContaFinanceira\": {param23},\n      \"NumeroConta\": {param24},\n      \"DigitoConta\": {param25},\n      \"NumeroAgencia\": {param26},\n      \"DigitoAgencia\": {param27},\n      \"NomeBanco\": {param28},\n      \"NumeroBanco\": {param29},\n      \"IdEmpresa\": {param30},\n      \"NomeEmpresa\": {param31},\n      \"DocumentoEmpresa\": {param32},\n      \"IdCliente\": {param33},\n      \"IdFornecedor\": {param34},\n      \"IdFuncionario\": {param35},\n      \"NomeClienteFornecedor\": {param36},\n      \"NomeFantasiaClienteFornecedor\": {param37},\n      \"DocumentoClienteFornecedor\": {param38},\n      \"LinkBoletoBancario\": {param39},\n      \"LinkNotaFiscalServico\": {param40},\n      \"IdDepartamento\": {param41},\n      \"NomeDepartamento\": {param42},\n      \"TipoDepartamento\": {param43},\n      \"NomeTipoDepartamento\": {param44},\n      \"TemRateio\": {param45},\n      \"ValorDefinitivo\": {param46},\n      \"TotalItens\": {param47},\n      \"DataCriacaoParcela\": {param48},\n      \"ValorAcrescimo\": {param49},\n      \"ValorDesconto\": {param50},\n      \"ValorBruto\": {param51},\n      \"DataUltimaAlteracao\": {param52},\n      \"DataFaturamento\": {param53},\n      \"EtiquetasMovimentacao\": {param54},\n      \"IdFatura\": {param55},\n      \"NumeroDocumento\": {param56},\n      \"NotaFiscalServicoParcela\": {param57},\n      \"NotaFiscalServicoVenda\": {param58},\n      \"NotaFiscalProduto\": {param59},\n      \"NotaFiscalConsumidor\": {param60}     \n    }\n  ],\n  \"TotalItens\": {param61}\n}\n\n

Paramêtros

{param1}: Array de Objetos contendo os dados pesquisados. (Tipo do Dado: Array de Objetos.)
{param2}: Indica se a movimentação possui uma renegociação ativa, o sistema considera uma renegociação ativa quando a receita passou por uma renegociação e tem uma nova data prevista no futuro, quando a data prevista não se cumpre a movimentação volta a não ter uma renegociação ativa. (Tipo do Dado: Booleano.)
{param3}: Quando a movimentação possui uma renegociação ativa esse campo indica a nova data prevista para o recebimento. (Tipo do Dado: Texto.)
{param4}: Id BomControle da Parcela. (Tipo do Dado: Texto.)
{param5}: Indica se é uma Movimentação de Débito. (Tipo do Dado: Booleano.)
{param6}: Data de Vencimento da Parcela. (Tipo do Dado: Texto.)
{param7}: Data de Competência da Parcela. (Tipo do Dado: Texto.)
{param8}: Data de Quitação da Parcela. (Tipo do Dado: Texto.)
{param9}: Data de Conciliação da Parcela. (Tipo do Dado: Texto.)
{param10}: Valor da Parcela. (Tipo do Dado: Decimal.)
{param11}: Forma de Pagamento da Parcela. (Opções: 1 - Dinheiro, 2 - Deposito, 3 - Cheque, 4 - DebitoEmContaCorrente, 5 - TransferenciaBancaria, 6 - CartaoCredito, 7 - CartaoDebito, 8 - DOC, 9 - TED, 10 - TransferenciaAplicativo, 11 - TransferenciaMoedaVirtual, 12 - InternetBanking, 13 - BoletoBancario, 14 - DescontoEmFolha, 15 - Outros, 16 - DebitoConta. Tipo do Dado: Inteiro.)
{param12}: Nome da Forma de Pagamento. (Tipo do Dado: Texto.)
{param13}: Tipo da Movimentação. (Dados: 15 - AporteCapital, 16 - ReceitaProduto, 17 - ReceitaServico, 18 - OutrasReceitas, 19 - DespesaFornecedor, 20 - DespesaFuncionario, 21 - DespesaImposto, 22 - DivisaoLucro. Tipo do Dado: Texto.)
{param14}: Nome do Tipo da Movimentação. (Tipo do Dado: Texto.)
{param15}: Nome da Parcela da Movimentação. (Tipo do Dado: Texto.)
{param16}: Observação da Parcela da Movimentação. (Tipo do Dado: Texto.)
{param17}: Número da Parcela da Movimentação. (Tipo do Dado: Inteiro.)
{param18}: Quantidade de Parcelas da Movimentação. (Tipo do Dado: Inteiro.)
{param19}: Id BomControle da Categoria Financeira da Parcela. Valor zerado caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Inteiro.)
{param20}: Nome da Categoria Financeira da Parcela. Nullo caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Texto.)
{param21}: Ícone da Categoria Financeira da Parcela. Nullo caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Texto.)
{param22}: Id BomControle da Conta Financeira da Parcela. (Tipo do Dado: Inteiro.)
{param23}: Nome da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param24}: Número da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param25}: Dígito da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param26}: Número da Agencia da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param27}: Dígito da Agencia da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param28}: Nome do Banco da Conta Financeira da Parcela na Febraban. (Tipo do Dado: Texto.)
{param29}: Número do Banco da Conta Financeira da Parcela na Febraban. (Tipo do Dado: Texto.)
{param30}: Id BomControle da Empresa da Parcela. (Tipo do Dado: Inteiro.)
{param31}: Nome da Empresa da Parcela. (Tipo do Dado: Texto.)
{param32}: Cnpj da Empresa da Parcela. (Tipo do Dado: Texto.)
{param33}: Id BomControle do Cliente da Parcela para contas a Receber. (Tipo do Dado: Inteiro.)
{param34}: Id BomControle do Fornecedor da Parcela para contas a Pagar. (Tipo do Dado: Inteiro.)
{param35}: Id BomControle do Funcionário da Parcela para contas a Pagar. (Tipo do Dado: Inteiro.)
{param36}: Nome do Cliente/Fornecedor/Funcionário da Parcela. (Tipo do Dado: Texto.)
{param37}: Nome Fantasia do Cliente/Fornecedor da Parcela. (Tipo do Dado: Texto.)
{param38}: Documento do Cliente/Fornecedor/Funcionário da Parcela. (Tipo do Dado: Texto.)
{param39}: Link do Boleto Bancário da Parcela. (Tipo do Dado: Texto.)
{param40}: Link da Nota Fiscal da Parcela. (Tipo do Dado: Texto.)
{param41}: Id BomControle do Departamento da Parcela. Valor zerado caso a Parcela possua mais de um Departamento. (Tipo do Dado: Inteiro.)
{param42}: Nome do Departamento da Parcela. Nullo caso a Parcela possua mais de um Departamento. (Tipo do Dado: Texto.)
{param43}: Id BomControle do Tipo do Departamento. (Opções: 1 - Administrativo, 2 - Produtivo. Tipo do Dado: Inteiro.)
{param44}: Nome do Tipo do Departamento. (Tipo do Dado: Texto.)
{param45}: Indica se a Parcela possui rateio. (Tipo do Dado: Booleano.)
{param46}: Indica se o valor da Parcela é definitivo (Tipo do Dado: Booleano.)
{param47}: Total de Itens Pesquisados. (Tipo do Dado: Inteiro.)
{param48}: Data de Criação da Parcela. (Tipo do Dado: Texto.)
{param49}: Valor de Acréscimo da Parcela. (Tipo do Dado: Decimal.)
{param50}: Valor de Desconto da Parcela. (Tipo do Dado: Decimal.)
{param51}: Valor Bruto da Parcela. (Tipo do Dado: Decimal.)
{param52}: Data de Última Alteração da Parcela. (Tipo do Dado: Texto.)
{param53}: Data do Faturamento. (Tipo do Dado: Texto.)
{param54}: Etiquetas da Movimentação. (Tipo do Dado: Texto.)
{param55}: Id da Fatura no BomControle. (Tipo do Dado: Inteiro.)
{param56}:Número do Documento informado na Movimentação. (Tipo do Dado: Inteiro.)
{param57}: Número da Nota Fiscal de Serviço vinculada à parcela. (Tipo do Dado: Texto.)
{param58}: Número da Nota Fiscal de Serviço vinculada à venda. (Tipo do Dado: Texto.)
{param59}: Número da Nota Fiscal de Produto. (Tipo do Dado: Texto.)
{param60}: Número da Nota Fiscal de Consumidor. (Tipo do Dado: Texto.)
{param61}: Total de Itens Pesquisados. (Tipo do Dado: Inteiro.)

","urlObject":{"protocol":"https","path":["integracao","Financeiro","PesquisaDetalhada"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"918d9e9a-828b-4fea-a955-c2bff192bee6","name":"Financeiro - Pesquisa Detalhada","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb_mUYW0EkCJIz9_2L6l__bI8P7PaYbnU2GTzHIR94nxh7M2jJALX7i4ynsbTrCaUm3_G4qy8Mix9UfB9RcXI73KHaUUcTkvYNwD3VPSZ9pRCgKd7MwMR1qwsW16kQFhc94.","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/PesquisaDetalhada?filtro.despesa=false&filtro.renegociacoesAtivas=true&filtro.dataInicio=2022-09-01&filtro.dataTermino=2022-09-30&filtro.tipoData=DataPrevista","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Financeiro","PesquisaDetalhada"],"query":[{"key":"filtro.despesa","value":"false"},{"key":"filtro.renegociacoesAtivas","value":"true"},{"key":"filtro.dataInicio","value":"2022-09-01"},{"key":"filtro.dataTermino","value":"2022-09-30"},{"key":"filtro.tipoData","value":"DataPrevista"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 06 Sep 2022 14:42:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"2199"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Itens\": [\r\n {\r\n \"RenegociacaoAtiva\": true,\r\n \"DataPrevistaRenegociada\": \"2022-09-10T00:00:00\",\r\n \"IdMovimentacaoFinanceiraParcela\": \"900b7247-dfce-4cb1-96c5-4801b1e84abd\",\r\n \"Debito\": false,\r\n \"DataVencimento\": \"2022-09-01T00:00:00\",\r\n \"DataCompetencia\": \"2022-09-01T00:00:00\",\r\n \"DataQuitacao\": null,\r\n \"DataConciliacao\": null,\r\n \"Valor\": 50.00000,\r\n \"FormaPagamento\": 13,\r\n \"NomeFormaPagamento\": \"Boleto Bancário\",\r\n \"TipoMovimentacao\": 18,\r\n \"NomeTipoMovimentacao\": \"Outros recebimentos\",\r\n \"Nome\": \"Recebimento DO(A) Cliente NO VALOR R$ 50.00 (PARCELA UNICA NO DIA 1)\",\r\n \"Observacao\": null,\r\n \"NumeroParcela\": 1,\r\n \"QuantidadeParcela\": 0,\r\n \"IdCategoriaFinanceira\": 46,\r\n \"NomeCategoriaFinanceira\": \"Serviço Bom\",\r\n \"IconeCategoriaFinanceira\": \"fa-dollar\",\r\n \"IdContaFinanceira\": 2,\r\n \"NomeContaFinanceira\": \"Banco Itau\",\r\n \"NumeroConta\": \"188596\",\r\n \"DigitoConta\": \"1\",\r\n \"NumeroAgencia\": \"1218\",\r\n \"DigitoAgencia\": null,\r\n \"NomeBanco\": \"Itaú Unibanco S.A.\",\r\n \"NumeroBanco\": \"341\",\r\n \"IdEmpresa\": 1,\r\n \"NomeEmpresa\": \"Empresa A+\",\r\n \"DocumentoEmpresa\": \"65961561000100\",\r\n \"IdCliente\": 20634,\r\n \"IdFornecedor\": null,\r\n \"IdFuncionario\": null,\r\n \"NomeClienteFornecedor\": \"Cliente\",\r\n \"NomeFantasiaClienteFornecedor\": \"Cliente\",\r\n \"DocumentoClienteFornecedor\": \"76631957000106\",\r\n \"LinkBoletoBancario\": null,\r\n \"LinkNotaFiscalServico\": null,\r\n \"IdDepartamento\": null,\r\n \"NomeDepartamento\": null,\r\n \"TipoDepartamento\": null,\r\n \"NomeTipoDepartamento\": \"\",\r\n \"Valores\": [\r\n {\r\n \"Despesa\": false,\r\n \"IconeCategoria\": \"fa-dollar\",\r\n \"Categoria\": \"Serviço Bom\",\r\n \"NomeCategoriaRoot\": \"Serviço Bom\",\r\n \"CategoriaDiretoRoot\": false,\r\n \"CentroCusto\": null,\r\n \"IdClienteFornecedor\": 5815,\r\n \"NomeClienteFornecedor\": \"Cliente\",\r\n \"NomeFantasiaClienteFornecedor\": \"Cliente\",\r\n \"Valor\": 50.00000\r\n }\r\n ],\r\n \"TemRateio\": true\r\n }\r\n ],\r\n \"TotalItens\": 1\r\n}"}],"_postman_id":"68609bb6-cc64-490e-9259-ab541a346728"},{"name":"Financeiro - Obter","id":"5f5f734e-dad0-4966-9dbc-5147ed48895c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/Obter","description":"

Pesquisa a Parcela conforme o filtro utilizado.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no sistema BomControle.

\n\n

Paramêtros

idMovimentacaoFinanceiraParcela: Id BomControle da Parcela. (Obrigatório. Tipo do Dado: Guid.)

\n\n

Response

Retorna um objeto com os dados da Parcela:

{\n  \"IdMovimentacaoFinanceiraParcela\": {param1},\n  \"Debito\": {param2},\n  \"DataVencimento\": {param3},\n  \"DataCompetencia\": {param4},\n  \"DataQuitacao\": {param5},\n  \"DataConciliacao\": {param6},\n  \"Valor\": {param7},\n  \"FormaPagamento\": {param8},\n  \"NomeFormaPagamento\": {param9},\n  \"TipoMovimentacao\": {param10},\n  \"NomeTipoMovimentacao\": {param11},\n  \"Nome\": {param12},\n  \"Observacao\": {param13},\n  \"NumeroParcela\": {param14},\n  \"QuantidadeParcela\": {param15},\n  \"IdCategoriaFinanceira\": {param16},\n  \"NomeCategoriaFinanceira\": {param17},\n  \"IconeCategoriaFinanceira\": {param18},\n  \"IdContaFinanceira\": {param19},\n  \"NomeContaFinanceira\": {param20},\n  \"NumeroConta\": {param21},\n  \"DigitoConta\": {param22},\n  \"NumeroAgencia\": {param23},\n  \"DigitoAgencia\": {param24},\n  \"NomeBanco\": {param25},\n  \"NumeroBanco\": {param26},\n  \"IdEmpresa\": {param27},\n  \"NomeEmpresa\": {param28},\n  \"DocumentoEmpresa\": {param29},\n  \"IdCliente\": {param30},\n  \"IdFornecedor\": {param31},\n  \"IdFuncionario\": {param32},\n  \"NomeClienteFornecedor\": {param33},\n  \"NomeFantasiaClienteFornecedor\": {param34},\n  \"DocumentoClienteFornecedor\": {param35},\n  \"LinkBoletoBancario\": {param36},\n  \"LinkNotaFiscalServico\": {param37},\n  \"IdDepartamento\": {param38},\n  \"NomeDepartamento\": {param39},\n  \"TipoDepartamento\": {param40},\n  \"NomeTipoDepartamento\": {param41}\n}\n

Paramêtros

{param1}: Id BomControle da Parcela. (Tipo do Dado: Texto.)
{param2}: Indica se é uma Movimentação de Débito. (Tipo do Dado: Booleano.)
{param3}: Data de Vencimento da Parcela. (Tipo do Dado: Texto.)
{param4}: Data de Competência da Parcela. (Tipo do Dado: Texto.)
{param5}: Data de Quitação da Parcela. (Tipo do Dado: Texto.)
{param6}: Data de Conciliação da Parcela. (Tipo do Dado: Texto.)
{param7}: Valor da Parcela. (Tipo do Dado: Decimal.)
{param8}: Forma de Pagamento da Parcela. (Opções: 1 - Dinheiro, 2 - Deposito, 3 - Cheque, 4 - DebitoEmContaCorrente, 5 - TransferenciaBancaria, 6 - CartaoCredito, 7 - CartaoDebito, 8 - DOC, 9 - TED, 10 - TransferenciaAplicativo, 11 - TransferenciaMoedaVirtual, 12 - InternetBanking, 13 - BoletoBancario, 14 - DescontoEmFolha, 15 - Outros, 16 - DebitoConta. Tipo do Dado: Inteiro.)
{param9}: Nome da Forma de Pagamento. (Tipo do Dado: Texto.)
{param10}: Tipo da Movimentação. (Dados: 0 - Inicial, 9 - Transferencia, 15 - AporteCapital, 16 - ReceitaProduto, 17 - ReceitaServico, 18 - OutrasReceitas, 19 - DespesaFornecedor, 20 - DespesaFuncionario, 21 - DespesaImposto, 22 - DivisaoLucro. Tipo do Dado: Texto.)
{param11}: Nome do Tipo da Movimentação. (Tipo do Dado: Texto.)
{param12}: Nome da Parcela da Movimentação. (Tipo do Dado: Texto.)
{param13}: Observação da Parcela da Movimentação. (Tipo do Dado: Texto.)
{param14}: Número da Parcela da Movimentação. (Tipo do Dado: Inteiro.)
{param15}: Quantidade de Parcelas da Movimentação. (Tipo do Dado: Inteiro.)
{param16}: Id BomControle da Categoria Financeira da Parcela. Valor zerado caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Inteiro.)
{param17}: Nome da Categoria Financeira da Parcela. Nullo caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Texto.)
{param18}: Ícone da Categoria Financeira da Parcela. Nullo caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Texto.)
{param19}: Id BomControle da Conta Financeira da Parcela. (Tipo do Dado: Inteiro.)
{param20}: Nome da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param21}: Número da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param22}: Dígito da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param23}: Número da Agencia da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param24}: Dígito da Agencia da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param25}: Nome do Banco da Conta Financeira da Parcela na Febraban. (Tipo do Dado: Texto.)
{param26}: Número do Banco da Conta Financeira da Parcela na Febraban. (Tipo do Dado: Texto.)
{param27}: Id BomControle da Empresa da Parcela. (Tipo do Dado: Inteiro.)
{param28}: Nome da Empresa da Parcela. (Tipo do Dado: Texto.)
{param29}: Cnpj da Empresa da Parcela. (Tipo do Dado: Texto.)
{param30}: Id BomControle do Cliente da Parcela para contas a Receber. (Tipo do Dado: Inteiro.)
{param31}: Id BomControle do Fornecedor da Parcela para contas a Pagar. (Tipo do Dado: Inteiro.)
{param32}: Id BomControle do Funcionário da Parcela para contas a Pagar. (Tipo do Dado: Inteiro.)
{param33}: Nome do Cliente/Fornecedor/Funcionário da Parcela. (Tipo do Dado: Texto.)
{param34}: Nome Fantasia do Cliente/Fornecedor da Parcela. (Tipo do Dado: Texto.)
{param35}: Documento do Cliente/Fornecedor/Funcionário da Parcela. (Tipo do Dado: Texto.)
{param36}: Link do Boleto Bancário da Parcela. (Tipo do Dado: Texto.)
{param37}: Link da Nota Fiscal da Parcela. (Tipo do Dado: Texto.)
{param38}: Id BomControle do Departamento da Parcela. Valor zerado caso a Parcela possua mais de um Departamento. (Tipo do Dado: Inteiro.)
{param39}: Nome do Departamento da Parcela. Nullo caso a Parcela possua mais de um Departamento. (Tipo do Dado: Texto.)
{param40}: Id BomControle do Tipo do Departamento. (Opções: 1 - Administrativo, 2 - Produtivo. Tipo do Dado: Inteiro.)
{param41}: Nome do Tipo do Departamento. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Financeiro","Obter"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"f8b6f110-b790-4d79-a937-b1d4a3d58326","name":"Financeiro - Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/Obter?idMovimentacaoFinanceiraParcela=D11513C0-55FE-47BC-A187-909398DFF498","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Financeiro","Obter"],"query":[{"key":"idMovimentacaoFinanceiraParcela","value":"D11513C0-55FE-47BC-A187-909398DFF498"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 13:11:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"1435"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"IdMovimentacaoFinanceiraParcela\": \"d11513c0-55fe-47bc-a187-909398dff498\",\r\n \"Debito\": false,\r\n \"DataVencimento\": \"2020-01-01T10:42:21\",\r\n \"DataCompetencia\": \"2020-01-01T00:00:00\",\r\n \"DataQuitacao\": null,\r\n \"DataConciliacao\": null,\r\n \"Valor\": 15.50000,\r\n \"FormaPagamento\": 6,\r\n \"NomeFormaPagamento\": \"Cartão de Crédito\",\r\n \"TipoMovimentacao\": 1,\r\n \"NomeTipoMovimentacao\": \"Venda de serviço\",\r\n \"Nome\": \"Receita referente a Venda número 338 realizada dia 01/01/2020\",\r\n \"Observacao\": null,\r\n \"NumeroParcela\": 1,\r\n \"QuantidadeParcela\": 0,\r\n \"IdCategoriaFinanceira\": 0,\r\n \"NomeCategoriaFinanceira\": null,\r\n \"IconeCategoriaFinanceira\": null,\r\n \"IdContaFinanceira\": 1,\r\n \"NomeContaFinanceira\": \"Conta Teste\",\r\n \"NumeroConta\": \"111111\",\r\n \"DigitoConta\": \"1\",\r\n \"NumeroAgencia\": \"1111\",\r\n \"DigitoAgencia\": null,\r\n \"NomeBanco\": \"Itaú Unibanco S.A.\",\r\n \"NumeroBanco\": \"341\",\r\n \"IdEmpresa\": 1,\r\n \"NomeEmpresa\": \"Empresa Teste\",\r\n \"DocumentoEmpresa\": \"12345678000100\",\r\n \"IdCliente\": 1,\r\n \"IdFornecedor\": null,\r\n \"IdFuncionario\": null,\r\n \"NomeClienteFornecedor\": \"Cliente Teste\",\r\n \"NomeFantasiaClienteFornecedor\": \"Clientes Teste\",\r\n \"DocumentoClienteFornecedor\": \"12345678000100\",\r\n \"LinkBoletoBancario\": null,\r\n \"LinkNotaFiscalServico\": null,\r\n \"IdDepartamento\": null,\r\n \"NomeDepartamento\": null,\r\n \"TipoDepartamento\": null,\r\n \"NomeTipoDepartamento\": \"\"\r\n}"}],"_postman_id":"5f5f734e-dad0-4966-9dbc-5147ed48895c"},{"name":"Financeiro - Buscar","id":"33e43892-297c-4167-b1a0-7d6b3f0f911b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/Buscar","description":"

Pesquisa as Movimentações conforme o filtro utilizado.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no sistema BomControle.

\n\n

Paramêtros

idsMovimentacaoFinanceira: Id BomControle da Movimentação. (Obrigatório. Tipo do Dado: Array de Guids.)

\n\n

Response

Retorna um Array de objetos com os dados das Movimentações:

[\n  {\n    \"IdMovimentacaoFinanceiraParcela\": {param1},\n    \"Debito\": {param2},\n    \"DataVencimento\": {param3},\n    \"DataCompetencia\": {param4},\n    \"DataQuitacao\": {param5},\n    \"DataConciliacao\": {param6},\n    \"Valor\": {param7},\n    \"FormaPagamento\": {param8},\n    \"NomeFormaPagamento\": {param9},\n    \"TipoMovimentacao\": {param10},\n    \"NomeTipoMovimentacao\": {param11},\n    \"Nome\": {param12},\n    \"Observacao\": {param13},\n    \"NumeroParcela\": {param14},\n    \"QuantidadeParcela\": {param15},\n    \"IdCategoriaFinanceira\": {param16},\n    \"NomeCategoriaFinanceira\": {param17},\n    \"IconeCategoriaFinanceira\": {param18},\n    \"IdContaFinanceira\": {param19},\n    \"NomeContaFinanceira\": {param20},\n    \"NumeroConta\": {param21},\n    \"DigitoConta\": {param22},\n    \"NumeroAgencia\": {param23},\n    \"DigitoAgencia\": {param24},\n    \"NomeBanco\": {param25},\n    \"NumeroBanco\": {param26},\n    \"IdEmpresa\": {param27},\n    \"NomeEmpresa\": {param28},\n    \"DocumentoEmpresa\": {param29},\n    \"IdCliente\": {param30},\n    \"IdFornecedor\": {param31},\n    \"IdFuncionario\": {param32},\n    \"NomeClienteFornecedor\": {param33},\n    \"NomeFantasiaClienteFornecedor\": {param34},\n    \"DocumentoClienteFornecedor\": {param35},\n    \"LinkBoletoBancario\": {param36},\n    \"LinkNotaFiscalServico\": {param37},\n    \"IdDepartamento\": {param38},\n    \"NomeDepartamento\": {param39},\n    \"TipoDepartamento\": {param40},\n    \"NomeTipoDepartamento\": {param41}\n  }\n]\n\n

Paramêtros

{param1}: Id BomControle da Parcela. (Tipo do Dado: Texto.)
{param2}: Indica se é uma Movimentação de Débito. (Tipo do Dado: Booleano.)
{param3}: Data de Vencimento da Parcela. (Tipo do Dado: Texto.)
{param4}: Data de Competência da Parcela. (Tipo do Dado: Texto.)
{param5}: Data de Quitação da Parcela. (Tipo do Dado: Texto.)
{param6}: Data de Conciliação da Parcela. (Tipo do Dado: Texto.)
{param7}: Valor da Parcela. (Tipo do Dado: Decimal.)
{param8}: Forma de Pagamento da Parcela. (Opções: 1 - Dinheiro, 2 - Deposito, 3 - Cheque, 4 - DebitoEmContaCorrente, 5 - TransferenciaBancaria, 6 - CartaoCredito, 7 - CartaoDebito, 8 - DOC, 9 - TED, 10 - TransferenciaAplicativo, 11 - TransferenciaMoedaVirtual, 12 - InternetBanking, 13 - BoletoBancario, 14 - DescontoEmFolha, 15 - Outros, 16 - DebitoConta. Tipo do Dado: Inteiro.)
{param9}: Nome da Forma de Pagamento. (Tipo do Dado: Texto.)
{param10}: Tipo da Movimentação. (Dados: 0 - Inicial, 9 - Transferencia, 15 - AporteCapital, 16 - ReceitaProduto, 17 - ReceitaServico, 18 - OutrasReceitas, 19 - DespesaFornecedor, 20 - DespesaFuncionario, 21 - DespesaImposto, 22 - DivisaoLucro. Tipo do Dado: Texto.)
{param11}: Nome do Tipo da Movimentação. (Tipo do Dado: Texto.)
{param12}: Nome da Parcela da Movimentação. (Tipo do Dado: Texto.)
{param13}: Observação da Parcela da Movimentação. (Tipo do Dado: Texto.)
{param14}: Número da Parcela da Movimentação. (Tipo do Dado: Inteiro.)
{param15}: Quantidade de Parcelas da Movimentação. (Tipo do Dado: Inteiro.)
{param16}: Id BomControle da Categoria Financeira da Parcela. Valor zerado caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Inteiro.)
{param17}: Nome da Categoria Financeira da Parcela. Nullo caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Texto.)
{param18}: Ícone da Categoria Financeira da Parcela. Nullo caso a Parcela possua mais de uma Categoria. (Tipo do Dado: Texto.)
{param19}: Id BomControle da Conta Financeira da Parcela. (Tipo do Dado: Inteiro.)
{param20}: Nome da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param21}: Número da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param22}: Dígito da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param23}: Número da Agencia da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param24}: Dígito da Agencia da Conta Financeira da Parcela. (Tipo do Dado: Texto.)
{param25}: Nome do Banco da Conta Financeira da Parcela na Febraban. (Tipo do Dado: Texto.)
{param26}: Número do Banco da Conta Financeira da Parcela na Febraban. (Tipo do Dado: Texto.)
{param27}: Id BomControle da Empresa da Parcela. (Tipo do Dado: Inteiro.)
{param28}: Nome da Empresa da Parcela. (Tipo do Dado: Texto.)
{param29}: Cnpj da Empresa da Parcela. (Tipo do Dado: Texto.)
{param30}: Id BomControle do Cliente da Parcela para contas a Receber. (Tipo do Dado: Inteiro.)
{param31}: Id BomControle do Fornecedor da Parcela para contas a Pagar. (Tipo do Dado: Inteiro.)
{param32}: Id BomControle do Funcionário da Parcela para contas a Pagar. (Tipo do Dado: Inteiro.)
{param33}: Nome do Cliente/Fornecedor/Funcionário da Parcela. (Tipo do Dado: Texto.)
{param34}: Nome Fantasia do Cliente/Fornecedor da Parcela. (Tipo do Dado: Texto.)
{param35}: Documento do Cliente/Fornecedor/Funcionário da Parcela. (Tipo do Dado: Texto.)
{param36}: Link do Boleto Bancário da Parcela. (Tipo do Dado: Texto.)
{param37}: Link da Nota Fiscal da Parcela. (Tipo do Dado: Texto.)
{param38}: Id BomControle do Departamento da Parcela. Valor zerado caso a Parcela possua mais de um Departamento. (Tipo do Dado: Inteiro.)
{param39}: Nome do Departamento da Parcela. Nullo caso a Parcela possua mais de um Departamento. (Tipo do Dado: Texto.)
{param40}: Id BomControle do Tipo do Departamento. (Opções: 1 - Administrativo, 2 - Produtivo. Tipo do Dado: Inteiro.)
{param41}: Nome do Tipo do Departamento. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Financeiro","Buscar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"9a3482ba-450a-423f-bd08-cdf868a95bdc","name":"Financeiro - Buscar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/Buscar?idsMovimentacaoFinanceira=502A898D-D47A-4988-99D6-FC263A850AFB","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Financeiro","Buscar"],"query":[{"key":"idsMovimentacaoFinanceira","value":"502A898D-D47A-4988-99D6-FC263A850AFB"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 13:47:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"65560"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"IdMovimentacaoFinanceiraParcela\": \"7fc9a2c6-b3bf-4ba0-aad7-007ac5daebd5\",\r\n \"Debito\": false,\r\n \"DataVencimento\": \"2020-01-01T10:42:21\",\r\n \"DataCompetencia\": \"2020-01-01T00:00:00\",\r\n \"DataQuitacao\": null,\r\n \"DataConciliacao\": null,\r\n \"Valor\": 15.50000,\r\n \"FormaPagamento\": 6,\r\n \"NomeFormaPagamento\": \"Cartão de Crédito\",\r\n \"TipoMovimentacao\": 1,\r\n \"NomeTipoMovimentacao\": \"Venda de serviço\",\r\n \"Nome\": \"Receita referente a Venda número 338 realizada dia 01/01/2020\",\r\n \"Observacao\": null,\r\n \"NumeroParcela\": 1,\r\n \"QuantidadeParcela\": 0,\r\n \"IdCategoriaFinanceira\": 0,\r\n \"NomeCategoriaFinanceira\": null,\r\n \"IconeCategoriaFinanceira\": null,\r\n \"IdContaFinanceira\": 1,\r\n \"NomeContaFinanceira\": \"Conta Teste\",\r\n \"NumeroConta\": \"111111\",\r\n \"DigitoConta\": \"1\",\r\n \"NumeroAgencia\": \"1111\",\r\n \"DigitoAgencia\": null,\r\n \"NomeBanco\": \"Itaú Unibanco S.A.\",\r\n \"NumeroBanco\": \"341\",\r\n \"IdEmpresa\": 1,\r\n \"NomeEmpresa\": \"Empresa Teste\",\r\n \"DocumentoEmpresa\": \"12345678000100\",\r\n \"IdCliente\": 1,\r\n \"IdFornecedor\": null,\r\n \"IdFuncionario\": null,\r\n \"NomeClienteFornecedor\": \"Cliente Teste\",\r\n \"NomeFantasiaClienteFornecedor\": \"Cliente Teste\",\r\n \"DocumentoClienteFornecedor\": \"12345678000100\",\r\n \"LinkBoletoBancario\": null,\r\n \"LinkNotaFiscalServico\": null,\r\n \"IdDepartamento\": null,\r\n \"NomeDepartamento\": null,\r\n \"TipoDepartamento\": null,\r\n \"NomeTipoDepartamento\": \"\"\r\n }\r\n]"}],"_postman_id":"33e43892-297c-4167-b1a0-7d6b3f0f911b"},{"name":"Financeiro - Alterar Vencimento","id":"12af4817-4809-497a-a0ee-f364ca8da8b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/AlterarVencimento/{id}","description":"

Altera a data de vencimento da Parcela no BomControle.

Request

O request para essa API é feito informando a identificação da Parcela diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id da Parcela dentro do BomControle. (Obrigatório. Tipo do Dado: Guid.)

\n\n

Body

{\n  \"DataVencimento\": {param1}\n}\n

Paramêtros

{param1}: Data do novo vencimento da Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Financeiro","AlterarVencimento","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"afdf1e4c-2ce3-40e4-82c6-867dc7303309","name":"Financeiro - AlterarVencimento","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"DataVencimento\": \"2020-01-01 00:00:00\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/AlterarVencimento/D11513C0-55FE-47BC-A187-909398DFF498"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 14:15:26 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"12af4817-4809-497a-a0ee-f364ca8da8b2"},{"name":"Financeiro - Alterar Valor","id":"8610ccf7-76c5-44f3-b119-f2c8281f8198","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/AlterarValor/{id}","description":"

Altera o valor da Parcela no BomControle.

Request

O request para essa API é feito informando a identificação da Parcela diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id da Parcela no BomControle. (Obrigatório. Tipo do Dado: Guid.)

\n\n

Body

{\n  \"Valor\": {param1}\n}\n

Paramêtros

{param1}: Valor da Parcela. (Obrigatório. Tipo do Dado: Decimal.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Financeiro","AlterarValor","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"cdd388b5-d3d1-41c7-994a-cf7d57292b1b","name":"Financeiro - AlterarValor","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Valor\": 15.50\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/AlterarValor/363F08D1-57BA-4E11-9E8F-4E9403B97C33"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 15:08:18 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8610ccf7-76c5-44f3-b119-f2c8281f8198"},{"name":"Financeiro - Efetuar Pagamento","id":"70ffa319-2170-4b48-ae8c-87b6ac459526","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/EfetuarPagamento/{id}","description":"

Realiza a quitação da Parcela no BomControle.

Request

O request para essa API é feito informando a identificação da Parcela diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id da Parcela dentro do BomControle. (Obrigatório. Tipo do Dado: Guid.)

\n\n

Body

{\n  \"ValorPagamento\": {param1},\n  \"DataQuitacao\": {param2},\n  \"DataConciliacao\": {param3},\n  \"FormaPagamento\": {param4},\n  \"GerarResiduo\": {param5}\n}\n

Paramêtros

{param1}: Valor da Quitação. (Obrigatório. Tipo do Dado: Decimal.)
{param2}: Data da Quitação. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param3}: Data da Conciliação. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param4}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param5}: Indica se a diferença entre o valor da quitação e o valor da Parcela deve gerar uma nova Parcela. (Opcional. Tipo do Dado: Booleano.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Financeiro","EfetuarPagamento","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"29ca0a80-7eea-4ed6-a04e-576e8db80915","name":"Financeiro - EfetuarPagamento","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ValorPagamento\": 15.50,\r\n \"DataQuitacao\": \"2020-01-01 00:00:00\",\r\n \"DataConciliacao\": \"2020-01-01 00:00:00\",\r\n \"FormaPagamento\": \"Dinheiro\",\r\n \"GerarResiduo\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/EfetuarPagamento/D11513C0-55FE-47BC-A187-909398DFF498"},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 15:19:17 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"94"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"70ffa319-2170-4b48-ae8c-87b6ac459526"},{"name":"Financeiro - Remover","id":"b747e17c-68ab-48d3-85cd-2ef2809cc07e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/Remover/{id}","description":"

Realiza a exclusão da Parcela no BomControle.

Request

O request para essa API é feito informando a identificação da Parcela diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id da Parcela dentro do BomControle. (Obrigatório. Tipo do Dado: Guid.)

\n\n

Body

{\n  \"Motivo\": {param1}\n}\n

Paramêtros

{param1}: Motivo da exclusão da Parcela. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Financeiro","Remover","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"0278ab19-f4e0-46b0-a2d0-37c93ad73c8a","name":"Financeiro - Remover","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Motivo\": \"Teste\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Financeiro/Remover/D11513C0-55FE-47BC-A187-909398DFF498"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 15:51:11 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b747e17c-68ab-48d3-85cd-2ef2809cc07e"}],"id":"6a572bf5-155f-4568-a102-180b43fb0234","description":"

APIs para modificação das Parcelas Financeiras do BomControle.

\n","event":[{"listen":"prerequest","script":{"id":"3b0b8d45-fe6b-4502-bf89-949892d819ee","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5aff3505-2452-4f65-b6dd-f1a7b441b05a","type":"text/javascript","exec":[""]}}],"_postman_id":"6a572bf5-155f-4568-a102-180b43fb0234"},{"name":"Fornecedor","item":[{"name":"Fornecedor - Obter","id":"be83f8ce-64eb-4292-a30a-4bbfb689da0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/Obter/{id}","description":"

Obtem os dados do Fornecedor do BomControle pesquisado.

Request

O request para essa API é feito informando a identificação do Fornecedor a ser pesquisado diretamente na URL.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: Id do Fornecedor dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados do Fornecedor:

{\n  \"Id\": {param1},\n  \"IdPessoa\": {param2},\n  \"TipoPessoa\": {param3},\n  \"PaisOrigem\": {param4},\n  \"PessoaFisica\": {param5} {\n    \"Documento\": {param6},\n    \"Nome\": {param7},\n    \"Sexo\": {param8},\n    \"DataNascimento\": {param9}\n  },\n  \"PessoaJuridica\": {param10} {\n    \"Documento\": {param11},\n    \"NomeFantasia\": {param12},\n    \"RazaoSocial\": {param13},\n    \"IsentoInscricaoEstadual\": {param14},\n    \"InscricaoEstadual\": {param15},\n    \"UFInscricaoEstadual\": {param16},\n    \"InscricaoMunicipal\": {param17},\n    \"RamoAtividade\": {param18}\n  },\n  \"Bloqueado\": {param19},\n  \"Endereco\": {param20} {\n    \"Id\": {param21},\n    \"TipoLogradouro\": {param22},\n    \"Logradouro\": {param23},\n    \"Numero\": {param24},\n    \"Complemento\": {param25},\n    \"Bairro\": {param26},\n    \"Cep\": {param27},\n    \"Cidade\": {param28},\n    \"Uf\": {param29}\n  },\n  \"Contatos\": {param30} [\n    {\n      \"Id\": {param31},\n      \"IdCliente\": {param32},\n      \"IdFornecedor\": {param33},\n      \"IdFuncionario\": {param34},\n      \"Nome\": {param35},\n      \"Email\": {param36},\n      \"Telefone\": {param37},\n      \"Padrao\": {param38},\n      \"Cobranca\": {param39}\n    }\n  ]\n}\n

Paramêtros

{param1}: Id BomControle do Fornecedor. (Tipo do Dado: Inteiro.)
{param2}: Id da Pessoa do Fornecedor no BomControle. (Tipo do Dado: Inteiro.)
{param3}: Tipo de Pessoa. (Opções: Juridica, Fisica. Tipo do Dado: Texto.)
{param4}: País de Origem do Fornecedor. (Tipo do Dado: Texto.)
{param5}: Objeto contendo os dados caso seja um Fornecedor Pessoa Física. (Tipo do Dado: Objeto.)
{param6}: Cpf do Fornecedor. (Tipo do Dado: Texto.)
{param7}: Nome do Fornecedor. (Tipo do Dado: Texto.)
{param8}: Sexo do Fornecedor. (Opções: M, F, O. Tipo do Dado: Texto.)
{param9}: Data de Nascimento do Fornecedor (Tipo do Dado: Texto.)
{param10}: Objeto contendo os dados caso seja um Fornecedor Pessoa Jurídica. (Tipo do Dado: Objeto.)
{param11}: Cnpj do Fornecedor. (Tipo do Dado: Texto.)
{param12}: Nome Fantasia do Fornecedor. (Tipo do Dado: Texto.)
{param13}: Razão Social do Fornecedor. (Tipo do Dado: Texto.)
{param14}: Indica se o Fornecedor é Isento da Inscrição Estadual. (Tipo do Dado: Booleano.)
{param15}: Número da Inscrição Estadual do Fornecedor. (Tipo do Dado: Texto.)
{param16}: UF da Inscrição Estadual do Fornecedor. (Tipo do Dado: Texto.)
{param17}: Número da Inscrição Municipal do Fornecedor. (Tipo do Dado: Texto.)
{param18}: Ramo de Atividade do Fornecedor. (Tipo do Dado: Texto.)
{param19}: Indica se o Fornecedor esta Bloqueado no BomControle. (Tipo do Dado: Booleano.)
{param20}: Objeto com os dados de endereço do Fornecedor. (Tipo do Dado: Objeto.)
{param21}: Id do endereço do Fornecedor no BomControle. (Tipo do Dado: Inteiro.)
{param22}: Tipo de logradouro do Fornecedor. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param23}: Logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param24}: Número do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param25}: Complemento do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param26}: Bairro do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param27}: Cep do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param28}: Cidade do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param29}: Sigla do Estado do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param30}: Array de Objetos com os dados de contatos do Fornecedor. (Tipo do Dado: Array de Objetos.)
{param31}: Id do contato do Fornecedor no BomControle. (Tipo do Dado: Inteiro.)
{param32}: Não utilizado. (Tipo do Dado: Inteiro.)
{param33}: Id do Fornecedor no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param34}: Não utilizado. (Tipo do Dado: Inteiro.)
{param35}: Nome do contato do Fornecedor. (Tipo do Dado: Texto.)
{param36}: E-mail do contato do Fornecedor. (Tipo do Dado: Texto.)
{param37}: Telefone do contato do Fornecedor. (Tipo do Dado: Texto.)
{param38}: Indica se é o contato principal do Fornecedor. (Tipo do Dado: Booleano.)
{param39}: Indica se o contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)

","urlObject":{"protocol":"https","path":["integracao","Fornecedor","Obter","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"4639359a-4e12-4155-91c4-8245ae96ec84","name":"Fornecedor - Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/Obter/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 15:57:31 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"461"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"IdPessoa\": 1,\r\n \"TipoPessoa\": \"Juridica\",\r\n \"PaisOrigem\": \"Brasil\",\r\n \"PessoaFisica\": null,\r\n \"PessoaJuridica\": {\r\n \"Documento\": \"12345678000100\",\r\n \"NomeFantasia\": \"Teste\",\r\n \"RazaoSocial\": \"Teste\",\r\n \"IsentoInscricaoEstadual\": false,\r\n \"InscricaoEstadual\": null,\r\n \"UFInscricaoEstadual\": null,\r\n \"InscricaoMunicipal\": null,\r\n \"RamoAtividade\": null\r\n },\r\n \"Bloqueado\": false,\r\n \"Endereco\": null,\r\n \"Contatos\": []\r\n}"}],"_postman_id":"be83f8ce-64eb-4292-a30a-4bbfb689da0d"},{"name":"Fornecedor - Pesquisar","id":"6ce66e60-e3e5-4a9c-91d8-9b62b20fac28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/Pesquisar","description":"

Pesquisa os Fornecedores cadastrados no BomControle conforme o filtro utilizado.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

pesquisa: Localiza os Fornecedores do BomControle contendo o Documento ou Nome informado. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Retorna um array de objetos com os dados dos Fornecedores:

[\n      {\n      \"Id\": {param1},\n      \"IdPessoa\": {param2},\n      \"TipoPessoa\": {param3},\n      \"PaisOrigem\": {param4},\n      \"PessoaFisica\": {param5} {\n        \"Documento\": {param6},\n        \"Nome\": {param7},\n        \"Sexo\": {param8},\n        \"DataNascimento\": {param9}\n      },\n      \"PessoaJuridica\": {param10} {\n        \"Documento\": {param11},\n        \"NomeFantasia\": {param12},\n        \"RazaoSocial\": {param13},\n        \"IsentoInscricaoEstadual\": {param14},\n        \"InscricaoEstadual\": {param15},\n        \"UFInscricaoEstadual\": {param16},\n        \"InscricaoMunicipal\": {param17},\n        \"RamoAtividade\": {param18}\n      },\n      \"Bloqueado\": {param19},\n      \"Endereco\": {param20} {\n        \"Id\": {param21},\n        \"TipoLogradouro\": {param22},\n        \"Logradouro\": {param23},\n        \"Numero\": {param24},\n        \"Complemento\": {param25},\n        \"Bairro\": {param26},\n        \"Cep\": {param27},\n        \"Cidade\": {param28},\n        \"Uf\": {param29}\n      },\n      \"Contatos\": {param30} [\n        {\n          \"Id\": {param31},\n          \"IdCliente\": {param32},\n          \"IdFornecedor\": {param33},\n          \"IdFuncionario\": {param34},\n          \"Nome\": {param35},\n          \"Email\": {param36},\n          \"Telefone\": {param37},\n          \"Padrao\": {param38},\n          \"Cobranca\": {param39}\n        }\n      ]\n    }\n]\n

Paramêtros

{param1}: Id BomControle do Fornecedor. (Tipo do Dado: Inteiro.)
{param2}: Id da Pessoa do Fornecedor no BomControle. (Tipo do Dado: Inteiro.)
{param3}: Tipo de Pessoa. (Opções: Juridica, Fisica. Tipo do Dado: Texto.)
{param4}: País de Origem do Fornecedor. (Tipo do Dado: Texto.)
{param5}: Objeto contendo os dados caso seja um Fornecedor Pessoa Física. (Tipo do Dado: Objeto.)
{param6}: Cpf do Fornecedor. (Tipo do Dado: Texto.)
{param7}: Nome do Fornecedor. (Tipo do Dado: Texto.)
{param8}: Sexo do Fornecedor. (Opções: M, F, O. Tipo do Dado: Texto.)
{param9}: Data de Nascimento do Fornecedor (Tipo do Dado: Texto.)
{param10}: Objeto contendo os dados caso seja um Fornecedor Pessoa Jurídica. (Tipo do Dado: Objeto.)
{param11}: Cnpj do Fornecedor. (Tipo do Dado: Texto.)
{param12}: Nome Fantasia do Fornecedor. (Tipo do Dado: Texto.)
{param13}: Razão Social do Fornecedor. (Tipo do Dado: Texto.)
{param14}: Indica se o Fornecedor é Isento da Inscrição Estadual. (Tipo do Dado: Booleano.)
{param15}: Número da Inscrição Estadual do Fornecedor. (Tipo do Dado: Texto.)
{param16}: UF da Inscrição Estadual do Fornecedor. (Tipo do Dado: Texto.)
{param17}: Número da Inscrição Municipal do Fornecedor. (Tipo do Dado: Texto.)
{param18}: Ramo de Atividade do Fornecedor. (Tipo do Dado: Texto.)
{param19}: Indica se o Fornecedor esta Bloqueado no BomControle. (Tipo do Dado: Booleano.)
{param20}: Objeto com os dados de endereço do Fornecedor. (Tipo do Dado: Objeto.)
{param21}: Id do endereço do Fornecedor no BomControle. (Tipo do Dado: Inteiro.)
{param22}: Tipo de logradouro do Fornecedor. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param23}: Logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param24}: Número do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param25}: Complemento do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param26}: Bairro do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param27}: Cep do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param28}: Cidade do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param29}: Sigla do Estado do logradouro do Fornecedor. (Tipo do Dado: Texto.)
{param30}: Array de Objetos com os dados de contatos do Fornecedor. (Tipo do Dado: Array de Objetos.)
{param31}: Id do contato do Fornecedor no BomControle. (Tipo do Dado: Inteiro.)
{param32}: Não utilizado. (Tipo do Dado: Inteiro.)
{param33}: Id do Fornecedor no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param34}: Não utilizado. (Tipo do Dado: Inteiro.)
{param35}: Nome do contato do Fornecedor. (Tipo do Dado: Texto.)
{param36}: E-mail do contato do Fornecedor. (Tipo do Dado: Texto.)
{param37}: Telefone do contato do Fornecedor. (Tipo do Dado: Texto.)
{param38}: Indica se é o contato principal do Fornecedor. (Tipo do Dado: Booleano.)
{param39}: Indica se o contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)

","urlObject":{"protocol":"https","path":["integracao","Fornecedor","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"a314d2d9-dcb7-4343-b67f-b0e21f9b8355","name":"Fornecedor - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/Pesquisar?pesquisa=Teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Fornecedor","Pesquisar"],"query":[{"key":"pesquisa","value":"Teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 16:27:35 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"4842"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"IdPessoa\": 1,\r\n \"TipoPessoa\": \"Juridica\",\r\n \"PaisOrigem\": \"Brasil\",\r\n \"PessoaFisica\": null,\r\n \"PessoaJuridica\": {\r\n \"Documento\": \"12345678000100\",\r\n \"NomeFantasia\": \"Fornecedor Teste\",\r\n \"RazaoSocial\": \"Fornecedor Teste\",\r\n \"IsentoInscricaoEstadual\": false,\r\n \"InscricaoEstadual\": null,\r\n \"UFInscricaoEstadual\": \"0\",\r\n \"InscricaoMunicipal\": \"\",\r\n \"RamoAtividade\": null\r\n },\r\n \"Bloqueado\": false,\r\n \"Endereco\": {\r\n \"Id\": 1,\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdCliente\": 0,\r\n \"IdFornecedor\": 1,\r\n \"IdFuncionario\": 0,\r\n \"Nome\": \"Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": null,\r\n \"Padrao\": true,\r\n \"Cobranca\": false\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"6ce66e60-e3e5-4a9c-91d8-9b62b20fac28"},{"name":"Fornecedor - Criar","id":"de2a26d9-37d7-4c7b-aef1-46e68c61e8bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/Criar","description":"

Realiza o cadastro de um novo Fornecedor no BomControle.

Request

Os dados enviados para a API devem ser informados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Body

{\n  \"PessoaFisica\": {param1} {\n    \"Documento\": {param2},\n    \"Nome\": {param3},\n    \"Sexo\": {param4}\n  },\n  \"PessoaJuridica\": {param5} {\n    \"Documento\": {param6},\n    \"NomeFantasia\": {param7},\n    \"RazaoSocial\": {param8},\n    \"IsentoInscricaoEstadual\": {param9},\n    \"InscricaoEstadual\": {param10},\n    \"UFInscricaoEstadual\": {param11},\n    \"InscricaoMunicipal\": {param12}\n  },\n  \"Endereco\": {param13} {\n    \"TipoLogradouro\": {param14},\n    \"Logradouro\": {param15},\n    \"Numero\": {param16},\n    \"Complemento\": {param17},\n    \"Bairro\": {param18},\n    \"Cep\": {param19},\n    \"Cidade\": {param20},\n    \"Uf\": {param21}\n  },\n  \"Contatos\": {param22} [\n    {\n      \"Nome\": {param23},\n      \"Email\": {param24},\n      \"Telefone\": {param25},\n      \"Padrao\": {param26},\n      \"Cobranca\": {param27}\n    }\n  ]\n}\n

Paramêtros

{param1}: Objeto com os dados do Fornecedor caso ele seja pessoa Física. (Opcional. Tipo do Dado: Objeto.)
{param2}: Cpf do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param3}: Nome do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param4}: Sexo do Fornecedor. (Opcional. Opções: M, MASCULINO, F, FEMININO, O, OUTROS. Tipo do Dado: Texto.)
{param5}: Objeto com os dados do Fornecedor caso ele seja pessoa Juridica. (Opcional. Tipo do Dado: Objeto.)
{param6}: Cnpj do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param7}: Nome Fantasia do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param8}: Razão Social do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param9}: Indica se o Fornecedor é isento da Inscricao Estadual. (Opcional. Tipo do Dado: Texto.)
{param10}: Número da Inscricao Estadual do Fornecedor. (Opcional. Tipo do Dado: Texto.)
{param11}: Estado da Inscricao Estadual do Fornecedor. (Opcional. Tipo do Dado: Texto.)
{param12}: Número da Inscricao Municipal do Fornecedor. (Opcional. Tipo do Dado: Texto.)
{param13}: Objeto com os dados de endereço do Fornecedor. (Opcional. Tipo do Dado: Objeto.)
{param14}: Tipo de logradouro do Fornecedor. Caso não informado o sistema utiliza o tipo padrão \"Rua\". (Opcional. Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param15}: Logradouro do Fornecedor. (Opcional. Tipo do Dado: Texto.)
{param16}: Número do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param17}: Complemento do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param18}: Bairro do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param19}: Cep do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param20}: Cidade do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param21}: Sigla do Estado do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param22}: Array de Objetos com os dados de contatos do Fornecedor. (Opcional. Tipo do Dado: Array de Objetos.)
{param23}: Nome do Contato do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param24}: E-mail do Contato do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param25}: Telefone do Contato do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param26}: Indica se é o Contato principal do Fornecedor. (Opcional. Tipo do Dado: Booleano.)
{param27}: Indica se o Contato esta cadastrado para recebimento de cobranças do BomControle. (Opcional. Tipo do Dado: Booleano.)

\n\n

Response

Retorna o Id do Fornecedor cadastrado no BomControle. (Tipo do Dado: Inteiro.)

\n","urlObject":{"protocol":"https","path":["integracao","Fornecedor","Criar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"a378b911-74f5-44d2-9dc7-7a9042581186","name":"Fornecedor - Criar","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"PessoaFisica\": null,\r\n \"PessoaJuridica\": {\r\n \"Documento\": \"12345678000100\",\r\n \"NomeFantasia\": \"Teste\",\r\n \"RazaoSocial\": \"Teste\",\r\n \"IsentoInscricaoEstadual\": true,\r\n \"InscricaoEstadual\": null,\r\n \"UFInscricaoEstadual\": null,\r\n \"InscricaoMunicipal\": null\r\n },\r\n \"Endereco\": {\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": [\r\n {\r\n \"Nome\": \"Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": \"1111111111\",\r\n \"Padrao\": true,\r\n \"Cobranca\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/Criar"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 16:45:21 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"1"}],"_postman_id":"de2a26d9-37d7-4c7b-aef1-46e68c61e8bf"},{"name":"Fornecedor - Alterar","id":"fe10f490-3e82-48bc-936e-0b3f962bb092","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/Alterar/{id}","description":"

Altera os dados de cadastro do Fornecedor no BomControle.

Request

O request para essa API é feito informando o Id do Fornecedor do BomControle na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do Fornecedor dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"PessoaFisica\": {param1} {\n    \"Documento\": {param2},\n    \"Nome\": {param3},\n    \"Sexo\": {param4}\n  },\n  \"PessoaJuridica\": {param5} {\n    \"Documento\": {param6},\n    \"NomeFantasia\": {param7},\n    \"RazaoSocial\": {param8},\n    \"IsentoInscricaoEstadual\": {param9},\n    \"InscricaoEstadual\": {param10},\n    \"UFInscricaoEstadual\": {param11},\n    \"InscricaoMunicipal\": {param12}\n  }\n}\n

Paramêtros

{param1}: Objeto com os dados do Fornecedor caso ele seja pessoa Física. (Opcional. Tipo do Dado: Objeto.)
{param2}: Cpf do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param3}: Nome do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param4}: Sexo do Fornecedor. (Opcional. Opções: M, MASCULINO, F, FEMININO, O, OUTROS. Tipo do Dado: Texto.)
{param5}: Objeto com os dados do Fornecedor caso ele seja pessoa Juridica. (Opcional. Tipo do Dado: Objeto.)
{param6}: Cnpj do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param7}: Nome Fantasia do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param8}: Razão Social do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param9}: Indica se o Fornecedor é isento da Inscricao Estadual. (Opcional. Tipo do Dado: Texto.)
{param10}: Número da Inscricao Estadual do Fornecedor. (Opcional. Tipo do Dado: Texto.)
{param11}: Estado da Inscricao Estadual do Fornecedor. (Opcional. Tipo do Dado: Texto.)
{param12}: Número da Inscricao Municipal do Fornecedor. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Fornecedor","Alterar","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"35131e47-edc4-4149-b777-deba69bbabf0","name":"Fornecedor - Alterar","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"PessoaFisica\": null,\r\n \"PessoaJuridica\": {\r\n \"Documento\": \"12345678000100\",\r\n \"NomeFantasia\": \"Teste\",\r\n \"RazaoSocial\": \"Teste\",\r\n \"IsentoInscricaoEstadual\": true,\r\n \"InscricaoEstadual\": null,\r\n \"UFInscricaoEstadual\": null,\r\n \"InscricaoMunicipal\": null\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/Alterar/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 18:24:26 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fe10f490-3e82-48bc-936e-0b3f962bb092"},{"name":"Fornecedor - Alterar Contatos","id":"fe37fa5b-608c-41d6-8411-38995810618b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/AlterarContatos/{id}","description":"

Altera ou remove os Contatos do Fornecedor no BomControle.

Request

O request para essa API é feito informando o Id do Fornecedor no BomControle na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do Fornecedor no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"Contatos\": {param1} [\n    {\n      \"Id\": {param2},\n      \"Nome\": {param3},\n      \"Email\": {param4},\n      \"Telefone\": {param5},\n      \"Padrao\": {param6},\n      \"Cobranca\": {param7}\n    }\n  ]\n}\n

Paramêtros

{param1}: Array de Objetos com os dados dos Contatos a serem alterados. (Obrigatorio. Tipo do Dado: Array de Objetos.)
{param2}: Id BomControle do Contato do Fornecedor. Caso não seja passado o Id, contatos que existirem serão removidos. Caso seja passado Zero será feito um novo cadastro. (Obrigatório. Tipo do Dado: Inteiro.)
{param3}: Nome do Contato do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param4}: E-mail do Contato do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param5}: Telefone do Contato do Fornecedor. (Obrigatório. Tipo do Dado: Texto.)
{param6}: Indica se é o Contato principal do Fornecedor. (Opcional. Tipo do Dado: Booleano.)
{param7}: Indica se o Contato esta cadastrado para recebimento de cobranças do BomControle. (Opcional. Tipo do Dado: Booleano.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Fornecedor","AlterarContatos","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"d1365f58-9187-4174-8682-f20fa9659dbd","name":"Fornecedor - AlterarContatos","originalRequest":{"method":"PUT","header":[{"key":"Authorization","type":"text","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA=="},{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"Nome\": \"Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": \"1111111111\",\r\n \"Padrao\": true,\r\n \"Cobranca\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/AlterarContatos/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 18:44:16 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fe37fa5b-608c-41d6-8411-38995810618b"},{"name":"Fornecedor - Alterar Endereco","id":"05899dd5-d4e2-4293-8fba-da5c961c471e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/AlterarEndereco/{id}","description":"

Altera ou remove o Endereço do Fornecedor no BomControle.

Request

O request para essa API é feito informando o Id do Fornecedor no BomControle na URL e os dados no Body do Request. Caso não tenha um Body informado o cadastro do endereço é removido.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do Fornecedor no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"TipoLogradouro\": {param1},\n  \"Logradouro\": {param2},\n  \"Numero\": {param3},\n  \"Complemento\": {param4},\n  \"Bairro\": {param5},\n  \"Cep\": {param6},\n  \"Cidade\": {param7},\n  \"Uf\": {param8}\n}\n

Paramêtros

{param1}: Tipo de logradouro do Fornecedor. Caso não informado o sistema utiliza o tipo padrão \"Rua\". (Opcional. Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param2}: Logradouro do Fornecedor. (Opcional. Tipo do Dado: Texto.)
{param3}: Número do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param4}: Complemento do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param5}: Bairro do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param6}: Cep do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param7}: Cidade do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)
{param8}: Sigla do Estado do logradouro do Fornecedor. (Opcional.Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Fornecedor","AlterarEndereco","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"88ea18e8-afbf-49fa-b5d9-cf39fdfc0a09","name":"Fornecedor - AlterarEndereco","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/AlterarEndereco/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 18:54:57 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"05899dd5-d4e2-4293-8fba-da5c961c471e"},{"name":"Fornecedor - Alterar Bloqueio","id":"a077755b-6b2e-4b1e-b86a-938ff1830f3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/AlterarBloqueio/{id}","description":"

Efetua o Bloqueio/Desbloqueio do cadastro do Fornecedor no BomControle.

Request

O request para essa API é feito informando o Id do Fornecedor no BomControle na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do Fornecedor no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"Bloquear\": {param1}\n}\n

Paramêtros

{param1}: Indica se deve ser feito o Bloqueio/Desbloqueio do Fornecedor. (Obrigatório. Tipo do Dado: Booleano.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Fornecedor","AlterarBloqueio","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"c34fd32d-665e-4b91-97a3-744a99a6e6ae","name":"Fornecedor - AlterarBloqueio","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Bloquear\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Fornecedor/AlterarBloqueio/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 19:04:07 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"a077755b-6b2e-4b1e-b86a-938ff1830f3e"}],"id":"104bab51-c1a7-411d-8a64-734ade14d813","description":"

APIs para modificação dos Fornecedores do BomControle.

\n","event":[{"listen":"prerequest","script":{"id":"55b77324-a9dd-47f7-902e-9539b6adfa73","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f3041542-4efb-468a-aacc-629c79a8b0ad","type":"text/javascript","exec":[""]}}],"_postman_id":"104bab51-c1a7-411d-8a64-734ade14d813"},{"name":"Funcionario","item":[{"name":"Funcionario - Obter","id":"77a8a0a6-77a1-4de7-b52d-68f4967a4351","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/Obter/{id}","description":"

Obtem os dados de cadastro no BomControle do Funcionário pesquisado.

Request

O request para essa API é feito informando a identificação do Funcionário a ser pesquisado diretamente na URL.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: Id do Funcionário no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados do Funcionário.

{\n  \"Id\": {param1},\n  \"IdPessoa\": {param2},\n  \"PessoaFisica\": {param3} {\n    \"Documento\": {param4},\n    \"Nome\": {param5},\n    \"Sexo\": {param6},\n    \"DataNascimento\": {param7}\n  },\n  \"Endereco\": {param8} {\n    \"Id\": {param9},\n    \"TipoLogradouro\": {param10},\n    \"Logradouro\": {param11},\n    \"Numero\": {param12},\n    \"Complemento\": {param13},\n    \"Bairro\": {param14},\n    \"Cep\": {param15},\n    \"Cidade\": {param16},\n    \"Uf\": {param17}\n  },\n  \"Contatos\": {param18} [\n    {\n      \"Id\": {param19},\n      \"IdCliente\": {param20},\n      \"IdFornecedor\": {param21},\n      \"IdFuncionario\": {param22},\n      \"Nome\": {param23},\n      \"Email\": {param24},\n      \"Telefone\": {param25},\n      \"Padrao\": {param26},\n      \"Cobranca\": {param27}\n    }\n  ],\n  \"Empresas\": {param28} [\n    {\n      \"IdFuncionario\": {param29},\n      \"IdEmpresa\": {param30},\n      \"NomeEmpresa\": {param31},\n      \"DocumentoEmpresa\": {param32},\n      \"SiglaEmpresa\": {param33},\n      \"CorEmpresa\": {param34}\n    }\n  ]\n}\n\n

Paramêtros

{param1}: Id BomControle do Funcionário. (Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Pessoa do Funcionário. (Tipo do Dado: Inteiro.)
{param3}: Objeto com os dados do Funcionário. (Tipo do Dado: Objeto.)
{param4}: Cpf do Funcionário. (Tipo do Dado: Texto.)
{param5}: Nome do Funcionário. (Tipo do Dado: Texto.)
{param6}: Sexo do Funcionário. (Opções: M, F, O. Tipo do Dado: Texto.)
{param7}: Data de nascimento do Funcionário. (Tipo do Dado: Texto.)
{param8}: Objeto com os dados de endereço do Funcionário. (Tipo do Dado: Objeto.)
{param9}: Id do endereço do Funcionário no BomControle. (Tipo do Dado: Inteiro.)
{param10}: Tipo de logradouro do Funcionário. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param11}: Logradouro do Funcionário. (Tipo do Dado: Texto.)
{param12}: Número do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param13}: Complemento do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param14}: Bairro do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param15}: Cep do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param16}: Cidade do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param17}: Sigla do Estado do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param18}: Array de Objetos com os dados de contatos do Funcionário. (Tipo do Dado: Array de Objetos.)
{param19}: Id do Contato do Funcionário no BomControle. (Tipo do Dado: Inteiro.)
{param20}: Não utilizado. (Tipo do Dado: Inteiro.)
{param21}: Não utilizado. (Tipo do Dado: Inteiro.)
{param22}: Id do Funcionário no BomControle o qual esse Contato pertence. (Tipo do Dado: Inteiro.)
{param23}: Nome do Contato do Funcionário. (Tipo do Dado: Texto.)
{param24}: E-mail do Contato do Funcionário. (Tipo do Dado: Texto.)
{param25}: Telefone do Contato do Funcionário. (Tipo do Dado: Texto.)
{param26}: Indica se é o Contato principal do Funcionário. (Tipo do Dado: Booleano.)
{param27}: Indica se o Contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)
{param28}: Array de Objetos com os dados de empresas do Funcionário. (Tipo do Dado: Array de Objetos.)
{param29}: Id do Funcionário no BomControle. (Tipo do Dado: Inteiro.)
{param30}: Id da Empresa do Funcionário no BomControle. (Tipo do Dado: Inteiro.)
{param31}: Nome da Empresa do Funcionário. (Tipo do Dado: Texto.)
{param32}: Documento da Empresa do Funcionário. (Tipo do Dado: Texto.)
{param33}: Sigla da Empresa do Funcionário. (Tipo do Dado: Texto.)
{param34}: Cor da Empresa do Funcionário. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Funcionario","Obter","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"f787925d-4de5-42b0-9cef-562742a83337","name":"Funcionario - Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/Obter/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 19:12:45 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"212"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"IdPessoa\": 1,\r\n \"PessoaFisica\": {\r\n \"Documento\": \"12345678900\",\r\n \"Nome\": \"Teste\",\r\n \"Sexo\": \"M\",\r\n \"DataNascimento\": null\r\n },\r\n \"Endereco\": null,\r\n \"Contatos\": []\r\n}"}],"_postman_id":"77a8a0a6-77a1-4de7-b52d-68f4967a4351"},{"name":"Funcionario - Pesquisar","id":"c4922898-fa21-46ef-869f-47175f183787","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/Pesquisar","description":"

Pesquisa de Funcionários conforme a condição informada no filtro.

Request

O request para essa API é feito através de Querystring usando o paramêtro informado abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{pesquisa}: Parte do nome ou cpf dos Funcionários a serem pesquisados. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Retorna um arrays de objetos com os dados dos Funcionários.

[\n    {\n      \"Id\": {param1},\n      \"IdPessoa\": {param2},\n      \"PessoaFisica\": {param3} {\n        \"Documento\": {param4},\n        \"Nome\": {param5},\n        \"Sexo\": {param6},\n        \"DataNascimento\": {param7}\n      },\n      \"Endereco\": {param8} {\n        \"Id\": {param9},\n        \"TipoLogradouro\": {param10},\n        \"Logradouro\": {param11},\n        \"Numero\": {param12},\n        \"Complemento\": {param13},\n        \"Bairro\": {param14},\n        \"Cep\": {param15},\n        \"Cidade\": {param16},\n        \"Uf\": {param17}\n      },\n      \"Contatos\": {param18} [\n      {\n        \"Id\": {param19},\n        \"IdCliente\": {param20},\n        \"IdFornecedor\": {param21},\n        \"IdFuncionario\": {param22},\n        \"Nome\": {param23},\n        \"Email\": {param24},\n        \"Telefone\": {param25},\n        \"Padrao\": {param26},\n        \"Cobranca\": {param27}\n      }\n   ],\n  \"Empresas\": {param28} [\n    {\n      \"IdFuncionario\": {param29},\n      \"IdEmpresa\": {param30},\n      \"NomeEmpresa\": {param31},\n      \"DocumentoEmpresa\": {param32},\n      \"SiglaEmpresa\": {param33},\n      \"CorEmpresa\": {param34}\n    }\n  ]\n}\n\n

Paramêtros

{param1}: Id BomControle do Funcionário. (Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Pessoa do Funcionário. (Tipo do Dado: Inteiro.)
{param3}: Objeto com os dados do Funcionário. (Tipo do Dado: Objeto.)
{param4}: Cpf do Funcionário. (Tipo do Dado: Texto.)
{param5}: Nome do Funcionário. (Tipo do Dado: Texto.)
{param6}: Sexo do Funcionário. (Opções: M, F, O. Tipo do Dado: Texto.)
{param7}: Data de nascimento do Funcionário. (Tipo do Dado: Texto.)
{param8}: Objeto com os dados de endereço do Funcionário. (Tipo do Dado: Objeto.)
{param9}: Id do endereço do Funcionário no BomControle. (Tipo do Dado: Inteiro.)
{param10}: Tipo de logradouro do Funcionário. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param11}: Logradouro do Funcionário. (Tipo do Dado: Texto.)
{param12}: Número do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param13}: Complemento do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param14}: Bairro do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param15}: Cep do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param16}: Cidade do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param17}: Sigla do Estado do logradouro do Funcionário. (Tipo do Dado: Texto.)
{param18}: Array de Objetos com os dados de contatos do Funcionário. (Tipo do Dado: Array de Objetos.)
{param19}: Id do Contato do Funcionário no BomControle. (Tipo do Dado: Inteiro.)
{param20}: Não utilizado. (Tipo do Dado: Inteiro.)
{param21}: Não utilizado. (Tipo do Dado: Inteiro.)
{param22}: Id do Funcionário no BomControle o qual esse Contato pertence. (Tipo do Dado: Inteiro.)
{param23}: Nome do Contato do Funcionário. (Tipo do Dado: Texto.)
{param24}: E-mail do Contato do Funcionário. (Tipo do Dado: Texto.)
{param25}: Telefone do Contato do Funcionário. (Tipo do Dado: Texto.)
{param26}: Indica se é o Contato principal do Funcionário. (Tipo do Dado: Booleano.)
{param27}: Indica se o Contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)
{param28}: Array de Objetos com os dados de empresas do Funcionário. (Tipo do Dado: Array de Objetos.)
{param29}: Id do Funcionário no BomControle. (Tipo do Dado: Inteiro.)
{param30}: Id da Empresa do Funcionário no BomControle. (Tipo do Dado: Inteiro.)
{param31}: Nome da Empresa do Funcionário. (Tipo do Dado: Texto.)
{param32}: Documento da Empresa do Funcionário. (Tipo do Dado: Texto.)
{param33}: Sigla da Empresa do Funcionário. (Tipo do Dado: Texto.)
{param34}: Cor da Empresa do Funcionário. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Funcionario","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"a6acf7b3-73dd-4461-af83-a7b009b34cf0","name":"Funcionario - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/Pesquisar?pesquisa=teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Funcionario","Pesquisar"],"query":[{"key":"pesquisa","value":"teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 19:26:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"784"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"IdPessoa\": 1,\r\n \"PessoaFisica\": {\r\n \"Documento\": \"12345678900\",\r\n \"Nome\": \"Teste\",\r\n \"Sexo\": \"M\",\r\n \"DataNascimento\": null\r\n },\r\n \"Endereco\": {\r\n \"Id\": 1,\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdCliente\": 0,\r\n \"IdFornecedor\": 0,\r\n \"IdFuncionario\": 1,\r\n \"Nome\": \"Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": \"1111111111\",\r\n \"Padrao\": true,\r\n \"Cobranca\": false\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"c4922898-fa21-46ef-869f-47175f183787"},{"name":"Funcionario - Criar","id":"4797c041-1e31-4629-8780-02c47b2c014b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/Criar","description":"

Realiza o cadastro de um novo Funcionário no BomControle.

Request

Os dados enviados para a API devem ser informados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Body

{\n  \"PessoaFisica\": {param1} {\n    \"Documento\": {param2},\n    \"Nome\": {param3},\n    \"Sexo\": {param4},\n    \"DataNascimento\": {param5}\n  },\n  \"Endereco\": {param6} {\n    \"TipoLogradouro\": {param7},\n    \"Logradouro\": {param8},\n    \"Numero\": {param9},\n    \"Complemento\": {param10},\n    \"Bairro\": {param11},\n    \"Cep\": {param12},\n    \"Cidade\": {param13},\n    \"Uf\": {param14}\n  },\n  \"Contatos\": {param15} [\n    {\n      \"Nome\": {param16},\n      \"Email\": {param17},\n      \"Telefone\": {param18},\n      \"Padrao\": {param19},\n      \"Cobranca\": {param20}\n    }\n  ],\n  \"Cargo\": {param21},\n  \"CodigoRh\": {param22},\n  \"DataAdmissao\": {param23},\n  \"DataDemissao\": {param24},\n  \"Observacao\": {param25},\n  \"IdsEmpresa\": {param26} [\n  ]\n}\n\n

Paramêtros

{param1}: Objeto com os dados do Funcionário. (Obrigatório. Tipo do Dado: Objeto.)
{param2}: Cpf do Funcionário. (Obrigatório. Tipo do Dado: Texto.)
{param3}: Nome do Funcionário. (Obrigatório. Tipo do Dado: Texto.)
{param4}: Sexo do Funcionário. (Opcional. Opções: M, MASCULINO, F, FEMININO, O, OUTROS. Tipo do Dado: Texto.)
{param5}: Data de Nascimento do Funcionário. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param6}: Objeto com os dados de endereço do Funcionário. (Opcional. Tipo do Dado: Objeto.)
{param7}: Tipo de logradouro do Funcionário. Caso não informado o sistema utiliza o tipo padrão \"Rua\". (Opcional. Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param8}: Logradouro do Funcionário. (Opcional. Tipo do Dado: Texto.)
{param9}: Número do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param10}: Complemento do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param11}: Bairro do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param12}: Cep do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param13}: Cidade do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param14}: Sigla do Estado do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param15}: Array de Objetos com os dados de contatos do Funcionário. (Opcional. Tipo do Dado: Array de Objetos.)
{param16}: Nome do Contato do Funcionário. (Obrigatório. Tipo do Dado: Texto.)
{param17}: E-mail do Contato do Funcionário. (Obrigatório. Tipo do Dado: Texto.)
{param18}: Telefone do Contato do Funcionário. (Obrigatório. Tipo do Dado: Texto.)
{param19}: Indica se é o Contato principal do Funcionário. (Opcional. Tipo do Dado: Booleano.)
{param20}: Indica se o Contato esta cadastrado para recebimento de cobranças do BomControle. (Opcional. Tipo do Dado: Booleano.)
{param21}: Cargo do Funcionário. (Opcional. Tipo do Dado: Texto.)
{param22}: Código no RH do Funcionário. (Opcional. Tipo do Dado: Texto.)
{param23}: Data de Admissão do Funcionário. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param24}: Data de Demissão do Funcionário. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param25}: Observação do Funcionário (Opcional. Tipo do Dado: Texto.)
{param26}: Array de Objetos com IDs de Empresas do Funcionário. (Obrigatório para BPO ativo. Tipo do Dado: Array de Objetos)

\n\n

Response

Retorna o Id do Funcionário cadastrado no BomControle. (Tipo do Dado: Inteiro.)

\n","urlObject":{"protocol":"https","path":["integracao","Funcionario","Criar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"2fd8a4b9-99c9-48f2-a8c6-d817ac96a729","name":"Funcionario - Criar","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"PessoaFisica\": {\r\n \"Documento\": \"12345678900\",\r\n \"Nome\": \"Teste\",\r\n \"Sexo\": \"Teste\",\r\n \"DataNascimento\": \"2020-01-01 00:00:00\"\r\n },\r\n \"Endereco\": {\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": [\r\n {\r\n \"Nome\": \"Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": \"1111111111\",\r\n \"Padrao\": true,\r\n \"Cobranca\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/Criar"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 03 Feb 2020 19:40:41 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"2"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"1"}],"_postman_id":"4797c041-1e31-4629-8780-02c47b2c014b"},{"name":"Funcionario - Alterar","id":"d14f0cab-5f60-484e-b516-f753c6e2d373","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/Alterar/{id}","description":"

Altera os dados de cadastro do Funcionário no BomControle.

Request

O request para essa API é feito informando o Id do Funcionário do BomControle na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do Funcionário dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"PessoaFisica\": {\n    \"Documento\": {param1},\n    \"Nome\": {param2},\n    \"Sexo\": {param3},\n    \"DataNascimento\": {param4},\n    \"Rg\": {param5}\n  },\n  \"IdsEmpresa\": [\n    {param6}\n  ]\n}\n\n

Paramêtros

{param1}: Cpf do Funcionário. (Obrigatório. Tipo do Dado: Texto.)
{param2}: Nome do Funcionário. (Obrigatório. Tipo do Dado: Texto.)
{param3}: Sexo do Funcionário. (Opcional. Opções: M, MASCULINO, F, FEMININO, O, OUTROS. Tipo do Dado: Texto.)
{param4}: Data de Nascimento do Funcionário. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param5}: RG do Funcionário; (Opcional. Tipo do Dado: Texto.)
{param6}: Array de Objetos com IDs de Empresas do Funcionário. (Obrigatório para BPO ativo. Tipo do Dado: Array de Objetos)EndFragment

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Funcionario","Alterar","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"42b879e9-6ed2-4b74-9efe-b8005b2e0583","name":"Funcionario - Alterar","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"PessoaFisica\": {\r\n \"Documento\": \"12345678900\",\r\n \"Nome\": \"Teste\",\r\n \"Sexo\": \"M\",\r\n \"DataNascimento\": \"2020-01-01 00:00:00\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/Alterar/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 13:03:59 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"d14f0cab-5f60-484e-b516-f753c6e2d373"},{"name":"Funcionario - Alterar Contatos","id":"df5f9596-405c-47b3-9a6d-abdf28f91000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/AlterarContatos/{id}","description":"

Altera ou remove os Contatos do Funcionário no BomControle.

Request

O request para essa API é feito informando o Id do Funcionário no BomControle na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do Funcionário no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"Contatos\": {param1} [\n    {\n      \"Id\": {param2},\n      \"Nome\": {param3},\n      \"Email\": {param4},\n      \"Telefone\": {param5},\n      \"Padrao\": {param6},\n      \"Cobranca\": {param7}\n    }\n  ]\n}\n\n

Paramêtros

{param1}: Array de Objetos com os dados dos Contatos a serem alterados. (Obrigatorio. Tipo do Dado: Array de Objetos.)
{param2}: Id BomControle do Contato do Funcionário. Caso não seja passado o Id, contatos que existirem serão removidos. Caso seja passado Zero será feito um novo cadastro. (Obrigatório. Tipo do Dado: Inteiro.)
{param3}: Nome do Contato do Funcionário. (Obrigatório. Tipo do Dado: Texto.)
{param4}: E-mail do Contato do Funcionário. (Obrigatório. Tipo do Dado: Texto.)
{param5}: Telefone do Contato do Funcionário. (Obrigatório. Tipo do Dado: Texto.)
{param6}: Indica se é o Contato principal do Funcionário. (Opcional. Tipo do Dado: Booleano.)
{param7}: Indica se o Contato esta cadastrado para recebimento de cobranças do BomControle. (Opcional. Tipo do Dado: Booleano.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Funcionario","AlterarContatos","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"0d1d639c-6ca7-4fc4-abc2-d738a67dfc57","name":"Funcionario - AlterarContatos","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"Nome\": \"Teste\",\r\n \"Email\": \"Teste\",\r\n \"Telefone\": \"1111111111\",\r\n \"Padrao\": true,\r\n \"Cobranca\": true\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/AlterarContatos/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 13:26:17 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"df5f9596-405c-47b3-9a6d-abdf28f91000"},{"name":"Funcionario - Alterar Endereco","id":"6f655c53-7a7a-48eb-b72f-4a9544d5be45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/AlterarEndereco/{id}","description":"

Altera ou remove o Endereço do Funcionário no BomControle.

Request

O request para essa API é feito informando o Id do Funcionário no BomControle na URL e os dados no Body do Request. Caso não tenha um Body informado o cadastro do endereço é removido.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do Funcionário no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"TipoLogradouro\": {param1},\n  \"Logradouro\": {param2},\n  \"Numero\": {param3},\n  \"Complemento\": {param4},\n  \"Bairro\": {param5},\n  \"Cep\": {param6},\n  \"Cidade\": {param7},\n  \"Uf\": {param8}\n}\n

Paramêtros

{param1}: Tipo de logradouro do Funcionário. Caso não informado o sistema utiliza o tipo padrão \"Rua\". (Opcional. Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param2}: Logradouro do Funcionário. (Opcional. Tipo do Dado: Texto.)
{param3}: Número do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param4}: Complemento do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param5}: Bairro do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param6}: Cep do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param7}: Cidade do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)
{param8}: Sigla do Estado do logradouro do Funcionário. (Opcional.Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Funcionario","AlterarEndereco","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"7ca6e388-91e2-40ea-a42e-0b715b57c53c","name":"Funcionario - AlterarEndereco","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Funcionario/AlterarEndereco/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 13:33:32 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"6f655c53-7a7a-48eb-b72f-4a9544d5be45"}],"id":"30782d9b-7e82-4401-9457-ccaee2965d37","description":"

APIs para modificação dos Funcionários do BomControle.

\n","_postman_id":"30782d9b-7e82-4401-9457-ccaee2965d37"},{"name":"Lead","item":[{"name":"Lead - Criar","id":"bc82753d-4c57-47fe-a5ad-277cf54f0dbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Lead/Criar","description":"

Realiza o cadastro do Lead no BomControle.

Request

Os dados enviados para a API devem ser informados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Body

{\n  \"PessoaJuridica\": {param1}{\n    \"Documento\": {param2},\n    \"NomeFantasia\": {param3},\n    \"RazaoSocial\": {param4}\n  },\n  \"PessoaFisica\": {param5}{\n    \"Documento\": {param6},\n    \"Nome\": {param7}\n  },\n  \"Enderecos\": {param8} [\n    {\n      \"Cep\": {param9},\n      \"Logradouro\": {param10},\n      \"Numero\": {param11},\n      \"Complemento\": {param12},\n      \"Bairro\": {param13},\n      \"Padrao\": {param14},\n      \"Referencia\": {param15},\n      \"TipoLogradouro\": {\n        \"Id\": {param16}\n      },\n      \"Uf\": {param17},\n      \"Cidade\": {param18}\n    }\n  ],\n  \"Contatos\": {param19} [\n    {\n      \"Nome\": {param20},\n      \"Email\": {param21},\n      \"Telefone\": {param22},\n      \"Celular\": {param23},\n      \"Fax\": {param24}\n    }\n  ]\n}\n

Paramêtros

{param1}: Objeto com os dados do Lead caso ele seja pessoa Juridica. (Opcional. Tipo do Dado: Objeto.)
{param2}: Cnpj do Lead. (Obrigatório. Tipo do Dado: Texto.)
{param3}: Nome Fantasia do Lead. (Obrigatório. Tipo do Dado: Texto.)
{param4}: Razão Social do Lead. (Obrigatório. Tipo do Dado: Texto.)
{param5}: Objeto com os dados do Lead caso ele seja pessoa Física. (Opcional. Tipo do Dado: Objeto.)
{param6}: Cpf do Lead. (Obrigatório. Tipo do Dado: Texto.)
{param7}: Nome do Lead. (Obrigatório. Tipo do Dado: Texto.)
{param8}: Array de objetos com os dados de endereço do Lead. (Opcional. Tipo do Dado: Objeto.)
{param9}: Cep do logradouro do Lead. (Opcional.Tipo do Dado: Texto.)
{param10}: Logradouro do Lead. (Opcional. Tipo do Dado: Texto.)
{param11}: Número do logradouro do Lead. (Opcional.Tipo do Dado: Texto.)
{param12}: Complemento do logradouro do Lead. (Opcional.Tipo do Dado: Texto.)
{param13}: Bairro do logradouro do Lead. (Opcional.Tipo do Dado: Texto.)
{param14}: Indica se é o endereço padrão do Lead. (Opcional.Tipo do Dado: Booleano.)
{param15}: Referencia do logradouro do Lead. (Opcional.Tipo do Dado: Texto.)
{param16}: Tipo de logradouro do Lead. Caso não informado o sistema utiliza o tipo padrão \"Rua\". (Opcional. Opções: 1 - Rua, 2 - Avenida, 3 - Travessa, 4 - Alameda, 5 - Estrada, 6 - Rodovia, 7 - PSG, 8 - Quadra. Tipo do Dado: Inteiro.)
{param17}: Sigla do Estado do logradouro do Lead. (Obrigatório.Tipo do Dado: Texto.)
{param18}: Cidade do logradouro do Lead. (Obrigatório.Tipo do Dado: Texto.)
{param19}: Array de Objetos com os dados de contatos do Lead. (Opcional. Tipo do Dado: Array de Objetos.)
{param20}: Nome do Contato do Lead. (Obrigatório. Tipo do Dado: Texto.)
{param21}: E-mail do Contato do Lead. (Opcional. Tipo do Dado: Texto.)
{param22}: Telefone do Contato do Lead. (Opcional. Tipo do Dado: Texto.)
{param23}: Celular do Contato do Lead. (Opcional. Tipo do Dado: Texto.)
{param24}: Fax do Contato do Lead. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Retorna o Id da Pessoa (Lead) cadastrada no BomControle. (Tipo do Dado: Inteiro.)

\n","urlObject":{"protocol":"https","path":["integracao","Lead","Criar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"fbb28c0a-cc3e-4be3-a198-8c8813e2dd20","name":"Lead - Criar","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"PessoaJuridica\": {\r\n \"Documento\": \"12345678000123\",\r\n \"NomeFantasia\": \"Teste\",\r\n \"RazaoSocial\": \"Teste\"\r\n },\r\n \"Enderecos\": [\r\n {\r\n \"Cep\": \"09510210\",\r\n \"Logradouro\": \"Niteroi\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": \"3 Andar\",\r\n \"Bairro\": \"Centro\",\r\n \"Padrao\": true,\r\n \"Referencia\": null,\r\n \"TipoLogradouro\": {\r\n \"Id\": 1\r\n },\r\n \"Uf\": \"SP\",\r\n \"Cidade\": \"São Caetano do Sul\"\r\n }\r\n ],\r\n \"Contatos\": [\r\n {\r\n \"Nome\": \"Contato Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": \"1111111111\",\r\n \"Celular\": \"11222222222\",\r\n \"Fax\": \"1133333333\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Lead/Criar"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 27 Jan 2020 19:06:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"3"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"1"}],"_postman_id":"bc82753d-4c57-47fe-a5ad-277cf54f0dbf"},{"name":"Lead - Pesquisar","id":"26234321-620c-47ea-bd12-7eea9608a392","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Lead/Pesquisar","description":"

Realiza a pesquisa de Leads no BomControle.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

nomeLead: O nome ou parte dele para a pesquisa do Lead. (Opcional. Tipo do Dado: Texto.)
documentoLead: O documento (cpf ou cnpj) ou parte dele para a pesquisa do Lead. (Opcional. Tipo do Dado: Texto.)
idOportunidade: Id de uma Oportunidade para obter os dados de Lead pertencente a ela. (Opcional. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um array de objetos com os dados dos Leads:

[\n    {\n    \"TipoPessoa\": {param1},\n    \"Id\": {param2},\n    \"Nome\": {param3},\n    \"NomeFantasia\": {param4},\n    \"Documento\": {param5},\n    \"NumeroOportunidades\": {param6},\n    \"NumeroContatos\": {param7}\n    }\n]\n

Paramêtros

{param1}: Tipo de pessoa do Lead. (Opções: 0 - Pessoa Jurídica, 1 - Pessoa Física. Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Pessoa (Lead). (Tipo do Dado: Inteiro.)
{param3}: Nome do Lead. (Tipo do Dado: Texto.)
{param4}: Nome fantasia do Lead. (Tipo do Dado: Texto.)
{param5}: Documento do Lead. (Tipo do Dado: Texto.)
{param6}: Quantidade de Oportunidades do Lead. (Tipo do Dado: Inteiro.)
{param7}: Quantidade de Contatos do Lead. (Tipo do Dado: Inteiro.)

","urlObject":{"protocol":"https","path":["integracao","Lead","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"ce5d3beb-0c3a-4476-b402-137c788ad68c","name":"Lead - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Lead/Pesquisar?nomeLead=teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Lead","Pesquisar"],"query":[{"key":"nomeLead","value":"teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 27 Jan 2020 19:44:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"26808"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"TipoPessoa\": 0,\r\n \"Id\": 1,\r\n \"Nome\": \"Teste\",\r\n \"NomeFantasia\": null,\r\n \"Documento\": \"12345678000123\",\r\n \"NumeroOportunidades\": 0,\r\n \"NumeroContatos\": 1\r\n }\r\n]"}],"_postman_id":"26234321-620c-47ea-bd12-7eea9608a392"},{"name":"Lead - Obter","id":"12e5da3c-e8f1-4f4f-8cd4-a92543e54934","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Lead/Obter/{id}","description":"

Obtém informações referentes a um Lead específico no BomControle.

Request

O request para essa API é feito informando a identificação da pessoa do Lead a ser pesquisado diretamente na URL.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: O Id BomControle da Pessoa do Lead. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados do Lead:

{\n  \"TipoPessoa\": {param1},\n  \"PessoaJuridica\": {param2} {\n    \"Documento\": {param3},\n    \"NomeFantasia\": {param4},\n    \"RazaoSocial\": {param5}\n  },\n  \"PessoaFisica\": {param6} {\n    \"Documento\": {param7},\n    \"Nome\": {param8}\n  },\n  \"Enderecos\": {param9} [\n    {\n      \"Id\": {param10},\n      \"Cep\": {param11},\n      \"Estado\": {param12},\n      \"NomeEstado\": {param13},\n      \"SiglaEstado\": {param14},\n      \"Logradouro\": {param15},\n      \"Numero\": {param16},\n      \"Complemento\": {param17},\n      \"Bairro\": {param18},\n      \"Padrao\": {param19},\n      \"TipoLogradouro\": {param20},\n      \"NomeTipoLogradouro\": {param21},\n      \"CodigoCidade\": {param22},\n      \"NomeCidade\": {param23},\n      \"CodigoIBGE\": {param24},\n      \"Referencia\": {param25}\n    }\n  ],\n  \"Segmento\": {param26} {\n    \"Id\": {param27},\n    \"Nome\": {param28}\n  },\n  \"Contatos\": {param29} [\n    {\n      \"Id\": {param30},\n      \"Tratamento\": {param31},\n      \"Nome\": {param32},\n      \"Cargo\": {param33},\n      \"Email\": {param34},\n      \"Telefone\": {param35},\n      \"Celular\": {param36}\n    }\n  ],\n  \"Oportunidades\": {param37} [\n    {\n      \"Id\": {param38},\n      \"Descricao\": {param39},\n      \"Valor\": {param40},\n      \"IdEtapa\": {param41},\n      \"NomeEtapa\": {param42},\n      \"TemperaturaDaOportunidade\": {param43},\n      \"NomeTemperaturaDaOportunidade\": {param44},\n      \"LoginUsuario\": {param45},\n      \"Status\": {param46},\n      \"DescricaoStatus\": {param47},\n      \"NomeStatus\": {param48}\n    }\n  ],\n  \"Atividades\": {param49} [\n    {\n      \"Id\": {param50},\n      \"Descricao\": {param51},\n      \"IdTipoAtividade\": {param52},\n      \"NomeTipoAtividade\": {param53},\n      \"IconeTipoAtividade\": {param54},\n      \"Realizada\": {param55},\n      \"LoginUsuario\": {param56},\n      \"NomeUsuario\": {param57},\n      \"LinkFotoPerfil\": {param58},\n      \"DataInicio\": {param59},\n      \"DataTermino\": {param60},\n      \"DataCriacao\": {param61}\n    }\n  ]\n}\n

Paramêtros

{param1}: Tipo de Pessoa do Lead. (Opções: 0 - Pessoa Jurídica, 1 - Pessoa Física. Tipo do Dado: Inteiro.)
{param2}: Objeto com os dados do Lead caso ele seja do TipoPessoa Jurídica. Nullo caso seja TipoPessoa Física. (Tipo do Dado: Objeto.)\n
{param3}: Cnpj do Lead. (Tipo do Dado: Texto.)
{param4}: Nome Fantasia do Lead. (Tipo do Dado: Texto.)
{param5}: Razão Social do Lead. (Tipo do Dado: Texto.)
{param6}: Objeto com os dados do Lead caso ele seja do TipoPessoa Física. Nullo caso seja TipoPessoa Jurídica. (Tipo do Dado: Objeto.)\n
{param7}: Cpf do Lead. (Tipo do Dado: Texto.)
{param8}: Nome do Lead. (Tipo do Dado: Texto.)
{param9}: Array de Objetos contendo os endereços do Lead. (Tipo do Dado: Array de Objetos.)
{param10}: Id BomControle do endereço do Lead. (Tipo do Dado: Inteiro.)
{param11}: Cep do Lead. (Tipo do Dado: Texto.)
{param12}: Id do Estado no BomControle. (Tipo do Dado: Inteiro.)
{param13}: Nome extenso do Estado do Lead. (Tipo do Dado: Texto.)
{param14}: Sigla do Estado do Lead. (Tipo do Dado: Texto.)
{param15}: Logradouro do Lead. (Tipo do Dado: Texto.)
{param16}: Número do endereço do Lead. (Tipo do Dado: Texto.)
{param17}: Complemento do endereço do Lead. (Tipo do Dado: Texto.)
{param18}: Bairro do endereço do Lead. (Tipo do Dado: Texto.)
{param19}: Indica se endereço do Lead é o principal. (Tipo do Dado: Booleano.)
{param20}: Tipo de logradouro do Lead. (Opções: 1 - Rua, 2 - Avenida, 3 - Travessa, 4 - Alameda, 5 - Estrada, 6 - Rodovia, 7 - PSG, 8 - Quadra. Tipo do Dado: Inteiro.)
{param21}: Nome do tipo de logradouro do Lead. (Tipo do Dado: Texto.)
{param22}: Id da Cidade no BomControle. (Tipo do Dado: Inteiro.)
{param23}: Nome da cidade do Lead. (Tipo do Dado: Texto.)
{param24}: Código Ibge da cidade do Lead. (Tipo do Dado: Texto.)
{param25}: Referência do endereço do Lead. (Tipo do Dado: Texto.)
{param26}: Objeto contendo os dados de segmento empresarial do Lead. (Tipo do Dado: Objeto.)
{param27}: Id do segmento empresarial do Lead no BomControle. (Tipo do Dado: Inteiro.)
{param28}: Nome do segmento empresarial do Lead. (Tipo do Dado: Texto.)
{param29}: Array de Objetos contendo os contatos do Lead. (Tipo do Dado: Array de Objetos.)
{param30}: Id do contato do Lead no BomControle. (Tipo do Dado: Inteiro.)
{param31}: Tratamento do contato do Lead. (Tipo do Dado: Texto.)
{param32}: Nome do contato do Lead. (Tipo do Dado: Texto.)
{param33}: Cargo do contato do Lead. (Tipo do Dado: Texto.)
{param34}: E-mail do contato do Lead. (Tipo do Dado: Texto.)
{param35}: Telefone do contato do Lead. (Tipo do Dado: Texto.)
{param36}: Celular do contato do Lead. (Tipo do Dado: Texto.)
{param37}: Array de Objetos contendo informações das Oportunidade associadas ao Lead. (Tipo do Dado: Array de Objetos.)
{param38}: Id da Oportunidade do Lead no BomControle. (Tipo do Dado: Inteiro.)
{param39}: Descrição da Oportunidade. (Tipo do Dado: Texto.)
{param40}: Valor da Oportunidade. (Tipo do Dado: Decimal.)
{param41}: Id da Etapa da Oportunidade no BomControle. (Tipo do Dado: Inteiro.)
{param42}: Nome da Etapa da Oportunidade. (Tipo do Dado: Texto.)
{param43}: Id da Temperatura da Oportunidade no BomControle. (Opções: 0 - Congelado, 1 - Morno, 2 - Quente, 3 - Muito quente. Tipo do Dado: Inteiro.)
{param44}: Nome da Temperatura da Oportunidade. (Tipo do Dado: Texto.)
{param45}: Login do usuário vendedor da Oportunidade no BomControle. (Tipo do Dado: Texto.)
{param46}: Id do Status da Oportunidade no BomControle. (Opções: 0 - Aberto, 1 - Ganhou, 2 - Perdeu. Tipo do Dado: Inteiro.)
{param47}: Nome do Status da Oportunidade. (Tipo do Dado: Texto.)
{param48}: Nome do Status da Oportunidade. (Tipo do Dado: Texto.)
{param49}: Array de Objetos contendo informações das Atividades associadas ao Lead. (Tipo do Dado: Array de Objetos.)
{param50}: Id da Atividade do Lead no BomControle. (Tipo do Dado: Inteiro.)
{param51}: Descrição da Atividade. (Tipo do Dado: Texto.)
{param52}: Id do Tipo da Atividade no BomControle. (Tipo do Dado: Inteiro.)
{param53}: Nome do Tipo da Atividade. (Tipo do Dado: Texto.)
{param54}: Icone do Tipo da Atividade. (Tipo do Dado: Texto.)
{param55}: Indica se a Atividade foi realizada. (Tipo do Dado: Booleano.)
{param56}: Login do Usuário responsável pela Atividade no BomControle. (Tipo do Dado: Texto.)
{param57}: Nome do Usuário responsável pela Atividade no BomControle. (Tipo do Dado: Texto.)
{param58}: Url com a Foto do Usuário responsável pela Atividade no BomControle. (Tipo do Dado: Texto.)
{param59}: Data de Inicio da Atividade. (Tipo do Dado: Texto.)
{param60}: Não utilizado. (Tipo do Dado: Texto.)
{param61}: Data de Criação da Atividade. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Lead","Obter","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"d8b53ff2-ad51-45c3-b2ff-88625717189b","name":"Lead - Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Lead/Obter/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Mon, 27 Jan 2020 20:06:55 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"24846"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"TipoPessoa\": 0,\r\n \"PessoaJuridica\": {\r\n \"Documento\": \"12345678000123\",\r\n \"NomeFantasia\": \"Teste\",\r\n \"RazaoSocial\": \"Teste\"\r\n },\r\n \"PessoaFisica\": null,\r\n \"Enderecos\": [\r\n {\r\n \"Id\": 1,\r\n \"Cep\": \"09510210\",\r\n \"Estado\": 25,\r\n \"NomeEstado\": \"São Paulo\",\r\n \"SiglaEstado\": null,\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Padrao\": false,\r\n \"TipoLogradouro\": 1,\r\n \"NomeTipoLogradouro\": \"Rua\",\r\n \"CodigoCidade\": 16356,\r\n \"NomeCidade\": \"São Caetano do Sul\",\r\n \"CodigoIBGE\": \"3550308\",\r\n \"Referencia\": null\r\n }\r\n ],\r\n \"Segmento\": null,\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"Tratamento\": \"Sr.\",\r\n\t \"Nome\": \"Teste\",\r\n\t \"Cargo\": null,\r\n\t \"Email\": \"teste@teste.com.br\",\r\n\t \"Telefone\": \"1111111111\",\r\n\t \"Celular\": \"11222222222\"\r\n }\r\n ],\r\n \"Oportunidades\": [\r\n {\r\n \"Id\": 1,\r\n \"Descricao\": \"Oportunidade Teste\",\r\n \"Valor\": 1.00000,\r\n \"IdEtapa\": 1,\r\n \"NomeEtapa\": \"Etapa Teste\",\r\n \"TemperaturaDaOportunidade\": 0,\r\n \"NomeTemperaturaDaOportunidade\": \"Congelado\",\r\n \"LoginUsuario\": \"teste@bomcontrole.com.br\",\r\n \"Status\": 0,\r\n \"DescricaoStatus\": \"Aberto\",\r\n \"NomeStatus\": \"Aberto\"\r\n }\r\n ],\r\n \"Atividades\": [\r\n {\r\n \"Id\": 1,\r\n \"Descricao\": \"Conferência Online com Fornecedor Teste... dia 01/01/2020 10:00\",\r\n\t \"IdTipoAtividade\": 1,\r\n\t \"NomeTipoAtividade\": \"Teste\",\r\n\t \"IconeTipoAtividade\": null, \r\n\t \"Realizada\": true,\r\n \"LoginUsuario\": \"teste@bomcontrole.com.br\",\r\n \"NomeUsuario\": null,\r\n \"LinkFotoPerfil\": null,\r\n \"DataInicio\": \"2020-01-01T00:00:00.000Z\",\r\n\t \"DataTermino\": \"2020-01-01T00:00:00.000Z\",\r\n\t \"DataCriacao\": \"2020-01-01T00:00:00.000Z\"\r\n }\r\n ]\r\n}"}],"_postman_id":"12e5da3c-e8f1-4f4f-8cd4-a92543e54934"}],"id":"58f5eb8f-4618-4b1a-830e-e61a07a68747","description":"

APIs para manipulação de Leads do BomControle.

\n","event":[{"listen":"prerequest","script":{"id":"b7bd3be5-3094-4527-b65d-5426abbccebe","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2b086762-8607-4305-adba-f15de805f732","type":"text/javascript","exec":[""]}}],"_postman_id":"58f5eb8f-4618-4b1a-830e-e61a07a68747"},{"name":"Oportunidade","item":[{"name":"Oportunidade - Criar","id":"4e168d19-04a8-4b7c-995a-c8400bcc2371","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Oportunidade/CriarOportunidade","description":"

Realiza o cadastro da Oportunidade no BomControle.

Request

Os dados enviados para a API devem ser informados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Body

{\n  \"TituloOportunidade\": {param1},\n  \"ValorOportunidade\": {param2},\n  \"NomeLead\": {param3},\n  \"DocumentoLead\": {param4},\n  \"TipoPessoa\": {param5},\n  \"CEP\": {param6},\n  \"Cidade\": {param7},\n  \"Estado\": {param8},\n  \"Bairro\": {param9},\n  \"Logradouro\": {param10},\n  \"Complemento\": {param11},\n  \"NumeroLogradouro\": {param12},\n  \"Campos\": {param13}\n  [\n      {\n         \"IdCampoFormulario\": {param14},\n         \"IdConteudo\": {param15},\n         \"Conteudo\": {param16}\n      }\n  ]\n}\n\n

Paramêtros

{param1}: Nome da Oportunidade. (Obrigatório. Tipo do Dado: Texto.)
{param2}: Valor da Oportunidade. (Opcional. Tipo do Dado: Decimal.)
{param3}: Nome do Lead da Oportunidade. (Obrigatório. Tipo do Dado: Texto.)
{param4}: Documento (cpf ou cnpj) do Lead da Oportunidade. (Obrigatório. Tipo do Dado: Texto.)
{param5}: Tipo da Pessoa (Informar \"0\" (Pessoa Jurídica) ou \"1\" (Pessoa Física)) do Lead da Oportunidade. (Obrigatório. Tipo do Dado: Texto.)
{param6}: Cep do Endereço do Lead da Oportunidade. Informe apenas se for cadastrar um novo endereço. (Opcional. Tipo do Dado: Texto.)
{param7}: Cidade do Endereço do Lead da Oportunidade. Informe apenas se for cadastrar um novo endereço. (Opcional. Tipo do Dado: Texto.)
{param8}: Estado do Endereço do Lead da Oportunidade. Informe apenas se for cadastrar um novo endereço. (Opcional. Tipo do Dado: Texto.)
{param9}: Bairro do Endereço do Lead da Oportunidade. Informe apenas se for cadastrar um novo endereço. (Opcional. Tipo do Dado: Texto.)
{param10}: Logradouro do Endereço do Lead da Oportunidade. Informe apenas se for cadastrar um novo endereço. (Opcional. Tipo do Dado: Texto.)
{param11}: Complemento do Endereço do Lead da Oportunidade. Informe apenas se for cadastrar um novo endereço. (Opcional. Tipo do Dado: Texto.)
{param12}: Número do Endereço do Lead da Oportunidade. Informe apenas se for cadastrar um novo endereço. (Opcional. Tipo do Dado: Texto.)
{param13}: Array de Objetos para preencher campos personalizados na criação da oportunidade. (Opcional. Tipo do Dado: Array de Objeto.)
{param14}: Preencher com o Id do Campo que deseja informar. (Opcional. Tipo do Dado: Inteiro.)
{param15}: Preencher com o Id do conteudo quando o campo for do tipo \"entidade\" ou \"lista\". (Opcional. Tipo do Dado: Inteiro.)
{param16}: Preencher com o Texto Desejado para preencher o campo. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Retorna o Id da Oportunidade cadastrada no BomControle. (Tipo do Dado: Inteiro.)

\n","urlObject":{"protocol":"https","path":["integracao","Oportunidade","CriarOportunidade"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"006f1508-8240-484a-a454-fa4756f71663","name":"Oportunidade - Criar Oportunidade","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"TituloOportunidade\": \"Oportunidade Teste\",\r\n \"ValorOportunidade\": 10,\r\n \"NomeLead\": \"Teste\",\r\n \"DocumentoLead\": \"64332848000109\",\r\n \"CEP\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Estado\": \"São Paulo\",\r\n \"Bairro\": \"Centro\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Complemento\": null,\r\n \"NumeroLogradouro\": \"265\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Oportunidade/CriarOportunidade"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 29 Jan 2020 15:31:05 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"1"},{"id":"9bad32d4-46c9-4dd8-a626-f96b7161f3d0","name":"Oportunidade - Criar Oportunidade","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"TituloOportunidade\": \"Oportunidade Teste\",\r\n \"ValorOportunidade\": 10,\r\n \"NomeLead\": \"Teste\",\r\n \"DocumentoLead\": \"12345678000123\",\r\n \"CEP\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Estado\": \"São Paulo\",\r\n \"Bairro\": \"Centro\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Complemento\": null,\r\n \"NumeroLogradouro\": \"265\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Oportunidade/CriarOportunidade"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 29 Jan 2020 15:31:05 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"54"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"1"}],"_postman_id":"4e168d19-04a8-4b7c-995a-c8400bcc2371"},{"name":"Oportunidade - Obter","id":"d8e41326-7010-47fe-b57a-4bbd28bfcbb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Oportunidade/ObterOportunidade","description":"

Realiza a pesquisa da Oportunidade no BomControle.

Request

O request para essa API é feito através de Querystring usando o paramêtro informado abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

idOportunidade: Id da Oportunidade no BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados da Oportunidade:

{\n    \"Id\": {param1},\n    \"Descricao\": {param2},\n    \"Valor\": {param3},\n    \"IdEtapa\": {param4},\n    \"NomeEtapa\": {param5},\n    \"TemperaturaDaOportunidade\": {param6},\n    \"NomeTemperaturaDaOportunidade\": {param7},\n    \"LoginUsuario\": {param8},\n    \"Status\": {param9},\n    \"DescricaoStatus\": {param10},\n    \"Titulo\": {param11},\n    \"IdLead\": {param12},\n    \"NomeLead\": {param13},\n    \"ValorTotalServicos\": {param14},\n    \"ValorTotalProdutos\": {param15},\n    \"IdVendedor\": {param16},\n    \"IdUsuarioVendedor\": {param17},\n    \"NomeVendedor\": {param18},\n    \"LinkImagemVendedor\": {param19},\n    \"IdOrigemOportunidade\": {param20},\n    \"NomeOrigemOportunidade\": {param21},\n    \"IdFunil\": {param22},\n    \"NomeFunil\": {param23},\n    \"DataPrevista\": {param24},\n    \"IdEmpresa\": {param25},\n    \"NomeEmpresa\": {param26},\n    \"NomeStatus\": {param27},\n    \"Observacao\": {param28},\n    \"DataUltimaTrocaEtapa\": {param29},\n    \"DataCriacao\": {param30},\n    \"Campanhas\": {param31} [\n        {\n          \"IdCampanha\": {param32},\n          \"IdOportunidade\": {param33},\n          \"IdOportunidadeCampanha\": {param34},\n          \"Nome\": {param35},\n          \"DataInicio\": {param36},\n          \"DataFinal\": {param37}\n        }\n    ],\n    \"Agenda\": {param38} [\n        {\n          \"Id\": {param39},\n          \"Descricao\": {param40},\n          \"IdTipoAtividade\": {param41},\n          \"NomeTipoAtividade\": {param42},\n          \"IconeTipoAtividade\": {param43},\n          \"Realizada\": {param44},\n          \"LoginUsuario\": {param45},\n          \"NomeUsuario\": {param46},\n          \"LinkFotoPerfil\": {param47},\n          \"DataInicio\": {param48},\n          \"DataTermino\": {param49},\n          \"DataCriacao\": {param50}\n        }\n    ],\n    \"Notas\": {param51} [\n        {\n          \"Id\": {param52},\n          \"Comentario\": {param53},\n          \"DataCriacao\": {param54},\n          \"NomeUsuario\": {param55},\n          \"LinkFotoPerfil\": {param56},\n          \"Excluido\": {param57}\n        }\n    ],\n    \"Propostas\": {param58} [\n        {\n          \"DataEnvio\": {param59},\n          \"Valor\": {param60},\n          \"EmailEnviado\": {param61},\n          \"StatusEmail\": {param62},\n          \"StatusEmailDescricao\": {param63},\n          \"Cancelado\": {param64},\n          \"IdUsuarioCancelamento\": {param65},\n          \"DataCancelamento\": {param66},\n          \"NomeUsuarioCancelamento\": {param67},\n          \"ValorFrete\": {param68},\n          \"NomeUsuarioEnvioProposta\": {param69},\n          \"LinkFotoUsuarioEnvioProposta\": {param70},\n          \"IdArquivo\": {param71},\n          \"IdProposta\": {param72},\n          \"IdVenda\": {param73},\n          \"SubTipoVenda\": {param74},\n          \"Data\": {param75},\n          \"IdTemplate\": {param76},\n          \"NomeTemplate\": {param77},\n          \"Validade\": {param78}\n        }\n    ],\n    \"IdsConcorrentes\": {param79} [0],\n    \"Anexos\": {param80} [\n        {\n          \"Id\": {param81},\n          \"IdArquivo\": {param82},\n          \"Nome\": {param83},\n          \"Link\": {param84},\n          \"Data\": {param85},\n          \"Formato\": {param86},\n          \"NomeUsuario\": {param87},\n          \"LinkFotoPerfil\": {param88}\n        }\n    ],\n    \"Contatos\": {param89} [\n        {\n          \"Id\": {param90},\n          \"Tratamento\": {param91},\n          \"Nome\": {param92},\n          \"Cargo\": {param93},\n          \"Email\": {param94},\n          \"Telefone\": {param95},\n          \"Celular\": {param96}\n        }\n    ],\n    \"Seguidores\": {param97}[\n        {\n          \"Id\": {param98},\n          \"Nome\": {param99},\n          \"LinkImagemSeguidor\": {param100}\n        }\n    ],\n    \"Formulario\": {param101} {\n        \"IdFormulario\": {param102},\n        \"NomeFormulario\": {param103},\n        \"IdFormularioOportunidade\": {param104},\n        \"IdOportunidade\": {param105},\n        \"Grupos\": {param106} [\n              {\n                \"IdGrupo\": {param107},\n                \"NomeGrupo\": {param108},\n                \"IconeGrupo\": {param109},\n                \"Campos\": {param110} [\n                      {\n                        \"Id\": {param111},\n                        \"CodigoTipo\": {param112},\n                        \"NomeTipo\": {param113},\n                        \"CodigoTipoEntidade\": {param114},\n                        \"NomeTipoEntidade\": {param115},\n                        \"Nome\": {param116},\n                        \"IdGrupo\": {param117},\n                        \"NomeGrupo\": {param118},\n                        \"Titulo\": {param119},\n                        \"Descricao\": {param120},\n                        \"PreenchimentoObrigatorio\": {param121},\n                        \"Bloqueado\": {param122},\n                        \"IdConteudo\": {param123},\n                        \"Conteudo\": {param124},\n                        \"Lista\": {param125} [\n                              {\n                                \"Id\": {param126},\n                                \"Valor\": {param127},\n                                \"Padrao\": {param128}\n                              }\n                        ]\n                      }\n                ]\n              }\n        ]\n    },\n    \"NotificacoesEmail\": {param129} [\n            {\n              \"Id\": {param130},\n              \"Prioridade\": {param131},\n              \"Origem\": {param132},\n              \"IdentificadorOrigem\": {param133},\n              \"Nova\": {param134},\n              \"Destinos\": {param135} [\n                    {\n                      \"Id\": {param136},\n                      \"IdUsuario\": {param137},\n                      \"IdPerfil\": {param138},\n                      \"Email\": {param139},\n                      \"Telefone\": {param140}\n                      \"Tipo\": {param141},\n                      \"NomeTipo\": {param142}\n                    }\n              ],\n              \"Anexos\": {param143} [\n                    {\n                      \"Id\": {param144},\n                      \"IdArquivo\": {param145},\n                      \"Nome\": {param146},\n                      \"Link\": {param147},\n                      \"Data\": {param148},\n                      \"Formato\": {param149},\n                      \"NomeUsuario\": {param150},\n                      \"LinkFotoPerfil\": {param151}\n                    }\n              ],\n              \"Mensagens\": {param152} [\n                    {\n                      \"Id\": {param153},\n                      \"Assunto\": {param154},\n                      \"Corpo\": {param155},\n                      \"Status\": {param156},\n                      \"NomeStatus\": {param157},\n                      \"TipoVeiculo\": {param158},\n                      \"IdConfiguracaoSmtp\": {param159},\n                      \"DataEnvio\": {param160},\n                      \"DataCriacao\": {param161},\n                      \"DataLeitura\": {param162},\n                      \"DataRecebimento\": {param163},\n                      \"ResponderPara\": {param164},\n                      \"DescricaoStatus\": {param165},\n                      \"Link\": {param166}\n                    }\n              ],\n              \"IdUsuario\": {param167},\n              \"NomeUsuario\": {param168}\n            }\n    ]\n}\n

Paramêtros

{param1}: Id BomControle da Oportunidade. (Tipo do Dado: Inteiro.)
{param2}: Não utilizado. (Tipo do Dado: Texto.)
{param3}: Valor da Oportunidade. (Tipo do Dado: Decimal.)
{param4}: Id da Etapa da Oportunidade no BomControle. (Tipo do Dado: Inteiro.)
{param5}: Nome da Etapa da Oportunidade. (Tipo do Dado: Texto.)
{param6}: Id da Temperatura da Oportunidade no BomControle. (Opções: 0 - Congelado, 1 - Morno, 2 - Quente, 3 - Muito quente. Tipo do Dado: Inteiro.)
{param7}: Nome da Temperatura da Oportunidade. (Tipo do Dado: Texto.)
{param8}: Não utilizado. (Tipo do Dado: Texto.)
{param9}: Id do Status da Oportunidade no BomControle. (Opções: 0 - Aberto, 1 - Ganhou, 2 - Perdeu. Tipo do Dado: Inteiro.)
{param10}: Nome do Status da Oportunidade. (Tipo do Dado: Texto.)
{param11}: Nome da Oportunidade. (Tipo do Dado: Texto.)
{param12}: Id da Pessoa do Lead da Oportunidade no BomControle. (Tipo do Dado: Inteiro.)
{param13}: Nome do Lead da Oportunidade. (Tipo do Dado: Texto.)
{param14}: Valor total de todas as Propostas de Venda de Serviços da Oportunidade. (Tipo do Dado: Decimal.)
{param15}: Valor total de todas as Propostas de Venda de Produtos da Oportunidade. (Tipo do Dado: Decimal.)
{param16}: Id BomControle do Vendedor da Oportunidade. (Tipo do Dado: Inteiro.)
{param17}: Id BomControle do Usuário Vendedor da Oportunidade. (Tipo do Dado: Inteiro.)
{param18}: Nome do Usuário Vendedor da Oportunidade. (Tipo do Dado: Texto.)
{param19}: Url com a Foto do Perfil do Usuário Vendedor da Oportunidade. (Tipo do Dado: Texto.)
{param20}: Id BomControle da Origem da Oportunidade. (Tipo do Dado: Inteiro.)
{param21}: Nome da Origem da Oportunidade. (Tipo do Dado: Texto.)
{param22}: Id BomControle do Funil de Venda da Oportunidade. (Tipo do Dado: Inteiro.)
{param23}: Nome do Funil de Venda da Oportunidade. (Tipo do Dado: Texto.)
{param24}: Data Prevista da Oportunidade. (Tipo do Dado: Texto.)
{param25}: Id BomControle da Empresa o qual essa Oportunidade pertence. (Tipo do Dado: Inteiro.)
{param26}: Nome da Empresa o qual essa Oportunidade pertence. (Tipo do Dado: Texto.)
{param27}: Nome do Status da Oportunidade. (Tipo do Dado: Texto.)
{param28}: Observação da Oportunidade. (Tipo do Dado: Texto.)
{param29}: Data da última troca de Etapa da Oportunidade. (Tipo do Dado: Texto.)
{param30}: Data de Criação da Oportunidade. (Tipo do Dado: Texto.)
{param31}: Array de Objetos contendo os dados das Campanhas da Oportunidade. (Tipo do Dado: Array de Objetos.)
{param32}: Id BomControle da Campanha. (Tipo do Dado: Inteiro.)
{param33}: Id BomControle da Oportunidade. (Tipo do Dado: Inteiro.)
{param34}: Id BomControle da relação entre Campanha e Oportunidade. (Tipo do Dado: Inteiro.)
{param35}: Nome da Campanha. (Tipo do Dado: Texto.)
{param36}: Data de Inicio da Campanha. (Tipo do Dado: Texto.)
{param37}: Data de Fim da Campanha. (Tipo do Dado: Texto.)
{param38}: Array de Objetos contendo os dados das Agendas da Oportunidade. (Tipo do Dado: Array de Objetos.)
{param39}: Id BomControle da Agenda da Oportunidade. (Tipo do Dado: Inteiro.)
{param40}: Nome da Agenda. (Tipo do Dado: Texto.)
{param41}: Id BomControle do Tipo da Atividade. (Tipo do Dado: Inteiro.)
{param42}: Nome do Tipo da Atividade. (Tipo do Dado: Texto.)
{param43}: Icone do Tipo da Atividade. (Tipo do Dado: Texto.)
{param44}: Indica se a Agenda foi realizada. (Tipo do Dado: Booleano.)
{param45}: Login do Usuário BomControle responsável pela Agenda. (Tipo do Dado: Texto.)
{param46}: Nome do Usuário responsável pela Agenda. (Tipo do Dado: Texto.)
{param47}: Url com a Foto do Perfil do Usuário responsável pela Agenda. (Tipo do Dado: Texto.)
{param48}: Data de Inicio da Agenda. (Tipo do Dado: Texto.)
{param49}: Data de Término da Agenda. (Tipo do Dado: Texto.)
{param50}: Data de Criação da Agenda. (Tipo do Dado: Texto.)
{param51}: Array de Objetos contendo os dados das Notas da Oportunidade. (Tipo do Dado: Array de Objetos.)
{param52}: Id BomControle da Nota da Oportunidade. (Tipo do Dado: Inteiro.)
{param53}: Comentário da Nota. (Tipo do Dado: Texto.)
{param54}: Data de Criação da Nota. (Tipo do Dado: Texto.)
{param55}: Nome do Usuário BomControle criador da Nota. (Tipo do Dado: Texto.)
{param56}: Url com a Foto do Perfil do Usuário criador da Nota. (Tipo do Dado: Texto.)
{param57}: Indica se é uma Nota cancelada. (Tipo do Dado: Booleano.)
{param58}: Array de Objetos contendo as Propostas da Oportunidade. (Tipo do Dado: Array de Objetos.)
{param59}: Data de Envio da Proposta. (Tipo do Dado: Texto.)
{param60}: Valor da Venda associada a Proposta. (Tipo do Dado: Decimal.)
{param61}: Indica se foi feito o envio de e-mail da Venda associada a Proposta. (Tipo do Dado: Booleano.)
{param62}: Id BomControle do Status do E-mail da Proposta. (Opções: 1 - Pendente, 2 - Enviado, 3 - Recebido, 4 - Lido, 5 - ErroEnvio. Tipo do Dado: Inteiro.)
{param63}: Descrição do Status do E-mail da Proposta. (Tipo do Dado: Texto.)
{param64}: Indica se a Venda da Proposta está cancelada. (Tipo do Dado: Booleano.)
{param65}: Id BomControle do Usuário responsável pelo cancelamento da Venda da Proposta. (Tipo do Dado: Inteiro.)
{param66}: Data de cancelamento da Venda da Proposta. (Tipo do Dado: Texto.)
{param67}: Nome do Usuário responsável pelo cancelamento da Venda da Proposta. (Tipo do Dado: Texto.)
{param68}: Valor do Frete da Venda da Proposta. (Tipo do Dado: Decimal.)
{param69}: Nome do Usuário BomControle responsável pelo envio do E-mail da Proposta. (Tipo do Dado: Texto.)
{param70}: Url com a Foto do Perfil do Usuário responsável pelo envio do E-mail da Proposta. (Tipo do Dado: Texto.)
{param71}: Id BomControle do Arquivo da Proposta. (Tipo do Dado: Inteiro.)
{param72}: Id BomControle da Proposta. (Tipo do Dado: Inteiro.)
{param73}: Id BomControle da Venda da Proposta. (Tipo do Dado: Inteiro.)
{param74}: Id BomControle do SubTipo da Venda da Proposta. (Opções: 0 - Produto, 1 - Servico. Tipo do Dado: Inteiro.)
{param75}: Data da Venda da Proposta. (Tipo do Dado: Texto.)
{param76}: Não utilizado. (Tipo do Dado: Inteiro.)
{param77}: Nome do Template usado na Proposta. (Tipo do Dado: Texto.)
{param78}: Data de Validade da Venda da Proposta. (Tipo do Dado: Texto.)
{param79}: Array de Ids BomControle dos Concorrentes da Proposta. (Tipo do Dado: Array de Inteiro.)
{param80}: Array de Objetos contendo os dados dos Anexos da Oportunidade. (Tipo do Dado: Array de Objetos.)
{param81}: Id BomControle do Anexo da Oportunidade. (Tipo do Dado: Inteiro.)
{param82}: Id BomControle do Arquivo do Anexo da Oportunidade. (Tipo do Dado: Inteiro.)
{param83}: Nome do Arquivo do Anexo da Oportunidade. (Tipo do Dado: Texto.)
{param84}: Url do Arquivo do Anexo da Oportunidade. (Tipo do Dado: Texto.)
{param85}: Data de Criação do Anexo da Oportunidade. (Tipo do Dado: Texto.)
{param86}: Formato do Arquivo do Anexo da Oportunidade. (Tipo do Dado: Texto.)
{param87}: Nome do Usuário BomControle responsável pelo envio do Anexo da Oportunidade. (Tipo do Dado: Texto.)
{param88}: Url com a Foto do Perfil do Usuário responsável pelo envio do Anexo da Oportunidade. (Tipo do Dado: Texto.)
{param89}: Array de Objetos contendo os dados dos Contatos Comerciais da Oportunidade. (Tipo do Dado: Array de Objetos.)
{param90}: Id BomControle do Contato da Oportunidade. (Tipo do Dado: Inteiro.)
{param91}: Tratamento do contato do Lead. (Tipo do Dado: Texto.)
{param92}: Nome do contato do Lead. (Tipo do Dado: Texto.)
{param93}: Cargo do contato do Lead. (Tipo do Dado: Texto.)
{param94}: E-mail do contato do Lead. (Tipo do Dado: Texto.)
{param95}: Telefone do contato do Lead. (Tipo do Dado: Texto.)
{param96}: Celular do contato do Lead. (Tipo do Dado: Texto.)
{param97}: Array de Objetos contendo os dados dos Seguidores da Oportunidade. (Tipo do Dado: Array de Objetos.)
{param98}: Id BomControle do Seguidor da Oportunidade. (Tipo do Dado: Inteiro.)
{param99}: Nome do Seguidor da Oportunidade. (Tipo do Dado: Texto.)
{param100}: Url com a Foto do Perfil do Seguidor da Oportunidade. (Tipo do Dado: Texto.)
{param101}: Objeto contendo os dados de Fomulário da Oportunidade. (Tipo do Dado: Objeto.)
{param102}: Id BomControle do Fomulário. (Tipo do Dado: Inteiro.)
{param103}: Nome do Fomulário. (Tipo do Dado: Texto.)
{param104}: Id BomControle da relação entre Fomulário e Oportunidade. (Tipo do Dado: Inteiro.)
{param105}: Id BomControle da Oportunidade. (Tipo do Dado: Inteiro.)
{param106}: Array de Objetos contendo os dados dos Grupos do Formulário. (Tipo do Dado: Array de Objetos.)
{param107}: Id BomControle do Grupo do Fomulário. (Tipo do Dado: Inteiro.)
{param108}: Nome do Grupo do Fomulário. (Tipo do Dado: Texto.)
{param109}: Ícone do Grupo do Fomulário. (Tipo do Dado: Texto.)
{param110}: Array de Objetos contendo os dados dos Campos do Grupo do Formulário. (Tipo do Dado: Array de Objetos.)
{param111}: Id BomControle do Campo do Grupo do Formulário. (Tipo do Dado: Inteiro.)
{param112}: Id BomControle do Tipo do Campo. (Opções: 1 - Texto, 2 - TextoMultilinha, 3 - Numerico, 4 - Data, 5 - Boleano, 6 - Lista, 7 - Entidade. Tipo do Dado: Inteiro.)
{param113}: Nome do Tipo do Campo. (Tipo do Dado: Texto.)
{param114}: Id BomControle do Tipo de Entidade do Campo. (Opções: 1 - Cliente, 2 - Fornecedor, 3 - Produto, 4 - Oportunidade, 5 - Departamento, 6 - Funcionario. Tipo do Dado: Inteiro.)
{param115}: Nome do Tipo de Entidade do Campo. (Tipo do Dado: Texto.)
{param116}: Nome do Campo. (Tipo do Dado: Texto.)
{param117}: Id BomControle do Grupo do Campo. (Tipo do Dado: Inteiro.)
{param118}: Nome do Grupo do Campo. (Tipo do Dado: Texto.)
{param119}: Titulo do Campo. (Tipo do Dado: Texto.)
{param120}: Descrição do Campo. (Tipo do Dado: Texto.)
{param121}: Indica se o Campo é obrigatório. (Tipo do Dado: Booleano.)
{param122}: Indica se o Campo esta bloqueado. (Tipo do Dado: Booleano.)
{param123}: Id BomControle do Conteudo do Campo. (Tipo do Dado: Inteiro.)
{param124}: Nome do Conteudo do Campo. (Tipo do Dado: Texto.)
{param125}: Array de Objetos contendo as Lista do Campo. (Tipo do Dado: Array de Objetos.)
{param126}: Id BomControle da Lista do Campo. (Tipo do Dado: Inteiro.)
{param127}: Valor da Lista do Campo. (Tipo do Dado: Texto.)
{param128}: Indica se é o item principal da Lista. (Tipo do Dado: Booleano.)
{param129}: Array de Objetos contendo os dados E-mails (Notificação) da Oportunidade. (Tipo do Dado: Array de Objetos.)
{param130}: Id BomControle da Notificação da Oportunidade. (Tipo do Dado: Inteiro.)
{param131}: Id BomControle da Prioridade da Notificação. (Opções: 10 - Normal, 50 - Urgente. Tipo do Dado: Inteiro.)
{param132}: Id BomControle da Origem da Notificação. (Opções: 1 - Relatorio, 2 - RecuperacaoSenha, 3 - ImportacaoLead, 4 - ConviteUsuario, 5 - NotificacaoTicket, 6 - NotificacaoInstanciaProcessoNegocio, 7 - NotificacaoDiariaDespesasReceitas, 8 - PropostaComercial, 9 - NovaAssinatura, 10 - AvisoDeCobranca, 11 - SugestaoDeUsuario, 12 - NotificacaoFaturamento, 13 - CotacaoProcessoCompra, 14 - Venda, 15 - NotificacaoDiariaAtividadeOportunidade, 16 - ImportacaoExtratoAutomatico, 17 - NotaFiscalVenda, 18 - BloqueioCliente, 19 - CancelamentoCliente, 20 - AtivacaoCliente, 21 - ExportacaoXmlNotasFiscaisProduto, 22 - ImportacaoNotaFiscalProduto, 23 - LimpezaBaseClienteBomControle, 24 - CadastroClienteBomControle, 25 - EmailOportunidade, 26 - ImportacaoFornecedor, 27 - ImportacaoCliente, 28 - ImportacaoProduto, 29 - ImportacaoContaAzulMovimentacaoFinanceira, 30 - ImportacaoContaAzulPessoas, 31 - ImportacaoContaAzulProdutos, 32 - ImportacaoContaAzulTabelaIBPT, 33 - AtualizacaoCotacaoExterna, 34 - AvisoDeVencimento, 35 - OrdemServico, 36 - ImportacaoContaContabil, 37 - SincronizacaoClienteMilvus. Tipo do Dado: Inteiro.)
{param133}: Nome da Origem da Notificação. (Tipo do Dado: Texto.)
{param134}: Indica se é uma Notificação nova. (Tipo do Dado: Booleano.)
{param135}: Array de Objetos contendo os Destinos da Notificação. (Tipo do Dado: Array de Objetos.)
{param136}: Id BomControle do Destino da Notificação. (Tipo do Dado: Inteiro.)
{param137}: Não utilizado. (Tipo do Dado: Inteiro.)
{param138}: Não utilizado. (Tipo do Dado: Inteiro.)
{param139}: Endereço de E-mail do Destino. (Tipo do Dado: Texto.)
{param140}: Telefone do Destino. (Tipo do Dado: Texto.)
{param141}: Não utilizado. (Tipo do Dado: Inteiro.)
{param142}: Não utilizado. (Tipo do Dado: Texto.)
{param143}: Array de Objetos contendo os Anexos da Notificação. (Tipo do Dado: Array de Objetos.)
{param144}: Id BomControle do Anexo da Notificação. (Tipo do Dado: Inteiro.)
{param145}: Id BomControle do Arquivo do Anexo da Notificação. (Tipo do Dado: Inteiro.)
{param146}: Não utilizado. (Tipo do Dado: Texto.)
{param147}: Url do Anexo. (Tipo do Dado: Texto.)
{param148}: Não utilizado. (Tipo do Dado: Texto.)
{param149}: Não utilizado. (Tipo do Dado: Texto.)
{param150}: Não utilizado. (Tipo do Dado: Texto.)
{param151}: Não utilizado. (Tipo do Dado: Texto.)
{param152}: Array de Objetos contendo as Mensagens da Notificação. (Tipo do Dado: Array de Objetos.)
{param153}: Id BomControle da Mensagem da Notificação. (Tipo do Dado: Inteiro.)
{param154}: Assunto da Mensagem. (Tipo do Dado: Texto.)
{param155}: Corpo da Mensagem. (Tipo do Dado: Texto.)
{param156}: Id BomControle do Status da Mensagem. (Opções: 1 - Pendente, 2 - Enviado, 3 - Recebido, 4 - Lido, 5 - ErroEnvio. Tipo do Dado: Inteiro.)
{param157}: Nome do Status da Mensagem. (Tipo do Dado: Texto.)
{param158}: Id BomControle do Tipo de Veículo da Mensagem. (Opções: 1 - Email, 2 - SMS, 3 - Tela. Tipo do Dado: Inteiro.)
{param159}: Não utilizado. (Tipo do Dado: Texto.)
{param160}: Data de Envio da Mensagem. (Tipo do Dado: Texto.)
{param161}: Data de Criação da Mensagem. (Tipo do Dado: Texto.)
{param162}: Data de Leitura da Mensagem. (Tipo do Dado: Texto.)
{param163}: Data de Recebimento da Mensagem. (Tipo do Dado: Texto.)
{param164}: Responder Para da Mensagem. (Tipo do Dado: Texto.)
{param165}: Descrição do Status da Mensagem. (Tipo do Dado: Texto.)
{param166}: Não utilizado. (Tipo do Dado: Texto.)
{param167}: Id BomControle do Usuário de Criação da Notificação. (Tipo do Dado: Inteiro.)
{param168}: Nome do Usuário de Criação da Notificação. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Oportunidade","ObterOportunidade"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"70763c8c-815a-4ae9-94ac-6a538fc097ce","name":"Oportunidade - Obter Oportunidade","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Oportunidade/ObterOportunidade?idOportunidade=1","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Oportunidade","ObterOportunidade"],"query":[{"key":"idOportunidade","value":"1"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 29 Jan 2020 15:53:09 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"7727"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"Descricao\": null,\r\n \"Valor\": 1.00000,\r\n \"IdEtapa\": 1,\r\n \"NomeEtapa\": \"Cliente em potencial\",\r\n \"TemperaturaDaOportunidade\": 0,\r\n \"NomeTemperaturaDaOportunidade\": \"Congelado\",\r\n \"LoginUsuario\": null,\r\n \"Status\": 0,\r\n \"DescricaoStatus\": \"Aberto\",\r\n \"Titulo\": \"Oportunidade Teste\",\r\n \"IdLead\": 1,\r\n \"NomeLead\": \"Lead Teste\",\r\n \"ValorTotalServicos\": 0.0,\r\n \"ValorTotalProdutos\": 1.00000,\r\n \"IdVendedor\": 1,\r\n \"IdUsuarioVendedor\": 1,\r\n \"NomeVendedor\": \"Teste\",\r\n \"LinkImagemVendedor\": \"https://bom-controle-arquivos.s3-sa-east-1.amazonaws.com/1/usuario/img_foto_usuario_a35781e9-7fcf-41a3-816c-2ea861a95903.jpg\",\r\n \"IdOrigemOportunidade\": 4,\r\n \"NomeOrigemOportunidade\": \"Prospect\",\r\n \"IdFunil\": 1,\r\n \"NomeFunil\": \"Funil Padrão\",\r\n \"DataPrevista\": \"2020-01-01T00:00:00.00\",\r\n \"IdEmpresa\": 1,\r\n \"NomeEmpresa\": \"Empresa Teste\",\r\n \"NomeStatus\": \"Aberto\",\r\n \"Observacao\": null,\r\n \"DataUltimaTrocaEtapa\": \"2020-01-01T00:00:00.000\",\r\n \"DataCriacao\": \"2020-01-01T00:00:00.000\",\r\n \"Campanhas\": [],\r\n \"Agenda\": [],\r\n \"Notas\": [\r\n {\r\n \"Id\": 1,\r\n \"Comentario\": \"Teste\",\r\n \"DataCriacao\": \"2020-01-01T09:55:17.72\",\r\n \"NomeUsuario\": \"Teste\",\r\n \"LinkFotoPerfil\": \"https://bom-controle-arquivos.s3-sa-east-1.amazonaws.com/1/usuario/img_foto_usuario_a35781e9-7fcf-41a3-816c-2ea861a95903.jpg\",\r\n \"Excluido\": false\r\n }\r\n ],\r\n \"Propostas\": [\r\n {\r\n \"DataEnvio\": \"2020-01-01T10:17:07.697\",\r\n \"Valor\": 1.00000,\r\n \"EmailEnviado\": true,\r\n \"StatusEmail\": 5,\r\n \"StatusEmailDescricao\": \"ErroEnvio\",\r\n \"Cancelado\": false,\r\n \"IdUsuarioCancelamento\": 0,\r\n \"DataCancelamento\": null,\r\n \"NomeUsuarioCancelamento\": null,\r\n \"ValorFrete\": 0.00000,\r\n \"NomeUsuarioEnvioProposta\": \"Testes\",\r\n \"LinkFotoUsuarioEnvioProposta\": \"https://bom-controle-arquivos.s3-sa-east-1.amazonaws.com/1/usuario/img_foto_usuario_a35781e9-7fcf-41a3-816c-2ea861a95903.jpg\",\r\n \"IdArquivo\": 1,\r\n \"IdProposta\": 1,\r\n \"IdVenda\": 1,\r\n \"SubTipoVenda\": 0,\r\n \"Data\": \"2020-01-01T10:17:01\",\r\n \"IdTemplate\": 0,\r\n \"NomeTemplate\": \"PropostaComercialProduto\",\r\n \"Validade\": \"2020-01-01T10:16:55.6445388\"\r\n }\r\n ],\r\n \"IdsConcorrentes\": [],\r\n \"Anexos\": [],\r\n \"Contatos\": [],\r\n \"Seguidores\": [],\r\n \"Formulario\": {\r\n \"IdFormulario\": 1,\r\n \"NomeFormulario\": \"Formulário de Oportunidade\",\r\n \"IdFormularioOportunidade\": 1,\r\n \"IdOportunidade\": 0,\r\n \"Grupos\": [\r\n {\r\n \"IdGrupo\": 1,\r\n \"NomeGrupo\": \"Grupo Teste\",\r\n \"IconeGrupo\": null,\r\n \"Campos\": [\r\n {\r\n \"Id\": 1,\r\n \"CodigoTipo\": 1,\r\n \"NomeTipo\": \"Texto\",\r\n \"CodigoTipoEntidade\": 0,\r\n \"NomeTipoEntidade\": null,\r\n \"Nome\": \"Teste\",\r\n \"IdGrupo\": 0,\r\n \"NomeGrupo\": null,\r\n \"Titulo\": \"Teste\",\r\n \"Descricao\": \"Teste\",\r\n \"PreenchimentoObrigatorio\": true,\r\n \"Bloqueado\": false,\r\n \"IdConteudo\": 0,\r\n \"Conteudo\": \"Teste\",\r\n \"Lista\": []\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n \"NotificacoesEmail\": []\r\n}"}],"_postman_id":"d8e41326-7010-47fe-b57a-4bbd28bfcbb5"},{"name":"Oportunidade - Pesquisar","id":"05554c22-f49d-46e3-bab6-2f54ae42a2e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Oportunidade/Pesquisar","description":"

Pesquisa de Oportunidades conforme as condições informadas nos filtros.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{documentoLead}: Parte do documento (cpf ou cnpj) dos Leads das Oportunidades a serem pesquisadas. (Obrigatório. Tipo do Dado: Texto.)
{nomeLead}: Parte do nome dos Leads das Oportunidades a serem pesquisadas. (Obrigatório. Tipo do Dado: Texto.)
{tituloOportunidade}: Parte do nome das Oportunidades a serem pesquisadas. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Retorna um arrays de objetos com os dados das Oportunidades.

[\n  {\n    \"Id\": {param1},\n    \"Titulo\": {param2},\n    \"IdLead\": {param3},\n    \"NomeLead\": {param4},\n    \"DocumentoLead\": {param5},\n    \"IdUsuarioResposavel\": {param6},\n    \"LoginUsuario\": {param7},\n    \"Status\": {param8},\n    \"TemperaturaDaOportunidade\": {param9},\n    \"NomeTemperaturaDaOportunidade\": {param10},\n    \"Valor\": {param11},\n    \"IdEtapa\": {param12},\n    \"NomeEtapa\": {param13}\n  }\n]\n

Paramêtros

{param1}: Id BomControle da Oportunidade. (Tipo do Dado: Inteiro.)
{param2}: Nome da Oportunidade. (Tipo do Dado: Texto.)
{param3}: Id BomControle da Pessoa (Lead). (Tipo do Dado: Inteiro.)
{param4}: Nome da Pessoa (Lead). (Tipo do Dado: Texto.)
{param5}: Documento da Pessoa (Lead). (Tipo do Dado: Texto.)
{param6}: Id BomControle do Usuário Vendedor da Oportunidade. (Tipo do Dado: Inteiro.)
{param7}: Login do Usuário Vendedor da Oportunidade. (Tipo do Dado: Texto.)
{param8}: Id BomControle do Status da Oportunidade. (Opções: 0 - Aberto, 1 - Ganhou, 2 - Perdeu. Tipo do Dado: Inteiro.)
{param9}: Id BomControle da Temperatura da Oportunidade. (Opções: 0 - Congelado, 1 - Morno, 2 - Quente, 3 - Muito quente. Tipo do Dado: Inteiro.)
{param10}: Nome da Temperatura da Oportunidade. (Tipo do Dado: Texto.)
{param11}: Valor da Oportunidade. (Tipo do Dado: Decimal.)
{param12}: Id BomControle da Etapa da Oportunidade. (Tipo do Dado: Inteiro.)
{param13}: Nome da Etapa da Oportunidade. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Oportunidade","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"08f83330-76fe-4d99-bfac-71521db633a7","name":"Oportunidade - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Oportunidade/Pesquisar?documentoLead=12345678000100&nomeLead=teste&tituloOportunidade=teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Oportunidade","Pesquisar"],"query":[{"key":"documentoLead","value":"12345678000100"},{"key":"nomeLead","value":"teste"},{"key":"tituloOportunidade","value":"teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 14:54:03 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"29503"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"Titulo\": \"Teste\",\r\n \"Observacao\": null,\r\n \"TipoLead\": 0,\r\n \"IdLead\": 1,\r\n \"NomeLead\": \"Fornecedor Teste\",\r\n \"DocumentoLead\": \"12345678000100\",\r\n \"IdUsuarioResposavel\": 1,\r\n \"NomeUsuarioResponsavel\": null,\r\n \"LoginUsuario\": \"teste@bomcontrole.com.br\",\r\n \"Usuario\": null,\r\n \"IdVendedor\": 0,\r\n \"NomeVendedor\": null,\r\n \"LinkImagemVendedor\": null,\r\n \"DataCriacao\": \"0001-01-01T00:00:00\",\r\n \"DataPrevista\": null,\r\n \"Status\": 0,\r\n \"TemperaturaDaOportunidade\": 0,\r\n \"NomeTemperaturaDaOportunidade\": \"Congelado\",\r\n \"Valor\": 10.00000,\r\n \"IdEtapa\": 1,\r\n \"NomeEtapa\": \"Cliente em potencial\",\r\n \"FunilVenda\": null,\r\n \"IdFunilVenda\": 0,\r\n \"IconeEtapa\": null,\r\n \"DataUltimaTrocaEtapa\": \"0001-01-01T00:00:00\",\r\n \"ValorIntervalo\": null,\r\n \"TipoIntervalo\": 0,\r\n \"QuantidadeAtividade\": 0,\r\n \"QuantidadeAtividadeAtrasada\": 0,\r\n \"QuantidadeAtividadesFuturas\": 0,\r\n \"Formulario\": null,\r\n \"DocumentoVendedor\": null\r\n }\r\n]"}],"_postman_id":"05554c22-f49d-46e3-bab6-2f54ae42a2e4"},{"name":"Oportunidade - Obter Campos Personalizados","id":"01175239-edb6-4282-b6ad-66d465dfe953","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Oportunidade/ObterCamposPersonalizados","description":"

Retorna um array com todos os campos criados por você no sistema Bomcontrole, esses campos são utilizados no momento de criar uma oportunidade.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no sistema BomControle.

\n\n

Response

Retorna um array de objetos com os dados dos Campos Personalizados:

[\n{\n  \"IdCampo\": {param1},\n  \"NomeCampo\": {param2},\n  \"TipoCampoFormulario\": {param3},\n  \"NomeTipoCampoFormulario\": {param4},\n  \"TipoEntidadeCampoFormulario\": {param5},\n  \"NomeTipoEntidadeCampoFormulario\": {param6},\n  \"Obrigatorio\": {param7},\n  \"ItensLista\": {param8}\n      [\n      {\n      \"IdItemLista\": {param9},\n      \"Padrao\": {param10},\n      \"Valor\": {param11}\n      }\n      ]\n}\n]\n

Paramêtros

{param1}: Id do Campo no Bomcontrole. (Tipo do Dado: Inteiro.)
{param2}: Titulo do Campo no Bomcontrole. (Tipo do Dado: Texto.)
{param3}: Id do Tipo do Campo. (Tipo do Dado: Inteiro.)
{param4}: Nome do Tipo do Campo. (Tipo do Dado: Texto.)
{param5}: Id da Entidade. Campo é preenchido apenas quando o \"NomeTipoCampoFormulario\" é \"Entidade\". (Tipo do Dado: Inteiro.)
{param6}: Nome da Entidade. Campo é preenchido apenas quando o \"NomeTipoCampoFormulario\" é \"Entidade\". (Tipo do Dado: Texto.)
{param7}: Indica se o campo é obrigatório na criação da oportunidade ou não. (Tipo do Dado: Boleano.)
{param8}: Array de Objetos contendo os dados dos Itens da lista. Campo é preenchido apenas quando o \"NomeTipoCampoFormulario\" é \"Lista\". (Tipo do Dado: Array de Objetos.)
{param9}: Id do Item nessa Lista. (Tipo do Dado: Inteiro.)
{param10}: Indica se esse item é o padrão da lista ou não. (Tipo do Dado: Boleano.)
{param11}: Titulo do Item da Lista. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Oportunidade","ObterCamposPersonalizados"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"00b015a8-4a4d-43cf-ad04-66232a474505","name":"Oportunidade - Obter Campos Personalizados","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb8rFLEkE6kE6cc2UuBkiKInyAN2kFrKH7-RGDrt325a2pXfMQPup8udynsbTrCaUm0-ug-q6JxgcGFVKq589l1JHaUUcTkvYNwD3VPSZ9pRCgKd7MwMR1qwsW16kQFhc94.","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Oportunidade/ObterCamposPersonalizados"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Tue, 06 Sep 2022 16:49:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"1136"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"IdCampo\": 98,\r\n \"NomeCampo\": \"Campo livre\",\r\n \"TipoCampoFormulario\": 1,\r\n \"NomeTipoCampoFormulario\": \"Texto\",\r\n \"TipoEntidadeCampoFormulario\": null,\r\n \"NomeTipoEntidadeCampoFormulario\": \"\",\r\n \"Obrigatorio\": true,\r\n \"ItensLista\": []\r\n },\r\n {\r\n \"IdCampo\": 99,\r\n \"NomeCampo\": \"Observações Gerais\",\r\n \"TipoCampoFormulario\": 2,\r\n \"NomeTipoCampoFormulario\": \"TextoMultilinha\",\r\n \"TipoEntidadeCampoFormulario\": null,\r\n \"NomeTipoEntidadeCampoFormulario\": \"\",\r\n \"Obrigatorio\": false,\r\n \"ItensLista\": []\r\n },\r\n {\r\n \"IdCampo\": 100,\r\n \"NomeCampo\": \"Plano\",\r\n \"TipoCampoFormulario\": 6,\r\n \"NomeTipoCampoFormulario\": \"Lista\",\r\n \"TipoEntidadeCampoFormulario\": null,\r\n \"NomeTipoEntidadeCampoFormulario\": \"\",\r\n \"Obrigatorio\": false,\r\n \"ItensLista\": [\r\n {\r\n \"IdItemLista\": 27,\r\n \"Padrao\": true,\r\n \"Valor\": \"Plano 1\"\r\n },\r\n {\r\n \"IdItemLista\": 28,\r\n \"Padrao\": false,\r\n \"Valor\": \"Plano 2\"\r\n },\r\n {\r\n \"IdItemLista\": 29,\r\n \"Padrao\": false,\r\n \"Valor\": \"Plano 3\"\r\n }\r\n ]\r\n }\r\n]"}],"_postman_id":"01175239-edb6-4282-b6ad-66d465dfe953"}],"id":"576daaf2-0bad-46ff-b18a-1174a7b47d7e","description":"

APIs para modificação das Oportunidades no BomControle.

\n","event":[{"listen":"prerequest","script":{"id":"a1d3c2e4-025e-428f-bcf9-b38b4d2ee440","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"809ed129-6649-4422-9c26-6e30067b5571","type":"text/javascript","exec":[""]}}],"_postman_id":"576daaf2-0bad-46ff-b18a-1174a7b47d7e"},{"name":"Orcamento","item":[{"name":"Orcamento - Obter","id":"78d20ded-b547-49d5-90d5-e5898d8cb61c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Orcamento/Obter/{id}","description":"

Obtem os dados do Orçamento do BomControle pesquisada.

Request

O request para essa API é feito informando a identificação do Orçamento a ser pesquisada diretamente na URL.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: Id do Orçamento dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados da Venda:

{\n  \"Id\": {param1},\n  \"Cancelado\": {param2},\n  \"Empresa\": {param3} {\n    \"Id\": {param4},\n    \"Documento\": {param5},\n    \"Nome\": {param6},\n    \"Padrao\": {param7}\n  },\n  \"Cliente\": {param8} {\n    \"Id\": {param9},\n    \"TipoPessoa\": {param10},\n    \"PaisOrigem\": {param11},\n    \"PessoaFisica\": {param12} {\n      \"Documento\": {param13},\n      \"Nome\": {param14},\n      \"Sexo\": {param15},\n      \"DataNascimento\": {param16}\n    },\n    \"PessoaJuridica\": {param17} {\n      \"Documento\": {param18},\n      \"NomeFantasia\": {param19},\n      \"RazaoSocial\": {param20},\n      \"IsentoInscricaoEstadual\": {param21},\n      \"InscricaoEstadual\": {param22},\n      \"UFInscricaoEstadual\": {param23},\n      \"InscricaoMunicipal\": {param24},\n      \"RamoAtividade\": {param25}\n    },\n    \"Bloqueado\": {param26},\n    \"Endereco\": {param27} {\n      \"Id\": {param28},\n      \"TipoLogradouro\": {param29},\n      \"Logradouro\": {param30},\n      \"Numero\": {param31},\n      \"Complemento\": {param32},\n      \"Bairro\": {param33},\n      \"Cep\": {param34},\n      \"Cidade\": {param35},\n      \"Uf\": {param36}\n    },\n    \"Contatos\": {param37} [\n      {\n        \"Id\": {param38},\n        \"IdCliente\": {param39},\n        \"IdFornecedor\": {param40},\n        \"IdFuncionario\": {param41},\n        \"Nome\": {param42},\n        \"Email\": {param43},\n        \"Telefone\": {param44},\n        \"Padrao\": {param45},\n        \"Cobranca\": {param46}\n      }\n    ]\n  },\n  \"Itens\": {param47} [\n    {\n      \"IdServico\": {param48},\n      \"Descricao\": {param49},\n      \"Quantidade\": {param50},\n      \"ValorUnitario\": {param51},\n      \"ValorDesconto\": {param52},\n      \"CodigoExterno\": {param53},\n      \"Nome\": {param54}\n    }\n  ],  \n  \"Valor\": {param55},\n  \"ValorDefinitivo\": {param56},\n  \"DataPrevisaoEntrega\": {param57},\n  \"Observacao\": {param58}\n}\n\n

Paramêtros

{param1}: Id BomControle do Orçamento. (Tipo do Dado: Inteiro.)
\n
{param2}: Status do Orçamento. (Tipo do Dado: Booleano.)
\n
{param3}: Objteto contendo os dados da Empresa do Orçamento. (Tipo do Dado: Objeto.)
\n
{param4}: Id BomControle da Empresa. (Tipo do Dado: Inteiro.)
\n
{param5}: Cnpj da Empresa. (Tipo do Dado: Texto.)
\n
{param6}: Nome da Empresa. (Tipo do Dado: Texto.)
\n
{param7}: Indica se a Empresa é a principal do BomControle. (Tipo do Dado: Booleano.)
\n
{param8}: Objteto contendo os dados do Cliente do Orçamento. (Tipo do Dado: Objeto.)
\n
{param9}: Id BomControle do Cliente. (Tipo do Dado: Inteiro.)
\n
{param10}: Tipo de Pessoa do Cliente. (Opções: Juridica, Fisca. Tipo do Dado: Texto.)
\n
{param11}: País de Origem do Cliente. (Tipo do Dado: Texto.)
\n
{param12}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Física. Nullo caso seja TipoPessoa Jurídica. (Tipo do Dado: Objeto.)
\n
{param13}: Cpf do Cliente. (Tipo do Dado: Texto.)
\n
{param14}: Nome do Cliente. (Tipo do Dado: Texto.)
\n
{param15}: Sexo do Cliente. (Opções: M, F, O. Tipo do Dado: Texto.)
\n
{param16}: Data de nascimento do Cliente. (Tipo do Dado: Texto.)
\n
{param17}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Jurídica. Nullo caso seja TipoPessoa Física. (Tipo do Dado: Objeto.)
\n
{param18}: Cnpj do Cliente. (Tipo do Dado: Texto.)
\n
{param19}: Nome Fantasia do Cliente. (Tipo do Dado: Texto.)
\n
{param20}: Razão Social do Cliente. (Tipo do Dado: Texto.)
\n
{param21}: Indica se o Cliente é isento da Inscricao Estadual. (Tipo do Dado: Texto.)
\n
{param22}: Número da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
\n
{param23}: Estado da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
\n
{param24}: Número da Inscricao Municipal do Cliente. (Tipo do Dado: Texto.)
\n
{param25}: Ramo de atividade do Cliente. (Tipo do Dado: Texto.)
\n
{param26}: Indica se o Cliente esta bloqueado no BomControle. (Tipo do Dado: Booleano.)
\n
{param27}: Objeto com os dados de endereço do Cliente. (Tipo do Dado: Objeto.)
\n
{param28}: Id do endereço do Cliente no BomControle. (Tipo do Dado: Inteiro.)
\n
{param29}: Tipo de logradouro do Cliente. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
\n
{param30}: Logradouro do Cliente. (Tipo do Dado: Texto.)
\n
{param31}: Número do logradouro do Cliente. (Tipo do Dado: Texto.)
\n
{param32}: Complemento do logradouro do Cliente. (Tipo do Dado: Texto.)
\n
{param33}: Bairro do logradouro do Cliente. (Tipo do Dado: Texto.)
\n
{param34}: Cep do logradouro do Cliente. (Tipo do Dado: Texto.)
\n
{param35}: Cidade do logradouro do Cliente. (Tipo do Dado: Texto.)
\n
{param36}: Sigla do Estado do logradouro do Cliente. (Tipo do Dado: Texto.)
\n
{param37}: Array de Objetos com os dados de contatos do Cliente. (Tipo do Dado: Array de Objetos.)
\n
{param38}: Id do contato do Cliente no BomControle. (Tipo do Dado: Inteiro.)
\n
{param39}: Id do Cliente no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
\n
{param40}: Id do Fornecedor no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
\n
{param41}: Id do Funcionário no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
\n
{param42}: Nome do contato do Cliente. (Tipo do Dado: Texto.)
\n
{param43}: E-mail do contato do Cliente. (Tipo do Dado: Texto.)
\n
{param44}: Telefone do contato do Cliente. (Tipo do Dado: Texto.)
\n
{param45}: Indica se é o contato principal do Cliente. (Tipo do Dado: Booleano.)
\n
{param46}: Indica se o contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)
\n
{param47}: Array contendo os dados dos itens do Orçamento. (Tipo do Dado: Array de Objetos.)
\n
{param48}: Id BomControle do Serviço. (Tipo do Dado: Inteiro.)
\n
{param49}: Descrição do Serviço do Orçamento (Tipo do Dado: Texto.)
\n
{param50}: Quantidade do Serviço no Orçamento. (Tipo do Dado: Inteiro.)
\n
{param51}: Valor unitário do Serviço no Orçamento (Tipo do Dado: Decimal.)
\n
{param52}: Valor do desconto do Serviço no Orçamento (Tipo do Dado: Decimal.)
\n
{param53}: Código externo do Serviço do Orçamento. (Tipo do Dado: Inteiro.)
\n
{param54}: Nome do Serviço do Orçamento (Tipo do Dado: Texto.)
\n
{param55}: Valor do Orçamento (Tipo do Dado: Decimal.)
\n
{param56}: Indica se o valor do Orçamento é definitivo. (Tipo do Dado: Booleano.)
\n
{param57}: Data do Orçamento. (Tipo do Dado: Texto.)
\n
{param58}: Observação do Orçamento (Tipo do Dado: Texto.)
\n

\n","urlObject":{"protocol":"https","path":["integracao","Orcamento","Obter","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"1a19e036-078d-460f-98c9-40a1fe25f399","name":"Venda - Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Obter/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 15:54:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"2853"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"Empresa\": {\r\n \"Id\": 1,\r\n \"Documento\": \"12345678000100\",\r\n \"Nome\": \"Teste\",\r\n \"Padrao\": false\r\n },\r\n \"Cliente\": {\r\n \"Id\": 1,\r\n \"TipoPessoa\": \"Fisica\",\r\n \"PaisOrigem\": \"Brasil\",\r\n \"PessoaFisica\": {\r\n \"Documento\": \"12345678900\",\r\n \"Nome\": \"Teste\",\r\n \"Sexo\": \"M\",\r\n \"DataNascimento\": null\r\n },\r\n \"PessoaJuridica\": null,\r\n \"Bloqueado\": false,\r\n \"Endereco\": {\r\n \"Id\": 1,\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdCliente\": 1,\r\n \"IdFornecedor\": 0,\r\n \"IdFuncionario\": 0,\r\n \"Nome\": \"Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": null,\r\n \"Padrao\": true,\r\n \"Cobranca\": false\r\n }\r\n ]\r\n },\r\n \"Servicos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdVenda\": 1,\r\n \"IdServico\": 1,\r\n \"Quantidade\": 1.00000,\r\n \"ValorUnitario\": 1.00000\r\n }\r\n ],\r\n \"Faturas\": [\r\n {\r\n \"Id\": 1,\r\n \"IdParcela\": \"a7f179a2-73f5-46ee-b951-249737a5dc32\",\r\n \"IdMovimentacaoFinanceira\": \"d85fbed5-5392-4b46-8c46-264d53aaee1e\",\r\n \"TipoFatura\": 0,\r\n \"NomeTipoFatura\": \"Faturamento\",\r\n \"DataVencimento\": \"2020-01-01T00:00:00\",\r\n \"DataCompetencia\": \"2020-01-01T00:00:00\",\r\n \"Valor\": 1.00000,\r\n \"DataPagamento\": null,\r\n \"ValorPagamento\": 0.0,\r\n \"NumeroParcela\": 1,\r\n \"Quitado\": false,\r\n \"Conciliado\": false,\r\n \"FormaPagamento\": 13,\r\n \"NomeFormaPagamento\": \"BoletoBancario\",\r\n \"EmiteBoleto\": true,\r\n \"ObservacaoBoleto\": null,\r\n \"IdBoleto\": 1,\r\n \"LinkBoleto\": null,\r\n \"EmiteNotaFiscal\": true,\r\n \"ObservacaoNotaFiscal\": null,\r\n \"LinkNotaFiscal\": null,\r\n \"LinkXmlNotaFiscal\": null,\r\n \"DataPromessaPagamento\": null,\r\n \"ClienteNaoVaiPagar\": false\r\n }\r\n ],\r\n \"Valor\": 1.00000\r\n}"}],"_postman_id":"78d20ded-b547-49d5-90d5-e5898d8cb61c"},{"name":"Orcamento - Pesquisar","id":"885bd2bc-5efd-4306-bb60-0184846bb4dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Orcamento/Pesquisar","description":"

Obtem os dados do Orçamento do BomControle pesquisado.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

pesquisa: Pesquisa o Orçamento pelo nome ou documento do cliente do Orçamento. (Opcional. Tipo do Dado: Texto.)
idEmpresa: Pesquisa o Orçamento pelo ID da Empresa do Orçamento. (Opcional. Tipo do Dado: Inteiro.)
idCliente: Pesquisa o Orçamento pelo ID do Cliente do Orçamento. (Opcional. Tipo do Dado: Inteiro.)
periodo.Inicial: Pesquisa o Orçamento a partir da data informada. (Opcional. Tipo do Dado: Data.)
periodo.Final: Pesquisa o Orçamento até a data informada. (Opcional. Tipo do Dado: Data.)

\n\n

Response

Retorna um array de objetos com os dados da Venda:

[\n    {\n      \"Id\": {param1},\n      \"Cancelado\": {param2}\n      \"Empresa\": {param3} {\n        \"Id\": {param4},\n        \"Documento\": {param5},\n        \"Nome\": {param6},\n        \"Padrao\": {param7}\n      },\n      \"Cliente\": {param8} {\n        \"Id\": {param9},\n        \"TipoPessoa\": {param10},\n        \"PaisOrigem\": {param11},\n        \"PessoaFisica\": {param12} {\n          \"Documento\": {param13},\n          \"Nome\": {param14},\n          \"Sexo\": {param15},\n          \"DataNascimento\": {param16}\n        },\n        \"PessoaJuridica\": {param17} {\n          \"Documento\": {param18},\n          \"NomeFantasia\": {param19},\n          \"RazaoSocial\": {param20},\n          \"IsentoInscricaoEstadual\": {param21},\n          \"InscricaoEstadual\": {param22},\n          \"UFInscricaoEstadual\": {param23},\n          \"InscricaoMunicipal\": {param24},\n          \"RamoAtividade\": {param25}\n        },\n        \"Bloqueado\": {param26},\n        \"Endereco\": {param27} {\n          \"Id\": {param28},\n          \"TipoLogradouro\": {param29},\n          \"Logradouro\": {param30},\n          \"Numero\": {param31},\n          \"Complemento\": {param32},\n          \"Bairro\": {param33},\n          \"Cep\": {param34},\n          \"Cidade\": {param35},\n          \"Uf\": {param36}\n        },\n        \"Contatos\": {param37} [\n          {\n            \"Id\": {param38},\n            \"IdCliente\": {param39},\n            \"IdFornecedor\": {param40},\n            \"IdFuncionario\": {param41},\n            \"Nome\": {param42},\n            \"Email\": {param43},\n            \"Telefone\": {param44},\n            \"Padrao\": {param45},\n            \"Cobranca\": {param46}\n          }\n        ]\n      },\n      \"Itens\": {param47} [\n      {\n        \"IdServico\": {param48},\n        \"Descricao\": {param49},\n        \"Quantidade\": {param50},\n        \"ValorUnitario\": {param51},\n        \"ValorDesconto\": {param52},\n        \"CodigoExterno\": {param53},\n        \"Nome\": {param54}\n      }\n   ],  \n  \"Valor\": {param55},\n  \"ValorDefinitivo\": {param56},\n  \"DataPrevisaoEntrega\": {param57},\n  \"Observacao\": {param58}\n}\n\n

Paramêtros

{param1}: Id BomControle da Venda. (Tipo do Dado: Inteiro.)
{param2}: Status do Orçamento. (Tipo do Dado: Booleano.)
{param3}: Objteto contendo os dados da Empresa do Orçamento. (Tipo do Dado: Objeto.)
{param4}: Id BomControle da Empresa. (Tipo do Dado: Inteiro.)
{param5}: Cnpj da Empresa. (Tipo do Dado: Texto.)
{param6}: Nome da Empresa. (Tipo do Dado: Texto.)
{param7}: Indica se a Empresa é a principal do BomControle. (Tipo do Dado: Booleano.)
{param8}: Objteto contendo os dados do Cliente do Orçamento. (Tipo do Dado: Objeto.)
{param9}: Id BomControle do Cliente. (Tipo do Dado: Inteiro.)
{param10}: Tipo de Pessoa do Cliente. (Opções: Juridica, Fisca. Tipo do Dado: Texto.)
{param11}: País de Origem do Cliente. (Tipo do Dado: Texto.)
{param12}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Física. Nullo caso seja TipoPessoa Jurídica. (Tipo do Dado: Objeto.)
{param13}: Cpf do Cliente. (Tipo do Dado: Texto.)
{param14}: Nome do Cliente. (Tipo do Dado: Texto.)
{param15}: Sexo do Cliente. (Opções: M, F, O. Tipo do Dado: Texto.)
{param16}: Data de nascimento do Cliente. (Tipo do Dado: Texto.)
{param17}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Jurídica. Nullo caso seja TipoPessoa Física. (Tipo do Dado: Objeto.)
{param18}: Cnpj do Cliente. (Tipo do Dado: Texto.)
{param19}: Nome Fantasia do Cliente. (Tipo do Dado: Texto.)
{param20}: Razão Social do Cliente. (Tipo do Dado: Texto.)
{param21}: Indica se o Cliente é isento da Inscricao Estadual. (Tipo do Dado: Texto.)
{param22}: Número da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param23}: Estado da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param24}: Número da Inscricao Municipal do Cliente. (Tipo do Dado: Texto.)
{param25}: Ramo de atividade do Cliente. (Tipo do Dado: Texto.)
{param26}: Indica se o Cliente esta bloqueado no BomControle. (Tipo do Dado: Booleano.)
{param27}: Objeto com os dados de endereço do Cliente. (Tipo do Dado: Objeto.)
{param28}: Id do endereço do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param29}: Tipo de logradouro do Cliente. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param30}: Logradouro do Cliente. (Tipo do Dado: Texto.)
{param31}: Número do logradouro do Cliente. (Tipo do Dado: Texto.)
{param32}: Complemento do logradouro do Cliente. (Tipo do Dado: Texto.)
{param33}: Bairro do logradouro do Cliente. (Tipo do Dado: Texto.)
{param34}: Cep do logradouro do Cliente. (Tipo do Dado: Texto.)
{param35}: Cidade do logradouro do Cliente. (Tipo do Dado: Texto.)
{param36}: Sigla do Estado do logradouro do Cliente. (Tipo do Dado: Texto.)
{param37}: Array de Objetos com os dados de contatos do Cliente. (Tipo do Dado: Array de Objetos.)
{param38}: Id do contato do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param39}: Id do Cliente no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param40}: Id do Fornecedor no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param41}: Id do Funcionário no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param42}: Nome do contato do Cliente. (Tipo do Dado: Texto.)
{param43}: E-mail do contato do Cliente. (Tipo do Dado: Texto.)
{param44}: Telefone do contato do Cliente. (Tipo do Dado: Texto.)
{param45}: Indica se é o contato principal do Cliente. (Tipo do Dado: Booleano.)
{param46}: Indica se o contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)
{param47}: Array contendo os dados dos itens do Orçamento. (Tipo do Dado: Array de Objetos.)
{param48}: Id BomControle do Serviço. (Tipo do Dado: Inteiro.)
{param49}: Descrição do Serviço do Orçamento (Tipo do Dado: Texto.)
{param50}: Quantidade do Serviço no Orçamento. (Tipo do Dado: Inteiro.)
{param51}: Valor unitário do Serviço no Orçamento (Tipo do Dado: Decimal.)
{param52}: Valor do desconto do Serviço no Orçamento (Tipo do Dado: Decimal.)
{param53}: Código externo do Serviço do Orçamento. (Tipo do Dado: Inteiro.)
{param54}: Nome do Serviço do Orçamento (Tipo do Dado: Texto.)
{param55}: Valor do Orçamento (Tipo do Dado: Decimal.)
{param56}: Indica se o valor do Orçamento é definitivo. (Tipo do Dado: Booleano.)
{param57}: Data do Orçamento. (Tipo do Dado: Texto.)
{param58}: Observação do Orçamento (Tipo do Dado: Texto.)

\n","urlObject":{"protocol":"https","path":["integracao","Orcamento","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"5409da5a-3c7e-413f-a793-d7869f6911f4","name":"Venda - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Pesquisar?pesquisa=teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Venda","Pesquisar"],"query":[{"key":"pesquisa","value":"teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 16:57:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"2670"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"Empresa\": {\r\n \"Id\": 1,\r\n \"Documento\": \"12345678000100\",\r\n \"Nome\": \"Teste\",\r\n \"Padrao\": true\r\n },\r\n \"Cliente\": {\r\n \"Id\": 1,\r\n \"TipoPessoa\": \"Fisica\",\r\n \"PaisOrigem\": \"Brasil\",\r\n \"PessoaFisica\": {\r\n \"Documento\": \"12345678900\",\r\n \"Nome\": \"Teste\",\r\n \"Sexo\": null,\r\n \"DataNascimento\": null\r\n },\r\n \"PessoaJuridica\": null,\r\n \"Bloqueado\": false,\r\n \"Endereco\": {\r\n \"Id\": 1,\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": []\r\n },\r\n \"Servicos\": null,\r\n \"Faturas\": null,\r\n \"Valor\": 10.00000\r\n }\r\n]"}],"_postman_id":"885bd2bc-5efd-4306-bb60-0184846bb4dc"},{"name":"Orcamento - Criar","id":"70990e76-9aa5-48b9-a29f-4a73ba8a1c62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Orcamento/Criar","description":"

Realiza o cadastro de um novo Orçamento no BomControle.

Request

Os dados enviados para a API devem ser informados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Body

{\n  \"IdCliente\": {param1},\n  \"IdEmpresa\": {param2},\n  \"Validade\": {param3}\n  \"FormaPagamento\": {param4} {\n    \"Boleto\": {param5} {\n      \"Observacao\": {param6},\n      \"EmiteBoleto\": {param7},\n    },\n    \"DepositoConta\": {param8} {\n      \"NumeroBanco\": {param9},\n      \"NumeroAgencia\": {param10},\n      \"NumeroConta\": {param11}\n    },\n    \"Outros\": {param12} {\n      \"Nome\": {param13}\n    }\n  },\n  \"Itens\": {param14} [\n    {\n      \"Id\": {param15},\n      \"IdProduto\": {param16},\n      \"IdServico\": {param17},\n      \"Descricao\": {param18},\n      \"Quantidade\": {param19},\n      \"ValorUnitario\": {param20},\n      \"ValorDesconto\": {param21}\n    }\n  ],\n  \"PrimeiroVencimento\": {param22},\n  \"Data\": {param23},\n  \"QuatidadeParcelas\": {param24},\n  \"DataPrevisaoEntrega\": {param25},\n  \"Observacao\": {param26}\n}\n\n

Paramêtros

{param1}: Id BomControle do Cliente. (Obrigatório. Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Empresa. (Obrigatório. Tipo do Dado: Inteiro.)
{param3}: Data de validade do Orçamento (Obrigatório. Tipo do Dado: Texto.)
{param4}: Objeto contendo as Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param5}: Objeto contendo os dados para Boleto. Informar apenas quando houver emissão (Opcional.Tipo do Dado: Objeto.)
{param6}: Observação do Boleto. (Opcional.Tipo do Dado: Texto.)
{param7}: Indica se haverá emissão de boleto ou não. (Tipo do Dado: Boleano.)
{param8}: Objeto contendo os dados para Depósito em Conta. (Opcional.Tipo do Dado: Objeto.)
{param9}: Número do Banco. (Opcional.Tipo do Dado: Texto.)
{param10}: Número da Agência. (Opcional.Tipo do Dado: Texto.)
{param11}: Número da Conta. (Opcional. Tipo do Dado: Texto.)
{param12}: Objeto contendo os dados para outras Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param13}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param14}: Array de Objetos contendo os dados dos Itens do Orçamento. (Obrigatório. Tipo do Dado: Array de Objetos.)
{param15}: Sequencial do item no Orçamento. (Obrigatório. Tipo do Dado: Inteiro.)
{param16}: ID do Produto do Orçamento (Opcional. Tipo do Dado: Inteiro.)
{param17}: ID do Serviço do Orçamento (Opcional. Tipo do Dado: Inteiro.)
{param18}: Descrição do item no Orçamento (Opcional. Tipo do Dado: Texto.)
{param19}: Quantidade do Item. (Obrigatório. Tipo do Dado: Decimal.)
{param20}: Valor Unitário do Item. (Obrigatório. Tipo do Dado: Decimal.)
{param21}: Valor Desconto do Item. (Obrigatório. Tipo do Dado: Decimal.)
{param22}: Data de Vencimento da Primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param23}: Data do Orçamento. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param24}: Quantidade de Parcelas. (Opcional. Tipo do Dado: Inteiro.)
{param25}: Data Previsão de Entrega. (Opcional. Tipo do Dado: Texto.)
{param26}: Observação. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Retorna o Id do Orçamento cadastrado no BomControle. (Tipo do Dado: Inteiro.)

\n","urlObject":{"protocol":"https","path":["integracao","Orcamento","Criar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"11ae3cce-fe69-43cf-b5ab-4991a90d083c","name":"Venda - Criar","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"IdCliente\": 1,\r\n \"IdEmpresa\": 1,\r\n \"FormaPagamento\": {\r\n \"Boleto\": {\r\n \"Observacao\": null\r\n }\r\n },\r\n \"NotaFiscal\": {\r\n \"Observacao\": null\r\n },\r\n \"Desconto\": {\r\n \"Percentual\": 0,\r\n \"DataFim\": \"2020-01-01 00:00:00\"\r\n },\r\n \"Servicos\": [\r\n {\r\n \"IdServico\": 305,\r\n \"Quantidade\": 1,\r\n \"ValorUnitario\": 10,\r\n \"ValorDesconto\": 0\r\n }\r\n ],\r\n \"PrimeiroVencimento\": \"2020-01-01 00:00:00\",\r\n \"Data\": \"2020-01-01 00:00:00\",\r\n \"QuatidadeParcelas\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Criar"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 19:22:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"IdVenda\": 1,\r\n \"IdContrato\": 0,\r\n \"IdFatura\": 1\r\n}"}],"_postman_id":"70990e76-9aa5-48b9-a29f-4a73ba8a1c62"},{"name":"Orcamento - Cancelar","id":"f625ed5a-eba1-4a12-a0b6-a5cd9825fd04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Orcamento/Cancelar/{id}","description":"

Realiza o cancelamento do Orçamento no BomControle.

Request

O request para essa API é feito informando a identificação do Orçamento diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do Orçamento dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"DataCompetencia\": {param1},\n  \"Motivo\": {param2}\n}\n\n

Paramêtros

{param1}: Data do cancelamento do Orçamento. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param2}: Motivo do cancelamento do Orçamento. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Orcamento","Cancelar","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"1f40006d-8b3c-43e9-8cc0-0eaa998bbb04","name":"Venda - Cancelar","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"DataCompetencia\": \"2020-01-01 00:00:00\",\r\n \"Motivo\": \"Teste\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Cancelar/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 05 Feb 2020 11:32:13 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f625ed5a-eba1-4a12-a0b6-a5cd9825fd04"}],"id":"9fd5e26f-83fd-48a0-87df-fd7c05ac0890","description":"

APIs para modificação das Orçamentos do BomControle.

\n","event":[{"listen":"prerequest","script":{"id":"89ec1fff-466b-45f2-9bbe-17321bd81106","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cdfbbd15-f796-4c2d-918a-7a7c6e960112","type":"text/javascript","exec":[""]}}],"_postman_id":"9fd5e26f-83fd-48a0-87df-fd7c05ac0890"},{"name":"Servico","item":[{"name":"Servico - Obter","id":"329ed66a-a241-4735-b688-6ca5639a5f33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Servico/Obter/{id}","description":"

Obtem os dados do Serviço do BomControle pesquisado.

Request

O request para essa API é feito informando a identificação do Serviço a ser pesquisado diretamente na URL.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: Id do Serviço dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados do Serviço:

{\n  \"Id\": {param1},\n  \"Nome\": {param2},\n  \"Observacao\": {param3},\n  \"Valor\": {param4},\n  \"IdTipoServico\": {param5},\n  \"NomeTipoServico\": {param6}\n}\n

Paramêtros

{param1}: Id BomControle do Serviço. (Tipo do Dado: Inteiro.)
{param2}: Nome do Serviço. (Tipo do Dado: Texto.)
{param3}: Observação do Serviço. (Tipo do Dado: Texto.)
{param4}: Valor do Serviço. (Tipo do Dado: Decimal.)
{param5}: Id BomControle do Tipo Serviço. (Tipo do Dado: Inteiro.)
{param6}: Nome do Tipo do Serviço. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Servico","Obter","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"dfc2d8ab-ea37-4ed8-b99f-8c633aac505c","name":"Servico - Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Servico/Obter/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 15:35:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"175"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"Nome\": \"Teste\",\r\n \"Observacao\": null,\r\n \"Valor\": 10.00000,\r\n \"IdTipoServico\": 1,\r\n \"NomeTipoServico\": \"Teste\"\r\n}"}],"_postman_id":"329ed66a-a241-4735-b688-6ca5639a5f33"},{"name":"Servico - Pesquisar","id":"0e0030fd-8fab-4546-9a40-27e4ddbdef38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Servico/Pesquisar","description":"

Pesquisa os Serviços cadastradas no BomControle conforme o filtro utilizado.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

nome: Localiza os Serviços do BomControle pelo Nome do serviço. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Retorna um array de objetos com os dados dos Serviços:

[\n  {\n    \"Id\": {param1},\n    \"Nome\": {param2},\n    \"Observacao\": {param3},\n    \"Valor\": {param4},\n    \"IdTipoServico\": {param5},\n    \"NomeTipoServico\": {param6}\n  }\n]\n

Paramêtros

{param1}: Id BomControle do Serviço. (Tipo do Dado: Inteiro.)
{param2}: Nome do Serviço. (Tipo do Dado: Texto.)
{param3}: Observação do Serviço. (Tipo do Dado: Texto.)
{param4}: Valor do Serviço. (Tipo do Dado: Decimal.)
{param5}: Id BomControle do Tipo Serviço. (Tipo do Dado: Inteiro.)
{param6}: Nome do Tipo do Serviço. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Servico","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"5ef05691-0e3b-49ef-ba0a-c0fe273f4aca","name":"Servico - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Servico/Pesquisar?nome=teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Servico","Pesquisar"],"query":[{"key":"nome","value":"teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 15:46:12 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"9686"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"Nome\": \"Teste\",\r\n \"Observacao\": null,\r\n \"Valor\": 10.00000,\r\n \"IdTipoServico\": 1,\r\n \"NomeTipoServico\": \"Teste\"\r\n }\r\n]"}],"_postman_id":"0e0030fd-8fab-4546-9a40-27e4ddbdef38"}],"id":"8e47df8f-b30b-4b17-8e58-5d798a91650d","description":"

APIs para pesquisa dos Serviços do BomControle.

\n","_postman_id":"8e47df8f-b30b-4b17-8e58-5d798a91650d"},{"name":"Produto / Servico","item":[{"name":"ProdutoServico - Pesquisar","id":"95876773-e1a0-436e-99d0-ec7d9a8448a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/ProdutoServico/Pesquisar","description":"

Pesquisa os Produtos e Serviços cadastrados no BomControle conforme o filtro utilizado.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

produto: Campo do tipo boleano (True/False), onde é possível filtrar se irá trazer os PRODUTOS ou não no response. (Obrigatório. Tipo do Dado: Boleano.)
servico: Campo do tipo boleano (True/False), onde é possível filtrar se irá trazer os SERVIÇOS ou não no response. (Obrigatório. Tipo do Dado: Boleano.)
venda: Campo do tipo boleano (True/False), com esse campo é possível pesquisar apenas produtos de venda ou de uso interno da empresa. (Opcional. Tipo do Dado: Boleano.)
idEmpresa: Id da empresa no Bomcontrole. (Opcional. Tipo do Dado: Inteiro.)
textoPesquisa: Localiza os Serviços/Produtos pelo nome informado no Bomcontrole. (Opcional. Tipo do Dado: Texto.)
paginacao.itensPorPagina: Usado para definir a paginação da pesquisa, se não informado utiliza valor padrão 50. Numero maximo permitido é de 100 itens. (Opcional. Tipo do Dado: Inteiro.)
paginacao.numeroDaPagina: Usado para definir a paginação da pesquisa, se não informado utiliza valor padrão 1. (Opcional. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um array de objetos com os dados dos Serviços:

{\n\"Itens\": {param1} [\n  {\n    \"Id\": {param2},\n    \"Nome\": {param3},\n    \"Observacao\": {param4},\n    \"ItemDeVenda\": {param5},\n    \"TipoItem\": {param6},\n    \"NomeTipoItem\": {param7},\n    \"Quantidade\": {param8},\n    \"Valor\": {param9},\n    \"IdTipoServico\": {param10},\n    \"NomeTipoServico\": {param11},\n    \"PrecoVendaMinimo\": {param12},\n    \"PrecoVendaMaximo\": {param13},\n    \"NCM\": {param14},\n    \"IdUnidade\": {param15},\n    \"NomeUnidade\": {param16},\n    \"SiglaUnidade\": {param17},\n    \"ItensCombo\": [] {param18}\n  }\n],\n\"TotalItens\": {param19}\n}\n\n

Paramêtros

{param1}: Array de Objetos contendo os dados pesquisados. (Tipo do Dado: Array de Objetos.)
{param2}: Id BomControle do Serviço ou do Produto. (Tipo do Dado: Inteiro.)
{param3}: Nome do Serviço ou do Produto. (Tipo do Dado: Texto.)
{param4}: Observação do Serviço ou do Produto. (Tipo do Dado: Texto.)
{param5}: Informa se o produto esta cadastrado como item de venda (Tipo do Dado: Boleano.)
{param6}: Id BomControle do Tipo do Item. (Tipo do Dado: Inteiro.)
{param7}: Nome do Tipo do Item, onde informa se é Produto ou Serviço. (Tipo do Dado: Texto.)
{param8}: Quantidade atual do Produto no estoque de venda. (Tipo do Dado: Decimal.)
{param9}: Valor de venda do Produto ou do Serviço. (Tipo do Dado: Decimal.)
{param10}: Id do Tipo de Serviço vinculado ao Serviço no Bomcontrole. (Tipo do Dado: Inteiro.)
{param11}: Nome do Tipo de Serviço vinculado ao Serviço no Bomcontrole. (Tipo do Dado: Texto.)
{param12}: Valor minimo para venda informado no cadastro do produto. (Tipo do Dado: Decimal.)
{param13}: Valor maximo para venda informado no cadastro do produto. (Tipo do Dado: Decimal.)
{param14}: Informa o numero do NCM informado no cadastro do produto. (Tipo do Dado: Texto.)
{param15}: Id da unidade do produto no Bomcontrole. (Tipo do Dado: Inteiro.)
{param16}: Nome da unidade do produto no Bomcontrole. (Tipo do Dado: Texto.)
{param17}: Abreviação da unidade do produto no Bomcontrole. (Tipo do Dado: Texto.)
{param18}: Array de objetos contendo os itens quando o produto for do tipo \"Combo\". (Tipo do Dado: Array de Objetos.)
{param19}: Total de Itens Pesquisados. (Tipo do Dado: Inteiro.)

","urlObject":{"protocol":"https","path":["integracao","ProdutoServico","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"0e666513-fd3a-4b3d-b7f6-62222e2c3951","name":"ProdutoServico - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb8XbsKi2ZwMUZlVnuxt6lw-ynsbTrCaUm2csWSye8K2XexoJEDmEw6eHaUUcTkvYNy0slS3Gm4za88Fkhu2kB8u8h9n0f3KNJU.","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/ProdutoServico/Pesquisar?request.idEmpresa=26&request.textoPesquisa=Teste&request.venda=true&request.produto=true&request.servico=false","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","ProdutoServico","Pesquisar"],"query":[{"key":"request.idEmpresa","value":"26"},{"key":"request.textoPesquisa","value":"Teste"},{"key":"request.venda","value":"true"},{"key":"request.produto","value":"true"},{"key":"request.servico","value":"false"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 18 Feb 2022 15:04:30 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"441"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 414,\r\n \"Nome\": \"Produto Teste\",\r\n \"Observacao\": null,\r\n \"ItemDeVenda\": true,\r\n \"TipoItem\": 0,\r\n \"NomeTipoItem\": \"Produto\",\r\n \"Quantidade\": 1.00000,\r\n \"Valor\": 3.00000,\r\n \"IdTipoServico\": 0,\r\n \"NomeTipoServico\": null,\r\n \"PrecoVendaMinimo\": 0.00000,\r\n \"PrecoVendaMaximo\": 50.00000,\r\n \"NCM\": \"85219000\",\r\n \"IdUnidade\": 12,\r\n \"NomeUnidade\": \"Unidade\",\r\n \"SiglaUnidade\": \"UN\"\r\n }\r\n]"}],"_postman_id":"95876773-e1a0-436e-99d0-ec7d9a8448a9"}],"id":"35c90407-38f9-40a0-b9dd-bd3c517089fc","description":"

APIs para pesquisa de Produtos ou Serviços do BomControle

\n","_postman_id":"35c90407-38f9-40a0-b9dd-bd3c517089fc"},{"name":"Venda","item":[{"name":"Venda - Obter","id":"66e3ced5-10cd-41ae-a5e6-7307520e3372","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Obter/{id}","description":"

Obtem os dados da Venda do BomControle pesquisada.

Request

O request para essa API é feito informando a identificação da Venda a ser pesquisada diretamente na URL.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: Id da Venda dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um objeto com os dados da Venda:

{\n  \"Id\": {param1},\n  \"Cancelado\": {param2},\n  \"Empresa\": {param3} {\n    \"Id\": {param4},\n    \"Documento\": {param5},\n    \"Nome\": {param6},\n    \"Padrao\": {param7}\n  },\n  \"Cliente\": {param8} {\n    \"Id\": {param9},\n    \"TipoPessoa\": {param10},\n    \"PaisOrigem\": {param11},\n    \"PessoaFisica\": {param12} {\n      \"Documento\": {param13},\n      \"Nome\": {param14},\n      \"Sexo\": {param15},\n      \"DataNascimento\": {param16}\n    },\n    \"PessoaJuridica\": {param17} {\n      \"Documento\": {param18},\n      \"NomeFantasia\": {param19},\n      \"RazaoSocial\": {param20},\n      \"IsentoInscricaoEstadual\": {param21},\n      \"InscricaoEstadual\": {param22},\n      \"UFInscricaoEstadual\": {param23},\n      \"InscricaoMunicipal\": {param24},\n      \"RamoAtividade\": {param25}\n    },\n    \"Bloqueado\": {param26},\n    \"Endereco\": {param27} {\n      \"Id\": {param28},\n      \"TipoLogradouro\": {param29},\n      \"Logradouro\": {param30},\n      \"Numero\": {param31},\n      \"Complemento\": {param32},\n      \"Bairro\": {param33},\n      \"Cep\": {param34},\n      \"Cidade\": {param35},\n      \"Uf\": {param36}\n    },\n    \"Contatos\": {param37} [\n      {\n        \"Id\": {param38},\n        \"IdCliente\": {param39},\n        \"IdFornecedor\": {param40},\n        \"IdFuncionario\": {param41},\n        \"Nome\": {param42},\n        \"Email\": {param43},\n        \"Telefone\": {param44},\n        \"Padrao\": {param45},\n        \"Cobranca\": {param46}\n      }\n    ]\n  },\n  \"Servicos\": {param47} [\n    {\n      \"Id\": {param48},\n      \"IdVenda\": {param49},\n      \"IdServico\": {param50},\n      \"Quantidade\": {param51},\n      \"ValorUnitario\": {param52}\n    }\n  ],\n  \"Faturas\": {param53} [\n    {\n      \"Id\": {param54},\n      \"IdParcela\": {param55},\n      \"IdMovimentacaoFinanceira\": {param56},\n      \"TipoFatura\": {param57},\n      \"NomeTipoFatura\": {param58},\n      \"DataVencimento\": {param59},\n      \"DataCompetencia\": {param60},\n      \"Valor\": {param61},\n      \"DataPagamento\": {param62},\n      \"ValorPagamento\": {param63},\n      \"NumeroParcela\": {param64},\n      \"Quitado\": {param65},\n      \"Conciliado\": {param66},\n      \"FormaPagamento\": {param67},\n      \"NomeFormaPagamento\": {param68},\n      \"EmiteBoleto\": {param69},\n      \"ObservacaoBoleto\": {param70},\n      \"IdBoleto\": {param71},\n      \"LinkBoleto\": {param72},\n      \"EmiteNotaFiscal\": {param73},\n      \"ObservacaoNotaFiscal\": {param74},\n      \"LinkNotaFiscal\": {param75},\n      \"LinkXmlNotaFiscal\": {param76},\n      \"ClienteNaoVaiPagar\": {param77}\n    }\n  ],\n  \"Valor\": {param78},\n  \"ValorDefinitivo\": {param79},\n  \"DataPrevisaoEntrega\": {param80},\n  \"Observacao\": {param81}\n}\n\n

Paramêtros

{param1}: Id BomControle da Venda. (Tipo do Dado: Inteiro.)
{param2}: Status da venda. (Tipo do Dado: Booleano.)
{param3}: Objteto contendo os dados da Empresa da Venda. (Tipo do Dado: Objeto.)
{param4}: Id BomControle da Empresa. (Tipo do Dado: Inteiro.)
{param5}: Cnpj da Empresa. (Tipo do Dado: Texto.)
{param6}: Nome da Empresa. (Tipo do Dado: Texto.)
{param7}: Indica se a Empresa é a principal do BomControle. (Tipo do Dado: Booleano.)
{param8}: Objteto contendo os dados do Cliente da Venda. (Tipo do Dado: Objeto.)
{param9}: Id BomControle do Cliente. (Tipo do Dado: Inteiro.)
{param10}: Tipo de Pessoa do Cliente. (Opções: Juridica, Fisca. Tipo do Dado: Texto.)
{param11}: País de Origem do Cliente. (Tipo do Dado: Texto.)
{param12}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Física. Nullo caso seja TipoPessoa Jurídica. (Tipo do Dado: Objeto.)
{param13}: Cpf do Cliente. (Tipo do Dado: Texto.)
{param14}: Nome do Cliente. (Tipo do Dado: Texto.)
{param15}: Sexo do Cliente. (Opções: M, F, O. Tipo do Dado: Texto.)
{param16}: Data de nascimento do Cliente. (Tipo do Dado: Texto.)
{param17}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Jurídica. Nullo caso seja TipoPessoa Física. (Tipo do Dado: Objeto.)
{param18}: Cnpj do Cliente. (Tipo do Dado: Texto.)
{param19}: Nome Fantasia do Cliente. (Tipo do Dado: Texto.)
{param20}: Razão Social do Cliente. (Tipo do Dado: Texto.)
{param21}: Indica se o Cliente é isento da Inscricao Estadual. (Tipo do Dado: Texto.)
{param22}: Número da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param23}: Estado da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param24}: Número da Inscricao Municipal do Cliente. (Tipo do Dado: Texto.)
{param25}: Ramo de atividade do Cliente. (Tipo do Dado: Texto.)
{param26}: Indica se o Cliente esta bloqueado no BomControle. (Tipo do Dado: Booleano.)
{param27}: Objeto com os dados de endereço do Cliente. (Tipo do Dado: Objeto.)
{param28}: Id do endereço do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param29}: Tipo de logradouro do Cliente. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param30}: Logradouro do Cliente. (Tipo do Dado: Texto.)
{param31}: Número do logradouro do Cliente. (Tipo do Dado: Texto.)
{param32}: Complemento do logradouro do Cliente. (Tipo do Dado: Texto.)
{param33}: Bairro do logradouro do Cliente. (Tipo do Dado: Texto.)
{param34}: Cep do logradouro do Cliente. (Tipo do Dado: Texto.)
{param35}: Cidade do logradouro do Cliente. (Tipo do Dado: Texto.)
{param36}: Sigla do Estado do logradouro do Cliente. (Tipo do Dado: Texto.)
{param37}: Array de Objetos com os dados de contatos do Cliente. (Tipo do Dado: Array de Objetos.)
{param38}: Id do contato do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param39}: Id do Cliente no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param40}: Não utilizado. (Tipo do Dado: Inteiro.)
{param41}: Não utilizado. (Tipo do Dado: Inteiro.)
{param42}: Nome do contato do Cliente. (Tipo do Dado: Texto.)
{param43}: E-mail do contato do Cliente. (Tipo do Dado: Texto.)
{param44}: Telefone do contato do Cliente. (Tipo do Dado: Texto.)
{param45}: Indica se é o contato principal do Cliente. (Tipo do Dado: Booleano.)
{param46}: Indica se o contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)
{param47}: Array contendo os dados dos Serviços da Venda. (Tipo do Dado: Array de Objetos.)
{param48}: Id BomControle do Item da Venda. (Tipo do Dado: Inteiro.)
{param49}: Id BomControle da Venda. (Tipo do Dado: Inteiro.)
{param50}: Id BomControle do Serviço. (Tipo do Dado: Inteiro.)
{param51}: Quantidade do Serviço. (Tipo do Dado: Decimal.)
{param52}: Valor Unitário do Serviço. (Tipo do Dado: Decimal.)
{param53}: Array contendo as Faturas da Venda. (Tipo do Dado: Array de Objetos.)
{param54}: Id BomControle da Fatura. (Tipo do Dado: Inteiro.)
{param55}: Id BomControle da Parcela. (Tipo do Dado: Texto.)
{param56}: Id BomControle da Movimentação. (Tipo do Dado: Texto.)
{param57}: Id BomControle do Tipo da Fatura. (Opções: 0 - Faturamento, 1 - Renegociacao. Tipo do Dado: Inteiro.)
{param58}: Nome do Tipo da Fatura. (Tipo do Dado: Texto.)
{param59}: Data de Vencimento da Fatura. (Tipo do Dado: Texto.)
{param60}: Data de Competência da Parcela da Fatura. (Tipo do Dado: Texto.)
{param61}: Valor da Fatura. (Tipo do Dado: Decimal.)
{param62}: Data de Pagamento da Parcela da Fatura. (Tipo do Dado: Texto.)
{param63}: Valor do Pagamento. (Tipo do Dado: Decimal.)
{param64}: Número da Parcela da Fatura. (Tipo do Dado: Inteiro.)
{param65}: Indica se a Parcela da Fatura foi Quitada. (Tipo do Dado: Booleano.)
{param66}: Indica se a Parcela da Fatura foi Conciliada. (Tipo do Dado: Booleano.)
{param67}: Forma de Pagamento da Fatura. (Opções: 1 - Dinheiro, 2 - Deposito, 3 - Cheque, 4 - DebitoEmContaCorrente, 5 - TransferenciaBancaria, 6 - CartaoCredito, 7 - CartaoDebito, 8 - DOC, 9 - TED, 10 - TransferenciaAplicativo, 11 - TransferenciaMoedaVirtual, 12 - InternetBanking, 13 - BoletoBancario, 14 - DescontoEmFolha, 15 - Outros, 16 - DebitoConta. Tipo do Dado: Inteiro.)
{param68}: Nome da Forma de Pagamento da Fatura. (Tipo do Dado: Texto.)
{param69}: Indica se a Fatura emite Boleto. (Tipo do Dado: Booleano.)
{param70}: Observação do Boleto. (Tipo do Dado: Texto.)
{param71}: Id BomControle do Boleto. (Tipo do Dado: Inteiro.)
{param72}: Link do Boleto. (Tipo do Dado: Texto.)
{param73}: Indica se a Fatura emite Nota Fiscal. (Tipo do Dado: Booleano.)
{param74}: Observação da Nota Fiscal. (Tipo do Dado: Texto.)
{param75}: Link do Arquivo da Nota Fiscal. (Tipo do Dado: Texto.)
{param76}: Link do Xml da Nota Fiscal. (Tipo do Dado: Texto.)
{param77}: Indica se o Cliente vai pagar. (Tipo do Dado: Booleano.)
{param78}: Valor Total da Venda. (Tipo do Dado: Decimal.)
{param79}: Valor Definitivo. (Tipo do Dado: Boleano.)
{param80}: Data Previsão de Entrega. (Tipo do Dado: Texto.)
{param81}: Observação. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","Venda","Obter","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"3a4d40b3-1500-43be-a9e2-17d198be29f5","name":"Venda - Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Obter/1"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 15:54:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"2853"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"Empresa\": {\r\n \"Id\": 1,\r\n \"Documento\": \"12345678000100\",\r\n \"Nome\": \"Teste\",\r\n \"Padrao\": false\r\n },\r\n \"Cliente\": {\r\n \"Id\": 1,\r\n \"TipoPessoa\": \"Fisica\",\r\n \"PaisOrigem\": \"Brasil\",\r\n \"PessoaFisica\": {\r\n \"Documento\": \"12345678900\",\r\n \"Nome\": \"Teste\",\r\n \"Sexo\": \"M\",\r\n \"DataNascimento\": null\r\n },\r\n \"PessoaJuridica\": null,\r\n \"Bloqueado\": false,\r\n \"Endereco\": {\r\n \"Id\": 1,\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdCliente\": 1,\r\n \"IdFornecedor\": 0,\r\n \"IdFuncionario\": 0,\r\n \"Nome\": \"Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": null,\r\n \"Padrao\": true,\r\n \"Cobranca\": false\r\n }\r\n ]\r\n },\r\n \"Servicos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdVenda\": 1,\r\n \"IdServico\": 1,\r\n \"Quantidade\": 1.00000,\r\n \"ValorUnitario\": 1.00000\r\n }\r\n ],\r\n \"Faturas\": [\r\n {\r\n \"Id\": 1,\r\n \"IdParcela\": \"a7f179a2-73f5-46ee-b951-249737a5dc32\",\r\n \"IdMovimentacaoFinanceira\": \"d85fbed5-5392-4b46-8c46-264d53aaee1e\",\r\n \"TipoFatura\": 0,\r\n \"NomeTipoFatura\": \"Faturamento\",\r\n \"DataVencimento\": \"2020-01-01T00:00:00\",\r\n \"DataCompetencia\": \"2020-01-01T00:00:00\",\r\n \"Valor\": 1.00000,\r\n \"DataPagamento\": null,\r\n \"ValorPagamento\": 0.0,\r\n \"NumeroParcela\": 1,\r\n \"Quitado\": false,\r\n \"Conciliado\": false,\r\n \"FormaPagamento\": 13,\r\n \"NomeFormaPagamento\": \"BoletoBancario\",\r\n \"EmiteBoleto\": true,\r\n \"ObservacaoBoleto\": null,\r\n \"IdBoleto\": 1,\r\n \"LinkBoleto\": null,\r\n \"EmiteNotaFiscal\": true,\r\n \"ObservacaoNotaFiscal\": null,\r\n \"LinkNotaFiscal\": null,\r\n \"LinkXmlNotaFiscal\": null,\r\n \"DataPromessaPagamento\": null,\r\n \"ClienteNaoVaiPagar\": false\r\n }\r\n ],\r\n \"Valor\": 1.00000\r\n}"}],"_postman_id":"66e3ced5-10cd-41ae-a5e6-7307520e3372"},{"name":"Venda - Pesquisar","id":"fed5fb5b-8ffb-409a-8e1a-45c91bed97c0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Pesquisar","description":"

Obtem os dados da Venda do BomControle pesquisada.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

pesquisa: Pesquisa a Venda pelo nome ou documento do cliente da Venda. (Obrigatório. Tipo do Dado: Texto.)
cancelado: Pesquisa a Venda pelo status da venda. (Opcional. Tipo do Dado: Booleano.)

\n\n

Response

Retorna um array de objetos com os dados da Venda:

[\n    {\n      \"Id\": {param1},\n      \"Empresa\": {param2} {\n        \"Id\": {param3},\n        \"Documento\": {param4},\n        \"Nome\": {param5},\n        \"Padrao\": {param6}\n      },\n      \"Cliente\": {param7} {\n        \"Id\": {param8},\n        \"TipoPessoa\": {param9},\n        \"PaisOrigem\": {param10},\n        \"PessoaFisica\": {param11} {\n          \"Documento\": {param12},\n          \"Nome\": {param13},\n          \"Sexo\": {param14},\n          \"DataNascimento\": {param15}\n        },\n        \"PessoaJuridica\": {param16} {\n          \"Documento\": {param17},\n          \"NomeFantasia\": {param18},\n          \"RazaoSocial\": {param19},\n          \"IsentoInscricaoEstadual\": {param20},\n          \"InscricaoEstadual\": {param21},\n          \"UFInscricaoEstadual\": {param22},\n          \"InscricaoMunicipal\": {param23},\n          \"RamoAtividade\": {param24}\n        },\n        \"Bloqueado\": {param25},\n        \"Endereco\": {param26} {\n          \"Id\": {param27},\n          \"TipoLogradouro\": {param28},\n          \"Logradouro\": {param29},\n          \"Numero\": {param30},\n          \"Complemento\": {param31},\n          \"Bairro\": {param32},\n          \"Cep\": {param33},\n          \"Cidade\": {param34},\n          \"Uf\": {param35}\n        },\n        \"Contatos\": {param36} [\n          {\n            \"Id\": {param37},\n            \"IdCliente\": {param38},\n            \"IdFornecedor\": {param39},\n            \"IdFuncionario\": {param40},\n            \"Nome\": {param41},\n            \"Email\": {param42},\n            \"Telefone\": {param43},\n            \"Padrao\": {param44},\n            \"Cobranca\": {param45}\n          }\n        ]\n      },\n      \"Servicos\": {param46} [\n        {\n          \"Id\": {param47},\n          \"IdVenda\": {param48},\n          \"IdServico\": {param49},\n          \"Quantidade\": {param50},\n          \"ValorUnitario\": {param51}\n        }\n      ],\n      \"Faturas\": {param52} [\n        {\n          \"Id\": {param53},\n          \"IdParcela\": {param54},\n          \"IdMovimentacaoFinanceira\": {param55},\n          \"TipoFatura\": {param56},\n          \"NomeTipoFatura\": {param57},\n          \"DataVencimento\": {param58},\n          \"DataCompetencia\": {param59},\n          \"Valor\": {param60},\n          \"DataPagamento\": {param61},\n          \"ValorPagamento\": {param62},\n          \"NumeroParcela\": {param63},\n          \"Quitado\": {param64},\n          \"Conciliado\": {param65},\n          \"FormaPagamento\": {param66},\n          \"NomeFormaPagamento\": {param67},\n          \"EmiteBoleto\": {param68},\n          \"ObservacaoBoleto\": {param69},\n          \"IdBoleto\": {param70},\n          \"LinkBoleto\": {param71},\n          \"EmiteNotaFiscal\": {param72},\n          \"ObservacaoNotaFiscal\": {param73},\n          \"LinkNotaFiscal\": {param74},\n          \"LinkXmlNotaFiscal\": {param75},\n          \"ClienteNaoVaiPagar\": {param76}\n        }\n      ],\n      \"Valor\": {param77}\n    }\n]\n\n

Paramêtros

{param1}: Id BomControle da Venda. (Tipo do Dado: Inteiro.)
{param2}: Objteto contendo os dados da Empresa da Venda. (Tipo do Dado: Objeto.)
{param3}: Id BomControle da Empresa. (Tipo do Dado: Inteiro.)
{param4}: Cnpj da Empresa. (Tipo do Dado: Texto.)
{param5}: Nome da Empresa. (Tipo do Dado: Texto.)
{param6}: Indica se a Empresa é a principal do BomControle. (Tipo do Dado: Booleano.)
{param7}: Objteto contendo os dados do Cliente da Venda. (Tipo do Dado: Objeto.)
{param8}: Id BomControle do Cliente. (Tipo do Dado: Inteiro.)
{param9}: Tipo de Pessoa do Cliente. (Opções: Juridica, Fisca. Tipo do Dado: Texto.)
{param10}: País de Origem do Cliente. (Tipo do Dado: Texto.)
{param11}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Física. Nullo caso seja TipoPessoa Jurídica. (Tipo do Dado: Objeto.)
{param12}: Cpf do Cliente. (Tipo do Dado: Texto.)
{param13}: Nome do Cliente. (Tipo do Dado: Texto.)
{param14}: Sexo do Cliente. (Opções: M, F, O. Tipo do Dado: Texto.)
{param15}: Data de nascimento do Cliente. (Tipo do Dado: Texto.)
{param16}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Jurídica. Nullo caso seja TipoPessoa Física. (Tipo do Dado: Objeto.)
{param17}: Cnpj do Cliente. (Tipo do Dado: Texto.)
{param18}: Nome Fantasia do Cliente. (Tipo do Dado: Texto.)
{param19}: Razão Social do Cliente. (Tipo do Dado: Texto.)
{param20}: Indica se o Cliente é isento da Inscricao Estadual. (Tipo do Dado: Texto.)
{param21}: Número da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param22}: Estado da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param23}: Número da Inscricao Municipal do Cliente. (Tipo do Dado: Texto.)
{param24}: Ramo de atividade do Cliente. (Tipo do Dado: Texto.)
{param25}: Indica se o Cliente esta bloqueado no BomControle. (Tipo do Dado: Booleano.)
{param26}: Objeto com os dados de endereço do Cliente. (Tipo do Dado: Objeto.)
{param27}: Id do endereço do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param28}: Tipo de logradouro do Cliente. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param29}: Logradouro do Cliente. (Tipo do Dado: Texto.)
{param30}: Número do logradouro do Cliente. (Tipo do Dado: Texto.)
{param31}: Complemento do logradouro do Cliente. (Tipo do Dado: Texto.)
{param32}: Bairro do logradouro do Cliente. (Tipo do Dado: Texto.)
{param33}: Cep do logradouro do Cliente. (Tipo do Dado: Texto.)
{param34}: Cidade do logradouro do Cliente. (Tipo do Dado: Texto.)
{param35}: Sigla do Estado do logradouro do Cliente. (Tipo do Dado: Texto.)
{param36}: Array de Objetos com os dados de contatos do Cliente. (Tipo do Dado: Array de Objetos.)
{param37}: Id do contato do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param38}: Id do Cliente no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param39}: Não utilizado. (Tipo do Dado: Inteiro.)
{param40}: Não utilizado. (Tipo do Dado: Inteiro.)
{param41}: Nome do contato do Cliente. (Tipo do Dado: Texto.)
{param42}: E-mail do contato do Cliente. (Tipo do Dado: Texto.)
{param43}: Telefone do contato do Cliente. (Tipo do Dado: Texto.)
{param44}: Indica se é o contato principal do Cliente. (Tipo do Dado: Booleano.)
{param45}: Indica se o contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)
{param46}: Array contendo os dados dos Serviços da Venda. (Tipo do Dado: Array de Objetos.)
{param47}: Id BomControle do Item da Venda. (Tipo do Dado: Inteiro.)
{param48}: Id BomControle da Venda. (Tipo do Dado: Inteiro.)
{param49}: Id BomControle do Serviço. (Tipo do Dado: Inteiro.)
{param50}: Quantidade do Serviço. (Tipo do Dado: Decimal.)
{param51}: Valor Unitário do Serviço. (Tipo do Dado: Decimal.)
{param52}: Array contendo as Faturas da Venda. (Tipo do Dado: Array de Objetos.)
{param53}: Id BomControle da Fatura. (Tipo do Dado: Inteiro.)
{param54}: Id BomControle da Parcela. (Tipo do Dado: Texto.)
{param55}: Id BomControle da Movimentação. (Tipo do Dado: Texto.)
{param56}: Id BomControle do Tipo da Fatura. (Opções: 0 - Faturamento, 1 - Renegociacao. Tipo do Dado: Inteiro.)
{param57}: Nome do Tipo da Fatura. (Tipo do Dado: Texto.)
{param58}: Data de Vencimento da Fatura. (Tipo do Dado: Texto.)
{param59}: Data de Competência da Parcela da Fatura. (Tipo do Dado: Texto.)
{param60}: Valor da Fatura. (Tipo do Dado: Decimal.)
{param61}: Data de Pagamento da Parcela da Fatura. (Tipo do Dado: Texto.)
{param62}: Valor do Pagamento. (Tipo do Dado: Decimal.)
{param63}: Número da Parcela da Fatura. (Tipo do Dado: Inteiro.)
{param64}: Indica se a Parcela da Fatura foi Quitada. (Tipo do Dado: Booleano.)
{param65}: Indica se a Parcela da Fatura foi Conciliada. (Tipo do Dado: Booleano.)
{param66}: Forma de Pagamento da Fatura. (Opções: 1 - Dinheiro, 2 - Deposito, 3 - Cheque, 4 - DebitoEmContaCorrente, 5 - TransferenciaBancaria, 6 - CartaoCredito, 7 - CartaoDebito, 8 - DOC, 9 - TED, 10 - TransferenciaAplicativo, 11 - TransferenciaMoedaVirtual, 12 - InternetBanking, 13 - BoletoBancario, 14 - DescontoEmFolha, 15 - Outros, 16 - DebitoConta. Tipo do Dado: Inteiro.)
{param67}: Nome da Forma de Pagamento da Fatura. (Tipo do Dado: Texto.)
{param68}: Indica se a Fatura emite Boleto. (Tipo do Dado: Booleano.)
{param69}: Observação do Boleto. (Tipo do Dado: Texto.)
{param70}: Id BomControle do Boleto. (Tipo do Dado: Inteiro.)
{param71}: Link do Boleto. (Tipo do Dado: Texto.)
{param72}: Indica se a Fatura emite Nota Fiscal. (Tipo do Dado: Booleano.)
{param73}: Observação da Nota Fiscal. (Tipo do Dado: Texto.)
{param74}: Link do Arquivo da Nota Fiscal. (Tipo do Dado: Texto.)
{param75}: Link do Xml da Nota Fiscal. (Tipo do Dado: Texto.)
{param76}: Indica se o Cliente vai pagar. (Tipo do Dado: Booleano.)
{param77}: Valor Total da Venda. (Tipo do Dado: Decimal.)

","urlObject":{"protocol":"https","path":["integracao","Venda","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"c0a01710-1f4e-4162-b8c7-c937ddd7fd34","name":"Venda - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Pesquisar?pesquisa=teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Venda","Pesquisar"],"query":[{"key":"pesquisa","value":"teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 16:57:51 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"2670"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"Empresa\": {\r\n \"Id\": 1,\r\n \"Documento\": \"12345678000100\",\r\n \"Nome\": \"Teste\",\r\n \"Padrao\": true\r\n },\r\n \"Cliente\": {\r\n \"Id\": 1,\r\n \"TipoPessoa\": \"Fisica\",\r\n \"PaisOrigem\": \"Brasil\",\r\n \"PessoaFisica\": {\r\n \"Documento\": \"12345678900\",\r\n \"Nome\": \"Teste\",\r\n \"Sexo\": null,\r\n \"DataNascimento\": null\r\n },\r\n \"PessoaJuridica\": null,\r\n \"Bloqueado\": false,\r\n \"Endereco\": {\r\n \"Id\": 1,\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": []\r\n },\r\n \"Servicos\": null,\r\n \"Faturas\": null,\r\n \"Valor\": 10.00000\r\n }\r\n]"}],"_postman_id":"fed5fb5b-8ffb-409a-8e1a-45c91bed97c0"},{"name":"Venda - Criar","id":"f4418d92-45da-46f7-bd8e-045b80ec0e82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Criar","description":"

Realiza o cadastro de uma nova Venda no BomControle.

Request

Os dados enviados para a API devem ser informados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Body

{\n  \"IdCliente\": {param1},\n  \"IdEmpresa\": {param2},\n  \"FormaPagamento\": {param3} {\n    \"Boleto\": {param4} {\n      \"Observacao\": {param5}\n    },\n    \"DepositoConta\": {param6} {\n      \"NumeroBanco\": {param7},\n      \"NumeroAgencia\": {param8},\n      \"NumeroConta\": {param9}\n    },\n    \"Outros\": {param10} {\n      \"Nome\": {param11}\n    }\n  },\n  \"NotaFiscal\": {param12} {\n    \"Observacao\": {param13}\n  },\n  \"Desconto\": {param14} {\n    \"Percentual\": {param15},\n    \"DataFim\": {param16}\n  },\n  \"Servicos\": {param17} [\n    {\n      \"IdServico\": {param18},\n      \"Quantidade\": {param19},\n      \"ValorUnitario\": {param20},\n      \"ValorDesconto\": {param21}\n    }\n  ],\n  \"PrimeiroVencimento\": {param22},\n  \"Data\": {param23},\n  \"QuatidadeParcelas\": {param24},\n  \"DataPrevisaoEntrega\": {param25},\n  \"Observacao\": {param26},\n  \"ObservacaoParcelas\": {param27}\n}\n\n

Paramêtros

{param1}: Id BomControle do Cliente. (Obrigatório. Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Empresa. (Obrigatório. Tipo do Dado: Inteiro.)
{param3}: Objeto contendo as Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param4}: Objeto contendo os dados para Boleto. Informar apenas quando houver emissão (Opcional.Tipo do Dado: Objeto.)
{param5}: Observação do Boleto. (Opcional.Tipo do Dado: Texto.)
{param6}: Objeto contendo os dados para Depósito em Conta. (Opcional.Tipo do Dado: Objeto.)
{param7}: Número do Banco. (Opcional.Tipo do Dado: Texto.)
{param8}: Número da Agência. (Opcional.Tipo do Dado: Texto.)
{param9}: Número da Conta. (Opcional. Tipo do Dado: Texto.)
{param10}: Objeto contendo os dados para outras Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param11}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param12}: Objeto contendo os dados para Emissão de Nota Fiscal. Informar apenas quando houver emissão (Opcional. Tipo do Dado: Texto.)
{param13}: Observação da Nota Fiscal. (Opcional. Tipo do Dado: Booleano.)
{param14}: Não utilizado. (Opcional. Tipo do Dado: Objeto.)
{param15}: Não utilizado. (Opcional. Tipo do Dado: Decimal.)
{param16}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param17}: Array de Objetos contendo os dados dos Serviços. (Obrigatório. Tipo do Dado: Array de Objetos.)
{param18}: Id BomControle do Serviço. (Obrigatório. Tipo do Dado: Inteiro.)
{param19}: Quantidade do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param20}: Valor Unitário do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param21}: Valor Desconto Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param22}: Data de Vencimento da Primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param23}: Data da Venda. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param24}: Quantidade de Parcelas. (Opcional. Tipo do Dado: Inteiro.)
{param25}: Data Previsão de Entrega. (Opcional. Tipo do Dado: Texto.)
{param26}: Observação da Venda. (Opcional. Tipo do Dado: Texto.)
{param27}: Observação das Parcelas da Venda. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Retorna o Id da Venda cadastrada no BomControle. (Tipo do Dado: Inteiro.)

\n","urlObject":{"protocol":"https","path":["integracao","Venda","Criar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"81c30546-03d1-4897-92f5-39e0c2302d24","name":"Venda - Criar","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"IdCliente\": 1,\r\n \"IdEmpresa\": 1,\r\n \"FormaPagamento\": {\r\n \"Boleto\": {\r\n \"Observacao\": null\r\n }\r\n },\r\n \"NotaFiscal\": {\r\n \"Observacao\": null\r\n },\r\n \"Desconto\": {\r\n \"Percentual\": 0,\r\n \"DataFim\": \"2020-01-01 00:00:00\"\r\n },\r\n \"Servicos\": [\r\n {\r\n \"IdServico\": 305,\r\n \"Quantidade\": 1,\r\n \"ValorUnitario\": 10,\r\n \"ValorDesconto\": 0\r\n }\r\n ],\r\n \"PrimeiroVencimento\": \"2020-01-01 00:00:00\",\r\n \"Data\": \"2020-01-01 00:00:00\",\r\n \"QuatidadeParcelas\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Criar"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 19:22:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"IdVenda\": 1,\r\n \"IdContrato\": 0,\r\n \"IdFatura\": 1\r\n}"}],"_postman_id":"f4418d92-45da-46f7-bd8e-045b80ec0e82"},{"name":"Venda - Cancelar","id":"067b22b4-f684-4266-929a-531ed9071367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Cancelar/{id}","description":"

Realiza o cancelamento da Venda no BomControle.

Request

O request para essa API é feito informando a identificação da Venda diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id da Venda dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"DataCompetencia\": {param1},\n  \"Motivo\": {param2}\n}\n

Paramêtros

{param1}: Data do cancelamento da Venda. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param2}: Motivo do cancelamento da Venda. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Venda","Cancelar","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"f544af5e-e914-460a-adf9-9534c7413ba4","name":"Venda - Cancelar","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"DataCompetencia\": \"2020-01-01 00:00:00\",\r\n \"Motivo\": \"Teste\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Cancelar/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 05 Feb 2020 11:32:13 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"067b22b4-f684-4266-929a-531ed9071367"},{"name":"Venda - Alterar Fatura","id":"619ffb4e-04c5-4e06-83f1-f51c4af7e927","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/AlterarFatura","description":"

Altera os dados da Fatura da Venda solicitada.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

idFatura: Id BomControle da Fatura da Venda. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"DiaVencimento\": {param1},\n  \"DataCompetencia\": {param2},\n  \"DataVencimento\": {param3},\n  \"Servicos\": {param4} [\n    {\n      \"IdServico\": {param5},\n      \"Quantidade\": {param6},\n      \"ValorUnitario\": {param7},\n      \"ValorDesconto\": {param8}\n    }\n  ],\n  \"NotaFiscal\": {param9} {\n    \"Observacao\": {param10}\n  }\n}\n

Paramêtros

{param1}: Altera o dia de Vencimento da Parcela da Fatura. (Opcional. Tipo do Dado: Inteiro.)
{param2}: Altera a data de Vencimento da Parcela da Fatura. (Obrigatório. Tipo do Dado: Texto.)
{param3}: Altera a data de Competencia da Parcela da Fatura. (Obrigatório. Tipo do Dado: Texto.)
{param4}: Array de objetos com os dados dos Serviços a serem alterados. (Obrigatório. Tipo do Dado: Array de Objetos.)
{param5}: Id BomControle do Serviço. (Obrigatório. Tipo do Dado: Inteiro.)
{param6}: Quantidade do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param7}: Valor Unitário do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param8}: Valor de Desconto do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param9}: Array de objeto com dado de Nota Fiscal. (Opcional. Tipo do Dado: Objeto.)
{param10}: Observação da Nota Fiscal. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","Venda","AlterarFatura"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"525ad329-8a90-4ac4-a908-87a1eb7596b5","name":"Venda - AlterarFatura","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"DiaVencimento\": 0,\r\n \"DataCompetencia\": \"2020-01-01 00:00:00\",\r\n \"DataVencimento\": \"2020-01-01 00:00:00\",\r\n \"Servicos\": [\r\n {\r\n \"IdServico\": 1,\r\n \"Quantidade\": 1,\r\n \"ValorUnitario\": 10,\r\n \"ValorDesconto\": 0\r\n }\r\n ],\r\n \"NotaFiscal\": {\r\n \"Observacao\": \"Teste\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/AlterarFatura?idFatura=1","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","Venda","AlterarFatura"],"query":[{"key":"idFatura","value":"1"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 05 Feb 2020 12:01:29 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"47"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"O campo Itens da Movimentação é obrigatório"}],"_postman_id":"619ffb4e-04c5-4e06-83f1-f51c4af7e927"},{"name":"Venda - Criar Venda Produto Serviço","id":"5fa4727a-0c0c-48be-8b25-85c0d1147481","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/CriarVendaProdutoServico","description":"

Realiza o cadastro de uma nova Venda, que pode conter Produtos e Serviços, no BomControle.

Request

Os dados enviados para a API devem ser informados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Body

{\n  \"IdCliente\": {param1},\n  \"IdEmpresa\": {param2},\n  \"FormaPagamento\": {param3} {\n    \"Boleto\": {param4} {\n      \"Observacao\": {param5}\n    },\n    \"DepositoConta\": {param6} {\n      \"NumeroBanco\": {param7},\n      \"NumeroAgencia\": {param8},\n      \"NumeroConta\": {param9}\n    },\n    \"Pix\": {param10} {\n      \"EmiteQrCodePix\": {param11}\n    },\n    \"Outros\": {param12} {\n      \"Nome\": {param13}\n    }\n  },\n  \"NotaFiscalServico\": {param14} {\n    \"Emite\": {param15},\n    \"Observacao\": {param16},\n    \"NotaFiscalTotal\": {param17}\n  },\n  \"Desconto\": {param18} {\n    \"Percentual\": {param19},\n    \"DataFim\": {param20}\n  },\n  \"Frete\": {param21} {\n    \"ValorFrete\": {param22}\n  },\n  \"OutrasDespesas\": {param23} {\n    \"ValorOutrasDespesas\": {param24}\n  },\n  \"Itens\": {param25} [\n    {\n      \"IdProduto\": {param26},\n      \"IdServico\": {param27},\n      \"Descricao\": {param28},\n      \"Quantidade\": {param29},      \n      \"ValorUnitario\": {param30},\n      \"ValorDesconto\": {param31}\n    }\n  ],\n  \"PrimeiroVencimento\": {param32},\n  \"Data\": {param33},\n  \"QuatidadeParcelas\": {param34},\n  \"DataPrevisaoEntrega\": {param35},\n  \"Observacao\": {param36},\n  \"ObservacaoParcelas\": {param37}\n}\n\n

Paramêtros

{param1}: Id BomControle do Cliente. (Obrigatório. Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Empresa. (Obrigatório. Tipo do Dado: Inteiro.)
{param3}: Objeto contendo as Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param4}: Objeto contendo os dados para Boleto. Informar apenas quando houver emissão (Opcional.Tipo do Dado: Objeto.)
{param5}: Observação do Boleto. (Opcional.Tipo do Dado: Texto.)
{param6}: Objeto contendo os dados para Depósito em Conta. (Opcional.Tipo do Dado: Objeto.)
{param7}: Número do Banco. (Opcional.Tipo do Dado: Texto.)
{param8}: Número da Agência. (Opcional.Tipo do Dado: Texto.)
{param10}: Objeto contendo os dados para Pix. Informar apenas quando houver emissão (Opcional. Tipo do Dado: Objeto.)
{param11}: Indica se emitirá QR Code Pix (Opcional. Tipo do Dado: Boleano.)
{param12}: Objeto contendo os dados para outras Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param13}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param14}: Objeto contendo os dados para Emissão de Nota Fiscal. Informar apenas quando houver emissão (Opcional. Tipo do Dado: Texto.)
{param15}: Indica se emitirá nota fiscal de serviço (Opcional. Tipo do Dado: Boleano.)
{param16}: Observação da Nota Fiscal. (Opcional. Tipo do Dado: Texto.)
{param17}: Indica se emitirá uma única nota no valor total da venda. (Opcional. Tipo do Dado: Boleano.)
{param18}: Não utilizado. (Opcional. Tipo do Dado: Objeto.)
{param19}: Não utilizado. (Opcional. Tipo do Dado: Decimal.)
{param20}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param21}: Objeto contendo os dados de Frete. Informar apenas quando houver frete (Opcional. Tipo do Dado: Objeto.)
{param22}: Valor do Frete na Venda. (Opcional. Tipo do Dado: Decimal.)
{param23}: Objeto contendo os dados de Outras Despesas. Informar apenas quando houver outras despesas (Opcional. Tipo do Dado: Objeto.)
{param24}: Valor de Outras Despesas na Venda. (Opcional. Tipo do Dado: Decimal.)
{param25}: Array de Objetos contendo os dados dos Itens. (Obrigatório. Tipo do Dado: Array de Objetos.)
{param26}: Id BomControle do Produto. (Obrigatório. Tipo do Dado: Inteiro.)
{param27}: Id BomControle do Serviço. (Obrigatório. Tipo do Dado: Inteiro.)
{param28}: Descrição do Item. (Opcional. Tipo do Dado: Texto.)
{param29}: Quantidade do Item. (Obrigatório. Tipo do Dado: Decimal.)
{param30}: Valor Unitário do Item. (Obrigatório. Tipo do Dado: Decimal.)
{param31}: Valor Desconto do Item. (Obrigatório. Tipo do Dado: Decimal.)
{param32}: Data de Vencimento da Primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param33}: Data da Venda. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param34}: Quantidade de Parcelas. (Opcional. Tipo do Dado: Inteiro.)
{param35}: Data Previsão de Entrega. (Opcional. Tipo do Dado: Texto.)
{param36}: Observação da Venda. (Opcional. Tipo do Dado: Texto.)
{param37}: Observação das Parcelas da Venda. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Retorna o Id da Venda cadastrada no BomControle. (Tipo do Dado: Inteiro.)

\n","urlObject":{"protocol":"https","path":["integracao","Venda","CriarVendaProdutoServico"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"6758f7a9-bd13-40d5-befb-85663ff8c7b6","name":"Venda - Criar","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"IdCliente\": 1,\r\n \"IdEmpresa\": 1,\r\n \"FormaPagamento\": {\r\n \"Boleto\": {\r\n \"Observacao\": null\r\n }\r\n },\r\n \"NotaFiscal\": {\r\n \"Observacao\": null\r\n },\r\n \"Desconto\": {\r\n \"Percentual\": 0,\r\n \"DataFim\": \"2020-01-01 00:00:00\"\r\n },\r\n \"Servicos\": [\r\n {\r\n \"IdServico\": 305,\r\n \"Quantidade\": 1,\r\n \"ValorUnitario\": 10,\r\n \"ValorDesconto\": 0\r\n }\r\n ],\r\n \"PrimeiroVencimento\": \"2020-01-01 00:00:00\",\r\n \"Data\": \"2020-01-01 00:00:00\",\r\n \"QuatidadeParcelas\": 1\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/Venda/Criar"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Tue, 04 Feb 2020 19:22:39 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"IdVenda\": 1,\r\n \"IdContrato\": 0,\r\n \"IdFatura\": 1\r\n}"}],"_postman_id":"5fa4727a-0c0c-48be-8b25-85c0d1147481"}],"id":"fcb12aff-0895-437f-8180-7aae105814e8","description":"

APIs para modificação das Vendas do BomControle.

\n","event":[{"listen":"prerequest","script":{"id":"89ec1fff-466b-45f2-9bbe-17321bd81106","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"cdfbbd15-f796-4c2d-918a-7a7c6e960112","type":"text/javascript","exec":[""]}}],"_postman_id":"fcb12aff-0895-437f-8180-7aae105814e8"},{"name":"VendaContrato","item":[{"name":"VendaContrato - Obter","id":"00a42e51-7e2b-46fb-85b3-dd34d4473ef3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/Obter/{id}","description":"

Obtem os dados do Contrato solicitado.

Request

O request para essa API é feito a identificação do Contrato e através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: Id BomControle do Contrato. (Obrigatório. Tipo do Dado: Inteiro.)
quitadas: Indica se busca apenas Faturas Quitadas. Usado para filtrar apenas os dados das Faturas. (Opcional. Tipo do Dado: Booleano.)
inicioPeriodo: Indica se busca apenas Faturas com Data de Vencimento superior a data informada. Usado para filtrar apenas os dados das Faturas. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
terminoPeriodo: Indica se busca apenas Faturas com Data de Vencimento inferior a data informada. Usado para filtrar apenas os dados das Faturas. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)

\n\n

Response

Retorna um objeto contendo os dados do Contrato.

Body

{\n  \"Id\": {param1},\n  \"Inicio\": {param2},\n  \"Termino\": {param3},\n  \"TipoPagamento\": {param4},\n  \"NomeTipoPagamento\": {param5},\n  \"Encerrado\": {param6},\n  \"DataEncerramento\": {param7},\n  \"Empresa\": {param8} {\n    \"Id\": {param9},\n    \"Documento\": {param10},\n    \"Nome\": {param11},\n    \"Padrao\": {param12}\n  },\n  \"Cliente\": {param13} {\n    \"Id\": {param14},\n    \"TipoPessoa\": {param15},\n    \"PaisOrigem\": {param16},\n    \"PessoaFisica\": {param17} {\n      \"Documento\": {param18},\n      \"Nome\": {param19},\n      \"Sexo\": {param20},\n      \"DataNascimento\": {param21}\n    },\n    \"PessoaJuridica\": {param22} {\n      \"Documento\": {param23},\n      \"NomeFantasia\": {param24},\n      \"RazaoSocial\": {param25},\n      \"IsentoInscricaoEstadual\": {param26},\n      \"InscricaoEstadual\": {param27},\n      \"UFInscricaoEstadual\": {param28},\n      \"InscricaoMunicipal\": {param29},\n      \"RamoAtividade\": {param30}\n    },\n    \"Bloqueado\": {param31},\n    \"Endereco\": {param32} {\n      \"Id\": {param33},\n      \"TipoLogradouro\": {param34},\n      \"Logradouro\": {param35},\n      \"Numero\": {param36},\n      \"Complemento\": {param37},\n      \"Bairro\": {param38},\n      \"Cep\": {param39},\n      \"Cidade\": {param40},\n      \"Uf\": {param41}\n    },\n    \"Contatos\": {param42} [\n      {\n        \"Id\": {param43},\n        \"IdCliente\": {param44},\n        \"IdFornecedor\": {param45},\n        \"IdFuncionario\": {param46},\n        \"Nome\": {param47},\n        \"Email\": \"{param48},\n        \"Telefone\": {param49},\n        \"Padrao\": {param50},\n        \"Cobranca\": {param51}\n      }\n    ]\n  },\n  \"Servicos\": {param52} [\n    {\n      \"Id\": {param53},\n      \"IdVenda\": {param54},\n      \"Nome\": {param55},\n      \"IdServico\": {param56},\n      \"Quantidade\": {param57},\n      \"ValorUnitario\": {param58},\n      \"ValorDesconto\": {param59}\n    }\n  ],\n  \"Valor\": {param60},\n  \"Periodicidade\": {param61},\n  \"Faturas\": {param62} [\n    {\n      \"Id\": {param63},\n      \"IdParcela\": {param64},\n      \"IdMovimentacaoFinanceira\": {param65},\n      \"TipoFatura\": {param66},\n      \"NomeTipoFatura\": {param67},\n      \"DataVencimento\": {param68},\n      \"DataCompetencia\": {param69},\n      \"Valor\": {param70},\n      \"DataPagamento\": {param71},\n      \"ValorPagamento\": {param72},\n      \"NumeroParcela\": {param73},\n      \"Quitado\": {param74},\n      \"Conciliado\": {param75},\n      \"FormaPagamento\": {param76},\n      \"NomeFormaPagamento\": {param77},\n      \"EmiteBoleto\": {param78},\n      \"ObservacaoBoleto\": {param79},\n      \"IdBoleto\": {param80},\n      \"LinkBoleto\": {param81},\n      \"EmiteNotaFiscal\": {param82},\n      \"ObservacaoNotaFiscal\": {param83},\n      \"LinkNotaFiscal\": {param84},\n      \"LinkXmlNotaFiscal\": {param85},\n      \"DataPromessaPagamento\": {param86},\n      \"ClienteNaoVaiPagar\": {param87}\n    }\n  ],\n  \"ProximoReajuste\": {param88},\n  \"IndiceReajuste\": {param89},\n  \"NomeIndiceReajuste\": {param90},\n  \"PeriodoReajuste\": {param91},\n  \"NomePeriodoReajuste\": {param92}\n}\n

Paramêtros

{param1}: Id BomControle do Contrato. (Tipo do Dado: Inteiro.)
{param2}: Data de Início do Contrato. (Tipo do Dado: Texto.)
{param3}: Data de Término do Contrato. (Tipo do Dado: Texto.)
{param4}: Tipo do Contrato. (Opções: 0 - Recorrente, 1 - Parcelado. Tipo do Dado: Inteiro)
{param5}: Nome do Tipo do Contrato. (Tipo do Dado: Texto.)
{param6}: Indica se o Contrato foi Encerrado. (Tipo do Dado: Booleano.)
{param7}: Data de Encerramento do Contrato. (Tipo do Dado: Texto.)
{param8}: Objeto contendo os dados da Empresa do Contrato. (Tipo do Dado: Objeto.)
{param9}: Id BomControle da Empresa. (Tipo do Dado: Inteiro.)
{param10}: Cnpj da Empresa. (Tipo do Dado: Texto.)
{param11}: Nome da Empresa. (Tipo do Dado: Texto.)
{param12}: Indica se é a Empresa principal do BomControle. (Tipo do Dado: Booleano.)
{param13}: Objeto contendo os dados do Cliente do Contrato. (Tipo do Dado: Objeto.)
{param14}: Id BomControle do Cliente. (Tipo do Dado: Inteiro.)
{param15}: Tipo Pessoa do Cliente. (Opções: Juridica, Fisica. Tipo do Dado: Texto.)
{param16}: País Origem do Cliente. (Opções: Juridica, Fisica. Tipo do Dado: Texto.)
{param17}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Física. Nullo caso seja TipoPessoa Jurídica. (Tipo do Dado: Objeto.)
{param18}: Cpf do Cliente. (Tipo do Dado: Texto.)
{param19}: Nome do Cliente. (Tipo do Dado: Texto.)
{param20}: Sexo do Cliente. (Opções: M, F, O. Tipo do Dado: Texto.)
{param21}: Data de nascimento do Cliente. (Tipo do Dado: Texto.)
{param22}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Jurídica. Nullo caso seja TipoPessoa Física. (Tipo do Dado: Objeto.)
{param23}: Cnpj do Cliente. (Tipo do Dado: Texto.)
{param24}: Nome Fantasia do Cliente. (Tipo do Dado: Texto.)
{param25}: Razão Social do Cliente. (Tipo do Dado: Texto.)
{param26}: Indica se o Cliente é isento da Inscricao Estadual. (Tipo do Dado: Texto.)
{param27}: Número da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param28}: Estado da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param29}: Número da Inscricao Municipal do Cliente. (Tipo do Dado: Texto.)
{param30}: Ramo de atividade do Cliente. (Tipo do Dado: Texto.)
{param31}: Indica se o Cliente esta bloqueado no BomControle. (Tipo do Dado: Booleano.)
{param32}: Objeto com os dados de endereço do Cliente. (Tipo do Dado: Objeto.)
{param33}: Id do endereço do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param34}: Tipo de logradouro do Cliente. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param35}: Logradouro do Cliente. (Tipo do Dado: Texto.)
{param36}: Número do logradouro do Cliente. (Tipo do Dado: Texto.)
{param37}: Complemento do logradouro do Cliente. (Tipo do Dado: Texto.)
{param38}: Bairro do logradouro do Cliente. (Tipo do Dado: Texto.)
{param39}: Cep do logradouro do Cliente. (Tipo do Dado: Texto.)
{param40}: Cidade do logradouro do Cliente. (Tipo do Dado: Texto.)
{param41}: Sigla do Estado do logradouro do Cliente. (Tipo do Dado: Texto.)
{param42}: Array de Objetos com os dados de contatos do Cliente. (Tipo do Dado: Array de Objetos.)
{param43}: Id do contato do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param44}: Id do Cliente no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param45}: Não utilizado. (Tipo do Dado: Inteiro.)
{param46}: Não utilizado. (Tipo do Dado: Inteiro.)
{param47}: Nome do contato do Cliente. (Tipo do Dado: Texto.)
{param48}: E-mail do contato do Cliente. (Tipo do Dado: Texto.)
{param49}: Telefone do contato do Cliente. (Tipo do Dado: Texto.)
{param50}: Indica se é o contato principal do Cliente. (Tipo do Dado: Booleano.)
{param51}: Indica se o contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)
{param52}: Array de Objetos com os dados dos Serviços da Venda do Contrato. (Tipo do Dado: Array de Objetos.)
{param53}: Id BomControle do Item da Venda. (Tipo do Dado: Inteiro.)
{param54}: Id BomControle da Venda. (Tipo do Dado: Inteiro.)
{param55}: Não utilizado. (Tipo do Dado: Texto.)
{param56}: Id BomControle do Serviço. (Tipo do Dado: Inteiro.)
{param57}: Quantidade do Serviço. (Tipo do Dado: Decimal.)
{param58}: Valor Unitário do Serviço. (Tipo do Dado: Decimal.)
{param59}: Valor Desconto Serviço. (Tipo do Dado: Decimal.)
{param60}: Valor do Contrato. (Tipo do Dado: Decimal.)
{param61}: Id BomControle da Periodicidade do Contrato. (Opções: 1 - Diaria, 2 - Semanal, 3 - Quinzenal, 4 - Mensal, 5 - Anual, 6 - Trimestral, 7 - Semestral, 8 - Bimestral. Tipo do Dado: Inteiro.)
{param62}: Array de Objetos com os dados das Faturas do Contrato. (Tipo do Dado: Array de Objetos.)
{param63}: Id BomControle da Fatura. (Tipo do Dado: Inteiro.)
{param64}: Id BomControle da Parcela. (Tipo do Dado: Texto.)
{param65}: Id BomControle da Movimentação. (Tipo do Dado: Texto.)
{param66}: Id BomControle do Tipo da Fatura. (Opções: 0 - Faturamento, 1 - Renegociacao. Tipo do Dado: Inteiro.)
{param67}: Nome do Tipo da Fatura. (Tipo do Dado: Texto.)
{param68}: Data de Vencimento da Fatura. (Tipo do Dado: Texto.)
{param69}: Data de Competência da Parcela. (Tipo do Dado: Texto.)
{param70}: Valor da Fatura. (Tipo do Dado: Decimal.)
{param71}: Data de Pagamento da Parcela. (Tipo do Dado: Texto.)
{param72}: Valor do Pagamento. (Tipo do Dado: Decimal.)
{param73}: Número da Parcela. (Tipo do Dado: Inteiro.)
{param74}: Indica se a Parcela foi Quitada. (Tipo do Dado: Booleano.)
{param75}: Indica se a Parcela foi Conciliada. (Tipo do Dado: Booleano.)
{param76}: Forma de Pagamento da Fatura. (Opções: 1 - Dinheiro, 2 - Deposito, 3 - Cheque, 4 - DebitoEmContaCorrente, 5 - TransferenciaBancaria, 6 - CartaoCredito, 7 - CartaoDebito, 8 - DOC, 9 - TED, 10 - TransferenciaAplicativo, 11 - TransferenciaMoedaVirtual, 12 - InternetBanking, 13 - BoletoBancario, 14 - DescontoEmFolha, 15 - Outros, 16 - DebitoConta. Tipo do Dado: Inteiro.)
{param77}: Nome da Forma de Pagamento. (Tipo do Dado: Texto.)
{param78}: Indica se a Fatura emite Boleto. (Tipo do Dado: Booleano.)
{param79}: Observação do Boleto. (Tipo do Dado: Texto.)
{param80}: Id BomControle do Boleto. (Tipo do Dado: Inteiro.)
{param81}: Url do arquivo do Boleto. (Tipo do Dado: Texto.)
{param82}: Indica se a Fatura emite Nota Fiscal. (Tipo do Dado: Booleano.)
{param83}: Observação da Nota Fiscal. (Tipo do Dado: Texto.)
{param84}: Url do arquivo da Nota Fiscal. (Tipo do Dado: Texto.)
{param85}: Url do arquivo xml da Nota Fiscal. (Tipo do Dado: Texto.)
{param86}: Não utilizado. (Tipo do Dado: Texto.)
{param87}: Indica se o Cliente vai pagar. (Tipo do Dado: Booleano.)
{param88}: Data do Próximo Reajuste do Contrato. (Tipo do Dado: Texto.)
{param89}: Id BomControle do Indice de Reajuste. (Opções: 0 - Nenhum, 1 - IPCA, 2 - IGPM, 3 - INPC, 4 - IGPDI, 5 - INCC, 6 - Outros. Tipo do Dado: Inteiro.)
{param90}: Nome do Indice de Reajuste. (Tipo do Dado: Texto.)
{param91}: Id BomControle do Período de Reajuste. (Opções: 1 - Diaria, 2 - Semanal, 3 - Quinzenal, 4 - Mensal, 5 - Anual, 6 - Trimestral, 7 - Semestral, 8 - Bimestral. Tipo do Dado: Inteiro.)
{param92}: Nome do Período de Reajuste. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","VendaContrato","Obter","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"3f617f20-7544-418c-b0ef-d522ad69b309","name":"VendaContrato - Obter","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/Obter/1?quitadas=false&inicioPeriodo=2020-01-01%2000%3A00%3A00&terminoPeriodo=2020-01-01%2000%3A00%3A00","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","VendaContrato","Obter","1"],"query":[{"key":"quitadas","value":"false"},{"key":"inicioPeriodo","value":"2020-01-01%2000%3A00%3A00"},{"key":"terminoPeriodo","value":"2020-01-01%2000%3A00%3A00"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 05 Feb 2020 12:27:54 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"2131"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": 1,\r\n \"Inicio\": \"2020-01-01T00:00:00\",\r\n \"Termino\": null,\r\n \"TipoPagamento\": 0,\r\n \"NomeTipoPagamento\": \"Recorrente\",\r\n \"Encerrado\": false,\r\n \"DataEncerramento\": null,\r\n \"Empresa\": {\r\n \"Id\": 1,\r\n \"Documento\": \"12345678000100\",\r\n \"Nome\": \"Teste\",\r\n \"Padrao\": false\r\n },\r\n \"Cliente\": {\r\n \"Id\": 1,\r\n \"TipoPessoa\": \"Juridica\",\r\n \"PaisOrigem\": \"Brasil\",\r\n \"PessoaFisica\": null,\r\n \"PessoaJuridica\": {\r\n \"Documento\": \"12345678000100\",\r\n \"NomeFantasia\": \"Teste\",\r\n \"RazaoSocial\": \"Teste\",\r\n \"IsentoInscricaoEstadual\": true,\r\n \"InscricaoEstadual\": null,\r\n \"UFInscricaoEstadual\": \"RJ\",\r\n \"InscricaoMunicipal\": null,\r\n \"RamoAtividade\": null\r\n },\r\n \"Bloqueado\": false,\r\n \"Endereco\": {\r\n \"Id\": 1,\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdCliente\": 1,\r\n \"IdFornecedor\": 0,\r\n \"IdFuncionario\": 0,\r\n \"Nome\": \"Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": null,\r\n \"Padrao\": false,\r\n \"Cobranca\": false\r\n }\r\n ]\r\n },\r\n \"Servicos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdVenda\": 1,\r\n \"Nome\": 0,\r\n \"IdServico\": 1,\r\n \"Quantidade\": 1.00000,\r\n \"ValorUnitario\": 10.00000,\r\n \"ValorDesconto\": 0.0\r\n }\r\n ],\r\n \"Valor\": 10.00000,\r\n \"Periodicidade\": 4,\r\n \"Faturas\": [],\r\n \"ProximoReajuste\": null,\r\n \"IndiceReajuste\": 0,\r\n \"NomeIndiceReajuste\": \"Nenhum\",\r\n \"PeriodoReajuste\": 0,\r\n \"NomePeriodoReajuste\": \"0\"\r\n}"}],"_postman_id":"00a42e51-7e2b-46fb-85b3-dd34d4473ef3"},{"name":"VendaContrato - Pesquisar","id":"2a22f28d-6e7a-4bdc-a258-b07594c0e013","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/Pesquisar","description":"

Pesquisa os Contratos conforme filtro.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

pesquisa: Documento ou nome do Cliente do Contrato. (Opcional. Tipo do Dado: Inteiro.)
paginacao.itensPorPagina: Usado para definir a paginação da pesquisa, se não informado utiliza valor padrão 50. Numero maximo permitido é de 100 itens. (Opcional. Tipo do Dado: Inteiro.)
paginacao.numeroDaPagina: Usado para definir a paginação da pesquisa, se não informado utiliza valor padrão 1. (Opcional. Tipo do Dado: Inteiro.)

\n\n

Response

Retorna um array de objetos contendo os dados dos Contratos.

Body

[\n    {\n      \"Id\": {param1},\n      \"IdVenda\": {param2},\n      \"Inicio\": {param3},\n      \"Termino\": {param4},\n      \"TipoPagamento\": {param5},\n      \"NomeTipoPagamento\": {param6},\n      \"Encerrado\": {param7},\n      \"DataEncerramento\": {param8},\n      \"Empresa\": {param9} {\n        \"Id\": {param10},\n        \"Documento\": {param11},\n        \"Nome\": {param12},\n        \"Padrao\": {param13}\n      },\n      \"Cliente\": {param14} {\n        \"Id\": {param15},\n        \"TipoPessoa\": {param16},\n        \"PaisOrigem\": {param17},\n        \"PessoaFisica\": {param18} {\n          \"Documento\": {param19},\n          \"Nome\": {param20},\n          \"Sexo\": {param21},\n          \"DataNascimento\": {param22}\n        },\n        \"PessoaJuridica\": {param23} {\n          \"Documento\": {param24},\n          \"NomeFantasia\": {param25},\n          \"RazaoSocial\": {param26},\n          \"IsentoInscricaoEstadual\": {param27},\n          \"InscricaoEstadual\": {param28},\n          \"UFInscricaoEstadual\": {param29},\n          \"InscricaoMunicipal\": {param30},\n          \"RamoAtividade\": {param31}\n        },\n        \"Bloqueado\": {param32},\n        \"Endereco\": {param33} {\n          \"Id\": {param34},\n          \"TipoLogradouro\": {param35},\n          \"Logradouro\": {param36},\n          \"Numero\": {param37},\n          \"Complemento\": {param38},\n          \"Bairro\": {param39},\n          \"Cep\": {param40},\n          \"Cidade\": {param41},\n          \"Uf\": {param42}\n        },\n        \"Contatos\": {param43} [\n          {\n            \"Id\": {param44},\n            \"IdCliente\": {param45},\n            \"IdFornecedor\": {param46},\n            \"IdFuncionario\": {param47},\n            \"Nome\": {param48},\n            \"Email\": \"{param49},\n            \"Telefone\": {param50},\n            \"Padrao\": {param51},\n            \"Cobranca\": {param52}\n          }\n        ]\n      },\n      \"Valor\": {param53},\n      \"Periodicidade\": {param54},\n      \"ProximoReajuste\": {param55},\n      \"IndiceReajuste\": {param56},\n      \"NomeIndiceReajuste\": {param57},\n      \"PeriodoReajuste\": {param58},\n      \"NomePeriodoReajuste\": {param59}\n    }\n]\n\n

Paramêtros

{param1}: Id BomControle do Contrato. (Tipo do Dado: Inteiro.)
{param2}: Id BomControle data Venda do Contrato. (Tipo do Dado: Inteiro.)
{param3}: Data de Início do Contrato. (Tipo do Dado: Texto.)
{param4}: Data de Término do Contrato. (Tipo do Dado: Texto.)
{param5}: Tipo do Contrato. (Opções: 0 - Recorrente, 1 - Parcelado. Tipo do Dado: Inteiro)
{param6}: Nome do Tipo do Contrato. (Tipo do Dado: Texto.)
{param7}: Indica se o Contrato foi Encerrado. (Tipo do Dado: Booleano.)
{param8}: Data de Encerramento do Contrato. (Tipo do Dado: Texto.)
{param9}: Objeto contendo os dados da Empresa do Contrato. (Tipo do Dado: Objeto.)
{param10}: Id BomControle da Empresa. (Tipo do Dado: Inteiro.)
{param11}: Cnpj da Empresa. (Tipo do Dado: Texto.)
{param12}: Nome da Empresa. (Tipo do Dado: Texto.)
{param13}: Indica se é a Empresa principal do BomControle. (Tipo do Dado: Booleano.)
{param14}: Objeto contendo os dados do Cliente do Contrato. (Tipo do Dado: Objeto.)
{param15}: Id BomControle do Cliente. (Tipo do Dado: Inteiro.)
{param16}: Tipo Pessoa do Cliente. (Opções: Juridica, Fisica. Tipo do Dado: Texto.)
{param17}: País Origem do Cliente. (Opções: Juridica, Fisica. Tipo do Dado: Texto.)
{param18}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Física. Nullo caso seja TipoPessoa Jurídica. (Tipo do Dado: Objeto.)
{param19}: Cpf do Cliente. (Tipo do Dado: Texto.)
{param20}: Nome do Cliente. (Tipo do Dado: Texto.)
{param21}: Sexo do Cliente. (Opções: M, F, O. Tipo do Dado: Texto.)
{param22}: Data de nascimento do Cliente. (Tipo do Dado: Texto.)
{param23}: Objeto com os dados do Cliente caso ele seja do TipoPessoa Jurídica. Nullo caso seja TipoPessoa Física. (Tipo do Dado: Objeto.)
{param24}: Cnpj do Cliente. (Tipo do Dado: Texto.)
{param25}: Nome Fantasia do Cliente. (Tipo do Dado: Texto.)
{param26}: Razão Social do Cliente. (Tipo do Dado: Texto.)
{param27}: Indica se o Cliente é isento da Inscricao Estadual. (Tipo do Dado: Texto.)
{param28}: Número da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param29}: Estado da Inscricao Estadual do Cliente. (Tipo do Dado: Texto.)
{param30}: Número da Inscricao Municipal do Cliente. (Tipo do Dado: Texto.)
{param31}: Ramo de atividade do Cliente. (Tipo do Dado: Texto.)
{param32}: Indica se o Cliente esta bloqueado no BomControle. (Tipo do Dado: Booleano.)
{param33}: Objeto com os dados de endereço do Cliente. (Tipo do Dado: Objeto.)
{param34}: Id do endereço do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param35}: Tipo de logradouro do Cliente. (Opções: Rua, Avenida, Travessa, Alameda, Estrada, Rodovia, PSG, Quadra. Tipo do Dado: Texto.)
{param36}: Logradouro do Cliente. (Tipo do Dado: Texto.)
{param37}: Número do logradouro do Cliente. (Tipo do Dado: Texto.)
{param38}: Complemento do logradouro do Cliente. (Tipo do Dado: Texto.)
{param39}: Bairro do logradouro do Cliente. (Tipo do Dado: Texto.)
{param40}: Cep do logradouro do Cliente. (Tipo do Dado: Texto.)
{param41}: Cidade do logradouro do Cliente. (Tipo do Dado: Texto.)
{param42}: Sigla do Estado do logradouro do Cliente. (Tipo do Dado: Texto.)
{param43}: Array de Objetos com os dados de contatos do Cliente. (Tipo do Dado: Array de Objetos.)
{param44}: Id do contato do Cliente no BomControle. (Tipo do Dado: Inteiro.)
{param45}: Id do Cliente no BomControle o qual esse contato pertence. (Tipo do Dado: Inteiro.)
{param46}: Não utilizado. (Tipo do Dado: Inteiro.)
{param47}: Não utilizado. (Tipo do Dado: Inteiro.)
{param48}: Nome do contato do Cliente. (Tipo do Dado: Texto.)
{param49}: E-mail do contato do Cliente. (Tipo do Dado: Texto.)
{param50}: Telefone do contato do Cliente. (Tipo do Dado: Texto.)
{param51}: Indica se é o contato principal do Cliente. (Tipo do Dado: Booleano.)
{param52}: Indica se o contato esta cadastrado para recebimento de cobranças do BomControle. (Tipo do Dado: Booleano.)
{param53}: Valor do Contrato. (Tipo do Dado: Decimal.)
{param54}: Id BomControle da Periodicidade do Contrato. (Opções: 1 - Diaria, 2 - Semanal, 3 - Quinzenal, 4 - Mensal, 5 - Anual, 6 - Trimestral, 7 - Semestral, 8 - Bimestral. Tipo do Dado: Inteiro.)
{param55}: Data do Próximo Reajuste do Contrato. (Tipo do Dado: Texto.)
{param56}: Id BomControle do Indice de Reajuste. (Opções: 0 - Nenhum, 1 - IPCA, 2 - IGPM, 3 - INPC, 4 - IGPDI, 5 - INCC, 6 - Outros. Tipo do Dado: Inteiro.)
{param57}: Nome do Indice de Reajuste. (Tipo do Dado: Texto.)
{param58}: Id BomControle do Período de Reajuste. (Opções: 1 - Diaria, 2 - Semanal, 3 - Quinzenal, 4 - Mensal, 5 - Anual, 6 - Trimestral, 7 - Semestral, 8 - Bimestral. Tipo do Dado: Inteiro.)
{param59}: Nome do Período de Reajuste. (Tipo do Dado: Texto.)

","urlObject":{"protocol":"https","path":["integracao","VendaContrato","Pesquisar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"89299c86-0bf1-459c-b0ba-41a57294e30a","name":"VendaContrato - Pesquisar","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"}],"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/Pesquisar?pesquisa=teste","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","VendaContrato","Pesquisar"],"query":[{"key":"pesquisa","value":"teste"}]}},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 05 Feb 2020 14:19:46 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"1729"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"[\r\n {\r\n \"Id\": 1,\r\n \"IdVenda\": 1,\r\n \"Inicio\": \"2020-01-1T00:00:00\",\r\n \"Termino\": null,\r\n \"TipoPagamento\": 0,\r\n \"NomeTipoPagamento\": \"Recorrente\",\r\n \"Encerrado\": false,\r\n \"DataEncerramento\": null,\r\n \"Empresa\": {\r\n \"Id\": 1,\r\n \"Documento\": \"12345678000100\",\r\n \"Nome\": \"Teste\",\r\n \"Padrao\": true\r\n },\r\n \"Cliente\": {\r\n \"Id\": 1,\r\n \"TipoPessoa\": \"Juridica\",\r\n \"PaisOrigem\": \"Brasil\",\r\n \"PessoaFisica\": null,\r\n \"PessoaJuridica\": {\r\n \"Documento\": \"12345678000100\",\r\n \"NomeFantasia\": \"Teste\",\r\n \"RazaoSocial\": \"Teste\",\r\n \"IsentoInscricaoEstadual\": false,\r\n \"InscricaoEstadual\": null,\r\n \"UFInscricaoEstadual\": \"0\",\r\n \"InscricaoMunicipal\": null,\r\n \"RamoAtividade\": null\r\n },\r\n \"Bloqueado\": false,\r\n \"Endereco\": {\r\n \"Id\": 1,\r\n \"TipoLogradouro\": \"Rua\",\r\n \"Logradouro\": \"Niterói\",\r\n \"Numero\": \"265\",\r\n \"Complemento\": null,\r\n \"Bairro\": \"Centro\",\r\n \"Cep\": \"09510210\",\r\n \"Cidade\": \"São Caetano do Sul\",\r\n \"Uf\": \"SP\"\r\n },\r\n \"Contatos\": [\r\n {\r\n \"Id\": 1,\r\n \"IdCliente\": 1,\r\n \"IdFornecedor\": 0,\r\n \"IdFuncionario\": 0,\r\n \"Nome\": \"Teste\",\r\n \"Email\": \"teste@teste.com.br\",\r\n \"Telefone\": \"1111111111\",\r\n \"Padrao\": false,\r\n \"Cobranca\": false\r\n }\r\n ]\r\n },\r\n \"Valor\": 10.00000,\r\n \"Periodicidade\": 0,\r\n \"ProximoReajuste\": null,\r\n \"IndiceReajuste\": 0,\r\n \"NomeIndiceReajuste\": \"Nenhum\",\r\n \"PeriodoReajuste\": 4,\r\n \"NomePeriodoReajuste\": \"Mensal\"\r\n }\r\n]"}],"_postman_id":"2a22f28d-6e7a-4bdc-a258-b07594c0e013"},{"name":"VendaContrato - Criar","id":"6e3904d5-111a-40c6-9eef-a3ef20f8eb61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/Criar","description":"

Realiza o cadastro de um novo Contrato no BomControle.

Request

Os dados enviados para a API devem ser informados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Body

{\n  \"IdCliente\": {param1},\n  \"IdEmpresa\": {param2},\n  \"Inicio\": {param3},\n  \"Termino\": {param4},\n  \"Observacao\": {param5},\n  \"ObservacaoParcelas\": {param6},\n  \"Recorrente\": {param7},      \n  \"FormaPagamento\": {param8} {\n    \"Boleto\": {param9} {\n      \"Observacao\": {param10}\n    },\n    \"DepositoConta\": {param11} {\n      \"NumeroBanco\": {param12},\n      \"NumeroAgencia\": {param13},\n      \"NumeroConta\": {param14}\n    },\n    \"Outros\": {param15} {\n      \"Nome\": {param16}\n    }\n  },\n  \"NotaFiscal\": {param17} {\n    \"Observacao\": {param18}\n  },\n  \"Desconto\": {param19} {\n    \"Percentual\": {param20},\n    \"DataFim\": {param21}\n  },\n  \"Servicos\": {param22} [\n    {\n      \"IdServico\": {param23},\n      \"Quantidade\": {param24},\n      \"ValorUnitario\": {param25},\n      \"ValorDesconto\": {param26}\n    }\n  ],\n  \"PrimeiroVencimento\": {param27},\n  \"QuatidadeParcelas\": {param28}\n  \"Periodicidade\": {param29},\n  \"ProximoReajusteContrato\": {param30},\n  \"IndiceReajusteContrato\": {param31},\n  \"PeriodoReajusteContrato\": {param32}\n}\n\n

Paramêtros

{param1}: Id BomControle do Cliente. (Obrigatório. Tipo do Dado: Inteiro.)
{param2}: Id BomControle da Empresa. (Obrigatório. Tipo do Dado: Inteiro.)
{param3}: Data de Inicio do Contrato. (Obrigatório.Tipo do Dado: Texto.)
{param4}: Data de Término do Contrato. (Obrigatório.Tipo do Dado: Texto.)
{param5}: Observação do Contrato. (Opcional.Tipo do Dado: Texto.)
{param6}: Observação das Parcelas do Contrato. (Opcional.Tipo do Dado: Texto.)
{param7}: Indica se é um Contrato Recorrente. (Opcional.Tipo do Dado: Booleano.)
{param8}: Objeto contendo as Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param9}: Objeto contendo os dados para Boleto. Informar apenas quando houver emissão (Opcional.Tipo do Dado: Objeto.)
{param10}: Observação do Boleto. (Opcional.Tipo do Dado: Texto.)
{param11}: Objeto contendo os dados para Depósito em Conta. (Opcional.Tipo do Dado: Objeto.)
{param12}: Número do Banco. (Opcional.Tipo do Dado: Texto.)
{param13}: Número da Agência. (Opcional.Tipo do Dado: Texto.)
{param14}: Número da Conta. (Opcional. Tipo do Dado: Texto.)
{param15}: Objeto contendo os dados para outras Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param16}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param17}: Objeto contendo os dados para Emissão de Nota Fiscal. Informar apenas quando houver emissão (Opcional. Tipo do Dado: Texto.)
{param18}: Observação da Nota Fiscal. (Opcional. Tipo do Dado: Booleano.)
{param19}: Não utilizado. (Opcional. Tipo do Dado: Objeto.)
{param20}: Não utilizado. (Opcional. Tipo do Dado: Decimal.)
{param21}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param22}: Array de Objetos contendo os dados dos Serviços. (Obrigatório. Tipo do Dado: Array de Objetos.)
{param23}: Id BomControle do Serviço. (Obrigatório. Tipo do Dado: Inteiro.)
{param24}: Quantidade do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param25}: Valor Unitário do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param26}: Valor Desconto Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param27}: Data de Vencimento da Primeira Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param28}: Quantidade de Parcelas. (Opcional. Tipo do Dado: Inteiro.)
{param29}: Periodicidade do Contrato. (Opcional. Opções: Diaria, Semanal, Quinzenal, Mensal, Anual, Trimestral, Semestral, Bimestral. Tipo do Dado: Texto.)
{param30}: Data do Próximo Reajuste do Contrato. (Opcional. Tipo do Dado: Texto.)
{param31}: Indice de Reajuste. (Opcional. Opções: Nenhum, IPCA, IGPM, INPC, IGPDI, INCC, Outros. Tipo do Dado: Texto.)
{param32}: Período de Reajuste. (Opcional. Opções: Diaria, Semanal, Quinzenal, Mensal, Anual, Trimestral, Semestral, Bimestral. Tipo do Dado: Texto.)

\n\n

Response

Retorna um objeto contendo os dados referente a criação do Contrato.

Body

{\n  \"IdVenda\": {param1},\n  \"IdContrato\": {param2},\n  \"IdFatura\": {param3}\n}\n\n

Paramêtros

{param1}: Id BomControle da Venda do Contrato. (Tipo do Dado: Inteiro.)
{param2}: Id BomControle do Contrato. (Tipo do Dado: Inteiro.)
{param3}: Id BomControle da Primeira Fatura do Contrato. (Tipo do Dado: Inteiro.)

","urlObject":{"protocol":"https","path":["integracao","VendaContrato","Criar"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"32ed8174-5b58-4648-b4a7-00501d75a582","name":"VendaContrato - Criar","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"IdCliente\": 1,\r\n \"IdEmpresa\": 1,\r\n \"Inicio\": \"2020-01-01 00:00:00\",\r\n \"Termino\": \"2020-01-01 00:00:00\",\r\n \"Observacao\": \"Teste\",\r\n \"Recorrente\": true,\r\n \"FormaPagamento\": {\r\n \"Boleto\": {\r\n \"Observacao\": \"Teste\"\r\n }\r\n },\r\n \"NotaFiscal\": {\r\n \"Observacao\": \"Teste\"\r\n },\r\n \"Desconto\": {\r\n \"Percentual\": 10,\r\n \"DataFim\": \"2020-01-01 00:00:00\"\r\n },\r\n \"Servicos\": [\r\n {\r\n \"IdServico\": 1,\r\n \"Quantidade\": 1,\r\n \"ValorUnitario\": 10,\r\n \"ValorDesconto\": 0\r\n }\r\n ],\r\n \"PrimeiroVencimento\": \"2020-01-01 00:00:00\",\r\n \"QuatidadeParcelas\": 1,\r\n \"Periodicidade\": \"Mensal\",\r\n \"ProximoReajusteContrato\": \"2020-01-01 00:00:00\",\r\n \"IndiceReajusteContrato\": \"Nenhum\",\r\n \"PeriodoReajusteContrato\": \"Diaria\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/Criar"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 05 Feb 2020 14:41:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"64"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"{\r\n \"IdVenda\": 1,\r\n \"IdContrato\": 1,\r\n \"IdFatura\": 1\r\n}"}],"_postman_id":"6e3904d5-111a-40c6-9eef-a3ef20f8eb61"},{"name":"VendaContrato - Alterar","id":"6a64edf3-960b-448b-b8a3-9be61960a3c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/Alterar/{id}","description":"

Altera os dados da Contrato e da Fatura localizada na Competencia informada.

Request

O request para essa API é feito informando a identificação do Contrato diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

{id}: Id BomControle do Contrato. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"DiaVencimento\": {param1},\n  \"DataCompetencia\": {param2},\n  \"DataVencimento\": {param3},\n  \"ProximoReajuste\": {param4},\n  \"IndiceReajuste\": {param5},\n  \"PeriodoReajuste\": {param6},\n  \"Servicos\": {param7} [\n    {\n      \"IdServico\": {param8},\n      \"Quantidade\": {param9},\n      \"ValorUnitario\": {param10},\n      \"ValorDesconto\": {param11}\n    }\n  ],\n  \"Desconto\": {param12} {\n    \"Percentual\": {param13},\n    \"DataFim\": {param14}\n  },\n  \"FormaPagamento\": {param15} {\n    \"Boleto\": {param16} {\n      \"Observacao\": {param17},\n      \"EmiteBoleto\": {param18}\n    },\n    \"DepositoConta\": {param19} {\n      \"NumeroBanco\": {param20},\n      \"NumeroAgencia\": {param21},\n      \"NumeroConta\": {param22}\n    },\n    \"Outros\": {param23} {\n      \"Nome\": {param24}\n    }\n  },\n  \"NotaFiscal\": {param25} {\n    \"Emite\": {param26},\n    \"Observacao\": {param27}\n  }\n}\n

Paramêtros

{param1}: Altera o dia de Vencimento da Parcela da Fatura. (Obrigatório. Tipo do Dado: Inteiro.)
{param2}: Indica a partir de qual Parcela, através da Data de Competencia, deve ocorrer as alterações. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param3}: Altera a Data de Vencimento da Parcela. (Obrigatório. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param4}: Altera a Data do Próximo Reajuste do Contrato. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param5}: Indice de Reajuste. (Opcional. Opções: Nenhum, IPCA, IGPM, INPC, IGPDI, INCC, Outros. Tipo do Dado: Texto.)
{param6}: Período de Reajuste. (Opcional. Opções: Diaria, Semanal, Quinzenal, Mensal, Anual, Trimestral, Semestral, Bimestral. Tipo do Dado: Texto.)
{param7}: Array de objeto com os dados dos Serviços. (Obrigatório. Tipo do Dado: Objeto.)
{param8}: Id BomControle do Serviço. (Obrigatório. Tipo do Dado: Inteiro.)
{param9}: Quantidade do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param10}: Valor Unitário do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param11}: Valor de Desconto do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param12}: Não utilizado. (Opcional. Tipo do Dado: Objeto.)
{param13}: Não utilizado. (Opcional. Tipo do Dado: Decimal.)
{param14}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param15}: Objeto contendo as Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param16}: Objeto contendo os dados para Boleto. (Opcional.Tipo do Dado: Objeto.)
{param17}: Observação do Boleto. (Opcional.Tipo do Dado: Texto.)
{param18}: Indica se emite o Boleto. (Opcional.Tipo do Dado: Booleano.)
{param19}: Objeto contendo os dados para Depósito em Conta. (Opcional.Tipo do Dado: Objeto.)
{param20}: Número do Banco. (Opcional.Tipo do Dado: Texto.)
{param21}: Número da Agência. (Opcional.Tipo do Dado: Texto.)
{param22}: Número da Conta. (Opcional. Tipo do Dado: Texto.)
{param23}: Objeto contendo os dados para outras Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param24}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param25}: Objeto contendo os dados para Emissão de Nota Fiscal. (Opcional. Tipo do Dado: Texto.)
{param26}: Indica se emite a Nota Fiscal. (Opcional. Tipo do Dado: Booleano.)
{param27}: Observação da Nota Fiscal. (Opcional. Tipo do Dado: Booleano.)

\n\n

Response

Retorna o Id BomControle da Fatura alterada no Response.

\n","urlObject":{"protocol":"https","path":["integracao","VendaContrato","Alterar","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"e4870f4c-b356-4f75-9ad9-ce9ab4ba3e91","name":"VendaContrato - Alterar","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"DiaVencimento\": 15,\r\n \"DataCompetencia\": \"2020-01-01 00:00:00\",\r\n \"DataVencimento\": \"2020-01-01 00:00:00\",\r\n \"ProximoReajuste\": \"2020-01-01 00:00:00\",\r\n \"IndiceReajuste\": \"Nenhum\",\r\n \"PeriodoReajuste\": \"Diaria\",\r\n \"Servicos\": [\r\n {\r\n \"IdServico\": 1,\r\n \"Quantidade\": 1,\r\n \"ValorUnitario\": 10,\r\n \"ValorDesconto\": 0\r\n }\r\n ],\r\n \"Desconto\": {\r\n \"Percentual\": 0,\r\n \"DataFim\": \"2020-01-01 00:00:00\"\r\n },\r\n \"FormaPagamento\": {\r\n \"Boleto\": {\r\n \"Observacao\": \"teste\"\r\n }\r\n },\r\n \"NotaFiscal\": {\r\n \"Observacao\": \"teste\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/Alterar/75"},"status":"OK","code":200,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 05 Feb 2020 15:16:29 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"},{"key":"Content-Length","value":"4"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":"1"}],"_postman_id":"6a64edf3-960b-448b-b8a3-9be61960a3c9"},{"name":"VendaContrato - Encerrar","id":"3e40df59-c9a8-4d1d-8cbd-51a7da2f482c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/Encerrar/{id}","description":"

Realiza o encerramento do Contrato no BomControle.

Request

O request para essa API é feito informando a identificação do Contrato diretamente na URL e os dados no Body do Request.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.
Content-Type: application/json

\n\n

Paramêtros

{id}: Id do Contrato dentro do BomControle. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"DataCompetencia\": {param1},\n  \"Motivo\": {param2}\n}\n

Paramêtros

{param1}: Data do encerramento do Contrato. (Opcional. Formato: \"aaaa-mm-dd hh24:mi:ss\". Tipo do Dado: Texto.)
{param2}: Motivo do encerramento do Contrato. (Obrigatório. Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","VendaContrato","Encerrar","{id}"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"28b6a4e3-e8ff-416a-8639-234d531c4b22","name":"VendaContrato - Encerrar","originalRequest":{"method":"DELETE","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"DataCompetencia\": \"2020-01-01 00:00:00\",\r\n \"Motivo\": \"Teste\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/Encerrar/1"},"status":"No Content","code":204,"_postman_previewlanguage":"html","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 05 Feb 2020 15:48:08 GMT"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Type","value":"text/html"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3e40df59-c9a8-4d1d-8cbd-51a7da2f482c"},{"name":"VendaContrato - Alterar Fatura","id":"577e33ec-352c-4e1f-8859-3b913f4e6133","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"url":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/AlterarFatura","description":"

Altera os dados da Fatura do Contrato solicitado.

Request

O request para essa API é feito através de Querystring usando os paramêtros informados abaixo.

Headers

Authorization: Chave API (\"ApiKey + {chave}\") obtido no BomControle.

\n\n

Paramêtros

idContrato: Id BomControle do Contrato. (Obrigatório. Tipo do Dado: Inteiro.)
idFatura: Id BomControle da Fatura do Contrato. (Obrigatório. Tipo do Dado: Inteiro.)

\n\n

Body

{\n  \"DiaVencimento\": {param1},\n  \"DataCompetencia\": {param2},\n  \"DataVencimento\": {param3},\n  \"ProximoReajuste\": {param4},\n  \"IndiceReajuste\": {param5},\n  \"PeriodoReajuste\": {param6},\n  \"Servicos\": {param7} [\n    {\n      \"IdServico\": {param8},\n      \"Quantidade\": {param9},\n      \"ValorUnitario\": {param10},\n      \"ValorDesconto\": {param11}\n    }\n  ],\n  \"Desconto\": {param12} {\n    \"Percentual\": {param13},\n    \"DataFim\": {param14}\n  },\n  \"FormaPagamento\": {param15} {\n    \"Boleto\": {param16} {\n      \"Observacao\": {param17},\n      \"EmiteBoleto\": {param18}\n    },\n    \"DepositoConta\": {param19} {\n      \"NumeroBanco\": {param20},\n      \"NumeroAgencia\": {param21},\n      \"NumeroConta\": {param22}\n    },\n    \"Outros\": {param23} {\n      \"Nome\": {param24}\n    }\n  },\n  \"NotaFiscal\": {param25} {\n    \"Emite\": {param26},\n    \"Observacao\": {param27}\n  }\n}\n

Paramêtros

{param1}: Altera o dia de Vencimento da Parcela da Fatura. (Opcional. Tipo do Dado: Inteiro.)
{param2}: Altera a data de Vencimento da Parcela da Fatura. (Obrigatório. Tipo do Dado: Texto.)
{param3}: Altera a data de Competencia da Parcela da Fatura. (Obrigatório. Tipo do Dado: Texto.)
{param4}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param5}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param6}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param7}: Array de objetos com os dados dos Serviços a serem alterados. (Obrigatório. Tipo do Dado: Array de Objetos.)
{param8}: Id BomControle do Serviço. (Obrigatório. Tipo do Dado: Inteiro.)
{param9}: Quantidade do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param10}: Valor Unitário do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param11}: Valor de Desconto do Serviço. (Obrigatório. Tipo do Dado: Decimal.)
{param12}: Não utilizado. (Opcional. Tipo do Dado: Objeto.)
{param13}: Não utilizado. (Opcional. Tipo do Dado: Decimal.)
{param14}: Não utilizado. (Opcional. Tipo do Dado: Texto.)
{param15}: Objeto contendo as Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param16}: Objeto contendo os dados para Boleto. (Opcional.Tipo do Dado: Objeto.)
{param17}: Observação do Boleto. (Opcional.Tipo do Dado: Texto.)
{param18}: Indica se emite o Boleto. (Opcional.Tipo do Dado: Booleano.)
{param19}: Objeto contendo os dados para Depósito em Conta. (Opcional.Tipo do Dado: Objeto.)
{param20}: Número do Banco. (Opcional.Tipo do Dado: Texto.)
{param21}: Número da Agência. (Opcional.Tipo do Dado: Texto.)
{param22}: Número da Conta. (Opcional. Tipo do Dado: Texto.)
{param23}: Objeto contendo os dados para outras Formas de Pagamento. (Opcional. Tipo do Dado: Objeto.)
{param24}: Nome da Forma de Pagamento. (Opcional. Opções: Dinheiro, Deposito, Cheque, TransferenciaBancaria, CartaoCredito, CartaoDebito, BoletoBancario, DescontoEmFolha, Outros, DebitoConta. Tipo do Dado: Texto.)
{param25}: Array de objeto com dado de Nota Fiscal. (Opcional. Tipo do Dado: Objeto.)
{param26}: Indica se Emite a Nota Fiscal. (Opcional. Tipo do Dado: Booleano.)
{param27}: Observação da Nota Fiscal. (Opcional. Tipo do Dado: Texto.)

\n\n

Response

Essa API não retorna nenhum dado no Response.

\n","urlObject":{"protocol":"https","path":["integracao","VendaContrato","AlterarFatura"],"host":["apinewintegracao","bomcontrole","com","br"],"query":[],"variable":[]}},"response":[{"id":"455cc67e-092e-4da2-9bad-e41195157528","name":"VendaContrato - AlterarFatura","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"ApiKey Z0EjZPzTOb-NVurlZvdf-jqb2g6FUvIlKBmvUVCh7sE03jMPBaCQ9bIps9El6__SynsbTrCaUm1yI2geYNx3JSPNELf-pDy5HaUUcTkvYNw8nwlkDozDnA==","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"DiaVencimento\": 20,\r\n \"DataCompetencia\": \"2020-01-01 00:00:00\",\r\n \"DataVencimento\": \"2020-01-01 00:00:00\",\r\n \"ProximoReajuste\": \"2020-01-01 00:00:00\",\r\n \"IndiceReajuste\": \"Nenhum\",\r\n \"PeriodoReajuste\": \"Diaria\",\r\n \"Servicos\": [\r\n {\r\n \"IdServico\": 1,\r\n \"Quantidade\": 1,\r\n \"ValorUnitario\": 10,\r\n \"ValorDesconto\": 0\r\n }\r\n ],\r\n \"Desconto\": {\r\n \"Percentual\": 0,\r\n \"DataFim\": \"2020-01-01 00:00:00\"\r\n },\r\n \"FormaPagamento\": {\r\n \"Boleto\": {\r\n \"Observacao\": \"teste\",\r\n \"EmiteBoleto\": true\r\n }\r\n },\r\n \"NotaFiscal\": {\r\n \"Emite\": false,\r\n \"Observacao\": \"true\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://apinewintegracao.bomcontrole.com.br/integracao/VendaContrato/AlterarFatura?idContrato=1&idFatura=1","protocol":"https","host":["apinewintegracao","bomcontrole","com","br"],"path":["integracao","VendaContrato","AlterarFatura"],"query":[{"key":"idContrato","value":"1"},{"key":"idFatura","value":"1"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"plain","header":[{"key":"Server","value":"nginx/1.10.3 (Ubuntu)"},{"key":"Date","value":"Wed, 05 Feb 2020 15:55:00 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"23"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"private"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"577e33ec-352c-4e1f-8859-3b913f4e6133"}],"id":"d03e6881-d4db-4422-8acd-54cb0a5d3032","description":"

APIs para modificação dos Contratos das Vendas do BomControle.

\n","_postman_id":"d03e6881-d4db-4422-8acd-54cb0a5d3032"}],"event":[{"listen":"prerequest","script":{"id":"451b6fa8-f256-440e-9da1-23ebb306bee1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"4dfa8402-65d6-4102-a8ea-132a0f797cce","type":"text/javascript","exec":[""]}}]}