Annul

A anulação de um documento não poderá ser revertida em circunstância alguma.

Anular Documento

Anula documento finalizado.

POST https://api.cloudinvoice.net/documents/:id/annul/

Path Parameters

Name	Type	Description
id*	integer	ID do Documento

Request Body

Name	Type	Description
print	boolean	Imprimir Documento após criação. Apenas pode imprimir documentos finalizados/anulados. Consulte os parâmetros disponíveis para impressão no Apêndice.
status_reason*	string	Motivo da Anulação
email	boolean	Enviar por E-mail após criação. Apenas pode enviar por e-mail documentos finalizados/anulados. Consulte os parâmetros disponíveis para impressão no Apêndice.

200: OK Devolve ficha completa do documento

400: Bad Request Lista de erros detectados

401 (Sem Resposta)

{
    // Response
}

403: Forbidden (Sem Resposta)

{
    // Response
}

Exemplo de Pedido

curl -X POST https://api.cloudinvoice.net/documents/1/annul/

Exemplo de Resposta

{
    "id": 7641,
    "doc_key": "FSI A2023-1/214",
    "document_date": "2023-01-11",
    "document_time": "13:32:36",
    "document_number": 214,
    "document_reference": "",
    "our_reference": "",
    "module_origin": 1,
    "party_id": 1,
    "line_details_count": 2,
    "lines_total_quantity": 3.0,
    "is_valued": true,
    "is_tax_included": true,
    "total_gross_amount": 5.23,
    "global_discount1": 0.0,
    "total_global_discount": 0.0,
    "total_line_discount": 0.0,
    "total_net_amount": 4.2520325203,
    "total_taxes_amount": 0.9779674797,
    "total_amount": 5.23,
    "total_document_amount": 5.23,
    "total_due_amount": 0.0,
    "due_date": "2023-01-11",
    "is_converted": false,
    "header_text": "",
    "footer_text": "",
    "number_of_prints": 0,
    "is_transport_document": false,
    "obs": "",
    "document_nature_id": 302,
    "document_id": 2,
    "document": {
        "code": "FSI", 
        "document_name": "Factura Simplificada", 
        "ask_payment_onclose": true
    },
    "document_serie_id": 6,
    "document_serie": {
        "code": "A2023-1", 
        "description": "Série A2023-1"
    },
    "document_status_id": 1203,
    "warehouse_id": 1,
    "warehouse": {
        "code": 1, 
        "description": "Armazém 1"
    },
    "salesman_id": 1,
    "salesman": {
        "code": 1, 
        "salesman_name": "Empregado 1"
    },
    "payment_term_id": 1,
    "payment_term": {
        "code": 1,
        "description": "Pronto Pagamento"
    },
    "payment_method_id": 1,
    "payment_method": {
        "code": 1,
        "description": "Dinheiro"
    },
    "origin_document_header_id": null,
    "origin_document_header": null,
    "document_nature": {
        "code": "FS", 
        "description": "Factura Simplificada"
    },
    "document_status": {
        "code": "A",
        "description": "Anulado"
    },
    "party": {
        "class": 1601,
        "code": 1,
        "name": "Consumidor Final",
        "commercial_name": "",
        "fiscal_number": "999999990",
        "street1": "",
        "street2": "",
        "zip_code": "",
        "zip_locale": ""
    },
    "print":{
        "filename": "FS__FSI_A2023_1_219__2023_01_11_1673450093.pdf",
        "url": "https://app.cloudinvoice/downloads/xxxxxxxxxx-xxxx-xxx-xxxx-xxxxxxxxx/download_file/?direct=true&compressed=false"
    }
}

Para ver exemplos de pedidos nas várias linguagens, consulte a página Exemplos de Pedidos.