Exportação de Correntistas (v.2)

Esta consulta disponibiliza todas as informações do cadastro de correntistas e pré-clientes. Os dados de correntistas podem abranger diferentes perfis, como cliente, fornecedor, transportador e representante utilizando o filtro tipo_correntista****.

Caso o cadastro ainda não esteja completo, ou seja, o registro esteja classificado como pré-cliente, alguns dados serão exportados, porém de forma limitada, devido à ausência de informações obrigatórias. No entanto, se houver um cadastro de correntista vinculado ao mesmo CNPJ, a API retornará automaticamente os dados mais completos disponíveis para esse registro.

Há a possibilidade de não incluir, na resposta da consulta, determinadas informações como: tipos de cliente, vendedores vinculados, formas de pagamento e itens associados ao cliente. Para isso, estão disponíveis os seguintes filtros: lista_tipo_cliente, lista_vendedor, lista_forma_pagamento e lista_itens.

Cada um desses filtros aceita os valores "S" (Sim) ou "N" (Não), indicando se a respectiva informação deve ou não ser incluída na resposta. Por padrão, todos esses filtros estão configurados como "S", ou seja, os dados serão exibidos, a menos que especificado o contrário.

Filtros

Alguns campos podem ser utilizados como filtros para tornar a consulta mais específica.

A seguir, estão listados os campos disponíveis para filtragem:

cliente

cnpj_cpf

data_alteracao

data_alteracao_fim

tipo_correntista

conceito

lista_tipo_cliente

lista_vendedor

lista_forma_pagamento

lista_itens

Fonte dos dados

PCAD001 - Cadastro de Correntistas

PCRM005 - Cadastro de Pré-Clientes

PCADP01 - Vinculação do Vendedor ao Correntista

PRCBP01 - Condições de Pagamento

PCAD020 - Cadastro de Itens (Aba Correntistas)

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Exemplo

{
  "tipoComando": "ASDCOMANDOJSONTMP",
  "grupoComando": "EXP_CLIENTES_V2",
  "data_alteracao": "dd/mm/yyyy hh24:mi:ss"
}

Respostas

🟢200

application/json

Bodyapplication/json

Exemplo

{
  "codigo_erp": "<integer>",
  "cnpj_cpf": "<string>",
  "rg": "<string>",
  "insc_estadual": "<string>",
  "tipo_pessoa": "<string>",
  "nome": "<string>",
  "nome_fantasia": "<string>",
  "conceito": "<integer>",
  "descricao_conceito": "<string>",
  "fone": "<string>",
  "celular": "<string>",
  "e_mail": "<string>",
  "data_alteracao": "<string>",
  "usuario_alteracao": "<integer>",
  "tributacao_ir": "<string>",
  "codigo_regiao": "<integer>",
  "desc_regiao": "<string>",
  "codigo_subregiao": "<integer>",
  "desc_subregiao": "<string>",
  "destino_mercadoria": "<string>",
  "codigo_segmento_mercado": "<integer>",
  "desc_segmento_mercado": "<string>",
  "codigo_subsegmento_mercado": "<integer>",
  "desc_subsegmentomerc_descricao": "<string>",
  "contribui_icms": "<string>",
  "obs_geral": "<string>",
  "status": "<string>",
  "tipo": "<string>",
  "transportador": "<integer>",
  "nome_transportador": "<string>",
  "operador_tmkt": "<integer>",
  "nome_operador_tmkt": "<string>",
  "endereco": [
    {
      "endereco": "<string>",
      "numero": "<string>",
      "complemento": "<string>",
      "bairro": "<string>",
      "cep": "<integer>",
      "codigo_cidade": "<integer>",
      "cidade": "<string>",
      "uf": "<string>",
      "ibge": "<integer>",
      "tipo_endereco": "<string>"
    }
  ],
  "tipo_cliente": [
    {
      "tipo_correntista": "<string>"
    }
  ],
  "vendedor": [
    {
      "empresa": "<integer>",
      "codigo_vendedor": "<integer>",
      "nome_vendedor": "<string>",
      "digita_pedidos": "<string>",
      "data_vinculacao": "<string>",
      "exibir_historico": "<string>"
    }
  ],
  "forma_pagamento": [
    {
      "parcela": "<integer>",
      "dias": "<integer>",
      "tipo_parcela": "<string>",
      "fator": "<integer>",
      "codigo_forma_recebimento": "<integer>",
      "desc_forma_recebimento": "<string>"
    }
  ],
  "itens": [
    {
      "empresa": "<integer>",
      "codigo_item": "<string>",
      "descricao_item": "<string>",
      "localizacao_acessorio": "<string>",
      "letra_desconto": "<string>",
      "tolerancia_menos": "<integer>",
      "tolerancia_mais": "<integer>"
    }
  ]
}

Filtros#

Fonte dos dados#

Requisição

Respostas

Filtros

Fonte dos dados