Obras are the central entity in Sintesis. Each obra belongs to a tenant and represents a construction contract with financial and scheduling data.
List obras Returns all obras for the authenticated user’s active tenant. Supports pagination, sorting, full-text search, and range filters.
Query parameters Page number (1-indexed). Enables paginated mode when provided alongside limit.
Results per page. Clamped between 1 and 500.
Column to sort by. Allowed values: n, designacion_y_ubicacion, sup_de_obra_m2, entidad_contratante, mes_basico_de_contrato, iniciacion, contrato_mas_ampliaciones, certificado_a_la_fecha, saldo_a_certificar, segun_contrato, prorrogas_acordadas, plazo_total, plazo_transc, porcentaje, updated_at.
Sort direction: asc or desc.
Filter by completion status. Accepted values: completed (porcentaje = 100) or in-process (porcentaje < 100).
Full-text search across designacion_y_ubicacion, entidad_contratante, mes_basico_de_contrato, iniciacion, and numeric fields.
Minimum surface area (m²).
Maximum surface area (m²).
Minimum completion percentage.
Maximum completion percentage.
Filter by one or more contracting entities. Repeat the parameter for multiple values: ?entidad=MUNICIPIO&entidad=PROVINCIA.
Filter mes_basico_de_contrato by year substring.
Filter iniciacion by year substring.
Numeric range filters are also available for contrato_mas_ampliaciones (cmaMin/cmaMax), certificado_a_la_fecha (cafMin/cafMax), saldo_a_certificar (sacMin/sacMax), segun_contrato (scMin/scMax), prorrogas_acordadas (paMin/paMax), plazo_total (ptMin/ptMax), and plazo_transc (ptrMin/ptrMax).
Response Array of obra objects. Sequential obra number within the tenant.
Name and location of the project.
Surface area in square meters.
Contract value including extensions.
Amount certified to date.
Remaining amount to certify.
Value per original contract.
Agreed extensions amount.
Total contract term (days).
Completion percentage (0–100).
ISO 8601 timestamp of last update.
Key-value map of tenant-defined custom column values.
Message sent on first completion notification.
Message sent on follow-up completion notification.
ISO 8601 timestamp for the follow-up message.
Present only when page or limit query params are supplied. Show Pagination properties
false if the tenant database does not yet have the on_finish_* columns (older schema).
curl 'https://<domain>/api/obras?page=1&limit=20&orderBy=n&status=in-process' \ --cookie 'sb-access-token=<session>'
{ "detalleObras" : [ { "id" : "a1b2c3d4-..." , "n" : 1 , "designacionYUbicacion" : "Escuela N° 42 — Barrio Norte" , "supDeObraM2" : 1200 , "entidadContratante" : "MUNICIPIO" , "mesBasicoDeContrato" : "enero 2023" , "iniciacion" : "marzo 2023" , "contratoMasAmpliaciones" : 5000000 , "certificadoALaFecha" : 2500000 , "saldoACertificar" : 2500000 , "segunContrato" : 4800000 , "prorrogasAcordadas" : 200000 , "plazoTotal" : 365 , "plazoTransc" : 180 , "porcentaje" : 50 , "updatedAt" : "2024-06-15T10:30:00Z" , "customData" : {}, "onFinishFirstMessage" : null , "onFinishSecondMessage" : null , "onFinishSecondSendAt" : null } ], "pagination" : { "page" : 1 , "limit" : 20 , "total" : 1 , "totalPages" : 1 , "hasNextPage" : false , "hasPreviousPage" : false }, "supportsConfigColumns" : true }
Bulk upsert obras Replaces the entire obras list for the tenant. Records present in the current tenant but absent from the payload are deleted. New obras automatically have tenant-level defaults applied (folders, tablas).
When an obra transitions from porcentaje < 100 to porcentaje = 100, an obra.completed workflow event is emitted and any configured flujo actions are executed.
Request body Full array of obras to persist. Each item must conform to the obra schema. Obra number — unique per tenant.
Contract value including extensions.
Amount certified to date.
Remaining amount to certify.
Value per original contract.
Total contract term (days).
Custom column values (keys must match tenant’s enabled custom column IDs).
Response curl -X PUT 'https://<domain>/api/obras' \ --cookie 'sb-access-token=<session>' \ --header 'Content-Type: application/json' \ --data '{ "detalleObras": [ { "n": 1, "designacionYUbicacion": "Escuela N° 42 — Barrio Norte", "supDeObraM2": 1200, "entidadContratante": "MUNICIPIO", "mesBasicoDeContrato": "enero 2023", "iniciacion": "marzo 2023", "contratoMasAmpliaciones": 5000000, "certificadoALaFecha": 2500000, "saldoACertificar": 2500000, "segunContrato": 4800000, "prorrogasAcordadas": 200000, "plazoTotal": 365, "plazoTransc": 180, "porcentaje": 50 } ] }'
Get a single obra Returns a single obra by UUID.
Path parameters Response The obra object. See field definitions under List obras . curl 'https://<domain>/api/obras/a1b2c3d4-...' \ --cookie 'sb-access-token=<session>'
{ "obra" : { "id" : "a1b2c3d4-..." , "n" : 1 , "designacionYUbicacion" : "Escuela N° 42 — Barrio Norte" , "porcentaje" : 50 } }
Replace a single obra Fully replaces all fields of an existing obra. Completion side-effects (workflow events, flujo actions) fire if porcentaje transitions to 100.
Path parameters Request body All obra fields (same schema as the bulk PUT body items, excluding n as identifier — the id path param is authoritative).
Response Partially update a single obra Updates only the supplied fields of an obra. Omitted fields are left unchanged. Completion side-effects fire if porcentaje transitions to or from 100.
Path parameters Request body Any subset of obra fields.
Response curl -X PATCH 'https://<domain>/api/obras/a1b2c3d4-...' \ --cookie 'sb-access-token=<session>' \ --header 'Content-Type: application/json' \ --data '{ "porcentaje": 100 }'
Delete a single obra Permanently deletes an obra and all its related data (cascaded by the database).
Path parameters Response Bulk patch obras Upserts multiple obras in a single request. Unlike PUT /api/obras, this endpoint does not delete obras absent from the payload. Defaults are applied to newly created obras.
Request body Array of obra objects to upsert. Each item must include either id (UUID) or a positive n value as identifier. Minimum 1 item.
Response Number of obras processed.
Whether on_finish_* columns are available in this tenant’s schema.
Get certificates for an obra GET /api/obras/{id}/certificates
Returns all certificates linked to the specified obra, ordered by certificate number ascending.
Path parameters Response Array of certificate objects. Show Certificate properties
Certificate sequence number.
Status (e.g. CERTIFICADO).
ISO 8601 creation timestamp.
ISO 8601 update timestamp.
Sum of all certificate amounts.
Create a certificate for an obra POST /api/obras/{id}/certificates
Creates a new certificate linked to an obra.
Path parameters Request body Certificate sequence number.
estado
string
default: "CERTIFICADO"
Certificate status.
Response The newly created certificate object.
Get findings for an obra GET /api/obras/{id}/findings
Returns reporting findings (anomalies, alerts, or insights) for the specified obra.
Path parameters Query parameters Optional period key to scope findings to a specific reporting period.
Response Array of finding objects. Structure depends on the reporting rules configured for the tenant.
Get material orders for an obra GET /api/obras/{id}/materials
Returns all material purchase orders associated with an obra, including their line items.
Path parameters Response Array of material order objects. Show MaterialOrder properties
Storage bucket name for attached document.
Storage path for attached document.
Create a material order for an obra POST /api/obras/{id}/materials
Creates a new material purchase order with line items.
Path parameters Request body Storage bucket for attached document.
Storage path for attached document.
Line items. Must contain at least one item. Response UUID of the newly created order.
