Register
Register (rejestr księgowy) to zasób kanoniczny opisujący rejestr księgowy w obrębie organizacji. Służy do grupowania dokumentów i powiązania ich z dopuszczalnymi wariantami dekretacji dla nagłówka oraz pozycji dokumentu.
Rozszerza DomainResource.
1. Zakres i zastosowanie
Register reprezentuje słownik rejestrów księgowych (np. zakupu, sprzedaży, kosztowy, magazynowy) i pozwala jednoznacznie określić, jakie warianty dekretacji są dopuszczone:
- dla nagłówka dokumentu,
- dla pozycji dokumentu.
Zasób może być wykorzystywany przez procesy tworzenia dokumentów i walidacji dekretacji.
2. Zawartość (struktura)
Poza polami z DomainResource (id, resourceType, meta, owner[], comment, category[], status, type, contained[], attribute[]):
| Nazwa | Kard. | Typ | Opis |
|---|---|---|---|
| identifier | 0..* | Identifier | Identyfikatory rejestru |
| symbol | 1..1 | string | Symbol rejestru w obrębie firmy |
| documentHeaderAccountingVariant | 0..* | Reference(AccountingVariant) | Warianty dekretacji dopuszczone dla nagłówka dokumentu |
| documentItemAccountingVariant | 0..* | Reference(AccountingVariant) | Warianty dekretacji dopuszczone dla pozycji dokumentu |
2a. Identyfikatory
| Przestrzeń (klucz) | Znaczenie | Klucz referencyjny | Skąd system |
|---|---|---|---|
GlRegister.Id |
Id rejestru księgowego | tak | NamingSystem; urn:oid:1.2.616.1.113769.4.<instalacja>.83 |
Referencje do wariantów (documentHeaderAccountingVariant, documentItemAccountingVariant) niosą identifier w przestrzeni AccountingVariant.Id — zob. AccountingVariant.
3. Operacje
| Metoda | Ścieżka | Opis |
|---|---|---|
| GET | /v1/registers |
Wyszukiwanie rejestrów (tylko odczyt) |
Odpowiedź: { "items": [...], "nextToken": null }; paginacja count (domyślnie 20) i offset (domyślnie 0).
| Parametr | Wymagany | Format | Opis |
|---|---|---|---|
identifier |
nie | system\|value |
Id rejestru w przestrzeni Register.Id; podany — zwraca jeden element |
symbol |
nie | string | Symbol rejestru |
owner |
nie | system\|value |
Firma po NIP: https://gov.pl/nip\|<NIP> |
Błędny format parametru → 400 Problem Details (type = https://httpstatuses.com/400).
4. Relacje
- PostingInstruction wskazuje Register polem
registerprzy przekazywaniu dokumentu do księgowania. - AccountingVariant jest używany do walidacji dopuszczalnych grup rozksięgowań dla nagłówka i pozycji.