List

Lista de Tipos de Documentos

Fornece uma lista de todos os Tipos de Documentos existentes.

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

Query Parameters

Name

Type

Description

limit

integer

Define o número de países por pesquisa.

offset

integer

Indica a posição inicial da pesquisa. Retorna a lista de países compreendida entre offset:offset+limit.

ordering

string

Define o campo e a direcção a usar na pesquisa de países.

Campos ordenáveis: id, code, search_order, country_name. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo.

string

Define o termo de pesquisa a utilizar na lista de países.

Campos Pesquisados: Código, Nome do País, Ordem de Pesquisa

code

string

Código do Distrito

Para pesquisa parcial pode usar o formato: "code__search"

document_name

string

Nome do Documento

Para pesquisa parcial pode usar o formato: "document_name__search"

is_hash_signed

boolean

Documento Assinado

is_valued

boolean

Documento Valorizado

is_self_billing

boolean

Documento de Auto-Facturação

is_plafond_document

boolean

Documento de Plafond

is_global_transport

boolean

Documento de Transporte Global

is_credit_document

boolean

Documento de Crédito

is_return_document

boolean

Documento de Devolução

is_eu_sales

boolean

Documento de Venda à Distância

Esta opção estará disponível apenas se o módulo de Regime de Vendas à Distância estiver activo.

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

{
    "limit": 10,
    "offset": 0,
    "count": 85,
    "next": "https://api.cloudinvoice.net/documents/configs/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 56,
            "code": "ACX",
            "document_name": "Abertura de Caixa",
            "document_type_id": 295,
            "document_type": {
                "code": "CX",
                "description": "Caixa"
            },
            "party_class_id": 1600,
            "party_class": {
                "code": "N",
                "description": "(Nenhuma)"
            },
            "document_nature_id": 701,
            "document_nature": {
                "code": "ACX",
                "description": "Abertura de Caixa"
            },
            "document_layout_type_id": 915,
            "document_layout_type": {
                "code": "CX",
                "description": "Caixa"
            },
            "saft_doc_category_id": 281,
            "saft_doc_category": {
                "code": "N",
                "description": "Documento Interno/Não-SAFT-PT"
            }
        },
        {
            "id": 42,
            "code": "AST",
            "document_name": "Acerto de Stock",
            "document_type_id": 293,
            "document_type": {
                "code": "S",
                "description": "Stock"
            },
            "party_class_id": 1600,
            "party_class": {
                "code": "N",
                "description": "(Nenhuma)"
            },
            "document_nature_id": 506,
            "document_nature": {
                "code": "AST",
                "description": "Acerto de Stock"
            },
            "document_layout_type_id": 913,
            "document_layout_type": {
                "code": "S",
                "description": "Produtos"
            },
            "saft_doc_category_id": 281,
            "saft_doc_category": {
                "code": "N",
                "description": "Documento Interno/Não-SAFT-PT"
            }
        },
        ...
    ]
}

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

PreviousTipos de Documentos NextGet

Last updated 1 month ago

{
    "limit": 10,
    "offset": 0,
    "count": 85,
    "next": "https://api.cloudinvoice.net/documents/configs/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 56,
            "code": "ACX",
            "document_name": "Abertura de Caixa",
            "document_type_id": 295,
            "document_type": {
                "code": "CX",
                "description": "Caixa"
            },
            "party_class_id": 1600,
            "party_class": {
                "code": "N",
                "description": "(Nenhuma)"
            },
            "document_nature_id": 701,
            "document_nature": {
                "code": "ACX",
                "description": "Abertura de Caixa"
            },
            "document_layout_type_id": 915,
            "document_layout_type": {
                "code": "CX",
                "description": "Caixa"
            },
            "saft_doc_category_id": 281,
            "saft_doc_category": {
                "code": "N",
                "description": "Documento Interno/Não-SAFT-PT"
            }
        },
        {
            "id": 42,
            "code": "AST",
            "document_name": "Acerto de Stock",
            "document_type_id": 293,
            "document_type": {
                "code": "S",
                "description": "Stock"
            },
            "party_class_id": 1600,
            "party_class": {
                "code": "N",
                "description": "(Nenhuma)"
            },
            "document_nature_id": 506,
            "document_nature": {
                "code": "AST",
                "description": "Acerto de Stock"
            },
            "document_layout_type_id": 913,
            "document_layout_type": {
                "code": "S",
                "description": "Produtos"
            },
            "saft_doc_category_id": 281,
            "saft_doc_category": {
                "code": "N",
                "description": "Documento Interno/Não-SAFT-PT"
            }
        },
        ...
    ]
}