Przejdź do treści

Systemy kodowania i value sety

W Implementation Guide wszystkie pola typu CodeableConcept oraz typ identyfikatora w Identifier używają systemów kodowania w przestrzeni nazw platformy: https://api-erp.kamsoft.pl/vs/. Poniżej rejestr słowników i kody opublikowane w ich plikach JSON.

Code system a value set:
Code system (system kodowania) określa przestrzeń nazw (URL) i pełny zestaw kodów z definicjami (np. document-type, document-position-type). Value set (zbiór wartości) doprecyzowuje ten system w danym kontekście: wybiera dopuszczalne kody dla konkretnego pola, zasobu lub profilu (np. typy dokumentu dozwolone w księgowości, typy pozycji dokumentu magazynowego). W poniższych sekcjach: §1 — rejestr słowników, §2 — kody w słownikach (przepisane z plików JSON), §2a — value sety kontekstowe.


1. Systemy kodowania (Code Systems)

Każdy słownik ma kanoniczny URL w przestrzeni https://api-erp.kamsoft.pl/vs/. URL przyjmuje jedną z dwóch postaci: https://api-erp.kamsoft.pl/vs/<slug> (słownik wspólny) albo https://api-erp.kamsoft.pl/vs/<obszar>/<slug>, gdzie <obszar> to obszar domenowy: finance (księgowość), warehouse (magazyn), assets (majątek), hr (kadry), retail (sprzedaż detaliczna) (np. https://api-erp.kamsoft.pl/vs/assets/fixed-asset-status). Ten sam słownik może występować w kilku wariantach domenowych; każdy wariant ma własny URL, własny plik JSON i własną listę kodów.

Słowniki są publikowane w tym przewodniku pod adresem /vs/<obszar>/<slug>.json (kolumna „JSON” w tabeli). Kanoniczny URL słownika to pole url w jego pliku JSON. Dla słownika dostępnego w kilku wariantach kolumna „JSON” zawiera osobny link per wariant. Słowniki oznaczone „— (bez pliku)” mają zarejestrowany adres, ale ich treść nie jest opublikowana w tym przewodniku. Słowniki oznaczone „wdrożeniowy” mają stały URL, a treść per instalacja pobiera się przez GET /v1/value-sets?url=<url>. Wcześniejsza konwencja vs/valueset/<Name> jest wycofana.

Słownik Użycie Zasoby / kontekst JSON
address-component-type Składnik adresu (country, province, district, commune, street, building-number, flat-number, locality, postal-code, TERYT-code) Address.component JSON
address-type Typ adresu (permanent, temporary, mailing) Address.type JSON
address-use Zastosowanie adresu; wersja 1.0.0 nie publikuje kodów Address.use JSON
allocation-item-category Kategoria pozycji alokacji kosztów AllocationItem — (bez pliku; warianty assets/, finance/)
allocation-item-code Kod pozycji alokacji kosztów AllocationItem — (bez pliku; warianty assets/, finance/)
allocation-item-type Typ pozycji alokacji kosztów AllocationItem — (bez pliku; warianty assets/, finance/)
allocation-type Rodzaj alokacji kwoty (KO, KR, SB, SO, SP) AllocationItem, valueAllocation finance
asset-component-attribute-type Rodzaj atrybutu składnika majątku (schema) AssetComponent.attribute assets
asset-component-status Status składnika majątku (active, inactive) AssetComponent.status assets
asset-kind Rodzaj majątku — słownik wdrożeniowy FixedAsset, AssetComponent — (wdrożeniowy; vs/asset-kind, warianty assets/, finance/, warehouse/)
asset-type Typ majątku (fixed, intangible, equipment) FixedAsset.type assets
attachment-attribute-type Rodzaj atrybutu załącznika (regon, city) Attachment.attribute hr
bank-account-category Kategoria rachunku bankowego BankAccount — (bez pliku; finance/)
bank-account-currency Waluta rachunku bankowego BankAccount — (bez pliku; finance/)
bank-account-status Status rachunku bankowego (active, inactive) BankAccount.status finance
bank-account-type Typ rachunku bankowego BankAccount — (bez pliku; finance/)
capability-type Typ uprawnienia (admin, access) Capability.type hr
contact-point-system Kanał kontaktu (Telefon, Fax, E-mail, WWW); w ContactPoint.system przekazywany jako kod tekstowy ContactPoint.system assets · finance
cost-assignment-position-category Kategoria pozycji przypisania kosztu CostAssignmentPosition — (bez pliku; finance/)
cost-assignment-position-type Typ pozycji przypisania kosztu (allocation) CostAssignmentPosition.type finance
cost-carrier-attribute-type Rodzaj atrybutu nośnika kosztów CostCarrier.attribute — (bez pliku; finance/)
cost-carrier-category Kategoria nośnika kosztów CostCarrier.category — (bez pliku; finance/)
cost-carrier-type Typ nośnika kosztów CostCarrier.type — (bez pliku; finance/)
cost-center-attribute-type Rodzaj atrybutu ośrodka kosztów (schema) CostCenter.attribute assets
document-attribute-type Rodzaj atrybutu dokumentu (Attribute.code); kody per wariant w §2 DocumentReference.attribute, PostingInstruction, Invoice finance · hr · warehouse
document-category Kategoria dokumentu; hr-inbox-document i warehouse-document rozpoznają profil DocumentReference DocumentReference.category finance · hr · warehouse
document-position-category Kategoria pozycji dokumentu DocumentPosition — (bez pliku; warianty assets/, finance/, warehouse/)
document-position-code Kod pozycji dokumentu magazynowego (order-line, vat-summary-line, goods-receipt-line, goods-issue-line) DocumentPosition.code warehouse
document-position-status Status pozycji dokumentu (buffer, not-buffer) DocumentPosition.status warehouse
document-position-type Rodzaj pozycji dokumentu (DocumentPosition.code); kody per wariant w §2 DocumentPosition.code finance · warehouse
document-position-value Rodzaj ceny odniesienia pozycji (net-value, gross-value) DocumentPosition warehouse
document-space Przestrzeń dokumentu (hr-inbox) DocumentReference.space hr
document-status Status dokumentu; kody per wariant w §2 DocumentReference.status finance · hr · warehouse
document-type Typ dokumentu; kody per wariant w §2 (wariant hr bez opublikowanych kodów) DocumentReference.type finance · hr · warehouse
employment-kind Rodzaj umowy (employment-contract, commission-agreement, contract-for-specific-work, management-contract…) Employment.kind hr
employment-type Typ zatrudnienia — słownik wdrożeniowy Employment.type — (wdrożeniowy; vs/employment-type, wariant hr/)
fixed-asset-allocation-attribute-type Rodzaj atrybutu alokacji środka trwałego (schema) FixedAssetAllocation.attribute assets
fixed-asset-allocation-category Kategoria alokacji środka trwałego (fixed-asset-location, fixed-asset-cost-center, fixed-asset-party, location-cost-center, location-party); parametr category w GET /v1/fixed-asset-allocations FixedAssetAllocation.category assets
fixed-asset-allocation-dimension Wymiar przypisania środka trwałego (location, responsible-party, cost-center) FixedAssetAllocation.dimension assets
fixed-asset-allocation-type Typ alokacji środka trwałego FixedAssetAllocation — (bez pliku; assets/)
fixed-asset-attribute-type Rodzaj atrybutu kartoteki środka trwałego (schema, price) FixedAsset.attribute assets
fixed-asset-category Kategoria środka trwałego FixedAsset.category — (bez pliku; assets/)
fixed-asset-deprecation-type Metoda amortyzacji (linear, linear-accelerated, linear-decelerated, declining, one-time, none) FixedAsset.depreciationTypeBalance, depreciationTypeTax assets
fixed-asset-deprecation-type-balance Metoda amortyzacji bilansowej FixedAsset — (bez pliku; assets/)
fixed-asset-deprecation-type-tax Metoda amortyzacji podatkowej FixedAsset — (bez pliku; assets/)
fixed-asset-document-attribute-type Rodzaj atrybutu dokumentu ruchu majątku (schema) FixedAssetDocument.attribute assets
fixed-asset-document-position-category Kategoria pozycji dokumentu ruchu majątku FixedAssetDocumentPosition — (bez pliku; assets/)
fixed-asset-document-position-type Typ pozycji dokumentu ruchu majątku FixedAssetDocumentPosition — (bez pliku; assets/)
fixed-asset-document-position-value Rodzaj wartości pozycji dokumentu ruchu majątku FixedAssetDocumentPosition — (bez pliku; assets/)
fixed-asset-document-status Status dokumentu ruchu majątku (open, closed, posted) FixedAssetDocument.status assets
fixed-asset-document-symbol Symbol dokumentu ruchu majątku FixedAssetDocument — (bez pliku; assets/)
fixed-asset-document-type Typ dokumentu ruchu majątku (acceptance, write-off, liquidation, sale, purchase, production, location-change, value-change, component-transfer, inventory) FixedAssetDocument.type assets
fixed-asset-status Status środka trwałego (accepted, investment, depreciated, sold, liquidated) FixedAsset.status assets
fixed-asset-type Rodzaj środka trwałego FixedAsset — (bez pliku; assets/)
formula-component-status Status składnika formuły (active, inactive) FormulaComponent.status finance
formula-type Typ formuły (KO, KR, SB, SO, SP) FormulaComponent.type finance
grant-assignment-attribute-type Rodzaj atrybutu nadania uprawnienia GrantAssignment.attribute — (bez pliku; hr/)
hr-inbox-document-type Typ dokumentu skrzynki kadrowej — słownik wdrożeniowy DocumentReference (HrInboxDocument) — (wdrożeniowy; vs/hr-inbox-document-type, wariant hr/)
inventory-document-attribute-status Status dokumentu magazynowego jako atrybut (buffer, not-buffer) InventoryDocument.attribute warehouse
inventory-document-attribute-type Rodzaj atrybutu dokumentu magazynowego i jego pozycji (receipt-date, is-correction, vat-rate, total-net, total-vat, total-gross, pay-amount, payment-method, sale-date, due-date, remark, expected-date, realization-date, warehouse-id…) InventoryDocument, InventoryDocumentPosition warehouse
inventory-document-movement-type Typ ruchu magazynowego (receipt, issue, transfer, adjustment, production, reservation, queue, proforma, collective, inventory-diff) InventoryDocument.movementType warehouse
inventory-document-position-status Status pozycji dokumentu magazynowego (buffer, not-buffer) InventoryDocumentPosition.status warehouse
inventory-document-status Status dokumentu magazynowego; wersja 1.0.0 nie publikuje kodów InventoryDocument.status warehouse
inventory-document-type Typ dokumentu magazynowego (receipt, issue, movement, production, reservation, queue, profora, collective, inventorydiff); parametr type w GET /v1/inventory-documents InventoryDocument.type warehouse
inventory-movement-type Typ ruchu magazynowego (wariant historyczny) InventoryDocument — (bez pliku; warehouse/)
invoice-category Kategoria faktury (consolidated-document, invoice); parametr category w GET /v1/invoices Invoice.category warehouse
invoice-payment-method Forma płatności faktury (cash, bank-transfer, inne) Invoice.paymentMethod warehouse
invoice-position-type Typ pozycji faktury InvoicePosition — (bez pliku; warehouse/)
invoice-position-vat-rate Stawka VAT pozycji faktury (0, 5, 8, 23, zw) InvoicePosition warehouse
invoice-status Status faktury; wersja 1.0.0 nie publikuje kodów Invoice.status warehouse
invoice-type Typ faktury (invoice) Invoice.type warehouse
location-attribute-type Rodzaj atrybutu lokalizacji (assets: schema; warehouse: warehouse-account-fk, is-accounting, zsmopl) Location.attribute assets · warehouse
location-category Kategoria lokalizacji (assets: usage-place; warehouse: 0–7, warehouse, storage-location); rozpoznaje profil Location Location.category assets · warehouse
location-status Status lokalizacji (active, inactive) Location.status assets
location-type Typ magazynu (0 — magazyn z lekami, 1 — bank krwi, 2 — magazyn materiałów medycznych) Location.type warehouse
medical-device-class Klasa wyrobu medycznego (I, IIa, IIb, III) ProductDefinition JSON
organization-assignment-hierarchy-level Stopień hierarchii przypisania organizacyjnego — słownik wdrożeniowy OrganizationAssignment — (wdrożeniowy; vs/organization-assignment-hierarchy-level, wariant hr/)
organization-unit-attribute-type Rodzaj atrybutu jednostki organizacyjnej (symbol, account) OrganizationUnit.attribute warehouse
organization-unit-status Status jednostki organizacyjnej (active, inactive) OrganizationUnit.status hr · warehouse
organization-unit-type Typ jednostki organizacyjnej (hr: unit; warehouse: main-warehouse, hospital-unit) OrganizationUnit.type hr · warehouse
party-attribute-type Rodzaj atrybutu strony (assets: schema, fkw-number; finance: CTKO, CEOD; warehouse: warehouse-account-fk, is-accounting, zsmopl) Party.attribute assets · finance · warehouse
party-category Kategoria strony w księgowości (person, organization) Party.category finance
party-kind Rodzaj strony — employee (pracownik), employer (pracodawca, własna organizacja), contractor (kontrahent), asset-holder (dysponent majątku). Kod kanoniczny bez wariantu domenowego, nadawany przez API.ERP w Party.category; rozpoznaje profil strony (Employee, Employer, Contractor, AssetHolder); parametr wyszukiwania kind. Party.category JSON
party-name Rodzaj nazwy strony (assets, finance: short-name, part1-name, part2-name, first-name, last-name; hr: display-name, first-name, middle-name, surname, maiden-name, tytuły; warehouse: official, upper) Party.name assets · finance · hr · warehouse
party-relationship-attribute-type Rodzaj atrybutu relacji (direct, employment-id, order-path) PartyRelationship.attribute hr
party-relationship-type Typ relacji (employer-employee, subordinate-supervisor, supervisor-subordinate); parametr type w GET /v1/party-relationships PartyRelationship.type hr
party-role Rola strony (wspólny: employee, employer, customer, supplier, payer; hr: employee, employer); parametr role w GET /v1/party-roles PartyRole.role JSON · hr
party-role-status Status roli strony (active, inactive) PartyRole.status hr
party-role-type Typ roli strony (employee, employer) PartyRole.type hr
party-status Status strony (active, inactive, deleted) Party.status JSON
party-type Typ strony (assets, hr: person, organization; finance: organization) Party.type assets · finance · hr
payment-aml-check-status Status weryfikacji AML płatności Payment — (bez pliku; finance/)
payment-attribute-type Rodzaj atrybutu płatności Payment.attribute — (bez pliku; finance/)
payment-category Kategoria płatności Payment.category — (bez pliku; finance/)
payment-method Forma płatności Payment — (bez pliku; warianty finance/, warehouse/)
payment-payment-method Metoda realizacji płatności Payment — (bez pliku; finance/)
payment-reconciliation-status Status uzgodnienia płatności Payment — (bez pliku; finance/)
payment-type Typ płatności Payment.type — (bez pliku; finance/)
posting-instruction-allocation-item-type Typ alokacji w valueAllocation pozycji (cost-type, cost-center, assets-under-construction, sale-types) PostingInstruction finance
posting-instruction-attribute-type Rodzaj atrybutu instrukcji księgowania (split-payment, ksef-acquisition-date, pz-document-number, correction-document-number, vat-date) PostingInstruction.attribute finance
posting-instruction-document-symbol-type Symbol typu dokumentu w PostingInstruction.symbol; wymagany przy POST /v1/posting-instructions PostingInstruction.symbol — (bez pliku; finance/)
posting-instruction-line-type Typ pozycji instrukcji księgowania (accounting-item, vat-summary) PostingInstruction.postingLine finance
posting-instruction-line-value-item-type Role kwot w valueItem[] linii (amount, net-amount, vat-amount, vat-amount-without-deductions, amount-not-earning-expense, description) PostingInstruction.postingLine finance
posting-instruction-participant-function Funkcja uczestnika dokumentu (seller, buyer, recipient, vat-group-member, subordinate-lgu)[^participant-function] PostingInstruction.participant finance
posting-instruction-payment-method Forma płatności instrukcji księgowania (cash, other, credit-card, transfer) PostingInstruction finance
posting-instruction-status Status instrukcji księgowania w systemie księgowym (ready-for-retrieval, retrieved, in-registration, deleted) PostingInstruction.status finance
posting-instruction-symbol Symbol dokumentu w systemie zewnętrznym; wymagany przy POST /v1/posting-instructions; wersja 1.0.0 nie publikuje kodów PostingInstruction.symbol finance
price-type Rodzaj ceny w pozycji price[] (unit, list, transactional, promotional) ProductPricing.price.type JSON
product-availability-category Kategoria dostępności leku (Rp, Rpw, Rpz, OTC, Lz) ProductDefinition JSON
product-class Klasa produktu (medication, blood-product, medical-device, ivd-medical-device, dietary-supplement, medical-food, cosmetic, biocidal-product, service, general-good). Zob. ProductDefinition — klasa produktu. ProductDefinition JSON
product-definition-attribute-type Rodzaj atrybutu definicji produktu (wspólny: unit-of-measure, vat-rate, producer, product-group, atc, pharmaceutical-form, strength…; retail: producer-country; warehouse: form, dose, package, producer, country, jednostki i mnożniki, material-type, blood-group, blood-kind, international-name, trade-name) ProductDefinition.attribute JSON · retail · warehouse
product-definition-blood-group Grupa krwi preparatu (0 — nieokreślona, 1 — 0, 2 — A, 3 — B, 4 — AB, 5 — para-Bombay, 6 — Bombay) ProductDefinition.attribute (blood-group) warehouse
product-definition-blood-kind Rodzaj krwi (0 — nieokreślony, 1 — Rh-, 2 — Rh+) ProductDefinition.attribute (blood-kind) warehouse
product-definition-category Kategoria definicji produktu (retail: catalog; warehouse: medications, materials, blood, cytostatics, nutrition); parametr category w GET /v1/product-definitions ProductDefinition.category retail · warehouse
product-definition-status Status definicji produktu (active, inactive) ProductDefinition.status warehouse
product-definition-type Typ definicji produktu (medicine, blood, material, nutrition, cytostatic) ProductDefinition.type warehouse
product-pricing-context Kontekst zestawu cen (sale, purchase, channel-retail, channel-b2b) ProductPricing.context JSON
professional-group-attribute-type Rodzaj atrybutu grupy zawodowej (professional-group-symbol) ProfessionalGroup.attribute hr
professional-group-status Status grupy zawodowej (active, inactive) ProfessionalGroup.status hr
purchase-order-attribute-type Rodzaj atrybutu zamówienia zakupu (order-fulfillment-step, warehouse) PurchaseOrder.attribute warehouse
purchase-order-position-status Status pozycji zamówienia zakupu (1 — odrzucone, 2 — przyjęte, 3 — realizacja, 4 — transport, 5 — zrealizowana) PurchaseOrderPosition.status warehouse
purchase-order-realization-step Stopień realizacji zamówienia (missing, not-fulfilled, part-fulfilled, fulfilled) PurchaseOrder.attribute (order-fulfillment-step) warehouse
purchase-order-status Status zamówienia zakupu (kody 0–13, zob. §2) PurchaseOrder.status warehouse
purchase-order-type Typ zamówienia zakupu (kody 1–8, zob. §2) PurchaseOrder.type warehouse
purchase-requisition-status Status zapotrzebowania (in-preparation/handed-over, not-delivered, accepted, completed, rejected, ordered, draft, temporary, suspended, pending-director-approval, partially-ordered, unknown) PurchaseRequisition.status warehouse
purchase-vat-deduction-type Typ odliczenia VAT przy zakupie (full-deduction, no-deduction, structured-deduction, deduction-50-percent) PostingInstruction, Invoice finance
qualification-attribute-type Rodzaj atrybutu kwalifikacji (specialty-level, is-primary, professional-license-type) Qualification.attribute hr
qualification-type Typ kwalifikacji (specialty, professional-license); parametr type w GET /v1/qualifications Qualification.type hr
resource-warning Ostrzeżenie o zasobie w meta.warning (unreconciled) Meta.warning JSON
specialty Specjalizacja — słownik wdrożeniowy Qualification — (wdrożeniowy; vs/specialty, wariant hr/)
unit-of-measure Jednostka miary — słownik wdrożeniowy (vs/unit-of-measure); opublikowane warianty: warehouse (kody numeryczne 1–66, np. 33 — szt., 19 — ml), retail (bez kodów) Quantity.unit, ValueItem retail · warehouse
value-item-quantity-type Rodzaj wartości ilościowej w valueItem ValueItem.type — (bez pliku; finance/)
value-item-type Rodzaj składnika wartości (finance: net-amount, vat-amount, vat-amount-no-deduction, cost-amount, cost-amount-not-earning-expense; warehouse: vat-rate, net-value, tax-value, gross-value, total-net, total-vat, total-gross) ValueItem.type finance · warehouse
value-item-value Wartość kodowana składnika wartości ValueItem — (bez pliku; warianty finance/, warehouse/)
vat-inclusion Czy kwota jest bez VAT (exclusive) czy z VAT (inclusive) ProductPricing, Price JSON
vat-rate Stawka VAT (wspólny: 23, 8, 5, 0, zw, np; finance: 23, 22, 8, 7, 5, 0, ZW, NP, OO) ValueItem.valueCodeableConcept, PostingInstruction JSON · finance

