Consultar

Requisição

GET [Url Ambiente]/clifors/

Header

Identificador	Valor
Accept	application/json
X-Api-Key	Token de acesso à API
x-idtokenoper	Token do contrato

Query

Parâmetro	Descrição	Tipo	Exemplos
busca	(Opcional) Termos para filtragem de resultados	String	"José"
tipo_busca	(Opcional) Tipo de busca para filtragem de resultados	String	"nome"

Tipos de busca

Tipo	Descrição
nome	Busca pelo campo "nome" do cliente/fornecedor
nome_completo	Busca pelo campo "nome_completo" do cliente/fornecedor
nome_fantasia	Busca pelo campo "nome_fantasia" do cliente/fornecedor
cpf	Busca pelo documento de "CPF" do cliente/fornecedor
cnpj	Busca pelo documento de "CNPJ" do cliente/fornecedor

Exemplo

curl -X GET --header 'Accept: application/json' --header 'X-Api-Key: e26f1ae9-d729-4fa9-bdd9-d2cbdcb5fa94' --header 'x-idtokenoper: 0c3a7999-06c9-4680-8a8a-aeb57965c468' 'https://sistemacontas.com.br/contas/api/v1/clifors?busca=Jose&tipo_busca=nome'

Resposta

Status Code 200

Retorno de sucesso.

Em caso de sucesso é retornada uma lista de objetos de clientes/fornecedores. Seguem campos que são retornados na consulta:

Parâmetro	Descrição	Tipo	Exemplos
idclifor	Código do cliente/fornecedor	Integer	20183
nome	Nome	String	"José Silva"
nome_completo	Nome completo	String	"Antônio José da Silva"
relacionamento	Tipo de relacionamento (CLIENTE, FORNECEDOR, ...)	String	"CLIENTE"
ativo	Indica se o cliente/fornecedor está ativo	Boolean	true
nome_fantasia	Nome fantasia	String	"Antônio José da Silva"
logotipo	URL do logotipo	String	"https://sistemacontas.com.br/contas/utils/show-clifor-logotipo?id=111&idtokenoper=1"
documentacao	Objeto com dados de documentação	Object
documentacao.tipo_pessoa	Tipo de pessoa (F = Física, J = Jurídica, E = Estrangeiro)	String	"F"
documentacao.cpf	CPF do cliente/fornecedor	String	"123.456.789.10"
documentacao.rg	Registro geral do cliente/fornecedor	String	"12345678910"
documentacao.rg_orgao_emissor	Orgão emissor do RG	String	"SSP-CE"
documentacao.sexo	Sexo do cliente/fornecedor (M = Masculino, F = Feminino)	String	"M"
documentacao.data_nascimento	Data de nascimento (aaaa-mm-dd)	String	"1980-01-01"
documentacao.cnpj	CNPJ do cliente/fornecedor	String	"12.345.678/0001-10"
documentacao.insc_municipal	Inscrição municipal, caso tipo_pessoa Jurídica	String
documentacao.insc_estadual	Inscrição estadual, caso tipo_pessoa Jurídica	String
documentacao.atividade_principal	Atividade principal da Pessoa Jurídica	String
documentacao.passaporte	Passaporte, caso tipo_pessoa = Estrangeiro	String
documentacao.pais_origem	País de origem do passaporte	String
documentacao.retem_iss	Indica se a empresa retém ISS, caso tipo_pessoa = Jurídica	Boolean	false
documentacao.estado_civil	Estado civil do cliente/fornecedor	String
documentacao.idconjuge	Código do cônjuge	Integer
documentacao.nacionalidade	Nacionalidade do cliente/fornecedor	String	"Brasileiro"
documentacao.profissao	Profissão do cliente/fornecedor	String
enderecos	Lista de endereços
enderecos[i].tipo_endereco	Tipo de endereço (PRINCIPAL, FINANCEIRO, LOGISTICO)	String
enderecos[i].cep	CEP	String
enderecos[i].logradouro	Logradouro	String
enderecos[i].numero	Número	String
enderecos[i].complemento	Complemento	String
enderecos[i].bairro	Bairro	String
enderecos[i].cidade	Cidade	String
enderecos[i].uf	Estado	String
enderecos[i].pais	País	String
enderecos[i].fone1	Telefone para contato	String
enderecos[i].tipo_fone1	Tipo de telefone (CELULAR, FAX, FIXO, OUTROS, WHATSAPP)	String
enderecos[i].fone2	Telefone alternativo para contato	String
enderecos[i].tipo_fone2	Tipo de telefone alternativo (CELULAR, FAX, FIXO, OUTROS, WHATSAPP)	String
enderecos[i].email	Email	String

[
    {
        "idclifor": 20183,
        "nome": "JOSE SILVA",
        "nome_completo": "ANTONIO JOSE DA SILVA",
        "relacionamento": "CLIENTE",
        "ativo": true,
        "nome_fantasia": "ANTONIO JOSE DA SILVA",
        "logotipo": null,
        "documentacao": {
            "tipo_pessoa": "F",
            "cpf": "123.456.789-10",
            "rg": "12345678910",
            "rg_orgao_emissor": "SSP-CE",
            "sexo": "M",
            "data_nascimento": "1980-01-01",
            "cnpj": null,
            "insc_municipal": null,
            "insc_estadual": null,
            "atividade_principal": null,
            "passaporte": null,
            "pais_origem": null,
            "retem_iss": false,
            "estado_civil": null,
            "idconjuge": null,
            "nacionalidade": null,
            "profissao": null
        },
        "enderecos": [
            {
                "tipo_endereco": "PRINCIPAL",
                "cep": "61.600-000",
                "logradouro": "RUA X",
                "numero": "123",
                "complemento": null,
                "bairro": "BAIRRO X",
                "cidade": "CIDADE X",
                "uf": "CE",
                "pais": "BRA",
                "fone1": null,
                "tipo_fone1": null,
                "fone2": "(85) 99999-9999",
                "tipo_fone2": "CELULAR",
                "email": null
            }
        ],
        "contatos": [
            {
                "nome": "",
                "email": null,
                "fone": "(85) 99999-9999",
                "tipo_fone": "CELULAR"
            }
        ],
        "dados_bancarios": []
    },
    ...
]