Comunicar à AT

Comunica o documento à Autoridade Tributária via WebServices.

Comunicar Documento por Webservice

A utilização deste endpoint requer que tenha activada a comunicação de documentos por webservice e configuradas as credenciais de acesso ao serviço da Autoridade Tributária no seu BackOffice.

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

Path Parameters

Name	Type	Description
id*	integer	ID do Documento

Exemplo de Pedido

curl -X POST https://api.cloudinvoice.net/documents/7/communicate/

Exemplo de Resposta

{
    "id": 7,
    "doc_key": "GTR A01/1",
    "document_nature_id": 322,
    "document_nature": {
        "code": "GT",
        "description": "Guia de Transporte"
    },
    "document_id": 9,
    "document": {
        "code": "GTR",
        "document_name": "Guia de Transporte",
        "ask_payment_onclose": false
    },
    "document_serie_id": 22,
    "document_serie": {
        "code": "A01",
        "description": "A01"
    },
    "document_status_id": 1202,
    "document_status": {
        "code": "F",
        "description": "Finalizado"
    },
    "at_report_status_id": 1182,
    "at_report_status": {
        "code": "C",
        "description": "Comunicado"
    },
    "document_date": "2026-08-31",
    "document_time": "16:55:43",
    "document_number": 1,
    "document_reference": "",
    "our_reference": "",
    "party_reference": "",
    "module_origin": 1,
    "warehouse_id": 1,
    "warehouse": {
        "code": 1,
        "description": "Armazém 1"
    },
    "target_warehouse_id": null,
    "target_warehouse": null,
    "origin_document_header_id": null,
    "origin_document_header": null,
    "salesman_id": null,
    "salesman": null,
    "party_id": 2,
    "party": {
        "class": 1601,
        "code": 2,
        "name": "Cliente Demo",
        "commercial_name": "",
        "fiscal_number": "123456789",
        "street1": "Rua Principal",
        "street2": "",
        "zip_code": "8800-123",
        "zip_locale": "Tavira"
    },
    "payment_term_id": 1,
    "payment_term": {
        "code": 1,
        "description": "Pronto Pagamento"
    },
    "payment_method_id": null,
    "payment_method": null,
    "line_details_count": 1,
    "lines_total_quantity": 1.0,
    "is_valued": true,
    "is_tax_included": false,
    "total_gross_amount": 10.0,
    "global_discount1": 0.0,
    "total_global_discount": 0.0,
    "total_line_discount": 0.0,
    "total_net_amount": 10.0,
    "total_taxes_amount": 2.3,
    "total_amount": 12.3,
    "total_document_amount": 12.3,
    "total_round_amount": 0.0,
    "total_due_amount": 0.0,
    "due_date": "2026-08-31",
    "header_text": "",
    "footer_text": "",
    "number_of_prints": 0,
    "is_converted": false,
    "is_transport_document": true,
    "load_date": "2026-08-31 17:00:37",
    "load_shipment_id": 1,
    "load_shipment": {
        "code": 1,
        "description": "Nossas instalações"
    },
    "ship_from_street1": "Morada do Estabelecimento",
    "ship_from_street2": "",
    "ship_from_city": "",
    "ship_from_zip_code": "8800-123",
    "ship_from_zip_locale": "Tavira",
    "ship_from_warehouse_id": 1,
    "ship_from_warehouse": {
        "code": 1,
        "description": "Armazém 1"
    },
    "unload_date": null,
    "unload_shipment_id": 5,
    "unload_shipment": {
        "code": 11,
        "description": "Morada do Destinatário"
    },
    "ship_to_street1": "Rua Principal",
    "ship_to_street2": "",
    "ship_to_city": "",
    "ship_to_zip_code": "8800-123",
    "ship_to_zip_locale": "Tavira",
    "ship_to_party_address_id": null,
    "ship_to_party_address": null,
    "has_withholding": false,
    "obs": ""
}

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