PT EN

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ódigoEstado HTTPSignificadoRepetível
INVALID_REQUEST400The request was malformed or failed validation.Não
UNAUTHORIZED401Authentication is missing, invalid, or expired.Não
FORBIDDEN403The authenticated caller lacks permission for this action.Não
CAPABILITY_INACTIVE403The tenant capability required for this operation is not active.Não
NOT_FOUND404The requested resource does not exist or is not visible in this context.Não
CONFLICT409The request conflicts with the current resource state or an idempotency key.Não
UNSUPPORTED_OPERATION400The requested operation is not supported for this resource.Não
INTEGRATION_UNAVAILABLE503A downstream connector or integration is temporarily unavailable.Sim
EXTERNAL_RESOURCE_CONFLICT409An external integration reported a state conflict.Não
RATE_LIMITED429The caller exceeded its request budget; retry after RateLimit-Reset.Sim
DEADLINE_EXCEEDED504The operation timed out before completion.Sim
INTERNAL_ERROR500An unexpected server error occurred.Sim

Códigos específicos (error_code)

CódigoParâmetrosSignificado
account.contact_in_useNenhumJá existe uma conta com este e-mail ou telefone.
account.creation_review_requiredNenhumA criação desta conta precisa de uma revisão manual. Contacte o suporte para continuar.
account.limit_reachedNenhumEsta pessoa atingiu o limite de contas permitido.
account_link.details_requiredNenhumIndique 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_delegableNenhumEsta permissão não pode ser delegada.
approval.self_approvalNenhumNão pode aprovar um pedido feito por si.
auth.challenge_failedNenhumNão foi possível confirmar que não é um robô. Tente de novo.
auth.challenge_requiredNenhumConfirme que não é um robô e tente de novo.
auth.forbiddenNenhumNão tem permissão para esta acção.
auth.invalid_credentialsNenhumOs dados de acesso estão incorrectos.
auth.ip_not_allowedNenhumA sua empresa não permite o acesso a partir desta rede.
auth.mfa_challenge_invalidNenhumO pedido de verificação expirou. Entre de novo.
auth.mfa_enrollment_requiredNenhumA sua empresa exige a verificação em dois passos. Active-a em Segurança para continuar.
auth.mfa_lockedNenhumDemasiados códigos incorrectos. Aguarde alguns minutos e tente de novo.
auth.session_endedNenhumEsta sessão foi terminada. Entre de novo para continuar.
auth.sso_requiredNenhumEsta empresa exige a entrada pelo seu fornecedor de identidade (SSO).
auth.step_up_requiredNenhumConfirme a sua identidade para continuar.
auth.token_expiredNenhumO código ou a ligação expirou. Peça um novo.
auth.unauthenticatedNenhumA sua sessão terminou. Entre novamente.
capability.inactiveNenhumEsta funcionalidade ainda não está activa para a empresa.
cashier.shift_not_openNenhumAbra um turno de caixa antes de continuar.
connection.property_not_ownedNenhumEste imóvel não pertence a este cliente.
connector.lease_expiredNenhumA reserva deste trabalho expirou. Tente de novo.
feature.not_configuredNenhumEsta funcionalidade ainda não está configurada.
file.too_largeNenhumO ficheiro excede o limite de tamanho.
file.type_unsupportedNenhumEste tipo de ficheiro não é aceite.
identity.password_too_commonNenhumEsta palavra-passe é demasiado comum. Escolha outra.
import.column_missingcolumnFalta a coluna {column} no ficheiro.
import.file_emptyNenhumO ficheiro não tem linhas para importar.
import.file_invalidNenhumNão foi possível ler o ficheiro. Verifique o formato.
import.line_invalidlineA linha {line} do ficheiro está incompleta ou não é válida.
import.too_many_rowsmaxO ficheiro tem demasiadas linhas: no máximo {max} de cada vez.
integration.bad_gatewayNenhumNão foi possível contactar o serviço externo.
integration.conflictNenhumO serviço externo recusou a operação por conflito.
integration.unavailableNenhumO serviço externo não está disponível. Tente mais tarde.
inventory.insufficient_stockNenhumNão há stock suficiente no armazém.
inventory.item_unavailableNenhumO artigo {item} não está no catálogo ou está inactivo.
inventory.whole_units_onlyNenhum{item} conta-se em unidades inteiras.
invoice.has_paymentsNenhumEsta factura tem pagamentos e não pode ser anulada. Emita uma nota de crédito.
invoice.no_balanceNenhumEsta factura não tem saldo em dívida.
invoice.not_openNenhumEsta factura não está em aberto.
invoice.voidNenhumEsta factura está anulada.
leak_allowance.ineligibleNenhumEsta factura não cumpre a política de abatimento por fuga.
meter.no_collectorNenhumEste contador não tem colector para receber comandos.
meter.no_reading_baselineNenhumNão há leituras aceites que delimitem o período de consumo.
meter.serial_mismatchNenhumO número de série não corresponde ao contador.
payment.method_not_configuredNenhumEste meio de pagamento não está configurado para esta entidade.
payment.reference_in_useNenhumEsta referência já foi usada.
payment.session_mismatchNenhumO pagamento não corresponde à sessão de pagamento.
proof.already_reviewedNenhumEste comprovativo já foi analisado.
reading.unit_mismatchNenhumA unidade da leitura não corresponde à do contador.
request.cursor_invalidNenhumA página pedida já não é válida. Recarregue a lista.
request.idempotency_conflictNenhumEste pedido já foi enviado com outros dados. Recarregue e tente de novo.
request.invalidNenhumOs dados indicados não são válidos. Reveja e tente de novo.
request.payload_too_largeNenhumO ficheiro é demasiado grande.
request.rate_limitedNenhumDemasiadas tentativas. Aguarde um pouco e tente de novo.
request.timeoutNenhumO pedido demorou demasiado. Tente de novo.
request.unsupportedNenhumEsta operação não é suportada.
resource.already_existsNenhumEste registo já existe.
resource.conflictNenhumEsta operação não é possível no estado actual do registo.
resource.goneNenhumEste endereço já não existe.
resource.not_foundNenhumRegisto não encontrado.
server.internalNenhumOcorreu um erro no servidor. Tente de novo dentro de momentos.
state.invalid_transitionNenhumEsta acção não é possível no estado actual do registo.
subscription.connection_limit_reachedNenhumO seu plano permite até {max} ligações activas. Mude de plano para activar mais.
subscription.suspendedNenhumA subscrição desta empresa está suspensa por falta de pagamento. Regularize a factura em aberto para voltar a fazer alterações.
validation.duplicatefieldHá valores repetidos. Cada entrada deve ser única.
validation.end_before_startNenhumA data de fim deve ser posterior à data de início.
validation.field_requiredfieldPreencha os campos obrigatórios.
validation.invalid_choicefieldEscolha uma das opções disponíveis.
validation.invalid_formatfieldUm dos valores não tem o formato correcto. Reveja e tente de novo.
validation.length_out_of_rangefield, min, maxO texto deve ter entre {min} e {max} caracteres.
validation.must_be_futurefieldA data deve ser no futuro.
validation.must_be_positivefieldIndique um valor maior que zero.
validation.must_not_be_futurefieldA data não pode ser no futuro.
validation.must_not_be_negativefieldO valor não pode ser negativo.
validation.out_of_rangefield, min, maxO valor deve estar entre {min} e {max}.
validation.reason_requiredfieldIndique o motivo.
validation.too_largefield, maxO valor não pode ser superior a {max}.
validation.too_longfield, maxO texto é demasiado longo: use no máximo {max} caracteres.
validation.too_manyfield, maxDemasiados elementos: no máximo {max}.
validation.too_shortfield, minO texto é demasiado curto: use pelo menos {min} caracteres.
validation.too_smallfield, minO valor não pode ser inferior a {min}.
workspace.unavailableNenhumEsta empresa está suspensa ou encerrada.