ET"}]] 124:["List SAF-T D406 generations, newest first (scope: saft:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 125:["List SAF-T D406 imports, newest first (scope: imports:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 126:["Verify the uploaded file (size + sha256) and parse it into a preview. 409 when not uploaded yet or not awaiting_upload; 410 past retention; 422 on a size/checksum mismatch or an unparseable file. (scope: saft_import:write)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 127:["Get a sales channel with sync health (scope: orders:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 128:["List sales channels (eMAG, WooCommerce, Trendyol, …) with sync health; credentials are never returned (scope: orders:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 129:["List document numbering series (read-only)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 12a:["Cancel the AWB at the courier and mark the shipment cancelled. 409 ALREADY_FINAL / CANCEL_UNSUPPORTED. Honours Idempotency-Key. (scope: shipping:write)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 12b:["Create an AWB at a courier — a real cost. Sender is the organisation; the pickup point is re-validated; the label is stored. 409 COURIER_NOT_CONFIGURED / SENDER_MISSING; 422 POINT_*. Requires Idempotency-Key. (scope: shipping:write)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 12c:["Get a shipment (scope: shipping:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 12d:["Download the AWB label (PDF, or ZPL with format=zpl) (scope: shipping:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 12e:["Refresh tracking from the courier and return the shipment with all events (scope: shipping:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 12f:["List shipments (AWBs), newest first (scope: shipping:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 130:["Price a parcel at every configured courier in parallel and compare (cheapest real tariff first). Creates nothing. Heavy rate tier. (scope: shipping:read)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 131:["Search lockers, partner shops and courier offices (global data, refreshed daily). One anchor required: near, city, postal_code or q. (scope: shipping:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 132:["List hosted sites (scope: sites:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 133:["Get a space transfer; 404 unless this organization is a party (scope: space_transfers:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 134:["List space transfers this organization sent or received, newest first. Read-only (scope: space_transfers:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 135:["Add a resource of this organization to a space (moves it from another space). Honours Idempotency-Key. (scope: spaces:write)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 136:["Create a space. Honours Idempotency-Key. (scope: spaces:write)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 137:["Delete a space. Its members are released, never deleted. Honours Idempotency-Key. (scope: spaces:write)"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 138:["Remove a resource from a space; the resource itself is untouched. Honours Idempotency-Key. (scope: spaces:write)"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 139:["Get a space with its members (scope: spaces:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 13a:["List spaces, by name (scope: spaces:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 13b:["Update a space. Honours Idempotency-Key. (scope: spaces:write)"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 13c:["Create a recurring subscription (scope: payments:charge)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 13d:["Cancel at period end (scope: payments:charge)"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 13e:["Get a merchant subscription (scope: invoices:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 13f:["List merchant subscriptions (scope: invoices:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 140:["Cancel / resume / change price (scope: payments:charge)"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 141:["Report usage for a metered price (Stripe Billing Meter event; identifier makes retries no-ops; scope: payments:charge)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 142:["Romanian VAT rates valid on a date"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 143:["Get a time entry"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 144:["List time entries (read-only)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 145:["Get a trip sheet (foaie de parcurs). driver_name needs fleet_drivers:read (scope: fleet:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 146:["Create a digital signature or seal (scope: trust:sign)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 147:["Batch sign up to 100 documents (scope: trust:sign)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 148:["Timestamp a signed document (scope: trust:timestamp)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 149:["Validate a signed document (scope: trust:validate)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 14a:["Get a signature by id (scope: trust:sign)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 14b:["Get a validation result (scope: trust:validate)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 14c:["List available trust providers (scope: trust:providers)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 14d:["Get evidence bundles for a signature (scope: trust:evidence)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 14e:["A customer with open ISSUED invoices changed fiscal status at ANAF or the trade registry: became inactive (art. 92 CPF) or was reactivated, was struck off or dissolved, entered insolvency, registered or deregistered for VAT, or entered or left TVA la încasare. Checked daily; the first observation of a contact is a baseline and emits nothing. Idempotent: id = evt_fsc___, where kind and date are those of the first entry in changes."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 14f:["A hearing was added to a court case. Case and hearing ids, date and court only; no parties, panel, solution or notes. Idempotent: id evt_court_hearing_."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 150:["A delivery route was dispatched: the route sheet was sent to its driver and the route is DISPATCHED. Ids and counts only (no driver contact, recipients or addresses). A re-dispatch is a new event. Id evt_delivery_route__dispatched_."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 151:["An inbound message landed in one of the organisation's Brivio mailboxes (inbox or a custom folder; not spam, trash, drafts or its own outbound mail; history imported by a first sync is not announced). Metadata only — never the body, snippet, cc/bcc or attachment names. Idempotent per stored message: a re-sync never announces it twice."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 152:["A fleet vehicle was added (in the app or through the API). Idempotent: id evt_fleet_vehicle__created."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 153:["A fleet vehicle was deleted, with its odometer and service logs. Idempotent: id evt_fleet_vehicle__del."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 154:["A fleet vehicle changed. changed_fields lists the wire names of the fields whose value changed, never the values; an edit that changes nothing emits nothing. Id evt_fleet_vehicle__upd_."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 155:["A credit note (storno) reversing an ISSUED invoice was issued or cancelled and changed the source invoice's credited amount. A storno cancels debt — it is not a payment. Idempotent per credited amount: id = evt_cred__, so a re-sync landing on the same amount is a re-delivery of the same event."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 156:["An ISSUED invoice was settled in full. Fires from every path that records money — manual entry, bank match, card settlement (Stripe/Netopia/Revolut), honoured instrument, collective receipt, Telegram. Idempotent per payment: `id` = `evt_pay_`."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 157:["A payment was recorded against an ISSUED invoice and a balance remains. Same producers and idempotency as invoice.paid; `remaining_amount` is the balance still open."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 158:["A recorded payment on an ISSUED invoice was reversed and the balance re-opened. Idempotent per reversal row (evt_rev_); reversal.reverses_payment_id names the payment to undo."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 159:["A merchant catalog subscription (POST /v1/subscriptions) became active or trialing — first payment confirmed, or recovered from past_due. Idempotent per underlying Stripe event: `id` = `evt_sub_`."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 15a:["A merchant catalog subscription ended (canceled or incomplete_expired). Revoke access here. Same idempotency as subscription.activated."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 15b:["A merchant catalog subscription changed status, renewed (new current_period_end) or toggled cancel_at_period_end. Same idempotency as subscription.activated."," ",["$","span",null,{"className":"ms-auto border border-current px-1 rounded-lg text-xs text-nowrap font-mono","children":"Webhook"}]] 15c:["Record a trip sheet (foaie de parcurs) for a registry vehicle. Honours Idempotency-Key. (scope: fleet:write)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 15d:["Get a registry vehicle (scope: fleet:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 15e:["List registry vehicles, by plate (scope: fleet:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 15f:["List a registry vehicle's trip sheets (foi de parcurs), newest first; 404 when the vehicle is not in this organization. driver_name needs fleet_drivers:read (scope: fleet:read)"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 160:["Create a webhook subscription"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 161:["Delete a webhook subscription"," ",["$","span",null,{"className":"font-mono font-medium text-red-600 dark:text-red-400 ms-auto text-xs text-nowrap","children":"DELETE"}]] 162:["Get a webhook subscription"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 163:["List delivery attempts for a webhook"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 164:["List available webhook event types"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 165:["List webhook subscriptions"," ",["$","span",null,{"className":"font-mono font-medium text-green-600 dark:text-green-400 ms-auto text-xs text-nowrap","children":"GET"}]] 166:["Redeliver a failed/dead delivery — resets the attempt budget and schedules it due-now; pass {\"force\":true} to redeliver an already-succeeded delivery (scope: webhooks:write)"," ",["$","span",null,{"className":"font-mono font-medium text-blue-600 dark:text-blue-400 ms-auto text-xs text-nowrap","children":"POST"}]] 167:["Update a webhook subscription (set rotate_secret to rotate the signing secret)"," ",["$","span",null,{"className":"font-mono font-medium text-orange-600 dark:text-orange-400 ms-auto text-xs text-nowrap","children":"PATCH"}]] 168:["$","$L3",null,{"parallelRouterKey":"children","error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L4",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":"$undefined","forbidden":"$undefined","unauthorized":"$undefined"}] 16a:["$","$1","c",{"children":[null,["$","$L3",null,{"parallelRouterKey":"children","error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L4",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":"$undefined","forbidden":"$undefined","unauthorized":"$undefined"}]]}] 16d:["$","$1","c",{"children":["$L176",[["$","script","script-0",{"src":"/_next/static/chunks/15096i4urbrfu.js","async":true,"nonce":"$undefined"}],["$","script","script-1",{"src":"/_next/static/chunks/267-0ffzvalzi.js","async":true,"nonce":"$undefined"}],["$","script","script-2",{"src":"/_next/static/chunks/3l4ayn197w3v0.js","async":true,"nonce":"$undefined"}],["$","script","script-3",{"src":"/_next/static/chunks/1nk-uc8g74wap.js","async":true,"nonce":"$undefined"}],["$","script","script-4",{"src":"/_next/static/chunks/0nr-j6wxmhl-u.js","async":true,"nonce":"$undefined"}],["$","script","script-5",{"src":"/_next/static/chunks/18f6acdz9cujg.js","async":true,"nonce":"$undefined"}]],["$","$L177",null,{"children":["$","$173",null,{"name":"Next.MetadataOutlet","children":"$@178"}]}]]}] 16b:C 184:T4e0,Same pipeline as `/emails/send` (verified sender domain, fail-closed suppression, Safe Mode, outbox retry, `email.*` webhooks) with a flatter wire shape: addresses are strings (`"Ana "`), `tags` is a key→value map, custom headers are allowed except envelope/MIME/authentication ones (From, To, Cc, Bcc, Subject, Reply-To, Message-ID, Date, Content-Type, DKIM-Signature, ARC-*, …; no CR/LF). `category` defaults to `transactional`; `auth` and `alert` are aliases for `transactional` and `notification`; `marketing` → 422. `from` on an unverified domain → 422 `from_domain_not_verified`; omit it for the org default sender. A `from` that no sending identity may send as → 422 `sender_identity_missing` (nothing recorded): use the sending address of the domain, or a hosted mailbox / alias with API sending enabled. 202 whenever the message is recorded — `status` is `sent`, `queued` (including a transport failure parked for retry) or `suppressed` (non-error). A transport refusal that could not be queued → 502 `send_failed`. `id`, `status` and `suppressed` are mirrored at the top level of the 202 body for clients that read them there. Honours `Idempotency-Key`. Shares the 600/h per-organisation limit with `/emails/send`.176:["$","$L17f",null,{"toc":[],"children":[["$","$L180",null,{"children":"List available webhook event types"}],["$","$L181",null,{"children":"$undefined"}],["$","$L182",null,{"children":["$","$L183",null,{"payload":{"bundled":{"openapi":"3.2.0","info":{"title":"Brivio API","version":"1.0.0","description":"Public REST API for Brivio — invoicing, contacts, articles, locations and module entitlements. Authenticate with a Bearer API key (brivio_sk_live_… / brivio_sk_test_…)."},"servers":[{"url":"https://api.brivio.ro/v1"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key as Bearer token"}},"schemas":{"Meta":{"type":"object","properties":{"page":{"type":"integer"},"perPage":{"type":"integer"},"total":{"type":"integer"},"totalPages":{"type":"integer"},"nextCursor":{"type":"string","nullable":true}}},"Error":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]},"BankRuleInput":{"type":"object","description":"A bank reconciliation rule. At least one condition (matchCounterpartyName, matchCounterpartyIban, matchDescription/Regex, amountMin/Max, direction != any) and one action (assignContactId, assignAccountId, assignCostCenterId, assignVatRate, descriptionTemplate, markIgnored, memo) are required.","properties":{"name":{"type":"string","maxLength":200},"isActive":{"type":"boolean","default":true},"stagingMode":{"type":"string","enum":["recognized","categorized"],"default":"recognized"},"matchCounterpartyName":{"type":"string","nullable":true,"maxLength":255},"matchCounterpartyIban":{"type":"string","nullable":true,"maxLength":40},"matchDescriptionRegex":{"type":"string","nullable":true,"maxLength":500},"matchDescription":{"type":"string","nullable":true,"maxLength":500},"matchDescriptionOp":{"type":"string","enum":["contains","starts_with","equals","regex"],"default":"contains"},"amountMin":{"type":"string","nullable":true,"description":"Decimal, up to 2 dp"},"amountMax":{"type":"string","nullable":true,"description":"Decimal, up to 2 dp"},"direction":{"type":"string","enum":["any","inflow","outflow"],"default":"any"},"assignContactId":{"type":"string","format":"uuid","nullable":true},"assignAccountId":{"type":"string","format":"uuid","nullable":true},"assignCostCenterId":{"type":"string","format":"uuid","nullable":true},"assignVatRate":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"descriptionTemplate":{"type":"string","nullable":true,"maxLength":500},"markIgnored":{"type":"boolean","default":false},"memo":{"type":"string","nullable":true,"maxLength":2000}}},"Contact":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["CLIENT","SUPPLIER","BOTH"]},"person_type":{"type":"string","enum":["INDIVIDUAL","COMPANY"]},"name":{"type":"string"},"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"vat_number":{"type":"string","nullable":true},"is_active":{"type":"boolean"}}},"ContactCreate":{"type":"object","required":["name"],"properties":{"type":{"type":"string","enum":["CLIENT","SUPPLIER","BOTH"]},"person_type":{"type":"string","enum":["INDIVIDUAL","COMPANY"]},"name":{"type":"string"},"email":{"type":"string"},"vat_number":{"type":"string"}}},"Article":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["PRODUCT","SERVICE","BUNDLE"]},"name":{"type":"string"},"default_price":{"type":"string","nullable":true},"currency":{"type":"string"},"unit":{"type":"string"},"vat_rate":{"type":"string"},"bundle":{"$ref":"#/components/schemas/BundleSettings"}}},"BundleSettings":{"type":"object","description":"Kit settings (type=BUNDLE only, ADR-0225).","properties":{"discount_percent":{"type":"string","nullable":true},"composite_supply":{"type":"boolean"},"principal_component_id":{"type":"string","format":"uuid","nullable":true},"return_policy":{"type":"string","enum":["per_component","whole_only"]},"valid_from":{"type":"string","format":"date","nullable":true},"valid_to":{"type":"string","format":"date","nullable":true},"explode_on_invoice":{"type":"boolean"}}},"BundleComponent":{"type":"object","required":["component_article_id","quantity"],"properties":{"component_article_id":{"type":"string","format":"uuid"},"quantity":{"type":"number"},"is_optional":{"type":"boolean"},"option_group":{"type":"string","nullable":true},"substitutes":{"type":"array","items":{"type":"string","format":"uuid"}}}},"ArticleCreate":{"type":"object","required":["name"],"properties":{"type":{"type":"string","enum":["PRODUCT","SERVICE","BUNDLE"]},"name":{"type":"string"},"default_price":{"type":"number"},"vat_rate":{"type":"number"},"bundle_discount_percent":{"type":"number","nullable":true},"bundle_composite_supply":{"type":"boolean"},"bundle_principal_component_id":{"type":"string","format":"uuid","nullable":true},"bundle_return_policy":{"type":"string","enum":["per_component","whole_only"]},"bundle_valid_from":{"type":"string","format":"date","nullable":true},"bundle_valid_to":{"type":"string","format":"date","nullable":true},"explode_on_invoice":{"type":"boolean"}}},"Invoice":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string"},"direction":{"type":"string"},"series":{"type":"string","nullable":true},"number":{"type":"integer"},"status":{"type":"string","description":"DRAFT, SENT, VIEWED, PAID, PARTIALLY_PAID, OVERDUE, CANCELLED, PENDING_REVIEW or CREDITED. CREDITED = fully reversed by issued credit notes (storno): nothing is owed and the invoice is never chased; an issued credit note linked to its source is CREDITED too (applied)."},"contact_id":{"type":"string"},"company_id":{"type":"string","format":"uuid","nullable":true,"description":"Issuing legal entity the number was allocated under."},"currency":{"type":"string"},"exchange_rate":{"type":"string","description":"RON per 1 unit of `currency`, persisted per document (BNR T-1, Cod Fiscal art. 290 / ADR-0029). \"1.000000\" for RON."},"vat_type":{"type":"string","enum":["TAXABLE","REVERSE_CHARGE","INTRA_COMMUNITY","EXPORT","VAT_EXEMPT","NON_TAXABLE","MARGIN"]},"vat_exemption_reason":{"type":"string","nullable":true},"subtotal":{"type":"string"},"vat_total":{"type":"string"},"total":{"type":"string"},"paid_amount":{"type":"string"},"credited_amount":{"type":"string","description":"Sum of the issued credit notes reversing this invoice. Open balance = total − paid_amount − credited_amount."}}},"InvoiceCreate":{"type":"object","required":["issue_date","due_date","items"],"description":"Exactly one of `contact_id` or `contact_external_id` is required. Issued documents are numbered by the same gapless per-(company, series, year) allocator the app uses (ADR-0208); the `series` defaults to `BRV`. Non-RON documents carry the BNR T-1 reference rate for `issue_date` unless a positive `exchange_rate` is supplied — when the rate cannot be obtained the request fails with 422 `EXCHANGE_RATE_UNAVAILABLE`, never a silent rate of 1.","properties":{"type":{"type":"string","enum":["INVOICE","PROFORMA","QUOTE","RECEIPT","CREDIT_NOTE"]},"direction":{"type":"string","enum":["ISSUED","RECEIVED"],"default":"ISSUED"},"series":{"type":"string","description":"Numbering series; defaults to `BRV` for issued documents."},"contact_id":{"type":"string","format":"uuid"},"contact_external_id":{"type":"string","maxLength":255,"description":"Your own identifier for the contact, resolved through the external reference map (source `api`, entity `contact`). Used only when `contact_id` is absent; unknown → 404 `CONTACT_NOT_FOUND`."},"company_id":{"type":"string","format":"uuid","description":"Issuing legal entity. Optional when the organization has a single active company; required (422) when it has several."},"project_id":{"type":"string"},"issue_date":{"type":"string","format":"date"},"due_date":{"type":"string","format":"date"},"currency":{"type":"string","default":"RON"},"exchange_rate":{"type":"number","exclusiveMinimum":0,"description":"RON per 1 unit of `currency`. Omit to have the BNR T-1 reference rate fetched server-side (recommended). A supplied value is persisted as-is; ignored for RON."},"vat_type":{"type":"string","enum":["TAXABLE","REVERSE_CHARGE","INTRA_COMMUNITY","EXPORT","VAT_EXEMPT","NON_TAXABLE","MARGIN"],"description":"VAT regime of the document. When omitted it is derived from the contact: RO → TAXABLE; EU (non-RO) with a VAT number → INTRA_COMMUNITY (reverse charge, UBL category AE); EU without VAT number → TAXABLE; non-EU → EXPORT. Only TAXABLE carries line VAT."},"vat_exemption_reason":{"type":"string","maxLength":500,"description":"Legal mention printed and emitted for non-TAXABLE regimes."},"notes":{"type":"string"},"items":{"type":"array","items":{"type":"object","required":["description","quantity","unit_price"],"properties":{"article_id":{"type":"string"},"description":{"type":"string"},"quantity":{"type":"number"},"unit":{"type":"string","default":"buc"},"unit_price":{"type":"number"},"vat_rate":{"type":"number"}}}}}},"InvoicePaymentCreate":{"type":"object","required":["amount","payment_date"],"properties":{"amount":{"type":"number"},"currency":{"type":"string"},"payment_date":{"type":"string","format":"date"},"method":{"type":"string","enum":["CASH","BANK_TRANSFER","CARD","PAYPAL","STRIPE","OTHER"]},"reference":{"type":"string"},"notes":{"type":"string"}}},"Location":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"code":{"type":"string","nullable":true},"vertical_type":{"type":"string","enum":["retail","restaurant","hotel","services","warehouse","professional","generic"]},"is_primary":{"type":"boolean"}}},"LocationCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"code":{"type":"string"},"vertical_type":{"type":"string"},"city":{"type":"string"}}},"Module":{"type":"object","properties":{"key":{"type":"string"},"enabled":{"type":"boolean"},"available":{"type":"boolean"},"reason":{"type":"string","nullable":true}}},"TimeEntry":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"user_id":{"type":"string"},"project_id":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"date":{"type":"string","format":"date"},"start_time":{"type":"string","nullable":true},"end_time":{"type":"string","nullable":true},"duration_minutes":{"type":"integer"},"billable":{"type":"boolean"},"hourly_rate":{"type":"string","nullable":true},"billed":{"type":"boolean"},"invoice_id":{"type":"string","nullable":true},"approval_status":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"Quote":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"series":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"contact_id":{"type":"string","nullable":true},"client_name":{"type":"string","nullable":true},"status":{"type":"string"},"version":{"type":"integer"},"issue_date":{"type":"string","format":"date-time"},"valid_until":{"type":"string","format":"date-time","nullable":true},"currency":{"type":"string"},"subtotal":{"type":"string"},"vat_amount":{"type":"string"},"total":{"type":"string"},"accepted_at":{"type":"string","format":"date-time","nullable":true},"rejected_at":{"type":"string","format":"date-time","nullable":true},"sent_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"AllocationInput":{"type":"object","description":"One person on one project for one ISO week (L-R4-PROJ-07).","required":["user_id","week_start","allocated_hours"],"properties":{"user_id":{"type":"string","format":"uuid"},"week_start":{"type":"string","format":"date","description":"Any date in the week; normalised to its Monday"},"allocated_hours":{"type":"number","minimum":0,"maximum":168,"description":"0 clears the cell"},"role":{"type":"string","nullable":true},"note":{"type":"string","nullable":true}}},"Project":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"slug":{"type":"string"},"status":{"type":"string"},"client_id":{"type":"string","nullable":true},"budget":{"type":"string","nullable":true},"currency":{"type":"string"}}},"ProjectCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"description":{"type":"string"},"status":{"type":"string","enum":["PLANNING","ACTIVE","ON_HOLD","COMPLETED","ARCHIVED"]},"client_id":{"type":"string"},"start_date":{"type":"string","format":"date"},"deadline":{"type":"string","format":"date"},"budget":{"type":"number"},"currency":{"type":"string"}}},"Expense":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"description":{"type":"string"},"category":{"type":"string"},"status":{"type":"string"},"amount":{"type":"string"},"currency":{"type":"string"},"expense_date":{"type":"string","format":"date","nullable":true}}},"ExpenseCreate":{"type":"object","required":["description","amount","expense_date"],"properties":{"description":{"type":"string"},"category":{"type":"string"},"amount":{"type":"number"},"vat_amount":{"type":"number"},"vat_rate":{"type":"number"},"currency":{"type":"string"},"expense_date":{"type":"string","format":"date"},"contact_id":{"type":"string"},"project_id":{"type":"string"}}},"Contract":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"number":{"type":"string","nullable":true},"status":{"type":"string"},"value":{"type":"string","nullable":true},"currency":{"type":"string"},"signature_required":{"type":"boolean"}}},"ContractCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"content":{"type":"string"},"number":{"type":"string"},"contact_id":{"type":"string"},"project_id":{"type":"string"},"value":{"type":"number"},"currency":{"type":"string"},"signature_required":{"type":"boolean"}}},"ContractObligation":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"contract_id":{"type":"string","format":"uuid"},"contract_name":{"type":"string","description":"Only on register (list) rows."},"title":{"type":"string"},"type":{"type":"string","enum":["payment","delivery","report","renewal_notice","custom"]},"due_date":{"type":"string","format":"date","nullable":true},"recurrence":{"type":"string","enum":["none","monthly","quarterly","yearly"]},"remind_days_before":{"type":"integer"},"status":{"type":"string","enum":["pending","overdue","done"]},"bucket":{"type":"string","enum":["overdue","due_soon","upcoming","undated","done"]},"obligor":{"type":"string","enum":["us","counterparty"]},"assignee_user_id":{"type":"string","format":"uuid","nullable":true},"assignee_name":{"type":"string","nullable":true,"description":"Only on register (list) rows."},"clause_label":{"type":"string","nullable":true},"clause_excerpt":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"evidence_document_id":{"type":"string","format":"uuid","nullable":true},"evidence_note":{"type":"string","nullable":true},"has_evidence":{"type":"boolean"},"completed_at":{"type":"string","format":"date-time","nullable":true},"overdue_notified_at":{"type":"string","format":"date-time","nullable":true},"escalated_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"ContractObligationCreate":{"type":"object","required":["contract_id","title"],"properties":{"contract_id":{"type":"string","format":"uuid"},"title":{"type":"string","maxLength":255},"type":{"type":"string","enum":["payment","delivery","report","renewal_notice","custom"]},"due_date":{"type":"string","format":"date","nullable":true},"recurrence":{"type":"string","enum":["none","monthly","quarterly","yearly"]},"remind_days_before":{"type":"integer","minimum":0,"maximum":365},"obligor":{"type":"string","enum":["us","counterparty"]},"assignee_user_id":{"type":"string","format":"uuid","nullable":true,"description":"Must be a member of the organization (ASSIGNEE_NOT_MEMBER)."},"clause_label":{"type":"string","maxLength":80,"nullable":true},"clause_excerpt":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"evidence_document_id":{"type":"string","format":"uuid","nullable":true,"description":"An organization document (DOCUMENT_NOT_FOUND)."},"evidence_note":{"type":"string","maxLength":2000,"nullable":true}}},"ContractObligationUpdate":{"type":"object","description":"Any subset of the create fields except contract_id. Changing due_date resets the overdue notice and escalation.","properties":{"title":{"type":"string","maxLength":255},"type":{"type":"string","enum":["payment","delivery","report","renewal_notice","custom"]},"due_date":{"type":"string","format":"date","nullable":true},"recurrence":{"type":"string","enum":["none","monthly","quarterly","yearly"]},"remind_days_before":{"type":"integer","minimum":0,"maximum":365},"obligor":{"type":"string","enum":["us","counterparty"]},"assignee_user_id":{"type":"string","format":"uuid","nullable":true},"clause_label":{"type":"string","maxLength":80,"nullable":true},"clause_excerpt":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"evidence_document_id":{"type":"string","format":"uuid","nullable":true},"evidence_note":{"type":"string","maxLength":2000,"nullable":true}}},"ContractObligationComplete":{"type":"object","description":"Evidence (a document or a note) is required for our own payment/delivery/report obligations (EVIDENCE_REQUIRED).","properties":{"evidence_document_id":{"type":"string","format":"uuid"},"evidence_note":{"type":"string","maxLength":2000}}},"Document":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"type":{"type":"string"},"file_key":{"type":"string"},"file_name":{"type":"string"},"mime_type":{"type":"string"},"file_size":{"type":"integer"},"is_archived":{"type":"boolean"}}},"DocumentCreate":{"type":"object","required":["name","file_key","file_name","mime_type","file_size"],"properties":{"name":{"type":"string"},"type":{"type":"string","enum":["CONTRACT","INVOICE","RECEIPT","IDENTITY","CERTIFICATE","IMAGE","OTHER"]},"file_key":{"type":"string"},"file_name":{"type":"string"},"mime_type":{"type":"string"},"file_size":{"type":"integer"},"folder_id":{"type":"string"},"project_id":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}},"DnsZone":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"dnssec_enabled":{"type":"boolean"}}},"DnsZoneCreate":{"type":"object","required":["name"],"properties":{"name":{"type":"string"},"template":{"type":"string"}}},"DnsRecordCreate":{"type":"object","required":["type","name","content"],"properties":{"type":{"type":"string"},"name":{"type":"string"},"content":{"type":"string"},"ttl":{"type":"integer"},"priority":{"type":"integer"}}},"Domain":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"locked":{"type":"boolean"}}},"Site":{"type":"object","properties":{"id":{"type":"string"},"domain":{"type":"string"},"status":{"type":"string"},"plan":{"type":"string"}}},"EmailAddress":{"type":"object","properties":{"email":{"type":"string","format":"email","example":"ana@client.ro"},"name":{"type":"string","maxLength":100,"example":"Ana Popescu"}},"required":["email"]},"EmailAttachment":{"type":"object","description":"Base64 payload. All attachments together must decode to at most 2 MB.","properties":{"filename":{"type":"string","example":"factura-2026-0042.pdf"},"content_base64":{"type":"string","format":"byte"},"content_type":{"type":"string","example":"application/pdf"}},"required":["filename","content_base64"]},"EmailSendRequest":{"type":"object","description":"Transactional or notification email sent as the organisation. `from` must be on a VERIFIED sending domain (see /email-domains); omit it to use the default sender. `category: marketing` is refused (422) — use campaigns.","properties":{"to":{"type":"array","minItems":1,"maxItems":50,"items":{"$ref":"#/components/schemas/EmailAddress"}},"cc":{"type":"array","maxItems":50,"items":{"$ref":"#/components/schemas/EmailAddress"}},"bcc":{"type":"array","maxItems":50,"items":{"$ref":"#/components/schemas/EmailAddress"}},"subject":{"type":"string","maxLength":998,"example":"Factura 2026-0042"},"html":{"type":"string","description":"At least one of html / text is required."},"text":{"type":"string"},"from":{"$ref":"#/components/schemas/EmailAddress"},"reply_to":{"$ref":"#/components/schemas/EmailAddress"},"headers":{"type":"object","description":"Allow-listed: X-Entity-Ref-ID, List-Unsubscribe.","additionalProperties":{"type":"string"},"example":{"X-Entity-Ref-ID":"inv_2026_0042"}},"category":{"type":"string","enum":["transactional","notification"],"example":"transactional"},"tags":{"type":"array","maxItems":10,"items":{"type":"string","maxLength":64},"example":["invoice","codai"]},"attachments":{"type":"array","maxItems":20,"items":{"$ref":"#/components/schemas/EmailAttachment"}}},"required":["to","subject","category"]},"EmailMessageSendRequest":{"type":"object","description":"Sibling-application mail (POST /email/send). Addresses are RFC 5322 strings. At least one of html / text is required.","properties":{"from":{"type":"string","maxLength":420,"example":"codai ","description":"Must be on a VERIFIED sending domain; omit for the org default."},"to":{"type":"array","minItems":1,"maxItems":50,"items":{"type":"string","maxLength":420},"example":["ana@client.ro"]},"cc":{"type":"array","maxItems":50,"items":{"type":"string","maxLength":420}},"bcc":{"type":"array","maxItems":50,"items":{"type":"string","maxLength":420}},"reply_to":{"type":"string","maxLength":420},"subject":{"type":"string","minLength":1,"maxLength":998},"html":{"type":"string"},"text":{"type":"string"},"headers":{"type":"object","additionalProperties":{"type":"string","maxLength":2000},"description":"Custom headers. Envelope, MIME and authentication headers are rejected (422); no CR/LF."},"tags":{"type":"object","additionalProperties":{"type":"string","maxLength":256},"description":"Key→value labels; stored as `key:value` tags (first 10)."},"category":{"type":"string","enum":["transactional","notification","marketing","auth","alert"],"default":"transactional","description":"`auth` → transactional, `alert` → notification; `marketing` is refused (use campaigns)."}},"required":["to","subject"]},"EmailMessageAccepted":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"message_id":{"type":"string","description":"SMTP Message-ID set on the outbound mail."},"status":{"type":"string","enum":["queued","sent","suppressed"]},"suppressed_recipients":{"type":"array","items":{"type":"string"}}},"required":["id","message_id","status"]},"error":{"type":"null"},"id":{"type":"string","format":"uuid","description":"Mirror of data.id."},"status":{"type":"string","enum":["queued","sent","suppressed"],"description":"Mirror of data.status."},"suppressed":{"type":"array","items":{"type":"string"},"description":"Mirror of data.suppressed_recipients."}},"required":["data","id","status"]},"EmailRecipient":{"type":"object","properties":{"email":{"type":"string","format":"email"},"name":{"type":"string"},"kind":{"type":"string","enum":["to","cc","bcc"]},"status":{"type":"string","enum":["accepted","suppressed"]}},"required":["email","kind","status"]},"EmailEvent":{"type":"object","properties":{"type":{"type":"string","enum":["email.queued","email.sent","email.delivered","email.bounced","email.complained","email.suppressed"]},"at":{"type":"string","format":"date-time"}},"required":["type","at"]},"Email":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["queued","sent","delivered","bounced","complained","suppressed","failed"],"description":"`queued` also covers a transport failure parked in the retry outbox."},"category":{"type":"string","enum":["transactional","notification"]},"from":{"type":"string","example":"Acme SRL "},"subject":{"type":"string"},"recipients":{"type":"array","items":{"$ref":"#/components/schemas/EmailRecipient"}},"suppressed_recipients":{"type":"array","items":{"type":"string"}},"tags":{"type":"array","items":{"type":"string"}},"message_id":{"type":"string","description":"SMTP Message-ID set on the outbound mail."},"provider_message_id":{"type":"string","nullable":true},"idempotency_key":{"type":"string","nullable":true},"last_error":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"sent_at":{"type":"string","format":"date-time","nullable":true},"delivered_at":{"type":"string","format":"date-time","nullable":true},"bounced_at":{"type":"string","format":"date-time","nullable":true},"complained_at":{"type":"string","format":"date-time","nullable":true},"events":{"type":"array","items":{"$ref":"#/components/schemas/EmailEvent"}}},"required":["id","status","category","from","subject","recipients","created_at","events"]},"EmailDnsRecord":{"type":"object","properties":{"type":{"type":"string","enum":["TXT","MX","CNAME","A","AAAA","SRV"],"example":"TXT"},"name":{"type":"string","example":"stw._domainkey.acme.ro"},"value":{"type":"string","example":"v=DKIM1; k=rsa; p=MIIB..."},"status":{"type":"string","enum":["pending","verified"]}},"required":["type","name","value","status"]},"EmailDomainChecks":{"type":"object","description":"Per-purpose verdicts. `mx` is null when the domain is not hosted by Brivio Mail.","properties":{"ownership":{"type":"boolean","description":"The `_brivio.` TXT (ADR-0185)."},"spf":{"type":"boolean"},"dkim":{"type":"boolean"},"dmarc":{"type":"boolean"},"mx":{"type":"boolean","nullable":true}},"required":["ownership","spf","dkim","dmarc"]},"EmailDomainCreate":{"type":"object","properties":{"domain":{"type":"string","example":"acme.ro"},"from_local_part":{"type":"string","default":"no-reply","example":"facturi"}},"required":["domain"]},"EmailDomain":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"domain":{"type":"string","example":"acme.ro"},"status":{"type":"string","enum":["pending","verified","failed"]},"verified":{"type":"boolean"},"from_local_part":{"type":"string"},"dkim_selector":{"type":"string","nullable":true},"dns_records":{"type":"array","description":"Everything the organisation must publish: ownership TXT, SPF, DKIM, DMARC, MX when hosted.","items":{"$ref":"#/components/schemas/EmailDnsRecord"}},"checks":{"$ref":"#/components/schemas/EmailDomainChecks"},"last_error":{"type":"string","nullable":true},"verified_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","domain","status","verified","dns_records","checks"]},"EmailDomainVerifyResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"verified":{"type":"boolean"},"status":{"type":"string","enum":["pending","verified","failed"]},"checks":{"$ref":"#/components/schemas/EmailDomainChecks"},"dns_records":{"type":"array","items":{"$ref":"#/components/schemas/EmailDnsRecord"}},"last_error":{"type":"string","nullable":true},"sender_identity":{"type":"object","nullable":true,"description":"Whether the verified domain can send as itself (its own SMTP identity, ADR-0210 D10). null while not verified. ready=false means sends From this domain answer 422 sender_identity_missing until fixed.","properties":{"ready":{"type":"boolean"},"mode":{"type":"string","enum":["exists","created","adopted","rotated"]},"reason":{"type":"string","enum":["not_verified","not_configured","no_provider_domain","secret_conflict","error"]}},"required":["ready"]}},"required":["id","verified","status","checks","dns_records"]},"InvoicePaymentWebhookData":{"type":"object","required":["invoice_id","number","currency","total","paid_amount","remaining_amount","status","payment"],"properties":{"invoice_id":{"type":"string","format":"uuid"},"number":{"type":"string","description":"``, e.g. IMS42"},"currency":{"type":"string"},"total":{"type":"string","description":"Decimal string"},"paid_amount":{"type":"string","description":"Decimal string, after this payment"},"credited_amount":{"type":"string","description":"Decimal string (ADR-0279): sum of |total| of the issued credit notes reversing this invoice; 0.00 when none"},"remaining_amount":{"type":"string","description":"Decimal string, total − credited_amount − paid_amount, 0.00 when settled"},"status":{"type":"string","enum":["PAID","PARTIALLY_PAID"]},"payment":{"type":"object","required":["id","amount","payment_date","method","source"],"properties":{"id":{"type":"string","format":"uuid"},"amount":{"type":"string"},"payment_date":{"type":"string","format":"date"},"method":{"type":"string"},"reference":{"type":"string","nullable":true},"source":{"type":"string","enum":["manual","mark_paid","bank_match","provider","instrument","receipt","telegram","api"]}}},"paid_at":{"type":"string","format":"date-time","nullable":true,"description":"Set only on invoice.paid"},"contact_id":{"type":"string","format":"uuid","nullable":true}}},"InvoicePaymentReversedWebhookData":{"type":"object","required":["invoice_id","number","currency","total","paid_amount","remaining_amount","status","reversal"],"properties":{"invoice_id":{"type":"string","format":"uuid"},"number":{"type":"string"},"currency":{"type":"string"},"total":{"type":"string","description":"Decimal string"},"paid_amount":{"type":"string","description":"Decimal string, after the reversal"},"credited_amount":{"type":"string","description":"Decimal string (ADR-0279): sum of |total| of the issued credit notes reversing this invoice; 0.00 when none"},"remaining_amount":{"type":"string","description":"Decimal string, the re-opened balance (total − credited_amount − paid_amount)"},"status":{"type":"string"},"reversal":{"type":"object","required":["id","reverses_payment_id","amount","reversal_date","method","reason"],"properties":{"id":{"type":"string","format":"uuid"},"reverses_payment_id":{"type":"string","format":"uuid","description":"The payment.id previously announced by invoice.paid / invoice.partially_paid"},"amount":{"type":"string","description":"Negative decimal string"},"reversal_date":{"type":"string","format":"date"},"method":{"type":"string"},"reason":{"type":"string"}}},"contact_id":{"type":"string","format":"uuid","nullable":true}}},"InvoiceCreditedWebhookData":{"type":"object","required":["invoice_id","number","currency","total","credited_amount","paid_amount","remaining_amount","refund_due","status","fully_credited","credit_note_id"],"properties":{"invoice_id":{"type":"string","format":"uuid","description":"The SOURCE invoice the credit note reverses"},"number":{"type":"string","description":"`` of the source, e.g. IMS42"},"currency":{"type":"string"},"total":{"type":"string","description":"Decimal string, gross total of the source"},"credited_amount":{"type":"string","description":"Decimal string, sum of |total| of the issued, non-cancelled credit notes reversing the source, after this change"},"paid_amount":{"type":"string","description":"Decimal string, money received on the source"},"remaining_amount":{"type":"string","description":"Decimal string, total − credited_amount − paid_amount, never negative"},"refund_due":{"type":"string","description":"Decimal string, paid_amount − (total − credited_amount) when the customer paid more than the net; else 0.00"},"status":{"type":"string","enum":["SENT","VIEWED","PAID","PARTIALLY_PAID","OVERDUE","CREDITED"],"description":"Source status after the change; CREDITED when fully reversed"},"fully_credited":{"type":"boolean","description":"Every unit of the source has been reversed by credit notes"},"credit_note_id":{"type":"string","format":"uuid","description":"The credit note whose issue or cancellation triggered this event"},"contact_id":{"type":"string","format":"uuid","nullable":true}}},"ContactFiscalStatusWebhookData":{"type":"object","required":["contact_id","cui","name","changes","open_invoices"],"properties":{"contact_id":{"type":"string","format":"uuid"},"cui":{"type":"string","description":"Numeric Romanian CUI, without the RO prefix"},"name":{"type":"string"},"changes":{"type":"array","minItems":1,"items":{"type":"object","required":["kind","from","to","effective_date"],"properties":{"kind":{"type":"string","enum":["became_inactive","reactivated","struck_off","insolvency","vat_registered","vat_deregistered","cash_vat_on","cash_vat_off"]},"from":{"type":"string"},"to":{"type":"string"},"effective_date":{"type":"string","format":"date","nullable":true,"description":"Date published by ANAF, when it publishes one"}}}},"open_invoices":{"type":"object","required":["count","total","currency"],"properties":{"count":{"type":"integer"},"total":{"type":"string","description":"Decimal string: open balance of the ISSUED invoices, converted at each invoice exchange rate"},"currency":{"type":"string","enum":["RON"]}}}}},"DeliveryRouteDispatchedWebhookData":{"type":"object","required":["id","object","number","driver_id","vehicle_id","stop_count","dispatched_at"],"properties":{"id":{"type":"string","format":"uuid"},"object":{"type":"string","enum":["delivery_route"]},"number":{"type":"string","nullable":true},"driver_id":{"type":"string","format":"uuid"},"vehicle_id":{"type":"string","format":"uuid","nullable":true},"stop_count":{"type":"integer"},"dispatched_at":{"type":"string","format":"date-time"}}},"FleetVehicleWebhookData":{"type":"object","required":["id","object","plate"],"properties":{"id":{"type":"string","format":"uuid"},"object":{"type":"string","enum":["fleet_vehicle"]},"plate":{"type":"string"},"changed_fields":{"type":"array","items":{"type":"string"},"description":"fleet_vehicle.updated only: wire names of the fields whose value changed. Names only, never values."}}},"CourtHearingAddedWebhookData":{"type":"object","required":["id","object","case_id","hearing_date","court"],"properties":{"id":{"type":"string","format":"uuid","description":"The hearing id"},"object":{"type":"string","enum":["court_hearing"]},"case_id":{"type":"string","format":"uuid"},"hearing_date":{"type":"string","format":"date"},"court":{"type":"string","nullable":true}}},"EmailReceivedWebhookData":{"type":"object","required":["object","id","message_id","mailbox","recipient","from","subject","received_at","size_bytes","has_attachments"],"properties":{"object":{"type":"string","enum":["email_message"]},"id":{"type":"string","format":"uuid","description":"The stored message id"},"message_id":{"type":"string","nullable":true,"description":"RFC 5322 Message-ID, with angle brackets"},"mailbox":{"type":"string","format":"email","description":"The Brivio mailbox the message landed in"},"recipient":{"type":"string","format":"email","description":"The mailbox or alias address it was delivered to (never another recipient of the message)"},"from":{"type":"string","description":"Sender address, lowercased"},"subject":{"type":"string"},"received_at":{"type":"string","format":"date-time"},"size_bytes":{"type":"integer","nullable":true},"has_attachments":{"type":"boolean"}}},"SubscriptionWebhookData":{"type":"object","required":["subscription_id","status","cancel_at_period_end","metadata"],"properties":{"subscription_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["trialing","active","past_due","canceled","unpaid","incomplete","incomplete_expired","paused"]},"external_customer_id":{"type":"string","nullable":true,"description":"Your reference, as sent to POST /v1/subscriptions"},"article_id":{"type":"string","format":"uuid","nullable":true},"article_price_id":{"type":"string","format":"uuid","nullable":true},"contact_id":{"type":"string","format":"uuid","nullable":true},"stripe_subscription_id":{"type":"string","nullable":true},"stripe_customer_id":{"type":"string","nullable":true},"current_period_start":{"type":"string","format":"date-time","nullable":true},"current_period_end":{"type":"string","format":"date-time","nullable":true},"cancel_at_period_end":{"type":"boolean"},"canceled_at":{"type":"string","format":"date-time","nullable":true},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"WebhookDelivery":{"type":"object","required":["id","type","created","environment","data"],"properties":{"id":{"type":"string","description":"Stable delivery id (`evt_…`). Dedupe on it: a replayed settlement reuses the same id."},"type":{"type":"string"},"created":{"type":"integer","description":"Unix seconds"},"environment":{"type":"string","enum":["live","test"]},"data":{"type":"object"}}},"Payment":{"type":"object","description":"One attempt to collect money for the organization (invoice pay link, storefront order, booking, ad-hoc link). Amounts are integers in minor units (bani/cents).","properties":{"id":{"type":"string","format":"uuid"},"environment":{"type":"string","enum":["live","test"]},"source_kind":{"type":"string","enum":["invoice","order","booking","event_ticket","portal_topup","link","contract_tranche"]},"source_id":{"type":"string","format":"uuid","nullable":true},"channel":{"type":"string"},"amount_minor":{"type":"integer"},"currency":{"type":"string","minLength":3,"maxLength":3},"refunded_minor":{"type":"integer"},"platform_fee_minor":{"type":"integer"},"provider":{"type":"string","description":"stripe | netopia | payu | euplatesc | revolut | none"},"provider_ref":{"type":"string","nullable":true},"sandbox":{"type":"boolean"},"status":{"type":"string","enum":["pending","authorized","paid","failed","cancelled","expired","refunded","partially_refunded"]},"flow":{"type":"string","enum":["redirect","embedded"]},"description":{"type":"string","nullable":true},"customer_email":{"type":"string","nullable":true},"customer_name":{"type":"string","nullable":true},"last_error":{"type":"string","nullable":true},"paid_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"PaymentRefundInput":{"type":"object","properties":{"amount_minor":{"type":"integer","minimum":1,"description":"Minor units. Omit for the full remaining amount."},"reason":{"type":"string","maxLength":200}}},"PaymentRefundResult":{"type":"object","properties":{"refunded_minor":{"type":"integer"},"pending":{"type":"boolean","description":"The processor accepted the refund but has not settled it; the payment still shows the claim, not `refunded`."},"payment":{"$ref":"#/components/schemas/Payment"}},"required":["refunded_minor","pending","payment"]},"PaymentLink":{"type":"object","description":"An ad-hoc payment request the merchant shares as a URL / QR. The payer resolves the payment account when they open it.","properties":{"id":{"type":"string","format":"uuid"},"token":{"type":"string"},"url":{"type":"string","format":"uri"},"amount_minor":{"type":"integer"},"currency":{"type":"string","minLength":3,"maxLength":3},"description":{"type":"string","nullable":true},"customer_email":{"type":"string","nullable":true},"customer_name":{"type":"string","nullable":true},"status":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"expires_at":{"type":"string","format":"date-time","nullable":true},"paid_at":{"type":"string","format":"date-time","nullable":true}}},"PaymentLinkCreate":{"type":"object","required":["amount","currency","description"],"properties":{"amount":{"type":"number","exclusiveMinimum":0,"maximum":1000000,"description":"MAJOR units (350.00 = 350 RON)."},"currency":{"type":"string","minLength":3,"maxLength":3},"description":{"type":"string","minLength":1,"maxLength":200},"customer_email":{"type":"string","format":"email"},"customer_name":{"type":"string","maxLength":120},"expires_in_days":{"type":"integer","minimum":1,"maximum":365,"default":30}}},"PaymentLinkCreated":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"token":{"type":"string"},"url":{"type":"string","format":"uri"},"qr_url":{"type":"string","format":"uri","nullable":true},"expires_at":{"type":"string","format":"date-time"}},"required":["id","token","url","expires_at"]},"PaymentLinkCancelResult":{"type":"object","properties":{"provider_cancelled":{"type":"boolean"},"link":{"$ref":"#/components/schemas/PaymentLink"}},"required":["provider_cancelled"]},"PayoutItem":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"external_id":{"type":"string"},"item_type":{"type":"string","description":"charge | refund | adjustment | payment | …"},"gross":{"type":"string","description":"Decimal, signed (refunds negative)"},"fee":{"type":"string","description":"Decimal, signed"},"net":{"type":"string","description":"Decimal, gross - fee"},"currency":{"type":"string"},"invoice_id":{"type":"string","format":"uuid","nullable":true},"external_reference":{"type":"string","nullable":true},"description":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"}}},"Payout":{"type":"object","description":"One processor settlement to the merchant bank account: gross − fee = net. Decimals are strings with 2 dp.","properties":{"id":{"type":"string","format":"uuid"},"provider":{"type":"string"},"external_id":{"type":"string"},"payment_provider_config_id":{"type":"string","format":"uuid","nullable":true},"arrival_date":{"type":"string","format":"date"},"currency":{"type":"string"},"gross":{"type":"string"},"fee":{"type":"string"},"net":{"type":"string"},"status":{"type":"string","description":"pending | paid | failed | canceled"},"bank_transaction_id":{"type":"string","format":"uuid","nullable":true},"reconciled_at":{"type":"string","format":"date-time","nullable":true},"description":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PayoutItem"}}}},"SaftGeneration":{"type":"object","required":["id","fiscal_year_id","variant","status","valid","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"fiscal_year_id":{"type":"string","format":"uuid"},"variant":{"type":"string","enum":["annual","assets","stocks"]},"period_start":{"type":["string","null"],"format":"date"},"period_end":{"type":["string","null"],"format":"date"},"status":{"type":"string","enum":["pending","ready","expired","done"],"description":"pending: the worker has not finished. ready: a stored file is fetchable via /download. expired: past the 7-day retention (the sha256 remains). done: an inline generation whose bytes were streamed and never stored."},"valid":{"type":"boolean","description":"Structural validation verdict (V1-V7)."},"xsd_valid":{"type":["boolean","null"],"description":"Official XSD verdict; null = the check did not run."},"semantic_reconciled":{"type":["boolean","null"],"description":"Ledger reconciliation clean; null = did not run."},"coherent":{"type":["boolean","null"],"description":"ANAF consistency tests clean; null = did not run."},"coherence_applicable":{"type":["boolean","null"],"description":"False when the filer is outside the consistency tests’ scope."},"xml_bytes":{"type":["integer","null"]},"xml_sha256":{"type":["string","null"],"description":"SHA-256 of the exact bytes produced."},"storage_expires_at":{"type":["string","null"],"format":"date-time"},"submitted_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"}}},"SaftGenerationDetail":{"allOf":[{"$ref":"#/components/schemas/SaftGeneration"},{"type":"object","properties":{"validation_issues":{"type":"object","description":"Counts of persisted issues (capped at 20 each); null = that check did not run.","properties":{"structural":{"type":"integer"},"xsd":{"type":"integer"},"semantic":{"type":["integer","null"]},"coherence":{"type":["integer","null"]}}}}}]},"SaftGenerationCreate":{"type":"object","required":["fiscal_year_id"],"properties":{"fiscal_year_id":{"type":"string","format":"uuid"},"variant":{"type":"string","enum":["annual","assets","stocks"],"default":"annual"},"period_start":{"type":"string","format":"date","description":"Stocks variant only; defaults to the fiscal year."},"period_end":{"type":"string","format":"date","description":"Stocks variant only; defaults to the fiscal year."}}},"SaftGenerationQueued":{"type":"object","required":["id","job_id","status"],"properties":{"id":{"type":"string","format":"uuid","description":"The generation id (poll GET /saft/generations/{id})."},"job_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending"]}}},"SaftGenerationFindings":{"type":"object","required":["generation_id","semantic_ran","coherence_ran","findings"],"properties":{"generation_id":{"type":"string","format":"uuid"},"semantic_ran":{"type":"boolean"},"coherence_ran":{"type":"boolean"},"coherence_applicable":{"type":["boolean","null"]},"findings":{"type":"array","items":{"type":"object","required":["code","domain","severity"],"properties":{"code":{"type":"string"},"domain":{"type":"string"},"severity":{"type":"string"},"title":{"type":"object"},"reason":{"type":"object"},"fix":{"type":"object"},"fixHref":{"type":"string"},"count":{"type":"integer"},"samples":{"type":"array","items":{"type":"object"}},"field":{"type":"string"}}}}}},"SaftGenerationDownload":{"type":"object","required":["url","valid"],"properties":{"url":{"type":"string","format":"uri","description":"Short-lived signed URL; fetch it directly."},"expires_at":{"type":["string","null"],"format":"date-time","description":"When the stored file is purged."},"sha256":{"type":["string","null"]},"valid":{"type":"boolean"}}},"ExportJob":{"type":"object","description":"An export job. The file itself is never part of this object; fetch it through GET /exports/{id}/download while `expires_at` is in the future.","properties":{"id":{"type":"string","format":"uuid"},"entity":{"type":"string","enum":["invoices_issued","invoices_received","contacts","articles","stock","trial_balance","expenses"]},"format":{"type":"string","description":"csv | xlsx (in-app jobs may also show saga-xml, saga-zip, payments-csv, pdf-zip, efactura-zip)"},"status":{"type":"string","enum":["running","completed","failed"]},"row_count":{"type":"integer"},"filename":{"type":"string","nullable":true},"content_type":{"type":"string","nullable":true},"byte_size":{"type":"integer","nullable":true},"sha256":{"type":"string","nullable":true,"description":"Hex SHA-256 of the file; kept after the file expires"},"expires_at":{"type":"string","format":"date-time","nullable":true,"description":"When the stored file is deleted (7 days after completion)"},"error":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"finished_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","entity","format","status","row_count","created_at"]},"ExportJobCreate":{"type":"object","properties":{"entity":{"type":"string","enum":["invoices_issued","invoices_received","contacts","articles","stock","trial_balance","expenses"],"description":"Also requires the entity read scope: invoices_* → invoices:read, contacts → contacts:read, articles → articles:read, stock → inventory:read, trial_balance → accounting:read, expenses → expenses:read."},"format":{"type":"string","enum":["csv","xlsx"]},"scope":{"type":"object","additionalProperties":false,"properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":5000},"date_range":{"type":"object","properties":{"start":{"type":"string","format":"date"},"end":{"type":"string","format":"date"}},"required":["start","end"]},"direction":{"type":"string","enum":["ISSUED","RECEIVED"]}}}},"required":["entity","format"]},"ExportJobDownload":{"type":"object","description":"Short-lived signed URL. Fetch it WITHOUT the Authorization header.","properties":{"url":{"type":"string","format":"uri"},"expires_at":{"type":"string","format":"date-time","description":"When the signed URL stops working"},"filename":{"type":"string"},"sha256":{"type":"string","nullable":true}},"required":["url","expires_at","filename"]},"ImportPreview":{"type":"object","description":"Dedupe/diff bucket counts computed at staging. Row samples are never exposed.","properties":{"news":{"type":"integer"},"updates":{"type":"integer"},"skips":{"type":"integer"},"errors":{"type":"integer"}},"required":["news","updates","skips","errors"]},"ImportJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"entity":{"type":"string","description":"One of invoices_issued, invoices_received, contacts, articles, stock, trial_balance, expenses (in-app migration runs may carry other kinds)."},"preset":{"type":"string","nullable":true},"filename":{"type":"string","nullable":true},"source":{"type":"string","nullable":true,"description":"file | provider | spv"},"status":{"type":"string","enum":["running","staged","completed","failed","reverted","cancelled"]},"total_rows":{"type":"integer"},"imported_count":{"type":"integer"},"updated_count":{"type":"integer"},"skipped_count":{"type":"integer"},"error_count":{"type":"integer"},"preview":{"allOf":[{"$ref":"#/components/schemas/ImportPreview"}],"nullable":true},"reverted_at":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"finished_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","entity","status","total_rows","imported_count","updated_count","skipped_count","error_count","preview","created_at"]},"ImportJobError":{"type":"object","properties":{"row":{"type":"integer","description":"Spreadsheet row number (header = 1); 0 for a job-level failure"},"field":{"type":"string","nullable":true},"message":{"type":"string"}},"required":["row","message"]},"ImportJobCreate":{"type":"object","additionalProperties":false,"properties":{"entity":{"type":"string","enum":["invoices_issued","invoices_received","contacts","articles","stock","trial_balance","expenses"]},"preset":{"type":"string","enum":["smartbill","oblio","fgo","saga","winmentor","generic"],"description":"Source system; decides the external-ref namespace for invoices/stock."},"filename":{"type":"string","maxLength":255},"mode":{"type":"string","enum":["historical","draft"],"description":"Invoices only. historical (default) keeps numbers and never posts to the ledger; draft re-enters the normal flow."},"rows":{"type":"array","minItems":1,"maxItems":5000,"items":{"type":"object","additionalProperties":true},"description":"Already-mapped canonical rows (the same shape the in-app wizard sends). Body at most 10 MB."}},"required":["entity","rows"]},"MarketingCampaignVariant":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"label":{"type":"string","description":"'A', 'B', … in configuration order"},"subject":{"type":"string"},"has_body_override":{"type":"boolean","description":"True when this arm overrides the campaign body"},"sent_count":{"type":"integer"},"opened_count":{"type":"integer"},"clicked_count":{"type":"integer"},"open_rate":{"type":"number","description":"opened_count / sent_count (0 when nothing sent)"},"click_rate":{"type":"number","description":"clicked_count / sent_count (0 when nothing sent)"}},"required":["id","label","subject","has_body_override","sent_count","opened_count","clicked_count","open_rate","click_rate"]},"MarketingAbTestConfigure":{"type":"object","properties":{"test_pct":{"type":"integer","minimum":1,"maximum":50,"description":"Share of the audience used as the test slice"},"decide_after_minutes":{"type":"integer","minimum":15,"maximum":10080},"winner_metric":{"type":"string","enum":["open","click"]},"variants":{"type":"array","minItems":2,"maxItems":4,"items":{"type":"object","properties":{"subject":{"type":"string","minLength":1,"maxLength":500},"body":{"type":"string","description":"Optional body override for this arm"}},"required":["subject"]}}},"required":["test_pct","decide_after_minutes","winner_metric","variants"]},"MarketingCampaignAbTest":{"type":"object","description":"A campaign with its A/B state and arms.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"channel":{"type":"string"},"status":{"type":"string"},"subject":{"type":["string","null"]},"ab_test_pct":{"type":["integer","null"]},"ab_decide_after_minutes":{"type":["integer","null"]},"ab_winner_metric":{"type":["string","null"],"enum":["open","click",null]},"ab_test_sent_at":{"type":["string","null"],"format":"date-time"},"ab_winner_variant_id":{"type":["string","null"],"format":"uuid"},"ab_decided_at":{"type":["string","null"],"format":"date-time"},"ab_conclusive":{"type":["boolean","null"]},"ab_winner_reason":{"type":["string","null"]},"variants":{"type":"array","items":{"$ref":"#/components/schemas/MarketingCampaignVariant"}}},"required":["id","status","variants"]},"MarketingSubscriberCreate":{"type":"object","properties":{"email":{"type":"string","format":"email","maxLength":320},"name":{"type":"string","maxLength":200},"locale":{"type":"string","enum":["ro","en"],"default":"ro","description":"Language of the confirmation email and pages"},"source":{"type":"string","maxLength":120,"description":"Where the form lives, e.g. \"example.ro/footer\""},"redirect_url":{"type":"string","format":"uri","maxLength":2048,"description":"https only. After a successful confirm the person is sent here (303) with ?status=confirmed."},"consent":{"type":"object","description":"GDPR art. 7(1) evidence. The text and the IP are stored only as hashes.","properties":{"text_version":{"type":"string","minLength":1,"maxLength":64,"description":"Version of the consent wording the person saw"},"text":{"type":"string","maxLength":2000,"description":"Consent wording; stored only as sha256"},"ip":{"type":"string","maxLength":64,"description":"The end user's IP; stored only as a salted hash"},"user_agent":{"type":"string","maxLength":1000,"description":"Truncated to 300 characters"}},"required":["text_version"]}},"required":["email","consent"]},"MarketingSubscriber":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"object":{"type":"string","enum":["marketing_subscriber"]},"email":{"type":"string","format":"email"},"name":{"type":["string","null"]},"status":{"type":"string","enum":["pending","subscribed","unsubscribed"]},"locale":{"type":"string","enum":["ro","en"]},"source":{"type":["string","null"]},"consent_text_version":{"type":"string"},"consent_at":{"type":"string","format":"date-time"},"confirmation_sent":{"type":"boolean","description":"Whether THIS call sent a confirmation email"},"confirmed_at":{"type":["string","null"],"format":"date-time"},"unsubscribed_at":{"type":["string","null"],"format":"date-time"},"unsubscribe_url":{"type":["string","null"],"format":"uri","description":"Signed RFC 8058 one-click unsubscribe URL"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","object","email","status","locale","consent_text_version","consent_at","confirmation_sent","created_at","updated_at"]},"ProspectingSavedSearch":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"filters":{"type":"object"},"sort":{"type":["string","null"]},"columns":{"type":["array","null"],"items":{"type":"string"}},"notify_in_app":{"type":"boolean"},"notify_email":{"type":"boolean"},"last_run_at":{"type":["string","null"],"format":"date-time","description":"Set by the alerts job; read-only."},"last_match_count":{"type":["integer","null"],"description":"Set by the alerts job; read-only."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","name","filters","notify_in_app","notify_email","created_at","updated_at"]},"ProspectingSavedSearchCreate":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"filters":{"type":"object","description":"The @brivio/registry-search filter model: `{ groups: FilterGroup[] }` (AND between groups, OR within).","properties":{"groups":{"type":"array","maxItems":40,"items":{"type":"object"}}},"required":["groups"]},"sort":{"type":"string","enum":["relevance","name","nameDesc","revenue","revenueAsc","employees","employeesAsc","foundedNewest","foundedOldest"]},"columns":{"type":"array","maxItems":40,"items":{"type":"string","maxLength":60}},"notify_in_app":{"type":"boolean"},"notify_email":{"type":"boolean"}},"required":["name","filters"]},"ProspectingSavedSearchUpdate":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":200},"filters":{"type":"object","description":"The @brivio/registry-search filter model: `{ groups: FilterGroup[] }` (AND between groups, OR within).","properties":{"groups":{"type":"array","maxItems":40,"items":{"type":"object"}}},"required":["groups"]},"sort":{"type":"string","enum":["relevance","name","nameDesc","revenue","revenueAsc","employees","employeesAsc","foundedNewest","foundedOldest"]},"columns":{"type":"array","maxItems":40,"items":{"type":"string","maxLength":60}},"notify_in_app":{"type":"boolean"},"notify_email":{"type":"boolean"}}},"FleetVehicle":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"plate":{"type":"string"},"vin":{"type":["string","null"]},"make":{"type":["string","null"]},"model":{"type":["string","null"]},"year":{"type":["integer","null"]},"category":{"type":"string","enum":["CAR","VAN","TRUCK","TRAILER","BUS","MOTORCYCLE","OTHER"]},"fuel_type":{"type":"string","enum":["PETROL","DIESEL","ELECTRIC","HYBRID","LPG","CNG","OTHER"]},"status":{"type":"string","enum":["ACTIVE","IN_SERVICE","INACTIVE","SOLD"]},"odometer_km":{"type":["integer","null"]},"itp_expires_at":{"type":["string","null"],"format":"date"},"rca_expires_at":{"type":["string","null"],"format":"date"},"casco_expires_at":{"type":["string","null"],"format":"date"},"rovinieta_expires_at":{"type":["string","null"],"format":"date"},"tahograf_expires_at":{"type":["string","null"],"format":"date"},"copie_conforma_expires_at":{"type":["string","null"],"format":"date"},"first_aid_kit_expires_at":{"type":["string","null"],"format":"date"},"extinguisher_expires_at":{"type":["string","null"],"format":"date"},"assigned_driver_id":{"type":["string","null"],"format":"uuid"},"rca_provider":{"type":["string","null"]},"casco_provider":{"type":["string","null"]},"rca_policy_number":{"type":["string","null"]},"casco_policy_number":{"type":["string","null"]},"service_interval_km":{"type":["integer","null"]},"service_interval_months":{"type":["integer","null"]},"acquisition_date":{"type":["string","null"],"format":"date"},"acquisition_value":{"type":["string","null"],"description":"Decimal as a string, to keep its precision."},"acquisition_currency":{"type":["string","null"]},"depreciation_months":{"type":["integer","null"]},"residual_value":{"type":["string","null"],"description":"Decimal as a string, to keep its precision."},"leasing_company":{"type":["string","null"]},"leasing_ends_at":{"type":["string","null"],"format":"date"},"notes":{"type":["string","null"]},"registry_vehicle_id":{"type":["string","null"],"format":"uuid","description":"The canonical registry vehicle this fleet vehicle is linked to (GET /vehicles/{id}). Read-only: it follows plate/VIN; null when the link could not be made."},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","plate","category","fuel_type","status","created_at","updated_at"]},"FleetVehicleCreate":{"type":"object","additionalProperties":false,"properties":{"plate":{"type":"string","minLength":2,"maxLength":20,"description":"Normalised to upper case, single spaces."},"vin":{"type":"string","maxLength":17},"make":{"type":"string","maxLength":80},"model":{"type":"string","maxLength":80},"year":{"type":"integer","minimum":1950,"maximum":2100},"category":{"type":"string","enum":["CAR","VAN","TRUCK","TRAILER","BUS","MOTORCYCLE","OTHER"],"description":"Default CAR on create."},"fuel_type":{"type":"string","enum":["PETROL","DIESEL","ELECTRIC","HYBRID","LPG","CNG","OTHER"],"description":"Default DIESEL on create."},"status":{"type":"string","enum":["ACTIVE","IN_SERVICE","INACTIVE","SOLD"],"description":"Default ACTIVE on create."},"odometer_km":{"type":"integer","minimum":0},"itp_expires_at":{"type":"string","format":"date"},"rca_expires_at":{"type":"string","format":"date"},"casco_expires_at":{"type":"string","format":"date"},"rovinieta_expires_at":{"type":"string","format":"date"},"tahograf_expires_at":{"type":"string","format":"date"},"copie_conforma_expires_at":{"type":"string","format":"date"},"first_aid_kit_expires_at":{"type":"string","format":"date"},"extinguisher_expires_at":{"type":"string","format":"date"},"assigned_driver_id":{"type":"string","format":"uuid","description":"A driver of this organization (422 otherwise)."},"rca_provider":{"type":"string","maxLength":120},"casco_provider":{"type":"string","maxLength":120},"rca_policy_number":{"type":"string","maxLength":60},"casco_policy_number":{"type":"string","maxLength":60},"service_interval_km":{"type":"integer","minimum":0},"service_interval_months":{"type":"integer","minimum":0},"acquisition_date":{"type":"string","format":"date"},"acquisition_value":{"type":"number","minimum":0},"acquisition_currency":{"type":"string","minLength":3,"maxLength":3,"description":"Default RON on create."},"depreciation_months":{"type":"integer","minimum":1},"residual_value":{"type":"number","minimum":0},"leasing_company":{"type":"string","maxLength":255},"leasing_ends_at":{"type":"string","format":"date"},"notes":{"type":"string","maxLength":4000}},"required":["plate"]},"FleetVehicleUpdate":{"type":"object","additionalProperties":false,"properties":{"plate":{"type":"string","minLength":2,"maxLength":20,"description":"Normalised to upper case, single spaces."},"vin":{"type":"string","maxLength":17},"make":{"type":"string","maxLength":80},"model":{"type":"string","maxLength":80},"year":{"type":"integer","minimum":1950,"maximum":2100},"category":{"type":"string","enum":["CAR","VAN","TRUCK","TRAILER","BUS","MOTORCYCLE","OTHER"],"description":"Default CAR on create."},"fuel_type":{"type":"string","enum":["PETROL","DIESEL","ELECTRIC","HYBRID","LPG","CNG","OTHER"],"description":"Default DIESEL on create."},"status":{"type":"string","enum":["ACTIVE","IN_SERVICE","INACTIVE","SOLD"],"description":"Default ACTIVE on create."},"odometer_km":{"type":"integer","minimum":0},"itp_expires_at":{"type":"string","format":"date"},"rca_expires_at":{"type":"string","format":"date"},"casco_expires_at":{"type":"string","format":"date"},"rovinieta_expires_at":{"type":"string","format":"date"},"tahograf_expires_at":{"type":"string","format":"date"},"copie_conforma_expires_at":{"type":"string","format":"date"},"first_aid_kit_expires_at":{"type":"string","format":"date"},"extinguisher_expires_at":{"type":"string","format":"date"},"assigned_driver_id":{"type":"string","format":"uuid","description":"A driver of this organization (422 otherwise)."},"rca_provider":{"type":"string","maxLength":120},"casco_provider":{"type":"string","maxLength":120},"rca_policy_number":{"type":"string","maxLength":60},"casco_policy_number":{"type":"string","maxLength":60},"service_interval_km":{"type":"integer","minimum":0},"service_interval_months":{"type":"integer","minimum":0},"acquisition_date":{"type":"string","format":"date"},"acquisition_value":{"type":"number","minimum":0},"acquisition_currency":{"type":"string","minLength":3,"maxLength":3,"description":"Default RON on create."},"depreciation_months":{"type":"integer","minimum":1},"residual_value":{"type":"number","minimum":0},"leasing_company":{"type":"string","maxLength":255},"leasing_ends_at":{"type":"string","format":"date"},"notes":{"type":"string","maxLength":4000}}},"FleetOdometerReading":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"vehicle_id":{"type":"string","format":"uuid"},"reading_km":{"type":"integer"},"reading_date":{"type":"string","format":"date"},"notes":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"}},"required":["id","vehicle_id","reading_km","reading_date","created_at"]},"FleetOdometerReadingCreate":{"type":"object","additionalProperties":false,"properties":{"reading_km":{"type":"integer","minimum":0},"reading_date":{"type":"string","format":"date"},"notes":{"type":"string","maxLength":500}},"required":["reading_km","reading_date"]},"FleetServiceLog":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"vehicle_id":{"type":"string","format":"uuid"},"type":{"type":"string","enum":["PERIODIC_SERVICE","ITP","REPAIR","TIRE_CHANGE","FUEL","INSURANCE","ROVINIETA","OTHER"]},"service_date":{"type":"string","format":"date"},"odometer_km":{"type":["integer","null"]},"description":{"type":["string","null"]},"provider_name":{"type":["string","null"]},"cost_amount":{"type":["string","null"],"description":"Decimal as a string, to keep its precision."},"cost_currency":{"type":["string","null"]},"fuel_liters":{"type":["string","null"],"description":"Decimal as a string, to keep its precision."},"next_service_km":{"type":["integer","null"]},"next_service_date":{"type":["string","null"],"format":"date"},"document_ref":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"}},"required":["id","vehicle_id","type","service_date","created_at"]},"FleetServiceLogCreate":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["PERIODIC_SERVICE","ITP","REPAIR","TIRE_CHANGE","FUEL","INSURANCE","ROVINIETA","OTHER"],"description":"Default PERIODIC_SERVICE."},"service_date":{"type":"string","format":"date"},"odometer_km":{"type":"integer","minimum":0},"description":{"type":"string","maxLength":2000},"provider_name":{"type":"string","maxLength":255},"cost_amount":{"type":"number","minimum":0},"cost_currency":{"type":"string","minLength":3,"maxLength":3,"description":"Default RON."},"fuel_liters":{"type":"number","minimum":0},"next_service_km":{"type":"integer","minimum":0},"next_service_date":{"type":"string","format":"date"},"document_ref":{"type":"string","maxLength":120}},"required":["service_date"]},"FleetDriver":{"type":"object","description":"Deliberately minimal: contact, licence and medical data are not exposed.","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"status":{"type":"string","enum":["ACTIVE","SUSPENDED","INACTIVE"]}},"required":["id","name","status"]},"DeliveryRoute":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":["string","null"],"description":"R-YYYY-NNNNN"},"name":{"type":["string","null"]},"status":{"type":"string","enum":["DRAFT","PLANNED","DISPATCHED","IN_PROGRESS","COMPLETED","CANCELLED"]},"route_date":{"type":["string","null"],"format":"date-time"},"start_location_id":{"type":["string","null"],"format":"uuid"},"start_address":{"type":["object","null"]},"start_latitude":{"type":["number","null"]},"start_longitude":{"type":["number","null"]},"round_trip":{"type":"boolean"},"vehicle_id":{"type":["string","null"],"format":"uuid"},"driver_id":{"type":["string","null"],"format":"uuid"},"capacity_kg":{"type":["number","null"]},"capacity_parcels":{"type":["integer","null"]},"total_distance_km":{"type":["number","null"]},"total_duration_minutes":{"type":["integer","null"]},"optimized_at":{"type":["string","null"],"format":"date-time"},"optimizer":{"type":["string","null"],"description":"`osrm` or `haversine`"},"dispatched_at":{"type":["string","null"],"format":"date-time"},"started_at":{"type":["string","null"],"format":"date-time"},"completed_at":{"type":["string","null"],"format":"date-time"},"gate_visit_id":{"type":["string","null"],"format":"uuid"},"notes":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","status","round_trip","created_at","updated_at"]},"DeliveryRouteCreate":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":255},"route_date":{"type":"string","description":"YYYY-MM-DD or ISO date-time; default now"},"start_location_id":{"type":"string","format":"uuid","description":"Depot; its address is used when start_address is absent"},"start_address":{"type":"object","additionalProperties":false,"properties":{"street":{"type":["string","null"],"maxLength":255},"city":{"type":["string","null"],"maxLength":100},"county":{"type":["string","null"],"maxLength":100},"postal_code":{"type":["string","null"],"maxLength":20},"country":{"type":["string","null"],"maxLength":50}}},"round_trip":{"type":"boolean","default":true},"vehicle_id":{"type":"string","format":"uuid"},"driver_id":{"type":"string","format":"uuid"},"capacity_kg":{"type":"number","minimum":0},"capacity_parcels":{"type":"integer","minimum":0},"gate_visit_id":{"type":"string","format":"uuid"},"notes":{"type":"string","maxLength":2000}}},"DeliveryRouteUpdate":{"type":"object","additionalProperties":false,"properties":{"name":{"type":["string","null"],"maxLength":255},"route_date":{"type":"string"},"notes":{"type":["string","null"],"maxLength":2000},"round_trip":{"type":"boolean"},"capacity_kg":{"type":["number","null"],"minimum":0},"capacity_parcels":{"type":["integer","null"],"minimum":0},"driver_id":{"type":["string","null"],"format":"uuid"},"vehicle_id":{"type":["string","null"],"format":"uuid"},"status":{"type":"string","enum":["DRAFT","IN_PROGRESS","COMPLETED","CANCELLED"],"description":"PLANNED is set by /optimize and DISPATCHED by /dispatch."}}},"DeliveryRouteStop":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"route_id":{"type":"string","format":"uuid"},"position":{"type":"integer","description":"0-based visit order"},"status":{"type":"string","enum":["PENDING","EN_ROUTE","DELIVERED","FAILED","SKIPPED"]},"source":{"type":"string","enum":["INVOICE","ORDER","MANUAL"]},"invoice_id":{"type":["string","null"],"format":"uuid"},"order_id":{"type":["string","null"],"format":"uuid"},"contact_id":{"type":["string","null"],"format":"uuid"},"recipient_name":{"type":["string","null"]},"address":{"type":"object"},"address_text":{"type":["string","null"]},"latitude":{"type":["number","null"]},"longitude":{"type":["number","null"]},"geocode_miss":{"type":"boolean"},"weight_kg":{"type":["number","null"]},"parcels":{"type":["integer","null"]},"window_start":{"type":["string","null"],"format":"date-time"},"window_end":{"type":["string","null"],"format":"date-time"},"service_minutes":{"type":["integer","null"]},"document_ref":{"type":["string","null"]},"notes":{"type":["string","null"]},"eta_minutes":{"type":["integer","null"]},"arrived_at":{"type":["string","null"],"format":"date-time"},"delivered_at":{"type":["string","null"],"format":"date-time"},"failure_reason":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","route_id","position","status","source","address","geocode_miss","created_at","updated_at"]},"DeliveryRouteStopCreate":{"type":"object","additionalProperties":false,"properties":{"source":{"type":"string","enum":["INVOICE","ORDER","MANUAL"],"default":"MANUAL"},"invoice_id":{"type":"string","format":"uuid","description":"Fills recipient and document_ref from the invoice"},"order_id":{"type":"string","format":"uuid"},"contact_id":{"type":"string","format":"uuid"},"recipient_name":{"type":"string","maxLength":255},"recipient_phone":{"type":"string","maxLength":40,"writeOnly":true,"description":"Write-only: shown to the driver, never returned."},"address":{"type":"object","additionalProperties":false,"properties":{"street":{"type":["string","null"],"maxLength":255},"city":{"type":["string","null"],"maxLength":100},"county":{"type":["string","null"],"maxLength":100},"postal_code":{"type":["string","null"],"maxLength":20},"country":{"type":["string","null"],"maxLength":50}},"description":"street or city required"},"weight_kg":{"type":"number","minimum":0},"parcels":{"type":"integer","minimum":0},"window_start":{"type":"string","format":"date-time"},"window_end":{"type":"string","format":"date-time"},"service_minutes":{"type":"integer","minimum":0,"maximum":240},"document_ref":{"type":"string","maxLength":100},"private_notes":{"type":"string","maxLength":2000,"writeOnly":true,"description":"Write-only: only on the driver's page."},"notes":{"type":"string","maxLength":2000}},"required":["address"]},"DeliveryRouteOptimizeResult":{"type":"object","properties":{"route_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["PLANNED"]},"stop_order":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Stop ids in visit order; ungeocoded stops last"},"stop_count":{"type":"integer"},"total_distance_km":{"type":"number"},"total_duration_minutes":{"type":"integer"},"optimizer":{"type":"string","enum":["osrm","haversine"]},"missing_geocode":{"type":"integer"},"warnings":{"type":"object","properties":{"overweight":{"type":["object","null"],"properties":{"total_kg":{"type":"number"},"capacity_kg":{"type":"number"}}},"over_parcels":{"type":["object","null"],"properties":{"total_parcels":{"type":"integer"},"capacity_parcels":{"type":["integer","null"]}}}}}},"required":["route_id","status","stop_order","total_distance_km","optimizer","warnings"]},"DeliveryRouteDispatchResult":{"type":"object","properties":{"route_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["DISPATCHED"]},"dispatched_at":{"type":"string","format":"date-time"},"stop_count":{"type":"integer"},"sent_to_driver":{"type":"boolean","description":"False when the mail transport refused the route sheet"}},"required":["route_id","status","dispatched_at","sent_to_driver"]},"DeliveryRouteCostComparison":{"type":"object","description":"Own fleet vs courier for one route (F-VS). Every *Minor amount is an integer in minor units of `currency`.","properties":{"currency":{"type":"string","description":"ISO 4217"},"mode":{"type":"string","enum":["MARGINAL","FULL"],"description":"FULL adds depreciation and insurance"},"fleetMinor":{"type":"integer","description":"Own-fleet cost of the route"},"fleetPerKmMinor":{"type":["integer","null"],"description":"Fleet cost per km; null without a distance"},"estimatedPercent":{"type":"number","description":"Share of the fleet cost that is estimated (0-100)"},"courierProjectedMinor":{"type":["integer","null"],"description":"Courier price of the same parcels; null when no stop could be priced"},"pricedStops":{"type":"integer"},"unpricedStops":{"type":"integer"},"estimatedStops":{"type":"integer"},"savingMinor":{"type":["integer","null"],"description":"Courier minus fleet; positive means the fleet is cheaper"},"verdict":{"type":"string","enum":["FLEET","COURIER","TIE","UNKNOWN"]},"breakdown":{"type":["array","null"],"description":"Per-category fleet cost. Always null for API keys (it would expose driver pay).","items":{"type":"object","properties":{"category":{"type":"string","enum":["FUEL","TOLLS","DRIVER_WAGES","PER_DIEM","MAINTENANCE","TYRES","INSURANCE","DEPRECIATION","LEASING","SUBCONTRACTOR","CUSTOMS","FINES","OTHER"]},"amountMinor":{"type":"integer"}},"required":["category","amountMinor"]}},"hybridStops":{"type":"array","description":"Stops cheaper to hand to a courier","items":{"type":"object","properties":{"stopId":{"type":"string","format":"uuid"},"label":{"type":"string"},"courier":{"type":"string"},"courierMinor":{"type":"integer"},"fleetMinor":{"type":["integer","null"]}},"required":["stopId","label","courier","courierMinor","fleetMinor"]}},"hybridSavingMinor":{"type":"integer"},"breakEvenStops":{"type":["integer","null"],"description":"Stop count at which the fleet breaks even"},"co2Grams":{"type":["integer","null"]},"senderMissing":{"type":"boolean","description":"True when the org has no sender address for courier quotes"}},"required":["currency","mode","fleetMinor","fleetPerKmMinor","estimatedPercent","courierProjectedMinor","pricedStops","unpricedStops","estimatedStops","savingMinor","verdict","breakdown","hybridStops","hybridSavingMinor","breakEvenStops","co2Grams","senderMissing"]},"DeliveryRouteCostAnalytics":{"type":"object","description":"Own fleet vs courier over the last 30 or 90 days, from the cost snapshots stored when each route was completed (F-VS). Every *Minor amount is an integer in minor units of `currency`.","properties":{"windowDays":{"type":"integer","enum":[30,90]},"mode":{"type":"string","enum":["MARGINAL","FULL"],"description":"FULL adds depreciation and insurance"},"currency":{"type":"string","description":"ISO 4217"},"routes":{"type":"integer","description":"Completed routes with a snapshot in the window"},"comparableRoutes":{"type":"integer","description":"Routes that had a courier price to compare against"},"fleetMinor":{"type":"integer","description":"Own-fleet cost over comparable routes"},"courierMinor":{"type":"integer","description":"Courier price over comparable routes"},"savingMinor":{"type":"integer","description":"Courier minus fleet; positive means the fleet saved money"},"verdicts":{"type":"object","properties":{"FLEET":{"type":"integer"},"COURIER":{"type":"integer"},"TIE":{"type":"integer"},"UNKNOWN":{"type":"integer"}},"required":["FLEET","COURIER","TIE","UNKNOWN"]},"hybridSavingMinor":{"type":"integer","description":"What handing the cheaper stops to a courier would have saved"},"co2Grams":{"type":"integer"},"avgStops":{"type":["number","null"],"description":"Average stops per comparable route"},"breakEvenStops":{"type":["integer","null"],"description":"Stop count at which the fleet starts winning"},"estimatedPercent":{"type":"number","description":"Share of fleet cost that was estimated, weighted by cost (0-100)"},"losing":{"type":"array","description":"Routes whose fleet cost exceeded the courier price","items":{"type":"object","properties":{"routeId":{"type":"string","format":"uuid"},"number":{"type":["string","null"]},"name":{"type":["string","null"]},"routeDate":{"type":"string","format":"date-time"},"fleetMinor":{"type":"integer"},"courierMinor":{"type":"integer"},"lossMinor":{"type":"integer"}},"required":["routeId","number","name","routeDate","fleetMinor","courierMinor","lossMinor"]}}},"required":["windowDays","mode","currency","routes","comparableRoutes","fleetMinor","courierMinor","savingMinor","verdicts","hybridSavingMinor","co2Grams","avgStops","breakEvenStops","estimatedPercent","losing"]},"CourtCase":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"case_number":{"type":"string"},"court":{"type":["string","null"]},"subject":{"type":["string","null"]},"materia":{"type":["string","null"]},"stage":{"type":["string","null"]},"status":{"type":"string","enum":["OPEN","SUSPENDED","WON","LOST","SETTLED","CLOSED"]},"role":{"type":"string","enum":["RECLAMANT","PARAT","CREDITOR","DEBITOR","INTERVENIENT","ALTA_CALITATE"]},"opposing_party":{"type":["string","null"]},"contact_id":{"type":["string","null"],"format":"uuid"},"invoice_id":{"type":["string","null"],"format":"uuid"},"contract_id":{"type":["string","null"],"format":"uuid"},"claim_amount":{"type":["string","null"],"description":"Decimal string, 2 places"},"awarded_amount":{"type":["string","null"],"description":"Decimal string, 2 places"},"recovered_amount":{"type":["string","null"],"description":"Decimal string, 2 places"},"outcome":{"type":["string","null"]},"claim_currency":{"type":["string","null"]},"lawyer_name":{"type":["string","null"]},"opened_at":{"type":["string","null"],"format":"date"},"closed_at":{"type":["string","null"],"format":"date","description":"Set automatically when the status becomes terminal"},"next_hearing_at":{"type":["string","null"],"format":"date","description":"Kept in sync when a future hearing is added"},"notes":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","case_number","status","role","created_at","updated_at"]},"CourtCaseCreate":{"type":"object","additionalProperties":false,"properties":{"case_number":{"type":"string","minLength":3,"maxLength":60,"description":"e.g. `12345/3/2026`"},"court":{"type":"string","maxLength":255},"subject":{"type":"string","maxLength":500},"materia":{"type":"string","maxLength":120},"stage":{"type":"string","maxLength":120},"status":{"type":"string","enum":["OPEN","SUSPENDED","WON","LOST","SETTLED","CLOSED"]},"role":{"type":"string","enum":["RECLAMANT","PARAT","CREDITOR","DEBITOR","INTERVENIENT","ALTA_CALITATE"]},"opposing_party":{"type":"string","maxLength":255},"contact_id":{"type":"string","format":"uuid","description":"A contact of this organization"},"invoice_id":{"type":"string","format":"uuid","description":"An invoice of this organization"},"contract_id":{"type":"string","format":"uuid","description":"A contract of this organization"},"claim_amount":{"type":"number","minimum":0},"awarded_amount":{"type":"number","minimum":0},"recovered_amount":{"type":"number","minimum":0},"outcome":{"type":"string","maxLength":500},"claim_currency":{"type":"string","minLength":3,"maxLength":3},"lawyer_name":{"type":"string","maxLength":255},"opened_at":{"type":"string","format":"date"},"closed_at":{"type":"string","format":"date"},"next_hearing_at":{"type":"string","format":"date"},"notes":{"type":"string","maxLength":8000}},"required":["case_number"]},"CourtCaseUpdate":{"type":"object","additionalProperties":false,"properties":{"case_number":{"type":"string","minLength":3,"maxLength":60,"description":"e.g. `12345/3/2026`"},"court":{"type":"string","maxLength":255},"subject":{"type":"string","maxLength":500},"materia":{"type":"string","maxLength":120},"stage":{"type":"string","maxLength":120},"status":{"type":"string","enum":["OPEN","SUSPENDED","WON","LOST","SETTLED","CLOSED"]},"role":{"type":"string","enum":["RECLAMANT","PARAT","CREDITOR","DEBITOR","INTERVENIENT","ALTA_CALITATE"]},"opposing_party":{"type":"string","maxLength":255},"contact_id":{"type":"string","format":"uuid","description":"A contact of this organization"},"invoice_id":{"type":"string","format":"uuid","description":"An invoice of this organization"},"contract_id":{"type":"string","format":"uuid","description":"A contract of this organization"},"claim_amount":{"type":"number","minimum":0},"awarded_amount":{"type":"number","minimum":0},"recovered_amount":{"type":"number","minimum":0},"outcome":{"type":"string","maxLength":500},"claim_currency":{"type":"string","minLength":3,"maxLength":3},"lawyer_name":{"type":"string","maxLength":255},"opened_at":{"type":"string","format":"date"},"closed_at":{"type":"string","format":"date"},"next_hearing_at":{"type":"string","format":"date"},"notes":{"type":"string","maxLength":8000}},"description":"Partial: only the fields sent are changed."},"CourtHearing":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"case_id":{"type":"string","format":"uuid"},"hearing_date":{"type":"string","format":"date"},"time":{"type":["string","null"]},"room":{"type":["string","null"]},"panel":{"type":["string","null"]},"solution":{"type":["string","null"]},"solution_summary":{"type":["string","null"]},"notes":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"}},"required":["id","case_id","hearing_date","created_at"]},"CourtHearingCreate":{"type":"object","additionalProperties":false,"properties":{"hearing_date":{"type":"string","format":"date"},"time":{"type":"string","maxLength":10},"room":{"type":"string","maxLength":60},"panel":{"type":"string","maxLength":255},"solution":{"type":"string","maxLength":8000},"solution_summary":{"type":"string","maxLength":500},"notes":{"type":"string","maxLength":4000}},"required":["hearing_date"]},"CourtCaseNote":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"case_id":{"type":"string","format":"uuid"},"content":{"type":"string"},"is_internal":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"}},"required":["id","case_id","content","is_internal","created_at"]},"CourtCaseNoteCreate":{"type":"object","additionalProperties":false,"properties":{"content":{"type":"string","minLength":1,"maxLength":8000},"is_internal":{"type":"boolean"}},"required":["content"]},"ImportDeclaration":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":["string","null"]},"mrn":{"type":["string","null"],"description":"Movement Reference Number"},"customs_office":{"type":["string","null"]},"status":{"type":"string","enum":["DRAFT","CONFIRMED","CANCELLED"]},"regime":{"type":"string","enum":["PAID_AT_CUSTOMS","DEFERRED"],"description":"PAID_AT_CUSTOMS: VAT paid at the border (Dr 4426 / Cr 446). DEFERRED: certificat de amânare (Dr 4426 / Cr 4427)."},"nir_document_id":{"type":["string","null"],"format":"uuid"},"supplier_id":{"type":["string","null"],"format":"uuid"},"declaration_date":{"type":"string","format":"date"},"currency":{"type":"string"},"customs_exchange_rate":{"type":"string","description":"The CUSTOMS rate (not the invoice BNR T-1 rate), 6 dp."},"invoice_value_currency":{"type":"string","description":"Transaction value, in `currency`."},"customs_value":{"type":"string","description":"Customs value in RON."},"customs_duty":{"type":"string","description":"RON."},"excise":{"type":"string","description":"RON."},"customs_commission":{"type":"string","description":"RON."},"accessory_costs":{"type":"string","description":"Transport + insurance to the first destination in Romania, RON."},"vat_rate":{"type":"string","description":"Percent."},"vat_base":{"type":"string","description":"Art. 289 VAT base, RON."},"vat_amount":{"type":"string","description":"Import VAT, RON."},"journal_entry_id":{"type":["string","null"],"format":"uuid","description":"Posted entry created at confirmation."},"capitalized_amount":{"type":"string","description":"Raised the cost of goods still in stock, RON."},"expensed_amount":{"type":"string","description":"Share for goods already sold, booked on 607, RON."},"notes":{"type":["string","null"]},"confirmed_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","status","regime","declaration_date","currency","customs_exchange_rate","vat_base","vat_amount","created_at","updated_at"]},"ImportDeclarationLine":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"nir_item_id":{"type":["string","null"],"format":"uuid"},"description":{"type":"string"},"tariff_code":{"type":["string","null"]},"country_of_origin":{"type":["string","null"]},"quantity":{"type":"string","description":"4 dp."},"unit":{"type":["string","null"]},"net_weight_kg":{"type":["string","null"]},"invoice_value_currency":{"type":"string","description":"In the declaration currency."},"customs_duty":{"type":"string","description":"RON."},"allocated_cost":{"type":"string","description":"Customs cost allocated at confirmation, RON (0 while DRAFT)."},"capitalized_cost":{"type":"string","description":"RON."},"expensed_cost":{"type":"string","description":"RON."},"sort_order":{"type":"integer"}},"required":["id","description","quantity","invoice_value_currency","allocated_cost","sort_order"]},"ImportDeclarationDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":["string","null"]},"mrn":{"type":["string","null"],"description":"Movement Reference Number"},"customs_office":{"type":["string","null"]},"status":{"type":"string","enum":["DRAFT","CONFIRMED","CANCELLED"]},"regime":{"type":"string","enum":["PAID_AT_CUSTOMS","DEFERRED"],"description":"PAID_AT_CUSTOMS: VAT paid at the border (Dr 4426 / Cr 446). DEFERRED: certificat de amânare (Dr 4426 / Cr 4427)."},"nir_document_id":{"type":["string","null"],"format":"uuid"},"supplier_id":{"type":["string","null"],"format":"uuid"},"declaration_date":{"type":"string","format":"date"},"currency":{"type":"string"},"customs_exchange_rate":{"type":"string","description":"The CUSTOMS rate (not the invoice BNR T-1 rate), 6 dp."},"invoice_value_currency":{"type":"string","description":"Transaction value, in `currency`."},"customs_value":{"type":"string","description":"Customs value in RON."},"customs_duty":{"type":"string","description":"RON."},"excise":{"type":"string","description":"RON."},"customs_commission":{"type":"string","description":"RON."},"accessory_costs":{"type":"string","description":"Transport + insurance to the first destination in Romania, RON."},"vat_rate":{"type":"string","description":"Percent."},"vat_base":{"type":"string","description":"Art. 289 VAT base, RON."},"vat_amount":{"type":"string","description":"Import VAT, RON."},"journal_entry_id":{"type":["string","null"],"format":"uuid","description":"Posted entry created at confirmation."},"capitalized_amount":{"type":"string","description":"Raised the cost of goods still in stock, RON."},"expensed_amount":{"type":"string","description":"Share for goods already sold, booked on 607, RON."},"notes":{"type":["string","null"]},"confirmed_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"lines":{"type":"array","items":{"$ref":"#/components/schemas/ImportDeclarationLine"}}},"required":["id","status","regime","declaration_date","currency","customs_exchange_rate","vat_base","vat_amount","created_at","updated_at","lines"]},"ImportDeclarationCreate":{"type":"object","additionalProperties":false,"properties":{"number":{"type":"string","maxLength":50},"mrn":{"type":"string","maxLength":21},"customs_office":{"type":"string","maxLength":120},"regime":{"type":"string","enum":["PAID_AT_CUSTOMS","DEFERRED"]},"nir_document_id":{"type":"string","format":"uuid","description":"Goods receipt whose stock absorbs the customs cost. Required to confirm."},"supplier_id":{"type":"string","format":"uuid"},"declaration_date":{"type":"string","format":"date"},"currency":{"type":"string","minLength":3,"maxLength":3,"description":"Default EUR."},"customs_exchange_rate":{"type":"string","pattern":"^\\d{1,6}(\\.\\d{1,6})?$"},"customs_duty":{"type":"string","pattern":"^-?\\d{1,13}(\\.\\d{1,2})?$","description":"RON, decimal as a string."},"excise":{"type":"string","pattern":"^-?\\d{1,13}(\\.\\d{1,2})?$","description":"RON, decimal as a string."},"customs_commission":{"type":"string","pattern":"^-?\\d{1,13}(\\.\\d{1,2})?$","description":"RON, decimal as a string."},"accessory_costs":{"type":"string","pattern":"^-?\\d{1,13}(\\.\\d{1,2})?$","description":"RON, decimal as a string."},"vat_rate":{"type":"number","minimum":0,"maximum":100},"notes":{"type":"string","maxLength":4000},"lines":{"type":"array","minItems":1,"maxItems":500,"items":{"type":"object","additionalProperties":false,"properties":{"description":{"type":"string","minLength":1,"maxLength":500},"tariff_code":{"type":"string","maxLength":12},"country_of_origin":{"type":"string","minLength":2,"maxLength":2},"quantity":{"type":"string","pattern":"^\\d{1,11}(\\.\\d{1,4})?$"},"unit":{"type":"string","maxLength":20},"net_weight_kg":{"type":"string"},"invoice_value_currency":{"type":"string","pattern":"^\\d{1,13}(\\.\\d{1,2})?$"},"customs_duty":{"type":"string","pattern":"^-?\\d{1,13}(\\.\\d{1,2})?$","description":"RON, decimal as a string."},"nir_item_id":{"type":"string","format":"uuid","description":"A line of `nir_document_id`."}},"required":["description","quantity","invoice_value_currency"]}}},"required":["regime","declaration_date","customs_exchange_rate","vat_rate","lines"]},"ImportDeclarationConfirmResult":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["CONFIRMED"]},"regime":{"type":"string","enum":["PAID_AT_CUSTOMS","DEFERRED"]},"capitalisable_amount":{"type":"string","description":"Duty + excise + commission (+ accessory costs unless already covered by a transport allocation), RON."},"capitalized_amount":{"type":"string","description":"Debited to stock (371 or the category account), RON."},"expensed_amount":{"type":"string","description":"Debited to 607 for goods already sold, RON."},"vat_amount":{"type":"string","description":"RON."},"accessory_costs_excluded":{"type":"boolean"},"journal_entry_id":{"type":["string","null"],"format":"uuid"},"journal_entry_number":{"type":["integer","null"]},"layers_uplifted":{"type":"integer"},"wavg_updated":{"type":"integer"},"confirmed_at":{"type":"string","format":"date-time"}},"required":["id","status","capitalized_amount","expensed_amount","journal_entry_id","confirmed_at"]},"SaftImportPreview":{"type":"object","description":"Persisted at parse time; what the file holds. Nothing is written until apply.","properties":{"header":{"type":"object","properties":{"taxRegistrationNumber":{"type":"string"},"companyName":{"type":"string"},"startDate":{"type":"string"},"endDate":{"type":"string"},"currency":{"type":"string"}}},"counts":{"type":"object","properties":{"accounts":{"type":"integer"},"parties":{"type":"integer"},"invoices":{"type":"integer"},"products":{"type":"integer"},"physical_stock":{"type":"integer"},"journal_entries":{"type":"integer"},"payments":{"type":"integer"},"assets":{"type":"integer"}}},"trial_balance":{"type":"object","description":"Closing balances (the opening position at the migration date), netted to one side per account.","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"account_code":{"type":"string"},"debit":{"type":"number"},"credit":{"type":"number"}}}},"total_debit":{"type":"number"},"total_credit":{"type":"number"},"balanced":{"type":"boolean"}}},"control_total_mismatches":{"type":"array","items":{"type":"string"},"description":"Declared control totals that disagree with what was read (truncated or mis-read file)."},"warnings":{"type":"array","items":{"type":"string"}},"unknown_accounts":{"type":"array","items":{"type":"string"},"description":"AccountIDs with no active RO (OMFP 1802) account; map them with account_mapping on apply."},"has_stock_section":{"type":"boolean","description":"False for a routine monthly D406 — PhysicalStock exists only in the on-demand Stocks variant."}}},"SaftImport":{"type":"object","required":["id","status","has_file","created_at"],"properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["awaiting_upload","parsing","previewed","running","completed","failed"]},"filename":{"type":["string","null"]},"byte_size":{"type":["integer","null"]},"sha256":{"type":["string","null"],"description":"Declared hex SHA-256; the stored bytes are verified against it at parse."},"has_file":{"type":"boolean","description":"The uploaded object is still stored (deleted once applied, or after 7 days)."},"storage_expires_at":{"type":["string","null"],"format":"date-time"},"preview":{"oneOf":[{"$ref":"#/components/schemas/SaftImportPreview"},{"type":"null"}]},"result":{"type":["object","null"],"description":"Per-section outcome once applied: contacts, products, accounts, stock, opening_balances ({posted, entry_id, errors}), migration_date."},"imported_count":{"type":"integer"},"updated_count":{"type":"integer"},"skipped_count":{"type":"integer"},"error_count":{"type":"integer"},"errors":{"type":"array","items":{"type":"object","properties":{"row":{"type":"integer"},"field":{"type":["string","null"]},"message":{"type":"string"}}}},"created_at":{"type":"string","format":"date-time"},"finished_at":{"type":["string","null"],"format":"date-time"}}},"SaftImportCreate":{"type":"object","additionalProperties":false,"required":["filename","byte_size","sha256"],"properties":{"filename":{"type":"string","maxLength":255},"byte_size":{"type":"integer","minimum":1,"maximum":52428800,"description":"Exact size; the signed PUT refuses a larger body."},"sha256":{"type":"string","pattern":"^[0-9a-fA-F]{64}$"}}},"SaftImportCreated":{"allOf":[{"$ref":"#/components/schemas/SaftImport"},{"type":"object","required":["upload"],"properties":{"upload":{"type":"object","required":["url","method","headers","expires_at"],"properties":{"url":{"type":"string","format":"uri","description":"Signed object-storage URL; PUT the raw XML bytes to it."},"method":{"type":"string","enum":["PUT"]},"headers":{"type":"object","additionalProperties":{"type":"string"},"description":"Send every header verbatim on the PUT — the signature covers them."},"expires_at":{"type":"string","format":"date-time"}}}}}]},"SaftImportApply":{"type":"object","additionalProperties":false,"properties":{"sections":{"type":"object","additionalProperties":false,"description":"Every section defaults to true.","properties":{"contacts":{"type":"boolean"},"products":{"type":"boolean"},"accounts":{"type":"boolean"},"stock":{"type":"boolean"},"opening_balances":{"type":"boolean"}}},"migration_date":{"type":"string","format":"date","description":"Defaults to the file's period end."},"account_mapping":{"type":"object","additionalProperties":{"type":"string"},"description":"Foreign AccountID → RO account code, for the opening balance."}}},"GateVisit":{"type":"object","description":"The driver's identity-document number and phone are deliberately not exposed.","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":["string","null"],"description":"V-YYYY-NNNNNN, per organization."},"direction":{"type":"string","enum":["INBOUND","OUTBOUND","OTHER"]},"status":{"type":"string","enum":["EXPECTED","AT_GATE","CHECKED_IN","AT_DOCK","WEIGHED_IN","LOADING","WEIGHED_OUT","DOCS_PENDING","DEPARTED","CANCELLED"]},"source":{"type":"string","enum":["MANUAL","PLATE_SCAN","ANPR","KIOSK","APPOINTMENT"]},"vehicle_plate":{"type":"string"},"trailer_plate":{"type":["string","null"]},"fleet_vehicle_id":{"type":["string","null"],"format":"uuid"},"compliance_alerts":{"type":["array","null"],"description":"Expired / due-within-14-days documents of the matching Fleet vehicle.","items":{"type":"object","properties":{"kind":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"expired":{"type":"boolean"}}}},"driver_name":{"type":["string","null"]},"carrier_id":{"type":["string","null"],"format":"uuid"},"carrier_name":{"type":["string","null"]},"partner_id":{"type":["string","null"],"format":"uuid"},"location_id":{"type":["string","null"],"format":"uuid"},"dock_name":{"type":["string","null"]},"purpose":{"type":["string","null"]},"notes":{"type":["string","null"]},"expected_at":{"type":["string","null"],"format":"date-time"},"arrived_at":{"type":["string","null"],"format":"date-time"},"docked_at":{"type":["string","null"],"format":"date-time"},"departed_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","direction","status","source","vehicle_plate","created_at","updated_at"]},"GateVisitDetail":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"number":{"type":["string","null"],"description":"V-YYYY-NNNNNN, per organization."},"direction":{"type":"string","enum":["INBOUND","OUTBOUND","OTHER"]},"status":{"type":"string","enum":["EXPECTED","AT_GATE","CHECKED_IN","AT_DOCK","WEIGHED_IN","LOADING","WEIGHED_OUT","DOCS_PENDING","DEPARTED","CANCELLED"]},"source":{"type":"string","enum":["MANUAL","PLATE_SCAN","ANPR","KIOSK","APPOINTMENT"]},"vehicle_plate":{"type":"string"},"trailer_plate":{"type":["string","null"]},"fleet_vehicle_id":{"type":["string","null"],"format":"uuid"},"compliance_alerts":{"type":["array","null"],"description":"Expired / due-within-14-days documents of the matching Fleet vehicle.","items":{"type":"object","properties":{"kind":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"expired":{"type":"boolean"}}}},"driver_name":{"type":["string","null"]},"carrier_id":{"type":["string","null"],"format":"uuid"},"carrier_name":{"type":["string","null"]},"partner_id":{"type":["string","null"],"format":"uuid"},"location_id":{"type":["string","null"],"format":"uuid"},"dock_name":{"type":["string","null"]},"purpose":{"type":["string","null"]},"notes":{"type":["string","null"]},"expected_at":{"type":["string","null"],"format":"date-time"},"arrived_at":{"type":["string","null"],"format":"date-time"},"docked_at":{"type":["string","null"],"format":"date-time"},"departed_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"weighings":{"type":"array","items":{"$ref":"#/components/schemas/GateWeighing"}},"events":{"type":"array","description":"Timeline, newest first.","items":{"type":"object","properties":{"type":{"type":"string"},"from_status":{"type":["string","null"],"enum":["EXPECTED","AT_GATE","CHECKED_IN","AT_DOCK","WEIGHED_IN","LOADING","WEIGHED_OUT","DOCS_PENDING","DEPARTED","CANCELLED",null]},"to_status":{"type":["string","null"],"enum":["EXPECTED","AT_GATE","CHECKED_IN","AT_DOCK","WEIGHED_IN","LOADING","WEIGHED_OUT","DOCS_PENDING","DEPARTED","CANCELLED",null]},"created_at":{"type":"string","format":"date-time"}},"required":["type","created_at"]}}},"required":["id","direction","status","source","vehicle_plate","weighings","events","created_at","updated_at"]},"GateVisitCreate":{"type":"object","additionalProperties":false,"properties":{"vehicle_plate":{"type":"string","minLength":2,"maxLength":20},"direction":{"type":"string","enum":["INBOUND","OUTBOUND","OTHER"],"description":"Default OUTBOUND."},"trailer_plate":{"type":"string","maxLength":20},"driver_name":{"type":"string","maxLength":255},"carrier_id":{"type":"string","format":"uuid"},"carrier_name":{"type":"string","maxLength":255},"partner_id":{"type":"string","format":"uuid"},"location_id":{"type":"string","format":"uuid"},"dock_name":{"type":"string","maxLength":50},"purpose":{"type":"string","maxLength":255},"notes":{"type":"string","maxLength":2000},"expected_at":{"type":"string","format":"date-time","description":"Set without appointment_id → the visit starts EXPECTED."},"appointment_id":{"type":"string","format":"uuid","description":"A dock appointment of this organization; it moves to ARRIVED."}},"required":["vehicle_plate"]},"GateVisitTransition":{"type":"object","additionalProperties":false,"properties":{"to":{"type":"string","enum":["EXPECTED","AT_GATE","CHECKED_IN","AT_DOCK","WEIGHED_IN","LOADING","WEIGHED_OUT","DOCS_PENDING","DEPARTED","CANCELLED"]},"note":{"type":"string","maxLength":1000},"dock_name":{"type":"string","maxLength":50,"description":"Used when moving to AT_DOCK."}},"required":["to"]},"GateWeighing":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"visit_id":{"type":"string","format":"uuid"},"number":{"type":["string","null"]},"unit":{"type":"string","enum":["kg"]},"gross_kg":{"type":["string","null"],"description":"Kilograms, decimal as a string to keep its precision."},"tare_kg":{"type":["string","null"],"description":"Kilograms, decimal as a string to keep its precision."},"net_kg":{"type":["string","null"],"description":"|gross − tare| once both are known."},"weighed_in_at":{"type":["string","null"],"format":"date-time"},"weighed_out_at":{"type":["string","null"],"format":"date-time"},"scale_name":{"type":["string","null"]},"operator_name":{"type":["string","null"]},"notes":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"}},"required":["id","visit_id","unit","created_at"]},"GateWeighingCreate":{"type":"object","additionalProperties":false,"properties":{"phase":{"type":"string","enum":["IN","OUT"]},"gross_kg":{"type":"number","minimum":0},"tare_kg":{"type":"number","minimum":0},"scale_name":{"type":"string","maxLength":100},"operator_name":{"type":"string","maxLength":255},"notes":{"type":"string","maxLength":1000}},"required":["phase"]},"DockAppointment":{"type":"object","description":"The driver's phone and the kiosk check-in token are deliberately not exposed.","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["SCHEDULED","CONFIRMED","ARRIVED","COMPLETED","NO_SHOW","CANCELLED"]},"direction":{"type":"string","enum":["INBOUND","OUTBOUND","OTHER"]},"location_id":{"type":["string","null"],"format":"uuid"},"dock_name":{"type":["string","null"]},"slot_start":{"type":"string","format":"date-time"},"slot_end":{"type":"string","format":"date-time"},"vehicle_plate":{"type":["string","null"]},"driver_name":{"type":["string","null"]},"carrier_id":{"type":["string","null"],"format":"uuid"},"carrier_name":{"type":["string","null"]},"partner_id":{"type":["string","null"],"format":"uuid"},"reference":{"type":["string","null"]},"notes":{"type":["string","null"]},"visit_id":{"type":["string","null"],"format":"uuid"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","status","direction","slot_start","slot_end","created_at","updated_at"]},"DockAppointmentCreate":{"type":"object","additionalProperties":false,"properties":{"direction":{"type":"string","enum":["INBOUND","OUTBOUND","OTHER"],"description":"Default INBOUND on create."},"location_id":{"type":"string","format":"uuid","description":"A location of this organization (422 otherwise)."},"dock_name":{"type":"string","maxLength":50,"description":"Enables the overlap check for this dock."},"slot_start":{"type":"string","format":"date-time"},"slot_end":{"type":"string","format":"date-time","description":"Must be after slot_start. Slots are half-open [start, end)."},"vehicle_plate":{"type":"string","maxLength":20},"driver_name":{"type":"string","maxLength":255},"carrier_id":{"type":"string","format":"uuid"},"carrier_name":{"type":"string","maxLength":255},"partner_id":{"type":"string","format":"uuid"},"reference":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":2000}},"required":["slot_start","slot_end"]},"DockAppointmentUpdate":{"type":"object","additionalProperties":false,"properties":{"direction":{"type":"string","enum":["INBOUND","OUTBOUND","OTHER"],"description":"Default INBOUND on create."},"location_id":{"type":"string","format":"uuid","description":"A location of this organization (422 otherwise)."},"dock_name":{"type":"string","maxLength":50,"description":"Enables the overlap check for this dock."},"slot_start":{"type":"string","format":"date-time"},"slot_end":{"type":"string","format":"date-time","description":"Must be after slot_start. Slots are half-open [start, end)."},"vehicle_plate":{"type":"string","maxLength":20},"driver_name":{"type":"string","maxLength":255},"carrier_id":{"type":"string","format":"uuid"},"carrier_name":{"type":"string","maxLength":255},"partner_id":{"type":"string","format":"uuid"},"reference":{"type":"string","maxLength":100},"notes":{"type":"string","maxLength":2000},"status":{"type":"string","enum":["SCHEDULED","CONFIRMED","ARRIVED","COMPLETED","NO_SHOW","CANCELLED"],"description":"CANCELLED cancels (soft)."}}},"AccessGrant":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"role":{"type":"string","enum":["cabinet","client"],"description":"The caller's side of the grant"},"status":{"type":"string","enum":["pending","active","revoked"]},"scope":{"type":"string","description":"Profession the grant is for (e.g. `accountant`)"},"counterparty_org_id":{"type":"string","format":"uuid"},"counterparty_name":{"type":"string"},"counterparty_vat_number":{"type":["string","null"],"description":"CUI of the other organization"},"requested_at":{"type":"string","format":"date-time"},"approved_at":{"type":["string","null"],"format":"date-time"},"revoked_at":{"type":["string","null"],"format":"date-time"}},"required":["id","role","status","scope","counterparty_org_id","counterparty_name","requested_at"]},"AccessGrantRequest":{"type":"object","additionalProperties":false,"properties":{"client_org_id":{"type":"string","format":"uuid","description":"A client this cabinet actively manages"}},"required":["client_org_id"]},"RegistryVehicle":{"type":"object","description":"A canonical registry vehicle (own fleet, customer, supplier or prospect car). Identity and classification only: the owner/holder, notes, photo and technical specs are not exposed.","properties":{"id":{"type":"string","format":"uuid"},"plate":{"type":"string","description":"Normalised registration number."},"vin":{"type":["string","null"]},"make":{"type":["string","null"]},"model":{"type":["string","null"]},"year":{"type":["integer","null"],"description":"Model year."},"ownership":{"type":"string","enum":["OWN","CUSTOMER","PROSPECT","SUPPLIER","OTHER"],"description":"Whose car it is, from this organization's point of view."},"status":{"type":"string","enum":["ACTIVE","ARCHIVED"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","plate","ownership","status","created_at","updated_at"]},"TripSheet":{"type":"object","description":"A foaie de parcurs (Romanian trip sheet). `driver_name` is present only when the key also holds fleet_drivers:read; otherwise the property is omitted.","properties":{"id":{"type":"string","format":"uuid"},"vehicle_id":{"type":"string","format":"uuid","description":"Registry vehicle id."},"performed_at":{"type":"string","format":"date-time"},"driver_id":{"type":["string","null"],"format":"uuid"},"driver_name":{"type":["string","null"],"description":"Requires scope fleet_drivers:read; omitted otherwise."},"route_from":{"type":["string","null"]},"route_to":{"type":["string","null"]},"purpose":{"type":["string","null"]},"odometer_start_km":{"type":["integer","null"]},"odometer_end_km":{"type":["integer","null"]},"distance_km":{"type":["integer","null"],"description":"Derived: end − start when both are present and end ≥ start."},"fuel_issued_litres":{"type":["string","null"],"description":"Decimal as a string, to keep its precision."},"notes":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"}},"required":["id","vehicle_id","performed_at","created_at"]},"TripSheetCreate":{"type":"object","additionalProperties":false,"properties":{"performed_at":{"type":"string","format":"date-time","description":"ISO 8601 with offset."},"driver_name":{"type":"string","maxLength":255},"route_from":{"type":"string","maxLength":200},"route_to":{"type":"string","maxLength":200},"purpose":{"type":"string","maxLength":255},"odometer_start_km":{"type":"integer","minimum":0},"odometer_end_km":{"type":"integer","minimum":0,"description":"Must be ≥ odometer_start_km (422 otherwise)."},"fuel_issued_litres":{"type":"number","minimum":0},"notes":{"type":"string","maxLength":2000}},"required":["performed_at"]},"Space":{"type":"object","description":"A grouping of domains, sites and apps of one project. It owns nothing: deleting it releases its members.","properties":{"id":{"type":"string","format":"uuid"},"slug":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$","maxLength":63},"name":{"type":"string","maxLength":120},"description":{"type":["string","null"]},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","slug","name","description","created_at","updated_at"]},"SpaceMember":{"type":"object","properties":{"kind":{"type":"string","enum":["website","custom_domain","dns_zone","hosted_site","registered_domain","email_domain","oauth_client","webhook"]},"id":{"type":"string","format":"uuid"},"label":{"type":"string","description":"Domain, site name, app name or webhook URL."}},"required":["kind","id","label"]},"SpaceDetail":{"allOf":[{"$ref":"#/components/schemas/Space"},{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/SpaceMember"}}},"required":["members"]}]},"SpaceCreate":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":120},"slug":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$","maxLength":63,"description":"Derived from the name when omitted. Unique in the organization (409 otherwise)."},"description":{"type":["string","null"],"maxLength":2000}},"required":["name"]},"SpaceUpdate":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","minLength":1,"maxLength":120},"slug":{"type":"string","pattern":"^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$","maxLength":63},"description":{"type":["string","null"],"maxLength":2000}}},"SpaceMemberRef":{"type":"object","additionalProperties":false,"properties":{"kind":{"type":"string","enum":["website","custom_domain","dns_zone","hosted_site","registered_domain","email_domain","oauth_client","webhook"]},"resource_id":{"type":"string","format":"uuid","description":"Must belong to this organization (404 otherwise)."}},"required":["kind","resource_id"]},"SpaceTransfer":{"type":"object","description":"A two-party transfer of a space to another organization. Visible to both parties. Created and accepted only in the app, with a second factor — never through the API.","properties":{"id":{"type":"string","format":"uuid"},"space_id":{"type":"string","format":"uuid"},"direction":{"type":"string","enum":["outgoing","incoming"],"description":"Relative to the calling organization."},"source_organization_id":{"type":"string","format":"uuid"},"target_organization_id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","accepted","completed","cancelled","expired","failed"]},"blockers":{"type":"array","items":{"type":"string","enum":["empty_space","store_in_closure","tenant_domain","registered_domain","target_no_company","target_quota"]}},"moved_counts":{"type":["object","null"],"additionalProperties":{"type":"integer"},"description":"Resources moved per kind, once completed."},"expires_at":{"type":"string","format":"date-time"},"accepted_at":{"type":["string","null"],"format":"date-time"},"completed_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"}},"required":["id","space_id","direction","source_organization_id","target_organization_id","status","blockers","expires_at","created_at"]},"DisplayMoney":{"type":"object","properties":{"minor":{"type":"integer","description":"Integer minor units (bani)."},"currency":{"type":"string","minLength":3,"maxLength":3}},"required":["minor","currency"]},"DisplayConfig":{"type":"object","properties":{"profile":{"type":"string","enum":["wallboard","kitchen","pickup","queue","reception","bookings","gate","showcase","menu","announcements","feed"],"description":"What the device is for; every profile except wallboard ignores `screens`."},"profileSettings":{"type":"object","description":"Per-profile settings; every field optional with a default.","properties":{"orientation":{"type":"string","enum":["landscape","portrait"]},"showClock":{"type":"boolean"},"showBrand":{"type":"boolean"},"welcome":{"type":"string","maxLength":160},"warnAfterMin":{"type":"integer","minimum":1,"maximum":120},"lateAfterMin":{"type":"integer","minimum":2,"maximum":240},"showModifiers":{"type":"boolean"},"clearReadyAfterMin":{"type":"integer","minimum":1,"maximum":120},"chime":{"type":"boolean"},"showNext":{"type":"integer","minimum":0,"maximum":12},"counters":{"type":"array","items":{"type":"string","maxLength":40},"maxItems":12},"slides":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":40},"kind":{"type":"string","enum":["image","text","product"]},"title":{"type":"string","maxLength":120},"subtitle":{"type":"string","maxLength":240},"imageUrl":{"type":"string","format":"uri","maxLength":1000},"articleId":{"type":"string","maxLength":64,"description":"product slides: catalog product or article id."},"durationSec":{"type":"integer","minimum":3,"maximum":120,"default":10}},"required":["id","kind","durationSec"]},"maxItems":40},"transition":{"type":"string","enum":["fade","slide","morph"]},"showPrices":{"type":"boolean"},"qrUrl":{"type":"string","format":"uri","maxLength":1000},"showBookings":{"type":"boolean"},"showVisitors":{"type":"boolean"}}},"screens":{"type":"array","items":{"type":"string","enum":["pulse","feed","present","kitchen","orders","bookings","gate","promo","queue","menu","slides"]},"maxItems":12},"rotateSec":{"type":"integer","minimum":0,"maximum":3600},"burnInGuard":{"type":"boolean"},"quietHours":{"type":["array","null"],"items":{"type":"integer","minimum":0,"maximum":23},"minItems":2,"maxItems":2},"locale":{"type":"string","enum":["ro","en"]},"audience":{"type":"string","enum":["internal","public"],"description":"public = customer-facing; internal numbers are withheld. Forced to public for pickup/queue/reception/showcase/menu/announcements."},"lock":{"type":"object","properties":{"enabled":{"type":"boolean"},"pinSalt":{"type":["string","null"],"maxLength":64},"pinHash":{"type":["string","null"],"maxLength":128,"description":"hex SHA-256(salt + pin); the PIN itself is never stored."}},"required":["enabled","pinSalt","pinHash"]},"autostart":{"type":"boolean","description":"Start the app after a power cycle (device capability permitting)."}},"required":["profile","profileSettings","screens","rotateSec","burnInGuard","quietHours","locale","audience","lock","autostart"]},"DisplayMe":{"type":"object","properties":{"deviceId":{"type":["string","null"],"format":"uuid","description":"null for a personal (non-device) token."},"name":{"type":"string"},"mode":{"type":"string","enum":["org","personal"]},"org":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"logoUrl":{"type":["string","null"]},"accent":{"type":["string","null"]}},"required":["id","name","logoUrl","accent"]},"config":{"$ref":"#/components/schemas/DisplayConfig"},"available":{"type":"array","items":{"type":"string","enum":["pulse","feed","present","kitchen","orders","bookings","gate","promo","queue","menu","slides"]}},"assistant":{"type":"boolean","description":"Token carries display:assistant."}},"required":["deviceId","name","mode","org","config","available","assistant"]},"DisplaySnapshot":{"type":"object","description":"Discriminated by `kind` (= the requested screen). pulse: kpis, banks (IBAN last 4 only), collections (30 days), alerts. feed: items (≤ 50, newest first). present: period + slides (bars | line | waterfall | table). kitchen: tickets. orders: preparing/ready numbers. bookings: today. gate: last 40 visits. promo: items + payUrl. queue: serving per counter + next (initials only) + waitMin. menu: categories ≤ 12 × items ≤ 40. slides (showcase/announcements): resolved slides + qrUrl.","properties":{"kind":{"type":"string","enum":["pulse","feed","present","kitchen","orders","bookings","gate","promo","queue","menu","slides"]},"kpis":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"labelKey":{"type":"string"},"label":{"type":"string"},"value":{"oneOf":[{"$ref":"#/components/schemas/DisplayMoney"},{"type":"null"}]},"count":{"type":["integer","null"]},"delta":{"type":["number","null"],"description":"Signed fraction vs the comparison period (0.12 = +12 %)."},"spark":{"type":"array","items":{"type":"number"},"maxItems":60},"tone":{"type":"string","enum":["neutral","good","warn","bad"]}},"required":["id","labelKey","label","value","count","delta","spark","tone"]},"maxItems":12},"banks":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"ibanTail":{"type":"string","maxLength":6},"balance":{"$ref":"#/components/schemas/DisplayMoney"}},"required":["name","ibanTail","balance"]},"maxItems":12},"collections":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string","format":"date"},"minor":{"type":"integer"}},"required":["day","minor"]},"maxItems":31},"alerts":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"severity":{"type":"string","enum":["info","warn","critical"]},"titleKey":{"type":"string"},"title":{"type":"string"},"at":{"type":"string"}},"required":["id","severity","titleKey","title","at"]},"maxItems":10},"items":{"type":"array","description":"feed: DisplayFeedItem; bookings / gate / promo: per-screen rows.","items":{"type":"object"}},"period":{"type":"string"},"slides":{"type":"array","maxItems":40,"description":"present: chart slides (≤ 12). slides: DisplayResolvedSlide (≤ 40).","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"},"titleKey":{"type":"string"},"title":{"type":"string"},"chart":{"type":"string","enum":["bars","line","waterfall","table"]},"series":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"points":{"type":"array","items":{"type":"object","properties":{"x":{"type":"string"},"y":{"type":"number"}},"required":["x","y"]},"maxItems":36}},"required":["label","points"]},"maxItems":4},"total":{"oneOf":[{"$ref":"#/components/schemas/DisplayMoney"},{"type":"null"}]}},"required":["id","titleKey","title","chart","series","total"]},{"$ref":"#/components/schemas/DisplayResolvedSlide"}]}},"tickets":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"number":{"type":"string"},"title":{"type":"string"},"lines":{"type":"array","items":{"type":"object","properties":{"qty":{"type":"number"},"name":{"type":"string"},"note":{"type":["string","null"]}},"required":["qty","name","note"]},"maxItems":30},"status":{"type":"string","enum":["new","preparing","ready","done"]},"since":{"type":"string"}},"required":["id","number","title","lines","status","since"]},"maxItems":40},"preparing":{"type":"array","items":{"type":"string"},"maxItems":40},"ready":{"type":"array","items":{"type":"string"},"maxItems":40},"orgName":{"type":"string"},"logoUrl":{"type":["string","null"]},"payUrl":{"type":["string","null"]},"serving":{"type":"array","items":{"type":"object","properties":{"counter":{"type":"string"},"number":{"type":"string"},"at":{"type":"string"}},"required":["counter","number","at"]},"maxItems":12},"next":{"type":"array","items":{"type":"string"},"maxItems":12},"waitMin":{"type":["integer","null"],"description":"queue: estimated wait in minutes."},"categories":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":["string","null"]},"price":{"oneOf":[{"$ref":"#/components/schemas/DisplayMoney"},{"type":"null"}]},"imageUrl":{"type":["string","null"]}},"required":["id","name","description","price","imageUrl"]},"maxItems":40}},"required":["name","items"]},"maxItems":12},"qrUrl":{"type":["string","null"]}},"required":["kind"]},"DisplayResolvedSlide":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string","enum":["image","text","product"]},"title":{"type":["string","null"]},"subtitle":{"type":["string","null"]},"imageUrl":{"type":["string","null"]},"price":{"oneOf":[{"$ref":"#/components/schemas/DisplayMoney"},{"type":"null"}]},"durationSec":{"type":"integer"}},"required":["id","kind","title","subtitle","imageUrl","price","durationSec"]},"DisplayFeedItem":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["efactura.received","efactura.accepted","efactura.rejected","payment.received","invoice.issued","invoice.overdue","spv.message"]},"title":{"type":"string"},"counterparty":{"type":["string","null"]},"amount":{"oneOf":[{"$ref":"#/components/schemas/DisplayMoney"},{"type":"null"}]},"at":{"type":"string","format":"date-time"}},"required":["id","type","title","counterparty","amount","at"]},"DisplayKpi":{"type":"object","properties":{"id":{"type":"string"},"labelKey":{"type":"string"},"label":{"type":"string"},"value":{"oneOf":[{"$ref":"#/components/schemas/DisplayMoney"},{"type":"null"}]},"count":{"type":["integer","null"]},"delta":{"type":["number","null"],"description":"Signed fraction vs the comparison period (0.12 = +12 %)."},"spark":{"type":"array","items":{"type":"number"},"maxItems":60},"tone":{"type":"string","enum":["neutral","good","warn","bad"]}},"required":["id","labelKey","label","value","count","delta","spark","tone"]},"DisplayUnlockRequest":{"type":"object","additionalProperties":false,"required":["pin"],"properties":{"pin":{"type":"string","pattern":"^\\d{4,8}$"}}},"DisplayUnlockResponse":{"type":"object","properties":{"ok":{"type":"boolean","description":"true when the PIN matched the display lock."},"retryAfterSec":{"type":["integer","null"],"description":"Set on 429: seconds until the next attempt is accepted."}},"required":["ok","retryAfterSec"]},"DisplayAssistantRequest":{"type":"object","additionalProperties":false,"description":"Send `text` (on-device speech recognition) or `audio` (base64, ≤ 15 s). One of them is required.","properties":{"text":{"type":"string","minLength":1,"maxLength":500},"audio":{"type":"string","maxLength":400000},"mime":{"type":"string","maxLength":40},"locale":{"type":"string","enum":["ro","en"],"default":"ro"}}},"DisplayAssistantResponse":{"type":"object","properties":{"transcript":{"type":"string"},"answer":{"type":"string"},"kpi":{"oneOf":[{"$ref":"#/components/schemas/DisplayKpi"},{"type":"null"}]}},"required":["transcript","answer","kpi"]},"RewardProgram":{"type":"object","description":"Your organization's own programme (created on first use). Internal cost settings are never exposed.","properties":{"key":{"type":"string"},"kind":{"type":"string","enum":["tenant_shop"]},"name":{"type":"string"},"unitLabel":{"type":"string"},"status":{"type":"string"},"regulationVersion":{"type":"string"},"partnerRewardsEnabled":{"type":"boolean"},"config":{"type":"object","additionalProperties":true,"description":"Expiry, hold, caps, auto-approve threshold, time zone."}},"required":["key","kind","name","unitLabel","status"]},"RewardMemberUpsert":{"type":"object","additionalProperties":false,"description":"Exactly one of externalRef or customerId.","properties":{"externalRef":{"type":"string","minLength":1,"maxLength":200},"customerId":{"type":"string","format":"uuid","description":"An end customer of your organization."}}},"RewardMemberSummary":{"type":"object","properties":{"ref":{"type":"string"},"programKey":{"type":"string"},"memberId":{"type":"integer"},"optedIn":{"type":"boolean"},"optedInAt":{"type":["string","null"],"format":"date-time"},"holdout":{"type":"boolean"},"balance":{"type":"object","properties":{"available":{"type":"integer"},"pending":{"type":"integer"},"inDebt":{"type":"boolean"}},"required":["available","pending","inDebt"]},"level":{"type":"object","properties":{"level":{"type":"integer"},"xp":{"type":"integer"},"floor":{"type":"integer"},"next":{"type":["integer","null"]},"ratio":{"type":"number"}}},"streak":{"type":"object","properties":{"current":{"type":"integer"},"longest":{"type":"integer"},"freezes":{"type":"integer"},"atRisk":{"type":"boolean"},"currentPeriod":{"type":"string"},"activeThisPeriod":{"type":"boolean"}}},"expiry":{"type":["object","null"],"properties":{"units":{"type":"integer"},"at":{"type":"string","format":"date-time"}}},"perks":{"type":"array","items":{"type":"string"}}},"required":["ref","programKey","memberId","balance","level"]},"RewardHistoryItem":{"type":"object","properties":{"txnId":{"type":"integer"},"kind":{"type":"string"},"units":{"type":"integer","description":"Signed, from the member's point of view."},"ruleKey":{"type":["string","null"]},"memo":{"type":["string","null"]},"createdAt":{"type":"string","format":"date-time"}},"required":["txnId","kind","units","createdAt"]},"RewardEventCreate":{"type":"object","additionalProperties":false,"properties":{"type":{"type":"string","enum":["profile.completed","import.completed","bank.connected","integration.connected","tour.completed","quest.completed","feedback.accepted","bug.confirmed","forum.answer_accepted","referral.converted","referral.first_payment","activity.weekly","cabinet.client_migrated","academy.badge_earned","order.paid","order.refunded","custom"]},"ref":{"type":"string","maxLength":200,"description":"Your stable business reference (order id, …)."},"memberRef":{"type":"string","maxLength":200},"payload":{"type":"object","additionalProperties":true,"properties":{"units":{"type":"integer","minimum":1,"maximum":1000000,"description":"Units to award (issuer-defined)."}}},"occurredAt":{"type":"string","format":"date-time"}},"required":["type","ref","memberRef"]},"RewardEventResult":{"type":"object","properties":{"eventId":{"type":["integer","null"]},"duplicate":{"type":"boolean"},"status":{"type":"string","enum":["processed","skipped","already_processed","duplicate"]},"reason":{"type":["string","null"]},"unitsAwarded":{"type":"integer"},"xpAwarded":{"type":"integer"},"levelUp":{"type":["object","null"],"properties":{"from":{"type":"integer"},"to":{"type":"integer"}}},"badges":{"type":"array","items":{"type":"string"}}},"required":["eventId","duplicate","status","unitsAwarded"]},"RewardRedemptionCreate":{"type":"object","additionalProperties":false,"properties":{"catalogKey":{"type":"string","maxLength":120}},"required":["catalogKey"]},"RewardRedemptionResult":{"type":"object","properties":{"id":{"type":"integer"},"status":{"type":"string","enum":["pending_approval","approved","fulfilled","rejected","cancelled","failed"]},"duplicate":{"type":"boolean"}},"required":["id","status","duplicate"]},"RewardCatalogItem":{"type":"object","properties":{"id":{"type":"integer"},"key":{"type":"string"},"kind":{"type":"string","enum":["ai_credit","discount_code","partner_offer","gift_card","perk"]},"unitsCost":{"type":"integer"},"credits":{"type":["integer","null"]},"perk":{"type":["string","null"]},"available":{"type":"boolean"}},"required":["id","key","kind","unitsCost"]},"RewardClawbackCreate":{"type":"object","additionalProperties":false,"properties":{"refType":{"type":"string","maxLength":80,"description":"The event `type` that earned (e.g. order.paid)."},"refId":{"type":"string","maxLength":200,"description":"The event `ref` that earned."},"reason":{"type":"string","maxLength":200}},"required":["refType","refId","reason"]},"RewardClawbackResult":{"type":"object","properties":{"reversedUnits":{"type":"integer"}},"required":["reversedUnits"]},"RewardWidgetKeyCreate":{"type":"object","additionalProperties":false,"properties":{"allowedOrigins":{"type":"array","minItems":1,"maxItems":20,"items":{"type":"string","format":"uri","description":"scheme://host[:port], no path."}}},"required":["allowedOrigins"]},"RewardWidgetKey":{"type":"object","description":"`secret` is returned ONLY by the create call. Keep it on your server.","properties":{"kid":{"type":"string"},"secret":{"type":"string"},"programKey":{"type":"string"},"allowedOrigins":{"type":"array","items":{"type":"string"}},"createdAt":{"type":"string","format":"date-time"}},"required":["kid","secret","programKey","allowedOrigins"]},"RewardWidgetKeyRevoked":{"type":"object","properties":{"kid":{"type":"string"},"revoked":{"type":"boolean"}},"required":["kid","revoked"]},"RewardWidgetSessionCreate":{"type":"object","additionalProperties":false,"properties":{"kid":{"type":"string"},"token":{"type":"string","description":"HS256 JWT signed by your server: sub, prg, iat, exp (≤ 15 min after iat), jti."}},"required":["kid","token"]},"RewardWidgetSession":{"type":"object","properties":{"sessionToken":{"type":"string"},"expiresAt":{"type":"string","format":"date-time"},"scope":{"type":"string","enum":["read"]}},"required":["sessionToken","expiresAt","scope"]},"RewardWidgetMe":{"type":"object","properties":{"program":{"type":"object","properties":{"name":{"type":"string"},"unitLabel":{"type":"string"}}},"summary":{"$ref":"#/components/schemas/RewardMemberSummary"},"history":{"type":"array","items":{"$ref":"#/components/schemas/RewardHistoryItem"}},"badges":{"type":"array","description":"Badges the member has earned (newest catalogue order).","items":{"type":"object","properties":{"key":{"type":"string"},"family":{"type":"string"},"icon":{"type":"string"},"awardedAt":{"type":["string","null"],"format":"date-time"}},"required":["key","family","icon"]}}},"required":["program","summary","history"]},"ShippingPoint":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"courier":{"type":"string","enum":["sameday","cargus","fancourier","dpd","gls"]},"external_id":{"type":"string","description":"The courier's own point id"},"type":{"type":"string","enum":["locker","shop","office","post"]},"name":{"type":"string"},"address":{"type":"string"},"city":{"type":"string"},"county":{"type":["string","null"]},"postal_code":{"type":["string","null"]},"country":{"type":"string"},"lat":{"type":["number","null"]},"lng":{"type":["number","null"]},"schedule":{"type":"array","items":{"type":"object","properties":{"day":{"type":"string"},"open":{"type":"string"},"close":{"type":"string"}}}},"supports_cod":{"type":"boolean"},"supports_card":{"type":"boolean"},"max_weight_kg":{"type":["number","null"]},"distance_km":{"type":["number","null"],"description":"From `near`, when given"}},"required":["id","courier","external_id","type","name","address","city","country","supports_cod","supports_card"]},"Shipment":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"courier":{"type":"string","enum":["sameday","cargus","fancourier","dpd","gls","manual"]},"status":{"type":"string","enum":["draft","awb_generated","picked_up","in_transit","out_for_delivery","delivered","returned","cancelled","failed"]},"awb_number":{"type":["string","null"]},"service_code":{"type":["string","null"]},"pickup_point_id":{"type":["string","null"],"format":"uuid"},"order_id":{"type":["string","null"],"format":"uuid"},"invoice_id":{"type":["string","null"],"format":"uuid"},"channel_order_id":{"type":["string","null"],"format":"uuid"},"is_return":{"type":"boolean"},"parcel_count":{"type":"integer"},"weight_kg":{"type":"number"},"cod_amount":{"type":"number"},"cost":{"type":["number","null"]},"has_label":{"type":"boolean","description":"GET /shipments/{id}/label returns a document"},"sender":{"type":["object","null"],"description":"Sender address as sent to the courier (the organisation)"},"tracking_events":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string"},"description":{"type":"string"},"at":{"type":"string","format":"date-time"},"location":{"type":"string"}}}},"last_tracked_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["id","courier","status","is_return","parcel_count","weight_kg","cod_amount","has_label","tracking_events","created_at","updated_at"]},"ShipmentQuoteRequest":{"type":"object","additionalProperties":false,"properties":{"recipient":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":200},"phone":{"type":"string","maxLength":40},"email":{"type":"string","format":"email"},"street":{"type":"string","maxLength":300},"city":{"type":"string","maxLength":120},"county":{"type":"string","maxLength":120},"postal_code":{"type":"string","maxLength":20},"country":{"type":"string","minLength":2,"maxLength":2,"default":"RO"}},"required":["name","phone","city"]},"parcel":{"type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":1,"maximum":99,"default":1},"weight_kg":{"type":"number","exclusiveMinimum":0,"maximum":1000},"contents":{"type":"string","maxLength":200}},"required":["weight_kg"]},"cod_amount":{"type":"number","minimum":0,"default":0},"declared_value":{"type":"number","minimum":0},"pickup_point_id":{"type":"string","format":"uuid","description":"Narrows the comparison to that point's courier"},"couriers":{"type":"array","items":{"type":"string","enum":["sameday","cargus","fancourier","dpd","gls"]}}},"required":["recipient","parcel"]},"ShipmentQuoteResult":{"type":"object","properties":{"quotes":{"type":"array","items":{"type":"object","properties":{"courier":{"type":"string","enum":["sameday","cargus","fancourier","dpd","gls"]},"service_code":{"type":["string","null"]},"service_name":{"type":"string"},"cost":{"type":"number"},"currency":{"type":"string"},"eta_days":{"type":["integer","null"]},"estimated":{"type":"boolean","description":"Our formula, not the courier tariff"},"cheapest":{"type":"boolean","description":"Cheapest real (non-estimated) tariff"}}}},"couriers":{"type":"array","items":{"type":"object","properties":{"courier":{"type":"string","enum":["sameday","cargus","fancourier","dpd","gls"]},"status":{"type":"string","enum":["ok","not_configured","timeout","failed"]}}}}},"required":["quotes","couriers"]},"ShipmentCreate":{"type":"object","additionalProperties":false,"properties":{"courier":{"type":"string","enum":["sameday","cargus","fancourier","dpd","gls"]},"service_code":{"type":"string","maxLength":40,"description":"From a quote"},"reference":{"type":"string","maxLength":80,"description":"Your order number, printed on the label"},"recipient":{"type":"object","additionalProperties":false,"properties":{"name":{"type":"string","maxLength":200},"phone":{"type":"string","maxLength":40},"email":{"type":"string","format":"email"},"street":{"type":"string","maxLength":300},"city":{"type":"string","maxLength":120},"county":{"type":"string","maxLength":120},"postal_code":{"type":"string","maxLength":20},"country":{"type":"string","minLength":2,"maxLength":2,"default":"RO"}},"required":["name","phone","city"]},"parcel":{"type":"object","additionalProperties":false,"properties":{"count":{"type":"integer","minimum":1,"maximum":99,"default":1},"weight_kg":{"type":"number","exclusiveMinimum":0,"maximum":1000},"contents":{"type":"string","maxLength":200}},"required":["weight_kg"]},"cod_amount":{"type":"number","minimum":0,"default":0},"declared_value":{"type":"number","minimum":0},"pickup_point_id":{"type":"string","format":"uuid","description":"Re-validated: active, same courier, accepts COD, fits the weight"},"order_id":{"type":"string","format":"uuid"},"invoice_id":{"type":"string","format":"uuid"},"channel_order_id":{"type":"string","format":"uuid"}},"required":["courier","reference","recipient","parcel"]}}},"webhooks":{"invoice.paid":{"post":{"summary":"An ISSUED invoice was settled in full. Fires from every path that records money — manual entry, bank match, card settlement (Stripe/Netopia/Revolut), honoured instrument, collective receipt, Telegram. Idempotent per payment: `id` = `evt_pay_`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["invoice.paid"]},"data":{"$ref":"#/components/schemas/InvoicePaymentWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged. Any 2xx stops retries; anything else is retried on the published ladder."}}}},"invoice.partially_paid":{"post":{"summary":"A payment was recorded against an ISSUED invoice and a balance remains. Same producers and idempotency as invoice.paid; `remaining_amount` is the balance still open.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["invoice.partially_paid"]},"data":{"$ref":"#/components/schemas/InvoicePaymentWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"invoice.payment_reversed":{"post":{"summary":"A recorded payment on an ISSUED invoice was reversed and the balance re-opened. Idempotent per reversal row (evt_rev_); reversal.reverses_payment_id names the payment to undo.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["invoice.payment_reversed"]},"data":{"$ref":"#/components/schemas/InvoicePaymentReversedWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"invoice.credited":{"post":{"summary":"A credit note (storno) reversing an ISSUED invoice was issued or cancelled and changed the source invoice's credited amount. A storno cancels debt — it is not a payment. Idempotent per credited amount: id = evt_cred__, so a re-sync landing on the same amount is a re-delivery of the same event.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["invoice.credited"]},"data":{"$ref":"#/components/schemas/InvoiceCreditedWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"contact.fiscal_status_changed":{"post":{"summary":"A customer with open ISSUED invoices changed fiscal status at ANAF or the trade registry: became inactive (art. 92 CPF) or was reactivated, was struck off or dissolved, entered insolvency, registered or deregistered for VAT, or entered or left TVA la încasare. Checked daily; the first observation of a contact is a baseline and emits nothing. Idempotent: id = evt_fsc___, where kind and date are those of the first entry in changes.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["contact.fiscal_status_changed"]},"data":{"$ref":"#/components/schemas/ContactFiscalStatusWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"delivery_route.dispatched":{"post":{"summary":"A delivery route was dispatched: the route sheet was sent to its driver and the route is DISPATCHED. Ids and counts only (no driver contact, recipients or addresses). A re-dispatch is a new event. Id evt_delivery_route__dispatched_.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["delivery_route.dispatched"]},"data":{"$ref":"#/components/schemas/DeliveryRouteDispatchedWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"fleet_vehicle.created":{"post":{"summary":"A fleet vehicle was added (in the app or through the API). Idempotent: id evt_fleet_vehicle__created.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["fleet_vehicle.created"]},"data":{"$ref":"#/components/schemas/FleetVehicleWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"fleet_vehicle.updated":{"post":{"summary":"A fleet vehicle changed. changed_fields lists the wire names of the fields whose value changed, never the values; an edit that changes nothing emits nothing. Id evt_fleet_vehicle__upd_.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["fleet_vehicle.updated"]},"data":{"$ref":"#/components/schemas/FleetVehicleWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"fleet_vehicle.deleted":{"post":{"summary":"A fleet vehicle was deleted, with its odometer and service logs. Idempotent: id evt_fleet_vehicle__del.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["fleet_vehicle.deleted"]},"data":{"$ref":"#/components/schemas/FleetVehicleWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"court_case.hearing_added":{"post":{"summary":"A hearing was added to a court case. Case and hearing ids, date and court only; no parties, panel, solution or notes. Idempotent: id evt_court_hearing_.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["court_case.hearing_added"]},"data":{"$ref":"#/components/schemas/CourtHearingAddedWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"email.received":{"post":{"summary":"An inbound message landed in one of the organisation's Brivio mailboxes (inbox or a custom folder; not spam, trash, drafts or its own outbound mail; history imported by a first sync is not announced). Metadata only — never the body, snippet, cc/bcc or attachment names. Idempotent per stored message: a re-sync never announces it twice.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["email.received"]},"data":{"$ref":"#/components/schemas/EmailReceivedWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"subscription.activated":{"post":{"summary":"A merchant catalog subscription (POST /v1/subscriptions) became active or trialing — first payment confirmed, or recovered from past_due. Idempotent per underlying Stripe event: `id` = `evt_sub_`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["subscription.activated"]},"data":{"$ref":"#/components/schemas/SubscriptionWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"subscription.updated":{"post":{"summary":"A merchant catalog subscription changed status, renewed (new current_period_end) or toggled cancel_at_period_end. Same idempotency as subscription.activated.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["subscription.updated"]},"data":{"$ref":"#/components/schemas/SubscriptionWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}},"subscription.canceled":{"post":{"summary":"A merchant catalog subscription ended (canceled or incomplete_expired). Revoke access here. Same idempotency as subscription.activated.","requestBody":{"required":true,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/WebhookDelivery"},{"type":"object","properties":{"type":{"type":"string","enum":["subscription.canceled"]},"data":{"$ref":"#/components/schemas/SubscriptionWebhookData"}}}]}}}},"responses":{"200":{"description":"Acknowledged."}}}}},"paths":{"/me":{"get":{"summary":"Identify the authenticated organization","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["me"],"operationId":"listMe"}},"/contacts":{"get":{"summary":"List contacts","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Contact"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contacts"],"operationId":"listContacts"},"post":{"summary":"Create a contact","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Contact"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contacts"],"operationId":"createContact"}},"/contacts/{id}":{"get":{"summary":"Get a contact","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Contact"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contacts"],"operationId":"getContact"},"patch":{"summary":"Update a contact","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Contact"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contacts"],"operationId":"updateContact"},"delete":{"summary":"Delete a contact","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contacts"],"operationId":"deleteContact"}},"/companies/lookup":{"get":{"summary":"Look up a company by CUI (scope: contacts:read)","description":"Auto-fill Persoană Juridică billing details from a CUI. Returns an empty result list rather than 404 when nothing matches. Scope: contacts:read.","parameters":[{"name":"cui","in":"query","schema":{"type":"string"},"description":"The CUI to look up"},{"name":"q","in":"query","schema":{"type":"string"},"description":"Alias for cui"}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["companies"],"operationId":"listCompanyLookup"}},"/companies/search":{"get":{"summary":"Search the public company registry (compact URL filters)","description":"Prospectare: filter ~2M Romanian companies. Same query-string codec as the /prospecting web UI (e.g. ?jud=CLUJ§=62&fin=employees:latest:10-). Scope: companies:read.","parameters":[{"name":"q","in":"query","schema":{"type":"string"},"description":"Free text (name/CUI)"},{"name":"caen","in":"query","schema":{"type":"string"},"description":"CAEN codes, comma-separated"},{"name":"sect","in":"query","schema":{"type":"string"},"description":"CAEN divisions, comma-separated"},{"name":"jud","in":"query","schema":{"type":"string"},"description":"Counties, comma-separated"},{"name":"fin","in":"query","schema":{"type":"string"},"description":"Financial ranges, e.g. revenue:latest:1000000-"},{"name":"trend","in":"query","schema":{"type":"string"},"description":"Trend filters, e.g. profitableYears:3"},{"name":"adm","in":"query","schema":{"type":"string"},"description":"Administrator/associate name"},{"name":"sort","in":"query","schema":{"type":"string","enum":["relevance","name","nameDesc","revenue","revenueAsc","employees","employeesAsc","foundedNewest","foundedOldest"]}},{"name":"p","in":"query","schema":{"type":"integer"},"description":"Page"},{"name":"n","in":"query","schema":{"type":"integer"},"description":"Page size (max 200)"},{"name":"stats","in":"query","schema":{"type":"boolean"},"description":"Include aggregate stats"}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["companies"],"operationId":"listCompanySearch"},"post":{"summary":"Search the public company registry (full filter model)","description":"Body: { groups: FilterGroup[], sort?, page?, pageSize?, stats? }. AND between groups, OR within a group; groups support exclude:true (NOT). Scope: companies:read.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["groups"],"properties":{"groups":{"type":"array","items":{"type":"object"}},"sort":{"type":"string"},"page":{"type":"integer"},"pageSize":{"type":"integer"},"stats":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["companies"],"operationId":"createCompanySearch"}},"/companies/{cui}/similar":{"get":{"summary":"Find similar companies (same CAEN, county, size band)","parameters":[{"name":"cui","in":"path","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","schema":{"type":"integer","maximum":25}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["companies"],"operationId":"listCompanySimilar"}},"/articles":{"get":{"summary":"List articles","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Article"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"listArticles"},"post":{"summary":"Create an article","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArticleCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Article"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"createArticle"}},"/articles/sync":{"post":{"summary":"Upsert articles by external_id (idempotent bulk sync, ADR-0212; scope: articles:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"createArticleSync"}},"/articles/{id}":{"get":{"summary":"Get a article","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Article"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"getArticle"},"patch":{"summary":"Update a article","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Article"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"updateArticle"},"delete":{"summary":"Delete a article","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"deleteArticle"}},"/articles/{id}/prices":{"get":{"summary":"List an article's prices (scope: articles:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"listArticlePrices"},"post":{"summary":"Add a price (one_time | month | year | metered) to an article (scope: articles:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"createArticlePrice"}},"/articles/{id}/components":{"get":{"summary":"List a bundle's components (ADR-0225; scope: articles:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"listArticleComponents"},"put":{"summary":"Replace a bundle's components — no nesting, no duplicates (ADR-0225; scope: articles:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["components"],"properties":{"components":{"type":"array","items":{"$ref":"#/components/schemas/BundleComponent"}}}}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"updateArticleComponent"}},"/articles/{id}/prices/sync":{"post":{"summary":"Push the article's active prices to the org's Stripe account (metered prices get a Billing Meter; scope: articles:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["articles"],"operationId":"createArticlePriceSync"}},"/invoices":{"get":{"summary":"List invoices","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"listInvoices"},"post":{"summary":"Create an invoice","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Invoice"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"createInvoice"}},"/compat/oblio/docs/invoice":{"post":{"operationId":"createOblioCompatInvoice","summary":"Compat shim: create an invoice with an Oblio-shaped payload (Oblio POST /api/docs/invoice)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["compat"]}},"/compat/oblio/docs/invoice/cancel":{"put":{"operationId":"cancelOblioCompatInvoice","summary":"Compat shim: cancel an invoice by seriesName + number (Oblio-shaped)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["compat"]}},"/compat/smartbill/invoice":{"post":{"operationId":"createSmartBillCompatInvoice","summary":"Compat shim: create an invoice with a SmartBill-shaped payload (SmartBill POST /SBORO/api/invoice)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["compat"]}},"/compat/smartbill/invoice/cancel":{"delete":{"operationId":"cancelSmartBillCompatInvoice","summary":"Compat shim: cancel an invoice by seriesname + number query params (SmartBill-shaped)","parameters":[{"name":"seriesname","in":"query","required":true,"schema":{"type":"string"}},{"name":"number","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["compat"]}},"/invoices/{id}":{"get":{"summary":"Get a invoice","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Invoice"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"getInvoice"},"patch":{"summary":"Update a invoice","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Invoice"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"updateInvoice"},"delete":{"summary":"Delete a invoice","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"deleteInvoice"}},"/invoices/{id}/items":{"get":{"summary":"List line items of an invoice","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"listInvoiceItems"}},"/invoices/{id}/payments":{"get":{"summary":"List payments recorded against an invoice","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"listInvoicePayments"},"post":{"summary":"Record a payment against an invoice (updates status)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePaymentCreate"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"createInvoicePayment"}},"/invoices/{id}/credit-note":{"post":{"summary":"Issue a credit note (storno) for an issued invoice, full or per line; 422 CREDIT_EXCEEDS_SOURCE when over-crediting (scope: invoices:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"creditNoteInvoice"}},"/invoices/{id}/pdf":{"get":{"summary":"Invoice PDF (application/pdf attachment; scope: invoices:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"PDF document","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}}},"tags":["invoices"],"operationId":"listInvoicePdf"}},"/invoices/{id}/payment-link":{"post":{"summary":"Get (minting on first call) the invoice's public pay URL (scope: payments:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"paymentLinkInvoice"}},"/invoices/{id}/send":{"post":{"summary":"Mark an invoice as sent (DRAFT → SENT; idempotent)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"sendInvoice"}},"/invoices/{id}/efactura-status":{"get":{"summary":"e-Factura transmission status of an invoice","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"listInvoiceEfacturaStatus"}},"/invoices/{id}/submit-efactura":{"post":{"summary":"Submit an invoice to ANAF e-Factura","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["invoices"],"operationId":"submitEfacturaInvoice"}},"/projects":{"get":{"summary":"List projects","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Project"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["projects"],"operationId":"listProjects"},"post":{"summary":"Create a project","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Project"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["projects"],"operationId":"createProject"}},"/projects/{id}":{"get":{"summary":"Get a project","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Project"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["projects"],"operationId":"getProject"},"patch":{"summary":"Update a project","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Project"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["projects"],"operationId":"updateProject"},"delete":{"summary":"Delete a project","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["projects"],"operationId":"deleteProject"}},"/projects/{id}/allocations":{"get":{"summary":"Project team with each person's org-wide weekly load vs capacity (L-R4-PROJ-07; scope: projects:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Any date in the first ISO week (default: today)"},{"name":"weeks","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":26,"default":12}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["projects"],"operationId":"listProjectAllocations"},"put":{"summary":"Book a person on the project for one ISO week; 0 hours clears; reports over_allocated (L-R4-PROJ-07; scope: projects:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AllocationInput"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["projects"],"operationId":"updateProjectAllocation"}},"/resourcing":{"get":{"summary":"People x ISO weeks across the org: allocated vs available hours, overage per week (L-R4-PROJ-07; scope: projects:read)","parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"Any date in the first ISO week (default: today)"},{"name":"weeks","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":26,"default":12}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["resourcing"],"operationId":"listResourcing"}},"/quotes":{"get":{"summary":"List quotes (read-only)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Quote"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["quotes"],"operationId":"listQuotes"}},"/quotes/{id}":{"get":{"summary":"Get a quote","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Quote"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["quotes"],"operationId":"getQuote"}},"/time-entries":{"get":{"summary":"List time entries (read-only)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimeEntry"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["time-entries"],"operationId":"listTimeEntries"}},"/time-entries/{id}":{"get":{"summary":"Get a time entry","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeEntry"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["time-entries"],"operationId":"getTimeEntry"}},"/expenses":{"get":{"summary":"List expenses","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Expense"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["expenses"],"operationId":"listExpenses"},"post":{"summary":"Create an expense","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExpenseCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Expense"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["expenses"],"operationId":"createExpense"}},"/expenses/{id}":{"get":{"summary":"Get a expense","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Expense"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["expenses"],"operationId":"getExpense"},"patch":{"summary":"Update a expense","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Expense"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["expenses"],"operationId":"updateExpense"},"delete":{"summary":"Delete a expense","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["expenses"],"operationId":"deleteExpense"}},"/contracts":{"get":{"summary":"List contracts","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Contract"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contracts"],"operationId":"listContracts"},"post":{"summary":"Create a contract","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Contract"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contracts"],"operationId":"createContract"}},"/contracts/{id}":{"get":{"summary":"Get a contract","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Contract"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contracts"],"operationId":"getContract"},"patch":{"summary":"Update a contract","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Contract"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contracts"],"operationId":"updateContract"},"delete":{"summary":"Delete a contract","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contracts"],"operationId":"deleteContract"}},"/contract-obligations":{"get":{"summary":"Contract obligations register across contracts, oldest due first (scope: contracts:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"contract_id","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"bucket","in":"query","schema":{"type":"string","enum":["open","overdue","due_soon","upcoming","undated","done"],"default":"open"}},{"name":"obligor","in":"query","schema":{"type":"string","enum":["us","counterparty"]}},{"name":"assignee_user_id","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"q","in":"query","schema":{"type":"string"},"description":"Matches title, clause label or contract name."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractObligation"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contract-obligations"],"operationId":"listContractObligations"},"post":{"summary":"Create a contract obligation (scope: contracts:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractObligationCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractObligation"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contract-obligations"],"operationId":"createContractObligation"}},"/contract-obligations/{id}":{"get":{"summary":"Get a contract obligation (scope: contracts:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractObligation"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contract-obligations"],"operationId":"getContractObligation"},"patch":{"summary":"Update a contract obligation (scope: contracts:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractObligationUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractObligation"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contract-obligations"],"operationId":"updateContractObligation"},"delete":{"summary":"Delete a contract obligation (scope: contracts:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK — `{ id, deleted: true }`"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contract-obligations"],"operationId":"deleteContractObligation"}},"/contract-obligations/{id}/complete":{"post":{"summary":"Complete a contract obligation; a recurring one returns its next occurrence (scope: contracts:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContractObligationComplete"}}}},"responses":{"200":{"description":"OK — `{ obligation, next }`","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"obligation":{"$ref":"#/components/schemas/ContractObligation"},"next":{"allOf":[{"$ref":"#/components/schemas/ContractObligation"}],"nullable":true}}}}}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contract-obligations"],"operationId":"completeContractObligation"}},"/contract-obligations/{id}/reopen":{"post":{"summary":"Reopen a completed contract obligation (scope: contracts:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractObligation"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["contract-obligations"],"operationId":"reopenContractObligation"}},"/documents":{"get":{"summary":"List documents","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Document"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["documents"],"operationId":"listDocuments"},"post":{"summary":"Create a document","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Document"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["documents"],"operationId":"createDocument"}},"/documents/{id}":{"get":{"summary":"Get a document","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Document"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["documents"],"operationId":"getDocument"},"patch":{"summary":"Update a document","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Document"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["documents"],"operationId":"updateDocument"},"delete":{"summary":"Delete a document","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["documents"],"operationId":"deleteDocument"}},"/locations":{"get":{"summary":"List locations","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Location"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["locations"],"operationId":"listLocations"},"post":{"summary":"Create a location","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Location"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["locations"],"operationId":"createLocation"}},"/locations/{id}":{"get":{"summary":"Get a location","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Location"},"error":{"type":"null"}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["locations"],"operationId":"getLocation"}},"/modules":{"get":{"summary":"List module entitlements","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Module"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["modules"],"operationId":"listModules"}},"/realtime/stream":{"get":{"summary":"Server-Sent Events stream of realtime org events (text/event-stream)","responses":{"200":{"description":"SSE stream; events follow the outbound webhook event catalog"}},"tags":["realtime"],"operationId":"listRealtimeStream"}},"/webhooks":{"get":{"summary":"List webhook subscriptions","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["webhooks"],"operationId":"listWebhooks"},"post":{"summary":"Create a webhook subscription","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["webhooks"],"operationId":"createWebhook"}},"/affiliates":{"get":{"summary":"List affiliates in your program (scope: affiliates:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["affiliates"],"operationId":"listAffiliates"},"post":{"summary":"Enroll an affiliate by email (scope: affiliates:write)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["affiliates"],"operationId":"createAffiliate"}},"/affiliates/{id}":{"get":{"summary":"Get an affiliate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["affiliates"],"operationId":"getAffiliate"}},"/affiliates/{id}/referrals":{"get":{"summary":"List referrals for an affiliate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["affiliates"],"operationId":"listAffiliateReferrals"}},"/affiliates/{id}/commissions":{"get":{"summary":"List commission ledger entries for an affiliate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["affiliates"],"operationId":"listAffiliateCommissions"}},"/affiliates/{id}/codes":{"post":{"summary":"Create a referral code for an affiliate (scope: affiliates:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["affiliates"],"operationId":"createAffiliateCode"}},"/affiliate-events/click":{"post":{"summary":"Record a referral click from an external storefront (scope: affiliates:write)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["affiliate-events"],"operationId":"createAffiliateEventClick"}},"/webhooks/events":{"get":{"summary":"List available webhook event types","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["webhooks"],"operationId":"listWebhookEvents"}},"/comms/conversations":{"get":{"summary":"List conversations your organization participates in (scope: comms:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"scope","in":"query","schema":{"type":"string","enum":["internal","external"]}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["comms"],"operationId":"listCommConversations"}},"/comms/conversations/{id}":{"get":{"summary":"Get one conversation (scope: comms:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["comms"],"operationId":"getCommConversation"}},"/comms/conversations/{id}/messages":{"get":{"summary":"List messages in a conversation; encrypted bodies are masked (scope: comms:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["comms"],"operationId":"listCommConversationMessages"},"post":{"summary":"Send a message as your organization; refused on end-to-end encrypted conversations (scope: comms:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["comms"],"operationId":"createCommConversationMessage"}},"/connect/outreach":{"get":{"summary":"List Connect outreach initiated by your organization (scope: connect:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string","enum":["draft","pending_approval","sent","accepted","declined","expired","blocked"]}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["connect"],"operationId":"listConnectOutreach"}},"/connect/outreach/{id}":{"get":{"summary":"Get the status of one outreach attempt (scope: connect:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["connect"],"operationId":"getConnectOutreach"}},"/network/partners":{"get":{"summary":"Ranked search of verified providers in the Brivio business network; notaries are never listed and lawyers are unranked/unrated by professional rules (scope: network:read)","parameters":[{"name":"category","in":"query","schema":{"type":"string"}},{"name":"county","in":"query","schema":{"type":"string"}},{"name":"city","in":"query","schema":{"type":"string"}},{"name":"q","in":"query","schema":{"type":"string"},"description":"Substring of the display name"},{"name":"limit","in":"query","schema":{"type":"integer","maximum":50}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["network"],"operationId":"listNetworkPartners"}},"/network/requests":{"get":{"summary":"List service requests: role=requester (raised by your organization) or role=provider (your inbox, requester redacted to a label) (scope: network:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"role","in":"query","schema":{"type":"string","enum":["requester","provider"]}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["network"],"operationId":"listNetworkRequests"},"post":{"summary":"Create a service request (RFQ) to at most 3 verified listings chosen from /network/partners; no payment is involved (scope: network:write)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["network"],"operationId":"createNetworkRequest"}},"/network/requests/{id}":{"get":{"summary":"Get one request: full view with every quote for the requester; redacted view with only your own quote for a targeted provider (scope: network:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["network"],"operationId":"getNetworkRequest"}},"/network/requests/{id}/quotes":{"post":{"summary":"Submit a quote on a request your organization was asked to quote; a new quote supersedes your live one (scope: network:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["network"],"operationId":"createNetworkRequestQuote"}},"/network/requests/{id}/withdraw":{"post":{"summary":"Withdraw an open request you raised; live quotes are declined (scope: network:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["network"],"operationId":"withdrawNetworkRequest"}},"/network/quotes/{id}/accept":{"post":{"summary":"Accept a quote on your request: closes the request, declines the others and creates a platform-originated relationship. Money never transits Brivio (ADR-0147) (scope: network:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["network"],"operationId":"acceptNetworkQuote"}},"/network/quotes/{id}/decline":{"post":{"summary":"Decline one quote on your request (scope: network:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["network"],"operationId":"declineNetworkQuote"}},"/network/relationships":{"get":{"summary":"List business relationships where your organization is the provider or the client, with origin and service kind; never the counterpart's contact details (scope: network:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["network"],"operationId":"listNetworkRelationships"}},"/webhooks/{id}":{"get":{"summary":"Get a webhook subscription","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["webhooks"],"operationId":"getWebhook"},"patch":{"summary":"Update a webhook subscription (set rotate_secret to rotate the signing secret)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["webhooks"],"operationId":"updateWebhook"},"delete":{"summary":"Delete a webhook subscription","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["webhooks"],"operationId":"deleteWebhook"}},"/webhooks/{id}/deliveries":{"get":{"summary":"List delivery attempts for a webhook","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string","enum":["pending","success","failed"]}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["webhooks"],"operationId":"listWebhookDeliveries"}},"/orders/{id}/status":{"post":{"summary":"Transition an order status: pending|paid|fulfilled|cancelled|refunded (scope: orders:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["orders"],"operationId":"statusOrder"}},"/webhooks/{id}/deliveries/{deliveryId}/redeliver":{"post":{"summary":"Redeliver a failed/dead delivery — resets the attempt budget and schedules it due-now; pass {\"force\":true} to redeliver an already-succeeded delivery (scope: webhooks:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"deliveryId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["webhooks"],"operationId":"redeliverWebhookDelivery"}},"/inventory/stock":{"get":{"summary":"Current stock levels for stock-tracked articles","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"},"description":"Page size (max 100). `per_page` is accepted as a legacy alias."},{"name":"cursor","in":"query","schema":{"type":"string"},"description":"Opaque keyset cursor (from meta.nextCursor); takes precedence over page"}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["inventory"],"operationId":"listInventoryStock"}},"/inventory/stock-by-location":{"get":{"summary":"Per-location (gestiune) stock balances","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"},"description":"Page size (max 100). `per_page` is accepted as a legacy alias."},{"name":"article_id","in":"query","schema":{"type":"string"}},{"name":"location_id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["inventory"],"operationId":"listInventoryStockByLocation"}},"/series":{"get":{"summary":"List document numbering series (read-only)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"},"description":"Page size (max 100). `per_page` is accepted as a legacy alias."},{"name":"document_type","in":"query","schema":{"type":"string"}},{"name":"active","in":"query","schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["series"],"operationId":"listSeries"}},"/taxes/vat-rates":{"get":{"summary":"Romanian VAT rates valid on a date","parameters":[{"name":"date","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["taxes"],"operationId":"listTaxeVatRates"}},"/inventory/movements":{"get":{"summary":"Stock movement history","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"},"description":"Page size (max 100). `per_page` is accepted as a legacy alias."},{"name":"cursor","in":"query","schema":{"type":"string"},"description":"Opaque keyset cursor (from meta.nextCursor); takes precedence over page"}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["inventory"],"operationId":"listInventoryMovements"}},"/inventory/nir":{"get":{"summary":"List goods receipt notes (NIR)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["inventory"],"operationId":"listInventoryNir"}},"/inventory/nir/{id}":{"get":{"summary":"Get a goods receipt note with line items","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["inventory"],"operationId":"getInventoryNir"}},"/hr/employees":{"get":{"summary":"Employee directory (PII excluded)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"},"description":"Page size (max 100). `per_page` is accepted as a legacy alias."},{"name":"cursor","in":"query","schema":{"type":"string"},"description":"Opaque keyset cursor (from meta.nextCursor); takes precedence over page"}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["hr"],"operationId":"listHrEmployees"}},"/orders":{"get":{"summary":"List storefront orders (scope: orders:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["orders"],"operationId":"listOrders"}},"/orders/{id}":{"get":{"summary":"Get a storefront order with line items","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["orders"],"operationId":"getOrder"}},"/orders/import":{"post":{"summary":"Import an e-commerce order (Shopify/WooCommerce connectors) into the channel sync engine — stored as a channel order (stock reserved, invoice drafted by the engine), deduped by source+external_id; returns channel_order_id (scope: orders:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["customer","lines","total"],"properties":{"source":{"type":"string","enum":["shopify","woocommerce","other"],"default":"other"},"external_id":{"type":"string","maxLength":255,"description":"Order id in the source system (required; snake_case or camelCase accepted)"},"external_number":{"type":"string","maxLength":64,"description":"Human-facing order number in the source system"},"issuedAt":{"type":"string","description":"Order date (ISO 8601); defaults to today (Europe/Bucharest)"},"currency":{"type":"string","minLength":3,"maxLength":3,"default":"RON"},"customer":{"type":"object","required":["name"],"properties":{"name":{"type":"string","maxLength":255},"email":{"type":"string","format":"email"},"address":{"type":"object","properties":{"line1":{"type":"string"},"city":{"type":"string"},"countryCode":{"type":"string"},"postalCode":{"type":"string"}}}}},"lines":{"type":"array","minItems":1,"items":{"type":"object","required":["description","quantity","unitPrice"],"properties":{"description":{"type":"string","maxLength":500},"quantity":{"type":"number","exclusiveMinimum":0},"unitPrice":{"type":"string","description":"Decimal string, e.g. \"129.90\""},"sku":{"type":"string","maxLength":64}}}},"total":{"type":"string","description":"Decimal string order total"},"paid":{"type":"boolean","default":false}}}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["orders"],"operationId":"createOrderImport"}},"/sales-channels":{"get":{"summary":"List sales channels (eMAG, WooCommerce, Trendyol, …) with sync health; credentials are never returned (scope: orders:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["sales-channels"],"operationId":"listSalesChannels"}},"/sales-channels/{id}":{"get":{"summary":"Get a sales channel with sync health (scope: orders:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["sales-channels"],"operationId":"getSalesChannel"}},"/channel-orders":{"get":{"summary":"List orders imported from sales channels (scope: orders:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"channel_id","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"status","in":"query","schema":{"type":"string","enum":["new","acknowledged","in_progress","shipped","delivered","cancelled","returned","needs_mapping","oversold"]}},{"name":"updated_since","in":"query","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["channel-orders"],"operationId":"listChannelOrders"}},"/channel-orders/{id}":{"get":{"summary":"Get a channel order with its lines (scope: orders:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["channel-orders"],"operationId":"getChannelOrder"}},"/channel-orders/{id}/retry":{"post":{"summary":"Retry the stock reservation of an oversold or unmapped channel order (scope: orders:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["channel-orders"],"operationId":"retryChannelOrder"}},"/bookings":{"get":{"summary":"List service appointments (scope: bookings:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["bookings"],"operationId":"listBookings"},"post":{"summary":"Create a service appointment (scope: bookings:write)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["bookings"],"operationId":"createBooking"}},"/bookings/{id}":{"get":{"summary":"Get a service appointment","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["bookings"],"operationId":"getBooking"}},"/reservations":{"get":{"summary":"List hotel reservations (scope: reservations:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["reservations"],"operationId":"listReservations"}},"/reservations/{id}":{"get":{"summary":"Get a hotel reservation","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["reservations"],"operationId":"getReservation"}},"/construction/work-certificates":{"get":{"summary":"List work-progress certificates (situații de lucrări). Filter by project_id. (scope: projects:read)","parameters":[{"name":"project_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["construction"],"operationId":"listConstructionWorkCertificates"}},"/construction/projects/{id}/schedule":{"get":{"summary":"List the schedule activities (grafic de eșalonare) of a construction project, in order (scope: projects:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["construction"],"operationId":"listConstructionProjectSchedule"}},"/api-keys":{"get":{"summary":"List API keys for the calling environment (scope: api_keys:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["api-keys"],"operationId":"listApiKeys"},"post":{"summary":"Create an API key — raw key shown once (scope: api_keys:write)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["api-keys"],"operationId":"createApiKey"}},"/api-keys/{id}/rotate":{"post":{"summary":"Rotate an API key — issues a replacement with the same scopes; old key expires after grace_period_hours (default 24, 0 = immediate). Raw key shown once (scope: api_keys:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["api-keys"],"operationId":"rotateApiKey"}},"/api-keys/{id}":{"delete":{"summary":"Revoke an API key (scope: api_keys:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["api-keys"],"operationId":"deleteApiKey"}},"/banking/connections":{"get":{"summary":"List open-banking connections (scope: banking:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"listBankingConnections"}},"/banking/transactions":{"get":{"summary":"List imported bank transactions (scope: banking:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"match_status","in":"query","schema":{"type":"string"}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"listBankingTransactions"}},"/banking/transactions/{id}":{"get":{"summary":"Get a bank transaction with its invoice allocations and allocated/unapplied amounts (scope: banking:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"getBankingTransaction"}},"/banking/transactions/{id}/suggestions":{"get":{"summary":"Top-5 scored open-invoice candidates for a bank line, ranked by the reconciliation matcher (scope: banking:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"listBankingTransactionSuggestions"}},"/banking/transactions/{id}/match":{"post":{"summary":"Allocate a bank line to an invoice and post it to the ledger. Body { invoice_id, amount? }; amount caps the allocation in the transaction currency, omitted = full outstanding. Cross-currency is refused. (scope: banking:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["invoice_id"],"properties":{"invoice_id":{"type":"string","format":"uuid"},"amount":{"type":"number","exclusiveMinimum":0}}}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"matchBankingTransaction"}},"/banking/transactions/{id}/unmatch":{"post":{"summary":"Unmatch a bank line. A line already posted to the ledger is immutable and needs { storno: true } to be reversed (409 otherwise). (scope: banking:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"storno":{"type":"boolean"}}}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"unmatchBankingTransaction"}},"/banking/coverage":{"get":{"summary":"Reconciliation coverage per own bank account — matched / partially matched / ignored over total lines, bank-rule hit-rate, lines auto-settled by rules, plus org totals and active-rule counts. Own IBAN masked to last4. (scope: banking:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"listBankingCoverage"}},"/banking/statements":{"get":{"summary":"List imported bank statements — account IBAN masked to last4, balances, period, transaction counts (scope: banking:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"from","in":"query","schema":{"type":"string","format":"date"}},{"name":"to","in":"query","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"listBankingStatements"}},"/banking/statements/import":{"post":{"summary":"Import a bank statement file (csv, mt940, mt942, camt052/053/054, ofx). Parses, de-duplicates against previously imported lines, auto-matches open invoices and applies bank rules. Re-importing the same file is a safe no-op. Honours Idempotency-Key. (scope: banking:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["format","content"],"properties":{"format":{"type":"string","enum":["csv","mt940","mt942","camt053","camt052","camt054","ofx"]},"content":{"type":"string","description":"Raw file contents (max 5 MB)"},"sourceFilename":{"type":"string","maxLength":255}}}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"createBankingStatementImport"}},"/banking/statements/{id}":{"get":{"summary":"Get a bank statement with its transactions (paginated) (scope: banking:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"getBankingStatement"}},"/banking/rules":{"get":{"summary":"List bank reconciliation rules in priority order (scope: banking:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"listBankingRules"},"post":{"summary":"Create a bank rule. At least one condition and one action are required; a new rule goes last in priority. (scope: banking:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankRuleInput"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"createBankingRule"}},"/banking/rules/{id}":{"get":{"summary":"Get a bank rule (scope: banking:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"getBankingRule"},"patch":{"summary":"Update a bank rule. Partial body; the merged rule is re-validated in full. (scope: banking:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BankRuleInput"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"updateBankingRule"},"delete":{"summary":"Delete a bank rule (scope: banking:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"deleteBankingRule"}},"/banking/payment-batches":{"get":{"summary":"List payment batches (pain.001 / salary runs), read-only; debtor IBAN masked (scope: banking:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string"}},{"name":"kind","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"listBankingPaymentBatches"}},"/banking/payment-batches/{id}":{"get":{"summary":"Get a payment batch with its lines; creditor IBANs masked (scope: banking:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["banking"],"operationId":"getBankingPaymentBatche"}},"/cabinet/risk":{"get":{"summary":"ANAF risk score (0–100) of every client the key’s organisation manages (accounting practice), built from signals Brivio already records — the client’s own ANAF status, overdue declarations, ANAF-rejected e-Invoices (90 days), customers inactive at ANAF with open invoices, VAT / micro ceiling usage, P300 vs D300 differences and the last SAF-T vs D300/D394 cross-check — with the points and parameters of every signal and the signals that could not be checked. Highest score first. Read-only. 403 not_a_cabinet. (scope: accounting:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["cabinet"],"operationId":"listCabinetRisk"}},"/cabinet/spv-status":{"get":{"summary":"SPV / e-Factura status of every client the key’s organisation manages (accounting practice) — per client: last sync, unread (critical flagged), rejected uploads, invoices within 2 working days of the legal window, invoices past it, and the ANAF connection state and expiry. Read-only; the client set is the cabinet’s active managed companies. (scope: efactura:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["cabinet"],"operationId":"listCabinetSpvStatus"}},"/catalog":{"get":{"summary":"Sellable product catalog with synced prices (scope: articles:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["catalog"],"operationId":"listCatalog"}},"/customers/{externalId}":{"get":{"summary":"Consolidated billing view of an external customer (scope: invoices:read)","parameters":[{"name":"externalId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["customers"],"operationId":"getCustomer"}},"/fixed-assets":{"get":{"summary":"List fixed assets (scope: accounting:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fixed-assets"],"operationId":"listFixedAssets"},"post":{"summary":"Create a fixed asset with depreciation schedule (scope: accounting:write)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fixed-assets"],"operationId":"createFixedAsset"}},"/marketing/audiences":{"get":{"summary":"List marketing audiences (scope: marketing:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["marketing"],"operationId":"listMarketingAudiences"},"post":{"summary":"Create a static audience (scope: marketing:write)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["marketing"],"operationId":"createMarketingAudience"}},"/marketing/campaigns":{"get":{"summary":"List marketing campaigns (scope: marketing:read)","parameters":[{"name":"channel","in":"query","schema":{"type":"string"}},{"name":"status","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["marketing"],"operationId":"listMarketingCampaigns"},"post":{"summary":"Create a draft campaign (scope: marketing:write)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["marketing"],"operationId":"createMarketingCampaign"}},"/payment-methods":{"get":{"summary":"List saved payment methods for an external customer (scope: payments:charge)","parameters":[{"name":"external_customer_id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payment-methods"],"operationId":"listPaymentMethods"},"post":{"summary":"Create a SetupIntent to save a card (scope: payments:charge)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payment-methods"],"operationId":"createPaymentMethod"},"patch":{"summary":"Set default or detach a payment method (scope: payments:charge)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payment-methods"],"operationId":"updatePaymentMethod"}},"/payments/charge":{"post":{"summary":"Create a PaymentIntent on the org provider (scope: payments:charge)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payments"],"operationId":"createPaymentCharge"}},"/payments":{"get":{"summary":"List payments — every attempt to collect money for the organization, with provider reference and refund state (scope: payments:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"},"description":"Page number (1-based)"},{"name":"perPage","in":"query","schema":{"type":"integer"},"description":"Page size (max 100)"},{"name":"status","in":"query","schema":{"type":"string","enum":["pending","authorized","paid","failed","cancelled","expired","refunded","partially_refunded"]},"description":"Filter by spine status"},{"name":"source_kind","in":"query","schema":{"type":"string","enum":["invoice","order","booking","event_ticket","portal_topup","link","contract_tranche"]},"description":"What the money was collected for"},{"name":"from","in":"query","schema":{"type":"string"},"description":"created_at ≥ (ISO date or date-time)"},{"name":"to","in":"query","schema":{"type":"string"},"description":"created_at ≤ (ISO date = through end of day, or date-time)"},{"name":"q","in":"query","schema":{"type":"string","maxLength":255},"description":"Exact match on provider_ref (Stripe pi_…, Netopia ntpID…) or pay token"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Payment"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payments"],"operationId":"listPayments"}},"/payments/{id}":{"get":{"summary":"Get a payment (scope: payments:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Payment id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Payment"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payments"],"operationId":"getPayment"}},"/payments/{id}/refund":{"post":{"summary":"Refund a paid payment through the account that collected it. Omit amount_minor for the full remaining amount; `pending: true` means the processor accepted but has not settled. Honours Idempotency-Key. (scope: payments:refund)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Payment id"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRefundInput"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PaymentRefundResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payments"],"operationId":"refundPayment"}},"/payment-links":{"get":{"summary":"List ad-hoc payment links, newest first (scope: payments:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"},"description":"Page number (1-based)"},{"name":"perPage","in":"query","schema":{"type":"integer"},"description":"Page size (max 100)"},{"name":"status","in":"query","schema":{"type":"string"},"description":"Filter by spine status"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentLink"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payment-links"],"operationId":"listPaymentLinks"},"post":{"summary":"Create a payment link. The provider is not contacted until the payer opens it, so a link can be minted before a processor is connected (it then offers IBAN + EPC QR). Honours Idempotency-Key. (scope: payments:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLinkCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PaymentLinkCreated"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payment-links"],"operationId":"createPaymentLink"}},"/payment-links/{id}":{"get":{"summary":"Get a payment link (scope: payments:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Payment link id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PaymentLink"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payment-links"],"operationId":"getPaymentLink"}},"/payment-links/{id}/cancel":{"post":{"summary":"Cancel an open payment link. 409 when already paid or not cancellable. Honours Idempotency-Key. (scope: payments:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Payment link id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PaymentLinkCancelResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payment-links"],"operationId":"cancelPaymentLink"}},"/payouts":{"get":{"summary":"List processor payouts (settlements) with the charges each one covers (scope: payments:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"},"description":"Page number (1-based)"},{"name":"perPage","in":"query","schema":{"type":"integer"},"description":"Page size (max 100)"},{"name":"provider","in":"query","schema":{"type":"string"},"description":"stripe | netopia | revolut | …"},{"name":"status","in":"query","schema":{"type":"string"},"description":"pending | paid | failed | canceled"},{"name":"from","in":"query","schema":{"type":"string","format":"date"},"description":"arrival_date ≥"},{"name":"to","in":"query","schema":{"type":"string","format":"date"},"description":"arrival_date ≤"},{"name":"include_items","in":"query","schema":{"type":"boolean","default":true},"description":"Set false to omit the covered charges"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Payout"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["payouts"],"operationId":"listPayouts"}},"/subscriptions":{"get":{"summary":"List merchant subscriptions (scope: invoices:read)","parameters":[{"name":"external_customer_id","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["subscriptions"],"operationId":"listSubscriptions"},"post":{"summary":"Create a recurring subscription (scope: payments:charge)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["subscriptions"],"operationId":"createSubscription"}},"/subscriptions/{id}":{"get":{"summary":"Get a merchant subscription (scope: invoices:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["subscriptions"],"operationId":"getSubscription"},"patch":{"summary":"Cancel / resume / change price (scope: payments:charge)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["subscriptions"],"operationId":"updateSubscription"},"delete":{"summary":"Cancel at period end (scope: payments:charge)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["subscriptions"],"operationId":"deleteSubscription"}},"/subscriptions/{id}/usage":{"post":{"summary":"Report usage for a metered price (Stripe Billing Meter event; identifier makes retries no-ops; scope: payments:charge)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["quantity"],"properties":{"quantity":{"type":"integer","minimum":1},"timestamp":{"type":"string","format":"date-time"},"identifier":{"type":"string","maxLength":100}}}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["subscriptions"],"operationId":"usageSubscription"}},"/trust/providers":{"get":{"summary":"List available trust providers (scope: trust:providers)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["trust"],"operationId":"listTrustProviders"}},"/trust/signatures":{"post":{"summary":"Create a digital signature or seal (scope: trust:sign)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["trust"],"operationId":"createTrustSignature"}},"/trust/signatures/batch":{"post":{"summary":"Batch sign up to 100 documents (scope: trust:sign)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["trust"],"operationId":"createTrustSignatureBatch"}},"/trust/signatures/{id}":{"get":{"summary":"Get a signature by id (scope: trust:sign)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["trust"],"operationId":"getTrustSignature"}},"/trust/signatures/{id}/evidence":{"get":{"summary":"Get evidence bundles for a signature (scope: trust:evidence)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["trust"],"operationId":"listTrustSignatureEvidence"}},"/trust/validations":{"post":{"summary":"Validate a signed document (scope: trust:validate)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["trust"],"operationId":"createTrustValidation"}},"/trust/validations/{id}":{"get":{"summary":"Get a validation result (scope: trust:validate)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["trust"],"operationId":"getTrustValidation"}},"/trust/timestamps":{"post":{"summary":"Timestamp a signed document (scope: trust:timestamp)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["trust"],"operationId":"createTrustTimestamp"}},"/dns/zones":{"get":{"summary":"List DNS zones (scope: dns:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DnsZone"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"listDnsZones"},"post":{"summary":"Create a DNS zone (scope: dns:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnsZoneCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DnsZone"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"createDnsZone"}},"/dns/zones/{id}":{"get":{"summary":"Get a DNS zone with its records (scope: dns:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DnsZone"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"getDnsZone"},"delete":{"summary":"Delete a DNS zone (scope: dns:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deleted"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"deleteDnsZone"}},"/dns/zones/{id}/records":{"get":{"summary":"List records in a zone (scope: dns:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"listDnsZoneRecords"},"post":{"summary":"Create a DNS record (scope: dns:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnsRecordCreate"}}}},"responses":{"201":{"description":"Created"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"createDnsZoneRecord"}},"/dns/zones/{id}/records/{recordId}":{"put":{"summary":"Update a DNS record (scope: dns:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"recordId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DnsRecordCreate"}}}},"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"updateDnsZoneRecord"},"delete":{"summary":"Delete a DNS record (scope: dns:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"recordId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deleted"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"deleteDnsZoneRecord"}},"/dns/zones/{id}/import":{"post":{"summary":"Import a BIND zone file (scope: dns:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"importDnsZone"}},"/dns/zones/{id}/export":{"get":{"summary":"Export a zone as a BIND zone file (scope: dns:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"listDnsZoneExport"}},"/dns/templates":{"get":{"summary":"List available DNS templates (scope: dns:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"listDnsTemplates"}},"/dns/zones/{id}/template":{"post":{"summary":"Apply a DNS template to a zone (scope: dns:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"templateDnsZone"}},"/dns/zones/{id}/versions":{"get":{"summary":"List zone version history (scope: dns:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"listDnsZoneVersions"}},"/dns/zones/{id}/rollback":{"post":{"summary":"Roll a zone back to a previous version (scope: dns:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"rollbackDnsZone"}},"/dns/connections":{"get":{"summary":"List external DNS provider connections (scope: dns:read)","responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"listDnsConnections"}},"/dns/connections/{id}/zones":{"get":{"summary":"List zones at an external DNS provider (scope: dns:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["dns"],"operationId":"listDnsConnectionZones"}},"/domains":{"get":{"summary":"List registered domains (scope: domains:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Domain"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["domains"],"operationId":"listDomains"}},"/domains/{id}/lock":{"post":{"summary":"Lock a domain against transfers (scope: domains:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["domains"],"operationId":"lockDomain"}},"/domains/{id}/unlock":{"post":{"summary":"Unlock a domain for transfer (scope: domains:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["domains"],"operationId":"unlockDomain"}},"/domains/{id}/auth-code":{"get":{"summary":"Get the domain transfer auth code (scope: domains:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["domains"],"operationId":"listDomainAuthCode"}},"/domains/{id}/renew":{"post":{"summary":"Renew a domain registration (scope: domains:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["domains"],"operationId":"renewDomain"}},"/domains/{id}/health":{"get":{"summary":"Domain health (expiry, nameservers, DNSSEC) (scope: domains:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["domains"],"operationId":"listDomainHealth"}},"/sites":{"get":{"summary":"List hosted sites (scope: sites:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"search","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Site"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["sites"],"operationId":"listSites"}},"/emails/send":{"post":{"summary":"Send a transactional or notification email as the organisation (scope: emails:send)","description":"Accepted with 202 once the message is durably recorded; delivery is asynchronous. Honours `Idempotency-Key` (same key → same `id`). Rate limit 600/h per organisation. Suppressed recipients (bounces, complaints, org opt-outs) are reported per recipient and never handed to the MTA; if every `to` is suppressed the message is recorded with `status: suppressed`. `category: marketing` → 422 (use campaigns). `from` on an unverified domain → 422. A `from` on a verified domain that no sending identity may send as → 422 `sender_identity_missing` (nothing recorded). Sendable: the sending address of the domain (`@`; re-run `/email-domains/{id}/verify` if its identity is missing), or a hosted mailbox of the organisation or one of its aliases with API sending enabled (Mail settings). Attachments over 2 MB decoded → 413. Webhooks: `email.sent`, `email.delivered`, `email.bounced`, `email.complained`, `email.suppressed`.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSendRequest"},"example":{"to":[{"email":"ana@client.ro","name":"Ana Popescu"}],"subject":"Factura 2026-0042","html":"

Bună ziua, atașat găsiți factura.

","category":"transactional","tags":["invoice"],"headers":{"X-Entity-Ref-ID":"inv_2026_0042"}}}}},"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Email"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"413":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["emails"],"operationId":"createEmailSend"}},"/emails":{"get":{"summary":"List emails sent through the API (scope: emails:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"since","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","schema":{"type":"string","enum":["queued","sent","delivered","bounced","complained","suppressed","failed"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Email"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["emails"],"operationId":"listEmails"}},"/emails/{id}":{"get":{"summary":"Get an email with its delivery timeline (scope: emails:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Email"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["emails"],"operationId":"getEmail"}},"/email/send":{"post":{"operationId":"sendEmailMessage","summary":"Send transactional mail from a sibling application, RFC 5322 address strings (scope: emails:send)","description":"$184","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","maxLength":255}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailMessageSendRequest"},"example":{"from":"codai ","to":["ana@client.ro"],"subject":"Your sign-in code","text":"Code: 481 220","category":"transactional","tags":{"kind":"auth_email"},"headers":{"X-Entity-Ref-ID":"auth-8f2c"}}}}},"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailMessageAccepted"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"502":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["email"]}},"/email/messages/{id}":{"get":{"operationId":"getEmailMessage","summary":"Get a message sent through /email/send, with its delivery timeline (scope: emails:send)","description":"Org-scoped. Accepts a key holding `emails:read` or `emails:send`, so a sending application can poll what it sent.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Email"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["email"]}},"/email-domains":{"get":{"summary":"List sending domains (scope: email_domains:read)","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmailDomain"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["email-domains"],"operationId":"listEmailDomains"},"post":{"summary":"Register a sending domain and get the DNS records to publish (scope: email_domains:write)","description":"Returns the ownership TXT (`_brivio.`), SPF, DKIM selector record(s), DMARC and — when hosted — MX. Publish them, then call `/email-domains/{id}/verify`. 409 when the domain is already registered or claimed by another account; 503 when provisioning is not configured.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailDomainCreate"},"example":{"domain":"acme.ro","from_local_part":"facturi"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmailDomain"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["email-domains"],"operationId":"createEmailDomain"}},"/email-domains/{id}":{"get":{"summary":"Get a sending domain (scope: email_domains:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmailDomain"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["email-domains"],"operationId":"getEmailDomain"},"delete":{"summary":"Remove a sending domain (scope: email_domains:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Deleted"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["email-domains"],"operationId":"deleteEmailDomain"}},"/email-domains/{id}/verify":{"post":{"summary":"Re-check DNS for a sending domain: ownership, SPF, DKIM, DMARC (scope: email_domains:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EmailDomainVerifyResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["email-domains"],"operationId":"verifyEmailDomain"}},"/saft/generations":{"get":{"operationId":"listSaftGenerations","summary":"List SAF-T D406 generations, newest first (scope: saft:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"fiscal_year_id","in":"query","schema":{"type":"string","format":"uuid"}},{"name":"variant","in":"query","schema":{"type":"string","enum":["annual","assets","stocks"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SaftGeneration"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["saft"]},"post":{"operationId":"createSaftGeneration","summary":"Queue a SAF-T D406 generation on the worker (never rendered inline). 409 when the readiness pre-flight has blocking findings or a generation is already running; 503 when no worker is reachable. (scope: saft:write)","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaftGenerationCreate"}}}},"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SaftGenerationQueued"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["saft"]}},"/saft/generations/{id}":{"get":{"operationId":"getSaftGeneration","summary":"Get a SAF-T generation with its issue counts (scope: saft:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"SAF-T generation id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SaftGenerationDetail"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["saft"]}},"/saft/generations/{id}/findings":{"get":{"operationId":"listSaftGenerationFindings","summary":"List the remediable findings of a SAF-T generation (scope: saft:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"SAF-T generation id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SaftGenerationFindings"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["saft"]}},"/saft/generations/{id}/download":{"get":{"operationId":"getSaftGenerationDownload","summary":"Get a signed download URL for a generated SAF-T file. 409 while not ready, 410 past retention. Heavy rate tier. (scope: saft:export)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"SAF-T generation id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SaftGenerationDownload"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"410":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["saft"]}},"/exports":{"get":{"summary":"List export jobs, newest first (scope: exports:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ExportJob"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["exports"],"operationId":"listExports"},"post":{"summary":"Start a csv/xlsx export. Runs in the background; poll GET /exports/{id} or subscribe to export.completed. Needs the exported entity read scope as well (403 SCOPE_REQUIRED names it). Requires Idempotency-Key. (scope: exports:write)","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportJobCreate"}}}},"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExportJob"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["exports"],"operationId":"createExport"}},"/exports/{id}":{"get":{"summary":"Get an export job (scope: exports:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExportJob"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["exports"],"operationId":"getExport"}},"/exports/{id}/download":{"get":{"operationId":"downloadExport","summary":"Download an export. Stored files: 200 JSON {url, expires_at, filename, sha256} with a short-lived signed URL. Legacy files (and deployments without object storage): 200 with the raw bytes and Content-Disposition: attachment. 409 while running or when the job failed; 410 once the file expired (the sha256 stays in error.details). (scope: exports:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Signed URL (JSON) or the file bytes","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExportJobDownload"},"error":{"type":"null"}},"required":["data","error"]}},"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"410":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["exports"]}},"/imports":{"get":{"operationId":"listImports","summary":"List import jobs, newest first (scope: imports:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImportJob"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["imports"]},"post":{"operationId":"createImport","summary":"Stage rows for import: computes the dedupe preview and holds the rows; nothing is written until commit. 202 with status staged (or failed). Requires Idempotency-Key. (scope: imports:write)","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportJobCreate"}}}},"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportJob"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"413":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["imports"]}},"/imports/{id}":{"get":{"operationId":"getImport","summary":"Get an import job (scope: imports:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Import job id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportJob"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["imports"]}},"/imports/{id}/errors":{"get":{"operationId":"listImportErrors","summary":"List the row-level errors of an import job, paginated (scope: imports:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Import job id"},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImportJobError"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["imports"]}},"/imports/{id}/cancel":{"post":{"operationId":"cancelImport","summary":"Cancel a staged import and drop its rows. 409 when not staged. Honours Idempotency-Key. (scope: imports:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Import job id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportJob"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["imports"]}},"/imports/{id}/commit":{"post":{"operationId":"commitImport","summary":"Commit a staged import into contacts, articles, invoice history or stock. 202 with the job (completed or failed). 409 when not staged; 422 for an entity with no committer. Requires Idempotency-Key. (scope: imports:commit)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Import job id"},{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportJob"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["imports"]}},"/marketing/campaigns/{id}/variants":{"get":{"operationId":"listMarketingCampaignVariants","summary":"List the A/B arms of a campaign with counters and rates. Winner state is on the campaign (ab_winner_variant_id, ab_decided_at). (scope: marketing:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Campaign id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MarketingCampaignVariant"}},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["marketing"]}},"/marketing/campaigns/{id}/ab-test":{"put":{"operationId":"configureCampaignAbTest","summary":"Configure (replace) the A/B subject test of a draft campaign. 409 when the campaign is not a draft. Honours Idempotency-Key. (scope: marketing_ab:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Campaign id"},{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional. A retry with the same key replays the first response (24 h).","schema":{"type":"string","maxLength":200}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketingAbTestConfigure"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarketingCampaignAbTest"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["marketing"]},"delete":{"operationId":"clearCampaignAbTest","summary":"Remove the A/B test from a draft campaign. 409 when the campaign is not a draft. (scope: marketing_ab:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Campaign id"},{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional. A retry with the same key replays the first response (24 h).","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarketingCampaignAbTest"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["marketing"]}},"/marketing/subscribers":{"post":{"operationId":"createMarketingSubscriber","summary":"Add a newsletter subscriber from a public form, with double opt-in: the address stays pending and receives ONE confirmation email; nothing else is sent until the person confirms. Idempotent per address (201 created, 200 already known; a confirmed address is never re-mailed and a pending one at most every 10 minutes). Rate limit 600/h per organisation. Honours Idempotency-Key. (scope: marketing_subscribers:write)","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional. A retry with the same key replays the first response (24 h).","schema":{"type":"string","maxLength":200}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketingSubscriberCreate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarketingSubscriber"},"error":{"type":"null"}},"required":["data","error"]}}}},"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MarketingSubscriber"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["marketing"]}},"/prospecting/saved-searches":{"get":{"operationId":"listProspectingSavedSearches","summary":"List saved prospecting searches, newest first (scope: prospecting:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProspectingSavedSearch"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["prospecting"]},"post":{"operationId":"createProspectingSavedSearch","summary":"Save a prospecting search. Counts toward the plan limit (402 PLAN_LIMIT_EXCEEDED). The row is attributed to the user who created the API key; 403 when the credential has no such member. Honours Idempotency-Key. (scope: prospecting:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProspectingSavedSearchCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProspectingSavedSearch"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"402":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["prospecting"]}},"/prospecting/saved-searches/{id}":{"get":{"operationId":"getProspectingSavedSearch","summary":"Get a saved prospecting search (scope: prospecting:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Saved search id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProspectingSavedSearch"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["prospecting"]},"patch":{"operationId":"updateProspectingSavedSearch","summary":"Update a saved prospecting search (name, filters, sort, columns, alert flags). The last_* fields are read-only. Honours Idempotency-Key. (scope: prospecting:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Saved search id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProspectingSavedSearchUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProspectingSavedSearch"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["prospecting"]},"delete":{"operationId":"deleteProspectingSavedSearch","summary":"Delete a saved prospecting search. Honours Idempotency-Key. (scope: prospecting:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Saved search id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean"}},"required":["id","deleted"]},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["prospecting"]}},"/fleet/vehicles":{"get":{"operationId":"listFleetVehicles","summary":"List fleet vehicles, by plate (scope: fleet:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FleetVehicle"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fleet"]},"post":{"operationId":"createFleetVehicle","summary":"Add a fleet vehicle. The canonical registry vehicle is found (VIN first, then plate) or created. Honours Idempotency-Key. (scope: fleet:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetVehicleCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FleetVehicle"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fleet"]}},"/fleet/vehicles/{id}":{"get":{"operationId":"getFleetVehicle","summary":"Get a fleet vehicle (scope: fleet:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Fleet vehicle id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FleetVehicle"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fleet"]},"patch":{"operationId":"updateFleetVehicle","summary":"Update a fleet vehicle; absent fields are left unchanged. A changed plate or VIN re-links the registry vehicle. Honours Idempotency-Key. (scope: fleet:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Fleet vehicle id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetVehicleUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FleetVehicle"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fleet"]},"delete":{"operationId":"deleteFleetVehicle","summary":"Delete a fleet vehicle. Its odometer readings and service logs are deleted with it (cascade); the registry vehicle and its history are kept. Honours Idempotency-Key. (scope: fleet:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Fleet vehicle id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean"}},"required":["id","deleted"]},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fleet"]}},"/fleet/vehicles/{id}/odometer-readings":{"get":{"operationId":"listFleetOdometerReadings","summary":"List a vehicle's odometer readings, newest first; 404 when the vehicle is not in this organization (scope: fleet:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Fleet vehicle id"},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FleetOdometerReading"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fleet"]},"post":{"operationId":"createFleetOdometerReading","summary":"Record an odometer reading; the vehicle's current odometer moves to it. Honours Idempotency-Key. (scope: fleet:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Fleet vehicle id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetOdometerReadingCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FleetOdometerReading"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fleet"]}},"/fleet/vehicles/{id}/service-logs":{"get":{"operationId":"listFleetServiceLogs","summary":"List a vehicle's service, repair and fuel log, newest first; 404 when the vehicle is not in this organization (scope: fleet:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Fleet vehicle id"},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FleetServiceLog"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fleet"]},"post":{"operationId":"createFleetServiceLog","summary":"Add a service / repair / fuel log entry for a vehicle. Honours Idempotency-Key. (scope: fleet:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Fleet vehicle id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FleetServiceLogCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FleetServiceLog"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fleet"]}},"/fleet/drivers":{"get":{"operationId":"listFleetDrivers","summary":"List drivers as id, name and status only, by name (scope: fleet_drivers:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FleetDriver"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["fleet"]}},"/delivery-routes":{"get":{"operationId":"listDeliveryRoutes","summary":"List delivery routes, newest first (scope: delivery:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["DRAFT","PLANNED","DISPATCHED","IN_PROGRESS","COMPLETED","CANCELLED"]}},{"name":"date_from","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"route_date on or after (YYYY-MM-DD)"},{"name":"date_to","in":"query","required":false,"schema":{"type":"string","format":"date"},"description":"route_date on or before (YYYY-MM-DD)"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryRoute"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]},"post":{"operationId":"createDeliveryRoute","summary":"Create a delivery route (status DRAFT; the start address is geocoded). Honours Idempotency-Key. (scope: delivery:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryRouteCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeliveryRoute"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]}},"/delivery-routes/{id}":{"get":{"operationId":"getDeliveryRoute","summary":"Get a delivery route (scope: delivery:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Delivery route id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeliveryRoute"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]},"patch":{"operationId":"updateDeliveryRoute","summary":"Update a delivery route: name, date, notes, capacity, driver/vehicle, or status (DRAFT, IN_PROGRESS, COMPLETED, CANCELLED — cancel instead of delete). Honours Idempotency-Key. (scope: delivery:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Delivery route id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryRouteUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeliveryRoute"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]}},"/delivery-routes/{id}/stops":{"get":{"operationId":"listDeliveryRouteStops","summary":"List the stops of a delivery route, in visit order (scope: delivery:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Delivery route id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DeliveryRouteStop"}},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]},"post":{"operationId":"addDeliveryRouteStop","summary":"Add a stop to a DRAFT or PLANNED route (409 ROUTE_LOCKED otherwise; a PLANNED route returns to DRAFT). The address is geocoded. Honours Idempotency-Key. (scope: delivery:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Delivery route id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeliveryRouteStopCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeliveryRouteStop"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]}},"/delivery-routes/{id}/stops/{stopId}":{"delete":{"operationId":"removeDeliveryRouteStop","summary":"Remove a stop from a delivery route. Honours Idempotency-Key. (scope: delivery:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Delivery route id"},{"name":"stopId","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Route stop id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean"}},"required":["id","deleted"]},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]}},"/delivery-routes/{id}/optimize":{"post":{"operationId":"optimizeDeliveryRoute","summary":"Optimize the stop order (OSRM road distances, synchronous) and mark the route PLANNED. 422 NO_GEOCODED_STOPS when no stop has coordinates. Requires Idempotency-Key; heavy rate tier. (scope: delivery:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Delivery route id"},{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeliveryRouteOptimizeResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]}},"/delivery-routes/{id}/dispatch":{"post":{"operationId":"dispatchDeliveryRoute","summary":"E-mail the route sheet to the assigned driver and mark the route DISPATCHED. 409 ROUTE_NOT_PLANNED; 422 NO_DRIVER, DRIVER_NO_EMAIL, NO_STOPS. The public driver page link is sent only to the driver, never returned. Requires Idempotency-Key. (scope: delivery:dispatch)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Delivery route id"},{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeliveryRouteDispatchResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]}},"/delivery-routes/cost-analytics":{"get":{"operationId":"getDeliveryRouteCostAnalytics","summary":"Own fleet vs courier over the last 30 or 90 days, from the snapshots stored when routes were completed: totals, saving, verdict counts, hybrid saving, CO2, break-even stop count and the routes that lost money. (scope: delivery:read)","parameters":[{"name":"window","in":"query","required":false,"schema":{"type":"string","enum":["30","90"],"default":"30"},"description":"Look-back window in days"},{"name":"mode","in":"query","required":false,"schema":{"type":"string","enum":["marginal","full"],"default":"marginal"},"description":"`marginal` (default) or `full` (adds depreciation and insurance)"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeliveryRouteCostAnalytics"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]}},"/delivery-routes/{id}/cost-comparison":{"get":{"operationId":"getDeliveryRouteCostComparison","summary":"Compare the own-fleet cost of a route with live courier quotes for the same parcels: verdict, saving, hybrid split, break-even stop count and CO2. 422 when the route has no stops. Heavy rate tier. (scope: delivery:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Delivery route id"},{"name":"mode","in":"query","required":false,"schema":{"type":"string","enum":["marginal","full"],"default":"marginal"},"description":"`marginal` (default) or `full` (adds depreciation and insurance)"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DeliveryRouteCostComparison"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["delivery-routes"]}},"/legal/court-cases":{"get":{"operationId":"listCourtCases","summary":"List the organization's own court cases, newest first (scope: legal:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string","enum":["OPEN","SUSPENDED","WON","LOST","SETTLED","CLOSED"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CourtCase"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["legal"]},"post":{"operationId":"createCourtCase","summary":"Record a court case. Linked contact/invoice/contract must belong to the organization. Honours Idempotency-Key. (scope: legal:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourtCaseCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourtCase"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["legal"]}},"/legal/court-cases/{id}":{"get":{"operationId":"getCourtCase","summary":"Get a court case (scope: legal:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Court case id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourtCase"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["legal"]},"patch":{"operationId":"updateCourtCase","summary":"Update a court case (partial). A terminal status sets closed_at when absent; OPEN clears it. Honours Idempotency-Key. (scope: legal:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Court case id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourtCaseUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourtCase"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["legal"]},"delete":{"operationId":"deleteCourtCase","summary":"Delete a court case with its hearings and notes. Honours Idempotency-Key. (scope: legal:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Court case id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean"}},"required":["id","deleted"]},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["legal"]}},"/legal/court-cases/{id}/hearings":{"get":{"operationId":"listCourtCaseHearings","summary":"List the hearings (termene) of a court case, by date (scope: legal:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Court case id"},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CourtHearing"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["legal"]},"post":{"operationId":"createCourtCaseHearing","summary":"Add a hearing to a court case; a future date becomes the case's next_hearing_at. Honours Idempotency-Key. (scope: legal:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Court case id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourtHearingCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourtHearing"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["legal"]}},"/legal/court-cases/{id}/notes":{"get":{"operationId":"listCourtCaseNotes","summary":"List the notes of a court case, newest first (scope: legal:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Court case id"},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CourtCaseNote"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["legal"]},"post":{"operationId":"createCourtCaseNote","summary":"Add a note to a court case. Honours Idempotency-Key. (scope: legal:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Court case id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourtCaseNoteCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourtCaseNote"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["legal"]}},"/purchases/import-declarations":{"get":{"operationId":"listImportDeclarations","summary":"List customs import declarations (DVI), newest declaration date first (scope: purchases:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","schema":{"type":"string","enum":["DRAFT","CONFIRMED","CANCELLED"]}},{"name":"from","in":"query","schema":{"type":"string","format":"date"},"description":"Declaration date ≥"},{"name":"to","in":"query","schema":{"type":"string","format":"date"},"description":"Declaration date ≤"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImportDeclaration"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["purchases"]},"post":{"operationId":"createImportDeclaration","summary":"Create a DRAFT customs import declaration; customs value, VAT base and VAT are computed server-side. Honours Idempotency-Key. (scope: purchases:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportDeclarationCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["DRAFT"]},"customs_value":{"type":"string"},"vat_base":{"type":"string"},"vat_amount":{"type":"string"}},"required":["id","status","customs_value","vat_base","vat_amount"]},"error":{"type":"null"}}}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["purchases"]}},"/purchases/import-declarations/{id}":{"get":{"operationId":"getImportDeclaration","summary":"Get a customs import declaration with its lines and cost allocation (scope: purchases:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Import declaration id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportDeclarationDetail"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["purchases"]}},"/purchases/import-declarations/{id}/confirm":{"post":{"operationId":"confirmImportDeclaration","summary":"Confirm a DRAFT declaration: posts the customs journal entry (Dr 371/607 = Cr 446; VAT Dr 4426 = Cr 446 or 4427), raises the cost of the stock still held, and flips the status — atomically. Runs inline; 202 with the result. 409 not_draft; 422 no_reception / no_period / no_journal / missing_account / period_closed. Requires Idempotency-Key. (scope: purchases:confirm)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Import declaration id"},{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImportDeclarationConfirmResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["purchases"]}},"/saft/imports":{"get":{"operationId":"listSaftImports","summary":"List SAF-T D406 imports, newest first (scope: imports:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SaftImport"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["saft"]},"post":{"operationId":"createSaftImport","summary":"Start a SAF-T D406 import (≤ 50 MB): returns a signed PUT URL to object storage; then call parse. 503 when object storage is not configured. (scope: saft_import:write)","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaftImportCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SaftImportCreated"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["saft"]}},"/saft/imports/{id}":{"get":{"operationId":"getSaftImport","summary":"Get a SAF-T import with its preview and, once applied, its result (scope: imports:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"SAF-T import id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SaftImport"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["saft"]}},"/saft/imports/{id}/parse":{"post":{"operationId":"parseSaftImport","summary":"Verify the uploaded file (size + sha256) and parse it into a preview. 409 when not uploaded yet or not awaiting_upload; 410 past retention; 422 on a size/checksum mismatch or an unparseable file. (scope: saft_import:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"SAF-T import id"},{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SaftImport"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"410":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["saft"]}},"/saft/imports/{id}/apply":{"post":{"operationId":"applySaftImport","summary":"Apply a previewed SAF-T import: contacts, products, account links, opening stock and opening balances (one posted, immutable OP entry). 409 when already applied or opening balances are already posted. (scope: saft_import:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"SAF-T import id"},{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaftImportApply"}}}},"responses":{"202":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SaftImport"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"410":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["saft"]}},"/gate/visits":{"get":{"operationId":"listGateVisits","summary":"List gate visits, newest first (scope: gate:read)","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["EXPECTED","AT_GATE","CHECKED_IN","AT_DOCK","WEIGHED_IN","LOADING","WEIGHED_OUT","DOCS_PENDING","DEPARTED","CANCELLED"]},"description":"Exact status"},{"name":"active","in":"query","required":false,"schema":{"type":"boolean"},"description":"true = not DEPARTED/CANCELLED; false = only those"},{"name":"direction","in":"query","required":false,"schema":{"type":"string","enum":["INBOUND","OUTBOUND","OTHER"]},"description":"Direction"},{"name":"plate","in":"query","required":false,"schema":{"type":"string"},"description":"Plate substring, spaces and dashes ignored"},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Arrived at or after"},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Arrived at or before"},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GateVisit"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["gate"]},"post":{"operationId":"createGateVisit","summary":"Register a vehicle at the gate: compliance alerts from Fleet, a linked appointment moved to ARRIVED, dispatcher notifications. No document automation runs. Honours Idempotency-Key. (scope: gate:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GateVisitCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GateVisit"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["gate"]}},"/gate/visits/{id}":{"get":{"operationId":"getGateVisit","summary":"Get a gate visit with its weighing tickets and timeline (scope: gate:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Gate visit id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GateVisitDetail"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["gate"]}},"/gate/visits/{id}/transitions":{"post":{"operationId":"transitionGateVisit","summary":"Move a visit along the state machine; 409 when the transition is not allowed (details list the allowed targets). Sends the same notification as the yard board. Honours Idempotency-Key. (scope: gate:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Gate visit id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GateVisitTransition"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GateVisit"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["gate"]}},"/gate/visits/{id}/weighings":{"post":{"operationId":"addGateVisitWeighing","summary":"Record a weighbridge reading on the visit's ticket (201 first reading, 200 later ones); does not change the visit status. Honours Idempotency-Key. (scope: gate:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Gate visit id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GateWeighingCreate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GateWeighing"},"error":{"type":"null"}},"required":["data","error"]}}}},"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GateWeighing"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["gate"]}},"/gate/dock-appointments":{"get":{"operationId":"listDockAppointments","summary":"List dock appointments by slot start (scope: gate:read)","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["SCHEDULED","CONFIRMED","ARRIVED","COMPLETED","NO_SHOW","CANCELLED"]},"description":"Exact status"},{"name":"dock_name","in":"query","required":false,"schema":{"type":"string"},"description":"Exact dock"},{"name":"from","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Slot starts at or after"},{"name":"to","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"Slot starts at or before"},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DockAppointment"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["gate"]},"post":{"operationId":"createDockAppointment","summary":"Book a dock slot; 409 when it overlaps a SCHEDULED/CONFIRMED/ARRIVED one on the same dock (back-to-back is allowed). Honours Idempotency-Key. (scope: gate:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DockAppointmentCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DockAppointment"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["gate"]}},"/gate/dock-appointments/{id}":{"get":{"operationId":"getDockAppointment","summary":"Get a dock appointment (scope: gate:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Dock appointment id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DockAppointment"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["gate"]},"patch":{"operationId":"updateDockAppointment","summary":"Update a dock appointment; absent fields are left unchanged. status CANCELLED cancels it (soft). The overlap check re-runs when the slot or dock changes (409). Honours Idempotency-Key. (scope: gate:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Dock appointment id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DockAppointmentUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DockAppointment"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["gate"]}},"/cabinet/access-grants":{"get":{"operationId":"listAccessGrants","summary":"List accountant access grants where the organization is the cabinet or the client, newest first (scope: grants:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"role","in":"query","schema":{"type":"string","enum":["cabinet","client"]}},{"name":"status","in":"query","schema":{"type":"string","enum":["pending","active","revoked"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AccessGrant"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["cabinet"]},"post":{"operationId":"requestAccessGrant","summary":"Cabinet requests access to a managed client — creates a PENDING grant the client admin approves in the app. 201 created, 200 when a live grant already exists; 403 not_a_cabinet; 422 client_not_linked. (scope: grants:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessGrantRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","active","revoked"]},"client_org_id":{"type":"string","format":"uuid"},"created":{"type":"boolean","description":"false when an existing live grant was returned"}},"required":["id","status","client_org_id","created"]},"error":{"type":"null"}}}}}},"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["pending","active","revoked"]},"client_org_id":{"type":"string","format":"uuid"},"created":{"type":"boolean","description":"false when an existing live grant was returned"}},"required":["id","status","client_org_id","created"]},"error":{"type":"null"}}}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["cabinet"]}},"/cabinet/access-grants/{id}/revoke":{"post":{"operationId":"revokeAccessGrant","summary":"Revoke an access grant — either the cabinet or the client may. 409 invalid_transition when already revoked. (scope: grants:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Access grant id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"status":{"type":"string","enum":["revoked"]},"revoked_by":{"type":"string","enum":["cabinet","client"]}},"required":["id","status","revoked_by"]},"error":{"type":"null"}}}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["cabinet"]}},"/vehicles":{"get":{"operationId":"listVehicles","summary":"List registry vehicles, by plate (scope: fleet:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RegistryVehicle"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["vehicles"]}},"/vehicles/{id}":{"get":{"operationId":"getVehicle","summary":"Get a registry vehicle (scope: fleet:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Registry vehicle id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RegistryVehicle"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["vehicles"]}},"/vehicles/{id}/trip-sheets":{"get":{"operationId":"listVehicleTripSheets","summary":"List a registry vehicle's trip sheets (foi de parcurs), newest first; 404 when the vehicle is not in this organization. driver_name needs fleet_drivers:read (scope: fleet:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Registry vehicle id"},{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TripSheet"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["vehicles"]},"post":{"operationId":"createVehicleTripSheet","summary":"Record a trip sheet (foaie de parcurs) for a registry vehicle. Honours Idempotency-Key. (scope: fleet:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Registry vehicle id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TripSheetCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TripSheet"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["vehicles"]}},"/trip-sheets/{id}":{"get":{"operationId":"getTripSheet","summary":"Get a trip sheet (foaie de parcurs). driver_name needs fleet_drivers:read (scope: fleet:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Trip sheet id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TripSheet"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["trip-sheets"]}},"/spaces":{"get":{"operationId":"listSpaces","summary":"List spaces, by name (scope: spaces:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Space"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["spaces"]},"post":{"operationId":"createSpace","summary":"Create a space. Honours Idempotency-Key. (scope: spaces:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Space"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["spaces"]}},"/spaces/{id}":{"get":{"operationId":"getSpace","summary":"Get a space with its members (scope: spaces:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Space id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SpaceDetail"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["spaces"]},"patch":{"operationId":"updateSpace","summary":"Update a space. Honours Idempotency-Key. (scope: spaces:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Space id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceUpdate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Space"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["spaces"]},"delete":{"operationId":"deleteSpace","summary":"Delete a space. Its members are released, never deleted. Honours Idempotency-Key. (scope: spaces:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Space id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"deleted":{"type":"boolean"}},"required":["id","deleted"]},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["spaces"]}},"/spaces/{id}/members":{"post":{"operationId":"attachSpaceMember","summary":"Add a resource of this organization to a space (moves it from another space). Honours Idempotency-Key. (scope: spaces:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Space id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceMemberRef"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"space_id":{"type":["string","null"],"format":"uuid"},"kind":{"type":"string","enum":["website","custom_domain","dns_zone","hosted_site","registered_domain","email_domain","oauth_client","webhook"]},"resource_id":{"type":"string","format":"uuid"}},"required":["space_id","kind","resource_id"]},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["spaces"]},"delete":{"operationId":"detachSpaceMember","summary":"Remove a resource from a space; the resource itself is untouched. Honours Idempotency-Key. (scope: spaces:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Space id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpaceMemberRef"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"space_id":{"type":["string","null"],"format":"uuid"},"kind":{"type":"string","enum":["website","custom_domain","dns_zone","hosted_site","registered_domain","email_domain","oauth_client","webhook"]},"resource_id":{"type":"string","format":"uuid"}},"required":["space_id","kind","resource_id"]},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["spaces"]}},"/space-transfers":{"get":{"operationId":"listSpaceTransfers","summary":"List space transfers this organization sent or received, newest first. Read-only (scope: space_transfers:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SpaceTransfer"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["space-transfers"]}},"/space-transfers/{id}":{"get":{"operationId":"getSpaceTransfer","summary":"Get a space transfer; 404 unless this organization is a party (scope: space_transfers:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Space transfer id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SpaceTransfer"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["space-transfers"]}},"/display/me":{"get":{"operationId":"getDisplayMe","summary":"The paired display: device, organization branding, config and the screens it can show (scope: display:read)","parameters":[{"name":"If-None-Match","in":"header","required":false,"schema":{"type":"string"},"description":"ETag from a previous response; a match answers 304 with no body (no database work on the server)."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DisplayMe"},"error":{"type":"null"}},"required":["data","error"]}}},"headers":{"ETag":{"description":"Strong validator of the JSON body; per transfer encoding (`\"\"`, `\"-br\"`, `\"-gzip\"`). Any of them matches If-None-Match.","schema":{"type":"string"}},"Cache-Control":{"description":"`private, no-cache` — keep the body, revalidate with If-None-Match.","schema":{"type":"string"}}}},"304":{"description":"Not Modified — the If-None-Match ETag is current; empty body.","headers":{"ETag":{"description":"Strong validator of the JSON body; per transfer encoding (`\"\"`, `\"-br\"`, `\"-gzip\"`). Any of them matches If-None-Match.","schema":{"type":"string"}},"Cache-Control":{"description":"`private, no-cache` — keep the body, revalidate with If-None-Match.","schema":{"type":"string"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["display"]}},"/display/snapshot":{"get":{"operationId":"getDisplaySnapshot","summary":"Pre-aggregated, read-only data for one screen; 403 when the display is not configured for it (scope: display:read)","parameters":[{"name":"screen","in":"query","required":true,"schema":{"type":"string","enum":["pulse","feed","present","kitchen","orders","bookings","gate","promo","queue","menu","slides"]}},{"name":"If-None-Match","in":"header","required":false,"schema":{"type":"string"},"description":"ETag from a previous response; a match answers 304 with no body (no database work on the server)."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DisplaySnapshot"},"error":{"type":"null"}},"required":["data","error"]}}},"headers":{"ETag":{"description":"Strong validator of the JSON body; per transfer encoding (`\"\"`, `\"-br\"`, `\"-gzip\"`). Any of them matches If-None-Match.","schema":{"type":"string"}},"Cache-Control":{"description":"`private, no-cache` — keep the body, revalidate with If-None-Match.","schema":{"type":"string"}}}},"304":{"description":"Not Modified — the If-None-Match ETag is current; empty body.","headers":{"ETag":{"description":"Strong validator of the JSON body; per transfer encoding (`\"\"`, `\"-br\"`, `\"-gzip\"`). Any of them matches If-None-Match.","schema":{"type":"string"}},"Cache-Control":{"description":"`private, no-cache` — keep the body, revalidate with If-None-Match.","schema":{"type":"string"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["display"]}},"/display/stream":{"get":{"operationId":"streamDisplayEvents","summary":"Server-Sent Events for a display (text/event-stream, never compressed): invalidate {screens} → re-fetch with If-None-Match, feed {item}, config, revoked, ping every 20 s; closes after 15 min (scope: display:read)","parameters":[{"name":"access_token","in":"query","required":false,"schema":{"type":"string"},"description":"Bearer fallback for clients whose EventSource cannot set headers (https only)."}],"responses":{"200":{"description":"SSE stream"},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["display"]}},"/display/assistant":{"post":{"operationId":"askDisplayAssistant","summary":"Ask the display assistant a question about the pulse data; read-only, 20/min per device; 501 STT_UNAVAILABLE for audio (scope: display:assistant)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayAssistantRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DisplayAssistantResponse"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"501":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["display"]}},"/display/unlock":{"post":{"operationId":"unlockDisplay","summary":"Re-check a locked display’s PIN server-side: 200 { ok }, 5 attempts/min per device (429 + retryAfterSec), every attempt audited without the PIN; 400 for personal tokens or when no PIN is set (scope: display:read)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayUnlockRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DisplayUnlockResponse"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["display"]}},"/rewards/program":{"get":{"operationId":"getRewardsProgram","summary":"Your organization's own rewards programme (scope: rewards:read)","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardProgram"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/members":{"post":{"operationId":"upsertRewardsMember","summary":"Create or fetch a member by externalRef or customerId; 201 when created (scope: rewards:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardMemberUpsert"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardMemberSummary"},"error":{"type":"null"}},"required":["data","error"]}}}},"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardMemberSummary"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/members/{ref}":{"get":{"operationId":"getRewardsMember","summary":"Member balance, level, streak and expiry (scope: rewards:read)","parameters":[{"name":"ref","in":"path","required":true,"schema":{"type":"string","maxLength":200},"description":"`customer:` for an end customer of your organization, otherwise your own external id (URL-encode it)."}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardMemberSummary"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/members/{ref}/history":{"get":{"operationId":"listRewardsMemberHistory","summary":"Newest ledger movements of a member, up to 200 (scope: rewards:read)","parameters":[{"name":"ref","in":"path","required":true,"schema":{"type":"string","maxLength":200},"description":"`customer:` for an end customer of your organization, otherwise your own external id (URL-encode it)."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":200,"default":50}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RewardHistoryItem"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/members/{ref}/redemptions":{"post":{"operationId":"createRewardsRedemption","summary":"Redeem a catalogue item for a member; units are burnt at once, above the auto-approve threshold the redemption waits for your approval. 409 insufficient_units / in_debt (scope: rewards:write)","parameters":[{"name":"ref","in":"path","required":true,"schema":{"type":"string","maxLength":200},"description":"`customer:` for an end customer of your organization, otherwise your own external id (URL-encode it)."},{"name":"Idempotency-Key","in":"header","required":false,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardRedemptionCreate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardRedemptionResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardRedemptionResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/events":{"post":{"operationId":"createRewardsEvent","summary":"Record a business event and process it inline; payload.units is the award. Idempotency-Key (or type+ref+member) dedupes (scope: rewards:write)","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardEventCreate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardEventResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardEventResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/catalog":{"get":{"operationId":"listRewardsCatalog","summary":"Active catalogue of your programme (scope: rewards:read)","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RewardCatalogItem"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/clawbacks":{"post":{"operationId":"createRewardsClawback","summary":"Reverse the units a refunded or voided business object earned; spent units become debt (scope: rewards:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardClawbackCreate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardClawbackResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/widget-keys":{"post":{"operationId":"createRewardsWidgetKey","summary":"Create a widget signing key; the secret is returned once (scope: rewards:write)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardWidgetKeyCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardWidgetKey"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/widget-keys/{kid}":{"delete":{"operationId":"revokeRewardsWidgetKey","summary":"Revoke a widget key; its sessions stop working at once (scope: rewards:write)","parameters":[{"name":"kid","in":"path","required":true,"schema":{"type":"string","maxLength":40}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardWidgetKeyRevoked"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/widget/session":{"post":{"operationId":"createRewardsWidgetSession","summary":"PUBLIC (no API key): exchange a host-signed token for a 15-minute read-only session. Each token works once (jti); CORS limited to the key's allowedOrigins","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardWidgetSessionCreate"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardWidgetSession"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/rewards/widget/me":{"get":{"operationId":"getRewardsWidgetMe","summary":"PUBLIC (widget session token as Bearer): the member summary and last 10 movements the widget renders","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/RewardWidgetMe"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["rewards"]}},"/shipping-points":{"get":{"operationId":"listShippingPoints","summary":"Search lockers, partner shops and courier offices (global data, refreshed daily). One anchor required: near, city, postal_code or q. (scope: shipping:read)","parameters":[{"name":"near","in":"query","required":false,"schema":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?,-?\\d+(\\.\\d+)?$"},"description":"lat,lng — sorted by distance"},{"name":"radius_km","in":"query","required":false,"schema":{"type":"number","maximum":50,"default":10},"description":"With near"},{"name":"city","in":"query","required":false,"schema":{"type":"string"},"description":"Locality (diacritics optional)"},{"name":"postal_code","in":"query","required":false,"schema":{"type":"string"},"description":"6-digit RO postcode"},{"name":"q","in":"query","required":false,"schema":{"type":"string","minLength":2},"description":"Text over name / address / city"},{"name":"courier","in":"query","required":false,"schema":{"type":"string"},"description":"Comma list of sameday, cargus, fancourier, dpd, gls"},{"name":"type","in":"query","required":false,"schema":{"type":"string"},"description":"Comma list of locker, shop, office, post"},{"name":"cod","in":"query","required":false,"schema":{"type":"boolean"},"description":"Only points that accept cash on delivery"},{"name":"card","in":"query","required":false,"schema":{"type":"boolean"},"description":"Only points that accept card"},{"name":"open_24_7","in":"query","required":false,"schema":{"type":"boolean"},"description":"Only points open around the clock"},{"name":"weight_kg","in":"query","required":false,"schema":{"type":"number"},"description":"Hide points that cannot take this weight"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"default":50},"description":"Max results"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ShippingPoint"}},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["shipping-points"]}},"/shipments":{"get":{"operationId":"listShipments","summary":"List shipments (AWBs), newest first (scope: shipping:read)","parameters":[{"name":"page","in":"query","schema":{"type":"integer"}},{"name":"perPage","in":"query","schema":{"type":"integer"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["draft","awb_generated","picked_up","in_transit","out_for_delivery","delivered","returned","cancelled","failed"]},"description":"Only this status"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Shipment"}},"meta":{"$ref":"#/components/schemas/Meta"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["shipments"]},"post":{"operationId":"createShipment","summary":"Create an AWB at a courier — a real cost. Sender is the organisation; the pickup point is re-validated; the label is stored. 409 COURIER_NOT_CONFIGURED / SENDER_MISSING; 422 POINT_*. Requires Idempotency-Key. (scope: shipping:write)","parameters":[{"name":"Idempotency-Key","in":"header","required":true,"description":"Required. Retries with the same key replay the first response instead of starting a second job (24 h).","schema":{"type":"string","maxLength":200}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentCreate"}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Shipment"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["shipments"]}},"/shipments/quote":{"post":{"operationId":"quoteShipment","summary":"Price a parcel at every configured courier in parallel and compare (cheapest real tariff first). Creates nothing. Heavy rate tier. (scope: shipping:read)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ShipmentQuoteRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ShipmentQuoteResult"},"error":{"type":"null"}},"required":["data","error"]}}}},"400":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"429":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["shipments"]}},"/shipments/{id}":{"get":{"operationId":"getShipment","summary":"Get a shipment (scope: shipping:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Shipment"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["shipments"]}},"/shipments/{id}/label":{"get":{"operationId":"getShipmentLabel","summary":"Download the AWB label (PDF, or ZPL with format=zpl) (scope: shipping:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"},{"name":"format","in":"query","required":false,"schema":{"type":"string","enum":["pdf_a4","pdf_a6","zpl"]},"description":"Ask the courier for this format"}],"responses":{"200":{"description":"The label document","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/zpl":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["shipments"]}},"/shipments/{id}/tracking":{"get":{"operationId":"getShipmentTracking","summary":"Refresh tracking from the courier and return the shipment with all events (scope: shipping:read)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Shipment"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["shipments"]}},"/shipments/{id}/cancel":{"post":{"operationId":"cancelShipment","summary":"Cancel the AWB at the courier and mark the shipment cancelled. 409 ALREADY_FINAL / CANCEL_UNSUPPORTED. Honours Idempotency-Key. (scope: shipping:write)","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid"},"description":"Shipment id"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Shipment"},"error":{"type":"null"}},"required":["data","error"]}}}},"401":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"403":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"404":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"409":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"422":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}},"503":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"null"},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object","nullable":true,"additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["code","message"]}},"required":["data","error"]}}}}},"tags":["shipments"]}}}},"proxyUrl":"$undefined"},"document":"brivio","operations":[{"method":"get","path":"/webhooks/events","tags":["webhooks"]}],"showDescription":true}]}]]}]

List available webhook event types

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Response Body