API Reference

Criar cliente

post
https://api.nibo.com.br/accountant/api/v1/accountingfirms//customers

Permite criar um cliente para um determinado escritório.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Dicionário para propriedades retornadas

taxRegime

Essa propriedade representa o regime tributário do cliente:

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

businessActivity

Essa propriedade representa a atividade econômica do cliente:

  • 0 - Não especificado
  • 1 - Comércio
  • 2 - Serviço
  • 4 - Indústria
  • 3 - Comércio e Serviço
  • 5 - Comércio e Indústria
  • 7 - Comércio, Serviço e Indústria
  • 6 - Serviço e Indústria

documentType

Essa propriedade representa o tipo de documento do cliente:

  • 1 - CNPJ
  • 2 - CPF
Path Params
string
required

Id do escritório.

Body Params
string
Defaults to Obrigatório

Nome do cliente.

string
Defaults to Obrigatório

Código do cliente.

boolean
Defaults to false

Permite enviar e-mail com lembrete no dia de vencimento de impostos

boolean
Defaults to false

Permitir visualização de documentos do cliente sem login.

string
Defaults to Obrigatório

Número de documento do cliente (CPF ou CNPJ).

string
Defaults to Opcional

CEI do cliente.

string
Defaults to Opcional

CAEPF do cliente (Somente para Pessoa física).

string
Defaults to Opcional

Inscrição Estadual do cliente.

string
Defaults to Opcional

Inscrição Municipal do cliente.

int32
Defaults to null

Regime tributário do cliente.

int32
Defaults to null

Ramo de atividade do cliente.

CustomerAddress
array

Endereço do cliente.

CustomerAddress
Headers
string

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

string

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Responses

Updated 3 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago