Internal Job¶

Internal Job - Sweep¶

HTTP Request

POST /api/v1/jobs/sweep

📋 Description: Initiates a job sweep operation to efficiently process and manage outstanding tasks within the system, ensuring optimal resource allocation and workflow efficiency.

Parameters

Name	In	Type	Required	Description
message	query	string	true	Content of the message to be processed during the job sweep operation, facilitating communication of specific instructions or information.

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "errorCode": "string",
  "balances": [
    {
      "id": 0,
      "displayId": "string",
      "invoiceId": 0,
      "invoiceDisplayId": "string",
      "invoiceLineItemId": 0,
      "invoiceLineItemDisplayId": "string",
      "invoiceLineItemDescription": "string",
      "expenseCategory": {
        "id": 0,
        "displayId": "string",
        "name": "string"
      },
      "totalNetAmount": 0,
      "totalTaxAmount": 0,
      "reservedNetAmount": 0,
      "reservedTaxAmount": 0,
      "remainingTotalAmount": 0,
      "remainingNetAmount": 0,
      "remainingTaxAmount": 0,
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

Internal Job - Kill¶

HTTP Request

POST /api/v1/jobs/kill

📋 Description: Terminates specified job processes within the system, ensuring efficient resource management and operational continuity.

Parameters

Name	In	Type	Required	Description
message	query	string	true	Textual content detailing the reason for terminating a job, which aids in maintaining clear communication and documentation within the job management process.

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "errorCode": "string",
  "balances": [
    {
      "id": 0,
      "displayId": "string",
      "invoiceId": 0,
      "invoiceDisplayId": "string",
      "invoiceLineItemId": 0,
      "invoiceLineItemDisplayId": "string",
      "invoiceLineItemDescription": "string",
      "expenseCategory": {
        "id": 0,
        "displayId": "string",
        "name": "string"
      },
      "totalNetAmount": 0,
      "totalTaxAmount": 0,
      "reservedNetAmount": 0,
      "reservedTaxAmount": 0,
      "remainingTotalAmount": 0,
      "remainingNetAmount": 0,
      "remainingTaxAmount": 0,
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

Internal Job - Interrupt¶

HTTP Request

POST /api/v1/jobs/interrupt

📋 Description: Initiates an interruption of a specified job process, allowing for immediate control over ongoing operations to enhance resource management and operational efficiency.

Parameters

Name	In	Type	Required	Description
message	query	string	true	Textual content that specifies the interruption message for the job, facilitating clear communication of the reason for the job’s interruption.

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "errorCode": "string",
  "balances": [
    {
      "id": 0,
      "displayId": "string",
      "invoiceId": 0,
      "invoiceDisplayId": "string",
      "invoiceLineItemId": 0,
      "invoiceLineItemDisplayId": "string",
      "invoiceLineItemDescription": "string",
      "expenseCategory": {
        "id": 0,
        "displayId": "string",
        "name": "string"
      },
      "totalNetAmount": 0,
      "totalTaxAmount": 0,
      "reservedNetAmount": 0,
      "reservedTaxAmount": 0,
      "remainingTotalAmount": 0,
      "remainingNetAmount": 0,
      "remainingTaxAmount": 0,
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}

Internal Job - Cancel¶

HTTP Request

POST /api/v1/jobs/cancel

📋 Description: Initiates the cancellation of a specified job, allowing users to effectively manage job statuses within the system.

Parameters

Name	In	Type	Required	Description
message	query	string	true	Textual content detailing the reason for canceling the job, which aids in maintaining accurate records and understanding cancellation trends.

Responses

Status	Meaning	Description	Schema
200	OK	OK	None
409	Conflict	Payment amount exceeds remaining invoice balance	InvoicePaymentBalanceConflictDto
502	Bad Gateway	Downstream service call failed	PayableErrorDto

Example Responses

{
  "errorCode": "string",
  "balances": [
    {
      "id": 0,
      "displayId": "string",
      "invoiceId": 0,
      "invoiceDisplayId": "string",
      "invoiceLineItemId": 0,
      "invoiceLineItemDisplayId": "string",
      "invoiceLineItemDescription": "string",
      "expenseCategory": {
        "id": 0,
        "displayId": "string",
        "name": "string"
      },
      "totalNetAmount": 0,
      "totalTaxAmount": 0,
      "reservedNetAmount": 0,
      "reservedTaxAmount": 0,
      "remainingTotalAmount": 0,
      "remainingNetAmount": 0,
      "remainingTaxAmount": 0,
      "allowsSystemGenerateNewId": true,
      "numberRangeIdentifierValue": "string",
      "numberRangeIdentifierType": {
        "name": "string"
      },
      "numberRangeType": {
        "name": "string"
      }
    }
  ]
}