Przejdź do treści

FormulaComponent

FormulaComponent (składnik formuły) to zasób kanoniczny reprezentujący element drzewa formuły księgowej w obrębie firmy. Umożliwia modelowanie struktury hierarchicznej (rodzic-dziecko), aktywności składnika i okresu obowiązywania.

Rozszerza DomainResource.

1. Zakres i zastosowanie

FormulaComponent służy do opisu składowych formuł księgowych (np. KO, KR, SB), które są wykorzystywane podczas dekretacji i wyliczeń księgowych — w PostingInstruction alokacja pozycji wskazuje składnik przez position[].allocation.formulaComponent.

Obiekt zawiera:

  • identyfikatory składnika (identifier),
  • numer i nazwę (number, name),
  • relację do składnika nadrzędnego (partOf),
  • poziom zagłębienia (level) oraz znacznik końca gałęzi (isLast),
  • lata obowiązywania (startingYear, endingYear),
  • rodzaj formuły (type) i aktywność (status) — pola dziedziczone z DomainResource.

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 składnika formuły
number 0..1 string Numer składnika formuły
name 0..1 string Nazwa składnika formuły
partOf 0..1 Reference(FormulaComponent) Nadrzędny składnik formuły — kolejny poziom formuły; referencja przez identifier w przestrzeni FormulaComponent.Id
level 0..1 integer Poziom w hierarchii
isLast 0..1 boolean Ostatni w gałęzi
startingYear 0..1 integer Rok początkowy
endingYear 0..1 integer Rok końcowy

2a. Identyfikatory

Rodzaj identyfikatora niesie Identifier.system; wartość przestrzeni wynika z instalacji (NamingSystem) — zob. Identyfikacja i parametry wdrożenia oraz Identifier.

Przestrzeń (klucz) Znaczenie Klucz referencyjny Skąd system
FormulaComponent.Id Id składnika formuły tak NamingSystem; urn:oid:1.2.616.1.113769.4.<instalacja>.71

Numer składnika (np. kod KO, KR, SB) jest odrębnym polem number, nie identyfikatorem.

2b. Systemy kodowania (value sety)

Value sety pól kodowanych FormulaComponent — pola status i type dziedziczone z DomainResource (rejestr: Systemy kodowania i value sety).

Pole Value set Kody
status finance/formula-component-status active, inactive
type (parametr wyszukiwania) finance/formula-type KO, KR, SB, SO, SP
type (w odczycie) finance/formula-component-type kod rodzaju formuły z systemu księgowego (te same wartości co wyżej)

3. Operacje

Metoda Ścieżka Opis
GET /v1/formula-components Wyszukiwanie składników formuł (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 składnika w przestrzeni FormulaComponent.Id (wartość liczbowa); zawęża wynik do jednego elementu
type nie system\|value Rodzaj formuły: https://api-erp.kamsoft.pl/vs/finance/formula-type\|KO
owner nie system\|value Firma po NIP: https://gov.pl/nip\|<NIP>
attribute nie code\|value year\|<rok> — rok obowiązywania
lastModified nie date-time Składniki zmienione po podanej chwili

Błędny format parametru → 400 Problem Details (type = https://httpstatuses.com/400).

4. Odniesienia