Skip to main content
POST
Inutilização de numeração

Authorizations

X-Api-Key
string
header
required

Authorization By X-Api-Key inside request's header

Body

initialNumber
integer<int64>
required

Número inicial

Required range: x >= 1
finalNumber
integer<int64>
required

Número final

Required range: x >= 1
series
integer<int32>
required

Série

Required range: 0 <= x <= 2147483647
reason
string
required

Motivo

Minimum string length: 15

Response

OK

identifier
string | null
date
string<date-time>
initialNumber
integer<int64>
finalNumber
integer<int64>
series
string | null
reason
string | null
protocolNumber
string | null
status
enum<string>

Valores possíveis:

  • inProcessing: Em Processamento
  • registered: Registrado
  • rejected: Rejeitado
  • error: Erro
Available options:
inProcessing,
registered,
rejected,
error
environment
enum<string>

Valores possíveis:

  • production: Produção
  • development: Homologação
  • simulation:
Available options:
production,
development,
simulation
messageCode
string | null
messageText
string | null