Resultados

Por rateio

Endpoint que lista os resultados do rateio

Method URI Headers Authorization
GET /api/v3/apportionments-results Content-Type: application/json Authorization: Bearer {token}

Parameters

apportionmentIds: (array, int) - "ID's dos rateios"
initialDate: (date) - "Data inicial dos resultados. Ex. 2021-09-01"
finalDate: (date) - "Data final dos resultados. Ex. 2021-09-30"
_sort: 'date' (string) ('date', 'apportionment_id') - "Define o campo de ordenação da lista."
_order: 'desc' (string) ('asc', 'desc') - "Define a ordem da lista com base no campo definido."
_limit: 10 (integer) - "Quantidade de itens por página."
_page: 1 (integer) - "Página a ser carregada."

Response

{success} Response 200 (application/json)

{
  "items": [
      {
          "apportionment_id": 4,
          "date": "2021-09-01",
          "equipments_value": 200,
          "additional_fees_value": 200,
          "additional_consumption_value": 15,
          "total_value_current": 415,
          "equipments_value_previous": 100,
          "additional_fees_value_previous": 200,
          "additional_consumption_value_previous": 15,
          "total_value_previous": 315,
          "percentage_diff": 31.75
      }
  ],
  "total": 1,
  "per_page": 10,
  "current_page": 1
}

{warning} Response 422 (application/json)

{
    "apportionmentIds": [
        "O campo apportionment ids deve ser uma matriz."
    ],
    "_sort": [
        "O campo sort selecionado é inválido."
    ],
    "_order": [
        "O campo order selecionado é inválido."
    ],
    "_limit": [
        "O campo limit deve ser um número inteiro."
    ],
    "_page": [
        "O campo page deve ser um número inteiro."
    ]
}

{primary} Response 204 (application/json).

Quando os critérios de parâmetros não contiver registros a serem retornados.

Por centro de custo

Endpoint que lista os resultados de rateio por centro de custo.

Method URI Headers Authorization
GET /api/v3/cost-centers-results Content-Type: application/json Authorization: Bearer {token}

Parameters

costCenterIds: (array, int) - "ID's dos centros de custos"
apportionment_id: (int) - "Id do Rateio - Busca todos os centros de custo do rateio",
initialDate: (date) - "Data inicial dos resultados. Ex. 2021-09-01"
finalDate: (date) - "Data final dos resultados. Ex. 2021-09-30"
_sort: 'date' (string) ('date', 'cost_center_id') - "Define o campo de ordenação da lista."
_order: 'desc' (string) ('asc', 'desc') - "Define a ordem da lista com base no campo definido."
_limit: 10 (integer) - "Quantidade de itens por página."
_page: 1 (integer) - "Página a ser carregada."

Response

{success} Response 200 (application/json)

{
  "items": [
    {
      "cost_center_id": 42, 
      "cost_center_name": "Centro de Custo 1", 
      "tariff_type": "Customizado",
      "tariff_value": 549.5,
      "date": "2021-09-01",
      "equipments_value": 70,
      "additional_fees_value": 70,
      "additional_consumption_value": 10, 
      "total_value": 150,
      "equipments_value_previous": 35,
      "additional_fees_value_previous": 70,
      "additional_consumption_value_previous": 10,
      "total_value_previous": 115,
      "percentage_diff_consumption_used": 100.00,
      "percentage_diff": 30.43
    }
  ],
  "total": 1,
  "per_page": 10,
  "current_page": 1
}

{warning} Response 422 (application/json)

{
  "costCenterIds": [
    "O campo cost center ids deve ser uma matriz."
  ]
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.

Por equipamento

Endpoint que lista os resultados de rateio por equipamento.

Method URI Headers Authorization
GET /api/v3/cost-centers-equipments-results Content-Type: application/json Authorization: Bearer {token}

Parameters

costCenterId: (int) - "ID's dos centros de custos"
initialDate: (date) - "Data inicial dos resultados. Ex. 2021-09-01"
finalDate: (date) - "Data final dos resultados. Ex. 2021-09-30"
_sort: 'date' (string) ('date') - "Define o campo de ordenação da lista."
_order: 'desc' (string) ('asc', 'desc') - "Define a ordem da lista com base no campo definido."
_limit: 10 (integer) - "Quantidade de itens por página."
_page: 1 (integer) - "Página a ser carregada."

Response

{success} Response 200 (application/json)

{
  "items": [
    {
      "cost_center_id": 42,
      "tariff_value": 549.5,
      "date": "2021-09-01",
      "total_value": 1600.79,
      "total_value_previous": 971.35,
      "percentage_diff": 64.8,
      "equipment": {
        "id": 61,
        "name": "Nome do equipamento"
      }
    }
  ],
  "total": 1,
  "per_page": 10,
  "current_page": 1
}

{warning} Response 422 (application/json)

{
  "costCenterId": [
    "O campo cost center id deve ser um número inteiro."
  ]
}

{primary} Response 204 (application/json)

Quando o registro não existir ou o usuário não tiver permissão de visualização.