Consultar una factura compartida

GET

/v1/invoice-receipts/{receiptId}

curl --request GET \
  --url https://api.timbro.do/v1/invoice-receipts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• API de Timbro

Autenticación

• invoiceReceiptAccess

Parámetros

Parámetros de ruta

receiptId

obligatorio

string format: uuid

Respuestas

200

200

Respuesta predeterminada

Media typeapplication/json

Campos y códigos de la respuesta

object

acceptedAt

obligatorio

string format: date-time

buyer

obligatorio

null

null

InvoiceBuyerIdentity

discriminator: kind

AnonymousBuyer

object

kind

obligatorio

string

Valores permitidos: anonymous

DomesticBuyer

object

kind

obligatorio

string

Valores permitidos: domestic

legalName

obligatorio

string

>= 1 characters <= 150 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

taxId

obligatorio

string

/^[0-9]{9}([0-9]{2})?$/

deliveryPhone

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

ForeignBuyer

object

foreignId

obligatorio

string

>= 1 characters <= 20 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

kind

obligatorio

string

Valores permitidos: foreign

legalName

obligatorio

string

>= 1 characters <= 150 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

deliveryPhone

string

/^[0-9]{3}-[0-9]{3}-[0-9]{4}$/

currency

obligatorio

string

string

Valores permitidos: DOP BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

environment

obligatorio

Ambiente de ejecución de la DGII elegido antes de admitir el ciclo de vida.

string

Valores permitidos: sandbox certification production

exchangeRate

obligatorio

null

null

InvoiceExchangeRate

La tasa de cambio registrada: pesos dominicanos por cada unidad de la moneda de la factura.

object

rate

obligatorio

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

files

obligatorio

object

pdf

obligatorio

discriminator: status

NotApplicableReadiness

object

status

obligatorio

string

Valores permitidos: notApplicable

object

object

stage

obligatorio

string

Valores permitidos: awaitingSignedSource queued rendering retryScheduled

status

obligatorio

string

Valores permitidos: pending

object

object

byteLength

obligatorio

integer format: int32

>= 1 <= 2147483647

createdAt

obligatorio

string format: date-time

layout

obligatorio

string

Valores permitidos: a4 receipt80mm

mediaType

obligatorio

string

Valores permitidos: application/pdf

pageCount

obligatorio

integer format: int32

>= 1 <= 100

pdfSha256

obligatorio

string

/^[0-9a-f]{64}$/

signedSourceSha256

obligatorio

string

/^[0-9a-f]{64}$/

status

obligatorio

string

Valores permitidos: ready

object

object

layout

obligatorio

string

Valores permitidos: a4 receipt80mm

resultCode

obligatorio

string

status

obligatorio

string

Valores permitidos: unavailable

fiscalIdentity

obligatorio

object

eNcf

obligatorio

string

/^E(31|32|33|34|41|43|44|45|46|47)[0-9]{10}$/

signature

obligatorio

null

null

InvoiceSignature

Los datos de la firma que la DGII exige en todo e-CF impreso, leídos del documento firmado.

Imprime la copia del comprador después de que la DGII acepte la factura; la DGII ordena el e-CF impreso después de su resultado de validación, incluido el tipo 32 por debajo de DOP 250,000 que valida mediante el resumen RFCE.

object

securityCode

obligatorio

Los primeros seis caracteres del valor de la firma, impresos debajo del código QR.

string

/^[A-Za-z0-9+/]{6}$/

signedAt

obligatorio

El instante exacto de FechaHoraFirma en RFC 3339 con el GMT-4 fijo de la DGII, para que su fecha y hora coincidan con el dd-MM-aaaa HH:mm:ss impreso.

string

/^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}-04:00$/

verificationUrl

obligatorio

La URL de consulta de la DGII que codifica el código QR impreso.

string format: uri

/^https://(ecf|fc)\.dgii\.gov\.do//

type

obligatorio

string

Valores permitidos: E31 E32 E33 E34 E41 E43 E44 E45 E46 E47

foreignPayment

obligatorio

null

null

InvoiceForeignPaymentResource

object

payee

obligatorio

object

foreignId

obligatorio

string

>= 1 characters <= 20 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

legalName

