ActionResultModel

Represents the result of an action.

In the Lockstep API, an Action is returned when an API call does not produce any data
but does produce messages that can be useful in understanding what work was performed.
You may use the messages text to display user visible error messages or the results of
various operations.

Methods

The following API methods use this data model.

• Revoke API Key
• Delete Application
• Archive Attachment
• Delete Credit Memo Application
• Delete Credit Memo Applied
• Delete Field Definition
• Delete Field
• Delete Financial Account
• Delete Balance History
• Delete Financial Year Setting
• Delete Invoice Address
• Revoke Magic Link
• Revoke Bounced Magic Link
• Archive Note
• Delete Payment Application
• Delete Payment
• Delete Payment Applied
• Delete Accounting Profile
• Provision Free Developer Account
• Disable User
• Reenable User
• Delete Webhook Rule
• Delete Webhook

Optional Fields

messages

string[], nullable

If the API call produced messages, this element will contain a list of user-visible
text strings that contain information about what work occurred in the API.