Overview

System

Tenant

Hosts the Tenant Management Module with API Endpoints for managing organizational units (tenants) within the system.

• Swagger UI
• OpenApi 3

Method	Path	Summary
POST	/v1/tenant/tenant	Create a new tenant
POST	/v1/tenant/tenant/query	Query tenant entities
GET	/v1/tenant/tenant/query/{page}	Get a specific page of tenant query results
GET	/v1/tenant/tenant/{entity-id}	Get detailed information for a single tenant
PUT	/v1/tenant/tenant/{entity-id}	Update an existing tenant
DELETE	/v1/tenant/tenant/{entity-id}	Delete a tenant
POST	/v1/tenant/tenant/{entity-id}/history	Query the audit history of a tenant
GET	/v1/tenant/tenant/{entity-id}/history/{page}	Get a specific page of a tenant’s audit history

User Account

Manages user accounts, providing endpoints for registration, profile management, and account status tracking.

• Swagger UI
• OpenApi 3

Method	Path	Summary
POST	/v1/user-account/user-account	Create a new user-account
POST	/v1/user-account/user-account/query	Query user-account entities
GET	/v1/user-account/user-account/query/{page}	Get a specific page of user-account query results
GET	/v1/user-account/user-account/{entity-id}	Get detailed information for a single user-account
PUT	/v1/user-account/user-account/{entity-id}	Update an existing user-account
DELETE	/v1/user-account/user-account/{entity-id}	Delete a user-account
POST	/v1/user-account/user-account/{entity-id}/history	Query the audit history of a user-account
GET	/v1/user-account/user-account/{entity-id}/history/{page}	Get a specific page of a user-account’s audit history

Agent For

Handles the associations between users and the tenants they are authorized to act upon (“Agent For” relationships).

• Swagger UI
• OpenApi 3

Method	Path	Summary
POST	/v1/agent-for/agent-for	Create a new agent-for relationship
POST	/v1/agent-for/agent-for/query	Query agent-for entities
GET	/v1/agent-for/agent-for/query/{page}	Get a specific page of query results
GET	/v1/agent-for/agent-for/{entity-id}	Get detailed information for a single relationship
PUT	/v1/agent-for/agent-for/{entity-id}	Update an existing relationship
DELETE	/v1/agent-for/agent-for/{entity-id}	Delete an agent-for relationship
POST	/v1/agent-for/agent-for/{entity-id}/history	Query the audit history of a relationship
GET	/v1/agent-for/agent-for/{entity-id}/history/{page}	Get a specific page of audit history

Invitation

Manages the lifecycle of invitations sent to potential users to join a tenant.

• Swagger UI
• OpenApi 3

Method	Path	Summary
POST	/v1/invitation/invitation	Create a new invitation
POST	/v1/invitation/invitation/query	Query invitation entities
GET	/v1/invitation/invitation/query/{page}	Get a specific page of query results
GET	/v1/invitation/invitation/{entity-id}	Get detailed information for an invitation
PUT	/v1/invitation/invitation/{entity-id}	Update an existing invitation
DELETE	/v1/invitation/invitation/{entity-id}	Revoke or delete an invitation
POST	/v1/invitation/invitation/{entity-id}/history	Query the audit history of an invitation
GET	/v1/invitation/invitation/{entity-id}/history/{page}	Get a specific page of audit history

Reference Data

Business Affiliate

Manages information about business partners, suppliers, and affiliates, including their assigned roles within the organization.

• Swagger UI
• OpenApi 3

Method	Path	Summary
POST	/v1/business-affiliate/business-affiliate	Add a new business affiliate
GET	/v1/business-affiliate/business-affiliate/{entity-id}	Get affiliate details by Entity Id
PUT	/v1/business-affiliate/business-affiliate/{entity-id}	Update affiliate information
DELETE	/v1/business-affiliate/business-affiliate/{entity-id}	Delete a business affiliate
POST	/v1/business-affiliate/business-affiliate/query	Query business affiliates
GET	/v1/business-affiliate/business-affiliate/query/{page}	Get a specific page of query results
GET	/v1/business-affiliate/business-affiliate/rid/{entity-record-id}	Get a specific record by its record Id
GET	/v1/business-affiliate/business-affiliate/with-details/{entity-id}	Get affiliate details including all enabled roles
POST	/v1/business-affiliate/business-affiliate/{entity-id}/history	Query affiliate audit history
GET	/v1/business-affiliate/business-affiliate/{entity-id}/history/{page}	Get a specific page of audit history
GET	/v1/business-affiliate/business-affiliate/{entity-id}/roles	Get all business roles associated with an affiliate
POST	/v1/business-affiliate/business-affiliate/{entity-id}/roles	Create a new business role for an affiliate
PUT	/v1/business-affiliate/business-affiliate/{entity-id}/roles/{business-role-eid}	Update an existing business role

Items

Manages the catalog of items, including their properties, supplies, and documentation (labels/breadcrumbs).

• Swagger UI
• OpenApi 3

