API reference / Import jobs

Import jobs API

5 endpoints. Scopes: Scalar360.import-jobs.READ, .CREATE, .UPDATE, .DELETE or .ALL. All calls need Authorization: Scalar360-oauthtoken <access_token> — see Authentication.

GET

Recent

/api/v1/import-jobs

Scope: Scalar360.import-jobs.READ

Parameter	In	Type	Required
`type`	query	string	No
`targetId`	query	string (uuid)	No
`limit`	query	integer (default 10)	No

Example request

curl -X GET "https://api.scalar360.com/api/v1/import-jobs" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

GET

Get

/api/v1/import-jobs/{id}

Scope: Scalar360.import-jobs.READ

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/import-jobs/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Cancel

/api/v1/import-jobs/{id}/cancel

Scope: Scalar360.import-jobs.CREATE

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Example request

curl -X POST "https://api.scalar360.com/api/v1/import-jobs/{id}/cancel" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Confirm

/api/v1/import-jobs/{id}/confirm

Scope: Scalar360.import-jobs.CREATE

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Body field	Type	Required	Notes
`mapping`	map of string
`label`	string
`bankAccountId`	string (uuid)
`openingBalance`	number
`closingBalance`	number

Example request

curl -X POST "https://api.scalar360.com/api/v1/import-jobs/{id}/confirm" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"mapping":{},"label":"string","bankAccountId":"3f1c2b9e-7a1d-4c3e-9b2a-1e5f6a7b8c9d","openingBalance":100,"closingBalance":100}'

GET

Errors

/api/v1/import-jobs/{id}/errors.csv

Scope: Scalar360.import-jobs.READ

Parameter	In	Type	Required
`id`	path	string (uuid)	Yes

Example request

curl -X GET "https://api.scalar360.com/api/v1/import-jobs/{id}/errors.csv" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"