Inserir cliente

Crie novos clientes no Sankhya ERP através da API de serviços

Parâmetros

Campo	Tipo	Descrição
Conta de serviço	Select	Permite o acesso ao sistema através de credenciais fornecidas no painel de contas do Floui.
Tipo pessoa	String	Define o perfil do cliente. F para pessoa física ou J para pessoa jurídica.
CPF / CNPJ	String	Valor associado ao tipo de pessoa.
Nome do parceiro	Select	Define o nome do parceiro.
Código da cidade	String	Define uma cidade já cadastrada.
Parceiro ativo	String	Define o estado do parceiro. S para sim e N para não.
Classificação ICMS	String	Código de classificação do ICMS. C para "Consumidor final não contribuinte" ou P para "Produtor rural".
Retornar dados em modo simplificado	Select	Retorno simplificado ao invés da resposta padrão da Sankhya.
Output path	String	Armazena os dados de saída do conector ao final da execução.
Descrição	String	Mensagem visual para descrever a função do conector no contexto do fluxo.

Cadastro de Clientes

post

Regras de negócio

Para realizar o cadastro de clientes é utilizado entidade no cadastro parceiros.No sistema ERP é possível selecionar mais de uma opção para o mesmo parceiro, desde que ele exerça as funções selecionadas junto à empresa. De acordo com as opções definidas, o parceiro estará visível em rotinas diferentes no sistema.

OBS: Caso tenha alguma necessidade de configuração do ERP procure “consultor” ou acesso o link de apoio:
https://ajuda.sankhya.com.br/hc/pt-br/articles/360044599814-Bairro

Dependências

No cadastro de parceiro, a cidade deve constar no cadastro do ERP Sankhya-Om.

Caso não seja informado o CPF ou CNPJ no campo CGC_CPF, deve se informar no campo CLASSIFICMS como("C" - Consumidor Final Não Contribuinte ou P-Produtor Rural).
Para cadastro de clientes, basta acrescentar o campo "CLIENTE"no corpo da requisição do JSON indicando "S" para Sim para indicar que o parceiro é cliente.

Detalhes Técnicos

A entidade utilizada é a Parceiro que por sua vez instancia a tabela TGFPAR mapeando os campos principais pertinentes ao cadastro de clientes.
Para realizar a importação do cadastro de clientes através do Json, os campos abaixo são obrigatórios:

• TIPPESSOA – Pessoa Física ou Jurídica;
• NOMEPARC – Nome do Parceiro;
• CODCID – Código de cidade;
• ATIVO – Parceiro ativo(S - Sim ou N - Não);
• CLIENTE – Parceiro é cliente(S - Sim ou N - Não);
• CLASSIFICMS – ("C" - Consumidor Final Não Contribuinte ou P-Produtor Rural).

Descritivo de campos da entidade

Acesse aqui o dicionário de dados da tabela TGFPAR

Exemplo de uso:

URL de chamada: https://api.sankhya.com.br/gateway/v1/mge/service.sbr?serviceName=CRUDServiceProvider.saveRecord&outputType=json

Corpo de requisição

{  "serviceName":"CRUDServiceProvider.saveRecord",
   "requestBody":{
      "dataSet":{
         "rootEntity":"Parceiro",
         "includePresentationFields":"S",
         "dataRow":{
            "localFields":{
               "TIPPESSOA":{
                  "$":"F"
               },               
               "NOMEPARC":{
                  "$":"JON SNOW"
               },               
               "CODCID":{
                  "$":"10"
               },               
               "ATIVO":{
                  "$":"S"
               },
                "CLIENTE":{
                    "$":"S"
                },
                "CLASSIFICMS":{
                    "$":"C"
                }
            }
         }, "entity":{
            "fieldset":{
               "list":"CODPARC,TIPPESSOA,NOMEPARC,CODCID,ATIVO,CLIENTE,CLASSIFICMS"
            }
         }
      }
   }
}

Retorno em json:

{
    "serviceName": "CRUDServiceProvider.saveRecord",
    "status": "1",
    "pendingPrinting": "false",
    "transactionId": "F58A5ED2A26C41F5536A63B7DB34FAE8",
    "responseBody": {
        "entities": {
            "total": "1",
            "entity": {
                "TIPPESSOA": {
                    "$": "F"
                },
                "ATIVO": {
                    "$": "S"
                },
                "NOMEPARC": {
                    "$": "JON SNOW"
                },
                "CLASSIFICMS": {
                    "$": "C"
                },
                "CODPARC": {
                    "$": "569"
                },
                "CODCID": {
                    "$": "10"
                },
                "CLIENTE": {
                    "$": "S"
                },
                "Cidade_NOMECID": {
                    "$": "TESTE"
                }
            }
        }
    }
}

Responses

201

Cadastro efetuado com sucesso

No content

400

Requisição inválida

500

Erro interno do servidor

post/Clientes

POST /Clientes HTTP/1.1
Accept: */*

No content