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 |
|---|---|
draft | draft |
reserved | reserved |
prepared_partiallyprepared | preparedIncluye la preparación parcial. |
picked_up | in_useRecogido o en uso. |
returned_partiallyreturnedchecked_in_partially | returnedIncluye la devolución parcial y la recepción parcial. |
checked_in | completedRecibido y completado. |
cancelled | cancelled |
- La descripción del filtro no coloca en ningún grupo
picked_up_partiallyniarchived.archivedaparece entre los valores del DTO, pero un pedido archivado no se puede listar ni leer.
El campo status de un pedido muestra el estado en bruto, uno de 12 valores. El filtro status de GET /api 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 |
|---|---|
draft | draft |
reserved | reserved |
prepared_partially, prepared | prepared (incluye la preparación parcial) |
picked_up | in_use (entregado o en uso) |
picked_up_partially | in_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, returned | returned (incluye la devolución parcial) |
checked_in_partially | returned (incluye la recepción parcial) |
checked_in | completed (recepcionado y completado) |
cancelled | cancelled |
archived | Ninguno. 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.
Facturas
Enlace a esta sección: Facturasstatus 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.
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 devuelve únicamente documentos de tipo factura.
| Campo | Valor | Significado |
|---|---|---|
status | draft | Aún sin validar |
status | validated | Validada y numerada |
status | voided | Anulada |
paymentStatus | unpaid | Todavía no se ha cobrado nada, también en facturas sin un cobro registrado |
paymentStatus | partially_paid | Parte del total cobrado |
paymentStatus | paid | Cobrado por completo |
paymentStatus | overpaid | Cobrado por encima del total |
paymentStatus | overdue | Vencido y sin pagar |
paymentStatus | voided | El documento se anula, sea cual sea lo cobrado antes |
Presupuestos
Enlace a esta sección: PresupuestosUn 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 lo cambia. Confirmar una versión deja las demás como superseded.
| Campo | Valor | Significado |
|---|---|---|
status | draft | Aún sin validar |
status | validated | Validada y numerada |
operativeStatus | pending | A la espera de respuesta |
operativeStatus | confirmed | Aceptado |
operativeStatus | cancelled | Rechazado o cancelado |
operativeStatus | superseded | Sustituido por otra versión |
Todos los enums de estado
Enlace a esta sección: Todos los enums de estadoEsta 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.
| Campo | Valores |
|---|---|
ContactDto. | active, inactive, archived |
ContactDetailDto. | active, inactive, archived |
RelatedContactDto. | active, inactive, archived |
OrderDto. | draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled |
OrderDetailDto. | draft, reserved, prepared_partially, prepared, picked_up_partially, picked_up, returned_partially, returned, checked_in_partially, checked_in, archived, cancelled |
OrderLineDto. | draft, reserved, prepared, picked_up, sold, returned, checked_in, cancelled, lost |
InvoiceDto. | draft, validated, voided |
InvoiceDto. | unpaid, partially_paid, paid, overpaid, overdue, voided |
InvoiceDetailDto. | draft, validated, voided |
InvoiceDetailDto. | unpaid, partially_paid, paid, overpaid, overdue, voided |
QuoteDto. | draft, validated |
QuoteDto. | pending, confirmed, cancelled, superseded |
QuoteDetailDto. | draft, validated |
QuoteDetailDto. | pending, confirmed, cancelled, superseded |
ProjectDto. | draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived |
ProjectDetailDto. | draft, budgeted, confirmed, in_progress, invoiced, completed, cancelled, archived |
RepairTicketDto. | draft, sent, partially_converted, fully_invoiced, closed |
RepairTicketDetailDto. | draft, sent, partially_converted, fully_invoiced, closed |
VehicleDto. | active, maintenance, inactive |
SubrentDto. | pending, active, completed, cancelled |
PurchaseOrderDto. | draft, pending, completed, cancelled |
ContractDto. | draft, validated, voided |
ContractDto. | pending, signed, cancelled |
OpportunityDto. | open, won, lost |
OpportunityDetailDto. | open, won, lost |
TreasuryAccountDto. | active, needs_reauth, disconnected, archived |
CreditNoteDto. | draft, validated, voided |
OrderLineReturnResultDto. | returned, failed |
UserDto. | active, pending, inactive |
Páginas relacionadas
Enlace a esta sección: Páginas relacionadasConceptos 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
sorty los filtros de tiempocreated*yupdated*, muchas aceptan filtros con lista de valores comostatuses, y algunas aceptanqpara 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?