Files
dashback/docs/api/routes/company/update.md
2026-10-28 00:08:02 +01:00

67 lines
1.2 KiB
Markdown

# `PUT /company/{id}`
Protected. Requires a valid session cookie (`credentials: 'include'`).
Update company
Updates a company.
## Path parameters
| Param | Required | Type | Description |
|-------|----------|------|-------------|
| `id` | yes | integer | |
## Body (JSON)
| Field | Required | Type | Description |
|-------|----------|------|-------------|
| `iso639` | yes | string | |
| `name` | yes | string | |
| `taxrate` | yes | number | |
| `reducedtaxrate` | yes | number | |
```json
{
"iso639": "…",
"name": "…",
"taxrate": 1,
"reducedtaxrate": 1
}
```
## Signals
On success, emits SSE signal: `company` (see [`GET /events`](../events.md)).
## Response `200`
Updated
```json
{
"company": {
"id": 1,
"name": "…",
"rootCategoryId": 1,
"languageId": 1,
"iso639": "…",
"taxrate": 1,
"reducedtaxrate": 1,
"taxfreerate": 1
}
}
```
## Errors
| Status | Description |
|--------|-------------|
| 400 | Validation error — `{"error":"…"}` |
| 401 | Unauthorized — `{"error":"…"}` |
| 404 | Company not found — `{"error":"…"}` |
---
_Generated from `@openapi` JSDoc. Do not edit by hand — run `npm run docs:api`._