Actions Service

Back

Overview

Actions represent tasks or activities assigned to entities (customers or suppliers). They support scheduling, tracking, and completion management.

Actions are used for:

• follow-up calls and reminders
• scheduled meetings
• task management
• activity tracking

All action operations are tenant-aware and scoped to the current tenant.

Endpoints

Back to Actions

GET

/api/v1/Actions/{id}

Returns a single action by its numeric identifier.

Route parameters:

• id (long, required) - action identifier

Behavior:

• Looks up action by ID
• Returns 404 if the action does not exist

Authorization:

• Requires Bearer Token
• Permission: FullRead

GET

/api/v1/Actions/entity/{entityId}

Returns a paginated, filterable list of actions for a specific entity.

Route parameters:

• entityId (long, required) - entity identifier

Query parameters (pagination):

• page (int, default: 1) - page number (1-based)
• pageSize (int, default: 20, max: 100) - items per page. Pass 0 to receive only totalCount with an empty items array
• sortBy (string, optional) - field to sort by: dueDate, chronologicalDate
• sortDesc (bool, default: false) - sort descending

Query parameters (filters):

• search (string, optional) - search across subject and description
• status (string, optional) - filter by computed status: scheduled, pending, overdue, completed
• showComplete (bool, default: false) - when false only incomplete actions are returned; when true completed actions are included
• actionType (long, optional) - filter by action type ID
• action (string, optional) - filter by exact action value

Behavior:

• Returns a PagedResponse<ActionModel> for the entity
• Returns 404 if no actions exist for the entity

Authorization:

• Requires Bearer Token
• Permission: FullRead

GET

/api/v1/Actions/due

Deprecated. Use GET /api/v1/Actions/entity/{entityId} with showComplete=false instead.

Returns all due actions (past due date and not completed).

Behavior:

• Returns actions where DueAt is in the past and CompletedAt is null
• Returns 404 if no due actions exist

Authorization:

• Requires Bearer Token
• Permission: FullRead

POST

/api/v1/Actions

Creates a new action.

Request body (CreateActionRequest):

• EntityId (long, required) - associated entity
• Subject (string, required) - action title
• ActionType (long, required) - action type identifier
• Description (string, optional) - detailed description
• DueAt (DateTime, optional) - due date
• Action (string, optional) - action notes
• ActionTypeTitle (string, optional) - action type display title hint

Behavior:

• CreatedAt is set automatically
• UserId is resolved from the authenticated user's JWT
• Successful creation writes an audit log entry

Errors:

• Returns 400 if validation fails

Response:

• 201 Created - ActionModel

Authorization:

• Requires Bearer Token
• Permission: FullManage

PUT

/api/v1/Actions/{id}

Partially updates an existing action. Fields not included in the request body retain their existing values.

Route parameters:

• id (long, required) - action identifier

Request body (UpdateActionRequest):

• Subject (string, optional) - falls back to existing value if not sent
• Description (string, optional)
• DueAt (DateTime, optional)
• Action (string, optional)
• CompletedAt (DateTime, optional)
• ActionType (long, optional)

Behavior:

• Only supplied fields are written; omitted fields keep their current database values
• UpdatedAt is set automatically
• Successful update writes an audit log entry

Errors:

• Returns 400 if action does not exist

Response:

• 200 OK - ActionModel

Authorization:

• Requires Bearer Token
• Permission: FullManage

PATCH

/api/v1/Actions/{id}

Marks an action as completed (sets CompletedAt to the current UTC timestamp).

Route parameters:

• id (long, required) - action identifier

Behavior:

• Sets CompletedAt to DateTime.UtcNow
• Successful operation writes an audit log entry

Errors:

• Returns 400 if action does not exist

Response:

• 200 OK - ActionModel

Authorization:

• Requires Bearer Token
• Permission: FullManage

DELETE

/api/v1/Actions/{id}

Deletes an action by its identifier.

Behavior:

• Performs a hard delete — record is permanently removed from the database
• Successful deletion writes an audit log entry

Errors:

• Returns 400 if action does not exist

Response:

• 204 No Content

Authorization:

• Requires Bearer Token
• Permission: FullManage

Notes

• Actions are linked to entities via EntityId
• UserId, UserFirstName, UserLastName are populated on responses when the action was created by a known user
• The computed Status field (read-only) reflects: Scheduled, Pending, Overdue, or Completed
• Validation is enforced in the service layer
• All state-changing operations are audited
• Internal errors are logged but not exposed to clients