{"openapi":"3.0.3","info":{"title":"JAI CRM API","description":"The API behind the app. Everything a screen can do, a request can do — the web client is a consumer of this and has no privileged back channel.\n\n**Authenticating.** A third-party integration presents an API key, created in Settings → API keys, as `Authorization: Bearer bb_xxxxxxxx.<secret>` or in an `X-API-Key` header. A key carries only the permissions granted when it was made, and can be revoked or given an expiry at any time. The app itself uses a short-lived JWT from `/auth/login`, which is refreshed; that flow is for interactive sessions, not for machines.\n\n**Scope.** Every request is confined to the business the key belongs to. Isolation is enforced in the database rather than in application code, so no request can reach another tenant's data.\n\n**Rate limits.** Requests are limited per account, and sign-in more tightly. Exceeding a limit returns 429 with the wait in the response.\n\n**Webhooks.** Instead of asking for changes, an integration can be told. Add an endpoint in Settings › API keys & webhooks, or with `POST /settings/webhooks` and `{ \"url\": \"https://…\", \"events\": [\"invoice.paid\"] }`. The answer carries the endpoint's `secret` once; store it. Remove an endpoint with `DELETE /settings/webhooks/{id}?confirm=true`.\n\n| Event | When |\n|---|---|\n| `lead.created` | A lead is added. Typed in, scanned from a card, or arriving from IndiaMART or Just Dial. |\n| `customer.created` | A customer is added. Added by hand, or made by converting a lead. |\n| `deal.won` | A deal is won. Marked won, or moved to a won stage on the board. |\n| `quotation.sent` | A quotation is sent. Proformas too; the type field says which. |\n| `quotation.accepted` | A quotation is accepted. By your team or by the customer on the link. |\n| `invoice.created` | An invoice is raised. Invoices, bills of supply and retainers, drafts included. |\n| `invoice.paid` | An invoice is paid in full. However the money came in. |\n| `payment.received` | A payment is received. Recorded by your team or paid online. |\n| `purchaseOrder.sent` | A purchase order is sent. To the supplier. |\n| `task.completed` | A task is completed. Ticked off on the task, the board or a bulk edit. |\n| `salesDebitNote.sent` | A debit note goes to a customer. Adding to an invoice they already have; the invoice it adds to is in the payload. |\n| `salesDebitNote.paid` | A customer's debit note is paid in full. However the money came in. |\n\nEach delivery is a `POST` of JSON:\n\n```\nContent-Type: application/json\nX-BB-Event: invoice.paid\nX-BB-Delivery: 6f2c9e1a-…        (the same on every retry of this delivery)\nX-BB-Timestamp: 1760945662       (this attempt, in seconds)\nX-BB-Attempt: 1\nX-BB-Signature: 9b1f…            (HMAC-SHA256 of the raw body, keyed with the secret, in hex)\n\n{ \"id\": \"6f2c9e1a-…\", \"event\": \"invoice.paid\", \"at\": \"2026-10-20T09:14:22.000Z\", \"data\": { … } }\n```\n\n**Checking a delivery.** Compute the HMAC-SHA256 of the raw body with the secret and compare it with `X-BB-Signature` in constant time, before parsing anything. A delivery can arrive more than once and out of order: drop repeats by `id`, and order by `at`, when the thing happened.\n\n**Answering.** Reply with any 2xx within 10 seconds, and do the work afterwards. A 5xx, 408 or 429, no answer in time, or a connection that fails is tried again after 1 min, 5 min, 30 min, 2 h, 6 h (6 tries in all), with the same id, body and signature. Any other answer is final, a redirect included: redirects are not followed. After 20 deliveries in a row fail for good, the endpoint is switched off; `PATCH /settings/webhooks/{id}` with `{ \"isActive\": true }` switches it back on. `POST /settings/webhooks/{id}/test` sends a signed `test.ping` and returns what the endpoint answered.\n\n**Where we post.** Only to `https` addresses that resolve to public addresses on the internet. Private, loopback, link-local and cloud metadata addresses are refused when the endpoint is saved and again before every delivery. The delivery log keeps the status code and a short reason for 30 days, never the body of the answer.\n\n**What `data` carries.** The record a few seconds after the event: its `id`, the fields a connector needs, the `owner` (`id`, `name`, `email`), `custom` (the business's own fields) and `url`, which opens it in JAI CRM. Money is a number in the record's `currency`; dates are ISO 8601 in UTC. Fields may be added, never renamed or removed.\n\n- `lead.created`: `name`, `companyName`, `designation`, `email`, `phone`, `mobile` (and the 2nd to 4th), `source`, `stage`, `rating`, `value`, `currency`, `address`, `interestedIn`, `tags`, `nextFollowUpAt`.\n- `customer.created`: `code`, `name`, `company`, contact details as a lead, `gstin`, `gstTreatment`, `placeOfSupply`, `currency`, `paymentTerms`, `creditDays`, `billingAddress`, `shippingAddress`, `source`, `convertedFromLeadId`.\n- `deal.won`: `name`, `amount`, `currency`, `pipeline`, `stage`, `outcome`, `closedAt`, `customer`, `company`, `leadId`.\n- `quotation.sent`, `quotation.accepted`, `invoice.created`, `invoice.paid`, `purchaseOrder.sent`: `type` (`quotation`, `proforma`, `invoice`, `billOfSupply`, `retainer`, `purchaseOrder`), `number`, `status`, `issueDate`, `dueDate`, `validUntil`, `customer` or `vendor`, `billTo`, `shipTo`, `lines` (`name`, `hsnSac`, `quantity`, `rate`, `taxRate`, `taxableValue`, `taxAmount`, `total`), `subtotal`, `taxTotal`, `total`, `amountPaid`, `amountDue`.\n- `salesDebitNote.sent`, `salesDebitNote.paid`: a debit note to a customer, adding to an invoice they already have. The document fields above with `type` `salesDebitNote`, plus `against` (`id`, `number`, `type` of the invoice or bill of supply it adds to) and `reason`. Never sent as `invoice.created` or `invoice.paid`.\n- `payment.received`: `number`, `date`, `amount`, `tdsAmount`, `mode`, `reference`, `customer`, `allocations` (`documentId`, `number`, `amount`), `unallocated`.\n- `task.completed`: `title`, `status`, `priority`, `dueDate`, `completedAt`, `outcome`, `related` (`type`, `id`), `customerId`, `dealId`, `leadId`.\n\nNever in a delivery: passwords, keys, share-link tokens, PAN, drawn signatures or internal notes.","version":"1.0.0","contact":{"name":"JAI CRM","email":"info@brandbeavers.com"}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"A session token from /auth/login, or an API key of the form bb_xxxxxxxx.<secret>"},"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"An API key created in Settings → API keys"}},"schemas":{}},"paths":{"/health":{"get":{"summary":"Check the API is alive","tags":["Service"],"responses":{"200":{"description":"Default Response"}}}},"/health/ready":{"get":{"summary":"Check the API can reach its database","tags":["Service"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/register":{"post":{"summary":"Create a business and its first administrator","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/register/autopay":{"get":{"summary":"List autopay","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/register/autopay/retry":{"post":{"summary":"Create a retry","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/login":{"post":{"summary":"Sign in and receive a token","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/refresh":{"post":{"summary":"Exchange a refresh token for a new one","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/session":{"get":{"summary":"List session","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/me":{"patch":{"summary":"Read who the current token belongs to","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/sessions":{"get":{"summary":"List sessions","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/sessions/{id}":{"delete":{"summary":"Delete a session","tags":["Authentication"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/logout":{"post":{"summary":"End the session","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/logout-all":{"post":{"summary":"Create a logout all","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/forgot-password":{"post":{"summary":"Create a forgot password","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/reset-password":{"post":{"summary":"Create a reset password","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/change-password":{"post":{"summary":"Create a change password","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/invitation/{token}":{"get":{"summary":"Read one invitation","tags":["Authentication"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/accept-invitation":{"post":{"summary":"Create an accept invitation","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/2fa/setup":{"post":{"summary":"Create a setup","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/2fa/enable":{"post":{"summary":"Create an enable","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/2fa/disable":{"post":{"summary":"Create a disable","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/platform/login":{"post":{"summary":"Sign in and receive a token","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/platform/session":{"get":{"summary":"List session","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/my-workspaces":{"get":{"summary":"List my workspaces","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/switch":{"post":{"summary":"Create a switch","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/workspace-plans":{"get":{"summary":"List workspace plans","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/workspaces/{id}/state":{"get":{"summary":"List state","tags":["Authentication"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/workspaces/new":{"post":{"summary":"Create a new","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/default-workspace":{"post":{"summary":"Create a default workspace","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/workspaces":{"post":{"summary":"Create a workspace","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/auth/me/deletion":{"get":{"summary":"List deletion","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a deletion","tags":["Authentication"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/organisation":{"get":{"summary":"List organisation","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an organisation","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/settings":{"get":{"summary":"List settings","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a setting","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/branches":{"get":{"summary":"List branches","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a branche","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/branches/{id}":{"get":{"summary":"Read one branche","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a branche","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a branche","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/branches/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/people":{"get":{"summary":"List people","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/users":{"get":{"summary":"List users","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an user","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/users/{id}":{"get":{"summary":"Read one user","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an user","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an user","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/users/{id}/effective-permissions":{"get":{"summary":"List effective permissions","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/users/permission-preview":{"post":{"summary":"Create a permission preview","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/users/{id}/permissions":{"patch":{"summary":"Change a permission","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/users/{id}/resend-invitation":{"post":{"summary":"Create a resend invitation","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/users/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/permission-scopes":{"get":{"summary":"List permission scopes","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/roles":{"get":{"summary":"List roles","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a role","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/roles/tree":{"get":{"summary":"List tree","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/roles/matrix":{"get":{"summary":"List matrix","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/roles/{id}":{"get":{"summary":"Read one role","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a role","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a role","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/roles/{id}/shipped":{"get":{"summary":"List shipped","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/roles/{id}/duplicate":{"post":{"summary":"Create a duplicate","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/roles/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/groups":{"get":{"summary":"List groups","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a group","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/circles":{"get":{"summary":"List circles, filtered, sorted and paged","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a circle","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/teams":{"get":{"summary":"List teams","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a team","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/groups/{id}":{"get":{"summary":"Read one group","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a group","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a group","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/circles/{id}":{"get":{"summary":"Read one circle in full","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a circle","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a circle","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/teams/{id}":{"get":{"summary":"Read one team","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a team","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a team","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/groups/{id}/members":{"post":{"summary":"Create a member","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/circles/{id}/members":{"post":{"summary":"Add to the members of a circle","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/teams/{id}/members":{"post":{"summary":"Create a member","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/groups/{groupId}/members/{memberId}":{"delete":{"summary":"Delete a member","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"groupId","required":true},{"schema":{"type":"string"},"in":"path","name":"memberId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/circles/{groupId}/members/{memberId}":{"delete":{"summary":"Remove from the members of a circle","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"groupId","required":true},{"schema":{"type":"string"},"in":"path","name":"memberId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/teams/{groupId}/members/{memberId}":{"delete":{"summary":"Delete a member","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"groupId","required":true},{"schema":{"type":"string"},"in":"path","name":"memberId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/groups/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/circles/{id}/dependencies":{"get":{"summary":"List what would break if a circle were deleted","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/teams/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/fields/{module}":{"get":{"summary":"Read one field","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Act on a field","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/fields/{module}/borrowable":{"get":{"summary":"List borrowable","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/fields/{module}/link":{"post":{"summary":"Create a link","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/fields/{module}/rollup":{"post":{"summary":"Create a rollup","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/fields/{module}/order":{"patch":{"summary":"Change an order","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/fields/{module}/{id}":{"patch":{"summary":"Change a field","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a field","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/fields/{module}/rules":{"get":{"summary":"List rules","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a rule","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/fields/{module}/rules/{id}":{"patch":{"summary":"Change a rule","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a rule","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/fields/{module}/rules/test":{"post":{"summary":"Create a test","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/field-modules":{"get":{"summary":"List field modules","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/option-sets":{"get":{"summary":"List option sets","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an option set","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/option-sets/{id}/values":{"put":{"summary":"Change a value","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/views/{module}":{"get":{"summary":"Read one view","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/views":{"post":{"summary":"Create a view","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/views/{id}":{"patch":{"summary":"Change a view","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a view","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/views/{id}/default":{"post":{"summary":"Create a default","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/taxes":{"get":{"summary":"List taxes","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a taxe","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/taxes/defaults":{"get":{"summary":"List defaults","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/taxes/{id}":{"get":{"summary":"Read one taxe","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a taxe","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a taxe","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/taxes/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/taxes/preview":{"post":{"summary":"Create a preview","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/withholding":{"get":{"summary":"List withholding","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a withholding","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/withholding/{id}":{"patch":{"summary":"Change a withholding","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a withholding","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/hsn":{"get":{"summary":"List hsn","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a hsn","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/hsn/{id}":{"delete":{"summary":"Delete a hsn","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/templates":{"get":{"summary":"List templates","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a template","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/templates/meta":{"get":{"summary":"List meta","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/templates/{id}":{"get":{"summary":"Read one template","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a template","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a template","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/templates/{id}/default":{"post":{"summary":"Create a default","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/templates/{id}/duplicate":{"post":{"summary":"Create a duplicate","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/templates/{id}/preview":{"post":{"summary":"Create a preview","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/snippets":{"get":{"summary":"List snippets","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a snippet","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/snippets/{id}":{"delete":{"summary":"Delete a snippet","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/email-templates":{"get":{"summary":"List email templates","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an email template","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/email-templates/{id}":{"get":{"summary":"Read one email template","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an email template","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an email template","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/assignable-users":{"get":{"summary":"List assignable users","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/rules":{"get":{"summary":"List rules","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a rule","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/rules/{id}":{"patch":{"summary":"Change a rule","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a rule","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/rules/{id}/entries":{"post":{"summary":"Create an entry","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/entries/{id}":{"patch":{"summary":"Change an entry","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an entry","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/thresholds":{"get":{"summary":"List thresholds","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a threshold","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/thresholds/{id}":{"delete":{"summary":"Delete a threshold","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/reallocation":{"get":{"summary":"List reallocation","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a reallocation","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/reallocation/run":{"post":{"summary":"Create a run","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/settings":{"get":{"summary":"List settings","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a setting","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/assignment/log":{"get":{"summary":"List log","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/reporting-tags":{"get":{"summary":"List reporting tags","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a reporting tag","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/reporting-tags/{id}":{"patch":{"summary":"Change a reporting tag","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a reporting tag","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/reporting-tags/{id}/options":{"post":{"summary":"Create an option","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/reporting-tags/{id}/options/{optionId}":{"patch":{"summary":"Change an option","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"optionId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an option","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"optionId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/reporting-tags/links":{"get":{"summary":"List links","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a link","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/reporting-tags/available":{"get":{"summary":"List available","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/plugins":{"get":{"summary":"List plugins","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/plugins/{key}":{"post":{"summary":"Act on a plugin","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/addons":{"get":{"summary":"List addons","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/addons/{key}":{"post":{"summary":"Act on an addon","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/integrations":{"get":{"summary":"List integrations","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/storage":{"get":{"summary":"List storage","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/storage/{code}":{"post":{"summary":"Act on a storage","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"code","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/storage/breakdown":{"get":{"summary":"List breakdown","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/storage/explore":{"get":{"summary":"List explore","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/storage/mine":{"get":{"summary":"List mine","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/storage/requests":{"post":{"summary":"Create a request","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"get":{"summary":"List requests","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/storage/requests/{id}/decide":{"post":{"summary":"Create a decide","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/modules":{"get":{"summary":"List modules","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/menu":{"get":{"summary":"List menu","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/modules/order":{"patch":{"summary":"Change an order","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/modules/{moduleKey}":{"patch":{"summary":"Change a module","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"moduleKey","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/modules/{moduleKey}/{submoduleKey}":{"patch":{"summary":"Change a module","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"moduleKey","required":true},{"schema":{"type":"string"},"in":"path","name":"submoduleKey","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/menu-items":{"get":{"summary":"List menu items","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a menu item","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/menu-items/{id}":{"patch":{"summary":"Change a menu item","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a menu item","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/menu-items/order":{"patch":{"summary":"Change an order","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/dependencies":{"get":{"summary":"List dependencies","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a dependency","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/dependencies/{id}":{"patch":{"summary":"Change a dependency","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a dependency","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/numbering":{"get":{"summary":"List numbering","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/numbering/{id}":{"patch":{"summary":"Change a numbering","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/audit":{"get":{"summary":"List audit","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/audit/export.csv":{"get":{"summary":"List export.csv","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/api-keys":{"get":{"summary":"List api keys","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an api key","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/api-keys/{id}":{"delete":{"summary":"Delete an api key","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/webhooks":{"get":{"summary":"Webhook endpoints, each with its last ten deliveries (status and reason only)","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add a webhook endpoint; the signing secret is in this answer and never again","tags":["Settings"],"description":"The address must be https and must resolve to a public address. `events` names one or more of the events listed in the reference introduction. The answer carries `secret`, used to check each delivery's X-BB-Signature; store it, it is not shown again.","responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":2000},"events":{"type":"array","items":{"type":"string"},"minItems":1}},"required":["url","events"],"additionalProperties":false}}}}}},"/api/settings/webhooks/{id}":{"patch":{"summary":"Change a webhook endpoint's address or events, or switch it off or back on","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":2000},"events":{"type":"array","items":{"type":"string"},"minItems":1},"isActive":{"type":"boolean"}},"additionalProperties":false}}}}},"delete":{"summary":"Remove a webhook endpoint and its delivery log (needs ?confirm=true)","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/webhooks/{id}/test":{"post":{"summary":"Send a signed test.ping to a webhook endpoint now, and say what it answered","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/sharing/modules":{"get":{"summary":"List modules","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/sharing/options":{"get":{"summary":"List options","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an option","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/sharing/org-permissions":{"get":{"summary":"List org permissions","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/sharing/org-permissions/{module}":{"patch":{"summary":"Change an org permission","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/sharing/rules":{"get":{"summary":"List rules","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a rule","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/sharing/rules/{id}":{"patch":{"summary":"Change a rule","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a rule","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/sharing/rules/{id}/duplicate":{"post":{"summary":"Create a duplicate","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/recycle-bin":{"get":{"summary":"List recycle bin","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/recycle-bin/restore":{"post":{"summary":"Create a restore","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/bank-accounts":{"get":{"summary":"List bank accounts","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a bank account","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/bank-accounts/{id}":{"patch":{"summary":"Change a bank account","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a bank account","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/bank-accounts/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Settings"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/my-email":{"get":{"summary":"List my email","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a my email","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a my email","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/workspace-email":{"get":{"summary":"List workspace email","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a workspace email","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a workspace email","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/workspace-mail":{"get":{"summary":"List workspace mail","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a workspace mail","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/mail-sharing":{"get":{"summary":"List mail sharing","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a mail sharing","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/mail-delete":{"put":{"summary":"Change a mail delete","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/my-email/receive":{"post":{"summary":"Create a receive","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/settings/my-email/test":{"post":{"summary":"Create a test","tags":["Settings"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/search":{"get":{"summary":"Search across sales","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/summary":{"get":{"summary":"Read a summary for sales","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tags":{"get":{"summary":"List the tags in use, with how many records carry each","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tags/apply":{"post":{"summary":"Add or remove tags on several records at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tags/{name}":{"patch":{"summary":"Rename a tag on every record that carries it","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"name","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove a tag from every record that carries it","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"name","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/pipelines":{"get":{"summary":"List pipelines","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a pipeline","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/pipelines/{id}":{"patch":{"summary":"Change a pipeline","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/pipelines/{id}/stages":{"put":{"summary":"Change a stage","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/pipelines/{id}/default":{"post":{"summary":"Create a default","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/pipelines/{id}/delete":{"post":{"summary":"Create a delete","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/comments":{"get":{"summary":"List the comments for a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads":{"get":{"summary":"List leads, filtered, sorted and paged","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a lead","tags":["Sales"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string","format":"uuid","nullable":true},"interestedIn":{"type":"array","items":{"type":"string","minLength":1},"maxItems":30},"name":{"type":"string","minLength":1},"companyName":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"email":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"phone":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"mobile2":{"type":"string","nullable":true},"mobile3":{"type":"string","nullable":true},"mobile4":{"type":"string","nullable":true},"phone2":{"type":"string","nullable":true},"phone3":{"type":"string","nullable":true},"email2":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"email3":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"moreDetails":{"type":"string","nullable":true},"designation":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"stage":{"type":"string"},"rating":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"value":{"type":"number","nullable":true},"currency":{"type":"string","minLength":3,"maxLength":3},"probability":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"website":{"type":"string","nullable":true},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"nextFollowUpAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"nextFollowUpTime":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}],"nullable":true},"lastContactedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"outcome":{"type":"string","enum":["open","won","lost"],"nullable":true},"lostReason":{"type":"string","nullable":true},"lostRemark":{"type":"string","maxLength":2000,"nullable":true},"score":{"type":"integer","nullable":true},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["name"],"additionalProperties":false}}}}}},"/api/crm/leads/export.csv":{"get":{"summary":"Download leads as a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/kanban":{"get":{"summary":"Read leads arranged as a board","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/pivot":{"get":{"summary":"Summarise leads as a pivot table","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/bulk":{"post":{"summary":"Change several leads at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/bulk/delete":{"post":{"summary":"Delete several leads at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/bulk/assign":{"post":{"summary":"Assign several leads to somebody at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/import":{"post":{"summary":"Import leads from a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}":{"get":{"summary":"Read one lead in full","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string","format":"uuid","nullable":true},"interestedIn":{"type":"array","items":{"type":"string","minLength":1},"maxItems":30},"name":{"type":"string","minLength":1},"companyName":{"type":"string","nullable":true},"number":{"type":"string","nullable":true},"email":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"phone":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"mobile2":{"type":"string","nullable":true},"mobile3":{"type":"string","nullable":true},"mobile4":{"type":"string","nullable":true},"phone2":{"type":"string","nullable":true},"phone3":{"type":"string","nullable":true},"email2":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"email3":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"moreDetails":{"type":"string","nullable":true},"designation":{"type":"string","nullable":true},"source":{"type":"string","nullable":true},"stage":{"type":"string"},"rating":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"value":{"type":"number","nullable":true},"currency":{"type":"string","minLength":3,"maxLength":3},"probability":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"website":{"type":"string","nullable":true},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"nextFollowUpAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"nextFollowUpTime":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}],"nullable":true},"lastContactedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"outcome":{"type":"string","enum":["open","won","lost"],"nullable":true},"lostReason":{"type":"string","nullable":true},"lostRemark":{"type":"string","maxLength":2000,"nullable":true},"score":{"type":"integer","nullable":true},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/similar":{"get":{"summary":"Find leads that look like duplicates of this one","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/dependencies":{"get":{"summary":"List what would break if a lead were deleted","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/assignees":{"post":{"summary":"Put somebody on a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/timeline":{"get":{"summary":"Read everything that has happened to a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/notes":{"post":{"summary":"Add a note to a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/email-check":{"get":{"summary":"List the email check for a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/email":{"post":{"summary":"Send an email about a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/related":{"get":{"summary":"List the related for a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/related/{module}":{"get":{"summary":"List the related for a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/convert/company":{"get":{"summary":"List the company for a lead","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/leads/{id}/convert":{"post":{"summary":"Convert a lead into the next document","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/comments":{"get":{"summary":"List the comments for a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies":{"get":{"summary":"List companies, filtered, sorted and paged","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a company","tags":["Sales"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"legalName":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"segment":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"email":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"phone":{"type":"string","nullable":true},"gstin":{"type":"string","nullable":true},"pan":{"type":"string","nullable":true},"employees":{"type":"integer","minimum":0,"nullable":true},"turnover":{"type":"number","nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"stateCode":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["name"],"additionalProperties":false}}}}}},"/api/crm/companies/export.csv":{"get":{"summary":"Download companies as a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/kanban":{"get":{"summary":"Read companies arranged as a board","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/pivot":{"get":{"summary":"Summarise companies as a pivot table","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/bulk":{"post":{"summary":"Change several companies at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/bulk/delete":{"post":{"summary":"Delete several companies at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/bulk/assign":{"post":{"summary":"Assign several companies to somebody at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/import":{"post":{"summary":"Import companies from a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}":{"get":{"summary":"Read one company in full","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"legalName":{"type":"string","nullable":true},"industry":{"type":"string","nullable":true},"segment":{"type":"string","nullable":true},"website":{"type":"string","nullable":true},"email":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"phone":{"type":"string","nullable":true},"gstin":{"type":"string","nullable":true},"pan":{"type":"string","nullable":true},"employees":{"type":"integer","minimum":0,"nullable":true},"turnover":{"type":"number","nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"addressLine1":{"type":"string","nullable":true},"addressLine2":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"state":{"type":"string","nullable":true},"stateCode":{"type":"string","nullable":true},"postalCode":{"type":"string","nullable":true},"country":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/similar":{"get":{"summary":"Find companies that look like duplicates of this one","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/dependencies":{"get":{"summary":"List what would break if a company were deleted","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/assignees":{"post":{"summary":"Put somebody on a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/timeline":{"get":{"summary":"Read everything that has happened to a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/notes":{"post":{"summary":"Add a note to a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/email-check":{"get":{"summary":"List the email check for a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/email":{"post":{"summary":"Send an email about a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/related":{"get":{"summary":"List the related for a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/companies/{id}/related/{module}":{"get":{"summary":"List the related for a company","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/comments":{"get":{"summary":"List the comments for a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers":{"get":{"summary":"List customers, filtered, sorted and paged","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a customer","tags":["Sales"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string","format":"uuid","nullable":true},"doNotContact":{"type":"boolean"},"name":{"type":"string","minLength":1},"code":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid","nullable":true},"email":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"phone":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"mobile2":{"type":"string","nullable":true},"mobile3":{"type":"string","nullable":true},"mobile4":{"type":"string","nullable":true},"phone2":{"type":"string","nullable":true},"phone3":{"type":"string","nullable":true},"email2":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"email3":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"moreDetails":{"type":"string","nullable":true},"designation":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"status":{"type":"string"},"industry":{"type":"string","nullable":true},"source":{"type":"string","maxLength":120,"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"nickname":{"type":"string","nullable":true},"currency":{"type":"string","minLength":3,"maxLength":3},"paymentTerms":{"type":"string","nullable":true},"creditLimit":{"type":"number","nullable":true},"creditDays":{"type":"integer","minimum":0,"nullable":true},"priceListId":{"type":"string","format":"uuid","nullable":true},"gstin":{"type":"string","nullable":true},"pan":{"type":"string","nullable":true},"gstTreatment":{"type":"string"},"placeOfSupply":{"type":"string","nullable":true},"taxRegime":{"type":"string","nullable":true},"defaultTaxRateId":{"type":"string","format":"uuid","nullable":true},"tdsApplicable":{"type":"boolean"},"tdsSection":{"type":"string","nullable":true},"tdsRate":{"type":"number","nullable":true},"billingLine1":{"type":"string","nullable":true},"billingLine2":{"type":"string","nullable":true},"billingCity":{"type":"string","nullable":true},"billingState":{"type":"string","nullable":true},"billingStateCode":{"type":"string","nullable":true},"billingPostal":{"type":"string","nullable":true},"billingCountry":{"type":"string","nullable":true},"shippingLine1":{"type":"string","nullable":true},"shippingLine2":{"type":"string","nullable":true},"shippingCity":{"type":"string","nullable":true},"shippingState":{"type":"string","nullable":true},"shippingStateCode":{"type":"string","nullable":true},"shippingPostal":{"type":"string","nullable":true},"shippingCountry":{"type":"string","nullable":true},"portalEnabled":{"type":"boolean"},"hideVendorNames":{"type":"boolean"},"website":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["name"],"additionalProperties":false}}}}}},"/api/crm/customers/export.csv":{"get":{"summary":"Download customers as a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/kanban":{"get":{"summary":"Read customers arranged as a board","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/pivot":{"get":{"summary":"Summarise customers as a pivot table","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/bulk":{"post":{"summary":"Change several customers at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/bulk/delete":{"post":{"summary":"Delete several customers at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/bulk/assign":{"post":{"summary":"Assign several customers to somebody at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/import":{"post":{"summary":"Import customers from a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}":{"get":{"summary":"Read one customer in full","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"partnerId":{"type":"string","format":"uuid","nullable":true},"doNotContact":{"type":"boolean"},"name":{"type":"string","minLength":1},"code":{"type":"string","nullable":true},"companyId":{"type":"string","format":"uuid","nullable":true},"email":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"phone":{"type":"string","nullable":true},"mobile":{"type":"string","nullable":true},"mobile2":{"type":"string","nullable":true},"mobile3":{"type":"string","nullable":true},"mobile4":{"type":"string","nullable":true},"phone2":{"type":"string","nullable":true},"phone3":{"type":"string","nullable":true},"email2":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"email3":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"moreDetails":{"type":"string","nullable":true},"designation":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"status":{"type":"string"},"industry":{"type":"string","nullable":true},"source":{"type":"string","maxLength":120,"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"nickname":{"type":"string","nullable":true},"currency":{"type":"string","minLength":3,"maxLength":3},"paymentTerms":{"type":"string","nullable":true},"creditLimit":{"type":"number","nullable":true},"creditDays":{"type":"integer","minimum":0,"nullable":true},"priceListId":{"type":"string","format":"uuid","nullable":true},"gstin":{"type":"string","nullable":true},"pan":{"type":"string","nullable":true},"gstTreatment":{"type":"string"},"placeOfSupply":{"type":"string","nullable":true},"taxRegime":{"type":"string","nullable":true},"defaultTaxRateId":{"type":"string","format":"uuid","nullable":true},"tdsApplicable":{"type":"boolean"},"tdsSection":{"type":"string","nullable":true},"tdsRate":{"type":"number","nullable":true},"billingLine1":{"type":"string","nullable":true},"billingLine2":{"type":"string","nullable":true},"billingCity":{"type":"string","nullable":true},"billingState":{"type":"string","nullable":true},"billingStateCode":{"type":"string","nullable":true},"billingPostal":{"type":"string","nullable":true},"billingCountry":{"type":"string","nullable":true},"shippingLine1":{"type":"string","nullable":true},"shippingLine2":{"type":"string","nullable":true},"shippingCity":{"type":"string","nullable":true},"shippingState":{"type":"string","nullable":true},"shippingStateCode":{"type":"string","nullable":true},"shippingPostal":{"type":"string","nullable":true},"shippingCountry":{"type":"string","nullable":true},"portalEnabled":{"type":"boolean"},"hideVendorNames":{"type":"boolean"},"website":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/similar":{"get":{"summary":"Find customers that look like duplicates of this one","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/dependencies":{"get":{"summary":"List what would break if a customer were deleted","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/assignees":{"post":{"summary":"Put somebody on a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/timeline":{"get":{"summary":"Read everything that has happened to a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/notes":{"post":{"summary":"Add a note to a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/email-check":{"get":{"summary":"List the email check for a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/email":{"post":{"summary":"Send an email about a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/related":{"get":{"summary":"List the related for a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/related/{module}":{"get":{"summary":"List the related for a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/customers/{id}/statement":{"get":{"summary":"List the statement for a customer","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/comments":{"get":{"summary":"List the comments for a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals":{"get":{"summary":"List deals, filtered, sorted and paged","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a deal","tags":["Sales"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"number":{"type":"string","nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"companyId":{"type":"string","format":"uuid","nullable":true},"leadId":{"type":"string","format":"uuid","nullable":true},"eventId":{"type":"string","format":"uuid","nullable":true},"partnerId":{"type":"string","format":"uuid","nullable":true},"contactId":{"type":"string","format":"uuid","nullable":true},"siteAddress":{"type":"string","nullable":true},"amount":{"type":"number","nullable":true},"currency":{"type":"string","minLength":3,"maxLength":3},"stage":{"type":"string"},"probability":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"expectedCloseDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"actualCloseDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"source":{"type":"string","nullable":true},"pipeline":{"type":"string","nullable":true},"outcome":{"type":"string","enum":["open","won","lost"]},"lostReason":{"type":"string","nullable":true},"lostRemark":{"type":"string","maxLength":2000,"nullable":true},"competitor":{"type":"string","nullable":true},"nextStep":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["name"],"additionalProperties":false}}}}}},"/api/crm/deals/export.csv":{"get":{"summary":"Download deals as a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/kanban":{"get":{"summary":"Read deals arranged as a board","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/pivot":{"get":{"summary":"Summarise deals as a pivot table","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/bulk":{"post":{"summary":"Change several deals at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/bulk/delete":{"post":{"summary":"Delete several deals at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/bulk/assign":{"post":{"summary":"Assign several deals to somebody at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/import":{"post":{"summary":"Import deals from a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}":{"get":{"summary":"Read one deal in full","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"number":{"type":"string","nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"companyId":{"type":"string","format":"uuid","nullable":true},"leadId":{"type":"string","format":"uuid","nullable":true},"eventId":{"type":"string","format":"uuid","nullable":true},"partnerId":{"type":"string","format":"uuid","nullable":true},"contactId":{"type":"string","format":"uuid","nullable":true},"siteAddress":{"type":"string","nullable":true},"amount":{"type":"number","nullable":true},"currency":{"type":"string","minLength":3,"maxLength":3},"stage":{"type":"string"},"probability":{"type":"integer","minimum":0,"maximum":100,"nullable":true},"expectedCloseDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"actualCloseDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"source":{"type":"string","nullable":true},"pipeline":{"type":"string","nullable":true},"outcome":{"type":"string","enum":["open","won","lost"]},"lostReason":{"type":"string","nullable":true},"lostRemark":{"type":"string","maxLength":2000,"nullable":true},"competitor":{"type":"string","nullable":true},"nextStep":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/similar":{"get":{"summary":"Find deals that look like duplicates of this one","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/dependencies":{"get":{"summary":"List what would break if a deal were deleted","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/assignees":{"post":{"summary":"Put somebody on a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/timeline":{"get":{"summary":"Read everything that has happened to a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/notes":{"post":{"summary":"Add a note to a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/email-check":{"get":{"summary":"List the email check for a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/email":{"post":{"summary":"Send an email about a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/related":{"get":{"summary":"List the related for a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/related/{module}":{"get":{"summary":"List the related for a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/deals/{id}/close":{"post":{"summary":"Add to the close of a deal","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/comments":{"get":{"summary":"List the comments for a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks":{"get":{"summary":"List tasks, filtered, sorted and paged","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a task","tags":["Sales"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1},"description":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"status":{"type":"string"},"priority":{"type":"string"},"ownerId":{"type":"string","format":"uuid","nullable":true},"dueDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"dueTime":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}],"nullable":true},"startDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"completedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"reminder":{"type":"string","nullable":true},"reminderAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"repeatRule":{"type":"string","nullable":true},"relatedType":{"type":"string","nullable":true},"relatedId":{"type":"string","format":"uuid","nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"dealId":{"type":"string","format":"uuid","nullable":true},"leadId":{"type":"string","format":"uuid","nullable":true},"outcome":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["title"],"additionalProperties":false}}}}}},"/api/crm/tasks/export.csv":{"get":{"summary":"Download tasks as a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/kanban":{"get":{"summary":"Read tasks arranged as a board","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/pivot":{"get":{"summary":"Summarise tasks as a pivot table","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/bulk":{"post":{"summary":"Change several tasks at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/bulk/delete":{"post":{"summary":"Delete several tasks at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/bulk/assign":{"post":{"summary":"Assign several tasks to somebody at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/import":{"post":{"summary":"Import tasks from a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}":{"get":{"summary":"Read one task in full","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string","minLength":1},"description":{"type":"string","nullable":true},"type":{"type":"string","nullable":true},"status":{"type":"string"},"priority":{"type":"string"},"ownerId":{"type":"string","format":"uuid","nullable":true},"dueDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"dueTime":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","pattern":"^([01]\\d|2[0-3]):[0-5]\\d$"}],"nullable":true},"startDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"completedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"reminder":{"type":"string","nullable":true},"reminderAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"repeatRule":{"type":"string","nullable":true},"relatedType":{"type":"string","nullable":true},"relatedId":{"type":"string","format":"uuid","nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"dealId":{"type":"string","format":"uuid","nullable":true},"leadId":{"type":"string","format":"uuid","nullable":true},"outcome":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/similar":{"get":{"summary":"Find tasks that look like duplicates of this one","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/dependencies":{"get":{"summary":"List what would break if a task were deleted","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/assignees":{"post":{"summary":"Put somebody on a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/timeline":{"get":{"summary":"Read everything that has happened to a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/notes":{"post":{"summary":"Add a note to a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/email-check":{"get":{"summary":"List the email check for a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/email":{"post":{"summary":"Send an email about a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/related":{"get":{"summary":"List the related for a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/related/{module}":{"get":{"summary":"List the related for a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/mine":{"get":{"summary":"List the mine for a task","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/complete":{"post":{"summary":"Add to the complete of a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/tasks/{id}/reopen":{"post":{"summary":"Add to the reopen of a task","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/comments":{"get":{"summary":"List the comments for a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits":{"get":{"summary":"List visits, filtered, sorted and paged","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a visit","tags":["Sales"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"purpose":{"type":"string","minLength":1},"status":{"type":"string","enum":["planned","done","cancelled"]},"ownerId":{"type":"string","format":"uuid","nullable":true},"plannedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"visitedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"checkedOutAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"outcome":{"type":"string","maxLength":200,"nullable":true},"cancelReason":{"type":"string","nullable":true},"relatedType":{"type":"string","nullable":true},"relatedId":{"type":"string","format":"uuid","nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"dealId":{"type":"string","format":"uuid","nullable":true},"leadId":{"type":"string","format":"uuid","nullable":true},"vendorId":{"type":"string","format":"uuid","nullable":true},"subject":{"type":"string","nullable":true},"metWith":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"place":{"type":"object","properties":{"lat":{"type":"number","minimum":-90,"maximum":90},"lng":{"type":"number","minimum":-180,"maximum":180},"accuracy":{"type":"number","minimum":0,"nullable":true},"capturedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"address":{"type":"string","maxLength":500,"nullable":true}},"required":["lat","lng"],"additionalProperties":false,"nullable":true},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["purpose"],"additionalProperties":false}}}}}},"/api/crm/visits/export.csv":{"get":{"summary":"Download visits as a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/kanban":{"get":{"summary":"Read visits arranged as a board","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/pivot":{"get":{"summary":"Summarise visits as a pivot table","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/bulk":{"post":{"summary":"Change several visits at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/bulk/delete":{"post":{"summary":"Delete several visits at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/bulk/assign":{"post":{"summary":"Assign several visits to somebody at once","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/import":{"post":{"summary":"Import visits from a CSV file","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}":{"get":{"summary":"Read one visit in full","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"purpose":{"type":"string","minLength":1},"status":{"type":"string","enum":["planned","done","cancelled"]},"ownerId":{"type":"string","format":"uuid","nullable":true},"plannedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"visitedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"checkedOutAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"outcome":{"type":"string","maxLength":200,"nullable":true},"cancelReason":{"type":"string","nullable":true},"relatedType":{"type":"string","nullable":true},"relatedId":{"type":"string","format":"uuid","nullable":true},"customerId":{"type":"string","format":"uuid","nullable":true},"dealId":{"type":"string","format":"uuid","nullable":true},"leadId":{"type":"string","format":"uuid","nullable":true},"vendorId":{"type":"string","format":"uuid","nullable":true},"subject":{"type":"string","nullable":true},"metWith":{"type":"string","nullable":true},"notes":{"type":"string","nullable":true},"place":{"type":"object","properties":{"lat":{"type":"number","minimum":-90,"maximum":90},"lng":{"type":"number","minimum":-180,"maximum":180},"accuracy":{"type":"number","minimum":0,"nullable":true},"capturedAt":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"address":{"type":"string","maxLength":500,"nullable":true}},"required":["lat","lng"],"additionalProperties":false,"nullable":true},"custom":{"type":"object","additionalProperties":{}},"assigneeIds":{"type":"array","items":{"type":"string","format":"uuid"}},"watcherIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/similar":{"get":{"summary":"Find visits that look like duplicates of this one","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/dependencies":{"get":{"summary":"List what would break if a visit were deleted","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/assignees":{"post":{"summary":"Put somebody on a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/timeline":{"get":{"summary":"Read everything that has happened to a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/notes":{"post":{"summary":"Add a note to a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/email-check":{"get":{"summary":"List the email check for a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/email":{"post":{"summary":"Send an email about a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/related":{"get":{"summary":"List the related for a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/related/{module}":{"get":{"summary":"List the related for a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/complete":{"post":{"summary":"Add to the complete of a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/check-in":{"post":{"summary":"Add to the check in of a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/visits/{id}/cancel":{"post":{"summary":"Cancel a visit","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/contacts":{"get":{"summary":"List contacts","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a contact","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/contacts/export.csv":{"get":{"summary":"List export.csv","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/contacts/{id}":{"get":{"summary":"Read one contact","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a contact","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a contact","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/contacts/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/contacts/bulk/delete":{"post":{"summary":"Create a delete","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/contacts/summary":{"get":{"summary":"Read a summary for sales","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/activities":{"get":{"summary":"List activities","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an activity","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/read-only/{entity}/{id}":{"get":{"summary":"Read one read only","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"entity","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/only-marked/{entity}/{id}":{"get":{"summary":"Read one only marked","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"entity","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/activities/{id}":{"get":{"summary":"Read one activity","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an activity","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an activity","tags":["Sales"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crm/":{"get":{"summary":"List crm","tags":["Sales"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages":{"get":{"summary":"List messages","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/{id}":{"get":{"summary":"Read one message","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/{id}/thread":{"get":{"summary":"List thread","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/{id}/important":{"post":{"summary":"Create an important","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/bulk":{"post":{"summary":"Create a bulk","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/counts":{"get":{"summary":"List counts","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/sense":{"get":{"summary":"List sense","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/sense/seen":{"post":{"summary":"Create a seen","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/recipients":{"get":{"summary":"List recipients","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/attachments":{"post":{"summary":"Create an attachment","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/compose":{"post":{"summary":"Create a compose","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/{id}/reply":{"post":{"summary":"Create a reply","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/{id}/forward":{"post":{"summary":"Create a forward","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/senders":{"get":{"summary":"List senders","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/drafts":{"put":{"summary":"Change a draft","tags":["Email"],"responses":{"200":{"description":"Default Response"}}},"get":{"summary":"List drafts","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/drafts/{id}":{"get":{"summary":"Read one draft","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a draft","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/images":{"post":{"summary":"Create an image","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/{id}/read":{"post":{"summary":"Create a read","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/bulk":{"post":{"summary":"Create a bulk","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/bulk/{batchId}":{"get":{"summary":"Read one bulk","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"batchId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/bulk/{batchId}/cancel":{"post":{"summary":"Create a cancel","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"batchId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/flow/lists":{"get":{"summary":"List lists","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/flow/mark":{"post":{"summary":"Create a mark","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/flow/unmark":{"post":{"summary":"Create an unmark","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/flow/senders":{"get":{"summary":"List senders","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/flow/senders/act":{"post":{"summary":"Create an act","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/flow/messages/{id}/make-lead":{"post":{"summary":"Create a make lead","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/flow/messages/{id}/undo":{"post":{"summary":"Create an undo","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/flow/trends":{"get":{"summary":"List trends","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/flow/prefs":{"get":{"summary":"List prefs","tags":["Email"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a pref","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/ai":{"get":{"summary":"Which of the mailbox's AI jobs this person may use now","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/rules":{"get":{"summary":"List rules","tags":["Email"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a rule","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/rules/{id}":{"patch":{"summary":"Change a rule","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a rule","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/rules/order":{"post":{"summary":"Create an order","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/rules/packs/{key}":{"post":{"summary":"Act on a pack","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/rules/test":{"post":{"summary":"Create a test","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/rules/runs":{"get":{"summary":"List runs","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/rules/runs/{id}/undo":{"post":{"summary":"Create an undo","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/{id}/not-cold":{"post":{"summary":"Create a not cold","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/{id}/summary":{"post":{"summary":"Read a summary for summary","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/search/ai":{"post":{"summary":"Create an ai","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/tone/learn":{"post":{"summary":"Create a learn","tags":["Email"],"responses":{"200":{"description":"Default Response"}}}},"/api/email/team/threads/{id}/comment":{"post":{"summary":"Create a comment","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/team/threads/{id}/assign":{"post":{"summary":"Create an assign","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/team/threads/{id}/replying":{"post":{"summary":"Create a replying","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/{id}/make/{kind}":{"post":{"summary":"Act on a make","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"kind","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/messages/{id}/links":{"post":{"summary":"Create a link","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/email/links/{entityType}/{entityId}":{"get":{"summary":"Read one link","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"entityType","required":true},{"schema":{"type":"string"},"in":"path","name":"entityId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/announcements/current":{"get":{"summary":"List current","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/announcements/{id}/dismiss":{"post":{"summary":"Create a dismiss","tags":["Notifications"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/modules":{"get":{"summary":"List the modules this business has added","tags":["Modules you added"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add a module of your own","tags":["Modules you added"],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/modules/{key}":{"patch":{"summary":"Change a module of your own","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a module of your own","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/{key}":{"get":{"summary":"List the records in a module you added","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a record in a module you added","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/{key}/export.csv":{"get":{"summary":"Export the records of a module you added as CSV","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/{key}/kanban":{"get":{"summary":"Read a module you added as a board","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/{key}/pivot":{"get":{"summary":"Summarise a module you added as a pivot","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/{key}/import":{"post":{"summary":"Import records into a module you added","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/{key}/bulk":{"post":{"summary":"Change several records in a module you added","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/{key}/bulk/delete":{"post":{"summary":"Delete several records in a module you added","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/{key}/{id}/timeline":{"get":{"summary":"Read the history of a record in a module you added","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/custom/{key}/{id}":{"get":{"summary":"Read a record in a module you added","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a record in a module you added","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a record in a module you added","tags":["Modules you added"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/approvals/rules":{"get":{"summary":"List rules","tags":["Mobile app"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a rule","tags":["Mobile app"],"responses":{"200":{"description":"Default Response"}}}},"/api/approvals/rules/{id}":{"patch":{"summary":"Change a rule","tags":["Mobile app"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a rule","tags":["Mobile app"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/approvals/pending":{"get":{"summary":"List pending","tags":["Mobile app"],"responses":{"200":{"description":"Default Response"}}}},"/api/approvals/requests":{"get":{"summary":"List requests","tags":["Mobile app"],"responses":{"200":{"description":"Default Response"}}}},"/api/approvals/requests/{id}/decide":{"post":{"summary":"Create a decide","tags":["Mobile app"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/approvals/request":{"post":{"summary":"Create a request","tags":["Mobile app"],"responses":{"200":{"description":"Default Response"}}}},"/api/approvals/ask":{"post":{"summary":"Create an ask","tags":["Mobile app"],"responses":{"200":{"description":"Default Response"}}}},"/api/collect/gateways":{"get":{"summary":"List gateways","tags":["Collections"],"responses":{"200":{"description":"Default Response"}}}},"/api/collect/gateways/{gateway}":{"put":{"summary":"Change a gateway","tags":["Collections"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"gateway","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a gateway","tags":["Collections"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"gateway","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/collect/gateways/{gateway}/test":{"post":{"summary":"Create a test","tags":["Collections"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"gateway","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/collect/attempts":{"get":{"summary":"List attempts","tags":["Collections"],"responses":{"200":{"description":"Default Response"}}}},"/api/collect/pay/{token}":{"post":{"summary":"Act on a pay","tags":["Collections"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/collect/options/{token}":{"get":{"summary":"Read one option","tags":["Collections"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/collect/webhook/{tenantId}/{gateway}":{"post":{"summary":"Act on a webhook","tags":["Collections"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"tenantId","required":true},{"schema":{"type":"string"},"in":"path","name":"gateway","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/comments":{"get":{"summary":"List the comments for a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/import/fields":{"get":{"summary":"List the fields for a quotation","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/import":{"post":{"summary":"Import quotations from a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/bulk/delete":{"post":{"summary":"Delete several quotations at once","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations":{"get":{"summary":"List quotations, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a quotation","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/kanban":{"get":{"summary":"Read quotations arranged as a board","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/pivot":{"get":{"summary":"Summarise quotations as a pivot table","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/export.csv":{"get":{"summary":"Download quotations as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}":{"get":{"summary":"Read one quotation in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/revise":{"post":{"summary":"Replace a quotation with a numbered revision","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/dependencies":{"get":{"summary":"List what would break if a quotation were deleted","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/status":{"post":{"summary":"Change the status of a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/duplicate":{"post":{"summary":"Copy a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/print":{"get":{"summary":"Print a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/pdf":{"get":{"summary":"Download a quotation as a PDF","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/bulk/pdf":{"post":{"summary":"Download a quotation as a PDF","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/share":{"post":{"summary":"Share a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/send-draft":{"get":{"summary":"List the send draft for a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/email-check":{"get":{"summary":"List the email check for a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/email":{"post":{"summary":"Send an email about a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/send/ai":{"post":{"summary":"Add to the ai of a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/invoice":{"post":{"summary":"Invoice a quotation directly","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/proforma":{"post":{"summary":"Add to the proforma of a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/progress":{"get":{"summary":"List the progress for a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/progress-invoice":{"post":{"summary":"Add to the progress invoice of a quotation","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/quotations/{id}/convert":{"post":{"summary":"Convert a quotation into the next document","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/comments":{"get":{"summary":"List the comments for a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/import/fields":{"get":{"summary":"List the fields for a proposal","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/import":{"post":{"summary":"Import proposals from a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/bulk/delete":{"post":{"summary":"Delete several proposals at once","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals":{"get":{"summary":"List proposals, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a proposal","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/kanban":{"get":{"summary":"Read proposals arranged as a board","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/pivot":{"get":{"summary":"Summarise proposals as a pivot table","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/export.csv":{"get":{"summary":"Download proposals as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}":{"get":{"summary":"Read one proposal in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/revise":{"post":{"summary":"Replace a proposal with a numbered revision","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/dependencies":{"get":{"summary":"List what would break if a proposal were deleted","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/status":{"post":{"summary":"Change the status of a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/duplicate":{"post":{"summary":"Copy a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/print":{"get":{"summary":"Print a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/pdf":{"get":{"summary":"Download a proposal as a PDF","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/bulk/pdf":{"post":{"summary":"Download a proposal as a PDF","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/share":{"post":{"summary":"Share a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/send-draft":{"get":{"summary":"List the send draft for a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/email-check":{"get":{"summary":"List the email check for a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/email":{"post":{"summary":"Send an email about a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/send/ai":{"post":{"summary":"Add to the ai of a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/comments":{"get":{"summary":"List the comments for a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/import/fields":{"get":{"summary":"List the fields for a sales order","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/import":{"post":{"summary":"Import sales orders from a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/bulk/delete":{"post":{"summary":"Delete several sales orders at once","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders":{"get":{"summary":"List sales orders, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a sales order","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/kanban":{"get":{"summary":"Read sales orders arranged as a board","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/pivot":{"get":{"summary":"Summarise sales orders as a pivot table","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/export.csv":{"get":{"summary":"Download sales orders as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}":{"get":{"summary":"Read one sales order in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/revise":{"post":{"summary":"Replace a sales order with a numbered revision","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/dependencies":{"get":{"summary":"List what would break if a sales order were deleted","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/status":{"post":{"summary":"Change the status of a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/duplicate":{"post":{"summary":"Copy a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/print":{"get":{"summary":"Print a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/pdf":{"get":{"summary":"Download a sales order as a PDF","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/bulk/pdf":{"post":{"summary":"Download a sales order as a PDF","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/share":{"post":{"summary":"Share a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/send-draft":{"get":{"summary":"List the send draft for a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/email-check":{"get":{"summary":"List the email check for a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/email":{"post":{"summary":"Send an email about a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/send/ai":{"post":{"summary":"Add to the ai of a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/cancel-items":{"post":{"summary":"Add to the cancel items of a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/reopen-items":{"post":{"summary":"Add to the reopen items of a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/purchase-order":{"post":{"summary":"Add to the purchase order of a sales order","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/orders/{id}/convert":{"post":{"summary":"Convert a sales order into the next document","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/comments":{"get":{"summary":"List the comments for a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/import/fields":{"get":{"summary":"List the fields for a proforma invoice","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/import":{"post":{"summary":"Import proforma invoices from a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/bulk/delete":{"post":{"summary":"Delete several proforma invoices at once","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas":{"get":{"summary":"List proforma invoices, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a proforma invoice","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/kanban":{"get":{"summary":"Read proforma invoices arranged as a board","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/pivot":{"get":{"summary":"Summarise proforma invoices as a pivot table","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/export.csv":{"get":{"summary":"Download proforma invoices as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}":{"get":{"summary":"Read one proforma invoice in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/revise":{"post":{"summary":"Replace a proforma invoice with a numbered revision","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/dependencies":{"get":{"summary":"List what would break if a proforma invoice were deleted","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/status":{"post":{"summary":"Change the status of a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/duplicate":{"post":{"summary":"Copy a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/print":{"get":{"summary":"Print a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/pdf":{"get":{"summary":"Download a proforma invoice as a PDF","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/bulk/pdf":{"post":{"summary":"Download a proforma invoice as a PDF","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/share":{"post":{"summary":"Share a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/send-draft":{"get":{"summary":"List the send draft for a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/email-check":{"get":{"summary":"List the email check for a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/email":{"post":{"summary":"Send an email about a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/send/ai":{"post":{"summary":"Add to the ai of a proforma invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proformas/{id}/convert":{"post":{"summary":"Convert a proforma invoice into the next document","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/comments":{"get":{"summary":"List the comments for an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/import/fields":{"get":{"summary":"List the fields for an invoice","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/import":{"post":{"summary":"Import invoices from a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/bulk/delete":{"post":{"summary":"Delete several invoices at once","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices":{"get":{"summary":"List invoices, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an invoice","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/kanban":{"get":{"summary":"Read invoices arranged as a board","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/pivot":{"get":{"summary":"Summarise invoices as a pivot table","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/export.csv":{"get":{"summary":"Download invoices as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}":{"get":{"summary":"Read one invoice in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/revise":{"post":{"summary":"Replace an invoice with a numbered revision","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/dependencies":{"get":{"summary":"List what would break if an invoice were deleted","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/status":{"post":{"summary":"Change the status of an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/duplicate":{"post":{"summary":"Copy an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/print":{"get":{"summary":"Print an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/pdf":{"get":{"summary":"Download an invoice as a PDF","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/bulk/pdf":{"post":{"summary":"Download an invoice as a PDF","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/share":{"post":{"summary":"Share an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/send-draft":{"get":{"summary":"List the send draft for an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/email-check":{"get":{"summary":"List the email check for an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/email":{"post":{"summary":"Send an email about an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/send/ai":{"post":{"summary":"Add to the ai of an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/debit-note":{"post":{"summary":"Add to the debit note of an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/write-off":{"post":{"summary":"Add to the write off of an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/cancel-write-off":{"post":{"summary":"Add to the cancel write off of an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/credit-room":{"get":{"summary":"How much of an invoice may still be credited","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/invoices/{id}/credit-note":{"post":{"summary":"Raise a credit note against an invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/comments":{"get":{"summary":"List the comments for a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/import/fields":{"get":{"summary":"List the fields for a bill of supply","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/import":{"post":{"summary":"Import bills of supply from a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/bulk/delete":{"post":{"summary":"Delete several bills of supply at once","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply":{"get":{"summary":"List bills of supply, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a bill of supply","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/kanban":{"get":{"summary":"Read bills of supply arranged as a board","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/pivot":{"get":{"summary":"Summarise bills of supply as a pivot table","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/export.csv":{"get":{"summary":"Download bills of supply as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}":{"get":{"summary":"Read one bill of supply in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/revise":{"post":{"summary":"Replace a bill of supply with a numbered revision","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/dependencies":{"get":{"summary":"List what would break if a bill of supply were deleted","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/status":{"post":{"summary":"Change the status of a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/duplicate":{"post":{"summary":"Copy a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/print":{"get":{"summary":"Print a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/pdf":{"get":{"summary":"Download a bill of supply as a PDF","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/bulk/pdf":{"post":{"summary":"Download a bill of supply as a PDF","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/share":{"post":{"summary":"Share a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/send-draft":{"get":{"summary":"List the send draft for a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/email-check":{"get":{"summary":"List the email check for a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/email":{"post":{"summary":"Send an email about a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/send/ai":{"post":{"summary":"Add to the ai of a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/debit-note":{"post":{"summary":"Add to the debit note of a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/write-off":{"post":{"summary":"Add to the write off of a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/cancel-write-off":{"post":{"summary":"Add to the cancel write off of a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/credit-room":{"get":{"summary":"How much of a bill of supply may still be credited","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/bills-of-supply/{id}/credit-note":{"post":{"summary":"Raise a credit note against a bill of supply","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/comments":{"get":{"summary":"List the comments for a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/import/fields":{"get":{"summary":"List the fields for a retainer invoice","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/import":{"post":{"summary":"Import retainer invoices from a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/bulk/delete":{"post":{"summary":"Delete several retainer invoices at once","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers":{"get":{"summary":"List retainer invoices, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a retainer invoice","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/kanban":{"get":{"summary":"Read retainer invoices arranged as a board","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/pivot":{"get":{"summary":"Summarise retainer invoices as a pivot table","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/export.csv":{"get":{"summary":"Download retainer invoices as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}":{"get":{"summary":"Read one retainer invoice in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/revise":{"post":{"summary":"Replace a retainer invoice with a numbered revision","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/dependencies":{"get":{"summary":"List what would break if a retainer invoice were deleted","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/status":{"post":{"summary":"Change the status of a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/duplicate":{"post":{"summary":"Copy a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/print":{"get":{"summary":"Print a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/pdf":{"get":{"summary":"Download a retainer invoice as a PDF","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/bulk/pdf":{"post":{"summary":"Download a retainer invoice as a PDF","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/share":{"post":{"summary":"Share a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/send-draft":{"get":{"summary":"List the send draft for a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/email-check":{"get":{"summary":"List the email check for a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/email":{"post":{"summary":"Send an email about a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/retainers/{id}/send/ai":{"post":{"summary":"Add to the ai of a retainer invoice","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/comments":{"get":{"summary":"List the comments for a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/import/fields":{"get":{"summary":"List the fields for a credit note","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/import":{"post":{"summary":"Import credit notes from a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/bulk/delete":{"post":{"summary":"Delete several credit notes at once","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes":{"get":{"summary":"List credit notes, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a credit note","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/kanban":{"get":{"summary":"Read credit notes arranged as a board","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/pivot":{"get":{"summary":"Summarise credit notes as a pivot table","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/export.csv":{"get":{"summary":"Download credit notes as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}":{"get":{"summary":"Read one credit note in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/revise":{"post":{"summary":"Replace a credit note with a numbered revision","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/dependencies":{"get":{"summary":"List what would break if a credit note were deleted","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/status":{"post":{"summary":"Change the status of a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/duplicate":{"post":{"summary":"Copy a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/print":{"get":{"summary":"Print a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/pdf":{"get":{"summary":"Download a credit note as a PDF","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/bulk/pdf":{"post":{"summary":"Download a credit note as a PDF","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/share":{"post":{"summary":"Share a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/send-draft":{"get":{"summary":"List the send draft for a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/email-check":{"get":{"summary":"List the email check for a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/email":{"post":{"summary":"Send an email about a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/send/ai":{"post":{"summary":"Add to the ai of a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/credit":{"get":{"summary":"List the credit for a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/apply":{"post":{"summary":"Add to the apply of a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/apply/{applicationId}":{"delete":{"summary":"Remove from the apply of a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/refund":{"post":{"summary":"Add to the refund of a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/credit-notes/{id}/refunds/{paymentId}":{"delete":{"summary":"Remove from the refunds of a credit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"paymentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/comments":{"get":{"summary":"List the comments for a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/import/fields":{"get":{"summary":"List the fields for a debit note","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/import":{"post":{"summary":"Import debit notes from a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/bulk/delete":{"post":{"summary":"Delete several debit notes at once","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes":{"get":{"summary":"List debit notes, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a debit note","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/kanban":{"get":{"summary":"Read debit notes arranged as a board","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/pivot":{"get":{"summary":"Summarise debit notes as a pivot table","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/export.csv":{"get":{"summary":"Download debit notes as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}":{"get":{"summary":"Read one debit note in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/revise":{"post":{"summary":"Replace a debit note with a numbered revision","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/dependencies":{"get":{"summary":"List what would break if a debit note were deleted","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/status":{"post":{"summary":"Change the status of a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/duplicate":{"post":{"summary":"Copy a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/print":{"get":{"summary":"Print a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/pdf":{"get":{"summary":"Download a debit note as a PDF","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/bulk/pdf":{"post":{"summary":"Download a debit note as a PDF","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/share":{"post":{"summary":"Share a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/send-draft":{"get":{"summary":"List the send draft for a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/email-check":{"get":{"summary":"List the email check for a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/email":{"post":{"summary":"Send an email about a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/debit-notes/{id}/send/ai":{"post":{"summary":"Add to the ai of a debit note","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/comments":{"get":{"summary":"List the comments for a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/import/fields":{"get":{"summary":"List the fields for a delivery challan","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/import":{"post":{"summary":"Import delivery challans from a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/bulk/delete":{"post":{"summary":"Delete several delivery challans at once","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans":{"get":{"summary":"List delivery challans, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a delivery challan","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/kanban":{"get":{"summary":"Read delivery challans arranged as a board","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/pivot":{"get":{"summary":"Summarise delivery challans as a pivot table","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/export.csv":{"get":{"summary":"Download delivery challans as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}":{"get":{"summary":"Read one delivery challan in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/revise":{"post":{"summary":"Replace a delivery challan with a numbered revision","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/dependencies":{"get":{"summary":"List what would break if a delivery challan were deleted","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/status":{"post":{"summary":"Change the status of a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/duplicate":{"post":{"summary":"Copy a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/print":{"get":{"summary":"Print a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/pdf":{"get":{"summary":"Download a delivery challan as a PDF","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/bulk/pdf":{"post":{"summary":"Download a delivery challan as a PDF","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/share":{"post":{"summary":"Share a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/send-draft":{"get":{"summary":"List the send draft for a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/email-check":{"get":{"summary":"List the email check for a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/email":{"post":{"summary":"Send an email about a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/challans/{id}/send/ai":{"post":{"summary":"Add to the ai of a delivery challan","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/recurring":{"get":{"summary":"List recurring","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a recurring","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/recurring/{id}":{"get":{"summary":"Read one recurring","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a recurring","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a recurring","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/recurring/{id}/{action}":{"post":{"summary":"Act on a recurring","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"action","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/recurring/{id}/run":{"post":{"summary":"Create a run","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposal-templates":{"get":{"summary":"List proposal templates","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a proposal template","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposal-templates/{id}":{"get":{"summary":"Read one proposal template","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a proposal template","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a proposal template","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposal-templates/{id}/default":{"post":{"summary":"Create a default","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposal-templates/preview":{"post":{"summary":"Create a preview","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposal-templates/preview/{hash}/{n}":{"get":{"summary":"Read one preview","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"hash","required":true},{"schema":{"type":"string"},"in":"path","name":"n","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/content":{"get":{"summary":"List the content for a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change the content of a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/editing":{"post":{"summary":"Add to the editing of a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove from the editing of a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/opens":{"get":{"summary":"List the opens for a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/pages":{"get":{"summary":"List the pages for a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/pages/{n}":{"get":{"summary":"List the pages for a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"n","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/save-as-template":{"post":{"summary":"Add to the save as template of a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/signatures":{"get":{"summary":"List signatures","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a signature","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/signatures/mine":{"put":{"summary":"Change a mine","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a mine","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/signatures/{id}":{"patch":{"summary":"Change a signature","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a signature","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/versions":{"get":{"summary":"List the versions of a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/versions/{vid}":{"get":{"summary":"List the versions of a proposal","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"vid","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/versions/{vid}/restore":{"post":{"summary":"Restore a proposal from the trash","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"vid","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/proposals/{id}/convert":{"post":{"summary":"Convert a proposal into the next document","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/payments":{"get":{"summary":"List payments received, filtered, sorted and paged","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a payment received","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/payments/{id}":{"get":{"summary":"Read one payment received in full","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a payment received","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a payment received","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/payments/bulk/update":{"post":{"summary":"Add to the update of a payment received","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/payments/{id}/status":{"post":{"summary":"Change the status of a payment received","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/payments/{id}/refund":{"post":{"summary":"Add to the refund of a payment received","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/payments/unapplied":{"get":{"summary":"List the unapplied for a payment received","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/payments/{id}/allocate":{"post":{"summary":"Add to the allocate of a payment received","tags":["Sales documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/payments/export.csv":{"get":{"summary":"Download payments received as a CSV file","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/sales/summary":{"get":{"summary":"Read a summary for sales documents","tags":["Sales documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/summary":{"get":{"summary":"Read a summary for procurement","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/comments":{"get":{"summary":"List comments","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a comment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/comments/{commentId}":{"delete":{"summary":"Delete a comment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/kanban":{"get":{"summary":"List kanban","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/pivot":{"get":{"summary":"List pivot","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/import":{"post":{"summary":"Create an import","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/export.csv":{"get":{"summary":"List export.csv","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/bulk/delete":{"post":{"summary":"Create a delete","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors":{"get":{"summary":"List vendors","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a vendor","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/compliance-expiring":{"get":{"summary":"List compliance expiring","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}":{"get":{"summary":"Read one vendor","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a vendor","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a vendor","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/status":{"post":{"summary":"Create a statu","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/approve":{"post":{"summary":"Create an approve","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/block":{"post":{"summary":"Create a block","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/compliance":{"get":{"summary":"List compliance","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a compliance","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/compliance/{docId}":{"patch":{"summary":"Change a compliance","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"docId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a compliance","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"docId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/contacts":{"get":{"summary":"List contacts","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a contact","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/contacts/{contactId}":{"patch":{"summary":"Change a contact","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"contactId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a contact","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"contactId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/sync-services":{"post":{"summary":"Create a sync service","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/vendors/{id}/related/{module}":{"get":{"summary":"Read one related","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/kanban":{"get":{"summary":"List kanban","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/pivot":{"get":{"summary":"List pivot","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/export.csv":{"get":{"summary":"List export.csv","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/bulk/delete":{"post":{"summary":"Create a delete","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders":{"get":{"summary":"List orders","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an order","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}":{"get":{"summary":"Read one order","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an order","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an order","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/status":{"post":{"summary":"Create a statu","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/duplicate":{"post":{"summary":"Create a duplicate","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/comments":{"get":{"summary":"List comments","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a comment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/comments/{commentId}":{"delete":{"summary":"Delete a comment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/print":{"get":{"summary":"List print","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/pdf":{"get":{"summary":"List pdf","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/bulk/pdf":{"post":{"summary":"Create a pdf","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/send-draft":{"get":{"summary":"List send draft","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/email-check":{"get":{"summary":"List email check","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/email":{"post":{"summary":"Create an email","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/send/ai":{"post":{"summary":"Create an ai","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/kanban":{"get":{"summary":"List kanban","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/pivot":{"get":{"summary":"List pivot","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/export.csv":{"get":{"summary":"List export.csv","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/bulk/delete":{"post":{"summary":"Create a delete","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills":{"get":{"summary":"List bills","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a bill","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}":{"get":{"summary":"Read one bill","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a bill","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a bill","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/bulk/update":{"post":{"summary":"Create an update","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/status":{"post":{"summary":"Create a statu","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/duplicate":{"post":{"summary":"Create a duplicate","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/comments":{"get":{"summary":"List comments","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a comment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/comments/{commentId}":{"delete":{"summary":"Delete a comment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/print":{"get":{"summary":"List print","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/pdf":{"get":{"summary":"List pdf","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/bulk/pdf":{"post":{"summary":"Create a pdf","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/send-draft":{"get":{"summary":"List send draft","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/email-check":{"get":{"summary":"List email check","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/email":{"post":{"summary":"Create an email","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/send/ai":{"post":{"summary":"Create an ai","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/kanban":{"get":{"summary":"List kanban","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/pivot":{"get":{"summary":"List pivot","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/export.csv":{"get":{"summary":"List export.csv","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/bulk/delete":{"post":{"summary":"Create a delete","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes":{"get":{"summary":"List debit notes","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a debit note","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}":{"get":{"summary":"Read one debit note","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a debit note","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a debit note","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/status":{"post":{"summary":"Create a statu","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/duplicate":{"post":{"summary":"Create a duplicate","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/comments":{"get":{"summary":"List comments","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a comment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/comments/{commentId}":{"delete":{"summary":"Delete a comment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/print":{"get":{"summary":"List print","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/pdf":{"get":{"summary":"List pdf","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/bulk/pdf":{"post":{"summary":"Create a pdf","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/send-draft":{"get":{"summary":"List send draft","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/email-check":{"get":{"summary":"List email check","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/email":{"post":{"summary":"Create an email","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/send/ai":{"post":{"summary":"Create an ai","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/debit-room":{"get":{"summary":"List debit room","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/bills/{id}/debit-note":{"post":{"summary":"Create a debit note","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/bills":{"get":{"summary":"List bills","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/credit":{"get":{"summary":"List credit","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/apply":{"post":{"summary":"Create an apply","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/apply/{applicationId}":{"delete":{"summary":"Delete an apply","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"applicationId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/refund":{"post":{"summary":"Create a refund","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/debit-notes/{id}/refunds/{paymentId}":{"delete":{"summary":"Delete a refund","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"paymentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/convert":{"post":{"summary":"Create a convert","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/receive":{"post":{"summary":"Create a receive","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/cancel-items":{"post":{"summary":"Create a cancel item","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/orders/{id}/reopen-items":{"post":{"summary":"Create a reopen item","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/payments":{"get":{"summary":"List payments","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a payment","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/payments/outstanding":{"get":{"summary":"List outstanding","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/payments/{id}":{"get":{"summary":"Read one payment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a payment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a payment","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/payments/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/payments/{id}/allocate":{"post":{"summary":"Create an allocate","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/payments/{id}/status":{"post":{"summary":"Create a statu","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/payments/bulk/update":{"post":{"summary":"Create an update","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/recurring":{"get":{"summary":"List recurring","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a recurring","tags":["Procurement"],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/recurring/{id}":{"get":{"summary":"Read one recurring","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a recurring","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a recurring","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/recurring/{id}/{action}":{"post":{"summary":"Act on a recurring","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"action","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/purchase/recurring/{id}/run":{"post":{"summary":"Create a run","tags":["Procurement"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/reports/valuation":{"get":{"summary":"Run the valuation report","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/reports/ageing":{"get":{"summary":"Run the ageing report","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/reports/movement-summary":{"get":{"summary":"Run the movement summary report","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/reports/reorder":{"get":{"summary":"Run the reorder report","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/reports/expiry":{"get":{"summary":"Run the expiry report","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/reports/vendor-supply":{"get":{"summary":"Run the vendor supply report","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/dashboard":{"get":{"summary":"Read the inventory dashboard","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/adjustments/export.csv":{"get":{"summary":"List export.csv","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/transfers/export.csv":{"get":{"summary":"List export.csv","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/receipts/export.csv":{"get":{"summary":"List export.csv","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/shipments/export.csv":{"get":{"summary":"List export.csv","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/movements/export.csv":{"get":{"summary":"List export.csv","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/warehouses/export.csv":{"get":{"summary":"List export.csv","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/categories/export.csv":{"get":{"summary":"List export.csv","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/box-types/export.csv":{"get":{"summary":"Download packages as a CSV file","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/price-lists/export.csv":{"get":{"summary":"Download price lists as a CSV file","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/movements":{"get":{"summary":"List movements","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/balances":{"get":{"summary":"List balances","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/stock":{"get":{"summary":"List stock","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/adjustments/{id}/comments":{"get":{"summary":"List comments","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a comment","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/adjustments/{id}/comments/{commentId}":{"delete":{"summary":"Delete a comment","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/adjustments":{"get":{"summary":"List adjustments","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an adjustment","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/adjustments/{id}":{"get":{"summary":"Read one adjustment","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an adjustment","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/adjustments/{id}/post":{"post":{"summary":"Create a post","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/cycle-count":{"get":{"summary":"List cycle count","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/transfers/{id}/comments":{"get":{"summary":"List comments","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a comment","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/transfers/{id}/comments/{commentId}":{"delete":{"summary":"Delete a comment","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/transfers":{"get":{"summary":"List transfers","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a transfer","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/transfers/{id}":{"get":{"summary":"Read one transfer","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a transfer","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/transfers/{id}/dispatch":{"post":{"summary":"Create a dispatch","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/transfers/{id}/receive":{"post":{"summary":"Create a receive","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/transfers/{id}/close-short":{"post":{"summary":"Create a close short","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/transfers/{id}/signature":{"post":{"summary":"Create a signature","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/batches":{"get":{"summary":"List batches","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/serials":{"get":{"summary":"List serials","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/scan":{"get":{"summary":"List scan","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/warehouses":{"get":{"summary":"List warehouses","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a warehouse","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/warehouses/{id}":{"get":{"summary":"Read one warehouse","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a warehouse","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a warehouse","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/warehouses/{id}/zones":{"post":{"summary":"Create a zone","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/zones/{id}":{"delete":{"summary":"Delete a zone","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/warehouses/{id}/bins":{"get":{"summary":"List bins","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a bin","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/bins/{id}":{"patch":{"summary":"Change a bin","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a bin","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/warehouses/{id}/bins/bulk":{"post":{"summary":"Create a bulk","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/receipts":{"get":{"summary":"List receipts","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a receipt","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/receipts/{id}":{"get":{"summary":"Read one receipt","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a receipt","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/receipts/{id}/post":{"post":{"summary":"Create a post","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/receipts/{id}/correct":{"post":{"summary":"Create a correct","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/fulfilment/availability/{documentId}":{"get":{"summary":"Read one availability","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"documentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/fulfilment/reserve/{documentId}":{"post":{"summary":"Act on a reserve","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"documentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/fulfilment/picklist/{documentId}":{"get":{"summary":"Read one picklist","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"documentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/fulfilment/ship/{documentId}":{"post":{"summary":"Act on a ship","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"documentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/shipments":{"get":{"summary":"List shipments","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/shipments/{id}":{"get":{"summary":"Read one shipment","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/shipments/{id}/delivered":{"post":{"summary":"Create a delivered","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/plan/{itemId}":{"get":{"summary":"List the plan for an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"itemId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/new":{"post":{"summary":"Add to the new of an assembly","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/detail":{"get":{"summary":"List the detail for an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/lines":{"put":{"summary":"Change the lines of an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/confirm":{"post":{"summary":"Add to the confirm of an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/assemble":{"post":{"summary":"Add to the assemble of an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/cancel":{"post":{"summary":"Cancel an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/comments":{"get":{"summary":"List the comments for an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies":{"get":{"summary":"List assemblies, filtered, sorted and paged","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an assembly","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["draft","confirmed","assembled","cancelled"]},"warehouseId":{"type":"string","format":"uuid","nullable":true},"assemblyDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}}},"/api/inventory/assemblies/export.csv":{"get":{"summary":"Download assemblies as a CSV file","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/kanban":{"get":{"summary":"Read assemblies arranged as a board","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/pivot":{"get":{"summary":"Summarise assemblies as a pivot table","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/bulk":{"post":{"summary":"Change several assemblies at once","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/bulk/delete":{"post":{"summary":"Delete several assemblies at once","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/bulk/assign":{"post":{"summary":"Assign several assemblies to somebody at once","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/import":{"post":{"summary":"Import assemblies from a CSV file","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}":{"get":{"summary":"Read one assembly in full","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["draft","confirmed","assembled","cancelled"]},"warehouseId":{"type":"string","format":"uuid","nullable":true},"assemblyDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/similar":{"get":{"summary":"Find assemblies that look like duplicates of this one","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/dependencies":{"get":{"summary":"List what would break if an assembly were deleted","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/assignees":{"post":{"summary":"Put somebody on an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/timeline":{"get":{"summary":"Read everything that has happened to an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/notes":{"post":{"summary":"Add a note to an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/email-check":{"get":{"summary":"List the email check for an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/email":{"post":{"summary":"Send an email about an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/related":{"get":{"summary":"List the related for an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/assemblies/{id}/related/{module}":{"get":{"summary":"List the related for an assembly","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/composite/{id}":{"get":{"summary":"Read one composite","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/comments":{"get":{"summary":"List the comments for a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages":{"get":{"summary":"List packages, filtered, sorted and paged","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a package","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"packageDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"warehouseId":{"type":"string","format":"uuid","nullable":true},"boxName":{"type":"string","maxLength":120,"nullable":true},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}}},"/api/inventory/packages/export.csv":{"get":{"summary":"Download packages as a CSV file","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/kanban":{"get":{"summary":"Read packages arranged as a board","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/pivot":{"get":{"summary":"Summarise packages as a pivot table","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/bulk":{"post":{"summary":"Change several packages at once","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/bulk/delete":{"post":{"summary":"Delete several packages at once","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/bulk/assign":{"post":{"summary":"Assign several packages to somebody at once","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/import":{"post":{"summary":"Import packages from a CSV file","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}":{"get":{"summary":"Read one package in full","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"packageDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"warehouseId":{"type":"string","format":"uuid","nullable":true},"boxName":{"type":"string","maxLength":120,"nullable":true},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/similar":{"get":{"summary":"Find packages that look like duplicates of this one","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/dependencies":{"get":{"summary":"List what would break if a package were deleted","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/assignees":{"post":{"summary":"Put somebody on a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/timeline":{"get":{"summary":"Read everything that has happened to a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/notes":{"post":{"summary":"Add a note to a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/email-check":{"get":{"summary":"List the email check for a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/email":{"post":{"summary":"Send an email about a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/related":{"get":{"summary":"List the related for a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/related/{module}":{"get":{"summary":"List the related for a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/orders":{"get":{"summary":"List the orders for a package","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/pending/{documentId}":{"get":{"summary":"List the pending for a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"documentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/box-types":{"get":{"summary":"List the box types for a package","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the box types of a package","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/box-types/{id}":{"patch":{"summary":"Change the box types of a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove from the box types of a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/geometry":{"post":{"summary":"Add to the geometry of a package","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/new":{"post":{"summary":"Add to the new of a package","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/from-geometry":{"post":{"summary":"Add to the from geometry of a package","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/detail":{"get":{"summary":"List the detail for a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/lines":{"post":{"summary":"Add to the lines of a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/delivered":{"post":{"summary":"Add to the delivered of a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/{id}/unpack":{"post":{"summary":"Add to the unpack of a package","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/packages/report/history":{"get":{"summary":"Read the history of a package","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/comments":{"get":{"summary":"List the comments for a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms":{"get":{"summary":"List bills of materials, filtered, sorted and paged","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a bill of materials","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","maxLength":500,"nullable":true},"isActive":{"type":"boolean"},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}}},"/api/inventory/boms/export.csv":{"get":{"summary":"Download bills of materials as a CSV file","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/kanban":{"get":{"summary":"Read bills of materials arranged as a board","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/pivot":{"get":{"summary":"Summarise bills of materials as a pivot table","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/bulk":{"post":{"summary":"Change several bills of materials at once","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/bulk/delete":{"post":{"summary":"Delete several bills of materials at once","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/bulk/assign":{"post":{"summary":"Assign several bills of materials to somebody at once","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/import":{"post":{"summary":"Import bills of materials from a CSV file","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}":{"get":{"summary":"Read one bill of materials in full","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","maxLength":500,"nullable":true},"isActive":{"type":"boolean"},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/similar":{"get":{"summary":"Find bills of materials that look like duplicates of this one","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/dependencies":{"get":{"summary":"List what would break if a bill of materials were deleted","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/assignees":{"post":{"summary":"Put somebody on a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/timeline":{"get":{"summary":"Read everything that has happened to a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/notes":{"post":{"summary":"Add a note to a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/email-check":{"get":{"summary":"List the email check for a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/email":{"post":{"summary":"Send an email about a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/related":{"get":{"summary":"List the related for a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/related/{module}":{"get":{"summary":"List the related for a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/for-item/{itemId}":{"get":{"summary":"List the for item for a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"itemId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/new":{"post":{"summary":"Add to the new of a bill of materials","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/detail":{"get":{"summary":"List the detail for a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/lines":{"post":{"summary":"Add to the lines of a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/clone":{"post":{"summary":"Add to the clone of a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/boms/{id}/active":{"post":{"summary":"Add to the active of a bill of materials","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/price-lists":{"get":{"summary":"List price lists, filtered, sorted and paged","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a price list","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/price-lists/rate":{"get":{"summary":"List the rate for a price list","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/price-lists/{id}":{"get":{"summary":"Read one price list in full","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a price list","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a price list","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/price-lists/{id}/entries":{"put":{"summary":"Change the entries of a price list","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/price-lists/{id}/entries.csv":{"get":{"summary":"List the entries.csv for a price list","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/price-lists":{"get":{"summary":"List price lists","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/channel-push":{"get":{"summary":"List channel push","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/channel-items":{"get":{"summary":"List channel items","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/channel/confirm":{"post":{"summary":"Create a confirm","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/channel/link":{"post":{"summary":"Create a link","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/channel/unlink":{"post":{"summary":"Create an unlink","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/labels":{"post":{"summary":"Create a label","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/label-options":{"get":{"summary":"List label options","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/serials/{serial}/history":{"get":{"summary":"List history","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/serial-list":{"get":{"summary":"List serial list","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/serials/{serial}/found":{"post":{"summary":"Create a found","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"serial","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/serials.csv":{"get":{"summary":"List serials.csv","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/serials":{"post":{"summary":"Create a serial","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/batches":{"get":{"summary":"List batches","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a batche","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/batches/{batchId}":{"patch":{"summary":"Change a batche","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"batchId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/kanban":{"get":{"summary":"List kanban","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/pivot":{"get":{"summary":"List pivot","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/import":{"post":{"summary":"Create an import","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/export.csv":{"get":{"summary":"List export.csv","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/bulk/delete":{"post":{"summary":"Create a delete","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/comments":{"get":{"summary":"List comments","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a comment","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/comments/{commentId}":{"delete":{"summary":"Delete a comment","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items":{"get":{"summary":"List items","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an item","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/export":{"get":{"summary":"List export","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/categories":{"get":{"summary":"List categories","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a category","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/categories/{id}":{"patch":{"summary":"Change a category","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a category","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/categories/{id}/items":{"get":{"summary":"List items","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/categories/import":{"post":{"summary":"Create an import","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/set-stock":{"post":{"summary":"Create a set stock","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/variants":{"get":{"summary":"List variants","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a variant","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/photos":{"get":{"summary":"List photos","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a photo","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a photo","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/photos/{photoId}":{"patch":{"summary":"Change a photo","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"photoId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a photo","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"photoId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}":{"get":{"summary":"Read one item","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an item","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an item","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/sales-summary":{"get":{"summary":"List sales summary","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/orders":{"get":{"summary":"List orders","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/movements":{"get":{"summary":"List movements","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/opening-stock":{"post":{"summary":"Create an opening stock","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/{id}/rebuild-balances":{"post":{"summary":"Create a rebuild balance","tags":["Inventory"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/items/sync-vendor-services":{"post":{"summary":"Create a sync vendor service","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/inventory/":{"get":{"summary":"List inventory","tags":["Inventory"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/dashboard":{"get":{"summary":"Read the accounting dashboard","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/reports/ageing":{"get":{"summary":"Run the ageing report","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/reports/profit-and-loss":{"get":{"summary":"Run the profit and loss report","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/reports/balance-sheet":{"get":{"summary":"Run the balance sheet report","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/reports/cash-flow":{"get":{"summary":"Run the cash flow report","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/payments":{"get":{"summary":"List payments","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/gst/summary":{"get":{"summary":"Read a summary for accounting","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/gst/gstr1":{"get":{"summary":"List gstr1","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/gst/gstr3b":{"get":{"summary":"List gstr3b","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/gst/returns":{"get":{"summary":"List returns","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a return","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/gst/returns/periods":{"get":{"summary":"List periods","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/gst/returns/{id}":{"get":{"summary":"Read one return","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/tds":{"get":{"summary":"List tds","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a td","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/tds/{id}":{"patch":{"summary":"Change a td","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a td","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/tds/challans":{"get":{"summary":"List challans","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a challan","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/tds/challans/{id}":{"delete":{"summary":"Delete a challan","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/tds/sections":{"get":{"summary":"List sections","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a section","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/tds/sections/{id}":{"delete":{"summary":"Delete a section","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks":{"get":{"summary":"List banks","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a bank","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/{id}":{"get":{"summary":"Read one bank","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a bank","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a bank","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/transfers":{"get":{"summary":"List transfers","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a transfer","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/transfers/{id}":{"delete":{"summary":"Delete a transfer","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/{id}/statement":{"get":{"summary":"List statement","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/{id}/statement/import":{"post":{"summary":"Create an import","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/{id}/statement/batches/{batchId}":{"delete":{"summary":"Delete a batche","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"batchId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/{id}/reconcile":{"get":{"summary":"List reconcile","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/{id}/reconcile/{lineId}/match":{"post":{"summary":"Create a match","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"lineId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/{id}/reconcile/{lineId}/unmatch":{"post":{"summary":"Create an unmatch","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"lineId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/{id}/reconcile/{lineId}/ignore":{"post":{"summary":"Create an ignore","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"lineId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/{id}/reconcile/{lineId}/restore":{"post":{"summary":"Create a restore","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"lineId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/banks/{id}/reconcile/{lineId}/record":{"post":{"summary":"Create a record","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"lineId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/employees/kanban":{"get":{"summary":"List kanban","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/employees/pivot":{"get":{"summary":"List pivot","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/employees/import":{"post":{"summary":"Create an import","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/employees/export.csv":{"get":{"summary":"List export.csv","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/employees/bulk/delete":{"post":{"summary":"Create a delete","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/employees":{"get":{"summary":"List employees","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an employee","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/employees/export":{"get":{"summary":"List export","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/employees/{id}":{"get":{"summary":"Read one employee","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an employee","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an employee","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/payroll":{"get":{"summary":"List payroll","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a payroll","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/payroll/{id}":{"get":{"summary":"Read one payroll","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a payroll","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/payroll/preview":{"post":{"summary":"Create a preview","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/payroll/{id}/pay":{"post":{"summary":"Create a pay","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/payroll/{id}/unpay":{"post":{"summary":"Create an unpay","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses/kanban":{"get":{"summary":"List kanban","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses/pivot":{"get":{"summary":"List pivot","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses/export.csv":{"get":{"summary":"List export.csv","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses/bulk/delete":{"post":{"summary":"Create a delete","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses":{"get":{"summary":"List expenses","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an expense","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses/export":{"get":{"summary":"List export","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses/{id}":{"get":{"summary":"Read one expense","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an expense","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an expense","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses/bulk/update":{"post":{"summary":"Create an update","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses/{id}/payments":{"post":{"summary":"Create a payment","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses/{id}/payments/{paymentId}":{"delete":{"summary":"Delete a payment","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"paymentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/expenses/{id}/approve":{"post":{"summary":"Create an approve","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/categories":{"get":{"summary":"List categories","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a category","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/categories/{id}":{"get":{"summary":"Read one category","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a category","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a category","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/payables":{"get":{"summary":"List payables","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/recurring-expenses":{"get":{"summary":"List recurring expenses","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a recurring expense","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/recurring-expenses/{id}":{"get":{"summary":"Read one recurring expense","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a recurring expense","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a recurring expense","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/recurring-expenses/{id}/{action}":{"post":{"summary":"Act on a recurring expense","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"action","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/recurring-expenses/{id}/run":{"post":{"summary":"Create a run","tags":["Accounting & finance"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/exchange-rate":{"get":{"summary":"List exchange rate","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/finance/":{"get":{"summary":"List finance","tags":["Accounting & finance"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/revaluation":{"get":{"summary":"List revaluation","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/revaluations":{"get":{"summary":"List revaluations","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a revaluation","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/revaluations/{id}":{"delete":{"summary":"Delete a revaluation","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/":{"get":{"summary":"List accountant","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/accounts":{"get":{"summary":"List accounts","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an account","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/accounts/{id}":{"get":{"summary":"Read one account","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an account","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an account","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/accounts/restore-defaults":{"post":{"summary":"Create a restore default","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/journals":{"get":{"summary":"List journals","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a journal","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/journals/{id}":{"get":{"summary":"Read one journal","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a journal","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a journal","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/journals/{id}/post":{"post":{"summary":"Create a post","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/journals/{id}/reverse":{"post":{"summary":"Create a reverse","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/templates":{"get":{"summary":"List templates","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a template","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/templates/{id}":{"patch":{"summary":"Change a template","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a template","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/templates/{id}/use":{"post":{"summary":"Create an use","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/recurring":{"get":{"summary":"List recurring","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a recurring","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/recurring/{id}":{"patch":{"summary":"Change a recurring","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a recurring","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/recurring/{id}/run":{"post":{"summary":"Create a run","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/budgets":{"get":{"summary":"List budgets","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a budget","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/budgets/{id}":{"get":{"summary":"Read one budget","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a budget","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a budget","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/locks":{"get":{"summary":"List locks","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a lock","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/locks/{id}":{"delete":{"summary":"Delete a lock","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/trial-balance":{"get":{"summary":"List trial balance","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/ledger/{id}":{"get":{"summary":"Read one ledger","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/balance-sheet":{"get":{"summary":"List balance sheet","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/assets":{"get":{"summary":"List assets","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an asset","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/assets/{id}":{"get":{"summary":"Read one asset","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an asset","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an asset","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/assets/depreciate":{"post":{"summary":"Create a depreciate","tags":["Accountant"],"responses":{"200":{"description":"Default Response"}}}},"/api/accountant/assets/{id}/dispose":{"post":{"summary":"Create a dispose","tags":["Accountant"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/vendors/":{"get":{"summary":"List vendors","tags":["Vendors"],"responses":{"200":{"description":"Default Response"}}}},"/api/vendors/dashboard":{"get":{"summary":"Read the dashboard dashboard","tags":["Vendors"],"responses":{"200":{"description":"Default Response"}}}},"/api/vendors/orders":{"get":{"summary":"List orders","tags":["Vendors"],"responses":{"200":{"description":"Default Response"}}}},"/api/vendors/master":{"get":{"summary":"List master","tags":["Vendors"],"responses":{"200":{"description":"Default Response"}}}},"/api/vendors/master/{key}":{"put":{"summary":"Change a master","tags":["Vendors"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/vendors/{id}/messages":{"get":{"summary":"List messages","tags":["Vendors"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a message","tags":["Vendors"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/vendors/{id}/history":{"get":{"summary":"List history","tags":["Vendors"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/vendors/{id}/files":{"get":{"summary":"List files","tags":["Vendors"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/vendors/bulk-status":{"post":{"summary":"Create a bulk statu","tags":["Vendors"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/justdial":{"get":{"summary":"List justdial","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a justdial","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/justdial/link":{"post":{"summary":"Create a link","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/justdial/records":{"get":{"summary":"List records","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/justdial/in/{token}":{"get":{"summary":"Read one in","tags":["Integrations"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Act on an in","tags":["Integrations"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/tally":{"get":{"summary":"List tally","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/tally/settings":{"put":{"summary":"Change a setting","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/tally/preview":{"post":{"summary":"Create a preview","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/tally/exports":{"post":{"summary":"Create an export","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}},"get":{"summary":"List exports","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/tally/exports/{id}/{file}":{"get":{"summary":"Read one export","tags":["Integrations"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"file","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/indiamart":{"get":{"summary":"List indiamart","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change an indiamart","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/indiamart/sync":{"post":{"summary":"Create a sync","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/indiamart/records":{"get":{"summary":"List records","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/shopify":{"get":{"summary":"List shopify","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a shopify","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/shopify/test":{"post":{"summary":"Create a test","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/shopify/sync":{"post":{"summary":"Create a sync","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/shopify/records":{"get":{"summary":"List records","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/shopify/fulfil/{shipmentId}":{"post":{"summary":"Act on a fulfil","tags":["Integrations"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"shipmentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/shopify/photos":{"post":{"summary":"Create a photo","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/shopify/webhook":{"post":{"summary":"Create a webhook","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/meetings/":{"get":{"summary":"Your video meeting accounts: which providers are set up, which you connected, and your default","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/meetings/{provider}/connect":{"get":{"summary":"Where to send the browser to sign in with Google, Microsoft or Zoom","tags":["Integrations"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/meetings/{provider}/default":{"post":{"summary":"Make this provider the one Add a video link uses first","tags":["Integrations"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/meetings/{provider}":{"delete":{"summary":"Disconnect a video meeting account","tags":["Integrations"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/integrations/meetings/link":{"post":{"summary":"Make a Google Meet, Microsoft Teams or Zoom link on your own account","tags":["Integrations"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/identity":{"get":{"summary":"List the identity for a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change the identity of a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/identity/preview":{"get":{"summary":"List the preview for a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/summary":{"get":{"summary":"List the summary for a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/":{"get":{"summary":"List projects, filtered, sorted and paged","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/kanban":{"get":{"summary":"Read projects arranged as a board","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/pivot":{"get":{"summary":"Summarise projects as a pivot table","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/import":{"post":{"summary":"Import projects from a CSV file","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/export.csv":{"get":{"summary":"Download projects as a CSV file","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/bulk/delete":{"post":{"summary":"Delete several projects at once","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/{id}":{"get":{"summary":"Read one project in full","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/{id}/notes":{"get":{"summary":"Add a note to a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add a note to a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/{id}/dependencies":{"get":{"summary":"List what would break if a project were deleted","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/{id}/restore":{"post":{"summary":"Restore a project from the trash","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/{id}/members":{"get":{"summary":"List the members for a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change the members of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/member-options":{"get":{"summary":"List the member options for a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/{id}/milestones":{"get":{"summary":"List the milestones for a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the milestones of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/milestones/{id}":{"patch":{"summary":"Change the milestones of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove from the milestones of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/milestones/{id}/complete":{"post":{"summary":"Add to the complete of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/milestones/{id}/dependencies":{"get":{"summary":"List what would break if a project were deleted","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks":{"get":{"summary":"List the tasks for a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the tasks of a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/cards":{"get":{"summary":"List the cards for a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/board":{"get":{"summary":"List the board for a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/timeline":{"get":{"summary":"Read everything that has happened to a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/calendar":{"get":{"summary":"List the calendar for a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/{id}":{"get":{"summary":"List the tasks for a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change the tasks of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove from the tasks of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/{id}/subtasks":{"get":{"summary":"List the subtasks for a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/{id}/status":{"patch":{"summary":"Change the status of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/{id}/dependencies":{"get":{"summary":"List what would break if a project were deleted","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/{id}/history":{"get":{"summary":"Read the history of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/{id}/comments":{"get":{"summary":"List the comments for a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/{id}/attachments":{"get":{"summary":"Attach a file to a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Attach a file to a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/tasks/{id}/attachments/{attachmentId}":{"delete":{"summary":"Remove from the attachments of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"attachmentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/timesheets":{"get":{"summary":"List the timesheets for a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the timesheets of a project","tags":["Projects"],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/timesheets/{id}":{"patch":{"summary":"Change the timesheets of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove from the timesheets of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/timesheets/{id}/approve":{"post":{"summary":"Approve a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/timesheets/{id}/dependencies":{"get":{"summary":"List what would break if a project were deleted","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/{id}/unbilled-time":{"get":{"summary":"List the unbilled time for a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/projects/{id}/invoice-time":{"post":{"summary":"Add to the invoice time of a project","tags":["Projects"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/comments":{"get":{"summary":"List the comments for a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty":{"get":{"summary":"List warranties, filtered, sorted and paged","tags":["Warranty"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a warranty","tags":["Warranty"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["active","claimed","void"]},"itemId":{"type":"string","format":"uuid"},"serialId":{"type":"string","format":"uuid","nullable":true},"serial":{"type":"string","maxLength":120,"nullable":true},"quantity":{"type":"integer","minimum":1},"customerId":{"type":"string","format":"uuid","nullable":true},"sourceDocumentId":{"type":"string","format":"uuid","nullable":true},"invoiceNumber":{"type":"string","maxLength":60,"nullable":true},"invoiceDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"startsOn":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"endsOn":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"termValue":{"type":"integer","minimum":1,"maximum":999},"termUnit":{"type":"string","enum":["day","week","month","year"]},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"required":["itemId","startsOn","termValue","termUnit"],"additionalProperties":false}}}}}},"/api/warranty/export.csv":{"get":{"summary":"Download warranties as a CSV file","tags":["Warranty"],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/kanban":{"get":{"summary":"Read warranties arranged as a board","tags":["Warranty"],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/pivot":{"get":{"summary":"Summarise warranties as a pivot table","tags":["Warranty"],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/bulk":{"post":{"summary":"Change several warranties at once","tags":["Warranty"],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/bulk/delete":{"post":{"summary":"Delete several warranties at once","tags":["Warranty"],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/bulk/assign":{"post":{"summary":"Assign several warranties to somebody at once","tags":["Warranty"],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/import":{"post":{"summary":"Import warranties from a CSV file","tags":["Warranty"],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}":{"get":{"summary":"Read one warranty in full","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["active","claimed","void"]},"itemId":{"type":"string","format":"uuid"},"serialId":{"type":"string","format":"uuid","nullable":true},"serial":{"type":"string","maxLength":120,"nullable":true},"quantity":{"type":"integer","minimum":1},"customerId":{"type":"string","format":"uuid","nullable":true},"sourceDocumentId":{"type":"string","format":"uuid","nullable":true},"invoiceNumber":{"type":"string","maxLength":60,"nullable":true},"invoiceDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"startsOn":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"endsOn":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"termValue":{"type":"integer","minimum":1,"maximum":999},"termUnit":{"type":"string","enum":["day","week","month","year"]},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/similar":{"get":{"summary":"Find warranties that look like duplicates of this one","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/dependencies":{"get":{"summary":"List what would break if a warranty were deleted","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/assignees":{"post":{"summary":"Put somebody on a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/timeline":{"get":{"summary":"Read everything that has happened to a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/notes":{"post":{"summary":"Add a note to a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/email-check":{"get":{"summary":"List the email check for a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/email":{"post":{"summary":"Send an email about a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/related":{"get":{"summary":"List the related for a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/{id}/related/{module}":{"get":{"summary":"List the related for a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/expiring":{"get":{"summary":"List the expiring for a warranty","tags":["Warranty"],"responses":{"200":{"description":"Default Response"}}}},"/api/warranty/for-customer/{id}":{"get":{"summary":"List the for customer for a warranty","tags":["Warranty"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/stores":{"get":{"summary":"List stores","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a store","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/stores/{id}":{"patch":{"summary":"Change a store","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a store","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/terminals":{"get":{"summary":"List terminals, filtered, sorted and paged","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a terminal","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/terminals/{id}/pair":{"post":{"summary":"Add to the pair of a terminal","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/terminals/{id}/unpair":{"post":{"summary":"Add to the unpair of a terminal","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/pair":{"post":{"summary":"Create a pair","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/me":{"get":{"summary":"Read who the current token belongs to","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/menu":{"get":{"summary":"List menu, filtered, sorted and paged","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/shifts":{"post":{"summary":"Create a shift","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}},"get":{"summary":"List shifts, filtered, sorted and paged","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/shifts/{id}/cash":{"post":{"summary":"Add to the cash of a shift","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/shifts/{id}/expected":{"get":{"summary":"List the expected for a shift","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/shifts/{id}/close":{"post":{"summary":"Add to the close of a shift","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders":{"post":{"summary":"Create an order","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}},"get":{"summary":"List orders","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/lines":{"put":{"summary":"Change a line","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/discount":{"post":{"summary":"Create a discount","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/customers":{"get":{"summary":"List customers","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/customer":{"post":{"summary":"Create a customer","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/place":{"post":{"summary":"Create a place","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/waiting":{"get":{"summary":"List waiting","tags":["Point of sale"],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/claim":{"post":{"summary":"Create a claim","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/settle":{"post":{"summary":"Create a settle","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/void":{"post":{"summary":"Create a void","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/abandon":{"post":{"summary":"Create an abandon","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/upi-qr":{"get":{"summary":"List upi qr","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/receipt":{"get":{"summary":"List receipt","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/refund":{"post":{"summary":"Create a refund","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}/refundable":{"get":{"summary":"List refundable","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/orders/{id}":{"patch":{"summary":"Change an order","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"get":{"summary":"Read one order","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/menu/{itemId}":{"put":{"summary":"Change a menu item","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"itemId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/pos/staff/{id}/pin":{"put":{"summary":"Change a pin","tags":["Point of sale"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/sessions":{"post":{"summary":"Add to the sessions of an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/sessions/mine":{"get":{"summary":"List the mine for an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/sessions/{id}/close":{"post":{"summary":"Add to the close of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/cards":{"post":{"summary":"Add to the cards of an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}},"get":{"summary":"List the cards for an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/cards/{id}/media":{"post":{"summary":"Add to the media of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/cards/{id}":{"get":{"summary":"List the cards for an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove from the cards of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change the cards of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/{id}/visits":{"post":{"summary":"Add to the visits of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/{id}/came-back":{"get":{"summary":"List the came back for an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/{id}/report":{"get":{"summary":"List the report for an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/{id}/report.pdf":{"get":{"summary":"List the report.pdf for an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/roi":{"get":{"summary":"List the roi for an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/roi.pdf":{"get":{"summary":"List the roi.pdf for an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/roi/team":{"get":{"summary":"List the team for an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/figures":{"get":{"summary":"List the figures for an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/lookup":{"post":{"summary":"Add to the lookup of an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/search":{"get":{"summary":"List the search for an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/":{"get":{"summary":"List exhibitions, filtered, sorted and paged","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/{id}":{"get":{"summary":"Read one exhibition in full","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/{id}/costs":{"post":{"summary":"Add to the costs of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/costs/{id}":{"patch":{"summary":"Change the costs of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove from the costs of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/stall/unlock":{"post":{"summary":"Add to the unlock of an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/stall/can-unlock":{"get":{"summary":"List the can unlock for an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/scanners":{"get":{"summary":"List the scanners for an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/{id}/review":{"get":{"summary":"List the review for an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/cards/{id}/duplicates":{"get":{"summary":"List the duplicates for an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/cards/{id}/bin":{"post":{"summary":"Add to the bin of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/cards/{id}/merge":{"post":{"summary":"Add to the merge of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/{id}/promote":{"post":{"summary":"Add to the promote of an exhibition","tags":["Events and card scanning"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/events/cards/file":{"post":{"summary":"Add to the file of an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/events/cards/unfiled/count":{"get":{"summary":"List the count for an exhibition","tags":["Events and card scanning"],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/figures":{"get":{"summary":"List the figures for a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/attribution":{"post":{"summary":"Add to the attribution of a channel partner","tags":["Channel partners"],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/comments":{"get":{"summary":"List the comments for a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners":{"get":{"summary":"List channel partners, filtered, sorted and paged","tags":["Channel partners"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a channel partner","tags":["Channel partners"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"firm":{"type":"string","nullable":true},"kind":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"email":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"city":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"gstin":{"type":"string","nullable":true},"pan":{"type":"string","nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"vendorId":{"type":"string","format":"uuid","nullable":true},"attributionMonths":{"type":"integer","minimum":1,"maximum":120,"nullable":true},"commissionRate":{"type":"number","minimum":0,"maximum":100,"nullable":true},"commissionBasis":{"type":"string","enum":["collected","invoiced"],"nullable":true},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"isActive":{"type":"boolean"},"custom":{"type":"object","additionalProperties":{}}},"required":["name"],"additionalProperties":false}}}}}},"/api/partners/export.csv":{"get":{"summary":"Download channel partners as a CSV file","tags":["Channel partners"],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/kanban":{"get":{"summary":"Read channel partners arranged as a board","tags":["Channel partners"],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/pivot":{"get":{"summary":"Summarise channel partners as a pivot table","tags":["Channel partners"],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/bulk":{"post":{"summary":"Change several channel partners at once","tags":["Channel partners"],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/bulk/delete":{"post":{"summary":"Delete several channel partners at once","tags":["Channel partners"],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/bulk/assign":{"post":{"summary":"Assign several channel partners to somebody at once","tags":["Channel partners"],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/import":{"post":{"summary":"Import channel partners from a CSV file","tags":["Channel partners"],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}":{"get":{"summary":"Read one channel partner in full","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1},"firm":{"type":"string","nullable":true},"kind":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"email":{"anyOf":[{"type":"string","enum":[""]},{"type":"string","format":"email"}],"nullable":true},"city":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"gstin":{"type":"string","nullable":true},"pan":{"type":"string","nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"vendorId":{"type":"string","format":"uuid","nullable":true},"attributionMonths":{"type":"integer","minimum":1,"maximum":120,"nullable":true},"commissionRate":{"type":"number","minimum":0,"maximum":100,"nullable":true},"commissionBasis":{"type":"string","enum":["collected","invoiced"],"nullable":true},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"isActive":{"type":"boolean"},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/similar":{"get":{"summary":"Find channel partners that look like duplicates of this one","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/dependencies":{"get":{"summary":"List what would break if a channel partner were deleted","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/assignees":{"post":{"summary":"Put somebody on a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/timeline":{"get":{"summary":"Read everything that has happened to a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/notes":{"post":{"summary":"Add a note to a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/email-check":{"get":{"summary":"List the email check for a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/email":{"post":{"summary":"Send an email about a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/related":{"get":{"summary":"List the related for a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/partners/{id}/related/{module}":{"get":{"summary":"List the related for a channel partner","tags":["Channel partners"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crosssell/setup":{"get":{"summary":"Pipelines, stages, dates, circles and task kinds a cross-sell rule can use","tags":["Cross-sell"],"responses":{"200":{"description":"Default Response"}}}},"/api/crosssell":{"get":{"summary":"Cross-sell rules, what each has done in 30 days, and the deals waiting to open","tags":["Cross-sell"],"responses":{"200":{"description":"Default Response"}}}},"/api/crosssell/rules/{id}":{"get":{"summary":"One cross-sell rule","tags":["Cross-sell"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change or switch a cross-sell rule","tags":["Cross-sell"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a cross-sell rule","tags":["Cross-sell"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crosssell/rules/existing":{"post":{"summary":"How many deals are already where a rule would start","tags":["Cross-sell"],"responses":{"200":{"description":"Default Response"}}}},"/api/crosssell/rules":{"post":{"summary":"Write a cross-sell rule","tags":["Cross-sell"],"responses":{"200":{"description":"Default Response"}}}},"/api/crosssell/runs/{id}/open":{"post":{"summary":"Open a waiting cross-sell deal now","tags":["Cross-sell"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crosssell/runs/{id}/stop":{"post":{"summary":"Stop a waiting cross-sell deal from opening","tags":["Cross-sell"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crosssell/convert/{id}":{"get":{"summary":"The deals converting this lead would open, one per department it asked about","tags":["Cross-sell"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/crosssell/deals/{id}":{"get":{"summary":"What cross-sell has done with one deal, and where it came from","tags":["Cross-sell"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/later":{"get":{"summary":"What Hanu will do for you later: documents to send and reminders, and what happened to the recent ones","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/later/{id}":{"patch":{"summary":"Change when something set for later happens","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/later/{id}/cancel":{"post":{"summary":"Cancel something set for later, or skip one waiting for you","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/later/{id}/retry":{"post":{"summary":"Try again now to send a document that is waiting for you","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/later/{id}/fire":{"post":{"summary":"Hanu's clock: send a document set for now","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/routines":{"get":{"summary":"Your routines: what Hanu does by himself, and when","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Start a routine","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/routines/{id}":{"patch":{"summary":"Change, pause or switch on a routine","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Stop a routine for good; its chat stays","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/routines/{id}/run":{"post":{"summary":"Run a routine now","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/knowledge":{"get":{"summary":"Knowledge folders: what each holds and which agents read it","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Make a knowledge folder","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/knowledge/{id}":{"get":{"summary":"One knowledge folder and its files","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Rename a knowledge folder or change what it is for","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Take a knowledge folder away (agents stop reading it; its files stay until removed)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/knowledge/{id}/files":{"post":{"summary":"Add a file to a knowledge folder (read in the background)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/knowledge/files/{fileId}/read":{"post":{"summary":"Read a knowledge file again","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"fileId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/knowledge/files/{fileId}":{"delete":{"summary":"Remove a file from a knowledge folder (its storage is freed)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"fileId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/knowledge/files/{fileId}/download":{"get":{"summary":"Open a knowledge file","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"fileId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/knowledge/{id}/ask":{"post":{"summary":"Try a question on a knowledge folder: the passages an agent would read","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/playbooks":{"get":{"summary":"Teams and playbooks, with what each step needs","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Make a playbook: its steps, each for Hanu, an agent or a person","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/teams":{"post":{"summary":"Make a team of agents, with its work room","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/teams/{id}":{"patch":{"summary":"Change a team","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Take a team away (its playbooks stay, without a team)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/playbooks/{id}":{"patch":{"summary":"Change a playbook","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Take a playbook away (runs already going finish)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/playbooks/{id}/run":{"post":{"summary":"Run a playbook for a job: a plan in your Hanu chat, a step at a time","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/runs/{planId}/steps/{index}/done":{"post":{"summary":"Mark your step in a playbook done (the plan goes on)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"planId","required":true},{"schema":{"type":"string"},"in":"path","name":"index","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/templates":{"get":{"summary":"Ready-made agents, and what of each you could give","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/agents/make":{"post":{"summary":"Make an agent from a template or a description (in Testing, for you alone; only rights you may give)","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/agents/{id}/export":{"get":{"summary":"An agent as a file: its job, instructions, rights and approvals (never who uses it)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/agents/import":{"post":{"summary":"Make an agent from a file exported from another (in Testing; only rights you may give)","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/agents/{id}/tests":{"get":{"summary":"An agent's tests and how each last went","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add a test: what someone says, and what should happen","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/tests/{testId}":{"delete":{"summary":"Remove a test","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"testId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/tests/{testId}/run":{"post":{"summary":"Run one test as a dry run: nothing is offered or changed (uses AI credits like a question)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"testId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena":{"get":{"summary":"Hanu Sena: the agents, their agent rights, and who may use each","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/agents/{id}":{"get":{"summary":"One agent with its versions","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an agent (a new version; its status stays as it is)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Take an agent away (its chats and versions are kept)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/agents":{"post":{"summary":"Make an agent (it starts in Testing, for its maker alone)","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/agents/{id}/status":{"post":{"summary":"Put an agent in Testing, make it live, or pause it","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/agents/{id}/restore":{"post":{"summary":"Put back an earlier version of an agent (saved as a new version)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/approvals":{"get":{"summary":"What waits for your yes, and what you asked for that still waits","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/rights":{"post":{"summary":"Make agent rights: what agents given them may do","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/sena/rights/{id}":{"patch":{"summary":"Change agent rights (every agent given them follows at once)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Take agent rights away (only when no agent has them)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/live/start":{"post":{"summary":"Start talking with Hanu live: a short-lived pass for this browser, never the key","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/live/tool":{"post":{"summary":"Hanu looks something up during a live conversation, as you","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/live/said":{"post":{"summary":"What was said in a live conversation, kept in the chat","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/live/end":{"post":{"summary":"End a live conversation; its minutes are charged","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/browse/{id}":{"post":{"summary":"A job in Hanu's own browser: take over, hand back, stop, your own clicks and keys while you have it; and the work itself, as you","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/browse/{id}/watch":{"get":{"summary":"Watch a job in Hanu's own browser live: the page as it changes","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/guide":{"get":{"summary":"The setup guide as this person sees it, with the storage gifts","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/guide/hidden":{"post":{"summary":"Hide or show the setup guide card on the overview, for this person","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/me":{"get":{"summary":"Whether this person has Hanu, their chats with him and his assistants, and what he can do for them","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"This person's own Hanu: alerts, the evening report, email notes","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/memory":{"delete":{"summary":"Forget what this person asked Hanu to remember, one fact or all","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/trust/{action}":{"delete":{"summary":"Hanu asks again before this kind of action","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"action","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/threads/{agent}/messages":{"get":{"summary":"A person's chat with Hanu or one of the business's assistants, newest last","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"agent","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Ask Hanu something; he answers as you, with your rights","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"agent","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/threads/{agent}/read":{"post":{"summary":"Mark a Hanu chat read","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"agent","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/threads/{agent}":{"delete":{"summary":"Clear a Hanu chat: what was said before is gone from the chat and from what Hanu reads back","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"agent","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/threads/{agent}/quick":{"post":{"summary":"One of Hanu's quick buttons: look something up straight away, no AI","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"agent","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/chats/{agent}":{"get":{"summary":"This person's chats with Hanu or an assistant, newest first, and the main one where alerts land","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"agent","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Start a new chat with Hanu or an assistant","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"agent","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/chats/{agent}/{id}":{"patch":{"summary":"Rename one of your chats with Hanu, close it, or open it again","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"agent","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete one of your chats with Hanu; what was saved from it stays","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"agent","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/files/{id}":{"get":{"summary":"A picture or PDF you sent to Hanu","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/actions/{id}/do":{"post":{"summary":"Yes: Hanu does what he offered, as you (or as the manager deciding)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/actions/{id}/decline":{"post":{"summary":"No: the asker cancels, or the manager declines","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/plans/{id}":{"post":{"summary":"A plan Hanu is working through for you: Yes to all of a step's changes, One by one, Stop; and the next step, as you","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/actions/{id}/undo":{"post":{"summary":"Undo what Hanu did, within half an hour","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/listen":{"post":{"summary":"What was said to Hanu, written out, where the device cannot do it itself","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/speak":{"post":{"summary":"A reply read in Hanu's natural voice","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/drafts/{id}/answer":{"post":{"summary":"Answer one of Hanu's questions on a draft, from a button","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/drafts/{id}/duplicate":{"post":{"summary":"The record already there: add this one anyway, change that one, or make a deal for that customer; on a list, also leave one out or put it back","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/drafts/{id}/review":{"post":{"summary":"That is all: the whole card, to check and Save","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/drafts/{id}/save":{"post":{"summary":"Save a draft: through the app's own route, as you","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/drafts/{id}/cancel":{"post":{"summary":"Drop a draft; nothing is saved","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/lessons":{"get":{"summary":"What Hanu learned from you (and for the whole business)","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/lessons/{id}":{"delete":{"summary":"Forget something Hanu learned from you","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/team":{"get":{"summary":"The team report for the people below you, as your role may see it","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/emails":{"get":{"summary":"Customer emails in your mailbox waiting for your reply","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/settings":{"get":{"summary":"What the business lets Hanu do","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change what the business lets Hanu do","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/agents":{"get":{"summary":"The assistants the business made, built on Hanu","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Make an assistant","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/agents/{id}":{"patch":{"summary":"Change an assistant","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Switch an assistant off (its chats are kept)","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/setup":{"get":{"summary":"The setup template and the latest plan","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/setup/team":{"post":{"summary":"Read your team from an Excel or CSV file: names, emails and roles from job titles (nothing is made)","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/setup/fill":{"post":{"summary":"Hanu fills the template from what the owner says about the business (nothing is made)","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/setup/plan":{"post":{"summary":"Turn the answers into a plan to check (nothing is made)","tags":["Hanu"],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/setup/{id}/apply":{"post":{"summary":"Make the plan: roles, invitations and the profile, as you","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/hanu/setup/{id}/discard":{"post":{"summary":"Throw a draft plan away","tags":["Hanu"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/voice/me":{"get":{"summary":"Read who the current token belongs to","responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Read who the current token belongs to","responses":{"200":{"description":"Default Response"}}}},"/api/voice/settings":{"put":{"summary":"Change a setting","responses":{"200":{"description":"Default Response"}}}},"/api/voice/listen":{"post":{"summary":"Create a listen","responses":{"200":{"description":"Default Response"}}}},"/api/voice/entries":{"post":{"summary":"Create an entry","responses":{"200":{"description":"Default Response"}}}},"/api/voice/entries/{id}":{"patch":{"summary":"Change an entry","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an entry","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/voice/history/{id}/audio":{"get":{"summary":"List audio","parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/live":{"get":{"summary":"Who is on your websites now, with each visit so far","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/visitors/{id}":{"get":{"summary":"One website visitor and their visits","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Forget a website visitor and everything kept about them","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/setup":{"get":{"summary":"Website Desk settings: your sites, the snippet and the rules","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change Website Desk settings","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/sites/{id}/read":{"post":{"summary":"Have Hanu read a website's pages again now","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/sites":{"post":{"summary":"Add a website to Website Desk","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/sites/{id}":{"patch":{"summary":"Pause or name a website on Website Desk","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Take a website off Website Desk, with its visits","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/chats":{"get":{"summary":"Website chats: waiting, with a person, with Hanu, and closed today","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/chats/{id}":{"get":{"summary":"One website chat, every line","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/chats/{id}/accept":{"post":{"summary":"Take a website chat: from the ring, or over from Hanu","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/chats/{id}/send":{"post":{"summary":"Write to the visitor in a website chat you have","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/chats/{id}/whisper":{"post":{"summary":"A note to Hanu in a website chat: only the team sees it","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/chats/{id}/handback":{"post":{"summary":"Give a website chat back to Hanu","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/chats/{id}/transfer":{"post":{"summary":"Pass a website chat you have to a colleague who answers website chats","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/chats/{id}/close":{"post":{"summary":"End a website chat","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/available":{"put":{"summary":"Say whether you may be rung for website chats","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/chats/{id}/pdf":{"get":{"summary":"A website chat as a PDF","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/for/{type}/{id}":{"get":{"summary":"The website visits and chats behind a lead or customer","tags":["Website Desk"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"type","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/p/config":{"get":{"summary":"What a website's snippet needs: whether to ask before keeping anything, and the words","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/p/collect":{"post":{"summary":"What a visitor did on a business's website, from its snippet","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/p/chat":{"post":{"summary":"A visitor writes in the website chat","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}},"get":{"summary":"What is new in a visitor's website chat","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}}},"/api/desk/p/person":{"post":{"summary":"A visitor asks for a person in the website chat","tags":["Website Desk"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/setup":{"get":{"summary":"Staff, circles, the target measure and what is switched on","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/targets":{"get":{"summary":"Every target for a financial year, for people and circles","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Save targets: one figure per person or circle and month","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/me":{"get":{"summary":"How a salesperson is doing this month against their target, and their commission so far","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/plans":{"get":{"summary":"Commission plans, and who each pays","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Write a commission plan","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/plans/{id}":{"get":{"summary":"One commission plan","tags":["Targets and commission"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a commission plan","tags":["Targets and commission"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a commission plan","tags":["Targets and commission"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/statements":{"get":{"summary":"Commission statements for a month","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/statements/{id}":{"get":{"summary":"One commission statement and how it adds up","tags":["Targets and commission"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/statements/work-out":{"post":{"summary":"Work out every statement for a month","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/statements/{id}/approve":{"post":{"summary":"Approve a commission statement","tags":["Targets and commission"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/statements/{id}/send-back":{"post":{"summary":"Send a commission statement back with a note","tags":["Targets and commission"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/statements/{id}/work-out":{"post":{"summary":"Work one statement out again","tags":["Targets and commission"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/payouts":{"get":{"summary":"Partner terms by kind, and a month's partner payouts","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/partner-terms":{"put":{"summary":"Set what each kind of channel partner earns","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/payouts/work-out":{"post":{"summary":"Work out every partner's payout for a month","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/payouts/bill":{"post":{"summary":"Approve partner payouts and make their draft bills","tags":["Targets and commission"],"responses":{"200":{"description":"Default Response"}}}},"/api/commission/payouts/tds/{id}":{"get":{"summary":"The TDS a partner's bill would take","tags":["Targets and commission"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/status":{"get":{"summary":"List status","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/email/{id}/suggest":{"post":{"summary":"Create a suggest","tags":["AI writing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/compose":{"post":{"summary":"Create a compose","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/proposal":{"post":{"summary":"Create a proposal","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/credits":{"get":{"summary":"List credits","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/credits/buy":{"post":{"summary":"Create a buy","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/credits/shares":{"put":{"summary":"Change a share","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/credits/usage":{"get":{"summary":"List usage","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/own":{"get":{"summary":"List own","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change an own","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/own/models":{"get":{"summary":"List models","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}}},"/api/ai/own/test":{"post":{"summary":"Create a test","tags":["AI writing"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/comments":{"get":{"summary":"List the comments for a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products":{"get":{"summary":"List products, filtered, sorted and paged","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a product","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"code":{"type":"string","maxLength":60,"nullable":true},"description":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"custom":{"type":"object","additionalProperties":{}}},"required":["name"],"additionalProperties":false}}}}}},"/api/subscriptions/products/export.csv":{"get":{"summary":"Download products as a CSV file","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/kanban":{"get":{"summary":"Read products arranged as a board","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/pivot":{"get":{"summary":"Summarise products as a pivot table","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/bulk":{"post":{"summary":"Change several products at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/bulk/delete":{"post":{"summary":"Delete several products at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/bulk/assign":{"post":{"summary":"Assign several products to somebody at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/import":{"post":{"summary":"Import products from a CSV file","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}":{"get":{"summary":"Read one product in full","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"code":{"type":"string","maxLength":60,"nullable":true},"description":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/similar":{"get":{"summary":"Find products that look like duplicates of this one","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/dependencies":{"get":{"summary":"List what would break if a product were deleted","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/assignees":{"post":{"summary":"Put somebody on a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/timeline":{"get":{"summary":"Read everything that has happened to a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/notes":{"post":{"summary":"Add a note to a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/email-check":{"get":{"summary":"List the email check for a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/email":{"post":{"summary":"Send an email about a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/related":{"get":{"summary":"List the related for a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/products/{id}/related/{module}":{"get":{"summary":"List the related for a product","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/comments":{"get":{"summary":"List the comments for a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans":{"get":{"summary":"List plans, filtered, sorted and paged","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a plan","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":60,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$"},"name":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","nullable":true},"productId":{"type":"string","format":"uuid","nullable":true},"itemId":{"type":"string","format":"uuid","nullable":true},"price":{"type":"number","minimum":0,"maximum":99999999},"currency":{"type":"string","minLength":3,"maxLength":3},"interval":{"type":"string","enum":["weekly","fortnightly","monthly","quarterly","half_yearly","yearly","days"]},"everyDays":{"type":"integer","minimum":1,"maximum":3650,"nullable":true},"trialDays":{"type":"integer","minimum":0,"maximum":3650},"setupFee":{"type":"number","minimum":0,"maximum":99999999},"taxRateId":{"type":"string","format":"uuid","nullable":true},"gstRate":{"type":"number","minimum":0,"maximum":100,"nullable":true},"hsnSac":{"type":"string","maxLength":20,"nullable":true},"defaultCycles":{"type":"integer","minimum":1,"maximum":999,"nullable":true},"isActive":{"type":"boolean"},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"required":["code","name","price","interval"],"additionalProperties":false}}}}}},"/api/subscriptions/plans/export.csv":{"get":{"summary":"Download plans as a CSV file","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/kanban":{"get":{"summary":"Read plans arranged as a board","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/pivot":{"get":{"summary":"Summarise plans as a pivot table","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/bulk":{"post":{"summary":"Change several plans at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/bulk/delete":{"post":{"summary":"Delete several plans at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/bulk/assign":{"post":{"summary":"Assign several plans to somebody at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/import":{"post":{"summary":"Import plans from a CSV file","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}":{"get":{"summary":"Read one plan in full","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":60,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$"},"name":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","nullable":true},"productId":{"type":"string","format":"uuid","nullable":true},"itemId":{"type":"string","format":"uuid","nullable":true},"price":{"type":"number","minimum":0,"maximum":99999999},"currency":{"type":"string","minLength":3,"maxLength":3},"interval":{"type":"string","enum":["weekly","fortnightly","monthly","quarterly","half_yearly","yearly","days"]},"everyDays":{"type":"integer","minimum":1,"maximum":3650,"nullable":true},"trialDays":{"type":"integer","minimum":0,"maximum":3650},"setupFee":{"type":"number","minimum":0,"maximum":99999999},"taxRateId":{"type":"string","format":"uuid","nullable":true},"gstRate":{"type":"number","minimum":0,"maximum":100,"nullable":true},"hsnSac":{"type":"string","maxLength":20,"nullable":true},"defaultCycles":{"type":"integer","minimum":1,"maximum":999,"nullable":true},"isActive":{"type":"boolean"},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/similar":{"get":{"summary":"Find plans that look like duplicates of this one","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/dependencies":{"get":{"summary":"List what would break if a plan were deleted","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/assignees":{"post":{"summary":"Put somebody on a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/timeline":{"get":{"summary":"Read everything that has happened to a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/notes":{"post":{"summary":"Add a note to a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/email-check":{"get":{"summary":"List the email check for a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/email":{"post":{"summary":"Send an email about a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/related":{"get":{"summary":"List the related for a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/plans/{id}/related/{module}":{"get":{"summary":"List the related for a plan","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/comments":{"get":{"summary":"List the comments for an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons":{"get":{"summary":"List addons, filtered, sorted and paged","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an addon","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":60,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$"},"name":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","nullable":true},"itemId":{"type":"string","format":"uuid","nullable":true},"price":{"type":"number","minimum":0,"maximum":99999999},"currency":{"type":"string","minLength":3,"maxLength":3},"kind":{"type":"string","enum":["recurring","one_time"]},"pricingModel":{"type":"string","enum":["unit","usage"]},"unitName":{"type":"string","maxLength":40,"nullable":true},"taxRateId":{"type":"string","format":"uuid","nullable":true},"gstRate":{"type":"number","minimum":0,"maximum":100,"nullable":true},"hsnSac":{"type":"string","maxLength":20,"nullable":true},"planCodes":{"type":"array","items":{"type":"string","maxLength":60}},"isActive":{"type":"boolean"},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"required":["code","name","price"],"additionalProperties":false}}}}}},"/api/subscriptions/addons/export.csv":{"get":{"summary":"Download addons as a CSV file","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/kanban":{"get":{"summary":"Read addons arranged as a board","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/pivot":{"get":{"summary":"Summarise addons as a pivot table","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/bulk":{"post":{"summary":"Change several addons at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/bulk/delete":{"post":{"summary":"Delete several addons at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/bulk/assign":{"post":{"summary":"Assign several addons to somebody at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/import":{"post":{"summary":"Import addons from a CSV file","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}":{"get":{"summary":"Read one addon in full","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":60,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$"},"name":{"type":"string","minLength":1,"maxLength":200},"description":{"type":"string","nullable":true},"itemId":{"type":"string","format":"uuid","nullable":true},"price":{"type":"number","minimum":0,"maximum":99999999},"currency":{"type":"string","minLength":3,"maxLength":3},"kind":{"type":"string","enum":["recurring","one_time"]},"pricingModel":{"type":"string","enum":["unit","usage"]},"unitName":{"type":"string","maxLength":40,"nullable":true},"taxRateId":{"type":"string","format":"uuid","nullable":true},"gstRate":{"type":"number","minimum":0,"maximum":100,"nullable":true},"hsnSac":{"type":"string","maxLength":20,"nullable":true},"planCodes":{"type":"array","items":{"type":"string","maxLength":60}},"isActive":{"type":"boolean"},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/similar":{"get":{"summary":"Find addons that look like duplicates of this one","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/dependencies":{"get":{"summary":"List what would break if an addon were deleted","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/assignees":{"post":{"summary":"Put somebody on an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/timeline":{"get":{"summary":"Read everything that has happened to an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/notes":{"post":{"summary":"Add a note to an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/email-check":{"get":{"summary":"List the email check for an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/email":{"post":{"summary":"Send an email about an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/related":{"get":{"summary":"List the related for an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/addons/{id}/related/{module}":{"get":{"summary":"List the related for an addon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/comments":{"get":{"summary":"List the comments for a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons":{"get":{"summary":"List coupons, filtered, sorted and paged","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a coupon","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":60,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$"},"name":{"type":"string","minLength":1,"maxLength":200},"discountType":{"type":"string","enum":["percent","flat"]},"discountValue":{"type":"number","minimum":0,"maximum":99999999},"duration":{"type":"string","enum":["once","forever","cycles"]},"durationCycles":{"type":"integer","minimum":1,"maximum":999,"nullable":true},"maxRedemptions":{"type":"integer","minimum":1,"maximum":9999999,"nullable":true},"startsOn":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"expiresOn":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"planCodes":{"type":"array","items":{"type":"string","maxLength":60}},"addonCodes":{"type":"array","items":{"type":"string","maxLength":60}},"isActive":{"type":"boolean"},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"required":["code","name","discountValue"],"additionalProperties":false}}}}}},"/api/subscriptions/coupons/export.csv":{"get":{"summary":"Download coupons as a CSV file","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/kanban":{"get":{"summary":"Read coupons arranged as a board","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/pivot":{"get":{"summary":"Summarise coupons as a pivot table","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/bulk":{"post":{"summary":"Change several coupons at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/bulk/delete":{"post":{"summary":"Delete several coupons at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/bulk/assign":{"post":{"summary":"Assign several coupons to somebody at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/import":{"post":{"summary":"Import coupons from a CSV file","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}":{"get":{"summary":"Read one coupon in full","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","minLength":1,"maxLength":60,"pattern":"^[A-Za-z0-9][A-Za-z0-9._-]*$"},"name":{"type":"string","minLength":1,"maxLength":200},"discountType":{"type":"string","enum":["percent","flat"]},"discountValue":{"type":"number","minimum":0,"maximum":99999999},"duration":{"type":"string","enum":["once","forever","cycles"]},"durationCycles":{"type":"integer","minimum":1,"maximum":999,"nullable":true},"maxRedemptions":{"type":"integer","minimum":1,"maximum":9999999,"nullable":true},"startsOn":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"expiresOn":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"planCodes":{"type":"array","items":{"type":"string","maxLength":60}},"addonCodes":{"type":"array","items":{"type":"string","maxLength":60}},"isActive":{"type":"boolean"},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/similar":{"get":{"summary":"Find coupons that look like duplicates of this one","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/dependencies":{"get":{"summary":"List what would break if a coupon were deleted","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/assignees":{"post":{"summary":"Put somebody on a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/timeline":{"get":{"summary":"Read everything that has happened to a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/notes":{"post":{"summary":"Add a note to a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/email-check":{"get":{"summary":"List the email check for a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/email":{"post":{"summary":"Send an email about a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/related":{"get":{"summary":"List the related for a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/coupons/{id}/related/{module}":{"get":{"summary":"List the related for a coupon","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/preferences":{"get":{"summary":"List the preferences for a subscription","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change the preferences of a subscription","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/revenue":{"get":{"summary":"List the revenue for a subscription","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/renewals":{"get":{"summary":"List the renewals for a subscription","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/preview":{"post":{"summary":"Add to the preview of a subscription","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/new":{"post":{"summary":"Add to the new of a subscription","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/change":{"post":{"summary":"Add to the change of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/pause":{"post":{"summary":"Add to the pause of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/resume":{"post":{"summary":"Add to the resume of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/schedule":{"delete":{"summary":"Remove from the schedule of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/cancel":{"post":{"summary":"Cancel a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/reactivate":{"post":{"summary":"Add to the reactivate of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/extend":{"post":{"summary":"Add to the extend of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/next-billing":{"post":{"summary":"Add to the next billing of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/charge":{"post":{"summary":"Add to the charge of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/addon":{"post":{"summary":"Add to the addon of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/lines/{lineId}":{"delete":{"summary":"Remove from the lines of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"lineId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/coupon":{"post":{"summary":"Add to the coupon of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/bill-now":{"post":{"summary":"Add to the bill now of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/record-payment":{"post":{"summary":"Add to the record payment of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/changes/{changeId}":{"delete":{"summary":"Remove from the changes of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"changeId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/comments":{"get":{"summary":"List the comments for a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions":{"get":{"summary":"List subscriptions, filtered, sorted and paged","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a subscription","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":200,"nullable":true},"customerId":{"type":"string","format":"uuid"},"contactId":{"type":"string","format":"uuid","nullable":true},"referenceNumber":{"type":"string","maxLength":120,"nullable":true},"salesPersonId":{"type":"string","format":"uuid","nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"paymentMode":{"type":"string","enum":["online","offline"]},"autocharge":{"type":"boolean"},"invoicePreference":{"type":"string","enum":["send","draft"],"nullable":true},"dueDays":{"type":"integer","minimum":0,"maximum":365},"prorate":{"type":"boolean"},"advanceBillingDays":{"type":"integer","minimum":0,"maximum":364,"nullable":true},"creditPausedDays":{"type":"boolean"},"renewalPricing":{"type":"string","enum":["retain","latest","markup","markdown"]},"renewalPercent":{"type":"number","minimum":0,"maximum":100,"nullable":true},"renewalEveryCycles":{"type":"integer","minimum":1,"maximum":99},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string","maxLength":40}},"custom":{"type":"object","additionalProperties":{}},"startsOn":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"interval":{"type":"string","enum":["weekly","fortnightly","monthly","quarterly","half_yearly","yearly","days"]},"maxCycles":{"type":"integer","minimum":1,"maximum":999,"nullable":true}},"required":["customerId"],"additionalProperties":false}}}}}},"/api/subscriptions/export.csv":{"get":{"summary":"Download subscriptions as a CSV file","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/kanban":{"get":{"summary":"Read subscriptions arranged as a board","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/pivot":{"get":{"summary":"Summarise subscriptions as a pivot table","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/bulk":{"post":{"summary":"Change several subscriptions at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/bulk/delete":{"post":{"summary":"Delete several subscriptions at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/bulk/assign":{"post":{"summary":"Assign several subscriptions to somebody at once","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/import":{"post":{"summary":"Import subscriptions from a CSV file","tags":["Subscriptions"],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}":{"get":{"summary":"Read one subscription in full","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","maxLength":200,"nullable":true},"customerId":{"type":"string","format":"uuid"},"contactId":{"type":"string","format":"uuid","nullable":true},"referenceNumber":{"type":"string","maxLength":120,"nullable":true},"salesPersonId":{"type":"string","format":"uuid","nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"paymentMode":{"type":"string","enum":["online","offline"]},"autocharge":{"type":"boolean"},"invoicePreference":{"type":"string","enum":["send","draft"],"nullable":true},"dueDays":{"type":"integer","minimum":0,"maximum":365},"prorate":{"type":"boolean"},"advanceBillingDays":{"type":"integer","minimum":0,"maximum":364,"nullable":true},"creditPausedDays":{"type":"boolean"},"renewalPricing":{"type":"string","enum":["retain","latest","markup","markdown"]},"renewalPercent":{"type":"number","minimum":0,"maximum":100,"nullable":true},"renewalEveryCycles":{"type":"integer","minimum":1,"maximum":99},"notes":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string","maxLength":40}},"custom":{"type":"object","additionalProperties":{}},"startsOn":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}]},"interval":{"type":"string","enum":["weekly","fortnightly","monthly","quarterly","half_yearly","yearly","days"]},"maxCycles":{"type":"integer","minimum":1,"maximum":999,"nullable":true}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/similar":{"get":{"summary":"Find subscriptions that look like duplicates of this one","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/dependencies":{"get":{"summary":"List what would break if a subscription were deleted","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/assignees":{"post":{"summary":"Put somebody on a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/timeline":{"get":{"summary":"Read everything that has happened to a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/notes":{"post":{"summary":"Add a note to a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/email-check":{"get":{"summary":"List the email check for a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/email":{"post":{"summary":"Send an email about a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/related":{"get":{"summary":"List the related for a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/related/{module}":{"get":{"summary":"List the related for a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/{id}/overview":{"get":{"summary":"List the overview for a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/subscriptions/for-customer/{id}":{"get":{"summary":"List the for customer for a subscription","tags":["Subscriptions"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/work-center-types":{"get":{"summary":"List work center types","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a work center type","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/work-center-types/{id}":{"patch":{"summary":"Change a work center type","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a work center type","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/work-centers":{"get":{"summary":"List work centres, filtered, sorted and paged","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a work centre","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/work-centers/{id}":{"patch":{"summary":"Change a work centre","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a work centre","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/operations":{"get":{"summary":"List operations, filtered, sorted and paged","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an operation","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/operations/{id}":{"patch":{"summary":"Change an operation","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an operation","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/comments":{"get":{"summary":"List the comments for a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders":{"get":{"summary":"List manufacturing orders, filtered, sorted and paged","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a manufacturing order","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"startDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}}},"/api/manufacturing/orders/export.csv":{"get":{"summary":"Download manufacturing orders as a CSV file","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/kanban":{"get":{"summary":"Read manufacturing orders arranged as a board","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/pivot":{"get":{"summary":"Summarise manufacturing orders as a pivot table","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/bulk":{"post":{"summary":"Change several manufacturing orders at once","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/bulk/delete":{"post":{"summary":"Delete several manufacturing orders at once","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/bulk/assign":{"post":{"summary":"Assign several manufacturing orders to somebody at once","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/import":{"post":{"summary":"Import manufacturing orders from a CSV file","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}":{"get":{"summary":"Read one manufacturing order in full","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"startDate":{"anyOf":[{"type":"string"},{"type":"string","format":"date-time"}],"nullable":true},"ownerId":{"type":"string","format":"uuid","nullable":true},"notes":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}},"status":{"type":"string"}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/similar":{"get":{"summary":"Find manufacturing orders that look like duplicates of this one","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/dependencies":{"get":{"summary":"List what would break if a manufacturing order were deleted","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/assignees":{"post":{"summary":"Put somebody on a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/timeline":{"get":{"summary":"Read everything that has happened to a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/notes":{"post":{"summary":"Add a note to a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/email-check":{"get":{"summary":"List the email check for a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/email":{"post":{"summary":"Send an email about a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/related":{"get":{"summary":"List the related for a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/related/{module}":{"get":{"summary":"List the related for a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/new":{"post":{"summary":"Add to the new of a manufacturing order","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/detail":{"get":{"summary":"List the detail for a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/cost":{"get":{"summary":"List the cost for a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/confirm":{"post":{"summary":"Add to the confirm of a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/release":{"post":{"summary":"Add to the release of a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/start":{"post":{"summary":"Add to the start of a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/complete":{"post":{"summary":"Add to the complete of a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/cancel":{"post":{"summary":"Cancel a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/orders/{id}/tracking":{"post":{"summary":"Add to the tracking of a manufacturing order","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/job-cards":{"get":{"summary":"List job cards, filtered, sorted and paged","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/job-cards/{id}/start":{"post":{"summary":"Add to the start of a job card","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/job-cards/{id}/pause":{"post":{"summary":"Add to the pause of a job card","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/job-cards/{id}/complete":{"post":{"summary":"Add to the complete of a job card","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/job-cards/{id}/staff":{"post":{"summary":"Add to the staff of a job card","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/job-cards/{id}/work-center":{"post":{"summary":"Add to the work center of a job card","tags":["Manufacturing"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/shopfloor":{"get":{"summary":"List shopfloor","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/dashboard":{"get":{"summary":"Read the dashboard dashboard","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/manufacturing/":{"get":{"summary":"List manufacturing","tags":["Manufacturing"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/comments":{"get":{"summary":"List the comments for a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates":{"get":{"summary":"List quality templates, filtered, sorted and paged","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a quality template","tags":["Quality"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"inspectionGuide":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}}},"/api/quality/templates/export.csv":{"get":{"summary":"Download quality templates as a CSV file","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/kanban":{"get":{"summary":"Read quality templates arranged as a board","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/pivot":{"get":{"summary":"Summarise quality templates as a pivot table","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/bulk":{"post":{"summary":"Change several quality templates at once","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/bulk/delete":{"post":{"summary":"Delete several quality templates at once","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/bulk/assign":{"post":{"summary":"Assign several quality templates to somebody at once","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/import":{"post":{"summary":"Import quality templates from a CSV file","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}":{"get":{"summary":"Read one quality template in full","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"inspectionGuide":{"type":"string","nullable":true},"isActive":{"type":"boolean"},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/similar":{"get":{"summary":"Find quality templates that look like duplicates of this one","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/dependencies":{"get":{"summary":"List what would break if a quality template were deleted","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/assignees":{"post":{"summary":"Put somebody on a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/timeline":{"get":{"summary":"Read everything that has happened to a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/notes":{"post":{"summary":"Add a note to a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/email-check":{"get":{"summary":"List the email check for a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/email":{"post":{"summary":"Send an email about a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/related":{"get":{"summary":"List the related for a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/related/{module}":{"get":{"summary":"List the related for a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/comments":{"get":{"summary":"List the comments for a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules":{"get":{"summary":"List quality rules, filtered, sorted and paged","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a quality rule","tags":["Quality"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"inspectionGuide":{"type":"string","nullable":true},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}}},"/api/quality/rules/export.csv":{"get":{"summary":"Download quality rules as a CSV file","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/kanban":{"get":{"summary":"Read quality rules arranged as a board","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/pivot":{"get":{"summary":"Summarise quality rules as a pivot table","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/bulk":{"post":{"summary":"Change several quality rules at once","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/bulk/delete":{"post":{"summary":"Delete several quality rules at once","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/bulk/assign":{"post":{"summary":"Assign several quality rules to somebody at once","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/import":{"post":{"summary":"Import quality rules from a CSV file","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}":{"get":{"summary":"Read one quality rule in full","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"inspectionGuide":{"type":"string","nullable":true},"status":{"type":"string"},"custom":{"type":"object","additionalProperties":{}}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/similar":{"get":{"summary":"Find quality rules that look like duplicates of this one","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/dependencies":{"get":{"summary":"List what would break if a quality rule were deleted","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/assignees":{"post":{"summary":"Put somebody on a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/timeline":{"get":{"summary":"Read everything that has happened to a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/notes":{"post":{"summary":"Add a note to a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/email-check":{"get":{"summary":"List the email check for a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/email":{"post":{"summary":"Send an email about a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/related":{"get":{"summary":"List the related for a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/related/{module}":{"get":{"summary":"List the related for a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/comments":{"get":{"summary":"List the comments for a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the comments of a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/comments/{commentId}":{"delete":{"summary":"Remove from the comments of a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"commentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections":{"get":{"summary":"List quality inspections, filtered, sorted and paged","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a quality inspection","tags":["Quality"],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"remarks":{"type":"string","nullable":true}},"additionalProperties":false}}}}}},"/api/quality/inspections/export.csv":{"get":{"summary":"Download quality inspections as a CSV file","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/kanban":{"get":{"summary":"Read quality inspections arranged as a board","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/pivot":{"get":{"summary":"Summarise quality inspections as a pivot table","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/bulk":{"post":{"summary":"Change several quality inspections at once","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/bulk/delete":{"post":{"summary":"Delete several quality inspections at once","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/bulk/assign":{"post":{"summary":"Assign several quality inspections to somebody at once","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/import":{"post":{"summary":"Import quality inspections from a CSV file","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}":{"get":{"summary":"Read one quality inspection in full","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"remarks":{"type":"string","nullable":true},"status":{"type":"string"}},"additionalProperties":false}}}}},"delete":{"summary":"Delete a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/similar":{"get":{"summary":"Find quality inspections that look like duplicates of this one","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/dependencies":{"get":{"summary":"List what would break if a quality inspection were deleted","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/assignees":{"post":{"summary":"Put somebody on a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/assignees/{userId}":{"delete":{"summary":"Take somebody off a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/timeline":{"get":{"summary":"Read everything that has happened to a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/notes":{"post":{"summary":"Add a note to a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/email-check":{"get":{"summary":"List the email check for a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/email":{"post":{"summary":"Send an email about a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/notes/{noteId}":{"patch":{"summary":"Change or remove a note on a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Change or remove a note on a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"noteId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/related":{"get":{"summary":"List the related for a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/related/{module}":{"get":{"summary":"List the related for a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"module","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/view":{"get":{"summary":"List view","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a view","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/new":{"post":{"summary":"Add to the new of a quality template","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/detail":{"get":{"summary":"List the detail for a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/lines":{"post":{"summary":"Add to the lines of a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/templates/{id}/active":{"post":{"summary":"Add to the active of a quality template","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/new":{"post":{"summary":"Add to the new of a quality rule","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/detail":{"get":{"summary":"List the detail for a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/lines":{"post":{"summary":"Add to the lines of a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/rules/{id}/status":{"post":{"summary":"Change the status of a quality rule","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/detail":{"get":{"summary":"List the detail for a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/inspections/{id}/inspector":{"post":{"summary":"Add to the inspector of a quality inspection","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/worklists/{id}/validate":{"post":{"summary":"Create a validate","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/worklists/{id}/sample":{"post":{"summary":"Create a sample","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/worklists/{id}/finish":{"post":{"summary":"Create a finish","tags":["Quality"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/worklists":{"get":{"summary":"List worklists","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/reports/summary":{"get":{"summary":"Read a summary for summary","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/reports/failures":{"get":{"summary":"Run the failures report","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/reports/by-transaction":{"get":{"summary":"Run the by transaction report","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/quality/":{"get":{"summary":"List quality","tags":["Quality"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/links/providers":{"get":{"summary":"List the providers for a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/links/{provider}/connect":{"get":{"summary":"List the connect for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/links/{provider}/callback":{"get":{"summary":"List the callback for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/links/connections/{id}":{"delete":{"summary":"Remove from the connections of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/links/{provider}/browse":{"get":{"summary":"List the browse for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/links/{provider}/picker":{"get":{"summary":"List the picker for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/links/{provider}/image":{"post":{"summary":"Add to the image of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/links/{provider}/import":{"post":{"summary":"Import files from a CSV file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/overview":{"get":{"summary":"List the overview for a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/shared-with-me":{"get":{"summary":"List the shared with me for a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/recent":{"get":{"summary":"List the recent for a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/public-links":{"get":{"summary":"List the public links for a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/share-targets":{"get":{"summary":"List the share targets for a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/folders":{"get":{"summary":"List the folders for a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the folders of a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/folders/tree":{"get":{"summary":"List the tree for a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/folders/{id}":{"patch":{"summary":"Change the folders of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove from the folders of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/folders/{id}/move":{"post":{"summary":"Add to the move of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/folders/{id}/dependencies":{"get":{"summary":"List what would break if a file were deleted","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/folders/{id}/restore":{"post":{"summary":"Restore a file from the trash","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/folders/{id}/download":{"get":{"summary":"List the download for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files":{"get":{"summary":"List the files for a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/upload":{"post":{"summary":"Add to the upload of a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}":{"get":{"summary":"List the files for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change the files of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove from the files of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/details":{"get":{"summary":"List the details for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/download":{"get":{"summary":"List the download for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/move":{"post":{"summary":"Add to the move of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/star":{"post":{"summary":"Add to the star of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/tags":{"post":{"summary":"Add to the tags of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/bulk/move":{"post":{"summary":"Add to the move of a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/bulk/tag":{"post":{"summary":"Add to the tag of a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/dependencies":{"get":{"summary":"List what would break if a file were deleted","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/restore":{"post":{"summary":"Restore a file from the trash","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/trash":{"get":{"summary":"List the trash for a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/trash/empty":{"post":{"summary":"Add to the empty of a file","tags":["Documents"],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/versions":{"get":{"summary":"List the versions of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"List the versions of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/versions/{version}/restore":{"post":{"summary":"Restore a file from the trash","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"version","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/shares":{"get":{"summary":"List the shares for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the shares of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/folders/{id}/shares":{"get":{"summary":"List the shares for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the shares of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/shares/{id}":{"delete":{"summary":"Remove from the shares of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/files/{id}/public-link":{"get":{"summary":"List the public link for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add to the public link of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/public-links/{id}":{"delete":{"summary":"Remove from the public links of a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/public/{token}":{"get":{"summary":"List the public for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/public/{token}/content":{"get":{"summary":"List the content for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/documents/public/{token}/download":{"get":{"summary":"List the download for a file","tags":["Documents"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/board/{module}/{id}/move":{"post":{"summary":"Create a move","tags":["Boards"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"module","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/":{"get":{"summary":"List notifications","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/templates":{"get":{"summary":"List templates","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a template","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/templates/{id}":{"get":{"summary":"Read one template","tags":["Notifications"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a template","tags":["Notifications"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a template","tags":["Notifications"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/templates/active":{"post":{"summary":"Create an active","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/templates/uninstall":{"post":{"summary":"Create an uninstall","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/library":{"get":{"summary":"List library","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/library/install":{"post":{"summary":"Create an install","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/preview":{"post":{"summary":"Create a preview","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/tokens/{moduleKey}":{"get":{"summary":"Read one token","tags":["Notifications"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"moduleKey","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/queue":{"get":{"summary":"List queue","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/queue/send":{"post":{"summary":"Create a send","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/queue/hold":{"post":{"summary":"Create a hold","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/queue/pause-all":{"post":{"summary":"Create a pause all","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/log":{"get":{"summary":"List log","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/log/{id}":{"get":{"summary":"Read one log","tags":["Notifications"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/settings":{"get":{"summary":"List settings","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a setting","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/preferences":{"get":{"summary":"List preferences","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a preference","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/preferences/mine":{"get":{"summary":"List mine","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/inbox":{"get":{"summary":"List inbox","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/inbox/{id}/read":{"post":{"summary":"Create a read","tags":["Notifications"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/inbox/read-all":{"post":{"summary":"Create a read all","tags":["Notifications"],"responses":{"200":{"description":"Default Response"}}}},"/api/notifications/inbox/{id}":{"delete":{"summary":"Delete an inbox","tags":["Notifications"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/boards":{"get":{"summary":"List boards","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a board","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/boards/{key}":{"get":{"summary":"Read one board","tags":["Reports"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a board","tags":["Reports"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a board","tags":["Reports"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/boards/{key}/data":{"post":{"summary":"Create a data","tags":["Reports"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/preview":{"post":{"summary":"Create a preview","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/drill":{"post":{"summary":"Create a drill","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/home":{"put":{"summary":"Change a home","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/homes":{"get":{"summary":"List homes","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a home","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/people":{"get":{"summary":"List people","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/hanu":{"post":{"summary":"Create a hanu","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/widget":{"post":{"summary":"Create a widget","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/overview":{"get":{"summary":"List overview","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/crm":{"get":{"summary":"List crm","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/sales":{"get":{"summary":"List sales","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/dashboards/sources":{"get":{"summary":"List sources","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/reports/":{"get":{"summary":"List reports","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/reports/{key}/run":{"get":{"summary":"Run the run report","tags":["Reports"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/reports/{key}/export.{format}":{"get":{"summary":"Run the export.:format report","tags":["Reports"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true},{"schema":{"type":"string"},"in":"path","name":"format","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/reports/schedules":{"get":{"summary":"Run the schedules report","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Run the schedules report","tags":["Reports"],"responses":{"200":{"description":"Default Response"}}}},"/api/reports/schedules/{id}":{"patch":{"summary":"Run the schedules report","tags":["Reports"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Run the schedules report","tags":["Reports"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/reports/schedules/{id}/send":{"post":{"summary":"Run the send report","tags":["Reports"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/feedback/":{"get":{"summary":"List feedback","tags":["Feedback & roadmap"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a feedback","tags":["Feedback & roadmap"],"responses":{"200":{"description":"Default Response"}}}},"/api/feedback/{id}/vote":{"post":{"summary":"Create a vote","tags":["Feedback & roadmap"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/feedback/{id}":{"patch":{"summary":"Change a feedback","tags":["Feedback & roadmap"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a feedback","tags":["Feedback & roadmap"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/files/{entityType}/{entityId}":{"get":{"summary":"Read one file","tags":["Files"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"entityType","required":true},{"schema":{"type":"string"},"in":"path","name":"entityId","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Act on a file","tags":["Files"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"entityType","required":true},{"schema":{"type":"string"},"in":"path","name":"entityId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/files/download/{id}":{"get":{"summary":"Read one download","tags":["Files"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/files/{id}":{"patch":{"summary":"Change a file","tags":["Files"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a file","tags":["Files"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/files/image":{"post":{"summary":"Create an image","tags":["Files"],"responses":{"200":{"description":"Default Response"}}}},"/api/files/usage/summary":{"get":{"summary":"Read a summary for files","tags":["Files"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/summary":{"get":{"summary":"Unread counts for the Charcha badges: chats, groups, channels, broadcasts and in total","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations":{"get":{"summary":"The conversations in one Charcha section, pinned first, then newest","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Make a group or a channel, with its first members","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/browse":{"get":{"summary":"Open channels in the business that this person has not joined","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/manage":{"get":{"summary":"Every group and channel in the business, for someone allowed to run them all","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/direct":{"post":{"summary":"Open the direct chat with one colleague, starting it if there is none","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}":{"get":{"summary":"One conversation: its settings, its members and how far each has read, and what this person may do in it","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a group or channel: name, about, who may post, delete and use @everyone","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/join":{"post":{"summary":"Join an open channel","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/members":{"post":{"summary":"Add people to a group or channel; adding to a direct chat turns it into a group","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/members/{userId}":{"patch":{"summary":"Make a member an admin of a group or channel, or a member again","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/members/{userId}/remove":{"post":{"summary":"Remove someone from a group or channel, or leave it yourself","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"userId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/me":{"patch":{"summary":"Pin, mute, archive or mark a conversation unread, for this person only","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/clear":{"post":{"summary":"Clear a conversation for this person only; others keep every message","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/read":{"post":{"summary":"Mark a conversation read up to its newest message, or up to a given moment","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/delivered":{"post":{"summary":"Record that messages reached this person's screen (the second tick)","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/typing":{"post":{"summary":"Tell the others in a conversation that this person is typing","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/messages":{"get":{"summary":"The messages of a conversation, newest page first (pass before= to go back further)","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Send a message, a reply in a thread, or a reply quoting another message","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/thread":{"get":{"summary":"A thread: the message that started it and every reply","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}":{"patch":{"summary":"Edit your own message; the earlier words are kept in its history","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/history":{"get":{"summary":"Every version of an edited message, with when each was written","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/delete":{"post":{"summary":"Delete a message for yourself, or for everyone in the conversation","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/reactions":{"post":{"summary":"Add a reaction to a message, or take yours away if it is already there","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/pin":{"post":{"summary":"Pin a message to the top of its conversation, or unpin it","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/forward":{"post":{"summary":"Forward a message, with its files, to other chats, groups or channels","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/seen":{"get":{"summary":"Who a message has reached and who has read it, with the date and time for each","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/search":{"get":{"summary":"Search the messages in every conversation this person is in","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/files":{"post":{"summary":"Upload files into a conversation, ready to send with a message","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/files/from-documents":{"post":{"summary":"Attach files from Documents to a conversation; each is copied in, so it opens for everyone there","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/files/documents":{"get":{"summary":"Files in Documents that this person may attach, for the Charcha picker","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/files/{provider}/picker":{"get":{"summary":"A short-lived token for Google's own file picker, for this person's own Drive","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/files/{provider}/browse":{"get":{"summary":"One folder of this person's own Dropbox, to attach from","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/files/{provider}/attach":{"post":{"summary":"Copy files from this person's own Google Drive or Dropbox into a conversation","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/files/{id}":{"get":{"summary":"Open or download a file sent in a conversation","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/people":{"get":{"summary":"Colleagues to start a chat with or mention, with their status and whether they are online","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/me":{"get":{"summary":"This person's Charcha: how Enter behaves, their status, and what their role lets them do","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Set how Enter behaves in Charcha, and set or clear a status","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/settings":{"get":{"summary":"The business's Charcha rules: the delete-for-everyone window and how long messages are kept","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change the business's Charcha rules (administrators)","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/broadcast/reach":{"get":{"summary":"Who this person may broadcast to: everyone under them, the level just below, or chosen people","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/broadcast":{"post":{"summary":"Send one message to people under you; each gets it in their own chat and replies come back privately","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/broadcasts":{"get":{"summary":"Broadcasts this person sent, with how many have read each, and the ones from above them","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/meetings":{"get":{"summary":"Meetings this person organises or is invited to: upcoming, or past","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Schedule a meeting with a link (Google Meet, Zoom or any other), posted in a chat if one is chosen","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/meetings/{id}":{"patch":{"summary":"Change a meeting you organise: its time, link, title or reminder","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/meetings/{id}/cancel":{"post":{"summary":"Cancel a meeting you organise; everyone invited is told","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/meetings/{id}/ics":{"get":{"summary":"A meeting as a calendar file (.ics) for Google Calendar, Outlook or a phone","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/push/key":{"get":{"summary":"The public key a browser needs to subscribe to Charcha notifications","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/push/subscriptions":{"post":{"summary":"Turn on Charcha notifications for this browser","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/push/unsubscribe":{"post":{"summary":"Turn off Charcha notifications for this browser","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/polls":{"post":{"summary":"Ask a question with choices; everybody here can vote and see the counts move","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/vote":{"post":{"summary":"Vote in a poll, or change your vote (an empty list takes it back)","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/close-poll":{"post":{"summary":"Close a poll you started (or run, as an admin); its result stays","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/records":{"get":{"summary":"Find a record to share in a message: only ones you can open yourself","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/refresh":{"post":{"summary":"Read the records a message carries again and show everybody the change","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/reminders":{"get":{"summary":"Your reminders: due, coming up, and the ones you recently marked done","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Remind me about a message, a chat or an email at a time","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/reminders/{id}/done":{"post":{"summary":"Mark a reminder done","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/reminders/{id}/undo":{"post":{"summary":"Put a reminder you marked done back on the list","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/reminders/{id}/snooze":{"post":{"summary":"Ring again later: a number of minutes from now, or a time","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/reminders/{id}":{"delete":{"summary":"Remove a reminder","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/checklists":{"post":{"summary":"Post a checklist: items ticked by hand, by a record, or by the day's work","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/checklist-items/{id}/tick":{"post":{"summary":"Tick an item on a checklist by hand, or take the tick back","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/checklists/{id}/stop-repeating":{"post":{"summary":"Stop a checklist repeating; the ones already posted stay","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/checklists/stages":{"get":{"summary":"The deal stages a checklist item can wait for","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/visit-rings/{id}/snooze":{"post":{"summary":"Ring again about a visit in a few minutes","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/visits/{id}/voice":{"post":{"summary":"Speak the notes of a visit: the recording is kept on it and its words are written out","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/visit-voice/{id}/applied":{"post":{"summary":"The open window took the written-out words into the notes","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/day-report":{"get":{"summary":"Your day so far, put together from your work, with where it goes","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/day-report/send":{"post":{"summary":"Send your day report to your manager, any colleague, a group or a channel; it remembers where","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/shows/{eventId}":{"get":{"summary":"An exhibition's stall channel: whether there is one, and whether you are in it","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"eventId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/shows/{eventId}/start":{"post":{"summary":"Make an exhibition's stall channel now, rather than a fortnight before the show","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"eventId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/shows/{eventId}/join":{"post":{"summary":"Join an exhibition's stall channel","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"eventId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/ai":{"get":{"summary":"Which of Charcha's AI jobs this business may use now (catching up, task drafts, the day note, voice)","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/conversations/{id}/catch-up":{"post":{"summary":"An AI summary of the messages you missed in a conversation, each line linked to its message","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/task-drafts":{"post":{"summary":"AI drafts of the task or tasks a message asks for, to check before making any","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/day-report/draft":{"post":{"summary":"An AI draft of the note on your day report, from your work in JAI CRM today","tags":["Charcha"],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/messages/{id}/words":{"post":{"summary":"Write out a voice note (AI where the business allows it, else our own transcriber); the words arrive live","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/record-chats/{type}/{id}":{"get":{"summary":"The conversation about a lead, deal, task or invoice, if there is one, and whether you are in it","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"type","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/record-chats/{type}/{id}/start":{"post":{"summary":"Start the conversation about a lead, deal, task or invoice","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"type","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/charcha/record-chats/{type}/{id}/join":{"post":{"summary":"Join the conversation about a lead, deal, task or invoice you can open","tags":["Charcha"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"type","required":true},{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/boot":{"get":{"summary":"The calendar’s settings, your own view, the kinds you can see and the people","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/items":{"get":{"summary":"Everything on the calendar in a window of days (at most 62)","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/items/ics":{"get":{"summary":"One calendar item as a calendar file (.ics)","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/attention":{"get":{"summary":"Overdue work, meetings and visits waiting for an outcome, open work with no next step, and work with no date","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/me":{"put":{"summary":"Your own calendar view: the view, the kinds you hide, your hours","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/settings":{"get":{"summary":"The business’s calendar settings","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change the business’s calendar settings","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/holidays":{"get":{"summary":"The business’s holidays for a year","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Add a holiday for the business or one branch","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/holidays/national":{"post":{"summary":"Add India’s national holidays for a year","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/holidays/{id}":{"delete":{"summary":"Remove a holiday","tags":["Calendar"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/compliance/mark":{"post":{"summary":"Mark a PF, ESI, TDS or quarterly GST date done, or not done","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/blocks":{"post":{"summary":"Block time for yourself: focus, away or travelling","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/blocks/{id}":{"patch":{"summary":"Change your blocked time","tags":["Calendar"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Remove your blocked time","tags":["Calendar"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/promises":{"post":{"summary":"Note a customer’s promise to pay an invoice on a day","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/promises/{id}":{"patch":{"summary":"Move a promised payment, or mark it kept or broken","tags":["Calendar"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/brief":{"get":{"summary":"A briefing on a lead, customer or deal before you meet them","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/meetings/{id}/outcome":{"post":{"summary":"Say how a meeting went","tags":["Calendar"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/feed":{"post":{"summary":"Make (or remake) your private calendar link for Apple Calendar or any other calendar app","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Turn your private calendar link off","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/sync/":{"get":{"summary":"Your Google Calendar and Outlook connections","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/sync/{provider}/connect":{"get":{"summary":"Where to send the browser to sign in to Google Calendar or Outlook","tags":["Calendar"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/sync/{provider}":{"put":{"summary":"Choose what goes to your Google Calendar or Outlook, and whether your busy time comes back","tags":["Calendar"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Disconnect your Google Calendar or Outlook (its JAI CRM calendar goes too)","tags":["Calendar"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/sync/{provider}/sync":{"post":{"summary":"Bring your Google Calendar or Outlook up to date now","tags":["Calendar"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/sync/{provider}/remake":{"post":{"summary":"Make the JAI CRM calendar again in your Google Calendar or Outlook","tags":["Calendar"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/sync/restore":{"post":{"summary":"Put an item you removed in Google Calendar or Outlook back there","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/calendar/sync/nudge":{"post":{"summary":"Ask for your connected calendars to be brought up to date","tags":["Calendar"],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/":{"get":{"summary":"The apps, each with how many of its files this person can open","tags":["Apps"],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/{app}":{"get":{"summary":"One app's files that this person can open, and the folders they may save into","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"app","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/{app}/new":{"post":{"summary":"Make a new file in this app from Blank or a template, saved into Documents","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"app","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}":{"get":{"summary":"One file with its app, its versions and what this person may do with it","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/versions/{version}":{"patch":{"summary":"Name a version of a file, or clear its name","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"version","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/download":{"get":{"summary":"Download a file opened in Apps","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/versions":{"post":{"summary":"Upload a newer copy of a file opened in Apps, as its next version","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/versions/{version}/restore":{"post":{"summary":"Bring an old version back, as the newest version","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"version","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/live/join":{"post":{"summary":"Open a file to edit it live: the room as it is, or a request to start it","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/live/seed":{"post":{"summary":"Start the room from the file, by the screen that was asked to","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/live/push":{"post":{"summary":"Send a change to the file, or where my cursor is, to everybody with it open","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/live/sync":{"post":{"summary":"What this screen missed, from its state vector","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/live/save":{"post":{"summary":"Save the file into Documents now, as a named version when given a name","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/live/leave":{"post":{"summary":"Close a file opened live","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/blocks/join":{"post":{"summary":"Open a file in its full editor together with others: the room as it is, or a request to start it","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/blocks/seed":{"post":{"summary":"Start the room from the first member's state","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/blocks/push":{"post":{"summary":"Send a batch of changes to everybody with the file open in its full editor","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/blocks/sync":{"post":{"summary":"The batches this screen missed while its stream was down","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/blocks/base":{"post":{"summary":"The leader's fresh state of the room","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/blocks/snapshot":{"post":{"summary":"The leader's saved file becomes the sitting's version, the room stays open","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/blocks/caret":{"post":{"summary":"Where this person is in a file opened with others, for everybody else in it","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/blocks/leave":{"post":{"summary":"Close a file opened in its full editor with others","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/apps/files/{id}/hanu":{"get":{"summary":"Your conversation with Hanu about a file open in Apps","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Clear your conversation with Hanu about a file","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Hanu in a file open in Apps: the next step of the job (commands for the editor, or the answer)","tags":["Apps"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/live/":{"get":{"summary":"Hold a stream of live updates for the signed-in person","tags":["Live updates"],"description":"Server-sent events. Each event is JSON with a `type`: `charcha.message`, `charcha.updated`, `charcha.typing`, `charcha.read`, `charcha.conversation`, `notification`. A comment line arrives every 20 seconds, and the stream closes after ten minutes; open another.","responses":{"200":{"description":"Default Response"}}}},"/api/app/android":{"get":{"summary":"List android","tags":["Mobile app"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/dashboard":{"get":{"summary":"Read the the platform dashboard","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/analytics/revenue":{"get":{"summary":"List revenue","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/analytics/churn":{"get":{"summary":"List churn","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/analytics/tenants":{"get":{"summary":"List tenants","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/public/plans":{"get":{"summary":"List plans","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/plans":{"get":{"summary":"List plans","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a plan","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/plans/{id}":{"get":{"summary":"Read one plan","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a plan","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a plan","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/plans/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/plans/{id}/prices":{"post":{"summary":"Create a price","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/plans/{id}/prices/{priceId}":{"patch":{"summary":"Change a price","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"priceId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a price","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true},{"schema":{"type":"string"},"in":"path","name":"priceId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/addons":{"get":{"summary":"List addons","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an addon","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/addons/{id}":{"get":{"summary":"Read one addon","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an addon","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an addon","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/addons/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/coupons":{"get":{"summary":"List coupons","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a coupon","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/coupons/{id}":{"get":{"summary":"Read one coupon","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a coupon","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a coupon","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/coupons/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/subscriptions":{"get":{"summary":"List subscriptions","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a subscription","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/subscriptions/{id}":{"get":{"summary":"Read one subscription","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/subscriptions/{id}/change-plan":{"post":{"summary":"Create a change plan","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/subscriptions/{id}/cancel":{"post":{"summary":"Create a cancel","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/subscriptions/{id}/reactivate":{"post":{"summary":"Create a reactivate","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/subscriptions/{id}/invoice":{"post":{"summary":"Create an invoice","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/invoices":{"get":{"summary":"List invoices","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/invoices/{id}":{"get":{"summary":"Read one invoice","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/invoices/{id}/payments":{"post":{"summary":"Create a payment","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/invoices/{id}/void":{"post":{"summary":"Create a void","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/payments":{"get":{"summary":"List payments","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/public/coupons/{code}":{"get":{"summary":"Read one coupon","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"code","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/gateways":{"get":{"summary":"List gateways","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/gateways/{key}":{"put":{"summary":"Change a gateway","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/gateways/{key}/test":{"post":{"summary":"Create a test","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/checkout":{"post":{"summary":"Create a checkout","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/autopay":{"get":{"summary":"List autopay","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an autopay","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an autopay","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/webhooks/{key}":{"post":{"summary":"Act on a webhook","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/purchases/pending":{"get":{"summary":"List pending","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/purchases":{"get":{"summary":"List purchases","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/purchases/{id}/close":{"post":{"summary":"Create a close","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/purchases/{id}/settle":{"post":{"summary":"Create a settle","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/webhooks":{"get":{"summary":"List webhooks","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/billing-settings":{"get":{"summary":"List billing settings","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a billing setting","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/dunning":{"get":{"summary":"List dunning","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/modules":{"get":{"summary":"List modules","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a module","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/modules/{id}":{"get":{"summary":"Read one module","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a module","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a module","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/modules/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/client-types":{"get":{"summary":"List client types","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a client type","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/client-types/{id}":{"get":{"summary":"Read one client type","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a client type","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a client type","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/client-types/{id}/modules":{"put":{"summary":"Change a module","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/client-types/{id}/dependencies":{"get":{"summary":"List dependencies","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/modules":{"get":{"summary":"List modules","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a module","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/modules/resync":{"post":{"summary":"Create a resync","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants":{"get":{"summary":"List tenants","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a tenant","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}":{"get":{"summary":"Read one tenant","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change a tenant","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/ai-credits":{"get":{"summary":"List ai credits","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an ai credit","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/suspend":{"post":{"summary":"Create a suspend","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/reactivate":{"post":{"summary":"Create a reactivate","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/cancel":{"post":{"summary":"Create a cancel","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/archive":{"post":{"summary":"Create an archive","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/usage":{"get":{"summary":"List usage","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/limits":{"post":{"summary":"Create a limit","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/extend-trial":{"post":{"summary":"Create an extend trial","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/free-days":{"get":{"summary":"List free days","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a free day","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a free day","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/impersonate":{"post":{"summary":"Create an impersonate","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/impersonate/end":{"post":{"summary":"Create an end","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/impersonations":{"get":{"summary":"List impersonations","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/permissions":{"get":{"summary":"List permissions","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/users":{"get":{"summary":"List users","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an user","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/users/{id}":{"patch":{"summary":"Change an user","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an user","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/roles":{"get":{"summary":"List roles","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a role","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/roles/{id}":{"patch":{"summary":"Change a role","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a role","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/branding":{"get":{"summary":"List branding","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a branding","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/settings/email":{"get":{"summary":"List email","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change an email","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/settings/email/test":{"post":{"summary":"Create a test","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/settings/email-templates":{"get":{"summary":"List email templates","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/settings/email-templates/{key}":{"put":{"summary":"Change an email template","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an email template","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/settings/email-templates/{key}/duplicate":{"post":{"summary":"Create a duplicate","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/settings/email-templates/{key}/preview":{"post":{"summary":"Create a preview","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"key","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/audit":{"get":{"summary":"List audit","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/signups":{"get":{"summary":"List signups","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/announcements/options":{"get":{"summary":"List options","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/announcements":{"get":{"summary":"List announcements","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create an announcement","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/announcements/{id}":{"get":{"summary":"Read one announcement","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"patch":{"summary":"Change an announcement","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete an announcement","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/announcements/{id}/reach":{"get":{"summary":"List reach","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/ai":{"get":{"summary":"List ai","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change an ai","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/ai/credits":{"get":{"summary":"List credits","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/ai/models":{"get":{"summary":"List models","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/ai/test":{"post":{"summary":"Create a test","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/tenants/{id}/ai":{"get":{"summary":"List ai","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change an ai","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/ai/gift":{"get":{"summary":"List gift","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}},"put":{"summary":"Change a gift","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/ai/gift/{tenantId}/more":{"post":{"summary":"Create a more","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"tenantId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/collections":{"get":{"summary":"List collections","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/collections/{invoiceId}/remind":{"post":{"summary":"Create a remind","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"invoiceId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/":{"get":{"summary":"List platform","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/video-meetings":{"get":{"summary":"The Google, Microsoft and Zoom apps video links are made through","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/video-meetings/{provider}":{"put":{"summary":"Save the client id and secret of one video meeting app","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"provider","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/feedback":{"get":{"summary":"List feedback","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/feedback/{id}":{"patch":{"summary":"Change a feedback","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a feedback","tags":["Platform"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/platform/feedback/hanu":{"post":{"summary":"Create a hanu","tags":["Platform"],"responses":{"200":{"description":"Default Response"}}}},"/api/public/roadmap":{"get":{"summary":"List roadmap","tags":["Feedback & roadmap"],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/me":{"get":{"summary":"Read who the current token belongs to","tags":["Portal"],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/summary":{"get":{"summary":"Read a summary for the portal","tags":["Portal"],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/documents":{"get":{"summary":"List documents","tags":["Portal"],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/documents/{id}":{"get":{"summary":"Read one document","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/documents/{id}/respond":{"post":{"summary":"Create a respond","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/messages":{"get":{"summary":"List messages","tags":["Portal"],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Create a message","tags":["Portal"],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/statement":{"get":{"summary":"List statement","tags":["Portal"],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/files":{"get":{"summary":"List files","tags":["Portal"],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/files/{id}/view":{"get":{"summary":"List view","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/files/{id}/download":{"get":{"summary":"List download","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/projects":{"get":{"summary":"List projects","tags":["Portal"],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/projects/{id}":{"get":{"summary":"Read one project","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"id","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/subscription":{"get":{"summary":"List subscription","tags":["Portal"],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/plans":{"get":{"summary":"List plans","tags":["Portal"],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/public/documents/{token}":{"get":{"summary":"Read one document","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/public/documents/{token}/respond":{"post":{"summary":"Create a respond","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/public/documents/{token}/pages/{n}":{"get":{"summary":"Read one page","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true},{"schema":{"type":"string"},"in":"path","name":"n","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/public/documents/{token}/proposal.pdf":{"get":{"summary":"List proposal.pdf","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/portal/share/{documentId}":{"post":{"summary":"Act on a share","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"documentId","required":true}],"responses":{"200":{"description":"Default Response"}}},"delete":{"summary":"Delete a share","tags":["Portal"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"documentId","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/t/o/{token}.gif":{"get":{"summary":"Read one o","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/t/c/{token}/{index}":{"get":{"summary":"Read one c","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true},{"schema":{"type":"string"},"in":"path","name":"index","required":true}],"responses":{"200":{"description":"Default Response"}}}},"/api/t/u/{token}":{"get":{"summary":"Read one u","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}},"post":{"summary":"Act on an u","tags":["Email"],"parameters":[{"schema":{"type":"string"},"in":"path","name":"token","required":true}],"responses":{"200":{"description":"Default Response"}}}}},"servers":[{"url":"https://app.jaicrm.ai"}],"tags":[{"name":"Authentication","description":"Signing in, refreshing, and the current session"},{"name":"Sales","description":"Leads, customers, companies, deals and tasks"},{"name":"Sales documents","description":"Quotations, orders, invoices, credit notes and receipts"},{"name":"Procurement","description":"Vendors, purchase orders, receipts and bills"},{"name":"Inventory","description":"Items, warehouses, stock and movements"},{"name":"Accounting & finance","description":"Expenses, banking, GST, TDS and payroll"},{"name":"Accountant","description":"Chart of accounts, manual journals, budgets, fixed assets and closing a period"},{"name":"Vendors","description":"The vendor pipeline, master data and what each supplier is worth"},{"name":"Approvals","description":"Who has to agree before a document leaves the building"},{"name":"Collections","description":"A business's own payment gateways, and the customer paying through them"},{"name":"Projects","description":"Projects, tasks, milestones and timesheets"},{"name":"Subscriptions","description":"Plans, addons, coupons, and the recurring arrangements billed against them"},{"name":"Warranty","description":"What is still under warranty, raised by the sale that sold it"},{"name":"Point of sale","description":"A counter: tills, shifts, counter sales and the drawer"},{"name":"Documents","description":"Folders, files and sharing"},{"name":"Reports","description":"Running reports, exports and schedules"},{"name":"Notifications","description":"Templates, triggers and the send log"},{"name":"Email","description":"The mailbox beside the bell: reading a thread, composing a reply, and what each message is about"},{"name":"Charcha","description":"Chat, groups, channels, broadcasts and meetings for a business's own team"},{"name":"Channel partners","description":"Architects and other partners who refer customers, and who a lead, customer, deal or document is credited to"},{"name":"Hanu","description":"The setup guide and its storage gifts, the chat with Hanu that answers as the person asking, actions that wait for a yes, the team report, emails waiting for a reply, and setting a business up"},{"name":"Cross-sell","description":"Rules that open the next department's deal for the same customer, the deals waiting to open, and what one deal passed on"},{"name":"Targets and commission","description":"Monthly sales targets, commission plans and statements, and what channel partners are owed"},{"name":"Live updates","description":"One stream per open screen: new messages, typing, seen ticks and the bell, without a refresh"},{"name":"Mobile app","description":"What the Android app asks for when it checks whether it is up to date"},{"name":"Settings","description":"Business profile, users, roles, API keys and webhooks"},{"name":"Integrations","description":"Connecting an outside system — IndiaMART, Shopify — and what it sends"},{"name":"Boards","description":"Moving a record between and within board columns"},{"name":"Files","description":"Uploading and downloading attachments"},{"name":"Portal","description":"What a customer or vendor can see of their own records"},{"name":"Platform","description":"The SaaS control plane. Not available to tenant keys."},{"name":"Feedback & roadmap","description":"Feature requests, votes and what is planned"},{"name":"Service","description":"Liveness and readiness, for load balancers and uptime checks"}]}