FoccoSMF - IntegraCRM¶
Utilização de Serviços de Envio e Consulta de Dados para CRM¶
Para utilização dos serviços do CRM é utilizado o padrão REST, utilizando JSON para envio e recebimento das informações.
A URL base para utilização dos serviços é o http://<IP>:<PORTA>/service/<SERVIÇO> do FoccoSMF.
Exemplo: http://172.16.11.109:8878/service/SendProposalCrm
1. Envio de Tarefas para o FoccoSMF¶
1.1 - JSON de envio de Tarefas¶
| Atributo | Informação |
|---|---|
| Chave de Acesso | Chave do ambiente do cliente do FoccoERP. |
| Modelo | Modelo de serviço do FoccoSMF, utilizar "CRM". |
| CodigoGenerico | Deve ser utilizado o nome do CRM que se deseja enviar/receber informações. |
| CrmData | Aqui devem ser enviados os dados que serão enviados ao CRM, sendo os dados de Autenticação, a URL base do CRM e os Dados (Contas, Usuários, Funis, Propostas) conforme as estruturas definidas. |
| CrmData.UrlBase | URL base do CRM. Exemplo: https://api.pipe.run/ |
| CrmData.Authentication | Dados de autenticação. |
| CrmData.Data | Dados do CRM conforme o serviço utilizado, por exemplo, se utilizado o serviço de envio de propostas, deve ser enviada a estrutura da proposta. |
Exemplo:
{
"ChaveAmbiente": "F39B0F66-14D9-4608-9A44-8434B2EF2D1E",
"Modelo": "CRM",
"CodigoGenerico": "PIPERUN",
"CrmData": {
"UrlBase": "https://api.pipe.run/",
"Authentication": { },
"Data": { }
},
}
1.2 - JSON de envio para consulta de resultado de tarefas¶
URL: <URL base para utilização dos serviços>/service/GetTaskResult
| Atributo | Informação |
|---|---|
| ChaveAmbiente | Chave do ambiente do cliente do FoccoERP. |
| Token | Token/chave da tarefa criada no FoccoSMF, que será utilizada para consulta do resultado da tarefa. |
Exemplo
{
"ChaveAmbiente": "F39B0F66-14D9-4608-9A44-8434B2EF2D1E",
"Token": "4041A17B-D946-4233-840A-6281DA13BF28"
}
1.3 - JSON de retorno do FoccoSMF¶
Essa estrutura de retorno é tanto para o agendamento de tarefas, quanto para a consulta de situação de tarefas.
| Atributo | Iinformação |
|---|---|
| Token | Token/chave da tarefa criada no FoccoSMF, que será utilizada para consulta do resultado da tarefa. |
| Status | Status/situação da tarefa no FoccoSMF. Situações possíveis: Pendente, Sucesso e Falha. |
| Modelo | Modelo de serviço do FoccoSMF, será o modelo utilizado no envio, no caso "CRM". |
| Acao | Identifica a ação/método executado pela tarefa, será o serviço utilizado. Exemplo:"SendProposalCrm" |
| Resultado | Retorna o resultado da execução da tarefa. |
Observação¶
Como os serviços do CRM são executados de maneira assíncrona com a chamada do serviço, o retorno do envio da tarefa sempre será "null". Na consulta de resultado da tarefa, quando a mesma for executada, será retornado o JSON de retorno, com o resultado do envio dos dados ao CRM.
Exemplo
{
"Token": "6D7AC256-9A47-4372-85F4-DDBC3E212AB2",
"Status": "Pendente",
"Modelo": "CRM",
"Acao": "SendProposalCrm",
"Resultado": null
}
2 - Envio de Propostas para o CRM via FoccoSMF¶
2.1. - Serviço de Envio de Propostas¶
URL: <URL base para utilização dos serviços>/SendProposalCrm
JSON (Enviados em "Data" dos dados do CRM ("CrmData")
| Atributo | Tipo | Informação | Obrigatório |
|---|---|---|---|
| Proposta | <object> | Estrutura da Proposta para envio ao CRM. | Sim |
| Proposta.PropostaCrmId | string | ID da proposta no CRM. | |
| Proposta.ContaId | long | ID da conta no CRM. | Sim |
| Proposta.UsuarioId | long | ID do usuário no CRM. | Sim |
| Proposta.OportunidadeId | long | ID da oportunidade no CRM. | Sim |
| Proposta.MoedaId | long | ID da moeda no CRM. | |
| Proposta.OrcamentoId | long | ID do orçamento gerado no FoccoERP. | Sim |
| Proposta.NumeroOrcamento | long | Número do orçamento gerado no FoccoERP. | Sim |
| Proposta.Observacao | string | Observação do orçamento/proposta. | |
| Proposta.ValorOrcamento | decimal | Valor do orçamento gerado no FoccoERP. | Sim |
| Proposta.CondicaoPagamento | <object> | Condição de Pagamento. | Sim |
| Proposta.CondicaoPagamento.TipoCondicaoPagamentoId | long | ID do tipo da condição de pagamento. | Sim |
| Proposta.CondicaoPagamento.Descricao | string | Descrição da condição de pagamento. | Sim |
| Proposta.CondicaoPagamento.Tipo | int | Tipo da condição de pagamento. | Sim |
| Proposta.CondicaoPagamento.TipoConfiguracao | int | Tipo da configuração da condição de pagamento. | Sim |
| Proposta.CondicaoPagamento.CondicaoPagamentoCrmId | string | ID da condição de pagamento no CRM. | |
| Proposta.CondicaoPagamento.CondicaoPagamentoId | long | ID da condição de pagamento no FoccoERP. | |
| Proposta.Itens | List\<object> | Lista de itens do orçamento/proposta. | Sim |
| Proposta.Itens.PropostaCrmId | string | ID da proposta no CRM. | |
| Proposta.Itens.CategoriaId | long | ID da categoria do item. | Sim |
| Proposta.Itens.ItemEmpresaId | long | ID da tabela "TITENS_EMPR" do FoccoERP. | Sim |
| Proposta.Itens.MascaraItemId | long | ID da máscara do item no FoccoERP. | |
| Proposta.Itens.Descricao | long | Descrição do item. | Sim |
| Proposta.Itens.ValorMinimo | decimal | Valor mínimo do item. | Sim |
| Proposta.Itens.ValorCusto | decimal | Valor de custo do item. | Sim |
| Proposta.Itens.Tipo | int | Tipo do item. | Sim |
| Proposta.Itens.CodigoItem | string | Código do item. | Sim |
| Proposta.Itens.Valor | decimal | Valor do item. | Sim |
| Proposta.Itens.ItemCrmId | string | ID do item no CRM. | |
| Proposta.Itens.Quantidade | decimal | Quantidade do item no orçamento/proposta. | Sim |
| Proposta.Itens.ContaId | long | ID da conta no CRM. | Sim |
Exemplo
"Data":{
"Proposta":{
"PropostaCrmId":null,
"ContaId":1,
"UsuarioId":14566,
"OportunidadeId":5495272,
"MoedaId":1,
"OrcamentoId":51122,
"NumeroOrcamento":15,
"Observacao":null,
"ValorOrcamento":23.0,
"CondicaoPagamento":{
"TipoCondicaoPagamentoId":1,
"Descricao":"30/60/90",
"Tipo":1,
"TipoConfiguracao":2,
"CondicaoPagamentoCrmId":"4511",
"CondicaoPagamentoId":619
},
"Itens":[
{
"PropostaCrmId":0,
"CategoriaId":0,
"ItemEmpresaId":32447,
"MascaraItemId":null,
"Nome":"ITEM COMERCIAL C/ ESTR",
"Descricao":null,
"ValorMinimo":0.0,
"ValorCusto":0.0,
"Referencia":"32447",
"Tipo":0,
"CodigoItem":"BORRACHA",
"Valor":7.0,
"ItemCrmId":"1825339",
"Quantidade":1.0,
"ContaId":1
},
{
"PropostaCrmId":0,
"CategoriaId":0,
"ItemEmpresaId":32449,
"MascaraItemId":31421,
"Nome":"ITEM INDUSTRIAL C/ ESTR",
"Descricao":"(31421) AMARELO PASSADOR",
"ValorMinimo":0.0,
"ValorCusto":0.0,
"Referencia":"32449[31421]",
"Tipo":0,
"CodigoItem":"CANETA",
"Valor":8.0,
"ItemCrmId":null,
"Quantidade":2.0,
"ContaId":1
}
]
}
}
2.2 -Retorno do envio de Propostas¶
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Proposta | <object> | Retorno do envio da proposta. |
| Proposta.PropostaCrmId | string | ID da proposta gerada no CRM. |
| Proposta.OrcamentoId | string | ID do orçamento. |
| Proposta.OportunidadeId | string | ID da oportunidade à qual a proposta foi vinculada no CRM. |
| Proposta.CondicaoPagamento | <object> | Condição de Pagamento. |
| Proposta.CondicaoPagamento.CondicaoPagamentoId | string | ID da condição de pagamento no FoccoERP. |
| Proposta.CondicaoPagamento.CondicaoPagamentoCrmId | string | ID da condição de pagamento no CRM. |
| Proposta.Itens | List\<object> | Lista de Itens da Proposta. |
| Proposta.Itens.ItemCrmId | string | ID do item no CRM. |
| Proposta.Itens.ItemEmpresaId | string | ID do item na tabela "TITENS_EMPR" no FoccoERP. |
| Proposta.Itens.MascaraItemId | string | ID da máscara do item. |
Exemplo
"Proposta":{
"PropostaCrmId":"334710",
"OrcamentoId":"51122",
"OportunidadeId":"5495272",
"CondicaoPagamento":{
"CondicaoPagamentoId":"619",
"CondicaoPagamentoCrmId":"4511"
},
"Itens":[
{
"ItemCrmId":"1825339",
"ItemEmpresaId":"32447",
"MascaraItemId":""
},
{
"ItemCrmId":"1824579",
"ItemEmpresaId":"32449",
"MascaraItemId":"31421"
}
]
}
3 - Busca de dados do CRM.¶
3.1. - Serviços para busca de dados do CRM.¶
JSON (Enviados em "Data" para busca dos dados do CRM ("CrmData")
{
"CrmData":{
"UrlBase":"https://api.pipe.run",
"Authentication":{
"UserName":"pedro.santos@gmail.com.br",
"Password":"487123",
"Token":""
},
"Data":null
},
"ChaveAmbiente":"F39B0F66-14D9-4608-9A44-8434B2EF2D1E",
"Producao":0,
"Versao":"1.0",
"Modelo":"CRM",
"Cnpj":"0",
"CodCidade":null,
"CodUfIbge":null,
"CodigoGenerico":"PIPERUN"
}
3.2. - Busca de Contas do CRM.¶
URL: <URL base para utilização dos serviços>/GetAccountCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Conta | List<object\> |
Retorno das Contas do CRM. |
| Conta.Id | string | ID da conta do CRM. |
| Conta.Nome | string | Nome da conta do CRM. |
| Conta.Ativo | string | Indica se a conta está ativa. |
Exemplo
{
"Id":"1736",
"Nome":"Focco2",
"Ativo":"1"
}
3.3. - Busca de Usuários do CRM.¶
URL: <URL base para utilização dos serviços>/GetUsersCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Usuários | List<object\> |
Lista de usuários retornados do CRM. |
| Usuários.Id | string | ID do usuário do CRM. |
| Usuários.Email | string | E-mail do usuário do CRM. |
| Usuários.ContaId | string | ID da conta do CRM em que o usuário está cadastrado. |
| Usuários.Nome | string | Nome do usuário. |
| Usuários.Ativo | string | Indica se o usuário está ativo. |
Exemplo
{
"Usuarios":[
{
"Id":"26465",
"Email":"kivastikivas@gmail.com",
"ContaId":"1736",
"Nome":"Teste3",
"Ativo":"1"
},
{
"Id":"14568",
"Email":"affonso.santos@gmail.com",
"ContaId":"1736",
"Nome":"Affonso",
"Ativo":"1"
},
]
}
3.4. - Busca de Funis do CRM.¶
URL: <URL base para utilização dos serviços>/GetPipelinesCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Funis | List<object\> |
Lista dos funis retornados do CRM. |
| Funis.Id | long | ID do funil do CRM. |
| Funis.ContaId | long | ID da conta do CRM em que o funil está vinculado. |
| Funis.UserId | long | ID do usuário. |
| Funis.Nome | string | Nome do funil. |
| Funis.Descricao | string | Descrição do funil. |
Exemplo
{
"Funis":[
{
"Id":11389,
"ContaId":1736,
"UserId":0,
"Nome":"Funil Comercial"
},
{
"Id":3803,
"ContaId":1736,
"UserId":0,
"Nome":"Funil Principal",
"Descricao":"Funil de vendas principal"
}
]
}
3.5. - Busca dos Estágios do Funil do CRM.¶
URL: <URL base para utilização dos serviços>/GetStagesCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Etapas | <object\> |
Lista dos estágios dos funis retornados do CRM. |
| Etapas.Id | long | ID do estágio do funil no CRM. |
| Etapas.FunilId | long | ID do funil no qual o estágio está vinculado. |
| Etapas.Nome | string | Nome do estágio do funil. |
| Etapas.Ordem | long | Ordem. |
Exemplo
{
"Etapas":[
{
"Id":19480,
"FunilId":3803,
"Nome":"Contato inicial",
"Ordem":0
},
{
"Id":58501,
"FunilId":11284,
"Nome":"Em negociação",
"Ordem":0
}
]
}
3.6. - Busca das Cidades do CRM.¶
URL: <URL base para utilização dos serviços>/GetCitiesCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Cidades | List<object\> |
Lista das cidades retornadas do CRM. |
| Cidades.Id | string | ID da cidade no CRM. |
| Cidades.Uf | string | Unidade Federativa da cidade. |
| Cidades.Nome | string | Nome da cidade. |
Exemplo
{
"Cidades":[
{
"Id":"5271",
"Uf":"GO",
"Nome":"Abadia de Goiás"
},
{
"Id":"2243",
"Uf":"MG",
"Nome":"Abadia dos Dourados"
}
]
}
3.6. - Busca das Regiões do CRM.¶
URL: <URL base para utilização dos serviços>/GetRegionsCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Regioes | List<object\> |
Lista das regiões retornadas do CRM. |
| Regioes.Id | string | ID da região no CRM. |
| Regioes.ContaId | long | ID da conta do CRM. |
| Regioes.RegiaoId | long | Conta do CRM. |
| Regioes.CidadeId | string | ID da cidade do CRM. |
| Regioes.Nome | string | Nome da região. |
| Cidades | List<object\> |
Lista das cidades pertencentes à região. |
| Regioes.Cidades.Id | string | ID da cidade. |
| Regioes.Cidades.Uf | string | Unidade Federativa da cidade. |
| Regioes.Cidades.Nome | string | Nome da cidade. |
Exemplo
{
"Regioes":[
{
"Id":"3314",
"ContaId":1736,
"RegiaoId":3313,
"CidadeId":null,
"Nome":"São Paulo",
"Cidades":[
{
"Id":"3826",
"Uf":"SP",
"Nome":"São Paulo"
},
{
"Id":"3845",
"Uf":"SP",
"Nome":"Sorocaba"
}
]
}
]
}
3.7. - Busca dos Segmentos de Mercado do CRM.¶
URL: <URL base para utilização dos serviços>/GetSegmentsCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Segmentos | List<object\> |
Lista dos segmentos de mercado retornados do CRM. |
| Id | string | ID do segmento de mercado do CRM. |
| ContaId | string | ID da conta na qual o segmento de mercado está cadastrado. |
| Nome | string | Nome do segmento de mercado. |
| Descricao | string | Descrição do segmento de mercado. |
Exemplo
{
"Segmentos":[
{
"Id":"66990",
"ContaId":null,
"Nome":"2",
"Descricao":"Industria"
},
{
"Id":"66940",
"ContaId":null,
"Nome":"6",
"Descricao":"PRESTADOR DE SERVIÇOS"
}
]
}
3.8. - Busca das Oportunidades do CRM.¶
URL: <URL base para utilização dos serviços>/GetDealsCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Oportunidades | List<object\> |
Lista das oportunidades retornadas do CRM. |
| Oportunidades.Id | long | ID da oportunidade. |
| Oportunidades.FunilId | long | ID do funil no qual a oportunidade está presente. |
| Oportunidades.GerenteId | long | ID do gerente/gestor no CRM. |
| Oportunidades.EtapaId | long | ID da etapa do funil em que a oportunidade está presente. |
| Oportunidades.PessoaId | long | ID da pessoa. |
| Oportunidades.EmpresaId | long | ID da empresa do CRM à qual a oportunidade está presente. |
| Oportunidades.Titulo | string | Título da oportunidade. |
| Oportunidades.Descricao | string | Descrição da oportunidade. |
| Oportunidades.Observacao | string | Observação da oportunidade. |
| Oportunidades.Status | int | Status da oportunidade. |
| Oportunidades.Excluido | int | Indica se a oportunidade está excluída. |
| Oportunidades.Congelado | int | Indica se a oportunidade está congelada. |
| Oportunidades.Valor | string | Valor da oportunidade. |
| Oportunidades.Ordem | int | Ordem da oportunidade. |
| Oportunidades.ValorServico | string | Valor de serviço da oportunidade. |
| Empresa | <object\> |
Empresa à qual a oportunidade está vinculada. |
| Oportunidades.Empresa.Id | string | ID da empresa. |
| Oportunidades.Empresa.Cnpj | string | Cnpj da empresa. |
| Oportunidades.Empresa.ContaId | string | ID da conta do CRM à qual a empresa está cadastrada. |
| Oportunidades.Empresa.NomeFantasia | string | Nome fantasia da empresa. |
| Oportunidades.Empresa.RegiaoId | string | ID da região à qual a empresa pertence. |
| Oportunidades.Empresa.MicroRegiaoId | string | ID da microrregiao à qual a empresa pertence. |
| Oportunidades.Empresa.SegmentoId | string | ID do segmento de mercado da empresa. |
| Oportunidades.Empresa.CidadeId | string | ID da cidade à qual a empresa pertence. |
| Oportunidades.Empresa.Site | string | Site da empresa. |
| Oportunidades.Empresa.EmailNf | string | Email utilizado para notas fiscais da empresa. |
| Oportunidades.Empresa.Observacao | string | Observação da empresa. |
| Oportunidades.Empresa.Endereco | string | Endereço da empresa. |
| Oportunidades.Empresa.EnderecoNumero | string | Número do endereço da empresa. |
| Oportunidades.Empresa.EnderecoComplemento | string | Complemento da empresa. |
| Oportunidades.Empresa.RazaoSocial | string | Razão social da empresa. |
| Oportunidades.Empresa.Ie | string | Inscrição estadual. |
| Oportunidades.Empresa.Bairro | string | Bairro da empresa. |
| Oportunidades.Empresa.Pais | string | País da empresa. |
| Oportunidades.Empresa.Cep | string | Cep da empresa. |
| Oportunidades.Empresa.ContatoEmails | string | E-mail do contato da empresa. |
| Oportunidades.Empresa.ContatoTelefones | string | Telefone do contato da empresa. |
| Pessoa | <object\> |
Descrição do segmento de mercado. |
| Oportunidades.Pessoa.Id | string | ID da pessoa. |
| Oportunidades.Pessoa.Cpf | string | Cpf da pessoa. |
| Oportunidades.Pessoa.Cnpj | string | Cnpj da pessoa. |
| Oportunidades.Pessoa.ContaId | string | ID da conta na qual a pessoa está cadastrada. |
| Oportunidades.Pessoa.RegiaoId | string | ID da região na qual a pessoa pertence. |
| Oportunidades.Pessoa.MicroRegiaoId | string | ID da microrregião na qual a pessoa pertence. |
| Oportunidades.Pessoa.CidadeId | string | ID da cidade na qual a pessoa pertence. |
| Oportunidades.Pessoa.Nome | string | Nome da pessoa. |
| Oportunidades.Pessoa.Observacao | string | Observação da pessoa. |
| Oportunidades.Pessoa.Endereco | string | Endereço da pessoa. |
| Oportunidades.Pessoa.EnderecoNumero | string | Número do endereço da pessoa. |
| Oportunidades.Pessoa.EnderecoComplemento | string | Complemento. |
| Oportunidades.Pessoa.Bairro | string | Bairro. |
| Oportunidades.Pessoa.Pais | string | País. |
| Oportunidades.Pessoa.Cep | string | Cep. |
| ContatoEmails | <object\> |
E-mails dos contatos da pessoa. |
| Oportunidades.ContatoEmails.Id | string | ID do contato. |
| Oportunidades.ContatoEmails.ClienteId | string | ID do cliente à qual o contato está vinculado. |
| Oportunidades.ContatoEmails.Tipo | string | Tipo do contato. |
| Oportunidades.ContatoEmails.Email | string | E-mail do contato. |
| Oportunidades.ContatoEmails.Principal | string | Indica se é o contato principal. |
| ContatoTelefones | <object\> |
Telefone dos contatos. |
| Oportunidades.ContatoTelefones.Id | string | ID do telefone de contato. |
| Oportunidades.ContatoTelefones.ClienteId | string | ID do cliente à qual o contato está vinculado. |
| Oportunidades.ContatoTelefones.Tipo | string | Tipo do contato. |
| Oportunidades.ContatoTelefones.Principal | string | Indica se é o contato principal. |
| Oportunidades.ContatoTelefones.Fone | string | Fone do contato. |
Exemplo
{
"Oportunidades":[
{
"Id":964310,
"FunilId":3803,
"GerenteId":4396,
"EtapaId":19480,
"PessoaId":1280008,
"EmpresaId":null,
"Titulo":"FoccoBI",
"Descricao":null,
"Observacao":null,
"Status":0,
"Excluido":0,
"Congelado":0,
"Valor":"0.00",
"Ordem":3,
"ValorServico":"4050.00",
"Empresa":{
"Id":null,
"Cnpj":null,
"ContaId":null,
"NomeFantasia":null,
"RegiaoId":null,
"MicroRegiaoId":null,
"SegmentoId":null,
"CidadeId":null,
"Site":null,
"EmailNf":null,
"Observacao":null,
"Endereco":null,
"EnderecoNumero":null,
"EnderecoComplemento":null,
"RazaoSocial":null,
"Ie":null,
"Bairro":null,
"Pais":null,
"Cep":null,
"ContatoEmails":null,
"ContatoTelefones":null
},
"Pessoa":{
"Id":"1280008",
"Cpf":"604.544.070-68",
"Cnpj":null,
"ContaId":"1736",
"RegiaoId":"0",
"MicroRegiaoId":"0",
"CidadeId":"4687",
"Nome":"Pedro",
"Observacao":null,
"Endereco":"Rua Moreira Cesar",
"EnderecoNumero":"2019",
"EnderecoComplemento":null,
"Bairro":"Pio x",
"Pais":null,
"Cep":"95034-000",
"ContatoEmails":[
{
"Id":"1204028",
"ClienteId":"1280008",
"Tipo":"Normal",
"Email":"pedrocelsof@gmail.com",
"Principal":0
}
],
"ContatoTelefones":[
{
"Id":"8585278",
"ClienteId":"1280008",
"Tipo":"Comercial",
"Principal":0,
"Fone":"054981330117"
}
]
}
}
]
}
3.9. - Busca das Condições de Pagamento do CRM.¶
URL: <URL base para utilização dos serviços>/GetPaymentMethodsCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| CondicoesPagamento | <object\> |
Condições de pagamento. |
| CondicoesPagamento.Id | string | ID da condição de pagamento no CRM. |
| CondicoesPagamento.TipoCondicaoPagamentoId | int | Tipo da condição de pagamento. |
| CondicoesPagamento.Descricao | string | Descrição da condição de pagamento. |
| CondicoesPagamento.Tipo | int | Tipo da condição de pagamento. |
| CondicoesPagamento.TipoConfiguracao | int | Tipo da configuração da condição de pagamento. |
Exemplo
{
"CondicoesPagamento":[
{
"Id":"3986",
"TipoCondicaoPagamentoId":1,
"Descricao":"APRAZO 12",
"Tipo":1,
"TipoConfiguracao":0
},
{
"Id":"3908",
"TipoCondicaoPagamentoId":9,
"Descricao":"AVISTA CADASTRADO",
"Tipo":1,
"TipoConfiguracao":1
}
]
}
3.10. - Busca do status da proposta no CRM¶
URL: <URL base para utilização dos serviços>/GetProposalStatusCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Status | <object\> |
Retorno do status da proposta. |
| OportunidadeId | string | ID da oportunidade do CRM. |
| Propostas | List<object\> |
Propostas. |
| Propostas.PropostaCrmId | string | ID da proposta do CRM. |
| Propostas.Status | string | Indica o status atual da proposta no CRM. (Ganha, Cancelada, Declinada). |
Exemplo
{
"OportunidadeId":1,
"Propostas":[
{
"PropostaCrmId":"334428",
"Status":"PRO_GAN"
}
]
}
3.11. - Serviço utilizado para autenticação com o CRM.¶
URL: <URL base para utilização dos serviços>/GetTokenCrm
JSON (Retornado no "Resultado" na Consulta de tarefas do FoccoSMF - Descrito no Item 1.2)
| Atributo | Tipo | Informação |
|---|---|---|
| Token | string | Mensagem de sucesso ou falha referente a autenticação. |
| Sucesso | boolean | Indica se a autenticação foi realizada com sucesso. |
| ContaLogin | string | Login da conta. |
Exemplo
{
"Token":"Login efetuado com sucesso.",
"Sucesso":true,
"ContaLogin":null
}