Skip to main content
POST
Distribute Term

Authorizations

Authorization
string
header
required

Auth token returned from the login endpoint. Send as: Authorization: <token> (no Bearer prefix)

Body

application/json
method
string
required

Always "Distribute"

Example:

"Distribute"

action
string
required

Always "Distribute Bills"

Example:

"Distribute Bills"

apiVersion
string
required
Example:

"v2"

operation
string
required

Always "schedule"

Example:

"schedule"

data
object
required
billId
integer | null

Pass to distribute a single bill only — null to distribute all bills in the term

Response

200 - application/json

Distribute job registered

success
boolean
data
object
message
string
statusCode
integer
error
unknown