Consulta un rango de e-NCF

GET

/api/v1/sequences/{id}

curl --request GET \
  --url https://api.novafe.example/api/v1/sequences/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'X-API-Key: <X-API-Key>'

Autenticación: requiere una API key (header X-API-Key) con rol admin_tenant.

Authorizations

• ApiKey

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

OK

Lo que la API devuelve para un rango de secuencias. Los campos derivados (long NcfSequenceDto.Remaining, long NcfSequenceDto.Capacity, bool NcfSequenceDto.IsLowStock) los calcula la consulta — bool NcfSequenceDto.IsLowStock con el setting runtime sequences.low_stock_fraction (RF-07.3); no se almacenan.

object

id

required

string format: uuid

environment

required

string

type

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

series

required

string

rangeFrom

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

rangeTo

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

next

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

capacity

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

remaining

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

isLowStock

required

boolean

expiresOn

required

null | string format: date

active

required

boolean

createdAt

required

string format: date-time

typeName

Nombre del tipo de comprobante de cara al contribuyente.

null | string

Lo que la API devuelve para un rango de secuencias. Los campos derivados (long NcfSequenceDto.Remaining, long NcfSequenceDto.Capacity, bool NcfSequenceDto.IsLowStock) los calcula la consulta — bool NcfSequenceDto.IsLowStock con el setting runtime sequences.low_stock_fraction (RF-07.3); no se almacenan.

object

id

required

string format: uuid

environment

required

string

type

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

series

required

string

rangeFrom

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

rangeTo

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

next

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

capacity

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

remaining

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

isLowStock

required

boolean

expiresOn

required

null | string format: date

active

required

boolean

createdAt

required

string format: date-time

typeName

Nombre del tipo de comprobante de cara al contribuyente.

null | string

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "environment": "example",
  "type": 1,
  "series": "example",
  "rangeFrom": 1,
  "rangeTo": 1,
  "next": 1,
  "capacity": 1,
  "remaining": 1,
  "isLowStock": true,
  "expiresOn": "2026-04-15",
  "active": true,
  "createdAt": "2026-04-15T12:00:00Z",
  "typeName": "example"
}

Lo que la API devuelve para un rango de secuencias. Los campos derivados (long NcfSequenceDto.Remaining, long NcfSequenceDto.Capacity, bool NcfSequenceDto.IsLowStock) los calcula la consulta — bool NcfSequenceDto.IsLowStock con el setting runtime sequences.low_stock_fraction (RF-07.3); no se almacenan.

object

id

required

string format: uuid

environment

required

string

type

required

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

series

required

string

rangeFrom

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

rangeTo

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

next

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

capacity

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

remaining

required

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

isLowStock

required

boolean

expiresOn

required

null | string format: date

active

required

boolean

createdAt

required

string format: date-time

typeName

Nombre del tipo de comprobante de cara al contribuyente.

null | string

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "environment": "example",
  "type": 1,
  "series": "example",
  "rangeFrom": 1,
  "rangeTo": 1,
  "next": 1,
  "capacity": 1,
  "remaining": 1,
  "isLowStock": true,
  "expiresOn": "2026-04-15",
  "active": true,
  "createdAt": "2026-04-15T12:00:00Z",
  "typeName": "example"
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}