Vouchers

Vouchers são os valores de vale-refeição e de hospedagem usados nas turmas. Cada voucher tem um tipo de despesa, um fornecedor e um valor. Os endpoints desta página correspondem à tela Vouchers do módulo Operacional.

O voucher é identificado pelo id numérico, que aparece no caminho das chamadas de consulta, alteração e exclusão.

Regras

• O tipo do voucher é informado pelo uuid do tipo, obtido em GET /operational/vouchers/types.
• O fornecedor é informado pelo uuid do fornecedor, obtido em GET /operational/vouchers/vendors. Na API o fornecedor é opcional.
• Ao cadastrar um voucher com o mesmo tipo, o mesmo fornecedor e o mesmo valor de um voucher já existente, nenhum duplicado é criado: o cadastro existente é devolvido. Se ele estiver apagado, é reativado antes de ser devolvido.

Endpoints

Método	Caminho	Descrição
GET	/operational/vouchers	Lista os vouchers
POST	/operational/vouchers	Cadastra um voucher
GET	/operational/vouchers/types	Lista os tipos de despesa aceitos em vouchers
GET	/operational/vouchers/vendors	Lista os fornecedores, para vincular ao voucher
GET	/operational/vouchers/{id}	Consulta um voucher
PUT	/operational/vouchers/{id}	Altera um voucher
DELETE	/operational/vouchers/{id}	Apaga um voucher

GET /operational/vouchers

Lista os vouchers do cliente, ordenados pelo id crescente, a menos que columnName e orderData sejam enviados.

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
type_id	Não	id numérico do tipo de despesa, para filtrar os vouchers de um tipo
columnName	Não	Coluna para ordenar a lista
orderData	Não	Direção da ordenação: asc ou desc. Use junto com columnName
per_page	Não	Quantidade de registros por página. Veja Convenções
page	Não	Número da página, quando per_page for informado

Resposta

Status 200. Sem per_page, a resposta é uma lista de vouchers. Com per_page, a resposta é paginada. Cada voucher traz id, type_id, type_uuid, type_name, customer_vendor_id, customer_vendor_uuid, customer_vendor_name, amount, inactive, user_create_name e user_update_name.

curl "https://api.pedagogo.app/operational/vouchers?per_page=15&page=1" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <token-de-sessao>"

POST /operational/vouchers

Cadastra um voucher. O cliente é o do usuário que faz a chamada.

Corpo

Campo	Obrigatório	Tipo	Descrição
type_uuid	Sim	Texto (uuid)	uuid do tipo de despesa, de GET /operational/vouchers/types
customer_vendor_uuid	Não	Texto (uuid)	uuid do fornecedor, de GET /operational/vouchers/vendors
amount	Sim	Número	Valor do voucher
inactive	Não	Booleano	Marca o voucher como inativo

Resposta

Status 201, com o voucher cadastrado ou devolvido: id, type_id, customer_vendor_id, amount, inactive, user_create_id e user_update_id.

curl -X POST https://api.pedagogo.app/operational/vouchers \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{"type_uuid": "3f1c0b6e-8a2d-4c57-9b1e-2d7a5f0e6a11", "customer_vendor_uuid": "7b2e4d91-0c3a-4f8e-a6d5-1e9b8c7f2a40", "amount": 1}'

GET /operational/vouchers/types

Lista os tipos de despesa aceitos em vouchers: vale-refeição e hospedagem. A lista é fixa e traz apenas esses dois tipos. Use o campo uuid como type_uuid no cadastro.

Resposta

Status 200. Lista de tipos, com os campos uuid e type (nome do tipo).

GET /operational/vouchers/vendors

Lista os fornecedores cadastrados no cliente. Use o campo uuid como customer_vendor_uuid no cadastro do voucher.

Parâmetros de URL

Parâmetro	Obrigatório	Descrição
per_page	Não	Quantidade de registros por página
page	Não	Número da página, quando per_page for informado

Resposta

Status 200. Lista de fornecedores, com os campos do cadastro (entre eles id, uuid e name). Sem per_page, a resposta é uma lista simples.

GET /operational/vouchers/{id}

Consulta um voucher. A resposta traz o voucher e, no objeto type, os dados do tipo de despesa.

Parâmetros de URL

Parâmetro	Descrição
id	id numérico do voucher

Resposta

Status 200, com o voucher.

PUT /operational/vouchers/{id}

Altera um voucher. Os campos não enviados mantêm o valor atual.

Parâmetros de URL

Parâmetro	Descrição
id	id numérico do voucher

Corpo

Campo	Obrigatório	Tipo	Descrição
type_uuid	Não	Texto (uuid)	uuid do novo tipo de despesa
customer_vendor_uuid	Não	Texto (uuid)	uuid do novo fornecedor. Se for omitido ou enviado vazio, o fornecedor atual é mantido
amount	Não	Número	Novo valor do voucher
inactive	Não	Booleano	Marca o voucher como inativo ou ativo

Resposta

Status 200, com o voucher alterado.

curl -X PUT https://api.pedagogo.app/operational/vouchers/152 \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <token-de-sessao>" \
  -d '{"amount": 2}'

DELETE /operational/vouchers/{id}

Apaga um voucher. A exclusão é lógica: o voucher deixa de aparecer nas listas, e os dados são mantidos.

Parâmetros de URL

Parâmetro	Descrição
id	id numérico do voucher

Resposta

Status 200, sem conteúdo útil.