u
This commit is contained in:
16
README.md
16
README.md
@@ -29,10 +29,10 @@ ID fields in the JS API use camelCase `…Id` (DB columns stay snake_case).
|
||||
|
||||
| Method | Signature | Returns |
|
||||
| --- | --- | --- |
|
||||
| `create` | `({ iso639, name, taxrate, reducedtaxrate })` | `{ id, rootCategoryId, languageId, taxrateId, reducedtaxrateId, taxfreerateId }` |
|
||||
| `create` | `({ iso639, name, taxrate, reducedtaxrate, authId })` | `{ id, rootCategoryId, languageId, taxrateId, reducedtaxrateId, taxfreerateId }` |
|
||||
| `update` | `(id, { iso639, name, taxrate, reducedtaxrate })` | `{ id, rootCategoryId, languageId, taxrateId, reducedtaxrateId, taxfreerateId }` |
|
||||
| `delete` | `(companyId)` | `void` |
|
||||
| `list` | `()` | `{ id, rootCategoryId, languageId, taxrateId, reducedtaxrateId, taxfreerateId }[]` |
|
||||
| `list` | `(authId)` | `{ id, name, rootCategoryId, languageId, taxrate, reducedtaxrate, taxfreerate }[]` |
|
||||
|
||||
### `create` (transaction)
|
||||
|
||||
@@ -43,6 +43,11 @@ For `POST /api/company`:
|
||||
3. Ensures tax rows for `taxrate`, `reducedtaxrate`, and `0` → `taxfreerateId`
|
||||
4. Creates root category (`parentId = null`)
|
||||
5. Inserts company with all FKs set
|
||||
6. Links creator as `companyuser` (`authId` → `company_id`)
|
||||
|
||||
### `list`
|
||||
|
||||
Returns only companies where `authId` has a `companyuser` row.
|
||||
|
||||
### `update` (transaction)
|
||||
|
||||
@@ -121,7 +126,8 @@ Backend mapping:
|
||||
|
||||
| Route | Store call |
|
||||
| --- | --- |
|
||||
| `POST /api/company` | `company.create({ iso639, name, taxrate, reducedtaxrate })` |
|
||||
| `POST /api/company` | `company.create({ iso639, name, taxrate, reducedtaxrate, authId })` |
|
||||
| `GET /api/company` | `company.list(authId)` |
|
||||
| `PATCH /api/company/:id` | `company.update(id, { iso639, name, taxrate, reducedtaxrate })` |
|
||||
| `DELETE /api/company/:id` | `company.delete(id)` |
|
||||
| `PUT /api/auth/selected-company` | `google_auth.setSelectedCompany(authId, companyId)` |
|
||||
@@ -131,7 +137,9 @@ Backend mapping:
|
||||
## Scripts
|
||||
|
||||
```bash
|
||||
npm run init-schema # apply SCHEMA_SCRIPTS via .env
|
||||
npm run purge-db # drop all tables + procedure (wipe data)
|
||||
npm run reset-db # purge + init-schema (empty DB, fresh schema)
|
||||
npm run init-schema # ensure schema only (does NOT delete data)
|
||||
npm run test:api # interactive API tester
|
||||
npm run schema-graph # regenerate schema-graph.svg
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user