Ir al contenido

Configurar software DIAN (SoftwareID, PIN, TestSetId)

PUT
/v1/tenant/software/{family}
curl --request PUT \
--url https://example.com/v1/tenant/software/invoicing \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "softwareId": "example", "pin": "example", "environment": "1", "testSetId": "example", "enablementMode": true, "providerNit": "example", "providerDv": "example" }'
family
required

Familia de documentos: invoicing (facturas y notas), support_document (documentos soporte y sus ajustes), payroll (nómina), pos, radian (eventos)

string
Allowed values: invoicing support_document payroll pos radian

Familia de documentos que emite el software

X-Tenant-Id
string

Id o NIT del facturador. Obligatorio con llaves de cuenta; ignorado con llaves restringidas.

Media typeapplication/json

Software de un facturador habilitado en la DIAN para una familia de documentos

object
softwareId
required

Id del software, tal como lo muestra el portal de habilitación de la DIAN

string
>= 1 characters <= 100 characters
pin
required

PIN del software, elegido al registrarlo; entra en el CUDE, el CUNE y el código de seguridad

string
>= 1 characters <= 100 characters
environment

A dónde van sus documentos: 1 = producción, 2 = habilitación (pruebas; por defecto)

string
default: 2
Allowed values: 1 2
testSetId

Id del set de pruebas (TestSetId), del portal de habilitación

string
<= 100 characters
enablementMode

Si el facturador está enviando su set de pruebas: con un testSetId, los documentos van por SendTestSetAsync (asíncrono) en vez del envío síncrono. true por defecto; páselo a false cuando quede habilitado

boolean
default: true
providerNit

NIT del proveedor del software, si se registró a través de uno; el NIT del propio facturador si no se envía

string
<= 20 characters
providerDv

Dígito de verificación del NIT del proveedor

string
<= 1 characters

Software guardado

Media typeapplication/json
object
data
required

Software guardado

object
tenantId
required

Id del facturador

string
family
required

Familia de documentos que emite

string
Allowed values: invoicing support_document payroll pos radian
softwareId
required

Id del software en la DIAN

string
pin
required

Nunca se muestra: siempre *****. Para cambiarlo, envíelo de nuevo con PUT

string
environment
required

Ambiente DIAN: 1 = producción, 2 = habilitación (pruebas)

string
Allowed values: 1 2
testSetId

Id del set de pruebas (TestSetId)

string
enablementMode
required

Si los documentos se envían al set de pruebas (SendTestSetAsync)

boolean
providerNit

NIT del proveedor del software, cuando no es el facturador

string
providerDv

Dígito de verificación del NIT del proveedor

string

Example

{
"data": {
"family": "invoicing",
"environment": "1"
}
}

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"
}
}

Falta la credencial o no es válida (UNAUTHORIZED)

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"
}
}

La llave no puede hacer esto (FORBIDDEN)

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, o no es de esta cuenta (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"
}
}

Conflicto con el estado actual (CONFLICT, INVALID_STATE)

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"
}
}

Regla de negocio (VALIDATION_ERROR, NUMBERING_*, CERTIFICATE_UNAVAILABLE…)

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"
}
}

Demasiadas peticiones para esta cuenta (RATE_LIMITED; vea X-RateLimit-* y Retry-After)

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 o de la DIAN (DIAN_UNAVAILABLE, DIAN_PROTOCOL_ERROR)

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"
}
}