Ir al contenido

Consultar un catálogo de la DIAN

GET
/v1/catalogs/{name}
curl --request GET \
--url https://example.com/v1/catalogs/departments

Devuelve los registros de una tabla de códigos de la DIAN. Admite filtro por texto sin tildes con q y, para municipios, por código de departamento DIVIPOLA de 2 dígitos. No requiere API key.

name
required

El catálogo de la DIAN a consultar (ej. municipalities, units, taxes, tax-responsibilities)

string
Allowed values: departments municipalities units taxes tax-responsibilities id-types payment-means currencies incoterms credit-note-concepts debit-note-concepts support-adjustment-concepts pos-adjustment-concepts radian-events radian-claim-concepts due-diligence generation-forms

El nombre del catálogo

q
string
<= 100 characters

Texto sin distinción de mayúsculas ni tildes para filtrar por código o nombre (ej. “bogota”)

department
string
/^\d{2}$/

Para municipios: solo los de este código de departamento DIVIPOLA de 2 dígitos (ej. “11”)

Los registros del catálogo

Media typeapplication/json
object
data
required

Los registros del catálogo

Array<object>

Un registro de una tabla de códigos de la DIAN

object
code
required

El código que se envía en la API y se escribe en el XML de la DIAN

string
name
required

El nombre oficial del código en la DIAN, en español

string
departmentCode

Para municipios: el código DIVIPOLA de 2 dígitos de su departamento

string

Example generated

{
"data": [
{
"code": "example",
"name": "example",
"departmentCode": "example"
}
]
}

La petición no cumple el esquema (VALIDATION_ERROR, con details por campo)

Media typeapplication/json

Un error: un código estable para los programas y un mensaje para los desarrolladores

object
error
required

El error

object
code
required

Código estable (VALIDATION_ERROR, NOT_FOUND, INSUFFICIENT_BALANCE…)

string
message
required

Qué salió mal, para desarrolladores (puede cambiar; compare por code)

string
details

Datos que lo explican (el campo, el valor esperado…); en un error de esquema, los campos que fallaron y por qué

requestId

Id de la petición, para soporte

string

Example generated

{
"error": {
"code": "example",
"message": "example",
"details": "example",
"requestId": "example"
}
}

No existe (NOT_FOUND)

Media typeapplication/json

Un error: un código estable para los programas y un mensaje para los desarrolladores

object
error
required

El error

object
code
required

Código estable (VALIDATION_ERROR, NOT_FOUND, INSUFFICIENT_BALANCE…)

string
message
required

Qué salió mal, para desarrolladores (puede cambiar; compare por code)

string
details

Datos que lo explican (el campo, el valor esperado…); en un error de esquema, los campos que fallaron y por qué

requestId

Id de la petición, para soporte

string

Example generated

{
"error": {
"code": "example",
"message": "example",
"details": "example",
"requestId": "example"
}
}

Error del servicio

Media typeapplication/json

Un error: un código estable para los programas y un mensaje para los desarrolladores

object
error
required

El error

object
code
required

Código estable (VALIDATION_ERROR, NOT_FOUND, INSUFFICIENT_BALANCE…)

string
message
required

Qué salió mal, para desarrolladores (puede cambiar; compare por code)

string
details

Datos que lo explican (el campo, el valor esperado…); en un error de esquema, los campos que fallaron y por qué

requestId

Id de la petición, para soporte

string

Example generated

{
"error": {
"code": "example",
"message": "example",
"details": "example",
"requestId": "example"
}
}