obligatorio

string

>= 1 characters <= 150 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

withholdingBasis

obligatorio

discriminator: kind

object

object

authorityReference

obligatorio

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

kind

obligatorio

string

Valores permitidos: dominicanSourceIncome

governmentEligibility

obligatorio

null

null

InvoiceGovernmentEligibility

discriminator: entityKind

object

object

authorityReference

obligatorio

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

entityKind

obligatorio

string

Valores permitidos: central_government

object

object

authorityReference

obligatorio

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

entityKind

obligatorio

string

Valores permitidos: decentralized_or_autonomous

object

object

authorityReference

obligatorio

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

entityKind

obligatorio

string

Valores permitidos: social_security

object

object

authorityReference

obligatorio

string

>= 1 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

entityKind

obligatorio

string

Valores permitidos: other_noncommercial_government

id

obligatorio

string format: uuid

invoiceId

obligatorio

string format: uuid

issuerTaxId

obligatorio

string

items

obligatorio

Array<object> | null

object

additionalDescription

obligatorio

null

null

string

string

>= 1 characters <= 1000 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

additionalTaxCodes

obligatorio

Array<string>

adjustments

obligatorio

null

null

InvoiceLinePriceAdjustmentsResource

object

discounts

obligatorio

Array

discriminator: kind

object

object

amount

obligatorio

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

obligatorio

string

Valores permitidos: fixed_amount

object

object

kind

obligatorio

string

Valores permitidos: percentage

percentage

obligatorio

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

surcharges

obligatorio

Array

discriminator: kind

object

object

amount

obligatorio

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

obligatorio

string

Valores permitidos: fixed_amount

object

object

kind

obligatorio

string

Valores permitidos: percentage

percentage

obligatorio

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,2})?$/

description

obligatorio

string

id

obligatorio

string

itemCodes

obligatorio

Array<object>

object

code

obligatorio

string

>= 1 characters <= 35 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

typeCode

obligatorio

string

>= 1 characters <= 14 characters /^(?=.*[^\p{White_Space}])(?!.*[\u0000-\u0008\u000B\u000C\u000E-\u001F\uD800-\uDFFF\uFFFE\uFFFF])[\s\S]+$/

kind

obligatorio

Indica si una línea Source describe un bien o un servicio.

string

Valores permitidos: good service

legalTip

obligatorio

boolean

quantity

obligatorio

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

tax

obligatorio

discriminator: kind

object

object

included

obligatorio

boolean

kind

obligatorio

string

Valores permitidos: itbis_18

object

object

included

obligatorio

boolean

kind

obligatorio

string

Valores permitidos: itbis_16

ZeroRatedTax

object

kind

obligatorio

string

Valores permitidos: zero_rated

ExemptTax

object

kind

obligatorio

string

Valores permitidos: exempt

object

object

kind

obligatorio

string

Valores permitidos: non_billable

unit

obligatorio

Una unidad de medida del e-CF de la DGII: un nombre legible en minúsculas en la API de Source y de Invoice, y el código numérico oficial del catálogo en los documentos fiscales.

string

Valores permitidos: barrel bag jar bundle bottle box cigarette_pack centimetre cylinder set container day dozen bale gallon degree gram bulk hour crate kilogram kilowatt_hour pound litre lot metre square_metre cubic_metre million_btu minute package pair foot piece roll envelope second tank ton tube yard square_yard unit element thousand sack tin display drum ration quintal gross_register_tonnage square_foot passenger inch boat_berth_stay tray hectare millilitre milligram ounce troy_ounce

unitPrice

obligatorio

string

/^[0-9]{1,16}(\.[0-9]{1,4})?$/

withholding

obligatorio

null

null

InvoiceItemWithholding

discriminator: kind

object

object

incomeTaxAmount

obligatorio

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

itbisAmount

obligatorio

null

null

string

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

obligatorio

string

Valores permitidos: purchase

object

object

incomeTaxWithheld

obligatorio

string

/^[0-9]{1,16}(\.[0-9]{1,2})?$/

kind

obligatorio

string

Valores permitidos: foreignPayment

originalInvoiceId

obligatorio

string | null format: uuid

paymentTerms

obligatorio

null

null

