Erros da API
Trate erros programaticamente por error_code e use detail apenas como recurso.
application/problem+json
{
"type": "https://gota.umbeluzi.com/docs/api/errors#validation.field_required",
"title": "Unprocessable Entity",
"status": 422,
"detail": "A required field was missing or empty.",
"code": "VALIDATION_ERROR",
"error_code": "validation.field_required",
"params": {
"field": "name"
},
"request_id": "req_01J...",
"invalid_params": [
{
"name": "name",
"reason": "is required"
}
]
}Códigos gerais (code)
| Código | Estado HTTP | Significado | Repetível |
|---|---|---|---|
INVALID_REQUEST | 400 | The request was malformed or failed validation. | Não |
UNAUTHORIZED | 401 | Authentication is missing, invalid, or expired. | Não |
FORBIDDEN | 403 | The authenticated caller lacks permission for this action. | Não |
CAPABILITY_INACTIVE | 403 | The tenant capability required for this operation is not active. | Não |
NOT_FOUND | 404 | The requested resource does not exist or is not visible in this context. | Não |
CONFLICT | 409 | The request conflicts with the current resource state or an idempotency key. | Não |
UNSUPPORTED_OPERATION | 400 | The requested operation is not supported for this resource. | Não |
INTEGRATION_UNAVAILABLE | 503 | A downstream connector or integration is temporarily unavailable. | Sim |
EXTERNAL_RESOURCE_CONFLICT | 409 | An external integration reported a state conflict. | Não |
RATE_LIMITED | 429 | The caller exceeded its request budget; retry after RateLimit-Reset. | Sim |
DEADLINE_EXCEEDED | 504 | The operation timed out before completion. | Sim |
INTERNAL_ERROR | 500 | An unexpected server error occurred. | Sim |
Códigos específicos (error_code)
| Código | Parâmetros | Significado |
|---|---|---|
account.contact_in_use | Nenhum | Já existe uma conta com este e-mail ou telefone. |
account.creation_review_required | Nenhum | A criação desta conta precisa de uma revisão manual. Contacte o suporte para continuar. |
account.limit_reached | Nenhum | Esta pessoa atingiu o limite de contas permitido. |
account_link.details_required | Nenhum | Indique o código de ligação, ou a empresa de água, o número de contrato ou de contador e o telemóvel. |
account_link.permission_not_delegable | Nenhum | Esta permissão não pode ser delegada. |
approval.self_approval | Nenhum | Não pode aprovar um pedido feito por si. |
auth.challenge_failed | Nenhum | Não foi possível confirmar que não é um robô. Tente de novo. |
auth.challenge_required | Nenhum | Confirme que não é um robô e tente de novo. |
auth.forbidden | Nenhum | Não tem permissão para esta acção. |
auth.invalid_credentials | Nenhum | Os dados de acesso estão incorrectos. |
auth.ip_not_allowed | Nenhum | A sua empresa não permite o acesso a partir desta rede. |
auth.mfa_challenge_invalid | Nenhum | O pedido de verificação expirou. Entre de novo. |
auth.mfa_enrollment_required | Nenhum | A sua empresa exige a verificação em dois passos. Active-a em Segurança para continuar. |
auth.mfa_locked | Nenhum | Demasiados códigos incorrectos. Aguarde alguns minutos e tente de novo. |
auth.session_ended | Nenhum | Esta sessão foi terminada. Entre de novo para continuar. |
auth.sso_required | Nenhum | Esta empresa exige a entrada pelo seu fornecedor de identidade (SSO). |
auth.step_up_required | Nenhum | Confirme a sua identidade para continuar. |
auth.token_expired | Nenhum | O código ou a ligação expirou. Peça um novo. |
auth.unauthenticated | Nenhum | A sua sessão terminou. Entre novamente. |
capability.inactive | Nenhum | Esta funcionalidade ainda não está activa para a empresa. |
cashier.shift_not_open | Nenhum | Abra um turno de caixa antes de continuar. |
connection.property_not_owned | Nenhum | Este imóvel não pertence a este cliente. |
connector.lease_expired | Nenhum | A reserva deste trabalho expirou. Tente de novo. |
feature.not_configured | Nenhum | Esta funcionalidade ainda não está configurada. |
file.too_large | Nenhum | O ficheiro excede o limite de tamanho. |
file.type_unsupported | Nenhum | Este tipo de ficheiro não é aceite. |
identity.password_too_common | Nenhum | Esta palavra-passe é demasiado comum. Escolha outra. |
import.column_missing | column | Falta a coluna {column} no ficheiro. |
import.file_empty | Nenhum | O ficheiro não tem linhas para importar. |
import.file_invalid | Nenhum | Não foi possível ler o ficheiro. Verifique o formato. |
import.line_invalid | line | A linha {line} do ficheiro está incompleta ou não é válida. |
import.too_many_rows | max | O ficheiro tem demasiadas linhas: no máximo {max} de cada vez. |
integration.bad_gateway | Nenhum | Não foi possível contactar o serviço externo. |
integration.conflict | Nenhum | O serviço externo recusou a operação por conflito. |
integration.unavailable | Nenhum | O serviço externo não está disponível. Tente mais tarde. |
inventory.insufficient_stock | Nenhum | Não há stock suficiente no armazém. |
inventory.item_unavailable | Nenhum | O artigo {item} não está no catálogo ou está inactivo. |
inventory.whole_units_only | Nenhum | {item} conta-se em unidades inteiras. |
invoice.has_payments | Nenhum | Esta factura tem pagamentos e não pode ser anulada. Emita uma nota de crédito. |
invoice.no_balance | Nenhum | Esta factura não tem saldo em dívida. |
invoice.not_open | Nenhum | Esta factura não está em aberto. |
invoice.void | Nenhum | Esta factura está anulada. |
leak_allowance.ineligible | Nenhum | Esta factura não cumpre a política de abatimento por fuga. |
meter.no_collector | Nenhum | Este contador não tem colector para receber comandos. |
meter.no_reading_baseline | Nenhum | Não há leituras aceites que delimitem o período de consumo. |
meter.serial_mismatch | Nenhum | O número de série não corresponde ao contador. |
organization.owner_consent_required | Nenhum | É necessário o consentimento do titular. |
payment.method_not_configured | Nenhum | Este meio de pagamento não está configurado para esta entidade. |
payment.reference_in_use | Nenhum | Esta referência já foi usada. |
payment.session_mismatch | Nenhum | O pagamento não corresponde à sessão de pagamento. |
proof.already_reviewed | Nenhum | Este comprovativo já foi analisado. |
reading.unit_mismatch | Nenhum | A unidade da leitura não corresponde à do contador. |
request.cursor_invalid | Nenhum | A página pedida já não é válida. Recarregue a lista. |
request.idempotency_conflict | Nenhum | Este pedido já foi enviado com outros dados. Recarregue e tente de novo. |
request.invalid | Nenhum | Os dados indicados não são válidos. Reveja e tente de novo. |
request.payload_too_large | Nenhum | O ficheiro é demasiado grande. |
request.rate_limited | Nenhum | Demasiadas tentativas. Aguarde um pouco e tente de novo. |
request.timeout | Nenhum | O pedido demorou demasiado. Tente de novo. |
request.unsupported | Nenhum | Esta operação não é suportada. |
resource.already_exists | Nenhum | Este registo já existe. |
resource.conflict | Nenhum | Esta operação não é possível no estado actual do registo. |
resource.gone | Nenhum | Este endereço já não existe. |
resource.not_found | Nenhum | Registo não encontrado. |
server.internal | Nenhum | Ocorreu um erro no servidor. Tente de novo dentro de momentos. |
state.invalid_transition | Nenhum | Esta acção não é possível no estado actual do registo. |
subscription.connection_limit_reached | Nenhum | O seu plano permite até {max} ligações activas. Mude de plano para activar mais. |
subscription.suspended | Nenhum | A subscrição desta empresa está suspensa por falta de pagamento. Regularize a factura em aberto para voltar a fazer alterações. |
validation.duplicate | field | Há valores repetidos. Cada entrada deve ser única. |
validation.end_before_start | Nenhum | A data de fim deve ser posterior à data de início. |
validation.field_required | field | Preencha os campos obrigatórios. |
validation.invalid_choice | field | Escolha uma das opções disponíveis. |
validation.invalid_format | field | Um dos valores não tem o formato correcto. Reveja e tente de novo. |
validation.length_out_of_range | field, min, max | O texto deve ter entre {min} e {max} caracteres. |
validation.must_be_future | field | A data deve ser no futuro. |
validation.must_be_positive | field | Indique um valor maior que zero. |
validation.must_not_be_future | field | A data não pode ser no futuro. |
validation.must_not_be_negative | field | O valor não pode ser negativo. |
validation.out_of_range | field, min, max | O valor deve estar entre {min} e {max}. |
validation.reason_required | field | Indique o motivo. |
validation.too_large | field, max | O valor não pode ser superior a {max}. |
validation.too_long | field, max | O texto é demasiado longo: use no máximo {max} caracteres. |
validation.too_many | field, max | Demasiados elementos: no máximo {max}. |
validation.too_short | field, min | O texto é demasiado curto: use pelo menos {min} caracteres. |
validation.too_small | field, min | O valor não pode ser inferior a {min}. |
workspace.unavailable | Nenhum | Esta empresa está suspensa ou encerrada. |