docs(crm): capture association graph and invoice/mail quirks
Document Medex-learned OO rules (one company, entityId at create, PDF cache/cleanup, Matrix # truncation) and add invoices pdf/status helpers.
This commit is contained in:
@@ -0,0 +1,120 @@
|
||||
# CRM associations (company ↔ person ↔ deal ↔ project ↔ invoice ↔ mail)
|
||||
|
||||
Operational rules learned from real billing work (AcmeClient INV-2026-01, AcmeProject INV-2026-01).
|
||||
Tooling: `oo` CLI + this library. Business SSOT remains OnlyOffice (`ASR-0002`).
|
||||
|
||||
## Canonical graph
|
||||
|
||||
One **legal company** owns the relationship. Do not invent a second “bill-to”
|
||||
company just for PDF layout.
|
||||
|
||||
```text
|
||||
Company (#CONTACT_ID)
|
||||
├── Person (GF / buyer contact) oo persons create --company-id
|
||||
├── Opportunity / Deal oo opportunities … ; member-add company + person
|
||||
├── Project (hub) oo projects … ; contacts add company + person
|
||||
│ └── Epic + subtasks
|
||||
└── Invoice (Draft → …) oo invoices create --contact COMPANY --opportunity DEAL
|
||||
└── PDF file oo invoices pdf ID
|
||||
└── Mail draft oo mails draft-invoice --invoice ID --to …
|
||||
```
|
||||
|
||||
| Layer | CLI | Must link |
|
||||
|-------|-----|-----------|
|
||||
| Company | `oo companies create` | website, email, phone, **one** Billing address |
|
||||
| Person | `oo persons create --company-id` | job title; never encode employer in `lastName` |
|
||||
| Deal | `oo opportunities create` + `member-add` | company **and** person as members |
|
||||
| Project | `oo projects create` + `contacts add` | same company + person |
|
||||
| Invoice | `oo invoices create --contact COMPANY --opportunity DEAL` | `entityId` at **create** |
|
||||
| Mail | `oo mails draft-invoice` | attach current PDF; **do not send** until confirmed |
|
||||
|
||||
UI checks (same company card):
|
||||
|
||||
- `#contacts` → person
|
||||
- `#deals` → opportunity
|
||||
- `#projects` → hub project
|
||||
- `#invoices` on the **deal** → invoice (needs `entity`)
|
||||
- `#files` → preferably **one** current `P-….pdf`
|
||||
|
||||
## Hard rules
|
||||
|
||||
1. **One company per legal entity.** Duplicate “bill-to” contacts empty Deals /
|
||||
Projects / Contacts tabs and break merge. Prefer
|
||||
`oo contacts merge FROM INTO` (keeps `INTO`) or `oo companies dedupe`.
|
||||
2. **Link invoice → deal at create.**
|
||||
`POST /crm/invoice` with `entityId` + `entityType: 0` (Opportunity).
|
||||
`oo invoices update … --opportunity` often returns **400**
|
||||
(“Value does not fall within the expected range”). If the link is missing,
|
||||
delete the Draft and recreate with `--opportunity`.
|
||||
3. **Bill To = company id**, not a throwaway contact. Person stays under the
|
||||
company (`companyId`). Optional `consigneeId` for Empfänger when the portal
|
||||
template prints it.
|
||||
4. **Stay Draft until mail is ready.** Billed (`status id=2`) is **not editable**
|
||||
via content PUT. Going Billed → Draft via `…/crm/invoice/status/1` usually
|
||||
**does not work** — delete + recreate Draft instead.
|
||||
5. **Do not regenerate PDF in a loop** without cleanup. Each
|
||||
`GET …/crm/invoice/{id}/pdf` attaches a new file to the company (and often
|
||||
the deal). Keep `invoice.fileID`; delete older `P-*.pdf` with
|
||||
`oo invoices pdf-cleanup ID` / Documents `fileops/delete`.
|
||||
|
||||
## Invoice PDF quirks
|
||||
|
||||
| Symptom | Workaround |
|
||||
|---------|------------|
|
||||
| Cached / stale PDF | Touch invoice (Draft PUT that clears `fileID`), then `GET …/pdf` — `oo invoices pdf ID --force` |
|
||||
| Billing address missing on **new** PDFs | Temporary multiline `companyName` (`Line1\nLine2\n…`) on the **canonical** company → force PDF → restore clean name. Cached `fileID` keeps the multiline Bill To. |
|
||||
| Separate bill-to company for newlines | **Forbidden** — merge back to the real company |
|
||||
| Invoice **number** won’t change on PUT | Delete Draft and recreate with the desired number |
|
||||
| Notizen / Bedingungen spacing | Leading `\n` and blank lines only — no HTML (tags print literally) |
|
||||
| Issuer NIE / street lines | Organisation profile address (`street` with `\n`), not only terms |
|
||||
|
||||
Status ids commonly used on this portal: `1` Draft, `2` Billed, `3` Rejected, `4` Paid.
|
||||
|
||||
## Mail quirks
|
||||
|
||||
| Symptom | Workaround |
|
||||
|---------|------------|
|
||||
| Signature / body cuts Matrix URL at `#` | Plain text `chat: https://matrix.to/#/@user:server` — avoid `<a href="…#…">` (or encode `#` as `%23` in href) |
|
||||
| German letter spacing | Blank `<p> </p>` between blocks (`MailHTMLWithBlankParagraphs`) |
|
||||
| Send | Never auto-send; draft only until the human confirms |
|
||||
|
||||
Prefer OnlyOffice Mail (`/addons/mail/#drafts`) over Gmail MCP for invoice delivery.
|
||||
|
||||
## Project / task quirks
|
||||
|
||||
- Hub title: `CC | Company` (e.g. `DE | AcmeClient Ambulanter Pflegedienst GmbH`).
|
||||
- Streams = epics/tasks under the hub, not a third title segment (unless the
|
||||
project itself is a named delivery stream).
|
||||
- Closing a **subtask**:
|
||||
`PUT /api/2.0/project/task/{epicId}/{subtaskId}/status` with `status=2`.
|
||||
`oo tasks update SUBTASK -s closed` returns **404** for subtasks.
|
||||
- After deleting a CRM contact, `GET /project/contact/{deletedId}` may still
|
||||
return projects (ghost). Official project contact list should only show live
|
||||
ids; unlink may 400 if the contact is gone.
|
||||
|
||||
## Merge / cleanup cheat sheet
|
||||
|
||||
```bash
|
||||
# Keep the human-created company (INTO), drop the duplicate (FROM)
|
||||
oo contacts merge 1334 1328
|
||||
|
||||
# Or by normalized name (careful — whole CRM)
|
||||
oo companies dedupe
|
||||
|
||||
# Invoice ↔ deal must exist at create
|
||||
oo invoices create --number P-YYYY-NN --contact CONTACT_ID --item N \
|
||||
--price 300 --opportunity OPPORTUNITY_ID --language de-DE …
|
||||
|
||||
# Fresh PDF + prune older P-*.pdf on company/deal
|
||||
oo invoices pdf 41 --force
|
||||
oo invoices pdf-cleanup INVOICE_ID
|
||||
|
||||
# Mail draft (no send)
|
||||
oo mails draft-invoice --invoice INVOICE_ID --to info@client.de
|
||||
```
|
||||
|
||||
## Related
|
||||
|
||||
- README § invoices / mail / CRM cleanup
|
||||
- Skill `oo-clients-projects` (Cursor)
|
||||
- inventar ASR-0014 / `ops/oo-clients-contacts-sync.md`
|
||||
Reference in New Issue
Block a user