InvoicePaymentTermsResource

discriminator: type

object

object

allocations

obligatorio

Array<object>

<= 7 items

Un medio de pago y su importe, ambos en DOP, cualquiera que sea la moneda de la factura. Las asignaciones suman el total en DOP.

object

amount

obligatorio

string

/^(?=[0-9.]*[1-9])[0-9]{1,16}(\.[0-9]{1,2})?$/

method

obligatorio

Métodos de pago identificados por nombre, cuyos códigos oficiales pertenecen a fiscal-document.

string

Valores permitidos: cash bank_transfer card credit_sale gift_certificate barter credit_note other

type

obligatorio

string

Valores permitidos: immediate

paymentAccount

object

accountNumber

obligatorio

null

null

string

string

>= 1 characters <= 28 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

bankName

obligatorio

null

null

string

string

>= 1 characters <= 75 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

CreditPaymentTerms

object

dueOn

obligatorio

Una fecha calendario en formato ISO 8601 de la API pública.

string format: date

/^(19|20)[0-9]{2}-[0-9]{2}-[0-9]{2}$/

type

obligatorio

string

Valores permitidos: credit

FreePaymentTerms

object

type

obligatorio

string

Valores permitidos: free

replacesInvoiceId

obligatorio

string | null format: uuid

source

obligatorio

object

contentSha256

obligatorio

string

/^[0-9a-f]{64}$/

id

obligatorio

string

version

obligatorio

string

status

obligatorio

string

Valores permitidos: accepted acceptedWithObservations

supplier

obligatorio

null

null

InvoiceSupplierResource

object

address

obligatorio

null

null

string

string

>= 1 characters <= 100 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

contactName

obligatorio

null

null

string

string

>= 1 characters <= 80 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

email

obligatorio

null

null

string

string

<= 80 characters /^[\p{L}\p{M}\p{N}\p{S}_]+(?:[-.][\p{L}\p{M}\p{N}\p{S}_]+)*@[\p{L}\p{M}\p{N}\p{S}]+(?:[-.][\p{L}\p{M}\p{N}\p{S}]+)*\.[\p{L}\p{M}\p{N}\p{S}]+(?:[-.][\p{L}\p{M}\p{N}\p{S}]+)*$/

identityNumber

obligatorio

string

/^[0-9]{9}([0-9]{2})?$/

internalCode

obligatorio

null

null

string

string

>= 1 characters <= 20 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

legalName

obligatorio

string

>= 1 characters <= 150 characters /^(?=.*[^\p{White_Space}])[\s\S]+$/

municipalityCode

obligatorio

null

null

string

string

/^[0-9]{6}$/

