APIs do Totali Middleware
Referenciado por: APIs do Totali Middleware |
Conceito
Realizar inclusão/alteração do parceiro/endereço.
Valida Sessão
Sim
API
TCommerceAPI
Método
PersisteParceiro
Troca de informações
- Parâmetros de Entrada:
{ "Parceiro": { "CodigoExterno": "<Código Externo do Parceiro [TT_CLI.CODEXT]>", "CodigoExternoVinculo": "<Código Externo do Parceiro Vinculado [TT_CLI.CODEXT] (opcional)>", "FilCli": "<Filial do Parceiro [TT_CLI.FILCLI] (opcional)>", "CodCli": "<Código do Parceiro [TT_CLI.CODCLI] (opcional)>", "FilVin": "<Filial do Parceiro Vinculado [TT_CLI.FILVIN] (opcional)>", "CodVin": "<Código do Parceiro Vinculado [TT_CLI.CODVIN] (opcional)>", "Categoria1":{ "__comment__": "<Categoria 1 - TABELA TD_CT1>", "Codigo":"<Categoria 1 do Parceiro[TT_CLI.CODTAB] (opcional)>", "Descricao":"<Descrição da Categoria 1 do Parceiro[TD_CT1.NOMCT1] (opcional)>", "CodigoExterno":"<Código Externo da Categoria 1 do Parceiro[TD_CT1.CODEXT_DCT1] (opcional)>" }, "Categoria2":{ "__comment__": "<Categoria 2 - TABELA TD_CT2>", "Codigo":"<Categoria 2 do Parceiro[TT_CLI.CODTAB] (opcional)>", "Descricao":"<Descrição da Categoria 2 do Parceiro[TD_CT2.NOMCT2] (opcional)>", "CodigoExterno":"<Código Externo da Categoria 2 do Parceiro[TD_CT2.CODEXT_DCT2] (opcional)>" }, "Categoria3":{ "__comment__": "<Categoria 3 - TABELA TD_CT3>", "Codigo":"<Categoria 3 do Parceiro[TT_CLI.CODTAB] (opcional)>", "Descricao":"<Descrição da Categoria 3 do Parceiro[TD_CT3.NOMCT3] (opcional)>", "CodigoExterno":"<Código Externo da Categoria 3 do Parceiro[TD_CT3.CODEXT_DCT3] (opcional)>" }, "RazaoSocial": "<Razão Social [TT_CLI.NOMCLI]>", "NomeFantasia": "<Sobrenome ou fantasia [TT_CLI.ULTNOM] (opcional)>", "Documento": "<CNPJ/CPF [TT_CLI.NUMDOC]>", "DocumentoVinculado": "<CNPJ/CPF [TT_CLI.NUMDOC] (opcional)>", "Documento2": "<IE/RG [TT_CLI.INSEST] (opcional)>", "Documento2Emissao": "", "Documento2Uf": "<UF do RG [TT_CLI.ID_EST] (opcional)>", "Documento2Orgao": "<Órgão Expeditor [TT_CLI.ID_ORG] (opcional)>", "TipoPessoa": "<Tipo de Pessoa (0 - Física; 1 - Jurídica; 2 - Entidade; 3 - Especial; 4 - M.E.; 5 - Filial) [TT_CLI.FLGTIP]>", "CodigoPais": "<País de Origem [TT_CLI.CODPAI>", "CodSex": "<Sexo do Cliente (0 - Não conhecido; 1 - Masculino; 2 - Feminino) [TT_CLI.CODSEX] (opcional)>", "DatNas": "<Data de Nascimento/Fundação [TT_CLI.DATNAS] (opcional)>", "DataOperacao": "<Data de operação (cadastramento) [TT_CLI.DATOPE]>", "eMail": "<E-Mail [TT_CLI.E_MCON ou TT_SPC.E_MAIL] (opcional)>", "EstadoCivil": "<Estado Civil (0 - Indefinido; 1 - Solteiro; 2 - Casado; 3 - Viúvo; 4 - Divorciado; 5 - União estável;
6 - Separado) [TT_CLI.ESTCIV] (opcional)>", "__comment__":"<Fidelização: [TD_FID.CODTAB - TCommerceAPI_ConsultaRetaguarda -> Origem - C; Tipo - 81 ->
Valor da coluna Fid_Chave do retorno]>", "FidelizacaoChave": "<Fidelização [TT_CLI.CODFID] (opcional)>", "Sufram": "<Superintendência da Zona Franca de Manaus [TT_CLI.SUFRAM] (opcional)>", "RegimeTributario": "<Regime Tributário (0 - Nenhum; 1 – Simples Nacional; 2 – Simples Nacional – excesso de sublimite de receita
bruta; 3 – Regime Normal)>", "Observ": "<Obervação para CheckOut [TT_CLI.OBSOUT] (opcional)>", "Revenda": "<É Revenda?>", "ValorLimiteCredito": "<Limite de Crédito [TT_CLI.VALOR1] (opcional)>", "VencimentoLimiteCredito": "<Validade do Limite [TT_CLI.VALLIM] (opcional)>", "Denegado": "<Cliente Denegado? (1 - Não; 2 - Sim; 3 - Sim. Permitir Vendas) [TT_CLI.DENEGA] (opcional)>", "CelularDDD": "<DDD Celular [TT_SPC.DDDCEL] (opcional)>", "Celular": "<Celular [TT_SPC.NUMCEL] (opcional)>", "AdministradoraDeCartao": "<Administradora de Cartões? (true ou false) [TT_REL.TIPPAR = C] (opcional - Padrão - false)", "Fornecedor": "<Fornecedor? (true ou false) [TT_REL.TIPPAR = F] (opcional - Padrão - false)", "IndicadorVenda": "<Indicador Venda? (true ou false) [TT_REL.TIPPAR = I] (opcional - Padrão - false)", "Marca": "<Marca? (true ou false) [TT_REL.TIPPAR = M] (opcional - Padrão - false)", "TecnicoInterno": "<Técnico Interno? (true ou false) [TT_REL.TIPPAR = N] (opcional - Padrão - false)", "Motorista": "<Motorista? (true ou false) [TT_REL.TIPPAR = O] (opcional - Padrão - false)", "Representante": "<Representante? (true ou false) [TT_REL.TIPPAR = R] (opcional - Padrão - false)", "Transportador": "<Transportador? (true ou false) [TT_REL.TIPPAR = T] (opcional - Padrão - false)", "ClienteTransportadora": "<Cliente Transportadora? (true ou false) [TT_REL.TIPPAR = A] (opcional - Padrão - false)", "TecnicoExterno": "<Técnico Externo? (true ou false) [TT_REL.TIPPAR = X] (opcional - Padrão - false)", "Contribuinte": "<Contribuinte de ICMS? (true ou false), "__comment__": "<Lista de Endereços>", "Enderecos": [{ "CodigoExterno": "<Código Externo do Endereço [TT_END.CODEXT]>", "CodFil": "<Filial do Endereço [TT_END.CODFIL] (opcional)>", "NumEnd": "<Número de Endereço [TT_END.NUMEND] (opcional)>", "__comment__":"<Tipo do Endereço: [TD_END.CODTAB - TCommerceAPI_ConsultaRetaguarda -> Origem - C; Tipo - 79 ->
Valor da coluna TipEnd_Chave do retorno]>", "Tipo": "<Tipo do Endereço [TT_END.TIPEND]>", "Logradouro": "<Endereço [TT_END.ENDERE]>", "Numero": "<Número [TT_END.NUMERO] (opcional)>", "Comple": "<Complemento [TT_END.COMPLE] (opcional)>", "Bairro": "<Bairro [TT_END.BAIRRO] (opcional)>", "CEP": "<CEP [TT_END.CODCEP - TT_END.CODLOG] (opcional)>", "DDD": "<DDD [TT_END.CODDDD] (opcional)>", "Telefone": "<Número do Telefone [TT_END.NUMFON] (opcional)>", "CodIbg": "<Código do IBGE do Município [TT_END.CODIBG] (opcional)>", "CodPai": "<País [TT_END.CODPAI]>", "Documento": "<Número do documento [TT_END.NUMDOC] (opcional)>", "Documento2": "<2º número do documento [TT_END.NUMDOC] (opcional)>", "InsMun": "<Inscrição Municipal [TT_END.INSMUN] (opcional)>" }] } }
- Parâmetros de Saída:
Exemplo de retorno com erro
{ "result": { "controle": { "err": true, "cod": "", "msg": "Mensagem de erro" } } } ou { "error": "Mensagem de erro" }
Exemplo de retorno com sucesso
{ "result": { "controle": { "err": false, "cod": 0, "msg": "" }, "conteudo": { "livre": { "FilCli": "<Filial do Parceiro [TT_CLI.FILCLI]>", "CodCli": "<Código do Parceiro [TT_CLI.CODCLI]>", "Enderecos": [{ "CodFil": "<Filial do Endereço [TT_END.CODFIL]>", "NumEnd": "<Número de Endereço [TT_END.NUMEND]>" }] } } } }
Exemplo de Parâmetros de Entrada
{ "Parceiro": { "CodigoExterno": "102548", "CodigoExternoVinculo": "", "FilCli": "", "CodCli": "", "FilVin": "", "CodVin": "", "Categoria1":{ "__comment__": "<Categoria 1 - TABELA TD_CT1>", "Codigo":"", "Descricao":"", "CodigoExterno":"" }, "Categoria2":{ "__comment__": "<Categoria 2 - TABELA TD_CT2>", "Codigo":"", "Descricao":"", "CodigoExterno":"" }, "Categoria3":{ "__comment__": "<Categoria 3 - TABELA TD_CT3>", "Codigo":"", "Descricao":"", "CodigoExterno":"" }, "RazaoSocial": "Teste API", "NomeFantasia": "", "Documento": "11111111111", "DocumentoVinculado": "", "Documento2": "", "Documento2Emissao": "", "Documento2Uf": "", "Documento2Orgao": "", "TipoPessoa": 0, "CodigoPais": 1058, "CodSex": 1, "DatNas": "", "DataOperacao": "28/06/2019 15:35:48", "eMail": "", "EstadoCivil": 0, "FidelizacaoChave": "", "Sufram": "", "RegimeTributario": "0", "Observ": "", "Revenda": "F", "ValorLimiteCredito": 0, "VencimentoLimiteCredito": "", "Denegado": 1, "CelularDDD": "", "Celular": "", "Enderecos": [{ "CodigoExterno": "9658742", "CodFil": "001", "NumEnd": "", "Tipo": 1, "Logradouro": "RUAJOAOPESSOA", "Numero": "158", "Comple": "", "Bairro": "", "CEP": "", "DDD": "", "Telefone": "", "CodIbg": 4202404, "CodPai": 1058, "Documento": "", "Documento2": "", "InsMun": "" }, { "CodigoExterno": "1258632", "CodFil": "001", "NumEnd": "", "Tipo": 1, "Logradouro": "RUAMONTECARLO", "Numero": "125", "Comple": "", "Bairro": "", "CEP": "", "DDD": "", "Telefone": "", "CodIbg": 4202404, "CodPai": 1058, "Documento": "", "Documento2": "", "InsMun": "" }] } }
Exemplo de retorno com sucesso
{ "result": { "controle": { "err": false, "cod": 0, "msg": "" }, "conteudo": { "livre": { "FilCli": "001", "CodCli": "1510", "Enderecos": [{ "CodFil": "001", "NumEnd": "1" }, { "CodFil": "001", "NumEnd": "2" } ] } } } }