Internal Job

Internal Job - Sweep

HTTP Request

POST /api/v1/jobs/sweep

Interactive Demo

📋 Description: Creates a new sweep job to consolidate and reconcile ledger entries across specified accounts, ensuring accurate financial records and streamlined transaction management.

Parameters

Name	In	Type	Required	Description
message	query	string	true	Textual content of the message that provides details or instructions related to the ledger entry for the transaction being processed in the financial record.

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Job - Kill

HTTP Request

POST /api/v1/jobs/kill

Interactive Demo

📋 Description: Terminates specified ledger entries or transactions within the General Ledger, ensuring accurate financial record management and account integrity.

Parameters

Name	In	Type	Required	Description
message	query	string	true	Textual content that provides a reason or justification for terminating a specific job within the financial record management process.

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Job - Interrupt

HTTP Request

POST /api/v1/jobs/interrupt

Interactive Demo

📋 Description: Initiates an interruption of a specified job within the General Ledger, allowing users to halt processing of ledger entries, transactions, or financial records associated with an account.

Parameters

Name	In	Type	Required	Description
message	query	string	true	Textual content that specifies the reason for interrupting a job related to ledger entries, transactions, or financial records.

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Internal Job - Cancel

HTTP Request

POST /api/v1/jobs/cancel

Interactive Demo

📋 Description: Cancels a specified job within the General Ledger system, ensuring that associated ledger entries and financial records are updated accordingly to maintain accurate transaction history.

Parameters

Name	In	Type	Required	Description
message	query	string	true	Textual representation of the reason for canceling a job entry, providing context for the financial record in the General Ledger.

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---