Valores permitidos: 010000 010100 010101 020000 020100 020101 020102 020103 020104 020105 020106 020107 020108 020109 020200 020201 020202 020300 020301 020302 020303 020400 020401 020402 020403 020404 020405 020500 020501 020600 020601 020602 020603 020604 020700 020701 020702 020800 020801 020802 020803 020804 020900 020901 021000 021001 030000 030001 030101 030102 030200 030201 030202 030300 030301 030302 030303 030304 030305 030306 030307 030400 030401 030500 030501 030502 040000 040100 040101 040102 040103 040104 040200 040201 040300 040301 040302 040400 040401 040402 040500 040501 040502 040503 040504 040600 040601 040700 040701 040702 040800 040801 040802 040900 040901 041000 041001 041100 041101 041102 050000 050100 050101 050102 050200 050201 050202 050203 050300 050301 050400 050401 050500 050501 050502 060000 060100 060101 060102 060103 060104 060105 060200 060201 060202 060203 060300 060301 060400 060401 060500 060501 060502 060503 060504 060505 060600 060601 060700 060701 060702 070000 070100 070101 070102 070103 070200 070201 070202 070203 070300 070301 070302 070400 070401 070402 070500 070501 070502 070600 070601 080000 080100 080101 080102 080103 080104 080200 080201 080202 080203 090000 090100 090101 090102 090103 090104 090105 090106 090107 090108 090109 090200 090201 090300 090301 090302 090303 090304 090400 090401 100000 100100 100101 100102 100103 100200 100201 100202 100300 100301 100400 100401 100402 100500 100501 100502 100600 100601 100602 110000 110100 110101 110102 110103 110104 110200 110201 110202 110203 120000 120100 120101 120102 120200 120201 120300 120301 120302 130000 130100 130101 130102 130103 130104 130105 130200 130201 130202 130203 130300 130301 130302 130303 130400 130401 130402 140000 140100 140101 140102 140103 140104 140200 140201 140202 140203 140300 140301 140302 140400 140401 150000 150100 150101 150200 150201 150202 150300 150301 150302 150303 150304 150400 150401 150500 150501 150502 150600 150601 160000 160100 160101 160102 160200 160201 160202 170000 170100 170101 170102 170103 170104 170105 170106 170107 170108 170109 170110 170200 170201 170202 170203 170300 170301 180000 180100 180101 180102 180103 180200 180201 180202 180300 180301 180400 180401 180500 180501 180502 180600 180601 180602 180603 180604 180700 180701 180702 180703 180800 180801 180802 180803 180804 180900 180901 190000 190100 190101 190102 190200 190201 190202 190300 190301 200000 200100 200101 200102 200103 200104 200200 200201 200300 200301 210000 210100 210101 210102 210103 210200 210201 210300 210301 210302 210303 210400 210401 210402 210500 210501 210502 210503 210504 210600 210601 210602 210700 210701 210800 210801 220000 220100 220101 220102 220103 220104 220105 220106 220107 220108 220109 220110 220111 220200 220201 220202 220203 220300 220301 220302 220303 220400 220401 220402 220500 220501 220502 220503 220600 220601 220602 230000 230100 230101 230200 230201 230202 230203 230300 230301 230400 230401 230500 230501 230600 230601 240000 240100 240101 240102 240103 240104 240105 240106 240200 240201 240202 240300 240301 240400 240401 240402 240403 240404 250000 250100 250101 250102 250104 250105 250106 250107 250200 250201 250300 250301 250302 250303 250400 250401 250402 250500 250501 250502 250503 250504 250600 250601 250602 250700 250701 250702 250703 250800 250801 250802 250803 250900 250901 251000 251001 260000 260100 260101 260200 260201 260300 260301 270000 270100 270101 270102 270103 270104 270200 270201 270202 270203 270204 270205 270300 270301 270302 270303 270304 280000 280100 280101 280102 280103 280104 280105 280106 280200 280201 280300 280301 280302 280303 290000 290100 290101 290102 290103 290104 290200 290201 290300 290301 290302 290303 290400 290402 290403 290500 290501 300000 300100 300101 300102 300103 300104 300200 300201 300202 300300 300301 310000 310100 310101 310102 310103 310104 310105 310200 310201 310300 310301 320000 320100 320101 320102 320200 320201 320300 320301 320302 320400 320401 320402 320500 320501 320502 320600 320601 320602 320603 320700 320701 320702 320703

provinceCode

obligatorio

null

null

string

string

/^[0-9]{6}$/

