v1

latestOpenAPI 3.1.02026-08-041420513.7 KB

Iniciar processo

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

post/v1/accountingfirms/{accountingFirmId}/process

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

startDatestring date

Data de início do processo.

complementstring

Complemento do processo.

customerIdsstring[]

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

processTemplateIdstring

Id do template de processo.

isDepartmentCustomerRepresentativestring

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

inChargeUserIdstring

Responsável pelo processo.

Response

200

totalProcessesstring
startDatestring
statusstring

Example response

{
  "totalProcesses": "int",
  "startDate": "Datetime",
  "status": "int"
}