SequencesAnula rangos de e-NCF sin usar

Anula rangos de e-NCF sin usar

POST

/api/v1/sequences/annulments

const url = 'https://api.novafe.example/api/v1/sequences/annulments';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'},
  body: '{"environment":"example","reason":"example","lines":[{"type":1,"series":"example","rangeFrom":1,"rangeTo":1}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.novafe.example/api/v1/sequences/annulments \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "environment": "example", "reason": "example", "lines": [ { "type": 1, "series": "example", "rangeFrom": 1, "rangeTo": 1 } ] }'

Anula la cola sin usar de uno o más rangos autorizados (ANECF). Descarta los números localmente de inmediato y confirma con la DGII dentro de la misma petición; si la DGII no responde, la anulación queda failed y se reintenta con Task<IActionResult> SequencesController.RetryAnnulment(Guid id, CancellationToken ct).

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

Authorizations

ApiKey

Request Body^required

object

environment

required

string

reason

required

string

lines

required

Array<object>

Una línea del request: el rango a anular de un tipo/serie puntual.

object

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*)$/

Example^generated

{
  "environment": "example",
  "reason": "example",
  "lines": [
    {
      "type": 1,
      "series": "example",
      "rangeFrom": 1,
      "rangeTo": 1
    }
  ]
}

object

environment

required

string

reason

required

string

lines

required

Array<object>

Una línea del request: el rango a anular de un tipo/serie puntual.

object

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*)$/

Example^generated

{
  "environment": "example",
  "reason": "example",
  "lines": [
    {
      "type": 1,
      "series": "example",
      "rangeFrom": 1,
      "rangeTo": 1
    }
  ]
}

object

environment

required

string

reason

required

string

lines

required

Array<object>

Una línea del request: el rango a anular de un tipo/serie puntual.

object

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*)$/

Example^generated

{
  "environment": "example",
  "reason": "example",
  "lines": [
    {
      "type": 1,
      "series": "example",
      "rangeFrom": 1,
      "rangeTo": 1
    }
  ]
}

Responses

200

Lo que la API devuelve para una solicitud de anulación de rango (Módulo 8).

object

required

string format: uuid

environment

required

string

reason

required

string

status

required

string

totalCount

required

integer | string format: int64

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

lines

required

Array<object>

Una línea (<Anulacion>) de la solicitud.

object

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*)$/

count

required

integer | string format: int64

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

typeName

Nombre del tipo de comprobante de cara al contribuyente.

null | string

dgiiCode

required

null | string

dgiiMessages

required

Array<string>

lastError

required

null | string

attempts

required

integer | string format: int32

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

submittedAt

required

null | string format: date-time

voidedAt

required

null | string format: date-time

createdAt

required

string format: date-time

Lo que la API devuelve para una solicitud de anulación de rango (Módulo 8).

object

required

string format: uuid

environment

required

string

reason

required

string

status

required

string

totalCount

required

integer | string format: int64

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

lines

required

Array<object>

Una línea (<Anulacion>) de la solicitud.

object

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*)$/

count

required

integer | string format: int64

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

typeName

Nombre del tipo de comprobante de cara al contribuyente.

null | string

dgiiCode

required

null | string

dgiiMessages

required

Array<string>

lastError

required

null | string

attempts

required

integer | string format: int32

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

submittedAt

required

null | string format: date-time

voidedAt

required

null | string format: date-time

createdAt

required

string format: date-time

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "environment": "example",
  "reason": "example",
  "status": "example",
  "totalCount": 1,
  "lines": [
    {
      "type": 1,
      "series": "example",
      "rangeFrom": 1,
      "rangeTo": 1,
      "count": 1,
      "typeName": "example"
    }
  ],
  "dgiiCode": "example",
  "dgiiMessages": [
    "example"
  ],
  "lastError": "example",
  "attempts": 1,
  "submittedAt": "2026-04-15T12:00:00Z",
  "voidedAt": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z"
}

Lo que la API devuelve para una solicitud de anulación de rango (Módulo 8).

object

required

string format: uuid

environment

required

string

reason

required

string

status

required

string

totalCount

required

integer | string format: int64

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

lines

required

Array<object>

Una línea (<Anulacion>) de la solicitud.

object

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*)$/

count

required

integer | string format: int64

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

typeName

Nombre del tipo de comprobante de cara al contribuyente.

null | string

dgiiCode

required

null | string

dgiiMessages

required

Array<string>

lastError

required

null | string

attempts

required

integer | string format: int32

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

submittedAt

required

null | string format: date-time

voidedAt

required

null | string format: date-time

createdAt

required

string format: date-time

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "environment": "example",
  "reason": "example",
  "status": "example",
  "totalCount": 1,
  "lines": [
    {
      "type": 1,
      "series": "example",
      "rangeFrom": 1,
      "rangeTo": 1,
      "count": 1,
      "typeName": "example"
    }
  ],
  "dgiiCode": "example",
  "dgiiMessages": [
    "example"
  ],
  "lastError": "example",
  "attempts": 1,
  "submittedAt": "2026-04-15T12:00:00Z",
  "voidedAt": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z"
}

400

Bad Request

object

type

null | string

title

null | string

status

null | integer | string format: int32

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

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

object

type

null | string

title

null | string

status

null | integer | string format: int32

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

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

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

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

Anula rangos de e-NCF sin usar

Authorizations

Request Bodyrequired

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Examplegenerated

Examplegenerated

400

Examplegenerated

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated