Core API
Published changes for Core API.
13 August 2026
| Area | Change type | Description |
|---|---|---|
| Administração | Change | More predictable tenant cache Tenant cache lifetimes were revised by data category (reference, master data, documents, dashboards and operational data), affecting all gateway APIs. Layout and listing configuration changes now refresh the cache immediately, instead of waiting for expiry alone. `POST /gateway/cache/clear` still clears the entire cache for the authenticated tenant. How to upgrade After manual changes in the database, call `POST /gateway/cache/clear` if you still see stale data. |
| SAT | Addition | Service order close preview New endpoint to inspect pre-close checks (open interventions and invoice presence) without changing the order. |
| SAT | Addition | Close a service order New endpoint to close a service order, recording the state history. With open interventions, `concludeOpenInterventions: true` is required (otherwise `409 Conflict`). |
| SAT | Addition | Reopen a service order New endpoint to reopen a previously closed service order, recording the state history. |
| SAT | Addition | Indicate whether the order already has an invoice New endpoint that indicates whether the order has at least one non-voided invoice (types FT/FR/FS). |
| SAT | Addition | Documents issued from the service order New endpoint to list documents (e.g. invoices) issued from a service order. |
| SAT | Addition | Service order printing data New endpoint with enriched data to render the List & Label print layout for the service order. |
| SAT | Addition | Associate an intervention with a service order New endpoint to associate an existing intervention with a service order. |
| SAT | Addition | Remove an intervention from a service order New endpoint to remove (soft delete) an intervention linked to a service order. |
| SAT | Addition | Get service order by series and number New endpoint to retrieve a service order by series and number (ticket identifier). |
| SAT | Addition | Next service order number for a series New endpoint that returns the next available number for a service order series. |
| SAT | Addition | Service order digital archive root New endpoint to get the root digital archive directory for service orders.
|
| SAT | Addition | Digital archive for a service order New endpoint to get the digital archive directory associated with a service order.
|
| SAT | Addition | SAT module configuration New endpoints to get and update SAT module configuration (`GET`/`PUT /gateway/sat-config`). |
6 August 2026
| Area | Change type | Description |
|---|---|---|
| Administração | Addition | Terminals, cache and extra fields Administration: terminal management (CRUD, next-id, `GET /gateway/terminal/configuration`), cache clear and configurable extra fields (`extra-tables-fields-config`). |
| Conta corrente | Addition | Balance aging enquiry Balance-aging enquiry (`balance`, `notDue`, `overdue0To30` … `points`) and recalculation via `POST .../balance-aging/recalculate`. Engine rules: payments with `SendToCheckingAccount` post to the current account; they cannot be mixed with immediate payments; FR does not accept current account. |
| Contratos | Addition | Customer contracts and covenants Customer contracts (`entity-contract`), types, groups and covenant models (`covenants-agreement`), with CRUD, next-id and entity assignment. |
| CRM | Addition | CRM module New CRM module: customer workspace, sales, lines, receipts, payment details, history/occurrences and configuration tables (`crm-config`). Guides: crm-config, crm-current-account, crm-customer-workspace. |
| Faturação | Addition | Convertible document types Conversion matrix: lists document types that can be converted into the given target type (e.g. FT returns GR, GT, …). |
| Plataforma | Breaking change | PUT now requires the id in the URL Several PUT operations no longer accept the collection path and now require the identifier in the URL, with partial-update DTOs (`*UpdateDTO` — only sent fields are changed): `/gateway/warehouse/{id}`, `/gateway/currency/{keyId}`, `/gateway/payment-mode/{id}`, `/gateway/payment-type/{id}`, `/gateway/itemsgroups/{id}`, `/gateway/sales-zone/{id}`, `/gateway/delivery-region/{id}`, `/gateway/address-type/{id}`, `/gateway/customer-contacts/{id}`, `/gateway/points-config/{id}`. How to upgrade Call PUT `.../{id}` (or `{keyId}` for currency). Send only the fields to change. `EntityGuid` is now generated on create and is immutable afterwards. |
| Plataforma | Deletion | Removed GET entity-layout `GET /gateway/entity-layout/{entityList}` has been removed.
How to upgrade Remove calls to this endpoint. Use the extra-tables / layout configuration documented in the Core API. |
| Plataforma | Change | Combined login and RFC 9110 errors Combined login is the recommended flow for the whole API (required for reports/charts). `Idempotency-Key` is required on replay-sensitive POSTs. Errors follow RFC 9110 with `errors[].code`. `documentTypeId` is not portable across customer databases — resolve via `GET /gateway/document-type`. |
| SAT | Addition | Service / SAT Service / SAT: equipment (brand/model/type), interventions (CRUD, billing, printing-data, digital archive), service orders, RMA/returns and accessories. |