Skip to main content
POST
/
billspree
/
bills
/
distribute-bills
Distribute Term
curl --request POST \
  --url https://{workspace}.spreesuite.com/billspree/bills/distribute-bills \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "method": "Distribute",
  "action": "Distribute Bills",
  "apiVersion": "v2",
  "operation": "schedule",
  "data": {
    "termID": 5,
    "sheduleTime": "2026-06-15T10:00:00"
  },
  "billId": null
}
'
{
  "success": true,
  "statusCode": 123,
  "message": "<string>",
  "error": null,
  "data": {}
}

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
​
statusCode
integer
​
message
string
​
error
unknown
​
data
object