Moloni API / Endpoints / Documents / Documents / documentCancel

documentCancel

Disponível na versão: 1.26+

Permite colocar um documento no estado anulado (status 2).

Apenas podem ser anulados documentos:

No estado "fechado" (status 1);
Não estejam pendentes de comunicação à autoridade tributária;
Sem código AT associado (guias de transporte);
Não deram origem a qualquer documento;
Tipo de documento permita anulação;

Pedido

https://api.moloni.pt/v1/documents/documentCancel/?access_token=[current_access_token]

Parâmetros

company_id int

Preenchimento obrigatório

document_id int

Preenchimento obrigatório

observation string

Nota
- O parâmetro qty tem como default 50 e o offset 0, sendo que o máximo qty é 50;
- Campos de preenchimento facultativo, significa que podem ser uma string vazia ou zero, dependendo do respectivo tipo.

Resposta

{
	valid: int,
	message: string
}

Lista de erros possíveis

Sempre que existir um erro no preenchimento dos campos, será devolvido via JSON o objeto com os erros indexado pela ordem dos campos.
As mensagens de erro, são devolvidas sob a forma de códigos, e para perceber quais os erros disponíveis e como interpretar as mensagens recebidas, consulte esta ligação.

Software de faturação online

Certificado pela Autoridade Tributária N.º 2860