Endpoint para dar de alta a una empresa

post https://sandbox-api.alegra.com/e-provider/col/v1/companies

Este endpoint permite dar de alta empresas en la API con las configuraciones necesarias para enviar documentos a la DIAN

Body Params

Objeto JSON con la información de la empresa

name

string

required

length between 5 and 450

Nombre/Razón Social de la empresa

tradeName

string

length between 1 and 450

Nombre Comercial de la empresa

identification

string

required

length between 3 and 30

Identificación de la empresa

string

required

length ≥ 1

Dígito verificador de la identificación de la empresa

type

string

Tipo de empresa

useAlegraCertificate

boolean

required

Indica si se desea usar el certificado de Alegra o no

certificate

object

Objeto que contiene la información del certificado, obligatorio únicamente si el atributo useAlegraCertificate es false

notificationByEmail

object

webhooks

object

Objeto que contiene la información de los webhooks configurados para la empresa. En caso de querer actualizar un webhook, se debe enviar el objeto completo con los webhooks que se desean mantener y los que se desean eliminar

organizationType

number

Tipo de organización jurídica de la empresa. Se debe colocar el Código que corresponda de la tabla de tipo de organización jurídica de la DIAN

identificationType

string

length ≤ 2

Tipo de documento de identificación de la empresa. Se debe colocar el Código que corresponda de la tabla de tipos de identificación de la DIAN

regimeCode

string

Régimen al que pertenece la empresa. Se debe colocar el Código que corresponda de la tabla de tipos de responsabilidad fiscal de la DIAN. Para reportar varias obligaciones / responsabilidades, se deben reportar separando cada uno de los valores de la lista con ';'. Ejemplo O‐13;O‐15;

taxCode

object

Objeto que contiene el grupo de detalles tributarios del Emisor

economicActivities

array of strings

length ≥ 1

Lista de actividades económicas de la empresa.
Debe informar el código según lista CIIU

economicActivities

string

Correo electrónico de la empresa registrado en la DIAN para la recepción de documentos

phone

string

Número de teléfono, celular u otro

address

object

Objeto que contiene la información relacionada a la dirección.
Grupo de información oficial DIAN <RegistrationAddress | PhysicalLocation>

logo

string

length ≥ 1

Imagen del logo en base64 a incluir en todos los documentos PDF

Consideraciones

El tamaño máximo de la imagen es de 150 KB (aproximadamente 150,000 caracteres en base64).
La validación final del tamaño se realizará en el servidor después de decodificar la imagen.
Si un documento es creado con un logo, este siempre mostrará ese logo. Si el logo es actualizado posteriormente, los documentos creados anteriormente no serán actualizados para mostrar el nuevo logo. Por lo tanto, se recomienda crear documentos con un logo solo después de haber cargado y establecido el logo final.

otherResponsabilities

string

length between 0 and 193

Texto que permite incluir información adicional sobre las responsabilidades fiscales o de otro tipo que la empresa desee reflejar en los documentos emitidos. Esta información se incluirá tanto en el XML como en el PDF de los documentos generados

200

Objeto que representa la respuesta que contiene la información de una empresa

Response body

object

company

object

string

Id de la empresa

name

string

required

Nombre/Razón Social de la empresa

tradeName

string

Nombre Comercial de la empresa

identification

string

required

Identificación de la empresa

string

required

Dígito verificador de la identificación de la empresa

useAlegraCertificate

boolean

required

True si deseas usar el certificado de Alegra

governmentStatus

object

Objeto que contiene la información de los estados de la compañía ante la DIAN para cada uno de los documentos electrónicos

certificate

object

Objeto que contiene la información del certificado, obligatorio únicamente si el atributo useAlegraCertificate es false

notificationByEmail

object

webhooks

object

Objeto que contiene la información de los webhooks configurados para la empresa

organizationType

number

Identificador de tipo de organización jurídica de la persona o empresa. Se debe colocar el Código que corresponda de la tabla de tipos de organización jurídica de la DIAN.
Campo oficial DIAN <AdditionalAccountID>

identificationType

string

length ≤ 2

Tipo de documento de identificación de la empresa. Se debe colocar el Código que corresponda de la tabla de tipos de identificación de la DIAN

regimeCode

string

Régimen al que pertenece la empresa. Se debe colocar el Código que corresponda de la tabla de tipos de régimen/responsabilidades fiscales de la DIAN. Para reportar varias obligaciones / responsabilidades, se deben reportar separando cada uno de los valores de la lista con ';'. Ejemplo O‐13;O‐15;

taxCode

object

Objeto que contiene el grupo de detalles tributarios del Emisor

string

Correo electrónico de la empresa. Se debe colocar el correo de recepción para documentos e instrumentos electrónicos

phone

string

Número de teléfono, celular u otro

address

object

Objeto que contiene la información relacionada a la dirección.
Grupo de información oficial DIAN <RegistrationAddress | PhysicalLocation>

xxxxxxxxxx
curl --request POST \
     --url https://sandbox-api.alegra.com/e-provider/col/v1/companies \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "useAlegraCertificate": true,
  "notificationByEmail": {
    "enabled": true
  }
}
'

Consideraciones

200Objeto que representa la respuesta que contiene la información de una empresa

400Objeto que representa una respuesta de error por validaciones

404Objeto que representa una respuesta de error por qué no se ha encontrado el recurso al que se intenta acceder

500Objeto que representa una respuesta de error por qué ha ocurrido un error interno en el sistema