Valores permitidos: 010000 010100 010101 020000 020100 020101 020102 020103 020104 020105 020106 020107 020108 020109 020200 020201 020202 020300 020301 020302 020303 020400 020401 020402 020403 020404 020405 020500 020501 020600 020601 020602 020603 020604 020700 020701 020702 020800 020801 020802 020803 020804 020900 020901 021000 021001 030000 030001 030101 030102 030200 030201 030202 030300 030301 030302 030303 030304 030305 030306 030307 030400 030401 030500 030501 030502 040000 040100 040101 040102 040103 040104 040200 040201 040300 040301 040302 040400 040401 040402 040500 040501 040502 040503 040504 040600 040601 040700 040701 040702 040800 040801 040802 040900 040901 041000 041001 041100 041101 041102 050000 050100 050101 050102 050200 050201 050202 050203 050300 050301 050400 050401 050500 050501 050502 060000 060100 060101 060102 060103 060104 060105 060200 060201 060202 060203 060300 060301 060400 060401 060500 060501 060502 060503 060504 060505 060600 060601 060700 060701 060702 070000 070100 070101 070102 070103 070200 070201 070202 070203 070300 070301 070302 070400 070401 070402 070500 070501 070502 070600 070601 080000 080100 080101 080102 080103 080104 080200 080201 080202 080203 090000 090100 090101 090102 090103 090104 090105 090106 090107 090108 090109 090200 090201 090300 090301 090302 090303 090304 090400 090401 100000 100100 100101 100102 100103 100200 100201 100202 100300 100301 100400 100401 100402 100500 100501 100502 100600 100601 100602 110000 110100 110101 110102 110103 110104 110200 110201 110202 110203 120000 120100 120101 120102 120200 120201 120300 120301 120302 130000 130100 130101 130102 130103 130104 130105 130200 130201 130202 130203 130300 130301 130302 130303 130400 130401 130402 140000 140100 140101 140102 140103 140104 140200 140201 140202 140203 140300 140301 140302 140400 140401 150000 150100 150101 150200 150201 150202 150300 150301 150302 150303 150304 150400 150401 150500 150501 150502 150600 150601 160000 160100 160101 160102 160200 160201 160202 170000 170100 170101 170102 170103 170104 170105 170106 170107 170108 170109 170110 170200 170201 170202 170203 170300 170301 180000 180100 180101 180102 180103 180200 180201 180202 180300 180301 180400 180401 180500 180501 180502 180600 180601 180602 180603 180604 180700 180701 180702 180703 180800 180801 180802 180803 180804 180900 180901 190000 190100 190101 190102 190200 190201 190202 190300 190301 200000 200100 200101 200102 200103 200104 200200 200201 200300 200301 210000 210100 210101 210102 210103 210200 210201 210300 210301 210302 210303 210400 210401 210402 210500 210501 210502 210503 210504 210600 210601 210602 210700 210701 210800 210801 220000 220100 220101 220102 220103 220104 220105 220106 220107 220108 220109 220110 220111 220200 220201 220202 220203 220300 220301 220302 220303 220400 220401 220402 220500 220501 220502 220503 220600 220601 220602 230000 230100 230101 230200 230201 230202 230203 230300 230301 230400 230401 230500 230501 230600 230601 240000 240100 240101 240102 240103 240104 240105 240106 240200 240201 240202 240300 240301 240400 240401 240402 240403 240404 250000 250100 250101 250102 250104 250105 250106 250107 250200 250201 250300 250301 250302 250303 250400 250401 250402 250500 250501 250502 250503 250504 250600 250601 250602 250700 250701 250702 250703 250800 250801 250802 250803 250900 250901 251000 251001 260000 260100 260101 260200 260201 260300 260301 270000 270100 270101 270102 270103 270104 270200 270201 270202 270203 270204 270205 270300 270301 270302 270303 270304 280000 280100 280101 280102 280103 280104 280105 280106 280200 280201 280300 280301 280302 280303 290000 290100 290101 290102 290103 290104 290200 290201 290300 290301 290302 290303 290400 290402 290403 290500 290501 300000 300100 300101 300102 300103 300104 300200 300201 300202 300300 300301 310000 310100 310101 310102 310103 310104 310105 310200 310201 310300 310301 320000 320100 320101 320102 320200 320201 320300 320301 320302 320400 320401 320402 320500 320501 320502 320600 320601 320602 320603 320700 320701 320702 320703

totals

obligatorio

object

foreign

obligatorio

null

null

InvoiceForeignTotals

Totales de una factura en la moneda en que se expresa su precio. total equivale al total del precio.

object

currency

obligatorio

string

Valores permitidos: BRL CAD CHF CHY XDR DKK EUR GBP JPY NOK SCP SEK USD VEF HTG MXN COP

exchangeRate

obligatorio

La tasa de cambio registrada: pesos dominicanos por cada unidad de la moneda de la factura.

object

rate

obligatorio

string

/^(?=[0-9.]*[1-9])[0-9]{1,3}(\.[0-9]{1,4})?$/

net

obligatorio

string

/^[0-9]+\.[0-9]{2}$/

tax

obligatorio

string

/^[0-9]+\.[0-9]{2}$/

total

obligatorio

string

/^[0-9]+\.[0-9]{2}$/

net

obligatorio

string

nonBillable

obligatorio

string

tax

obligatorio

string

total

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

400

400

No se pudo entender la solicitud.

