API Reference

Iniciar processo

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

Permite iniciar um processo a partir de um template de processo vinculado ao escritório.

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

Dicionário para propriedades retornadas

status

Essa propriedade representa o status do documento:

  • 1- Agendado
  • 2- Iniciado
  • 3- Completo
  • 4- Cancelado

Response body

  • totalProcesses - Total de processos criados
  • startDate - Data de início dos processos
  • status - Status do processo
Path Params
string
required

Id do escritório.

Body Params
date
Defaults to Obrigatório

Data de início do processo.

string
Defaults to Opcional

Complemento do processo.

customerIds
array of strings
Defaults to Obrigatório

Lista com Ids dos clientes que serão vinculados ao processo.

customerIds
string

Id do template de processo.

string
Defaults to Opcional

Determina se o responsável é o responsável do cliente no respectivo departamento.

string
Defaults to Obrigatório caso não IsDepartmentCustomerRepresentative há

Responsável pelo processo.

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