API Reference

Approval Request States

post
https://app.financekey.com/OData/ApprovalRequestStates

Defines the different possible states of an approval request and the possible next steps for the state.

Body Params
string
required
length between 1 and 32

The ApprovalRequestStateId field is the primary key of the ApprovalRequestState table. It is of data type nvarchar with a maximum length of 32 characters. This field uniquely identifies each record in the table and is used to reference and link to related data in other tables. It stores the state of an approval request and is crucial in tracking the status and progress of requests within a system. This primary key field plays a critical role in maintaining the integrity and organization of data within the ApprovalRequestState table.

string
required
length ≥ 1

The Description field in the ApprovalRequestState table is of data type nvarchar, which allows for storing character data with a maximum length of 4000 characters. This field is used to provide a brief description or explanation of the current state of an approval request. It is an important piece of information that helps to provide context and clarification for each pending request. The nvarchar data type is a versatile choice, allowing for the storage of both numbers and letters, making it suitable for various descriptions that may include a combination of words and numbers. The data stored in this field can be accessed and modified as needed to reflect any changes or updates in the status of the approval request.

string | null

Miscellaneous notes and information for the entry or record.

string | null

The BadgeId field in the ApprovalRequestState table is a nvarchar data type with a maximum length of 32 characters. It is used to store the unique badge identification number associated with an approval request. This field allows for accurate and efficient tracking and management of approval requests within the system. The BadgeId can be alphanumeric and has a flexible length, making it suitable for various identification formats. It serves as a key identifier for each approval request and plays a crucial role in the decision-making process.

boolean

The CanApprove field in the ApprovalRequestState table is a bit data type that indicates whether a user has the authority to approve a request. This field can either have a value of 1, indicating the user can approve the request, or 0, indicating the user does not have the approval privilege. This field is designed to facilitate the approval process by providing a clear indication of the users who have the power to approve or deny a request. It is a crucial component in managing and tracking approval requests within the system.

boolean

The CanReject field in the ApprovalRequestState table is a boolean value that indicates whether or not the request can be rejected. A bit data type is used to store a binary value of either 1 or 0, with 1 representing 'true' and 0 representing 'false'. This field allows for greater control and flexibility in the approval process, as it allows for certain requests to have the option of being rejected. Setting this field to 'true' enables the requester to reject the approval, while setting it to 'false' removes this option. This field is commonly used in workflow management systems to provide a streamlined and efficient approval process.

boolean

The CanReopen field of data type bit in the ApprovalRequestState table represents whether or not an approval request can be reopened. A value of 1 indicates that the request can be reopened, while a value of 0 indicates that it cannot be reopened. This field is useful for tracking the status of approval requests and controlling the ability to make changes or adjustments to previously approved requests.

Response
200

OK

Updated over 1 year ago

Language
URL
Response 
Click Try It! to start a request and see the response here!
Updated over 1 year ago