Przejdź do treści

Profile kanoniczne

Ta część przewodnika zbiera to, jak opisujemy zasoby kanoniczne w praktyce: które pola są obowiązkowe, jak wygląda struktura w JSON oraz — tam, gdzie to ma sens — jak pole łączy się z listą dozwolonych kodów (ValueSet). Chodzi o czytelny, wspólny opis ograniczeń i powiązań z listami kodów — wyłącznie w kontekście API.ERP i standardu Kamsoft.FAIR.

Pliki JSON poniżej to podgląd z aktualnej wersji modeli kanonicznych opisanych w tym Implementation Guide — pola i kardynalności są z nimi spójne. Integrator stosuje dostarczony zestaw plików z tej samej wersji IG i API co używane kontrakty (OpenAPI, JSON Schema); nie edytuj ich ręcznie — modyfikacje po stronie integratora nie stanowią części kontraktu z operatorem API.

Profile w formacie JSON

Zasób Więcej o modelu Wygenerowany profil (JSON)
AccountingVariant Wariant księgowy AccountingVariant.profile.json
AllocationItem (alokacja na pozycji dokumentu) Pozycja dokumentu AllocationItem.profile.json
AllocationWeight (waga w AllocationItem) Pozycja dokumentu AllocationWeight.profile.json
AssetComponent Składowa majątku AssetComponent.profile.json
Attribute (atrybut zagnieżdżony) Attribute Attribute.profile.json
BankAccount Rachunek bankowy BankAccount.profile.json
Capability Zdolność (Capability) Capability.profile.json
CostAssignment Przypisanie kosztów CostAssignment.profile.json
CostAssignmentPosition (wewnątrz przypisania) Przypisanie kosztów CostAssignmentPosition.profile.json
CostCarrier Nośnik kosztów CostCarrier.profile.json
CostCenter Centrum kosztów CostCenter.profile.json
DeliveryScheduleLine (harmonogram w pozycji ZZ) Zamówienie zakupu DeliveryScheduleLine.profile.json
Document Dokument Document.profile.json
DocumentPosition Pozycja dokumentu DocumentPosition.profile.json
EmployeeProfessionalGroup Przypisanie do grupy zawodowej EmployeeProfessionalGroup.profile.json
Employment Zatrudnienie Employment.profile.json
EmploymentPosition (wewnątrz Employment) Zatrudnienie EmploymentPosition.profile.json
FixedAsset Środek trwały FixedAsset.profile.json
FixedAssetAllocation Alokacja ŚT FixedAssetAllocation.profile.json
FixedAssetDocument Dokument ŚT FixedAssetDocument.profile.json
FixedAssetDocumentPosition (wewnątrz dokumentu ŚT) Dokument ŚT FixedAssetDocumentPosition.profile.json
FormulaComponent Składnik formuły FormulaComponent.profile.json
GrantAssignment Przyznanie uprawnienia GrantAssignment.profile.json
InventoryDocument Dokument magazynowy InventoryDocument.profile.json
InventoryDocumentPosition Pozycja dokumentu magazynowego InventoryDocumentPosition.profile.json
Invoice Faktura i pozycje w kanonie Invoice.profile.json
InvoicePosition (wewnątrz faktury) Ten sam rozdział InvoicePosition.profile.json
Location Lokalizacja Location.profile.json
OrganizationAssignment Przypisanie do jednostki OrganizationAssignment.profile.json
OrganizationUnit Jednostka organizacyjna OrganizationUnit.profile.json
Party Strona (Party) Party.profile.json
PartyRelationship Relacja stron PartyRelationship.profile.json
PartyRole Rola strony PartyRole.profile.json
Payment Płatność Payment.profile.json
Position Stanowisko Position.profile.json
PostingInstruction Instrukcja dekretacji faktury PostingInstruction.profile.json
PostingInstructionLine (wewnątrz instrukcji) Ten sam rozdział PostingInstructionLine.profile.json
Product Produkt (instancja) Product.profile.json
ProductDefinition Definicja produktu ProductDefinition.profile.json
ProfessionalGroup Grupa zawodowa ProfessionalGroup.profile.json
PurchaseOrder Zamówienie zakupu PurchaseOrder.profile.json
PurchaseOrderPosition (wewnątrz ZZ) Zamówienie zakupu PurchaseOrderPosition.profile.json
Qualification Kwalifikacja Qualification.profile.json
Register Rejestr księgowy Register.profile.json
ValueItem (wartości w pozycjach / atrybutach) Pozycja dokumentu ValueItem.profile.json
ValueSet ValueSet ValueSet.profile.json

Jak czytać te pliki

  • Ścieżki pól odpowiadają nazwom z kontraktu API (OpenAPI / JSON Schema w kanonie EOD), np. kolekcja pozycji faktury to ścieżka w stylu Invoice.lines, zgodnie z publikowanym kontraktem (bez aliasów spoza API).
  • Dla pól opartych o CodeableConcept w profilu pojawi się powiązanie z ValueSet: identyfikator url jest ten sam, co w artefaktach IG i w rozdziale o systemach kodów.
  • W JSON profilu pole binding podaje tylko identyfikator ValueSet (valueSet jako URI). Pola dodatkowe (np. siła wymuszenia listy kodów) nie występują w tym artefakcie — ewentualne wymagania dodatkowe są w kontrakcie API dla wybranej wersji.