Primeiros Passos
Auth & Identidade
Gestão de Acesso
Listar Faturas
curl --request GET \
--url https://api.example.com/organizations/{organizationId}/invoices \
--header 'Authorization: <authorization>'{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
Invoices
Listar Faturas
Obter todas as faturas da organizacao com paginacao baseada em cursor e filtros opcionais por status, tipo e metodo de pagamento.
GET
/
organizations
/
{organizationId}
/
invoices
Listar Faturas
curl --request GET \
--url https://api.example.com/organizations/{organizationId}/invoices \
--header 'Authorization: <authorization>'{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
Retorna uma lista de faturas.
curl "https://api.awsales.io/studio/organizations/ORG_ID/invoices?limit=20" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
Requer permissao
invoice:read.Cabecalhos
Token bearer.
Parametros de Rota
O UUID da organizacao.
Parametros de Consulta
Resultados por pagina.
Cursor para buscar a pagina anterior.
Cursor para buscar a proxima pagina.
Filtrar por metodo de pagamento.
Filtrar por status da fatura.
Filtrar por tipo da fatura.
Ordenar por
status, type, dueDate ou createdAt.Resposta
Array de objetos de fatura.
Metadados de paginacao.
{
"statusCode": 400,
"message": "Bad Request Error",
"errors": [{"message": "required", "path": "field"}]
}
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.