Este webhook é disparado sempre que um documento é cadastrado no módulo Q-Colabore.
O envio ocorre exclusivamente do escritório para usuários da empresa.
Regras gerais:
O tipo de módulo deve ser identificado através do campo:
“PastaPrincipal” = "Q-Colabore"
A estrutura do JSON é única.
Alguns campos podem ou não estar presentes, dependendo do contexto do envio e da configuração da pasta.
{
“Dados”:{
‘IdCodigoDocumento’: number,
“IdPasta”: number,
"PastaPrincipal': string,
“IdSubpasta”: number,
“Subpasta”: string,
“Assunto”: string,
“Status”: string,
“IdUsuarioEnviadoPor”: number,
“NomeEnviadoPor”: string,
“EmailEnviadoPor”: string,
“DataCriacao”: datatime,
“Observacao”: string | null,
“Atributos”: object | null,
“Destinatarios”: array,
“Arquivo”: object
}
}
Confira, a seguir, as regras para o campo apresentado:
"PastaPrincipal"
Valor fixo para este módulo:
"Q-Colabore"
O objeto Atributos é variável e depende exclusivamente da configuração da pasta no Q-colabore.
Possíveis campos:
|
Campo |
Tipo |
Obrigatório |
| DataVencimento | datetime | Não |
| Competencia | datetime | Não |
| Valor | decimal | Não |
Regras:
{ }nullO campo “Destinatarios”:
“Destinatarios”: [
{
“IdEmpresa”: number,
“CnpjEmpresa”: string,
“NomeEmpresa”: string,
“IdUsuarioEmpresa”: string,
“EmailUsuarioEmpresa”: string,
}
]
Segue o mesmo padrão:
“Arquivo”: {
“NomeDoArquivo”: string,
“ContentType”: string,
“Base64”: string
}
Regras:
Para configurar o módulo especifico Q-colabore, confira nosso material especifico: