Skip to main content

Glosario

Orden de Compra​

Documento formal emitido por un comprador a un proveedor solicitando la entrega de productos o servicios específicos. Detalla cantidades, precios y condiciones de entrega, y sirve como un acuerdo contractual entre ambas partes.

Movimientos​

Registros de transacciones relacionadas con un producto, como entradas, salidas y transferencias. Estos registros son esenciales para mantener un control preciso del inventario y rastrear el flujo de bienes dentro del sistema.

Archivos de Facturas​

Un endpoint de la API que permite adjuntar archivos, como PDFs o imágenes, a una factura. Esta funcionalidad permite a los usuarios almacenar y referenciar documentación importante junto con sus registros de facturación.

Parámetros​

Variables que se pasan como entrada a un endpoint de la API para modificar su comportamiento. Por ejemplo, el endpoint GET Invoices utiliza los parámetros from y to para definir el rango de fechas para consultar facturas específicas.

Inputs​

Objetos JSON que contienen los datos que un endpoint de la API procesa. Por ejemplo, el endpoint POST Invoices Mex Accounted recibe datos detallados de facturas dentro de sus inputs para crear nuevos registros de facturas.

Objetos​

Estructuras de datos en formato JSON compuestas por pares clave-valor que representan entidades. Por ejemplo, una orden de compra se representa como un objeto con campos como purchaseOrder, productId y quantity.

Arreglo​

Una estructura de datos que consiste en una colección de elementos, cada uno identificado por un índice. En los endpoints de la API, los arreglos se utilizan para agrupar múltiples objetos, como "inputs": [...] que puede contener una lista de elementos a procesar.

Una sección de un objeto JSON que contiene metadatos o información general relevante para todo el objeto. Por ejemplo, una factura puede tener una sección de encabezado con detalles como el número de factura, la fecha y la dirección de facturación.

Detalles​

Una sección dentro de un objeto JSON que proporciona información específica de los elementos. Por ejemplo, en una factura, la sección de detalles incluiría una lista de productos comprados, cantidades y precios.

Endpoint​

Una URL específica que expone la funcionalidad de una API o servicio web. Los endpoints se utilizan para realizar diversas operaciones, como recuperar datos o enviar solicitudes, y son esenciales para la implementación de los casos de uso de la API.

cURL​

Una herramienta de línea de comandos utilizada para realizar solicitudes HTTP y probar la interacción con APIs. Se utiliza comúnmente en ejemplos de documentación de APIs para demostrar cómo invocar endpoints y enviar solicitudes.

Parámetros de Consulta​

Parámetros incluidos en la cadena de consulta de la URL que se utilizan para filtrar o modificar los resultados de una solicitud API. Por ejemplo, los parámetros de consulta en el endpoint GET Invoices se pueden usar para especificar rangos de fechas para filtrar registros de facturas.

Cuerpo​

El cuerpo de una solicitud HTTP que se envía a un endpoint de la API, típicamente contiene datos en formato JSON. Estos datos son procesados por el endpoint para realizar la operación solicitada, como crear o actualizar registros.

Respuesta​

Los datos devueltos por un endpoint de la API después de procesar una solicitud. Las respuestas suelen incluir los resultados de la operación, como los datos solicitados o la confirmación del éxito, junto con cualquier código de error relevante.