[^participant-function]: Plik słownika jest opublikowany, ale rejestr adresów pluginu nie ma dla niego klucza — API.ERP nie rozwiązuje tego adresu po kluczu.

Identyfikatory: Rodzaj identyfikatora niesie Identifier.system — przestrzeń, w której nadano wartość: rejestry publiczne (https://gov.pl/nip, https://gov.pl/regon, https://gov.pl/pesel, https://gov.pl/ean, https://gov.pl/eu-tax, https://ksef.podatki.gov.pl) albo przestrzeń wewnętrzna instalacji urn:oid:1.2.616.1.113769.4.<instalacja>.<klucz>, gdzie <instalacja> to gotowy prefiks instalacji przekazany przez KAMSOFT w parametrach wdrożenia, a <klucz> numer przestrzeni zasobu (klucz z tabeli „Identyfikatory" strony zasobu, np. Party.Id). Identifier.type jest opcjonalne i przyjmuje wyłącznie kody FHIR identifier-type (v2-0203, np. TAX dla NIP); IG nie definiuje własnego słownika rodzajów identyfikatorów. Faktyczne przestrzenie instalacji publikuje zasób NamingSystem (GET /v1/naming-systems: name = klucz, usage = zasób, uniqueId[].value = system, uniqueId[].preferred = klucz referencyjny) — Identyfikacja i parametry wdrożenia. Nie istnieją osobne słowniki vs/hr-employee-id, vs/company ani podobne — takie adresy nie są przestrzeniami identyfikatorów.


2. Value sety (kody z plików słowników)

Kody i opisy przepisane z opublikowanych plików JSON (wersja 1.0.0). Słownik z kilkoma wariantami domenowymi ma osobną tabelę per wariant.

document-type

finance (vs/finance/document-type)

Code Opis
invoice Invoice

hr (vs/hr/document-type) — plik bez kodów; typy dokumentów skrzynki kadrowej pochodzą ze słownika wdrożeniowego hr-inbox-document-type (GET /v1/value-sets?url=https://api-erp.kamsoft.pl/vs/hr-inbox-document-type).

warehouse (vs/warehouse/document-type)

Code Opis
1 dokument przychodowy
6 dokument zamówienia
8 dokument zapotrzebowania
10 dokument komisowy

GR / GI: przyjęcie i wydanie towaru nie są typami document-type na zasobie DocumentReference — wyłącznie InventoryDocument z movementType receipt / issue (zob. InventoryDocument).

document-category

Wariant Code Opis
finance documents-buffer Dokument w buforze
hr hr-inbox-document Dokument skrzynki HR (rozpoznaje profil HrInboxDocument)
warehouse taxrate Podsumowanie dokumentu wg stawek VAT
warehouse cost-document Podsumowanie kosztowe powiązanych dokumentów
warehouse document-attachment Załącznik dokumentu

Profil WarehouseDocument rozpoznaje kod warehouse-document w category (wymaganie profilu, schemat); wersja 1.0.0 wariantu warehouse nie publikuje tego kodu.

document-status

Wariant Code Opis
finance E w trakcie ewidencji system zewnętrzny
finance B do pobrania przez FK
finance K pobrany do FK
finance Z usunięty z FK
hr received Przyjęty
hr approved Zatwierdzony
hr rejected Odrzucony
warehouse buffer W buforze
warehouse not-buffer Przyjęty

posting-instruction-status

Używany w PostingInstruction.status (zob. PostingInstruction). System kodów: https://api-erp.kamsoft.pl/vs/finance/posting-instruction-status (JSON).

Code Opis
ready-for-retrieval Do pobrania (B)
retrieved Pobrany do FK (K)
in-registration W trakcie ewidencji (E)
deleted Usunięty z FK (Z)

posting-instruction-line-type, posting-instruction-line-value-item-type

Słownik Code Opis
line-type accounting-item Opis do dekretacji
line-type vat-summary Podsumowanie VAT
line-value-item-type amount Kwota pozycji
line-value-item-type net-amount Kwota netto
line-value-item-type vat-amount Kwota VAT
line-value-item-type vat-amount-without-deductions Kwota VAT bez odliczeń
line-value-item-type amount-not-earning-expense Kwota nie stanowiąca kosztu uzyskania przychodu
line-value-item-type description Opis pozycji

posting-instruction-allocation-item-type, posting-instruction-payment-method, posting-instruction-participant-function

Słownik Code Opis
allocation-item-type cost-type Alokacja do rodzajów kosztów KR
allocation-item-type cost-center Alokacja do ośrodków kosztów KO
allocation-item-type assets-under-construction Alokacja do środków trwałych w budowie SB
allocation-item-type sale-types Alokacja do rodzajów sprzedaży SP
payment-method cash Gotówka (G)
payment-method other Inna (I)
payment-method credit-card Karta kredytowa (K)
payment-method transfer Przelew (P)
participant-function seller Sprzedawca
participant-function buyer Nabywca
participant-function recipient Odbiorca
participant-function vat-group-member Członek grupy VAT
participant-function subordinate-lgu Jednostka podrzędna JST

inventory-document-movement-type

Używany w InventoryDocument.movementType (vs/warehouse/inventory-document-movement-type). Oznaczenia angielskie: GR (goods receipt) = receipt, GI (goods issue) = issue.

Code Opis
receipt przychód
issue rozchód
transfer MM (Przychód/Rozchód)
adjustment korekta stanu
production produkcja
reservation rezerwacja (rozchód)
queue kolejka (rozchód)
proforma proForma (rozchód)
collective zbiorczy dokument (przychód)
inventory-diff różnice remanentowe (przychód/rozchód)

inventory-document-type

Parametr type w GET /v1/inventory-documents (vs/warehouse/inventory-document-type).

Code Opis
receipt Przychód
issue Rozchód
movement MM (przychód/rozchód)
production produkcja
reservation rezerwacja
queue kolejka (rozchód)
profora ProForma (rozchód)
collective dokument zbiorczy (zbiorcza FV, zbiorcza KFV)
inventorydiff różnice remanentowe

fixed-asset-allocation-dimension

Używany w FixedAssetAllocation.dimension (JSON).

Code Opis
location Miejsce użytkowania
responsible-party Osoba odpowiedzialna
cost-center Ośrodek kosztów

Kody funding-source i business-dimension występują w opisie modelu FixedAssetAllocation, ale nie ma ich w opublikowanej wersji słownika (1.0.0).

fixed-asset-allocation-category

Parametr category w GET /v1/fixed-asset-allocations (JSON).

Code Opis
fixed-asset-location Miejsca użytkowania dla środków trwałych
fixed-asset-cost-center Ośrodki kosztów dla środków trwałych
fixed-asset-party Osoby odpowiedzialne dla środków trwałych
location-cost-center Powiązanie miejsc użytkowania z ośrodkami kosztów
location-party Powiązanie miejsc użytkowania z osobami odpowiedzialnymi

fixed-asset-status

Używany w FixedAsset.status (JSON).

Code Opis
accepted Przyjęty
investment Inwestycja
depreciated Zamortyzowany
sold Sprzedany
liquidated Zlikwidowany

asset-type

Używany w FixedAsset.type (JSON).

Code Opis
fixed Środki trwałe
intangible WNiP
equipment Wyposażenie

fixed-asset-deprecation-type

Code Opis
linear Liniowa
linear-accelerated Liniowa przyspieszona
linear-decelerated Liniowa spowolniona
declining Degresywna
one-time Jednorazowa
none Bez amortyzacji

fixed-asset-document-type

Używany w FixedAssetDocument.type (JSON).

Code Opis
acceptance Przyjęcie
write-off Odpis amortyzacyjny
liquidation Likwidacja
sale Sprzedaż
purchase Zakup
production Wytworzenie
location-change Zmiana miejsca użytkowania
value-change Zmiana wartości
component-transfer Przeniesienie komponentu
inventory Inwentaryzacja

fixed-asset-document-status

Używany w FixedAssetDocument.status (JSON).

Code Opis
open Otwarty
closed Zamknięty
posted Zaksięgowany

document-position-type

finance (vs/finance/document-position-type)[^position-type-spaces]

Code Opis
accounting-item Opis do dekretacji
vat-summary Podsumowanie VAT

warehouse (vs/warehouse/document-position-type)

Code Opis
order-line Pozycja zamówienia
vat-summary-line Podsumowanie VAT
goods-receipt-line Pozycja dostawy
goods-issue-line Pozycja wydania

[^position-type-spaces]: W opublikowanym pliku vs/finance/document-position-type.json oba kody mają spację wiodącą (" accounting-item", " vat-summary"). To defekt pliku wymagający poprawki; tu kody podano bez spacji.

Dekretacji faktury nie zapisuje się w DocumentReference.position — służy do tego wyłącznie PostingInstruction.postingLine[]. Pozycji ruchu magazynowego nie zapisuje się w DocumentReference.position — pola pozycji: InventoryDocument.position[] (InventoryDocument §2a).

document-attribute-type

Wariant Code Opis
finance payment-method Forma płatności
finance split-payment Czy split payment T/N
finance ksef-acquisition-date Data zarejestrowania w KSeF
finance accounting-variant-name Wariant dekretacji nagłówek dokumentu
finance gross-amount Suma brutto
finance net-amount Suma netto
finance vat-amount Suma VAT
finance register-symbol Symbol rejestru FK
finance sale-date Data sprzedaży
finance due-date Termin płatności
finance accounting-date Data księgowania
finance vat-date Data ujęcia w VAT
finance eod-symbol Symbol systemu który wstawił dokument
finance eod-number Numer wewnętrzny dokumentu w systemie zewnętrznym
finance ksef-number Numer w KSeF
finance symbol-type Symbol typu dokumentu w systemie zewnętrznym
hr external-system-name System zewnętrzny
hr receive-operation-comment Komentarz operacji otrzymania
hr operator-login Login operatora
hr external-document-id Identyfikator dokumentu z systemu zewnętrznego
hr processing-description Opis procesu obsługi
warehouse vat-rate Stawka VAT
warehouse net-value Wartość netto
warehouse tax-value Wartość VAT
warehouse gross-value Wartość brutto
warehouse total-net Suma netto
warehouse total-vat Suma VAT
warehouse total-gross Suma brutto
warehouse pz (bez opisu)
warehouse cost-value (bez opisu)
warehouse pz-id (bez opisu)

value-item-type

Wariant Code Opis
finance net-amount Wartość netto
finance vat-amount Wartość VAT
finance vat-amount-no-deduction Wartość VAT bez odliczeń
finance cost-amount Wartość kosztu
finance cost-amount-not-earning-expense Wartość kosztu niestanowiąca kosztu uzyskania przychodu
warehouse vat-rate Stawka VAT
warehouse net-value Wartość netto
warehouse tax-value Wartość VAT
warehouse gross-value Wartość brutto
warehouse total-net Suma netto
warehouse total-vat Suma VAT
warehouse total-gross Suma brutto

vat-rate

wspólny (vs/vat-rate)

Code Opis
23 23% (stawka podstawowa)
8 8% (obniżona)
5 5% (obniżona)
0 0% (obniżona / eksport)
zw Zwolniony
np Nie podlega

finance (vs/finance/vat-rate)

Code Opis
23 23% (stawka podstawowa)
22 22% (poprzednia stawka podstawowa)
8 8% (obniżona)
7 7% (poprzednia obniżona)
5 5% (obniżona)
0 0% (obniżona / eksport itd.)
ZW ZW zwolniony od podatku
NP NP niepodlegająca opodatkowaniu
OO OO odwrotne obciążenie

warehouse — pozycje faktury używają vs/warehouse/invoice-position-vat-rate: 0, 5, 8, 23, zw.

Kody literowe A–G z rozporządzenia MF (kasy fiskalne) nie występują w żadnym opublikowanym słowniku — zob. §4.2.

party-kind

Code Opis Profil Party
employee Pracownik Employee
employer Pracodawca Employer
contractor Kontrahent Contractor
asset-holder Dysponent majątku AssetHolder

party-type

Wariant Code Opis
assets person Osoba
assets organization Podmiot
finance organization Podmiot
hr person Osoba
hr organization Podmiot

party-category (finance)

Code Opis
person Osoba
organization Podmiot

party-name

Wariant Code Opis
assets, finance short-name Skrócona nazwa
assets, finance part1-name Pierwszy człon nazwy
assets, finance part2-name Drugi człon nazwy
assets, finance first-name Imie
assets, finance last-name Nazwisko
hr display-name Nazwa
hr first-name Imię
hr middle-name Drugie imię
hr surname Nazwisko
hr maiden-name Nazwisko rodowe
hr professional-title Tytuł zawodowy
hr professional-shorttitle Tytuł zawodowy skrócony
hr academic-title Tytuł naukowy
hr academic-shorttitle Tytuł naukowy skrócony
warehouse official Nazwa magazynu
warehouse upper Nazwa magazynu UPPER

party-status, party-role

Słownik Code Opis
party-status (wspólny) active Aktywny
party-status (wspólny) inactive Nieaktywny
party-status (wspólny) deleted Usunięty
party-role (wspólny) employee Pracownik
party-role (wspólny) employer Pracodawca
party-role (wspólny) customer Odbiorca
party-role (wspólny) supplier Dostawca
party-role (wspólny) payer Płatnik
party-role (hr) employee Pracownik
party-role (hr) employer Pracodawca

party-attribute-type

Wariant Code Opis
assets schema Schemat bazy danych
assets fkw-number Numer w systemie księgowym
finance CTKO Czy kartoteka osobowa
finance CEOD Czy kartoteka przypisana do grupy obiegu dokumentów
warehouse warehouse-account-fk Kod dla FK
warehouse is-accounting Czy magazyn jest księgowy
warehouse zsmopl Czy magazyn raportowany do MZ (ZSMOPL)

address-component-type

Code Opis
country Kraj
province Województwo
district Powiat
commune Gmina
street Ulica
building-number Numer domu
flat-number Numer lokalu
locality Miejscowość
postal-code Kod pocztowy
TERYT-code Kod TERYT

address-type

Code Opis
permanent Adres stały
temporary Adres tymczasowy
mailing Adres do korespondencji

address-use

Wersja 1.0.0 pliku vs/address-use.json nie publikuje kodów (concept: []).

contact-point-system (assets, finance)

W ContactPoint.system kod przekazywany jest jako tekst (pole typu string), bez obiektu CodeableConcept.

Code Opis
Telefon Telefon
Fax Fax
E-mail E-mail
WWW WWW

location-type (warehouse), location-category

Słownik Code Opis
location-type (warehouse) 0 magazyn z lekami
location-type (warehouse) 1 bank krwi
location-type (warehouse) 2 magazyn materiałów medycznych
location-category (assets) usage-place Miejsce użytkowania (profil UsagePlace)
location-category (warehouse) 0 nieokreślony
location-category (warehouse) 1 magazyn leków
location-category (warehouse) 2 pracownia cytostatyków
location-category (warehouse) 3 dietetyka (kuchnia)
location-category (warehouse) 4 komis
location-category (warehouse) 5 pracownia żywienia pozajelitowego
location-category (warehouse) 6 apteczka pacjenta
location-category (warehouse) 7 magazyn gospodarczy
location-category (warehouse) warehouse Magazyn (profil Warehouse)
location-category (warehouse) storage-location Miejsce składowania (profil StorageLocation)

location-attribute-type

Wariant Code Opis
assets schema Schemat bazy danych
warehouse warehouse-account-fk Kod dla FK
warehouse is-accounting Czy magazyn jest księgowy
warehouse zsmopl Czy magazyn raportowany do MZ (ZSMOPL)

cost-assignment-position-type (finance)

Code Opis
allocation Alokacja kosztu

allocation-type, formula-type (finance)

Oba słowniki mają te same kody.

Code Opis (allocation-type) Opis (formula-type)
KO Alokacja do ośrodków kosztów Formuła do ośrodków kosztów
KR Alokacja do rodzajów kosztów Formuła do rodzajów kosztów
SB Alokacja do środków trwałych w budowie Formuła do środków trwałych w budowie
SO Alokacja do rodzajów sprzedaży ogólnej Formuła do rodzajów sprzedaży ogólnej
SP Alokacja do rodzajów sprzedaży Formuła do rodzajów sprzedaży

employment-kind (hr)

Używany w Employment.kind (rodzaj umowy).

Code Opis
employment-contract Umowa o pracę
artistic-and-literary-activities Działalność artystyczna, literacka (art.13 pkt 2 ustawy)
expert-and-collection-services Czynności biegłych, inkasentów (art.13 pkt 6 ustawy)
commission-agreement Umowa zlecenia
contract-for-specific-work Umowa o dzieło
management-contract Kontrakt menedżerski (art.13 pkt 9 ustawy)
copyright-income Prawo autorskie (art.18 ustawy)
settlements-with-heirs-and-former-employees Rozliczenia ze spadkobiercami i byłymi pracownikami
supervisory-board Rady nadzorcze
other Inne
graduate-internship-agreement Umowa o praktykę absolwencką
service-contract Kontrakt na świadczenie usług

qualification-type, qualification-attribute-type (hr)

Słownik Code Opis
qualification-type specialty Specjalizacja
qualification-type professional-license Prawo wykonywania zawodu
qualification-attribute-type specialty-level Stopień specjalizacji
qualification-attribute-type is-primary Wiodąca
qualification-attribute-type professional-license-type Typ prawa

organization-unit-type, organization-unit-attribute-type

Słownik Code Opis
organization-unit-type (hr) unit Jednostka
organization-unit-type (warehouse) main-warehouse Apteka centralna
organization-unit-type (warehouse) hospital-unit Oddział szpitalny
organization-unit-attribute-type (warehouse) symbol Symbol jednostki organizacyjnej
organization-unit-attribute-type (warehouse) account Konto jednostki organizacyjnej w systemie FK

party-relationship-type, party-relationship-attribute-type (hr)

Słownik Code Opis
party-relationship-type employer-employee Pracodawca-Pracownik
party-relationship-type subordinate-supervisor Podwładny-Przełożony
party-relationship-type supervisor-subordinate Przełożony-Podwładny
party-relationship-attribute-type direct Bezpośredni
party-relationship-attribute-type employment-id Opcjonalny zakres umowy
party-relationship-attribute-type order-path Kod wyznacznika hierarchii

capability-type (hr)

Code Opis
admin Administrator
access Dostęp

purchase-order-status, purchase-order-type (warehouse)

Słownik Code Opis
purchase-order-status 0 lista braków
purchase-order-status 1 nieprzekazane
purchase-order-status 2 przekazane
purchase-order-status 3 zrealizowane
purchase-order-status 4 przekazane - odebrano listę braków
purchase-order-status 5 przekazane - rezerwacja
purchase-order-status 6 odwołane
purchase-order-status 7 w trakcie realizacji
purchase-order-status 8 w transporcie
purchase-order-status 9 odrzucone
purchase-order-status 10 zablokowane
purchase-order-status 12 wysłane do anulowania
purchase-order-status 13 anulowanie potwierdzone przez dostawcę
purchase-order-type 1 lista braków
purchase-order-type 2 zamówienie
purchase-order-type 3 zamówienie z apteki do farmanetu
purchase-order-type 4 centralna lista braków (tylko w KS-FN)
purchase-order-type 5 zamówienie centralne (tylko w KS-FN)
purchase-order-type 6 zamówienie banku krwi
purchase-order-type 7 zamówienie indywidualne elektroniczne banku krwi (e-krew)
purchase-order-type 8 zamówienie zbiorcze elektroniczne banku krwi (e-krew)

purchase-requisition-status (warehouse)

Code Opis
in-preparation/handed-over W przygotowaniu/przekazane
not-delivered Nie przekazane
accepted Przyjęte
completed Zrealizowane
rejected Odrzucone
ordered Zamówione
draft W przygotowaniu (nieukończona edycja)
temporary Tymczasowe
suspended Wstrzymane (zawieszone)
pending-director-approval Wnioskowane z zgody Dyrekcji
partially-ordered Częściowo zamówione (niektóre pozycje)
unknown Nieznany

2a. Value sety kontekstowe (doprecyzowanie systemów)

Value sety odwołują się do code systemów i zawężają dopuszczalne kody do danego kontekstu (zasób, profil, endpoint). W API.ERP rolę value setu kontekstowego pełni wariant domenowy słownika: ten sam slug, osobny URL z segmentem obszaru i własna lista kodów (§1, §2). Dawna konwencja https://api-erp.kamsoft.pl/vs/valueset/<Name> jest wycofana.

Kontekst Słownik (wariant) Dopuszczalne kody
DocumentReference.type w profilu HrInboxDocument hr-inbox-document-type (wdrożeniowy) treść z GET /v1/value-sets?url=
DocumentReference.type w profilu WarehouseDocument warehouse/document-type 1, 6, 8, 10
DocumentReference.status w profilu HrInboxDocument hr/document-status received, approved, rejected
DocumentReference.status w profilu WarehouseDocument warehouse/document-status buffer, not-buffer
DocumentPosition.code w profilu WarehouseDocument warehouse/document-position-type order-line, vat-summary-line, goods-receipt-line, goods-issue-line
PostingInstruction.postingLine[].type finance/posting-instruction-line-type accounting-item, vat-summary
PostingInstruction.postingLine[].valueItem[].type finance/posting-instruction-line-value-item-type amount, net-amount, vat-amount, vat-amount-without-deductions, amount-not-earning-expense, description
PostingInstruction.status finance/posting-instruction-status ready-for-retrieval, retrieved, in-registration, deleted
FixedAsset.status assets/fixed-asset-status accepted, investment, depreciated, sold, liquidated
FixedAsset.type assets/asset-type fixed, intangible, equipment
FixedAsset.depreciationTypeBalance, depreciationTypeTax assets/fixed-asset-deprecation-type linear, linear-accelerated, linear-decelerated, declining, one-time, none
FixedAssetAllocation.dimension assets/fixed-asset-allocation-dimension location, responsible-party, cost-center
FixedAssetDocument.type assets/fixed-asset-document-type acceptance, write-off, liquidation, sale, purchase, production, location-change, value-change, component-transfer, inventory
FixedAssetDocument.status assets/fixed-asset-document-status open, closed, posted
Party.category (profil strony) party-kind employee, employer, contractor, asset-holder
Party.type party-type (assets, hr: person, organization; finance: organization) wg wariantu
Location.category (profil lokalizacji) warehouse/location-category, assets/location-category warehouse, storage-location, usage-place
InventoryDocument.movementType warehouse/inventory-document-movement-type receipt (GR), issue (GI), transfer, adjustment, production, reservation, queue, proforma, collective, inventory-diff
Stawka VAT pozycji faktury magazynowej warehouse/invoice-position-vat-rate 0, 5, 8, 23, zw
Stawka VAT w księgowości finance/vat-rate 23, 22, 8, 7, 5, 0, ZW, NP, OO
Jednostka miary unit-of-measure (wdrożeniowy; opublikowany wariant warehouse/) kody numeryczne 1–66
oh-exam-type OID 1.2.616.1.113769.1.9 MP — profil CDA skierowania (sekcja 1, purpose.exam_type_code): 01–06 — rodzaje badania
oh-exposure-group OID 1.2.616.1.113769.1.8.1 MP — sekcja 3 (organizer CLUSTER): 01–05 — grupy czynników
oh-exposure-factor OID 1.2.616.1.113769.1.8.2 MP — sekcja 3 (observation czynnika): słownik centralny (IG: kody z przykładów v0.3; pełny katalog w master data)
oh-profile-section1-code OID 1.2.616.1.113769.5.1.1 MP — sekcja 1 (daty kontekstowe): LAST-EXAM-DATE, EXAM-VALID-UNTIL
oh-profile-section3-code OID 1.2.616.1.113769.5.1.3 MP — sekcja 3 (struktura narażeń): ALL-EXPOSURES, EXPOSURE-TIME, EXPOSURE-DESC
oh-profile-section4-code OID 1.2.616.1.113769.5.1.4 MP — sekcja 4 (badania dodatkowe): ADD-EXAMS, ADDITIONAL-EXAMS
oh-profile-section5-code OID 1.2.616.1.113769.5.1.5 MP — sekcja 5 (informacje dodatkowe): ADDITIONAL-INFO

Słowniki aktywne w danej instalacji wymienia GET /v1/value-sets (bez parametru url: lista { url, version }; z url — treść słownika) — ValueSet, Kontrakty API. Klasę słownika niesie adres: kanoniczny (bez segmentu), domenowy (z segmentem obszaru) albo wdrożeniowy (treść per instalacja). Karta GET /v1/metadata słowników nie wymienia.


3. Powiązanie z modelami

Dopuszczalne wartości w polach CodeableConcept/Identifier w poszczególnych zasobach wynikają z wariantu domenowego słownika właściwego dla profilu zasobu (zob. §2a).

  • DocumentReference, DocumentPosition, ValueItem → document-category (rozpoznanie profilu), document-type, document-status, document-attribute-type, document-position-type, value-item-type, vat-rate. Identyfikatory dokumentu: przestrzeń wewnętrzna instalacji DocumentReference.Id (urn:oid:1.2.616.1.113769.4.<instalacja>.<klucz>).
  • Party → party-kind (rozpoznanie profilu), party-type, party-category, party-status, party-name, party-attribute-type, address-component-type, address-use, address-type, contact-point-system. Identyfikatory strony: https://gov.pl/nip, https://gov.pl/regon, https://gov.pl/pesel oraz przestrzenie wewnętrzne Party.Id (osobna dla każdego profilu strony).
  • Location → location-category (rozpoznanie profilu Warehouse / StorageLocation / UsagePlace), location-type, location-status, location-attribute-type; managingParty (Reference do Party). Identyfikatory: przestrzeń wewnętrzna ResourceLocation.Id.
  • InventoryDocument → inventory-document-type, inventory-document-movement-type, inventory-document-status, inventory-document-attribute-type, inventory-document-position-status.
  • Majątek (FixedAsset, AssetComponent, FixedAssetAllocation, FixedAssetDocument, CostCenter) → fixed-asset-status, asset-type, fixed-asset-deprecation-type, fixed-asset-allocation-dimension, fixed-asset-allocation-category, fixed-asset-document-type, fixed-asset-document-status oraz słowniki atrybutów assets/*-attribute-type. Reuse: Location jako miejsce użytkowania (profil UsagePlace), Party jako dysponent majątku (profil AssetHolder). Identyfikatory: przestrzenie FixedAsset.Id, AssetComponent.Id, FixedAssetDocument.Id, CostCenter.Id oraz osobne przestrzenie numerów i kodów kreskowych.
  • Księgowość (PostingInstruction, JournalEntry, Payment, Register, AccountingVariant, CostCarrier, CostAssignment, FormulaComponent) — zasoby w Resources/FK/Accounting → posting-instruction-*, formula-type, formula-component-status, allocation-type, cost-assignment-position-type, purchase-vat-deduction-type, finance/vat-rate. Identyfikatory: przestrzenie PostingInstruction.Id, PostingInstruction.ExternalId, GlRegister.Id, AccountingVariant.Id, CostCarrier.Id, FormulaComponent.Id; numer dokumentu (https://api-erp.kamsoft.pl/vs/document-number) i numer KSeF (https://ksef.podatki.gov.pl).
  • Kadry (Employment, Position, OrganizationUnit, OrganizationAssignment, Qualification, ProfessionalGroup, EmployeeProfessionalGroup, Capability, GrantAssignment, PartyRole, PartyRelationship) → employment-kind, employment-type (wdrożeniowy), organization-unit-type, organization-unit-status, organization-assignment-hierarchy-level (wdrożeniowy), qualification-type, qualification-attribute-type, specialty (wdrożeniowy), professional-group-status, capability-type, party-role, party-role-type, party-role-status, party-relationship-type, party-relationship-attribute-type. Identyfikatory: przestrzenie Party.Id, Employment.Id, Position.Id, OrganizationUnit.Id, OrganizationAssignment.Id, Capability.Id oraz przestrzenie wdrożeniowe pozostałych zasobów kadrowych.
  • Magazyn (ProductDefinition, PurchaseOrder, PurchaseRequisition, Invoice, Inventory) → product-definition-category, product-definition-type, product-definition-status, product-definition-attribute-type, purchase-order-status, purchase-order-type, purchase-order-position-status, purchase-order-realization-step, purchase-requisition-status, invoice-category, invoice-type, invoice-payment-method, invoice-position-vat-rate, unit-of-measure. Identyfikatory: przestrzenie ProductDefinition.Id, ProductDefinition.Number, PurchaseOrder.Id, PurchaseRequisition.Id, Invoice.Id, ResourceLocation.Id oraz EAN (https://gov.pl/ean).
  • MP (e-skierowanie medycyny pracy, profil CDA) → value sety oh-exam-type, oh-exposure-group, oh-exposure-factor, oh-profile-section1-code, oh-profile-section3-code, oh-profile-section4-code, oh-profile-section5-code (OID jako codeSystem w CDA; zob. profil CDA MP). Zestawy lokalne klienta (oh-exposure-factor-client, oh-work-position) — URL stabilny, treść poza IG.

W razie rozszerzania modelu nowe kody dodaje się do odpowiedniego wariantu słownika (lub definiuje nowy słownik w przestrzeni https://api-erp.kamsoft.pl/vs/), a jego adres rejestruje w rejestrze adresów pakietu słowników.


4. Oficjalne i zewnętrzne słowniki kodowania

Dla identyfikatorów państwowych i stawek podatkowych stosuje się oficjalne źródła oraz — tam gdzie występują — oficjalne lub powszechnie przyjęte systemy (URI). Poniżej zestawienie dla Polski.

4.1 Identyfikatory podmiotów (NIP, REGON, KRS)

Identyfikator Opis Oficjalny rejestr / źródło Rekomendowany Identifier.system (URI) Uwagi
NIP Numer Identyfikacji Podatkowej (10 cyfr, ostatnia kontrolna) Ministerstwo Finansów (Biała lista VAT), GUS (wyszukiwarka REGON po NIP) https://gov.pl/nip org-id.guide: schemat PL-NIP-&lt;numer&gt;. Weryfikacja: wyszukiwarkaregon.stat.gov.pl, API Wykazu podatników VAT (gov.pl).
REGON Rejestr Gospodarki Narodowej (9 lub 14 cyfr) Główny Urząd Statystyczny (GUS) https://gov.pl/regon org-id.guide: schemat PL-REGON-&lt;numer&gt;. Weryfikacja i API: API REGON (stat.gov.pl).
KRS Krajowy Rejestr Sądowy Ministerstwo Sprawiedliwości (rejestr sądowy) urn:pl:krs Wyszukiwanie m.in. przez wyszukiwarkaregon.stat.gov.pl (po KRS).

Uwaga: NIP, REGON i KRS to polskie identyfikatory państwowe; ich przestrzeń nazw jest oddzielna od rejestrów HL7 (np. HL7 Terminology). Konwencja https://gov.pl/nip, https://gov.pl/regon i urn:pl:krs jest powszechnie stosowana w integracjach i spójna z rekomendacją używania URN dla identyfikatorów państwowych. Polska ma przypisane OID 1.2.616 (KRIO – Krajowy Rejestr Identyfikatorów Obiektów, PKN).

4.2 Stawki VAT (Polska)

Stawki VAT w Polsce wynikają z ustawy z 11 marca 2004 r. o podatku od towarów i usług oraz rozporządzeń Ministra Finansów. Oficjalne źródła:

Źródło Opis Adres
Matryca stawek VAT Wykaz stawek i zastosowań (m.in. zał. 3 i 10 do ustawy o VAT) podatki.gov.pl – Matryca stawek VAT
Lista stawek VAT Opis stawek i kategorii (SDG) podatki.gov.pl – List of VAT rates
Rozporządzenie MF – kody literowe Oznaczenia literowe stawek w kasach rejestrujących (fiskalnych) Rozporządzenie MF z 29.04.2019 r. w sprawie kas rejestrujących (Dz.U. poz. 816)

Kody literowe (rozporządzenie MF) – oficjalny słownik dla kas i systemów fiskalnych:

Litera Znaczenie Stawka / status
A Stawka podstawowa 23%
B Stawka obniżona 8%
C Stawka obniżona 5%
D Stawka obniżona 0%
E Zwolnienie od podatku zwolnienie
F, G Pozostałe (np. 0% techniczne) wg przepisów

Rekomendacja dla API-ERP:
Dla atrybutów typu „stawka VAT” stosuje się:

  • Wartość procentowa (23, 8, 5, 0) oraz kody zw, np – słownik https://api-erp.kamsoft.pl/vs/vat-rate lub jego wariant domenowy (§2), z odwołaniem do oficjalnej matrycy MF w dokumentacji.
  • Kod literowy (A–G) – w integracji z kasami fiskalnymi: oficjalne litery z rozporządzenia MF. API.ERP nie publikuje dla nich słownika; ewentualny system https://api-erp.kamsoft.pl/vs/vat-rate-fiscal z value setem AG i odniesieniem do Dz.U. 2019 poz. 816 wymaga rejestracji.

Stawki procentowe (23%, 8%, 5%, 0%) nie mają jednego oficjalnego „URI słownika” wydanego przez MF; matryca stawek VAT na podatki.gov.pl jest aktualnym wykazem zastosowań.