JournalEntry
JournalEntry to kanoniczny zasób zaksięgowanego dekretu, materializowany na podstawie PostingInstruction. Reprezentuje wynik księgowania dokumentu wraz z pozycjami dekretu.
Rozszerza DomainResource.
1. Zakres i granica odpowiedzialności
| Aspekt | Opis |
|---|---|
| JournalEntry | Zaksięgowany dekret dokumentu (nagłówek dekretu + pozycje). |
| PostingInstruction | Źródło danych wejściowych do wygenerowania dekretu. |
| JournalEntryPosition | Pozycje dekretu z kontem księgowym, stroną zapisu i kwotami. |
W odczycie każdy wiersz dekretu jest zwracany jako osobny JournalEntry z jedną pozycją; positionNo numeruje wiersze kolejno w obrębie odpowiedzi.
2. Pola nagłówka
Poza polami z DomainResource (id, resourceType, meta, owner[], comment, category[], status, type, contained[], attribute[]):
| Nazwa | Kard. | Typ | Opis |
|---|---|---|---|
| identifier | 0..* | Identifier | Identyfikatory dekretu. |
| postingInstruction | 1..1 | Reference(PostingInstruction) | Instrukcja księgowania, z której powstał dekret; identifier typu eod-id w przestrzeni PostingInstruction.Id. |
| accountingDate | 1..1 | date | Data księgowania. |
| description | 0..1 | string | Opis nagłówka dekretu. |
| position | 0..* | JournalEntryPosition | Pozycje dekretu. |
3. JournalEntryPosition (zagnieżdżony)
| Nazwa | Kard. | Typ | Opis |
|---|---|---|---|
| positionNo | 1..1 | integer | Numer pozycji dekretu (>= 1). |
| description | 0..1 | string | Opis pozycji dekretu. |
| symbol | 0..1 | CodeableConcept | Symbol pozycji dekretu; system finance/journal-entry-position-symbol — kody nadaje wdrożenie. |
| debitAccount | 0..1 | Reference | Konto księgi debetowej (Wn): identifier.value = numer konta w wewnętrznej przestrzeni kont księgowych, display = nazwa konta. |
| creditAccount | 0..1 | Reference | Konto księgi kredytowej (Ma); jak wyżej. |
| amount | 1..1 | Money | Kwota pozycji dekretu (w odczycie w PLN). |
| foreignAmount | 0..1 | Money | Kwota w walucie obcej, jeśli zapis źródłowo dotyczy innej waluty. |
| exchangeRate | 0..1 | decimal | Kurs użyty do przeliczenia waluty obcej na PLN. |
| decreePosition | 1..1 | integer | Pozycja dekretu w obrębie dokumentu. |
4. Operacje
| Metoda | Ścieżka | Opis |
|---|---|---|
| GET | /v1/journal-entries |
Dekrety dokumentu (tylko odczyt) |
Odpowiedź: { "items": [...], "nextToken": null }; paginacja count (domyślnie 20) i offset (domyślnie 0).
| Parametr | Wymagany | Format | Opis |
|---|---|---|---|
postingInstruction |
tak | system\|value |
Id instrukcji księgowania w przestrzeni PostingInstruction.Id |
symbol |
nie | system\|value |
Symbol dokumentu: https://api-erp.kamsoft.pl/vs/finance/posting-instruction-symbol\|<symbol> |
owner |
nie | system\|value |
Firma po NIP: https://gov.pl/nip\|<NIP> |
Błędny format parametru → 400 Problem Details (type = https://httpstatuses.com/400).
5. Relacje
- PostingInstruction - źródło dekretu (
postingInstruction). - JournalEntryPosition - pozycje należące do dekretu (
position[]). - Konta księgowe wskazane na poziomie pozycji (
debitAccount,creditAccount) są referencjami po numerze konta; nie ma osobnego zasobu konta.