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

List

Fornece uma lista de todas as famílias existentes.

Listar Famílias

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

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: "description"

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

Campos ordenáveis:

  • id, code, description

Use '-' antes do nome para ordem decrescente.

search

string

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

Campos Pesquisados:

  • code, description

code

string

Código da Família

Sufixos disponíveis:

  • __search: para pesquisa parcial

description

string

Descrição

Sufixos disponíveis:

  • __search: para pesquisa parcial

curl https://api.cloudinvoice.net/families/
    -H "Content-Type: application/json"
{
    "limit": 10,
    "offset": 0,
    "count": 37,
    "next": "https://api.cloudinvoice.net/families/?limit=10&offset=10",
    "previous": null,
    "results": [
        {
            "id": 1,
            "code": "1",
            "description": "Familia 1",
            "photo_image_path": null,
            "button_background_color": 3,
            "is_disable_touch": false,
            "obs": ""
        },
        ...
    ]
}

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

Last updated