Skip to main content
POST
Trigger Monitoring Job

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Monitoring job parameters

jobType
enum<string>
required

Type of monitoring job to run

Available options:
payments_status_mismatch,
invoices_mismatch,
payments_stuck,
customers_mismatch,
customer_info_mismatch
startDate
string

Start date in YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$
endDate
string

End date in YYYY-MM-DD format

Pattern: ^\d{4}-\d{2}-\d{2}$
all
boolean
default:false

Whether to fetch all records or only active ones

Response

Monitoring job triggered successfully

data
object
required
code
enum<string>
Available options:
health_status_ok,
health_status_error,
validation_error,
bad_request,
unauthorized,
forbidden,
not_found,
method_not_allowed,
internal_server_error,
organization_not_found,
cannot_access_organization,
api_key_not_found,
resource_already_exists
message
string