v1

latestOpenAPI 3.0.3Licença Sankhya2026-07-24161242654.8 KB

Clientes

Retornar lista de clientes

Permite acessar a lista de clientes cadastrados no ERP. A resposta da API contém apenas os clientes ativos ou inativos que já foram cadastrados previamente no ERP.

get/v1/parceiros/clientes

Query parameters

pageinteger required

Example:1

Informe neste atributo a "página" desejada

dataHoraAlteracaostring

Example:28/01/2025 16:24

Informe neste atributo a data e hora da alteração do registro. Enviando este atributo, o serviço irá retornar apenas registros que tiveram alteração maior ou igual ao valor informado. O padrão de envio é "dd/mm/aaaa hh:mm"

Response

Operação bem sucedida. Clique aqui para mais detalhes.

codigointeger

tipostring

mensagemstring

pageinteger

numeroRegistrosinteger

temMaisRegistrosboolean

Example response

{
  "page": 2,
  "numeroRegistros": 50,
  "temMaisRegistros": true,
  "clientes": [
    {
      "tipo": "PF",
      "cnpjCpf": "12315914799",
      "ieRg": "12315914799",
      "nome": "José da Silva",
      "razao": "José da Silva ME",
      "email": "contato@provedor.com.br",
      "telefoneDdd": "34",
      "telefoneNumero": "912349966",
      "limiteCredito": 10500,
      "grupoAutorizacao": "AB",
      "endereco": {
        "logradouro": "Rua Maria Roberta",
        "complemento": "Apto 104",
        "bairro": "Centro",
        "cidade": "Uberlândia",
        "uf": "MG"
      },
      "camposAdicionais": {
        "AD_TESTE_API_CAMPO_ADICIONAL_1": "Conteudo do campo 01",
        "AD_TESTE_API_CAMPO_ADICIONAL_2": "Conteudo do campo 02",
        "AD_TESTE_API_CAMPO_ADICIONAL_3": "Conteudo do campo 03",
        "AD_TESTE_API_CAMPO_ADICIONAL_4": "Conteudo do campo 04"
      },
      "codigoCliente": 5
    }
  ]
}