Auth & Identidade
Gestão de Acesso
Listar Usos de Voucher
curl --request GET \
--url https://api.example.com/organizations/{organizationId}/vouchers/{voucherId}/usages \
--header 'Authorization: <authorization>'{
"data": [
{
"voucherUsageId": "019525fe-7e6c-7fe9-e1ad-9b1c3d5f7a9d",
"voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
"invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
"organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
"externalRef": "ext_ref_abc123",
"amount": 2500,
"status": "APPLIED",
"createdAt": "2026-03-01T00:00:00.000Z",
"updatedAt": "2026-03-01T00:00:00.000Z"
}
],
"meta": { "page": 1, "limit": 20, "totalItems": 1, "totalPages": 1 }
}
Vouchers
Listar Usos de Voucher
Recuperar uma lista paginada de todos os usos de um voucher especifico.
GET
/
organizations
/
{organizationId}
/
vouchers
/
{voucherId}
/
usages
Listar Usos de Voucher
curl --request GET \
--url https://api.example.com/organizations/{organizationId}/vouchers/{voucherId}/usages \
--header 'Authorization: <authorization>'{
"data": [
{
"voucherUsageId": "019525fe-7e6c-7fe9-e1ad-9b1c3d5f7a9d",
"voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
"invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
"organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
"externalRef": "ext_ref_abc123",
"amount": 2500,
"status": "APPLIED",
"createdAt": "2026-03-01T00:00:00.000Z",
"updatedAt": "2026-03-01T00:00:00.000Z"
}
],
"meta": { "page": 1, "limit": 20, "totalItems": 1, "totalPages": 1 }
}
Requer permissao
voucher:read.Headers
Bearer token.
Parametros de Path
UUID da organizacao.
UUID do voucher.
Parametros de Query
Numero da pagina.
Resultados por pagina.
Resposta
Lista de usos de voucher.
Show usage properties
Show usage properties
Usage UUID.
UUID do voucher.
UUID da fatura.
UUID da organizacao.
Referencia externa.
Valor de desconto em centavos.
Usage status.
Timestamp de criacao.
Timestamp da ultima atualizacao.
{
"data": [
{
"voucherUsageId": "019525fe-7e6c-7fe9-e1ad-9b1c3d5f7a9d",
"voucherId": "019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a",
"invoiceId": "019525fd-c290-7a9e-f6b2-8c0d2e4a6b8e",
"organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
"externalRef": "ext_ref_abc123",
"amount": 2500,
"status": "APPLIED",
"createdAt": "2026-03-01T00:00:00.000Z",
"updatedAt": "2026-03-01T00:00:00.000Z"
}
],
"meta": { "page": 1, "limit": 20, "totalItems": 1, "totalPages": 1 }
}
Exemplos de Codigo
curl https://api.awsales.io/admin/organizations/019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2/vouchers/019525fd-e4b8-7cb0-b8d4-0e2f4a6c8d0a/usages \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Codigos de Erro
| Status | Codigo | Descricao |
|---|---|---|
400 | validation_error | Entrada invalida ou campos obrigatorios ausentes |
401 | unauthorized | Autenticacao ausente ou invalida |
403 | forbidden | Permissoes insuficientes |
404 | organization.not_found | Organizacao nao encontrada |
500 | internal_server_error | Ocorreu um erro inesperado |
⌘I
Assistant
Responses are generated using AI and may contain mistakes.