SIFENDE
Referencia APIExplorador de la API

Inutilizar un rango de numeración

Informa a SIFEN que un rango de números de un timbrado no se va a usar. Una respuesta 4066 deja el resultado terminal INDETERMINADA y bloquea nuevos envíos para proteger el rango. SANDBOX responde 422 sin registrar ni enviar un evento.

POST
/api/v1/documento-electronico/inutilizar
AuthorizationBearer <token>

API key de Sifende en el header Authorization: Bearer {api-key}. Además de autenticar, fija el contribuyente emisor y un ambiente inmutable DEV, PROD o SANDBOX: por eso ninguno de los dos se envía en el body. En PROD, la clave requiere un plan que incluya la API de integración; si no, toda ruta responde 403 plan-operation-not-allowed.

In: header

Header Parameters

Idempotency-Key?string

Clave opcional para identificar una intención idempotente en operaciones compatibles. Acepta un solo valor de 1 a 255 caracteres ASCII visibles, sin espacios al inicio ni al final. El alcance es por contribuyente y ambiente, compartido entre los tipos de operación. Una clave existente resuelve la operación original sin comparar el body ni el CDC posterior. Otro tipo de operación devuelve 422. El cliente debe persistir la clave y la solicitud original y generar una clave nueva para cada intención nueva. El replay dura 7 días desde la finalización; después la clave sigue reservada hasta que termina la conservación del documento. La solicitud debe poder deserializarse; los campos del body se validan sólo para operaciones nuevas.

Match^[!-~](?:[ -~]{0,253}[!-~])?$
Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

*/*

application/problem+json

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X POST "https://example.com/api/v1/documento-electronico/inutilizar" \  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \  -H "Content-Type: application/json" \  -d '{    "numeroTimbrado": 0,    "establecimiento": "str",    "puntoExpedicion": "str",    "numeroInicio": "string",    "numeroFin": "string",    "tipoDocumento": 0,    "motivo": "string"  }'
{  "eventoSifenId": 0,  "documentoElectronicoId": 0,  "contribuyenteId": 0,  "ambiente": "string",  "tipoEvento": "string",  "estadoEvento": "string",  "cdc": "string",  "motivo": "string",  "protocoloAutorizacion": "string",  "codigoRespuesta": "string",  "mensajeRespuesta": "string",  "fechaCreacion": "2019-08-24T14:15:22Z",  "fechaProcesamiento": "2019-08-24T14:15:22Z",  "numeroTimbrado": 0,  "establecimiento": "string",  "puntoExpedicion": "string",  "numeroInicio": "string",  "numeroFin": "string",  "tipoDocumento": 0,  "serieNumero": "string"}