> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stockshift.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Muestra el resumen de facturación
> El plan de la organización, las ejecuciones de automatización usadas este mes, una página de
registros de uso diario, su suscripción de Stripe, su método de pago y su
contacto de facturación. Los registros de uso llegan en grupos de 5, del más nuevo al más antiguo; pasa
`usage_records_next_cursor` como `after` para obtener la página siguiente. Requiere el
permiso `billing.overview.view` y un token con `billing:read`.
## OpenAPI
````yaml /openapi.es.json get /billing/overview
openapi: 3.1.2
info:
title: StockShift API
version: 1.0.0
description: >-
La API REST de StockShift. Empieza con las guías de autenticación, alcances,
paginación, errores y webhooks.
servers:
- url: https://app.stockshift.io/api/v1
description: Producción
- url: https://app.beta.stockshift.io/api/v1
description: Beta
security:
- apiKey: []
- oauth2: []
tags:
- name: Acciones de existencias con testigo
description: >-
Retiene una acción de existencias para una segunda persona, que recuenta a
ciegas y firma, y lee ambas firmas. Las existencias solo cambian cuando el
testigo firma.
- name: Existencias del artículo
description: >-
Todo sobre las existencias de un artículo: dónde están, qué está
prometido, cómo se rastrean y cuánto cuestan.
- name: Transferencias
description: >-
Mueve existencias de una ubicación a otra, con tiempo en tránsito entre el
envío y la recepción.
- name: Costos de importación
description: >-
Agrega flete, aranceles y otros cargos al costo de las existencias que
recibiste.
- name: Conteos de existencias
description: >-
Cuenta lo que hay en el estante, compáralo con lo que StockShift espera y
contabiliza la diferencia cuando alguien la apruebe.
- name: Ubicaciones
description: >-
Los almacenes, salas y contenedores donde se guardan las existencias. La
mayoría de las llamadas de existencias necesitan un ID de ubicación de
aquí.
- name: Periodos
description: >-
Cierra cada mes una vez informado: bloquea lo que tiene fecha en él,
comprueba que no quede nada abierto y conserva el valor de las existencias
al final.
- name: Importaciones de inventario
description: >-
Carga las existencias iniciales desde un archivo CSV, con una vista previa
antes de contabilizar nada.
- name: Solicitudes de liberación
description: >-
Pide a Calidad que libere existencias retenidas, y rechaza o retira la
solicitud. Liberar las existencias la cierra.
- name: Firmantes
description: >-
Quién puede firmar acciones de existencias con testigo: de quién se
verificó la identidad, cómo y cuándo, y las firmas fallidas que deben ver
los revisores.
- name: Existencias
description: >-
Cuánto hay de cada artículo y dónde. Consulta los niveles, ahora o en una
fecha pasada, y contabiliza ajustes cuando se encuentren, pierdan o dañen
existencias.
- name: Reglas de testigo
description: >-
Qué acciones de existencias esperan a que una segunda persona vuelva a
contar y firme, como retirar una sustancia controlada.
- name: Reglas de asignación
description: >-
Qué lotes se toman primero cuando se reservan o se envían existencias,
como primero en caducar, primero en salir.
- name: Configuración de inventario
description: >-
Cómo maneja la organización las existencias, por ejemplo si pueden quedar
en negativo y cómo se costean.
- name: Lotes
description: Lotes de existencias que comparten un número de lote, y cuándo vencen.
- name: Movimientos
description: >-
El libro detrás de cada nivel de existencias. Los movimientos nunca se
editan; se corrigen revirtiéndolos.
- name: Números de serie
description: Unidades con seguimiento individual y dónde está cada una ahora.
- name: Movimientos de existencias
description: >-
Mueve existencias de una ubicación a otra en un solo paso, por ejemplo de
un muelle a un estante, y deshaz un movimiento completo.
- name: Vistas previas masivas
description: >-
Revisa una lista de líneas de existencias antes de un movimiento masivo,
un ajuste, una retención o una impresión, y ve qué debe decidirse en cada
línea.
- name: Artículos
description: >-
Los productos y materiales que almacenas, compras, fabricas o vendes. El
ID o el SKU de un artículo es lo que piden la mayoría de los demás
endpoints.
- name: Familias
description: >-
Grupos de artículos que solo se diferencian por opciones como la talla o
el color, y las variantes que se hacen con ellos.
- name: Importaciones de catálogo
description: >-
Crea o actualiza artículos desde un archivo CSV, con una vista previa
antes de guardar nada.
- name: Campos personalizados
description: >-
Campos adicionales que la organización agrega a sus artículos. Defínelos
aquí y luego asigna sus valores en cada artículo.
- name: Biblioteca de productos
description: >-
Busca un producto por su GTIN y crea un artículo con lo que la biblioteca
sabe de él.
- name: Unidades
description: >-
Unidades de medida, como each, box o kg. Los artículos se cuentan en una
unidad base y se convierten desde las demás.
- name: Escaneo
description: >-
Convierte un código de barras escaneado en el artículo, la unidad o la
pieza etiquetada que identifica.
- name: Proveedores
description: >-
Las empresas a las que compras, las personas con las que tratas allí y lo
que te cobran.
- name: Órdenes de compra
description: >-
Órdenes a proveedores. Crea un borrador, apruébalo, envíalo y recibe la
mercancía contra él.
- name: Importaciones de compras
description: Carga proveedores y sus catálogos desde archivos CSV.
- name: Configuración de compras
description: >-
Cómo compra la organización, por ejemplo el umbral de aprobación y cuánto
puede superar una recepción a la orden.
- name: Recepciones
description: >-
Mercancía recibida contra órdenes de compra. Revierte una recepción para
corregirla o imprime etiquetas de lo que llegó.
- name: Proveedores del artículo
description: Qué proveedores venden un artículo, y a qué precio.
- name: Exportaciones de compras
description: >-
Descarga proveedores o sus catálogos como CSV, en las mismas columnas que
lee la importación.
- name: Pedidos de venta
description: >-
Pedidos de clientes. Toma uno como borrador, confírmalo para reservar
existencias, luego envíalo y factúralo.
- name: Clientes
description: Las empresas a las que vendes y las personas con las que tratas allí.
- name: Facturas
description: Facturas de lo que has vendido y los pagos registrados contra ellas.
- name: Listas de precios
description: >-
Los precios que paga un cliente, con escalas por cantidad. Asígnale una
lista de precios a un cliente y sus pedidos se calculan solos.
- name: Cotizaciones
description: >-
Ofertas a clientes. Una cotización aceptada se convierte en un pedido de
venta.
- name: Tasas de impuestos
description: Las tasas de impuesto sobre las ventas con las que se cobran las facturas.
- name: Importaciones de ventas
description: Carga clientes y listas de precios desde archivos CSV.
- name: Devoluciones
description: >-
Mercancía que los clientes devuelven: autoriza la devolución, luego
recíbela en las existencias y acredítala.
- name: Envíos
description: Lo que salió del edificio por cada pedido de venta.
- name: Configuración de ventas
description: >-
Cómo vende la organización, por ejemplo cuándo se reservan las existencias
y si las facturas pueden salir antes del envío.
- name: Certificados de conformidad
description: >-
Certificados firmados de que los productos de un envío cumplen con el
pedido, conservados exactamente como se firmaron.
- name: Precios
description: >-
Consulta cuánto pagaría un cliente por una cantidad de un artículo antes
de ponerlo en un pedido.
- name: Exportaciones de ventas
description: >-
Descarga clientes y listas de precios como CSV, en las mismas columnas que
lee la importación.
- name: Órdenes de fabricación
description: >-
Órdenes para fabricar algo. Libera una orden de fabricación al piso,
consume sus piezas y complétala hacia las existencias.
- name: Reparaciones
description: >-
Reparaciones de unidades que los clientes devuelven: revisa la garantía,
registra las piezas puestas y retiradas, y luego completa la reparación o
factúrala.
- name: Rutas
description: >-
Los pasos por los que pasa una orden de fabricación y el centro de trabajo
en el que se ejecuta cada paso.
- name: Centros de trabajo
description: Las máquinas, celdas o equipos donde se hacen los pasos de una ruta.
- name: Plazos de garantía
description: >-
Cuánto tiempo un artículo está en garantía y si cuenta desde el envío o la
fabricación, con condiciones propias para algunos clientes.
- name: Trazabilidad
description: >-
Rastrea un lote o número de serie hacia atrás hasta lo que entró en él, o
hacia adelante hasta aquello en lo que entró.
- name: Configuración de fabricación
description: >-
Cómo fabrica la organización, por ejemplo si las operaciones pueden
superponerse y el estado en el que entran los productos terminados.
- name: Programación
description: Planifica las órdenes de fabricación abiertas en días hábiles.
- name: Variaciones de costo
description: >-
Dónde una orden de fabricación completada costó más o menos que su costo
estándar.
- name: BOM
description: >-
Listas de materiales: las piezas y cantidades que forman un artículo,
guardadas como revisiones.
- name: Cambios de ingeniería
description: >-
Órdenes de cambio que proponen revisiones nuevas de BOM y las liberan una
vez aprobadas.
- name: Importaciones de ingeniería
description: Carga listas de materiales desde un archivo CSV o una exportación de CAD.
- name: Configuración de Ingeniería
description: >-
Cómo gestiona la organización los cambios de ingeniería, por ejemplo
cuántas aprobaciones necesita una orden de cambio.
- name: Exportaciones de ingeniería
description: >-
Descarga listas de materiales como CSV, en las mismas columnas que lee la
importación.
- name: Dónde se usa
description: >-
Encuentra todas las BOM en las que aparece un artículo, antes de cambiarlo
o retirarlo.
- name: Planes de inspección
description: >-
Qué revisar, en qué artículos y cuántos: las características, el muestreo
y el punto de inspección de cada plan.
- name: Inspecciones
description: >-
Inspecciones abiertas por recepciones, operaciones y órdenes de
fabricación. Registra sus resultados para aprobar o rechazar las
existencias que retienen.
- name: Pronósticos
description: >-
La demanda esperada de cada artículo, semana por semana, y los cambios que
hacen los planificadores.
- name: Escenarios
description: Copias del pronóstico para probar cambios sin tocar el plan real.
- name: Demanda
description: >-
Demanda pasada de un artículo en una ubicación, a partir de la cual se
construyen los pronósticos.
- name: Sugerencias
description: >-
Lo que el plan dice que se compre o se fabrique. Acepta uno para generar
la orden de compra o la orden de fabricación, o descártalo.
- name: Reabastecimiento
description: >-
Cómo se mantiene cada artículo en existencias en cada ubicación: puntos de
reorden, mínimos y máximos o revisión periódica.
- name: Días festivos
description: >-
Días en que la organización no trabaja, que el plan omite al contar plazos
de entrega.
- name: Configuración de planificación
description: >-
Cómo planifica la organización, por ejemplo el horizonte del pronóstico y
el nivel de servicio.
- name: Automatizaciones
description: >-
Reglas que ejecutan pasos cuando ocurre algo o según una programación.
Edita el borrador y luego publícalo para activarla.
- name: Ejecuciones
description: >-
Cada vez que se ejecutó una automatización: qué la inició, qué hizo cada
paso y dónde falló.
- name: Aprobaciones
description: >-
Ejecuciones en pausa a la espera de que una persona las apruebe o rechace
antes de continuar.
- name: Configuración de automatización
description: >-
Límites de toda la organización para las automatizaciones, como las
ejecuciones por minuto y si alguien puede aprobar su propia ejecución.
- name: Plantillas de automatización
description: Automatizaciones prediseñadas para empezar.
- name: Eventos
description: >-
Los eventos que pueden activar una automatización y los datos que lleva
cada uno.
- name: Catálogo de pasos
description: >-
Todos los pasos que puede usar una automatización y las entradas que toma
cada uno.
- name: Vistas
description: >-
Reportes guardados: el conjunto de datos, los filtros, la agrupación y el
gráfico que alguien configuró, listos para ejecutarse de nuevo.
- name: Paneles
description: Páginas de gráficos y KPI dispuestos en una cuadrícula.
- name: Conjuntos de datos
description: >-
Los datos sobre los que puedes reportar y los campos de cada uno. Empieza
aquí para crear un reporte.
- name: Programaciones
description: >-
Envía un reporte por correo electrónico según una programación, o avisa a
alguien cuando un valor cruza un umbral.
- name: KPI
description: >-
Cifras individuales que vale la pena vigilar, definidas como una fórmula
sobre un conjunto de datos.
- name: Panel
description: >-
Las cifras de la pantalla de inicio de la app, por si quieres mostrar los
mismos números en otro lugar.
- name: Carpetas de vistas
description: Carpetas que mantienen organizadas las vistas guardadas.
- name: Exportaciones de Insights
description: >-
Exporta un informe a un archivo. Las exportaciones grandes se ejecutan en
segundo plano y están listas para descargar más tarde.
- name: Plantillas de reportes
description: >-
Reportes prediseñados, como el envejecimiento de existencias, para empezar
una vista.
- name: Reportes
description: >-
Ejecuta la definición de un reporte y obtén sus filas o su gráfico, sin
guardarla antes.
- name: Plantillas de panel
description: Paneles prediseñados para empezar.
- name: Fórmulas
description: >-
Comprueba una fórmula contra un conjunto de datos antes de guardarla en un
KPI o en un campo calculado.
- name: Conexiones
description: >-
Cuentas conectadas en otros sistemas, qué sincroniza cada una y el
historial de sus ejecuciones de sincronización.
- name: Envío
description: >-
Tarifas de transportistas, las etiquetas compradas para pedidos y
devoluciones, y los escaneos que rastrean cada paquete.
- name: Migraciones
description: >-
Trae registros de otro sistema: prepara archivos o una extracción, asigna
las columnas, revisa las filas, confírmalas y deshaz la confirmación.
- name: Abastecimiento
description: >-
Precios y existencias de piezas de distribuidores: busca en un
distribuidor conectado, vincula artículos con sus piezas y calcula el
precio de una revisión de BOM.
- name: CAD
description: >-
Ensambles de CAD y PLM: lista los ensambles de una herramienta conectada y
vigila aquellos cuyas liberaciones se convierten en importaciones de BOM.
- name: Exportación de datos
description: >-
Todo lo que guarda la organización en un solo ZIP de archivos CSV y de
líneas JSON, para que el propietario lo descargue.
- name: Direcciones fiscales
description: >-
Las direcciones por las que un servicio de impuestos conectado calcula el
impuesto de cada venta, comprobadas con él.
- name: Conectores
description: >-
Los sistemas a los que puede conectarse StockShift y lo que puede
sincronizar cada conector.
- name: Conjuntos de etiquetas
description: >-
Todos los lotes de etiquetas impresos, para que puedas encontrar uno de
nuevo y reimprimirlo.
- name: Plantillas de etiquetas
description: Los diseños con que se imprimen las etiquetas.
- name: Piezas
description: >-
Busca una pieza etiquetada a partir del código de su etiqueta: el
artículo, el lote o la serie y cuánto contiene.
- name: Marca y plantillas
description: >-
El logotipo, los colores, los términos y los campos personalizados con que
se imprime cada cotización, orden de compra, factura y lista de empaque.
- name: Apps móviles
description: >-
Cómo las apps móviles de StockShift registran un dispositivo, inician
sesión y se mantienen sincronizadas con el servidor.
- name: Dispositivos
description: >-
Los teléfonos y escáneres registrados en la organización. Bloquea uno
perdido, bórralo o retíralo.
- name: Configuración del escáner
description: >-
Hojas imprimibles de códigos de barras que configuran un escáner de
hardware, y las preferencias de escáner de cada persona.
- name: Inscripciones
description: Crea los códigos QR que inscriben dispositivos compartidos y quioscos.
- name: Feeds de sincronización
description: >-
Descarga una instantánea de los datos que necesita un dispositivo y luego
obtén los cambios desde entonces.
- name: Comandos de sincronización
description: >-
Envía los cambios que un dispositivo hizo sin conexión. Cada comando se
aplica una sola vez, sin importar cuántas veces se envíe.
- name: Archivos de sincronización
description: >-
Descarga los archivos, como imágenes de artículos, a los que apunta un
feed.
- name: Perfil
description: >-
La cuenta propia de la persona que inició sesión: sus datos, contraseña,
llaves de acceso, segundo factor y sesiones.
- name: Notificaciones
description: >-
La bandeja de entrada del miembro que inició sesión: lo que lo necesita,
lo que no ha leído, y de qué se le avisa y cómo.
- name: Invitaciones
description: Invita a personas a unirse a la organización y acepta una invitación.
- name: Roles
description: >-
Roles y los permisos de cada uno. Un miembro puede hacer lo que sus roles
permiten.
- name: Acceso del personal
description: >-
Solicitudes del soporte de StockShift para ver los datos de la
organización, que un propietario debe conceder.
- name: Equipo
description: Las personas de la organización y los roles que tienen.
- name: Claves de API
description: >-
Crea y revoca las claves que usan los scripts y las integraciones para
llamar a esta API.
- name: Organizaciones
description: Las organizaciones a las que pertenece la persona que inició sesión.
- name: Firmas
description: >-
Algunas acciones necesitan una firma electrónica. Obtén aquí un token de
firma y envíalo con la llamada.
- name: Registro
description: Regístrate para obtener una cuenta y una organización nuevas.
- name: Organización
description: >-
Política de toda la organización: cuánto tiempo se conservan los
registros, reglas de sesión, retenciones legales y cierre de la
organización.
- name: Aceptaciones legales
description: >-
Las versiones de los Términos de servicio y de la Política de privacidad
que aceptó la organización, las versiones que esperan a un propietario y
un certificado de cada aceptación.
- name: Dirección
description: >-
La dirección de facturación que aparece en las facturas de la
organización.
- name: Historial
description: Quién cambió qué campo de un registro, cuándo y a partir de qué.
- name: Certificados de destrucción
description: Comprueba que un certificado de destrucción de datos es auténtico.
- name: Facturación
description: >-
Consulta o cambia el plan, compra paquetes de ejecuciones para
automatizaciones, ve las facturas y actualiza el método de pago.
- name: Webhooks
description: >-
Registra URL para que te avisen cuando pasen cosas, y consulta cada
entrega y su respuesta.
- name: Apps OAuth
description: >-
Las apps de terceros que los miembros conectaron mediante OAuth. Revoca
una para cortar su acceso.
- name: Hooks REST
description: >-
Para apps conectadas como Zapier: suscribe un evento a una URL y cancela
la suscripción.
- name: Servidor MCP
description: >-
Deja que un asistente de IA trabaje en StockShift a través del Model
Context Protocol, con los mismos permisos que el miembro que lo conecta.
- name: Eventos recientes
description: >-
Los últimos eventos de un tipo, tal como los envían las entregas, para
consultar periódicamente o usar como muestras.
- name: Eventos de webhook
description: >-
Todos los eventos que pueden enviar los webhooks y los REST hooks, con la
forma de sus datos.
paths:
/billing/overview:
get:
tags:
- Facturación
summary: Muestra el resumen de facturación
description: >-
El plan de la organización, las ejecuciones de automatización usadas
este mes, una página de
registros de uso diario, su suscripción de Stripe, su método de pago y
su
contacto de facturación. Los registros de uso llegan en grupos de 5, del
más nuevo al más antiguo; pasa
`usage_records_next_cursor` como `after` para obtener la página
siguiente. Requiere el
permiso `billing.overview.view` y un token con `billing:read`.
operationId: v1.billing.overview.show
parameters:
- name: after
in: query
description: >-
El `usage_records_next_cursor` de la página anterior. Omítelo para
ver los registros de uso más recientes.
schema:
type:
- integer
- 'null'
minimum: 1
responses:
'200':
description: '`BillingOverviewResource`'
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/BillingOverviewResource'
required:
- data
headers:
X-RateLimit-Limit:
description: >-
Solicitudes por minuto permitidas para este token, o para la
dirección si no tiene uno.
schema:
type: integer
X-RateLimit-Remaining:
description: Solicitudes que quedan este minuto.
schema:
type: integer
'401':
$ref: '#/components/responses/AuthenticationException'
'422':
$ref: '#/components/responses/ValidationException'
'429':
description: Demasiadas solicitudes
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
headers:
Retry-After:
description: Segundos hasta que se restablece el límite.
schema:
type: integer
X-RateLimit-Limit:
description: Solicitudes por minuto permitidas.
schema:
type: integer
X-RateLimit-Remaining:
description: 'Solicitudes que quedan este minuto: ninguna.'
schema:
type: integer
x-codeSamples:
- lang: typescript
label: TypeScript SDK
source: >-
import { StockShift } from "@stockshift/sdk";
const stockshift = new StockShift({ token:
process.env.STOCKSHIFT_TOKEN! });
const result = await stockshift.get("/billing/overview");
components:
schemas:
BillingOverviewResource:
type: object
properties:
plan:
$ref: '#/components/schemas/PlanSummaryResource'
description: >-
El plan actual de la organización, con el precio de su plazo de
facturación.
usage:
$ref: '#/components/schemas/UsageSummaryResource'
description: >-
Ejecuciones de automatización usadas este mes calendario frente al
límite mensual del plan, con los paquetes de ejecuciones incluidos
en el límite.
usage_records:
type: array
description: >-
Hasta 5 registros de uso diario, de los más nuevos a los más
antiguos. Pasa `usage_records_next_cursor` como `after` para obtener
la página siguiente.
items:
$ref: '#/components/schemas/UsageRecordResource'
usage_records_next_cursor:
type:
- integer
- 'null'
description: >-
Pásalo como `after` para obtener la página siguiente, más antigua,
de registros de uso. Es null en la última página.
subscription:
anyOf:
- $ref: '#/components/schemas/SubscriptionSummaryResource'
- type: 'null'
description: >-
La suscripción de Stripe detrás del plan. Es null cuando la
organización no tiene suscripción.
payment_method:
anyOf:
- $ref: '#/components/schemas/PaymentMethodResource'
- type: 'null'
description: >-
El método de pago predeterminado registrado, o null cuando no hay
ninguno.
billing_contact:
anyOf:
- $ref: '#/components/schemas/BillingContactResource'
- type: 'null'
description: >-
A quién se dirigen las facturas, o null cuando no hay una dirección
de facturación guardada.
term_switch:
anyOf:
- $ref: '#/components/schemas/TermSwitchResource'
- type: 'null'
description: >-
El cambio a facturación mensual que espera al final del año pagado,
o null cuando no hay ninguno programado.
cancellation:
anyOf:
- $ref: '#/components/schemas/CancellationResource'
- type: 'null'
description: >-
Cuándo termina el plan de pago, si se canceló y su período pagado
aún no ha terminado. Es null cuando el plan se renueva.
required:
- plan
- usage
- usage_records
- usage_records_next_cursor
- subscription
- payment_method
- billing_contact
- term_switch
- cancellation
title: BillingOverviewResource
description: >-
Todo lo que muestra la página de facturación: el plan de la
organización, las ejecuciones de automatización de este mes, una página
de registros de uso, la suscripción, el método de pago y el contacto de
facturación.
ProblemDetails:
type: object
description: >-
Un error, como detalles del problema RFC 9457. Decide según `code`, que
es estable; `detail` está escrito para personas y puede cambiar.
properties:
type:
type: string
format: uri
description: Enlaces a la documentación de este código.
title:
type: string
description: El texto de estado HTTP.
status:
type: integer
description: El código de estado HTTP.
code:
type: string
description: Un nombre estable legible por máquina, como validation_failed.
detail:
type: string
description: Qué salió mal, para las personas.
errors:
type: object
description: >-
Errores por campo. En validation_failed, y en un rechazo con un
código propio como insufficient_stock o document_closed.
additionalProperties:
type: array
items:
type: string
feature:
type: string
description: La función del plan que se necesita. Solo en plan_upgrade_required.
reason:
type: string
description: >-
Por qué un dispositivo debe descargar un feed de nuevo. Solo en
resync_required.
attempts_left:
type: integer
description: >-
Cuántas firmas rechazadas quedan antes de que el miembro se bloquee
en el dispositivo. Solo en signature_assertion_invalid.
rule_ids:
type: array
description: >-
Las reglas de testigo que cubren las existencias. Solo en
verification_required.
items:
type: string
witness:
type: string
description: >-
Dónde firma el testigo: same_device, remote o either. Solo en
verification_required.
blind_recount:
type: boolean
description: >-
Si el testigo vuelve a contar antes de ver la cantidad. Solo en
verification_required.
flags:
type: array
description: >-
Las marcas que dejan abiertas las decisiones de una línea masiva,
tal como las nombra la vista previa masiva. Solo en
decision_required.
items:
type: object
properties:
flag:
type: string
description: El nombre de la marca, tal como lo da la vista previa masiva.
facts:
type: object
description: >-
Los hechos de la marca, como en la vista previa masiva; los
demás son null.
additionalProperties:
anyOf:
- type: string
- type: integer
- type: array
items:
type: string
- type: 'null'
choices:
type: array
description: >-
Las decisiones que resolverían la marca, tal como las nombra
la vista previa masiva.
items:
type: string
required:
- flag
- facts
- choices
required:
- type
- title
- status
- code
- detail
title: ProblemDetails
PlanSummaryResource:
type: object
properties:
name:
type: string
description: El nombre del plan, tal como se muestra en la página de planes.
icon:
type:
- string
- 'null'
description: >-
El nombre del ícono que muestra la app para el plan, como `rocket`,
o null cuando no tiene ninguno.
term:
$ref: '#/components/schemas/BillingTerm'
description: |-
Cómo se factura el plan: `monthly` o `annual`.
| |
|---|
| `monthly`
Se factura cada mes. |
| `annual`
Se factura una vez al año, al precio anual. |
amount:
type: integer
description: Lo que cuesta el plan por plazo, en centavos.
features:
type: array
description: Lo que incluye el plan hoy, según sus límites y derechos.
items:
type: string
coming_soon:
type: array
description: Funciones que enumera el plan y que aún no están construidas.
items:
type: string
limits:
type: array
description: Cada límite que define el plan. Un valor null significa ilimitado.
items:
type: object
properties:
key:
type: string
enum:
- locations
- skus
- automation_runs
- attachment_storage_mb
- audit_retention_days
- report_rows
- insights_schedules
description: >-
Lo que cuenta el límite: `locations`, `skus`,
`automation_runs` (ejecuciones por mes calendario),
`attachment_storage_mb` (megabytes de imágenes y documentos de
artículos), `audit_retention_days` (días que se conservan las
entradas de auditoría), `report_rows` (el máximo de filas que
lee o exporta un reporte) o `insights_schedules` (reportes y
alertas programados).
value:
type:
- integer
- 'null'
description: >-
El máximo que permite el plan para ese límite, o null si es
ilimitado.
required:
- key
- value
required:
- name
- icon
- term
- amount
- features
- coming_soon
- limits
title: PlanSummaryResource
description: >-
El plan actual de la organización tal como lo muestra el resumen de
facturación. Los montos están en centavos.
UsageSummaryResource:
type: object
properties:
used:
type: integer
description: Cuántas ejecuciones de automatización se usaron este mes calendario.
limit:
type:
- integer
- 'null'
description: >-
Cuántas ejecuciones de automatización permite el mes, incluidos los
paquetes de ejecuciones. Es null cuando el plan no tiene límite.
remaining:
type:
- integer
- 'null'
description: >-
Cuántas ejecuciones de automatización quedan este mes, nunca menos
de 0. Es null cuando el plan no tiene límite.
over_limit:
type: integer
description: >-
Cuántas ejecuciones de automatización superaron el límite este mes.
Es 0 cuando están dentro del límite o cuando no hay límite.
percentage:
type:
- number
- 'null'
description: >-
La parte del límite que se usó, como porcentaje redondeado a un
decimal, como 42.5. Puede ser mayor que 100. Es null cuando no hay
límite o el límite es 0.
daily:
type: array
description: >-
Ejecuciones de automatización usadas cada día de este mes hasta
ahora, como una lista de `date` (YYYY-MM-DD) y `used`.
items: {}
required:
- used
- limit
- remaining
- over_limit
- percentage
- daily
title: UsageSummaryResource
description: >-
Ejecuciones de automatización usadas este mes calendario frente al
límite mensual del plan, que incluye los paquetes de ejecuciones. Sin
límite, `limit`, `remaining` y `percentage` son null y `over_limit` es
0.
UsageRecordResource:
type: object
properties:
id:
type: integer
description: >-
El id del registro de uso. Pásalo como `after` para obtener los
registros más antiguos que este.
date:
type: string
description: El día al que corresponde el uso, como YYYY-MM-DD.
quantity:
type: integer
description: Cuántas unidades medidas se usaron ese día.
reported:
type: boolean
description: Si el uso ya se envió a Stripe.
required:
- id
- date
- quantity
- reported
title: UsageRecordResource
description: Un día de uso medido que se factura a la organización mediante Stripe.
SubscriptionSummaryResource:
type: object
properties:
status:
type: string
description: >-
El estado de la suscripción según Stripe, como `trialing`, `active`
o `past_due`.
on_trial:
type: boolean
description: Si la suscripción está ahora en su prueba gratuita.
trial_ends_at:
type:
- string
- 'null'
description: >-
Cuándo termina la prueba, como fecha y hora ISO 8601. Es null cuando
la suscripción nunca tuvo una prueba.
current_period_end:
type:
- string
- 'null'
description: >-
El último día del período de facturación actual, como YYYY-MM-DD. Es
null cuando Stripe no informa ninguno.
required:
- status
- on_trial
- trial_ends_at
- current_period_end
title: SubscriptionSummaryResource
description: La suscripción de Stripe detrás del plan de la organización.
PaymentMethodResource:
type: object
properties:
brand:
$ref: '#/components/schemas/StripePaymentBrand'
description: >-
La marca de la tarjeta, como `visa` o `mastercard`, o el tipo de
método de pago cuando no es una tarjeta, como `us_bank_account`. Las
marcas desconocidas son `unknown`.
last_four:
type:
- string
- 'null'
description: >-
Los últimos cuatro dígitos del número de la tarjeta o cuenta, o null
cuando Stripe no los dio.
masked_number:
type:
- string
- 'null'
description: >-
El número enmascarado como lo imprime la marca, terminado en los
últimos cuatro dígitos. Es null cuando se desconocen los últimos
cuatro dígitos.
expires:
type:
- string
- 'null'
description: >-
El mes de vencimiento, como MM/YYYY. Es null para un método de pago
sin vencimiento, como una cuenta bancaria.
funding:
type:
- string
- 'null'
description: >-
El tipo de fondos de la tarjeta según Stripe, como `credit`, `debit`
o `prepaid`. Es null cuando Stripe no da ninguno, como en una cuenta
bancaria.
required:
- brand
- last_four
- masked_number
- expires
- funding
title: PaymentMethodResource
description: >-
El método de pago predeterminado de la organización que está registrado.
Stripe guarda la tarjeta o la cuenta; StockShift conserva su marca, los
últimos cuatro dígitos, el vencimiento y el tipo de fondos.
BillingContactResource:
type: object
properties:
first_name:
type:
- string
- 'null'
description: El nombre del contacto de facturación, o null.
last_name:
type:
- string
- 'null'
description: El apellido del contacto de facturación, o null.
company_name:
type:
- string
- 'null'
description: >-
El nombre de la empresa que se imprime en las facturas, o null
cuando no hay ninguno.
email:
type:
- string
- 'null'
description: >-
La dirección de correo electrónico a la que se envían las facturas y
los recibos, o null.
phone:
type:
- string
- 'null'
description: >-
El número de teléfono del contacto de facturación tal como se
ingresó, o null.
street_line_1:
type:
- string
- 'null'
description: La primera línea de la dirección postal, o null.
street_line_2:
type:
- string
- 'null'
description: >-
La segunda línea de la dirección, como un local o una unidad, o
null.
city:
type:
- string
- 'null'
description: La ciudad o población de la dirección, o null.
region:
type:
- string
- 'null'
description: El nombre de la región, como `Ontario`, o null.
postal_code:
type:
- string
- 'null'
description: El código postal o ZIP tal como se ingresó, o null.
country:
type:
- string
- 'null'
description: El nombre del país, como `Canada`, o null.
required:
- first_name
- last_name
- company_name
- email
- phone
- street_line_1
- street_line_2
- city
- region
- postal_code
- country
title: BillingContactResource
description: >-
El contacto de facturación de la organización tal como lo muestra el
resumen de facturación: a quién se dirigen las facturas de StockShift y
a quién se envían los recibos. Todos los campos son null cuando nunca se
definieron.
TermSwitchResource:
type: object
properties:
id:
type:
- string
- 'null'
description: >-
El id del cambio en espera; es null para un cambio a anual, que se
aplica de inmediato.
term:
$ref: '#/components/schemas/BillingTerm'
description: |-
El plazo con el que se factura el plan después del cambio.
| |
|---|
| `monthly`
Se factura cada mes. |
| `annual`
Se factura una vez al año, al precio anual. |
status:
$ref: '#/components/schemas/PlanChangeStatus'
description: >-
En qué situación está el cambio: `scheduled` hasta que termina el
año pagado, `applied` cuando el plan se factura con el nuevo plazo,
o `cancelled`.
| |
|---|
| `scheduled`
Espera, y Stripe cambia el plan cuando termina
el período. |
| `applied`
Entró en vigor, y la organización está en el nuevo
plan o plazo. |
| `cancelled`
Se canceló antes de entrar en vigor. Cancelar el
plan también lo cancela. |
effective_on:
type: string
description: El día en que entra en vigor, como YYYY-MM-DD.
required:
- id
- term
- status
- effective_on
title: TermSwitchResource
description: >-
Un cambio del plazo de facturación: a anual, que se aplica de inmediato,
o a mensual, que espera al final del año pagado.
CancellationResource:
type: object
properties:
plan:
type: string
description: El nombre del plan de pago.
cancelled:
type: boolean
description: >-
Si el plan termina al final del período pagado en lugar de
renovarse.
ends_on:
type:
- string
- 'null'
description: >-
El último día del período pagado, como YYYY-MM-DD, después del cual
la organización pasa a Free. Es null cuando el plan se renueva.
required:
- plan
- cancelled
- ends_on
title: CancellationResource
description: >-
Si el plan de pago de la organización se renueva o termina al final de
su período pagado, y qué día termina.
BillingTerm:
type: string
description: |-
Cada cuánto se factura un plan y sus complementos.
| |
|---|
| `monthly`
Se factura cada mes. |
| `annual`
Se factura una vez al año, al precio anual. |
enum:
- monthly
- annual
title: BillingTerm
StripePaymentBrand:
type: string
description: >
La marca de la tarjeta de un método de pago con tarjeta, o el tipo de
método de pago para todo lo demás, como los nombra Stripe.
enum:
- mastercard
- amex
- diners
- visa
- discover
- jcb
- unionpay
- ach_direct_debit
- us_bank_transfer
- canadian_pads
- us_bank_account
- acss_debit
- unknown
title: StripePaymentBrand
PlanChangeStatus:
type: string
description: >-
En qué situación está un cambio de plan o de plazo de facturación: una
rebaja de plan o un cambio a facturación mensual espera al final del
período pagado.
| |
|---|
| `scheduled`
Espera, y Stripe cambia el plan cuando termina el
período. |
| `applied`
Entró en vigor, y la organización está en el nuevo
plan o plazo. |
| `cancelled`
Se canceló antes de entrar en vigor. Cancelar el
plan también lo cancela. |
enum:
- scheduled
- applied
- cancelled
title: PlanChangeStatus
responses:
AuthenticationException:
description: No autenticado
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
ValidationException:
description: Error de validación
content:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
securitySchemes:
apiKey:
type: http
description: >-
Para tus propios scripts e integraciones de servidor a servidor. Crea
una clave en la app en Configuración > Acceso > Claves de API y cópiala
entonces, porque se muestra una sola vez. Envíala como `Authorization:
Bearer `. La clave actúa como el miembro que la creó, en la
organización en la que se creó. Una llamada necesita el permiso del
miembro y uno de los alcances de la clave, como `inventory:read` o
`sales:write`. Una clave con `*` tiene todos los alcances.
scheme: bearer
oauth2:
type: oauth2
description: >-
Para apps que otras personas conectan a su cuenta de StockShift. Usa el
flujo de código de autorización OAuth 2.1 con PKCE (S256); no hay
secreto de cliente. Descubre los endpoints en
`/.well-known/oauth-authorization-server` (RFC 8414) y registra tu app
en `POST /oauth/register` (RFC 7591). El miembro elige la organización y
aprueba los alcances en la página de consentimiento, y el token nunca
puede hacer más de lo que podría hacer el miembro. Envíalo como
`Authorization: Bearer `, igual que una clave de API. Los tokens
de acceso duran una hora; cada actualización devuelve un token de
actualización nuevo, así que guárdalo.
flows:
authorizationCode:
authorizationUrl: https://app.stockshift.io/oauth/authorize
tokenUrl: https://app.stockshift.io/oauth/token
refreshUrl: https://app.stockshift.io/oauth/token
scopes:
access:read: Access read
audit:read: Audit read
address:read: Address read
address:write: Address write
billing:read: Billing read
catalog:read: Catalog read
catalog:write: Catalog write
dashboard:read: Dashboard read
dashboard:write: Dashboard write
developer:read: Developer read
developer:write: Developer write
devices:read: Devices read
devices:write: Devices write
documents:read: Documents read
documents:write: Documents write
notifications:read: Notifications read
notifications:write: Notifications write
inventory:read: Inventory read
inventory:write: Inventory write
purchasing:read: Purchasing read
purchasing:write: Purchasing write
quality:read: Quality read
quality:write: Quality write
sales:read: Sales read
sales:write: Sales write
engineering:read: Engineering read
engineering:write: Engineering write
manufacturing:read: Manufacturing read
manufacturing:write: Manufacturing write
automation:read: Automation read
automation:write: Automation write
insights:read: Insights read
insights:write: Insights write
integrations:read: Integrations read
integrations:write: Integrations write
labels:read: Labels read
labels:write: Labels write
library:read: Library read
organization:read: Organization read
organization:write: Organization write
planning:read: Planning read
planning:write: Planning write
sync:read: Sync read
sync:write: Sync write
````
## Related topics
- [Muestra el resumen de una conexión](https://docs.stockshift.io/es/api-reference/conexiones/muestra-el-resumen-de-una-conexión.md)
- [Muestra la dirección de facturación](https://docs.stockshift.io/es/api-reference/dirección/muestra-la-dirección-de-facturación.md)
- [Muestra el directorio de integraciones](https://docs.stockshift.io/es/api-reference/conectores/muestra-el-directorio-de-integraciones.md)
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.