v1

latestOpenAPI 3.1.02026-08-041420513.7 KB

Criar cliente

Permite criar um cliente para um determinado escritório.

post/v1/accountingfirms/{accountingFirmId}/customers

Path parameters

accountingFirmIdstring required

Id do escritório.

Headers

X-API-Keystring

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

X-User-Idstring

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

Request body

Namestring

Nome do cliente.

Codestring

Código do cliente.

IsDailyAgendaEmailEnabledboolean

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

AllowsAnonymousAccessToFiledboolean

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

DocumentNumberstring

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

Ceistring

CEI do cliente.

Caepfstring

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

stateRegistrationstring

Inscrição Estadual do cliente.

cityRegistrationstring

Inscrição Municipal do cliente.

TaxRegimeinteger

Regime tributário do cliente.

BusinessActivityinteger

Ramo de atividade do cliente.

Response

200

Idstring

Namestring

Codestring

NiboDocsEnabledstring

Cnaesobject[]

Tagsobject[]

BusinessActivitystring

DocumentNumberstring

DocumentTypestring

IsOwnAccountantstring

TaxRegimestring

CreatedAtstring

CreatedBystring

InactiveDatestring

InactiveUserstring

Example response

{
  "Id": "Id",
  "Name": "string",
  "Code": "string",
  "NiboDocsEnabled": "bool",
  "Address": {
    "City": "string?",
    "Complement": "string?",
    "District": "string?",
    "State": "string?",
    "Number": "string?",
    "PostalCode": "string?",
    "Street": "string?"
  },
  "BusinessActivity": "int?",
  "DocumentNumber": "string",
  "DocumentType": "int",
  "IsOwnAccountant": "bool",
  "TaxRegime": "int?",
  "CreatedAt": "DateTime",
  "CreatedBy": "string",
  "InactiveDate": "DateTime?",
  "InactiveUser": "string?"
}