Estado del documento y resultado de la DIAN

GET/api/v1/documents/{id}

Parámetros de ruta

idstring · uuidobligatorio

Respuestas

200OK

idstring · uuid
account_idstring · uuid
Cuenta emisora; una casa de software la usa para saber de qué cliente es el aviso
document_typestring
Valores: invoice · credit_note · debit_note · support_document · support_document_adjustment · payroll · payroll_adjustment · pos · pos_adjustment · pos_debit_adjustment
external_idstring
reference_document_idstring · uuid
prefixstring
numberinteger
null hasta que se envía a la DIAN; un rechazo lo libera
full_numberstring
Ejemplo: SETP990000001
document_keystring
CUFE, CUDE, CUDS o CUNE según el tipo
Ejemplo: a3f1c9...e2
environmentinteger
1 producción, 2 habilitación
Valores: 1 · 2
stagingboolean
Documento de prueba (cuenta en staging): no fue a la DIAN y no tiene validez fiscal
issued_atstring · date-time
customer_idstring
Contraparte: adquirente, vendedor (documento soporte) o trabajador (nómina)
customer_namestring
Ejemplo: PÉREZ GÓMEZ ANA
currencystring
Siempre COP: el XML y los montos van en pesos (regla FAD15 del Anexo 1.9)
Ejemplo: COP
payable_amountstring
Ejemplo: 5000.00
foreignobject
Solo si se facturó en otra moneda: moneda, tasa usada y total en esa moneda
+ Ver 3 campos− Ocultar 3 campos
- currencystring
  Ejemplo: USD
- exchange_ratestring
  Ejemplo: 4123.45
- payable_amountstring
  Ejemplo: 5000.00
statusstring
pending esperando al worker, submitted enviado y esperando a la DIAN, accepted, rejected (por la DIAN, final) y failed (se agotaron los reintentos).
Valores: pending · submitted · accepted · rejected · failed
dianobject
+ Ver 5 campos− Ocultar 5 campos
- track_idstring
- status_codestring
  Ejemplo: 00
- status_descriptionstring
- errorsarray<string>
- rulesarray<object>
  errors separados: regla, tipo (rejection rechaza el documento; notification no impide la aceptación), mensaje de la DIAN y, si factuROA la conoce, cómo corregirla
  + Ver 4 campos− Ocultar 4 campos
  - rulestring
    Ejemplo: FAJ44b
  - typestring
    Valores: rejection · notification
  - messagestring
  - hintstring
    Ejemplo: Emisor persona natural: usa document_type 13 (cédula) en vez de 31.
attemptsinteger
errorobject
Solo si factuROA rechazó el documento sin enviarlo a la DIAN (p. ej. error.plan.no_documents: se quedó en fila cuando el plan se agotó o venció con la renovación cancelada)
+ Ver 2 campos− Ocultar 2 campos
- codestring
  Ejemplo: error.plan.no_documents
- messagestring
emailobject
Correo al adquiriente con el AttachedDocument y el PDF (solo facturas y notas aceptadas, con FACTUROA_EMAIL_FROM configurado).
+ Ver 6 campos− Ocultar 6 campos
- statusstring
  abandoned: sin correo válido del adquiriente o intentos agotados (ver last_error)
  Valores: pending · sent · abandoned
- attemptsinteger
- sent_atstring · date-time
- last_errorstring
- recipientstring
  Dirección del último reenvío (si se pidió otra)
- resendsinteger
  Reenvíos pedidos (máximo 5)
created_atstring · date-time
updated_atstring · date-time

401Falta la key o es inválida, está deshabilitada, vencida o revocada (error.missing_api_key, error.invalid_api_key, error.api_key.disabled, error.api_key.expired, error.api_key.revoked)

codestring
Ejemplo: error.document.invalid
messagestring
errorsarray<object>
Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)
+ Ver 2 campos− Ocultar 2 campos
- fieldstring
  Ruta del campo en el JSON enviado
  Ejemplo: lines[0].quantity
- messagestring
  Ejemplo: Cantidad inválida: debe ser mayor que cero.
detailsarray<string>
Rutas de los campos inválidos (compatibilidad; usa errors)
request_idstring

404No existe (o es de otra cuenta)

codestring
Ejemplo: error.document.invalid
messagestring
errorsarray<object>
Solo en 400: cada campo inválido con su explicación (en español, o en inglés con Accept-Language: en)
+ Ver 2 campos− Ocultar 2 campos
- fieldstring
  Ruta del campo en el JSON enviado
  Ejemplo: lines[0].quantity
- messagestring
  Ejemplo: Cantidad inválida: debe ser mayor que cero.
detailsarray<string>
Rutas de los campos inválidos (compatibilidad; usa errors)
request_idstring