Giro de caixa

Listar

GET /api/v1/working_sessions

Filtros

Os parâmetros abaixo podem ser passados como uma query string. Mais de um filtro pode ser passado na mesma consulta.

Este serviço suporta paginação.

start_date: a data de início das transações cash.
- Se passado, a consulta retorna somente transações cash ocorridas a partir desta data e hora, inclusive.
- Deve-se passar a data e também a hora; se não passada, considerada-se 00:00 UTC.
- Um formato possível é dd/mm/yyyy hh:mi:ss. Nesse caso a data e hora devem estar em UTC.
- Este campo também suporta o formato ISO 8601.
- Caso o formato da data seja inválido, é retornado erro com o código HTTP 400 (bad request).
end_date: a data final das transações cash.
- Se passado, a consulta retorna somente transações cash ocorridas até esta data e hora, inclusive.
- Deve-se passar a data e também a hora; se não passada, considerada-se 00:00 UTC.
- Um formato possível é dd/mm/yyyy hh:mi:ss. Nesse caso a data e hora devem estar em UTC.
- Este campo também suporta o formato ISO 8601.
- Caso o formato da data seja inválido, é retornado erro com o código HTTP 400 (bad request).
client_id: o id do cliente das transações cash.
- Se passado, a consulta retorna somente transações cash ocorridas para este cliente.
distribution_center_id: o id do centro de distribuição das transações cashless.
- Se passado, a consulta retorna somente transações cashless ocorridas nas instalações do centro de distribuição.
location_id: o id do local das transações cash.
- Se passado, a consulta retorna somente transações cashless ocorridas neste local.
machine_id: o id da máquina das transações cash.
- Se passado, a consulta retorna somente transações cash ocorridas nesta máquina.
machine_type_id: o id do tipo da máquina das transações cashless.
- Se passado, a consulta retorna somente transações cashless ocorridas neste tipo de máquina.
machine_model_id: o id modelo de máquina das instalações.
- Se passado, a consulta retorna somente instalações desse modelo de máquina.
place: local interno da instalção.
- Se passado, a consulta retorna somente transações cashless ocorridas neste local interno.
route_id: o id da rota associada a instalação das transações cashless.
- Se passado, a consulta retorna somente transações cashless da instalação dessa rota.
kind: o tipo das transações cash, podendo ser um desses valores:
- coin: Moedeiro.
- cashbox: Cofre.
- cashless: Cashless.
- bill: Noteiro.
- manual_coin: Carga ou retirada.
- recycled_bills: Reciclador.
- Se passado, a consulta retorna somente transações cash do tipo informado.

Retorno

É retornado um JSON contendo um array com objetos que correspondem às transações cashless. O array é ordenado por data e hora das transações, da mais recente para a mais antiga. Os campos de cada transação cashless são os seguintes:

occurred_at: a data e hora da transação cash, no formato ISO 8601.
client: detalhes do cliente da transação cash.
location: detalhes do local da transação cash.
machine: detalhes da máquina da transação cash.
kind: o tipo da transação cash.
value: o valor da transação cashless.
place: o local interno da instalação da visita.
route: rota associada a instalação.

Segue um exemplo de retorno de consulta:

[
    {
        "occurred_at": "2015-07-28T21:00:56.000Z",
        "client_id": 1502,
        "location_id": 9874,
        "machine_id": 6341,
        "kind": "cashbox",
        "value": 0.5,
        "place": "CENTRAL",
        "routes": [
            {
                "id": 83,
                "name": "UNIVERSIDADE"
            }
        ],
        "client": {
            "id": 1502,
            "name": "UNIFACS"
        },
        "location": {
            "id": 9874,
            "name": "CTN 1 PISO CENTRAL"
        },
        "machine": {
            "id": 6341,
            "asset_number": "15691609"
        }
    }
]