Consultar un catálogo

GET

/catalogos/{id}

curl --request GET \
  --url https://openfactura.co/api/v1/catalogos/example \
  --header 'Authorization: Bearer <token>'

• Open Factura en la nube

CAT-012 departamentos, CAT-013 municipios (filtre con departamento), CAT-008 distritos, CAT-019 actividades económicas (50 por defecto; use q), CAT-014 unidades, CAT-017 formas de pago, CAT-022 documentos.

Authorizations

• claveApi
• sesion

Parameters

Path Parameters

id

required

string

Identificador del recurso.

Query Parameters

q

string

<= 100 characters

departamento

string

<= 2 characters

limite

integer

>= 1 <= 2000

Responses

200

Valores del catálogo.

Media typeapplication/json

object

id

string

nombre

string

total

integer

valores

Array<object>

object

codigo

required

string

valor

required

string

departamento

string

Example ^generated

{
  "id": "example",
  "nombre": "example",
  "total": 1,
  "valores": [
    {
      "codigo": "example",
      "valor": "example",
      "departamento": "example"
    }
  ]
}

Headers

RateLimit-Limit

integer

Peticiones permitidas por minuto (sólo con clave de API).

RateLimit-Remaining

integer

Peticiones restantes en la ventana actual (sólo con clave de API).

RateLimit-Reset

integer

Segundos hasta que se reinicia la ventana (sólo con clave de API).

Idempotent-Replayed

string

Allowed values: true

true cuando la respuesta es la guardada de un intento anterior.

400

Cuerpo o parámetros inválidos (details = [{ ruta, mensaje }]), o el DTE no cumple el esquema del MH (details.problemas). Códigos: datos_invalidos, dte_invalido.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta

message

required

string

details

Detalle según el código; puede faltar.

Example

{
  "error": {
    "code": "datos_invalidos"
  }
}

401

Falta sesión, o la clave de API no es válida, fue revocada o expiró. Códigos: no_autenticado.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta

message

required

string

details

Detalle según el código; puede faltar.

Example

{
  "error": {
    "code": "datos_invalidos"
  }
}

403

Falta un permiso (details.permiso) o el origen de la petición con cookie no está permitido. Códigos: sin_permiso, origen_no_permitido.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta

message

required

string

details

Detalle según el código; puede faltar.

Example

{
  "error": {
    "code": "datos_invalidos"
  }
}

404

El recurso no existe en esta organización. Códigos: no_encontrado.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta

message

required

string

details

Detalle según el código; puede faltar.

Example

{
  "error": {
    "code": "datos_invalidos"
  }
}

429

Límite de peticiones excedido; Retry-After indica cuántos segundos esperar. Códigos: limite_excedido.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: datos_invalidos dte_invalido no_autenticado sin_permiso origen_no_permitido no_encontrado sin_organizacion sin_organizacion_activa nit_bloqueado emisor_no_configurado credenciales_incompletas sin_punto_venta estado_invalido ambiente_distinto retorno_excedido retorno_vigente idempotencia_distinta idempotencia_en_curso cliente_repetido producto_repetido codigo_repetido sin_archivo limite_webhooks simulador_inactivo dte_rechazado invalidacion_rechazada contingencia_rechazada evento_rechazado limite_excedido error_interno mh_credenciales_rechazadas mh_no_disponible emision_fallida emision_incierta

message

required

string

details

Detalle según el código; puede faltar.

Example

{
  "error": {
    "code": "datos_invalidos"
  }
}

Headers

Retry-After

integer

Segundos que hay que esperar.