Get

Obter Documento

Devolve Documento a partir do seu :id.

GET https://api.cloudinvoice.net/documents/:id/

Path Parameters

Name	Type	Description
id*	integer	O ID do documento que pretende.

200: OK Devolve ficha completa do documento

400: Bad Request Lista de erros detectados

401 (Sem Resposta)

{
    // Response
}

403: Forbidden (Sem Resposta)

{
    // Response
}

404 Não existe nenhum documento com :id

{
    // Response
}

Exemplo de Pedido

curl https://api.cloudinvoice.net/documents/1/
    -H "Content-Type: application/json"

Exemplo de Resposta

{
    "id": 7621,
    "doc_key": "FSI A2023-1/213",
    "document_date": "2023-01-10",
    "document_time": "11:30:48",
    "document_number": 213,
    "document_reference": "",
    "our_reference": "",
    "module_origin": 2,
    "party_id": 1,
    "line_details_count": 5,
    "lines_total_quantity": 9.0,
    "is_valued": true,
    "is_tax_included": true,
    "total_gross_amount": 54.9,
    "global_discount1": 0.0,
    "total_global_discount": 0.0,
    "total_line_discount": 0.0,
    "total_net_amount": 44.6341463414,
    "total_taxes_amount": 10.2658536586,
    "total_amount": 54.9,
    "total_document_amount": 54.9,
    "total_round_amount": 0.0,
    "total_due_amount": 0.0,
    "due_date": "2023-01-10",
    "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": 1202,
    "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": "F",
        "description": "Finalizado"
    },
    "party": {
        "class": 1601,
        "code": 1,
        "name": "Consumidor Final",
        "commercial_name": "",
        "fiscal_number": "999999990",
        "street1": "",
        "street2": "",
        "zip_code": "",
        "zip_locale": ""
    }
}

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