List

Lista de Métodos de Pagamento

Fornece uma Lista de todos os Métodos de Pagamento existentes.

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

Query Parameters

Name	Type	Description
limit	integer	Define o número de formas de pagamento por pesquisa.
offset	integer	Indica a posição inicial da pesquisa. Retorna a lista de formas de pagamento compreendida entre offset:offset+limit.
ordering	string	Define o campo e a direcção a usar na pesquisa de formas de pagamento. Campos ordenáveis: id, code, description, where_to_use, payment_mechanism. Para ordenar de forma descendente, deve usar o sinal de '-' antes do campo.
search	string	Define o termo de pesquisa a utilizar na lista de formas de pagamento. Campos Pesquisados: Descrição
code	string	Código da Forma de Pagamento. Para pesquisa parcial pode usar o formato: "code__search"
description	string	Descrição da Forma de Pagamento. Para pesquisa parcial pode usar o formato: "description__search"
does_add_to_till	boolean	Adiciona à Caixa

200: OK Lista de métodos de pagamento

401: Unauthorized (Sem Resposta)

400 Lista de erros detectados

{
    // Response
}

403: Forbidden (Sem Resposta)

Exemplo de Pedido

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

Exemplo de Resposta

{
    "limit": 10,
    "offset": 0,
    "count": 48,
    "next": "https://api.cloudinvoice.net/payment_methods/?limit=10&offset=10",
    "previous": null
    "results": [
        {
            "id": 1,
            "code": 1,
            "description": "Dinheiro",
            "where_to_use_id": 58,
            "where_to_use": {
                "id": 58,
                "description1": "Ambos"
            },
            "payment_mechanism_id": 61,
            "payment_mechanism": {
                "id": 61,
                "description1": "Numerário"
            },
            "does_add_to_till": true,
            "obs": ""
        },
        ...

    ]
}

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.