API Reference

Listar clientes

Permite obter uma lista paginada de até 100 clientes vinculados a um escritório contábil, com suporte a OData.

Nessa rota da API, o campo de endereço do cliente agora pode ser usado nos filtros da URL. Isso significa que você pode buscar clientes com base em informações como cidade, estado ou CEP diretamente pela chamada da API, usando a sintaxe Address/NomeDoCampo.

Para utilizar o filtro, basta referenciar o campo desejado do endereço na URL. Por exemplo, para buscar clientes cuja cidade seja "São Paulo", a consulta OData será:

https://api.nibo.com.br/accountant/api/v1/accountingfirms?$filter=Address/City eq 'São Paulo'

Outro exemplo seria buscar clientes com um CEP específico. Para filtrar clientes com o CEP "01310-100", a consulta seria:

https://api.nibo.com.br/accountant/api/v1/accountingfirms?$filter=Address/PostalCode eq '01310-100'

Para filtrar por outros campos do endereço pasta substituir para a propriedade desejada.


Dicionário para propriedades retornadas

documentType

Essa propriedade representa o tipo de documento do cliente:

  • 0 - Não especificado
  • 1 - Pessoa Jurídica (CNPJ)
  • 2 - Pessoa Física (CPF)

taxRegime

Essa propriedade representa o regime tributário da empresa:

  • 0 - Não especificado
  • 1 - Lucro Real
  • 2 - Lucro Presumido
  • 3 - Lucro Arbitrado
  • 4 - Simples Nacional
  • 5 - Microempreendedor Individual
  • 6 - Isento/Imune

businessActivity

Essa propriedade utiliza flags (pode combinar valores) e representa os tipos de atividade empresarial:

  • 0 - Não especificado
  • 1 - Comércio
  • 2 - Serviço
  • 4 - Indústria
Combinações possíveis:
  • 3 - Comércio e Serviço (1 | 2)
  • 5 - Comércio e Indústria (1 | 4)
  • 6 - Serviço e Indústria (2 | 4)
  • 7 - Comércio, Serviço e Indústria (1 | 2 | 4)
Language
Click Try It! to start a request and see the response here!