Tarifas Customizadas de Rateio

Listar

Endpoint que lista todos as tarifas cadastrados.

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

Parameters

apportionmentId: 1 (integer) - "Filtra por Id do rateio.",
_sort: 'id' (string) ('id', 'vigency_start', 'vigency_end') - "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": [
    {
      "id": 1,
      "apportionment_id": 1,
      "vigency_start": "2021-05-01",
      "vigency_end": "2021-05-31",
      "value": 100.88
    },
    {
      "id": 2,
      "apportionment_id": 1,
      "vigency_start": "2021-06-01",
      "vigency_end": null,
      "value": 88
    }
  ],
  "total": 2,
  "per_page": 10,
  "current_page": 1
}

{primary} Response 204 (application/json).

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

Pegar

Endpoint que pega uma tarifa específica.

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

Parameters

id: 1 (integer) - "Id da tarifa de rateio"

Response

{success} Response 200 (application/json)

{
  "id": 1,
  "apportionment_id": 1,
  "vigency_start": "2021-05-01",
  "vigency_end": "2021-05-31",
  "value": 100.88
}

{primary} Response 204 (application/json)

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

Criar

Endpoint que cria uma tarifa.

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

{info} Regras:
Apenas uma tarifa por mês, por rateio.
Quando não informado o vigency_end, ele passa a ser válido para os próximos periodos até ser editado.

Attributes

apportionment_id: 1 (integer, required) - "Id do rateio.",
vigency_start: '2021-05-01' (string, required) - "Data inicial de vigência da tarifa. Formato Y-m-d.",
vigency_end: '2021-05-01' (string) - "Data final de vigência da tarifa. Formato Y-m-d."
value: 100.88 (float, required) - "Valor correspondente a tarifa personalizada."

Response

{success} Response 201 (application/json)

{
  "id": 1,
  "apportionment_id": 1,
  "vigency_start": "2021-05-01",
  "vigency_end": "2021-05-31",
  "value": 100.88
}

{primary} Response 204 (application/json)

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

Atualizar

Endpoint que atualiza uma tarifa específica.

Method URI Headers Authorization
PUT /api/v3/apportionments-tariffs/{id} Content-Type:application/json Authorization: Bearer {token}

{info} Regras:
Apenas uma tarifa por mês, por rateio.
Quando não informado o vigency_end, ele passa a ser válido para os próximos periodos até ser editado.

Parameters

id: 1 (integer) - "Id da tarifa de rateio."

Attributes

vigency_start: '2021-05-01' (string, required) - "Data inicial de vigência da tarifa. Formato Y-m-d.",
vigency_end: '2021-05-01' (string) - "Data final de vigência da tarifa. Formato Y-m-d."
value: 100.88 (float, required) - "Valor correspondente a tarifa personalizada."

Response

{success} Response 200 (application/json)

{
  "id": 1,
  "apportionment_id": 1,
  "vigency_start": "2021-06-01",
  "vigency_end": "2021-06-30",
  "value": 88
}

{primary} Response 204 (application/json)

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

Deletar

Endpoint que deleta uma tarifa específica.

Method URI Headers Authorization
DELETE /api/v3/apportionments-tariffs/{id} Content-Type:application/json Authorization: Bearer {token}

Parameters

id: 1 (integer) - "Id da tarifa de rateio."

Response

{primary} Response 204 (application/json)

Quando o registro for excluído com sucesso.