Empresa

Ver la identidad en impresos

Devuelve cómo se ve la empresa activa en sus impresos: logo, color, si se muestra el logo y el formato. Es nulo mientras no tenga ninguna.

GET/api/v1/companies/get-branding

Permiso: companies.view
Empresa: Opera sobre la empresa activa
Tipo: Lectura: no cambia nada
Respuesta: JSON

Encabezados

Cookietextorequerido
La cookie de sesión del usuario de la integración (__Secure-erp.session_token). Cuando esté la clave API, va en Authorization: Bearer. Ver Autenticación.
X-Expected-Companyuuidrequerido
La empresa sobre la que operás. Si no coincide con la de la credencial, responde 409. Ver Empresa activa.

Respuesta

200 con este JSON.

brandingobjetorequeridoadmite null
Campos (7)
- hasLogosí o norequerido
- logoTypecualquierarequerido
- logoDataUrlcualquierarequerido
- colorcualquierarequerido
- showLogosí o norequerido
- printLayoutopciónrequerido
  Valores: standard classic
- versionenterorequerido
  mínimo 1

Errores

Un rechazo responde application/problem+json con un code estable. Los más comunes en esta operación:

`401`	Falta la credencial o venció.
`403`	La credencial no tiene el permiso `companies.view`.
`409`	La empresa activa no es la de `X-Expected-Company`.
`422`	Datos inválidos o una regla de negocio rota, con el detalle por campo.
`503`	Sistema ocupado: reintentá después de `Retry-After` segundos.

La lista completa está en Errores.

curl
TypeScript

curl "$ERP_URL/api/v1/companies/get-branding" \
  -b sesion.txt \
  -H "X-Expected-Company: $ERP_EMPRESA"

const respuesta = await fetch(`${process.env.ERP_URL}/api/v1/companies/get-branding`, {
  headers: {
    Cookie: process.env.ERP_SESION!,
    "X-Expected-Company": process.env.ERP_EMPRESA!,
  },
});
if (!respuesta.ok) throw new Error((await respuesta.json()).title);
const datos = await respuesta.json();

{
  "branding": {
    "hasLogo": false,
    "logoType": null,
    "logoDataUrl": null,
    "color": null,
    "showLogo": false,
    "printLayout": "standard",
    "version": 1
  }
}