For the complete documentation index, see llms.txt. This page is also available as Markdown.

Documentos Internos

Fornece uma lista de documentos internos.

Listar Documentos Internos

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

Query Parameters

Name
Type
Description

limit

integer

Define o número de registos por pesquisa.

offset

integer

Indica a posição inicial da pesquisa.

Retorna a lista de registos compreendida entre offset e offset+limit.

ordering

string

Define o campo e a direção a usar na pesquisa de registos.

Campos ordenáveis:

  • id, doc_key, document_date, document_time

Use '-' antes do nome para ordem decrescente.

search

string

Define o termo de pesquisa a utilizar na lista de registos.

Campos Pesquisados:

  • doc_key, document_name, our_reference, party_fiscal_number, party_name, salesman_name, etc.

document_status

integer

Estado do Documento

Consulte a tabela Apêndice para mais informação

curl https://api.cloudinvoice.net/documents/internal_documents/
    -H "Content-Type: application/json"
{
    "limit": 10,
    "offset": 0,
    "count": 42,
    "next": "https://api.cloudinvoice.net/documents/internal_documents/?limit=10&offset=10",
    "previous": null,
    "results":[
        {
            "id": 1,
            "doc_key": "DINC A01/1",
            "document_date": "2026-09-09",
            "document_time": "17:54:18.033683",
            "document_number": 1,
            "our_reference": "",
            "is_valued": true,
            "is_tax_included": true,
            "total_amount": 39.9,
            "total_due_amount": 0.0,
            "due_date": "2026-09-09",
            "document_nature_id": 371,
            "document_id": 146,
            "document": {
                "code": "DINC",
                "document_name": "Documento Interno",
                "ask_payment_onclose": false
            },
            "document_serie_id": 1,
            "document_serie": {
                "code": "A01",
                "description": "Série A01"
            },
            "document_status_id": 1202,
            "warehouse_id": 1,
            "warehouse": {
                "code": 1,
                "description": "Armazém 1"
            },
            "document_nature": {
                "code": "DIN",
                "description": "Documento Interno"
            },
            "document_status": {
                "code": "F",
                "description": "Finalizado"
            },
            "party_id": 2,
            "party": {
                "class": 1601,
                "code": 2,
                "name": "Cliente Demo",
                "fiscal_number": "999999990"
            },
            "payment_method_id": null,
            "payment_method": null
        },
        ...
    ]
}

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

Last updated