Período de Fatura do Rateio

Listar

Endpoint que lista todos as períodos de fatura cadastrados dos rateios e empresas que o usuário tiver permissão.

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

Parameters

apportionment_id: 1 (required, integer) - "Filtra por Id do rateio.",
_sort: 'id' (string) ('id', 'period', 'period_start', 'period_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,
      "period": "2021-05-01",
      "period_start": "2021-05-01",
      "period_end": "2021-06-02"
    },
    {
      "id": 2,
      "apportionment_id": 1,
        "period": "2021-06-01",
        "period_start": "2021-06-03",
        "period_end": "2021-06-30"
    }
  ],
  "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 um período de fatura específico.

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

Parameters

id: 1 (integer) - "Id do período de fatura"

Response

{success} Response 200 (application/json)

{
  "id": 1,
  "apportionment_id": 1,
  "period": "2021-05-01",
  "period_start": "2021-05-01",
  "period_end": "2021-06-02"
}

{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 um período de fatura.

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

{info} Regras:
Apenas um período por mês, por rateio.

Attributes

apportionment_id: 1 (integer, required) - "Id do rateio.",
period: '2021-05-01' (string, required) - "Período de referência, sendo sempre no dia 1. Formato Y-m-d.",
period_start: '2021-05-01' (string) - "Data inicial do período de fatura. Formato Y-m-d.",
period_end: '2021-06-02' (string) - "Data final do período de fatura. Formato Y-m-d.",

Response

{success} Response 201 (application/json)

{
  "id": 1,
  "apportionment_id": 1,
  "period": "2021-05-01",
  "period_start": "2021-05-01",
  "period_end": "2021-06-02"
}

{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 um período de fatura específico.

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

{info} Regras:
Apenas um período por mês, por rateio.

Parameters

id: 1 (integer) - "Id do período de fatura"

Attributes

period: '2021-05-01' (string, required) - "Período de referência, sendo sempre no dia 1. Formato Y-m-d.",
period_start: '2021-05-01' (string) - "Data inicial do período de fatura. Formato Y-m-d.",
period_end: '2021-06-02' (string) - "Data final do período de fatura. Formato Y-m-d.",

Response

{success} Response 200 (application/json)

{
  "id": 1,
  "apportionment_id": 1,
  "period": "2021-05-01",
  "period_start": "2021-05-01",
  "period_end": "2021-06-02"
}

{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 um período de fatura específico.

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

Parameters

id: 1 (integer) - "Id do período de fatura"

Response

{primary} Response 204 (application/json)

Quando o registro for excluído com sucesso.