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

List

Fornece uma lista de todos os fornecedores existentes.

Listar Fornecedores

GET https://api.cloudinvoice.net/suppliers/

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 Default: "code"

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

Campos ordenáveis:

  • id, code, fiscal_number, supplier_name

Use '-' antes do nome para ordem decrescente.

search

string

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

Campos Pesquisados:

  • code, supplier_name, fiscal_number, etc.

code

integer

Código do Fornecedor

supplier_name

string

Nome do Fornecedor

Sufixos disponíveis:

  • __search: para pesquisa parcial

fiscal_number

String

Contribuinte

Sufixos disponíveis:

  • __search: para pesquisa parcial

curl https://api.cloudinvoice.net/suppliers/
    -H "Content-Type: application/json"
{
    "limit": 10,
    "offset": 0,
    "count": 120,
    "next": "https://api.cloudinvoice.net/suppliers/?limit=10&offset=10",
    "previous": null,
    "results":[
        {
            "id": 1,
            "code": 1,
            "supplier_name": "Fornecedor 1",
            "fiscal_number": "500000000",
            "fiscal_country_id": 1,
            "fiscal_country": {"code": "PT", "country_name": "Portugal"},
            "fiscal_status_type_id": 1593,
            "fiscal_status_type": {"code": "2", "description": "Sujeito Passivo de IVA"},
            "street1": "",
            "street2": "",
            "zip_code": "",
            "zip_locale": "",
            "country_id": 1,
            "country": {"code": "PT", "country_name": "Portugal"},
            "phone1": "",
            "mobile1": "",
            "email1": "",
            "total_debits": 0.0,
            "total_credits": 100.0,
            "current_balance": 100.0
        },
        ...
    ]
}

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

Notas: Alguns dos campos do termo de pesquisa geral poderão ser incluídos mediante critérios específicos (Ex: Descrição será incluída na pesquisa geral apenas se o termo de pesquisa contiver 3 ou mais caracteres). Por defeito, o comportamento expectável será obter-se todos os items cujo o texto a pesquisar (search) esteja CONTIDO em pelo menos um dos campos incluídos na pesquisa geral.

Last updated