Media typeapplication/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "No se pudo entender la solicitud.",
  "status": 400,
  "code": "parameter_invalid",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: parameter_invalid

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 400

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

Valores permitidos: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

401

401

La credencial falta, tiene un formato incorrecto o ya no es válida.

Media typeapplication/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La credencial falta, tiene un formato incorrecto o ya no es válida.",
  "status": 401,
  "code": "api_key_missing",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: api_key_missing api_key_invalid checkout_token_invalid checkout_token_expired

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 401

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

Valores permitidos: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

403

403

La credencial es válida, pero no tiene permiso para realizar esta operación.

Media typeapplication/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La credencial es válida, pero no tiene permiso para realizar esta operación.",
  "status": 403,
  "code": "operation_not_permitted",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: operation_not_permitted

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 403

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

Valores permitidos: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

404

404

Ningún endpoint sirve este método y ruta, o no existe un recurso con este identificador dentro del alcance del solicitante.

Media typeapplication/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "Ningún endpoint sirve este método y ruta, o no existe un recurso con este identificador dentro del alcance del solicitante.",
  "status": 404,
  "code": "route_not_found",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: route_not_found webhook_endpoint_not_found webhook_event_not_found organization_not_found legal_issuer_not_found invitation_invalid certificate_custody_binding_not_found integration_not_found source_provider_authorization_not_found certification_test_run_document_not_found fiscal_operation_not_found invoice_not_found fiscal_artifact_not_found invoice_receipt_not_found fiscal_delivery_not_found received_document_not_found receiving_issuer_not_found

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 404

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

Valores permitidos: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

409

409

La solicitud entra en conflicto con el estado actual del recurso o con una solicitud anterior que usó la misma clave de idempotencia (Idempotency-Key).

Media typeapplication/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La solicitud entra en conflicto con el estado actual del recurso o con una solicitud anterior que usó la misma clave de idempotencia (`Idempotency-Key`).",
  "status": 409,
  "code": "integration_not_connected",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: integration_not_connected

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 409

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

Valores permitidos: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.

500

500

La solicitud no pudo completarse. Recupera el resultado con la referencia guardada o repite la solicitud con la misma clave de idempotencia.

Media typeapplication/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La solicitud no pudo completarse. Recupera el resultado con la referencia guardada o repite la solicitud con la misma clave de idempotencia.",
  "status": 500,
  "code": "internal_error",
  "requestId": "request_000000000000000000000001"
}

Campos y códigos de la respuesta

Detalles de problema RFC 9457. Cada fallo de esta API es uno de estos objetos y cada operación limita code al subconjunto que puede emitir.

object

code

obligatorio

Código estable legible por máquinas. Toma decisiones con este código, nunca con title.

string

Valores permitidos: internal_error fiscal_artifact_unverified

requestId

obligatorio

string

status

obligatorio

integer format: int32

>= 400 <= 599

Valor permitido: 500

title

obligatorio

string

type

obligatorio

string

Valores permitidos: about:blank

Campos opcionales

detail

string

invoiceId

Solo aparece si la solicitud rechazada produjo una operación fiscal.

string

issuanceBlockers

Solo aparece cuando las reglas oficiales de emisión rechazan la emisión.

Array<string>

Valores permitidos: invalid_request unsupported_protocol unsupported_rules_version invalid_resolved_facts numbering_verifier_missing numbering_mode_not_enabled document_type_not_recognized sequence_missing sequence_not_observed_on_effective_date sequence_suspended sequence_cancelled sequence_superseded sequence_exhausted sequence_conflicting sequence_document_type_mismatch sequence_rejected_by_dgii sequence_expired sequence_range_overlap fiscal_number_capacity_exhausted invalid_fiscal_number fiscal_number_outside_authorized_range fiscal_number_before_verified_floor sequence_expiration_mismatch

problems

Solo aparece cuando el rechazo señala un valor incluido en la solicitud.

Array<object>

Un problema público estable del documento, guardado para una admisión rechazada.

object

code

obligatorio

string

message

obligatorio

string

path

obligatorio

string

Cabeceras

request-id

obligatorio

string

Identifica esta solicitud. Indícalo cuando contactes a soporte.