API kanoniczne — system księgowy i obieg dokumentów, WMS, HR, ESM
Wszystkie zasoby kanoniczne w tym przewodniku należą do standardu Kamsoft.FAIR (Fast Adaptive Interoperable Resources). FAIR to zestaw modeli zaprojektowanych pod szybką adaptację i interoperacyjność między systemami (ERP, WMS, HR, FK). Specyfikacje API oparte na modelu kanonicznym API.ERP zastępują wcześniejsze modele wyspecyfikowane w katalogu EOD. Pliki OpenAPI 3.0 definiują zasoby i ścieżki w sposób ujednolicony (Identifier, CodeableConcept, Reference). Szczegóły standardu: Standard Kamsoft.FAIR.
Źródła: kompletne API w Portalu dla Integratorów (APIM) — https://api-integrators-partners.developer.azure-api.net/; pliki OpenAPI w katalogu docs/openapi/ (YAML w repozytorium). Link: Specyfikacje OpenAPI (YAML).
| Plik | Zakres | Zasoby |
|---|---|---|
| API-ERP-Canonical-EOD.yaml (docs/openapi/) | System księgowy i obieg dokumentów (FK) — klientem API może być dowolny system | Party, BankAccount, Document (bufor obiegu, dekret), Invoice (faktura), Register, AccountingVariant, CostCarrier, CostAssignment |
| API-ERP-Canonical-WMS.yaml (docs/openapi/) | WMS — obieg magazynowy | Party, Location, ProductDefinition, Inventory, InventoryDocument (dokument ruchu – PZ, WZ, przesunięcie, korekta), Document (zapotrzebowania) |
| API-ERP-Canonical-HR.yaml (docs/openapi/) | HR — kadry | Party, PartyRole, Employment, Position, OrganizationUnit, OrganizationAssignment, Capability, GrantAssignment |
| API-ERP-Canonical-ESM.yaml (planowane) | ESM — srodki trwale i dokumenty ruchu majatku | FixedAsset, AssetComponent, FixedAssetAllocation, FixedAssetDocument |
Wspólna konwencja: ścieżki /v1/..., nagłówki ks-system-identification, parametr zapytania company (NIP), paginacja _count / _offset, błędy RFC 7807 (ProblemDetails).
Opis modeli (struktura pól, typy, zastosowanie): w menu — Standard Kamsoft.FAIR (lista zasobów i typów danych oraz Przykłady).
Mapowanie domena → Resources → OpenAPI
Jedna domena kanoniczna = jeden katalog zasobów pod docs/Resources/ + jeden plik OpenAPI w docs/openapi/.
| Domena | Katalog Resources | Plik OpenAPI |
|---|---|---|
| FK (EOD) — system księgowy i obieg dokumentów | Resources/FK (Faktura + Księgowanie) | API-ERP-Canonical-EOD.yaml (docs/openapi/) |
| WMS — obieg magazynowy | Resources/WMS | API-ERP-Canonical-WMS.yaml (docs/openapi/) |
| HR — kadry i płace | Resources/HR | API-ERP-Canonical-HR.yaml (docs/openapi/) |
| ESM — srodki trwale | Resources/ESM | API-ERP-Canonical-ESM.yaml (planowane) |
Zasoby współdzielone (Party, Document, BankAccount, Location, ProductDefinition itd.) znajdują się w korzeniu Resources; typy danych w Resources/DataTypes.
Ten przewodnik obejmuje wyłącznie modele kanoniczne API.ERP.
System księgowy i obieg dokumentów (FK)
API kanoniczne dla systemu księgowego i obiegu dokumentów. Źródło danych: system księgowy / obieg; klientem może być dowolny system (EOD, WMS, CRM, BI itd.).
- Ścieżki:
/v1/parties,/v1/bank-accounts,/v1/documents(bufor obiegu, dekret – nie faktury),/v1/invoices(faktury),/v1/documents-changed-status,/v1/registers,/v1/accounting-variants,/v1/cost-carriers,/v1/cost-assignments - Modele: Party (kontrahenci), BankAccount, Document (bufor dokumentów, dekret), Invoice + InvoicePosition (faktura), Register, AccountingVariant, CostCarrier, CostAssignment
- Szczegóły: API-ERP-Canonical-EOD.yaml (docs/openapi/) (OpenAPI 3.0).
Canonical WMS (obieg magazynowy)
- Ścieżki:
/v1/parties,/v1/locations,/v1/product-definitions,/v1/inventories,/v1/inventory-documents(dokumenty ruchu – PZ, WZ, przesunięcie, korekta),/v1/documents(zapotrzebowania, integracja) - Modele: Party (np. magazyny), Location, ProductDefinition, Inventory, InventoryDocument (kanoniczny dokument ruchu; movementType: receipt, issue, transfer, adjustment), InventoryDocumentPosition, Document (tylko zapotrzebowania, integracja z obiegiem dokumentów – nie ruch magazynowy)
- Szczegóły: API-ERP-Canonical-WMS.yaml (docs/openapi/) (OpenAPI 3.0). Opisy: Resources/WMS.
Canonical HR (kadry i płace)
- Ścieżki:
/v1/parties,/v1/party-roles,/v1/employments,/v1/positions,/v1/organization-units,/v1/organization-assignments,/v1/capabilities,/v1/grant-assignments - Modele: Party, PartyRole (employer, employee, manager), Employment, Position, OrganizationUnit, OrganizationAssignment, Capability, GrantAssignment
- Szczegóły: API-ERP-Canonical-HR.yaml (docs/openapi/) (OpenAPI 3.0). Opisy zasobów HR w Resources/HR.
Canonical ESM (srodki trwale)
- Sciezki planowane:
/v1/fixed-assets,/v1/asset-components,/v1/fixed-asset-allocations,/v1/fixed-asset-documents - Modele: FixedAsset (kartoteka srodka), AssetComponent (komponent), FixedAssetAllocation (alokacje lokalizacji, MPK i odpowiedzialnosci), FixedAssetDocument (dokument ruchu majatku z integracja workflow)
- Szczegoly: dokumentacja zasobow w Resources/ESM. Specyfikacja OpenAPI dla ESM pozostaje do dodania jako osobny plik.