Negocio

Consultar la certificación del negocio

GET

/v1/business/certification

const url = 'https://api.timbro.do/v1/business/certification';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

curl --request GET \
  --url https://api.timbro.do/v1/business/certification \
  --header 'Authorization: Bearer <token>'

Devuelve la ruta de certificación DGII del negocio autenticado, sus requisitos previos, el paso DGII declarado, los 15 pasos oficiales con la fuente de cada estado, los resultados informados y lo que necesita el paso actual. Un paso informado o declarado nunca queda verificado ni da acceso al modo en vivo.

Autenticación

secretKey
adminKey

Respuestas

200

Preparación de la certificación y avance ante la DGII que informó el negocio autenticado. Nada de esto da acceso al modo en vivo.

application/json

Campos y códigos de la respuesta

discriminator: status

BusinessCertificationNotStarted
BusinessCertificationInProgress

object

object

obligatorio

string

Valor permitido: business_certification

status

obligatorio

string

Valor permitido: not_started

requirements

obligatorio

Array<object>

Lo que falta, quién lo resuelve y qué pasos esperan por eso. Desde el paso 12, Timbro recibe en producción los documentos del negocio; un requisito production_reception_* detiene el paso 12 hasta que eso ocurra. Volver a informar o declarar el paso 12 lo intenta de nuevo cuando lo hace una persona propietaria o una clave de administrador; si el requisito está a cargo del equipo de Timbro, espera a que el equipo lo resuelva.

object

code

obligatorio

Cualquiera de:

string

Valor permitido: invoices_not_requested

owner

obligatorio

Cualquiera de:

string

Valor permitido: merchant

blocks

obligatorio

Array

<= 4 items

field

string

availablePaths

obligatorio

Array

>= 1 items

recommendedPath

obligatorio

Cualquiera de:

string
string

string

Valor permitido: own_software

actions

obligatorio

Array

<= 1 items

object

object

obligatorio

string

Valor permitido: business_certification

obligatorio

string

/^cert_[a-z0-9]{24,}$/

revision

obligatorio

integer

>= 1

status

obligatorio

string

Valor permitido: in_progress

path

obligatorio

Cualquiera de:

string
string

string

Valor permitido: own_software

software

obligatorio

object

name

obligatorio

string

>= 1 characters <= 128 characters

version

obligatorio

string

>= 1 characters <= 64 characters

dgiiProvider

obligatorio

Cualquiera de:

object
null

object

rnc

obligatorio

string

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

name

obligatorio

string

>= 1 characters <= 128 characters

phase

obligatorio

Cualquiera de:

string

Valor permitido: preparation

receiver

obligatorio

La única dirección por la que la DGII y otros emisores llegan al negocio, en certificación y en producción.

object

host

obligatorio

La dirección de recepción de Timbro, tal como la piden las casillas de la DGII, por ejemplo ecf.timbro.do. El negocio la escribe en Recepción, Aprobación comercial y Autenticación, en la postulación y en los pasos 7 y 12.

string

>= 1 characters

requirements

obligatorio

Array<object>

object

code

obligatorio

Cualquiera de:

string

Valor permitido: invoices_not_requested

owner

obligatorio

Cualquiera de:

string

Valor permitido: merchant

blocks

obligatorio

Array

<= 4 items

field

string

actions

obligatorio

Lo que puede hacer quien llama ahora. start_production_reception aparece cuando informar el paso 12 puede pedirle a Timbro que reciba en producción los documentos del negocio: para una persona propietaria o una clave de administrador, porque eso crea el vínculo de producción. sign_portal_document aparece solo cuando el Timbro de este despliegue firma documentos del portal de la DGII, existe el vínculo de certificación y quien llama confirma por sí mismo: una persona o una clave de administrador, no un agente. run_test_set aparece en las mismas condiciones cuando el Timbro de este despliegue ejecuta archivos de pruebas de certificación.

Array

progress

obligatorio

Cualquiera de:

BusinessCertificationProgress
null

Último paso DGII que declaró el negocio. Los pasos anteriores se dan por completados para que la secuencia avance, y quedan como informados por el negocio. Una declaración nunca verifica un paso ni da acceso al modo en vivo.

object

dgiiStep

obligatorio

Cualquiera de:

number

Valor permitido: 1

postulationSoftware

obligatorio

Cualquiera de:

object
null

Programa que el negocio indicó en su postulación ante la DGII. name solo se acepta cuando kind es other.

object

kind

obligatorio

Cualquiera de:

string

Valor permitido: timbro

name

string

>= 1 characters <= 80 characters /^[^\p{C}]*$/

reportedAt

obligatorio

string format: date-time

entryKit

obligatorio

Array<object>

<= 5 items

Algo que el paso actual necesita del negocio, con la acción que lo completa. service_urls_in_dgii pide escribir la dirección de recepción en las casillas de la DGII en el paso 1, desde el paso 7 y desde el paso 12, y queda en done solo después de que el negocio informe ese paso desde Timbro. postulation_provider pide al negocio con la ruta external_software escribir en su postulación a INDEXA SRL como proveedor de servicios de facturación electrónica.

object

code

obligatorio

Cualquiera de:

string

Valor permitido: signing_certificate

state

obligatorio

Cualquiera de:

string

Valor permitido: done

action

obligatorio

Cualquiera de:

unknown
null

Cualquiera de:

string

Valor permitido: import_certificate

steps

obligatorio

Array<object>

>= 15 items <= 15 items

Un paso oficial de la DGII. basis indica de dónde viene su estado: declared_progress para un paso anterior al paso DGII declarado, business_report para un resultado informado y null cuando no hay nada registrado.

object

number

obligatorio

Cualquiera de:

number

Valor permitido: 1

code

obligatorio

string

>= 1 characters

title

obligatorio

string

>= 1 characters

actor

obligatorio

Cualquiera de:

string

Valor permitido: merchant

status

obligatorio

Cualquiera de:

string

Valor permitido: blocked

basis

obligatorio

Cualquiera de:

unknown
null

Cualquiera de:

string

Valor permitido: timbro_executed

evidence

obligatorio

Array<object>

Resultado DGII informado por el negocio. Queda como informado: solo una respuesta de la DGII que Timbro reciba puede verificar un paso.

object

obligatorio

string

>= 1 characters

outcome

obligatorio

Cualquiera de:

string

Valor permitido: submitted

verification

obligatorio

Cualquiera de:

string

string

Valor permitido: user_reported

reference

obligatorio

Cualquiera de:

string
null

string

<= 255 characters

createdAt

obligatorio

string format: date-time

Cabeceras

request-id

obligatorio

string

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

400

No se pudo entender la solicitud.

application/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

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

application/problem+json

Ejemplo

{
  "type": "about:blank",
  "title": "La credencial falta, tiene un formato incorrecto o ya no es válida.",
  "status": 401,
  "code": "person_session_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: person_session_missing 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>

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

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

application/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>

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

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

application/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": "business_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: business_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>

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

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

application/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

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>

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.