--- title: "Dar de alta a una empresa" method: POST path: "/company" tags: ["Empresas"] --- # Dar de alta a una empresa `POST /company` Este endpoint permite dar de alta empresas en la API con las configuraciones necesarias para enviar documentos a la DGII ## Request body - object - `name` string, required — Nombre/Razón social de la empresa - `tradeName` string — Nombre comercial (opcional) - `identification` string, required — Identificación de la empresa - `type` 'main' | 'associated' — Tipo de empresa - `address` string, required — Dirección de la compañía - `province` string — Provincia donde está situada la compañía - `municipality` string — Municipio donde está situada la compañía - `email` string, email — Correo electrónico de la compañía - `certificate` object, required — Objeto que contiene la información del certificado - `name` string, required — Nombre del archivo - `extension` string, required — Extensión del archivo - `content` string, byte, required — Archivo de certificado en base 64 - `password` string, required — Contraseña del certificado - `webhooks` object — Objeto que contiene la información de los webhooks configurados para la empresa. ### Notas - Para conocer de forma general como funcionan los webhooks puedes consultar la documentación en el siguiente [enlace](https://dash.readme.com/project/e-api-a-la-nube-dom/v1.0-DOM/docs/webhooks) - Estaremos enviando un POST request al webhook proporcionado por ustedes con el fin de verificar su funcionamiento. El body que pasaremos a su endpoint será: `{message: 'Test message'}`. En caso de detectar errores HTTP o de red, se lo comunicaremos en nuestra respuesta HTTP - Si aún no dispones de un webhook, puedes omitir esta configuración inicialmente y continuar con la creación de tu compañía. - La configuración de webhook se puede completar o modificar más adelante actualizando los detalles de tu compañía. - `general` object — Objeto con información de webhooks generales - `governmentStatusChanged` object — Objeto con la información para el webhook que se dispara cuando cambia el estado de la compañía ante la DGII - `url` string — Url a la cual notificará el webhook - `headers` object — Objeto con headers personalizados que serán enviados en el request al webhook configurado - `status` 'active' | 'inactive' - `documents` object — Objeto con información de webhooks relacionado con documentos - `emissionFinished` object — Objeto con la información para el webhook que se dispara cuando finaliza el proceso de un documento electrónica - `url` string, required — Url a la cual notificará el webhook - `headers` object — Objeto con headers personalizados que serán enviados en el request al webhook configurado - `status` 'active' | 'inactive' - `auth` object — Mecanismo para solicitar headers de configuración antes de enviar datos al webhook principal. ### Caso de uso Su webhook principal necesita de un token de autenticación para poder ser invocado y este mismo solamente puede ser obtenido a traves de este endpoint de autenticación. ### Notas - Se debe proveer todos los detalles necesarios para la correcta invocación, como propiedades para el body (POST), headers requeridos, etc. - Nosotros intentaremos un reenvío a sus webhooks si obtenemos alguna de los siguientes estados de respuesta del mismo: - Unauthorized errors (401 & 403) - (IMPORTANTE) Este solo aplica para el endpoint principal en caso de tener un auth-endpoint configurado. - Refrescaremos el token desde el endpoint de autenticación y reintentaremos la solicitud. - Si volvemos a obtener un 401 | 403, nos daremos por vencidos. - Server errors (5xx) - Network errors (timeout, dns, etc) - `status` 'active' | 'inactive', required - `url` string, required - `headersRequest` object — Objeto con headers personalizados que serán enviados en el request a este auth-endpoint - `body` object — Objeto con información que será enviada en el body del request a este auth-endpoint - `headersResponse` object — Configuración de los encabezados esperados en la respuesta del auth-endpoint. Se determinará qué encabezados serán utilizados para la solicitud al webhook principal - `fields` string[], required — Lista de encabezados (headers) que se emplearán en la solicitud al webhook principal. Estos encabezados serán obtenidos de la respuesta de los encabezados del auth-endpoint - `cache` object — Objeto con información de cache para el auth-endpoint - … - `cancellations` object — Objeto con la información para el webhook que se dispara cuando finaliza el proceso de anulaciones - `url` string, required — Url a la cual notificará el webhook - `headers` object — Objeto con headers personalizados que serán enviados en el request al webhook configurado - `status` 'active' | 'inactive' - `reception` object — Objeto con la información para el webhook que se dispara cuando se recibe un documento o se genera una aprobación comercial - `url` string, required — Url a la cual notificará el webhook - `headers` object — Objeto con headers personalizados que serán enviados en el request al webhook configurado - `status` 'active' | 'inactive' - `notificationByEmail` object - `enabled` boolean, required — Indica si la compañía tiene habilitada o no la notificación por mail hacia el receptor de un comprobante electrónico (cuando es aceptado por DGII). Por defecto, no se encuentra habilitada. - `message` string — Cuando la notificación por mail esté habilitada, se añadirá el mensaje configurado al final del correo enviado. No es obligatorio configurar mensaje extra alguno. - `logo` string — 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. - 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. ## Other responses - `201` — unresolved $ref - `400` — unresolved $ref - `404` — unresolved $ref - `500` — unresolved $ref --- [API](https://skmtc.net/alanube/apis/api-fe-dom.md) · [All operations](https://skmtc.net/alanube/apis/api-fe-dom/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/alanube/api-fe-dom/revisions/884e0cb47e4a/schema)