Órdenes de compra

Listar pedidos de compra

Devuelve lo que la empresa compra o subcontrata a sus proveedores, con sus importes y su estado de pago.

Herramienta
filmo_purchase_orders_list
Acceso: Lectura

Resultado

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_purchase_orders_list",
    "arguments": {
      "limit": 20
    }
  }
}

generado desde el esquema

Los importes son importes de COSTE, porque el objeto es una compra. Las líneas no se publican, así que el gasto no se puede atribuir a un artículo concreto de un alquiler.

Argumentos

limitintegerpredeterminado:50

Tamaño de página (1-500). Por defecto es 50.

Límites: mín. 1, máx. 500

cursorstring

Cursor opaco de la página que se devuelve. Pasa el valor de pagination.nextCursor de la respuesta anterior; trátalo como opaco.

Límites: longitud máx. 200

sortstring

Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: createdAt, updatedAt, poNumber, poDate, status, type, grossPrice, netPrice, isDraft. Por defecto, "-createdAt". Los empates se resuelven por id, así que el orden es estable entre páginas, y un cursor queda ligado al orden con el que se emitió.

Límites: longitud máx. 200

statusstring

Filtra por estado del pedido de compra.

Opciones disponibles: draft, pending, completed, cancelled

statusesstring[]

Filtra por status, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Opciones disponibles: draft, pending, completed, cancelled

Límites: mín. 1 elementos, máx. 50 elementos

typestring

Filtra por tipo de pedido de compra.

Opciones disponibles: subrental, stock_purchase, resale_purchase, consumable_purchase, technician, transport, repair, consignment

typesstring[]

Filtra por type, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Opciones disponibles: subrental, stock_purchase, resale_purchase, consumable_purchase, technician, transport, repair, consignment

Límites: mín. 1 elementos, máx. 50 elementos

supplierIdstring

Filtra por proveedor.

Límites: longitud mín. 1, longitud máx. 100

supplierIdsstring[]

Filtra por supplierId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

orderIdstring

Filtra por pedido de alquiler asociado.

Límites: longitud mín. 1, longitud máx. 100

orderIdsstring[]

Filtra por orderId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

projectIdstring

Filtra por proyecto asociado.

Límites: longitud mín. 1, longitud máx. 100

projectIdsstring[]

Filtra por projectId, como lista: repite el parámetro o separa los valores con comas. Acepta hasta 50 valores y devuelve lo que coincida con cualquiera de ellos.

Límites: mín. 1 elementos, máx. 50 elementos, cada uno: longitud mín. 1, cada uno: longitud máx. 100

includeTotalbooleanpredeterminado:false

Ponlo en true para incluir pagination.total, el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.

dateFiltersobject

Filtros de fecha por campo. Una fecha sin hora (YYYY-MM-DD) se lee en la zona horaria del negocio; un instante ISO 8601 con desplazamiento se aplica tal cual con gte, lte, gt y lt, mientras que on lo amplía al día completo del negocio que lo contiene. Campos: created, updated.

Mostrar atributos hijos
dateFilters.createdobject

Mostrar atributos hijos
dateFilters.created.gtestring

Desde este día o instante, inclusive.

dateFilters.created.ltestring

Hasta este día o instante, inclusive.

dateFilters.created.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.created.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.created.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

dateFilters.updatedobject

Mostrar atributos hijos
dateFilters.updated.gtestring

Desde este día o instante, inclusive.

dateFilters.updated.ltestring

Hasta este día o instante, inclusive.

dateFilters.updated.gtstring

Estrictamente posterior; una fecha sin hora significa después del final de ese día.

dateFilters.updated.ltstring

Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.

dateFilters.updated.onstring

Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.

Resultado

En un éxito el resultado lleva structuredContent con data y meta. Estos son los atributos de data.

Ver los atributos de data
idstring

Identificador único del pedido de compra.

poNumberstring | null

Número del pedido de compra; null mientras es un borrador.

statusstring

Estado del pedido de compra.

Opciones disponibles: draft, pending, completed, cancelled

typestring

Tipo de pedido de compra.

Opciones disponibles: subrental, stock_purchase, resale_purchase, consumable_purchase, technician, transport, repair, consignment

isDraftboolean

true si el pedido de compra sigue siendo un borrador.

poDatestring<date-time> | null

Fecha del pedido de compra en ISO 8601 UTC; null si no se ha fijado.

supplierIdstring | null

Identificador del proveedor; null mientras un borrador no tiene proveedor. Resuélvelo contra /api/v1/contacts.

referencestring | null

Referencia de formato libre del pedido de compra; null si no tiene.

currencystring

Moneda del pedido de compra, como código ISO 4217.

subTotalstring

Subtotal antes de descuentos e impuestos, como cadena decimal "1234.50".

Límites: patrón ^-?\d+\.\d{2}$

discountTotalstring

Total de descuentos, como cadena decimal "1234.50".

Límites: patrón ^-?\d+\.\d{2}$

taxesPricestring

Total de impuestos, como cadena decimal "1234.50".

Límites: patrón ^-?\d+\.\d{2}$

netPricestring

Base imponible, como cadena decimal "1234.50".

Límites: patrón ^-?\d+\.\d{2}$

grossPricestring

Total con impuestos, como cadena decimal "1234.50".

Límites: patrón ^-?\d+\.\d{2}$

totalPaidstring | null

Importe ya pagado, como cadena decimal "1234.50"; null si no se ha registrado ningún pago.

Límites: patrón ^-?\d+\.\d{2}$

orderIdstring | null

Pedido de alquiler asociado; null si no tiene.

orderNumberstring | null

Número de ese pedido; null si no tiene.

projectIdstring | null

Proyecto asociado; null si no tiene.

repairTicketIdstring | null

Ticket de reparación que originó la compra; null si no procede de uno.

notesstring | null

Notas del pedido de compra; null si no tiene.

createdAtstring<date-time>

Fecha de creación en ISO 8601 UTC.

updatedAtstring<date-time>

Fecha de la última modificación en ISO 8601 UTC.

Un error es un resultado con isError: true y el problema en content[0].text; no hay structuredContent. Consulta Errores.

La misma operación por REST

Esta herramienta ejecuta GET /api/v1/purchase-orders.

  • Órdenes de compra

    Listar pedidos de compra

    Devuelve lo que la empresa compra o subcontrata a sus proveedores, con sus importes y su estado de pago.

  • Guías

    Escrituras seguras

    Un asistente que puede escribir también puede escribir lo equivocado. Decide qué herramientas necesitan a una persona, reintenta sin duplicar y sabe qué pone en marcha una escritura.

  • Guías

    Errores

    Un error de herramienta es un resultado con isError: true y el problema en el primer bloque de texto. Ramifica por su code.