API reference / Credit notes

Credit notes API

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

GET

List

/api/v1/credit-notes

Scope: Scalar360.credit-notes.READ

Parameter	In	Type	Required
`type`	query	string	No
`q`	query	string	No
`page`	query	integer	No
`pageSize`	query	integer	No
`sortBy`	query	string	No
`sortDir`	query	string	No
`startDate`	query	string (date)	No
`endDate`	query	string (date)	No

Example request

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

POST

Create

/api/v1/credit-notes

Scope: Scalar360.credit-notes.CREATE

Body field	Type	Required	Notes
`invoiceId`	string (uuid)	Yes
`type`	string	Yes	required, not blank
`amount`	number	Yes	required, > 0
`taxableAmount`	number
`cgst`	number
`sgst`	number
`igst`	number
`lines`	array of object
`lines[].invoiceLineId`	string (uuid)
`lines[].qty`	number	Yes	required, > 0
`lines[].taxableAmount`	number
`lines[].gstRate`	number
`reason`	string
`notes`	string
`date`	string (date)

Example request

curl -X POST "https://api.scalar360.com/api/v1/credit-notes" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"invoiceId":"3f1c2b9e-7a1d-4c3e-9b2a-1e5f6a7b8c9d","type":"string","amount":100}'

GET

Get

/api/v1/credit-notes/{id}

Scope: Scalar360.credit-notes.READ

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

Example request

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

DELETE

Delete

/api/v1/credit-notes/{id}

Scope: Scalar360.credit-notes.DELETE

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

Example request

curl -X DELETE "https://api.scalar360.com/api/v1/credit-notes/{id}" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN"

POST

Apply

/api/v1/credit-notes/{id}/applications

Scope: Scalar360.credit-notes.CREATE

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

Body field	Type	Required	Notes
`invoiceId`	string (uuid)	Yes
`amount`	number	Yes	required, > 0
`appliedDate`	string (date)

Example request

curl -X POST "https://api.scalar360.com/api/v1/credit-notes/{id}/applications" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[{"invoiceId":"3f1c2b9e-7a1d-4c3e-9b2a-1e5f6a7b8c9d","amount":100,"appliedDate":"2026-10-12"}]'

POST

Cancel

/api/v1/credit-notes/{id}/cancel

Scope: Scalar360.credit-notes.CREATE

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

Body field	Type	Required	Notes
`date`	string (date)
`reason`	string	Yes	required, not blank, max length 500

Example request

curl -X POST "https://api.scalar360.com/api/v1/credit-notes/{id}/cancel" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"string"}'

POST

Refund

/api/v1/credit-notes/{id}/refunds

Scope: Scalar360.credit-notes.CREATE

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

Body field	Type	Required	Notes
`amount`	number	Yes	required, > 0
`refundDate`	string (date)
`method`	string		max length 50
`reference`	string		max length 200

Example request

curl -X POST "https://api.scalar360.com/api/v1/credit-notes/{id}/refunds" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"amount":100}'

GET

Applications for invoice

/api/v1/credit-notes/applications

Scope: Scalar360.credit-notes.READ

Parameter	In	Type	Required
`invoiceId`	query	string (uuid)	Yes

Example request

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

POST

Reverse application

/api/v1/credit-notes/applications/{applicationId}/reverse

Scope: Scalar360.credit-notes.CREATE

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

Body field	Type	Required	Notes
`date`	string (date)
`reason`	string	Yes	required, not blank, max length 500

Example request

curl -X POST "https://api.scalar360.com/api/v1/credit-notes/applications/{applicationId}/reverse" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"string"}'

POST

Reverse refund

/api/v1/credit-notes/refunds/{refundId}/reverse

Scope: Scalar360.credit-notes.CREATE

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

Body field	Type	Required	Notes
`date`	string (date)
`reason`	string	Yes	required, not blank, max length 500

Example request

curl -X POST "https://api.scalar360.com/api/v1/credit-notes/refunds/{refundId}/reverse" \
  -H "Authorization: Scalar360-oauthtoken $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reason":"string"}'