Payment batches & settlement

Can Submit Schedule Settlement

Name and signature indicate it returns can submit schedule settlement

GEThttps://api.toku.com/tga/can-submit-schedule-settlement

Required scope: payments:read

curl --request GET \
  --url 'https://api.toku.com/tga/can-submit-schedule-settlement?taxReferenceID=%3CtaxReferenceID%3E' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "allowed": true
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Query parameters

taxReferenceIDstring<uuid>required

Response

200Successful response
allowedboolean
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits