Cuenta y acceso

Cuenta

La cuenta que hizo la petición, su clave y sus límites de uso.

Esquemas: AccountDto

{
  "name": "Example",
  "timezone": "string",
  "currency": "EUR",
  "country": "ES",
  "language": "es-ES",
  "addons": [
    "platform"
  ],
  "trial": {
    "active": true,
    "endsAt": "2026-09-01T08:00:00Z"
  },
  "apiKey": {
    "id": "id_8f2a1c",
    "name": "Example",
    "scopes": [
      "string"
    ]
  },
  "rateLimits": {
    "global": {
      "perMinute": 1
    },
    "availability": {
      "perMinute": 1
    }
  },
  "api": {
    "version": "string",
    "docsUrl": "https://example.com"
  }
}

Generado a partir del esquema

La cuenta que hizo la petición: su nombre, zona horaria, moneda, país e idioma, los add-ons que tiene, si está en periodo de prueba, la clave de API que hizo la llamada con sus permisos (scopes), los límites de uso y la versión del contrato. Es de solo lectura y es la primera llamada de cualquier integración, porque te dice cómo leer fechas e importes y qué recursos responden 402. Léela con GET /api/v1/account.

Atributos

namestring

Nombre de la cuenta.

timezonestring

Zona horaria IANA del negocio, aquella en la que se leen las fechas sin hora de los filtros.

currencystring

Moneda de la cuenta en ISO 4217; los documentos pueden llevar la suya.

countrystring

País del negocio en ISO 3166-1 alpha-2.

languagestring

Idioma por defecto de los mensajes de error de esta clave (BCP 47), salvo que Accept-Language indique otro.

addonsstring[]

Ids de los add-ons a los que la cuenta tiene acceso hoy. Un recurso tras un add-on que no figura aquí responde 402.

Opciones disponibles: platform, user-seat, connected-account, extra-tax-cif, qr-codes, incidence, purchases, activity-log, custom-fields, profitability, web-builder, crm, consignments, email-calendar, sales-documents, internal-bookings, internal-communication, advanced-user-permissions, ai-pack-25k, ai-pack-55k, ai-pack-115k

trialobject

Periodo de prueba de la cuenta.

Mostrar atributos hijos

trial.activeboolean

true mientras dura el periodo de prueba de la cuenta: todos los add-ons están desbloqueados.

trial.endsAtstring<date-time> | null

Fin de la prueba en ISO 8601 UTC; null si no hay.

apiKeyobject

La clave que hizo la petición. Nunca su secreto.

Mostrar atributos hijos

apiKey.idstring

Identificador de la clave de API que hizo la petición.

apiKey.namestring

Nombre dado a la clave cuando se creó.

apiKey.scopesstring[]

Scopes concedidos a la clave, los que pueden usar sus peticiones.

rateLimitsobject

Límites de uso de la clave, los que informan las cabeceras RateLimit-*.

Mostrar atributos hijos

rateLimits.globalobject

Peticiones por minuto en toda la API.

Mostrar atributos hijos

rateLimits.global.perMinuteinteger

rateLimits.availabilityobject

Peticiones por minuto de las consultas de disponibilidad, contadas aparte.

Mostrar atributos hijos

rateLimits.availability.perMinuteinteger

apiobject

El contrato con el que se sirve a esta cuenta.

Mostrar atributos hijos

api.versionstring

Versión del contrato de la API pública.

api.docsUrlstring

Dónde está la documentación de esta versión.

Valores

addons: platform, user-seat, connected-account, extra-tax-cif, qr-codes, incidence, purchases, activity-log, custom-fields, profitability, web-builder, crm, consignments, email-calendar, sales-documents, internal-bookings, internal-communication, advanced-user-permissions, ai-pack-25k, ai-pack-55k, ai-pack-115k

Lo devuelven

GET /api/v1/account — Obtener la cuenta

Lo modifican

Ninguna operación.

¿Te ha resultado útil esta página?

Ejemplo

Atributos

Valores

Lo devuelven

Lo modifican