Conceptos básicos

Estados

La mayoría de los estados son listas cerradas de valores de texto. En los pedidos, el campo muestra uno de 12 estados en bruto, mientras que el filtro del listado usa siete grupos más amplios.

Un valor nuevo sería un cambio documentado y aditivo, así que un cliente debe tolerar un valor que no conozca. Los estados de las notas de crédito y de las proformas no son listas cerradas en absoluto: son texto libre, así que tolera cualquier valor ahí. Las tablas de abajo son las que más necesita un integrador; la tabla generada al final lista todos los enums de estado. La vista de la propia app sobre el ciclo de vida del pedido está en Ciclo de vida de un pedido.

status del pedido (valor en bruto)Filtro ?status= de la lista
draftdraft
reservedreserved
prepared_partiallypreparedpreparedIncluye la preparación parcial.
picked_upin_useRecogido o en uso.
returned_partiallyreturnedchecked_in_partiallyreturnedIncluye la devolución parcial y la recepción parcial.
checked_incompletedRecibido y completado.
cancelledcancelled
  • La descripción del filtro no coloca en ningún grupo picked_up_partially ni archived. archived aparece entre los valores del DTO, pero un pedido archivado no se puede listar ni leer.
Estados del pedido: 12 valores en bruto, 7 grupos de filtro

El campo status de un pedido muestra el estado en bruto, uno de 12 valores. El filtro status de GET /api/v1/orders usa grupos operativos, la misma vista que la app. No envíes un valor en bruto al filtro ni esperes un grupo en el campo.

Estado en bruto (campo)Grupo de filtros
draftdraft
reservedreserved
prepared_partially, preparedprepared (incluye la preparación parcial)
picked_upin_use (entregado o en uso)
picked_up_partiallyin_use. La redacción de la especificación lista solo recogido, así que si necesitas exactamente este estado, lee los pedidos y comprueba tú mismo el estado en bruto
returned_partially, returnedreturned (incluye la devolución parcial)
checked_in_partiallyreturned (incluye la recepción parcial)
checked_incompleted (recepcionado y completado)
cancelledcancelled
archivedNinguno. Filmo nunca produce este valor: un pedido archivado deja de ser visible para la API, no aparece en los listados y su GET responde 404

Para filtrar por varios grupos a la vez, usa statuses, una lista de hasta 50 valores que devuelve lo que coincida con cualquiera de ellos.

status de la factura

Ciclo de vida del documento

draft
Un borrador.
validated
Validada y numerada.
voided
Anulada.

paymentStatus de la factura

Estado de cobro; el mismo vocabulario que el filtro ?paymentStatus=

unpaid
Nada cobrado todavía (también para facturas sin cobro registrado).
partially_paid
Cobrada en parte.
paid
Cobrada por completo.
overpaid
Cobrado por encima del total.
overdue
Vencida y sin cobrar.
voided
El documento está anulado.

status del presupuesto

Ciclo de vida de la versión activa

draft
Un borrador.
validated
Validado y numerado.

operativeStatus del presupuesto

Estado comercial de la versión activa

pending
A la espera de respuesta.
confirmed
Aceptado.
cancelled
Rechazado o cancelado.
superseded
Sustituido por otra versión.
  • Los dos estados de cada documento son independientes: uno dice en qué punto del ciclo está el documento y el otro, cómo va su cobro o su respuesta comercial.
Estados de factura y de presupuesto

Una factura tiene dos campos. status es el ciclo de vida del documento; paymentStatus es el estado del pago. El filtro de lista paymentStatus usa los mismos valores que devuelve el campo paymentStatus, y GET /api/v1/invoices devuelve únicamente documentos de tipo factura.

CampoValorSignificado
statusdraftAún sin validar
statusvalidatedValidada y numerada
statusvoidedAnulada
paymentStatusunpaidTodavía no se ha cobrado nada, también en facturas sin un cobro registrado
paymentStatuspartially_paidParte del total cobrado
paymentStatuspaidCobrado por completo
paymentStatusoverpaidCobrado por encima del total
paymentStatusoverdueVencido y sin pagar
paymentStatusvoidedEl documento se anula, sea cual sea lo cobrado antes

Un presupuesto también tiene dos campos, y el detalle aplana la versión activa del presupuesto. status es el ciclo de vida del documento de esa versión; operativeStatus es el estado comercial, y PATCH /api/v1/quotes/{quoteId}/status lo cambia. Confirmar una versión deja las demás como superseded.

CampoValorSignificado
statusdraftAún sin validar
statusvalidatedValidada y numerada
operativeStatuspendingA la espera de respuesta
operativeStatusconfirmedAceptado
operativeStatuscancelledRechazado o cancelado
operativeStatussupersededSustituido por otra versión

Esta tabla se genera a partir de la especificación y lista los enums de estado de todos los recursos, incluidos proyectos, tareas, contratos y el resto.

CampoValores
ContactDto.statusactive, inactive, archived
ContactDetailDto.statusactive, inactive, archived
RelatedContactDto.statusactive, inactive, archived
OrderDto.statusdraft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled
OrderDetailDto.statusdraft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled
OrderLineDto.statusdraft, reserved, prepared, picked_up, sold, returned, checked_in, cancelled, lost
InvoiceDto.statusdraft, validated, voided
InvoiceDto.paymentStatusunpaid, partially_paid, paid, overpaid, overdue, voided
InvoiceDetailDto.statusdraft, validated, voided
InvoiceDetailDto.paymentStatusunpaid, partially_paid, paid, overpaid, overdue, voided
QuoteDto.statusdraft, validated
QuoteDto.operativeStatuspending, confirmed, cancelled, superseded
QuoteDetailDto.statusdraft, validated
QuoteDetailDto.operativeStatuspending, confirmed, cancelled, superseded
ProjectDto.statusdraft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived
ProjectDetailDto.statusdraft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived
RepairTicketDto.statusdraft, sent, partially_converted, fully_invoiced, closed
RepairTicketDetailDto.statusdraft, sent, partially_converted, fully_invoiced, closed
VehicleDto.statusactive, maintenance, inactive
SubrentDto.statuspending, active, completed, cancelled
PurchaseOrderDto.statusdraft, pending, completed, cancelled
ContractDto.statusdraft, validated, voided
ContractDto.operativeStatuspending, signed, cancelled
OpportunityDto.statusopen, won, lost
OpportunityDetailDto.statusopen, won, lost
TreasuryAccountDto.statusactive, needs_reauth, disconnected, archived
CreditNoteDto.statusdraft, validated, voided
OrderLineReturnResultDto.statusreturned, failed
UserDto.statusactive, pending, inactive
  • Conceptos básicos

    Modelo de datos

    Los pedidos conectan un contacto, un proyecto opcional y el equipo alquilado; de ellos cuelgan los documentos, los pagos, la planificación y el catálogo.

  • Guías

    Filtrado y orden

    La mayoría de las listas aceptan sort y los filtros de tiempo created* y updated*, muchas aceptan filtros con lista de valores como statuses, y algunas aceptan q para búsqueda de texto libre. Los ejemplos usan la lista de pedidos.

  • Guías

    Sincronizar datos

    Filmo v1 no envía webhooks, así que mantienes otro sistema sincronizado consultando periódicamente: lee lo que cambió en ventanas de tiempo semiabiertas y ejecuta un barrido aparte para encontrar lo que se eliminó. No sigas el cursor de paginación para decidir qué cambió o qué desapareció.

¿Te ha resultado útil esta página?