API Endpoints

Actualizar la información de una empresa

patch
https://sandbox.alanube.co/dom/v1/company/

Este endpoint permite actualizar la información de la empresa enviada cómo parámetro, ten en cuenta que únicamente se actualizará la información enviada y por lo tanto no es necesario enviar toda la información de la empresa

Path Params
string
required

Id de la empresa

Body Params

Objeto JSON con la información de la empresa que se desea actualizar

string
required

Nombre/Razón social de la empresa

string
required

Nombre comercial

string
required

Identificación de la empresa

string
enum

Tipo de empresa

Allowed:
string
required
length ≤ 100

Dirección de la compañía

string
required

Provincia donde está situada la compañía

string
required

Municipio donde está situada la compañía

string
length ≤ 80

Correo electrónico de la compañía

certificate
object
required

Objeto que contiene la información 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
  • 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.
notificationByEmail
object
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.
  • 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.
Responses

Updated 7 months ago

Language
Credentials
Bearer
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago