Seek

Procura por documento a partir da sua identificação ou referência.

Procurar Documento

Os identificadores dos documentos CloudInvoice, normalmente com aspeto semelhante a FAC A01/1, contêm sempre uma barra / . Caracteres especiais como este deverão ser sempre codificados para URL / → %2F .

GET https://api.cloudinvoice.net/documents/seek/:search/

Path Parameters

Name	Type	Description
search*	string	Identificador/Referência do Documento a procurar

Exemplo de Pedido

curl https://api.cloudinvoice.net/documents/seek/FAC%20A01%2F1/
    -H "Content-Type: application/json"

Exemplo de Resposta

{
    "id": 1,
    "doc_key": "FAC A01/1",
    "document_date": "2023-01-04",
    "document_time": "17:35:57",
    "document_number": 1,
    "document_nature_id": 301,
    "document_nature": {
        "code": "FT",
        "description": "Factura"
    },
    "document_id": 1,
    "document": {
        "code": "FAC",
        "document_name": "Factura",
        "ask_payment_onclose": false
    },
    "document_serie_id": 3,
    "document_serie": {
        "code": "A01",
        "description": "Série A01"
    },
    "document_status_id": 1202,
    "document_status": {
        "code": "F",
        "description": "Finalizado"
    },
    "document_reference": "",
    "our_reference": "",
    "party_reference": "",
    "module_origin": 1,
    "warehouse_id": 1,
    "warehouse": {
        "code": 1,
        "description": "Armazém 1"
    },
    "party_id": 2,
    "party": {
        "class": 1601,
        "code": 2,
        "name": "Cliente Demo",
        "commercial_name": "",
        "fiscal_number": "123456789",
        "street1": "Desconhecido",
        "street2": "",
        "zip_code": "0000-000",
        "zip_locale": "Desconhecido"
    },
    "line_details_count": 1,
    "lines_total_quantity": 1.0,
    "is_valued": true,
    "is_tax_included": false,
    "total_gross_amount": 100.0,
    "global_discount1": 0.0,
    "total_global_discount": 0.0,
    "total_line_discount": 0.0,
    "total_net_amount": 100.0,
    "total_taxes_amount": 23.0,
    "total_amount": 123.0,
    "total_document_amount": 123.0,
    "total_round_amount": 0.0,
    "total_due_amount": 0.0,
    "due_date": "2023-01-04",
    "header_text": "",
    "footer_text": "",
    "number_of_prints": 1,
    "is_converted": false,
    "is_transport_document": false,
    "has_withholding": false,
    "salesman_id": 1,
    "salesman": {
        "code": 1,
        "salesman_name": "Vendedor 1"
    },
    "payment_term_id": 1,
    "payment_term": {
        "code": 1,
        "description": "Pronto Pagamento"
    },
    "payment_method_id": null,
    "payment_method": null,
    "origin_document_header_id": null,
    "origin_document_header": null,
    "at_report_status_id": 1181,
    "at_report_status": {
        "code": "I",
        "description": "Isento"
    },
    "obs": ""
}

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