Method	Path	Summary
POST	/v1/item/item	Add a new item
GET	/v1/item/item/{entity-id}	Get item details by Entity Id
PUT	/v1/item/item/{entity-id}	Update an existing item
DELETE	/v1/item/item/{entity-id}	Delete an item
POST	/v1/item/item/query	Query items
GET	/v1/item/item/query/{page}	Get a specific page of query results
GET	/v1/item/item/rid/{entity-record-id}	Get a specific record by its record Id
GET	/v1/item/item/{entity-id}/draft	Get the current draft for an item
PUT	/v1/item/item/{entity-id}/draft	Update the draft for an item
POST	/v1/item/item/print-label	Request label printing for a list of items
POST	/v1/item/item/print-breadcrumb	Request breadcrumb printing for a list of items
GET	/v1/item/item/{parent-item-id}/supply	Get all supplies associated with an item
POST	/v1/item/item/{parent-item-id}/supply	Add a new supply to an item
PUT	/v1/item/item/{parent-item-id}/supply/{item-supply-id}	Update an existing item supply
DELETE	/v1/item/item/{parent-item-id}/supply/{item-supply-id}	Remove a supply from an item
GET	/v1/item/lookup-suppliers	Fuzzy search for supplier names
GET	/v1/item/lookup-units	Fuzzy search for unit names
POST	/v1/item/upload-job/upload-url	Generate a URL for CSV upload
GET	/v1/item/upload-job/{job-id}	Get status of a CSV upload job

Resources

Kanban Cards

Manages Kanban cards used for inventory and process tracking, supporting a full lifecycle of events (request, accept, fulfill, use, etc.).

• Swagger UI
• OpenApi 3

Method	Path	Summary
POST	/v1/kanban/kanban-card	Add a new Kanban card
GET	/v1/kanban/kanban-card/{entity-id}	Get card details
PUT	/v1/kanban/kanban-card/{entity-id}	Update card information
DELETE	/v1/kanban/kanban-card/{entity-id}	Delete a Kanban card
POST	/v1/kanban/kanban-card/query	Query Kanban cards
GET	/v1/kanban/kanban-card/query/{page}	Get query results page
GET	/v1/kanban/kanban-card/rid/{entity-record-id}	Get specific record by ID
POST	/v1/kanban/kanban-card/details	Query cards and return extended details (including item info)
GET	/v1/kanban/kanban-card/details/{card-eid}	Get extended details for a specific card
GET	/v1/kanban/kanban-card/details/{page}	Get a page of extended details
POST	/v1/kanban/kanban-card/details/{status}	Query detailed cards filtered by status
GET	/v1/kanban/kanban-card/for-item/{item-eid}	Get all cards associated with a specific item
POST	/v1/kanban/kanban-card/summary	Get aggregated status summary of cards
POST	/v1/kanban/kanban-card/summary/requested	Get summary of cards in REQUESTED status
POST	/v1/kanban/kanban-card/summary/in-process	Get summary of cards in IN_PROCESS status
POST	/v1/kanban/kanban-card/print-card	Request printing for a list of cards
PUT	/v1/kanban/kanban-card/{card-eid}/notes	Update private notes/annotations on a card
POST	/v1/kanban/kanban-card/{card-eid}/event/request	Post a REQUEST event
POST	/v1/kanban/kanban-card/{card-eid}/event/accept	Post an ACCEPT event
POST	/v1/kanban/kanban-card/{card-eid}/event/start-processing	Post a START_PROCESSING event
POST	/v1/kanban/kanban-card/{card-eid}/event/complete-processing	Post a COMPLETE_PROCESSING event
POST	/v1/kanban/kanban-card/{card-eid}/event/fulfill	Post a FULFILL event
POST	/v1/kanban/kanban-card/{card-eid}/event/receive	Post a RECEIVE event
POST	/v1/kanban/kanban-card/{card-eid}/event/use	Post a USE event
POST	/v1/kanban/kanban-card/{card-eid}/event/deplete	Post a DEPLETE event
POST	/v1/kanban/kanban-card/{card-eid}/event/withdraw	Post a WITHDRAW event

Procurement

Orders

Manages the procurement order lifecycle, from creation (optionally from Items or Kanban cards) to submission and receiving.

• Swagger UI
• OpenApi 3

Method	Path	Summary
POST	/v1/order/order	Create a new order
GET	/v1/order/order/{entity-id}	Get header details
PUT	/v1/order/order/{entity-id}	Update order header
DELETE	/v1/order/order/{entity-id}	Delete an order
POST	/v1/order/order/query	Query orders
GET	/v1/order/order/query/{page}	Get query results page
GET	/v1/order/order/full/{entity-id}	Get full order including all line items
GET	/v1/order/order/full/rid/{entity-record-id}	Get full order by specific record ID
POST	/v1/order/order/from-items	Create a new order from a list of items
PUT	/v1/order/order/from-items/{entity-id}	Add lines to existing order from items
POST	/v1/order/order/from-kanban-cards	Create a new order from a list of Kanban cards
PUT	/v1/order/order/from-kanban-cards/{entity-id}	Add lines to existing order from Kanban cards
POST	/v1/order/order/{entity-id}/lines	Add a free-form line to an order
PUT	/v1/order/order/{entity-id}/lines/{order-line-eid}	Update an existing order line
DELETE	/v1/order/order/{entity-id}/lines/{order-line-eid}	Remove a line from an order
PUT	/v1/order/order/{entity-id}/lines/move-line/{order-line-eid}	Change the position of an order line
PUT	/v1/order/order/{entity-id}/submit	Transition order to SUBMITTED status
PUT	/v1/order/order/{entity-id}/accepted	Mark order as ACCEPTED by supplier
PUT	/v1/order/order/{entity-id}/receive	Record receiving against order lines
PUT	/v1/order/order/{entity-id}/archive	Archive a completed order
PUT	/v1/order/order/{entity-id}/annotate	Add a private note to the order
PUT	/v1/order/order/{entity-id}/annotate-line/{order-line-eid}	Add a private note to a specific line

---

Copyright: © Arda Systems 2025-2026, All rights reserved

Comments