Contratos
Listar contratos
Devuelve los contratos de alquiler con su doble estado: status es el estado del documento (draft, issued, voided) y operativeStatus el estado de la firma.
contracts:readcontracts:read- 120/min
- Anotación del servidor: Solo lectura
- Anotación del servidor: Idempotente
Resultado
generado desde el esquema
signed es lo que decide si el material puede salir. No incluye las cláusulas legales.
Argumentos
Tamaño de página (1-500). Por defecto es 50.
Límites: mín. 1, máx. 500
Cursor opaco de la página que se devuelve. Pasa el valor de pagination. de la respuesta anterior; trátalo como opaco.
Límites: longitud máx. 200
Orden: hasta 3 campos separados por comas, cada uno con un "-" inicial para descendente (p. ej. "-updatedAt,name"). Campos ordenables: createdAt, updatedAt, contractNumber, contractDate, startDate, endDate, status, signedAt, grossPrice. 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
Filtra por estado del documento: draft, validated (emitido) o voided.
Opciones disponibles: draft, validated, voided
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, validated, voided
Límites: mín. 1 elementos, máx. 50 elementos
Filtra por estado de firma: pending, signed o cancelled.
Opciones disponibles: pending, signed, cancelled
Filtra por operativeStatus, 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: pending, signed, cancelled
Límites: mín. 1 elementos, máx. 50 elementos
Filtra por pedido asociado.
Límites: longitud mín. 1, longitud máx. 100
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
Filtra por proyecto asociado.
Límites: longitud mín. 1, longitud máx. 100
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
Filtra por cliente.
Límites: longitud mín. 1, longitud máx. 100
Filtra por contactId, 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
Ponlo en true para incluir pagination., el número de resultados que coinciden con los filtros en todas las páginas. Desactivado por defecto.
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 hijosOcultar atributos hijos
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
Exactamente ese día; un instante significa toda la jornada del negocio que lo contiene.
Mostrar atributos hijosOcultar atributos hijos
Desde este día o instante, inclusive.
Hasta este día o instante, inclusive.
Estrictamente posterior; una fecha sin hora significa después del final de ese día.
Estrictamente anterior; una fecha sin hora significa antes del inicio de ese día.
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
Identificador único del contrato.
Número del contrato, por ejemplo "C260001"; null mientras es un borrador.
Estado del documento.
Opciones disponibles: draft, validated, voided
Estado de la firma.
Opciones disponibles: pending, signed, cancelled
true si el contrato consta como firmado. Es lo que decide si el equipo puede salir.
Fecha de firma en ISO 8601 UTC; null si no está firmado.
Identificador del cliente; null en borradores sin cliente.
Pedido asociado; null si no tiene.
Número del pedido asociado; null si no tiene.
Proyecto asociado; null si no tiene.
Fecha del contrato en ISO 8601 UTC; null si no está definida.
Inicio de la vigencia en ISO 8601 UTC; null si no aplica.
Fin de la vigencia en ISO 8601 UTC; null si no aplica.
Importe total con impuestos como cadena decimal "1234.50"; null si no aplica.
Límites: patrón ^-?\d+\.\d{2}$
Fecha de creación en ISO 8601 UTC; null si no consta.
Fecha de la última modificación en ISO 8601 UTC; null si no está registrada.
Un error es un resultado con isError: true y el problema en content[0].; no hay structuredContent. Consulta Errores.
La misma operación por REST
Esta herramienta ejecuta GET /api/v1/contracts.
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasContratos
Listar contratos
Devuelve los contratos de alquiler con su doble estado:
statuses el estado del documento (draft, issued, voided) yoperativeStatusel estado de la firma.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: truey el problema en el primer bloque de texto. Ramifica por sucode.
¿Te ha resultado útil esta página?