Credit balance

Read the balance you can spend on your office wallet.

POST/Common/CreditBalance

Access requires the permission credit_balance

The balance returned is already net of any funds held for open bookings, so it is what you can actually spend right now.

Path parameters

None.

Query parameters

None.

Body parameters

Name	Type	Required	Description
`SessionId`	string	Yes	Your session id.

Request

curl -X POST https://api.hermeseus.com/api/Common/CreditBalance \
  -H "Content-Type: application/json" \
  -d '{ "SessionId": "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f" }'

const res = await fetch("https://api.hermeseus.com/api/Common/CreditBalance", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({ SessionId: "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f" })
});

const balance = await res.json();

import requests

res = requests.post(
    "https://api.hermeseus.com/api/Common/CreditBalance",
    json={"SessionId": "8f3c81d2-4a5b-4c6d-9e0f-1a2b3c4d5e6f"},
)

print(res.json())

Response

Field	Type	Description
`Success`	boolean	`true` on success.
`Balance`	number	Spendable balance, net of held funds.
`Currency`	string	Wallet currency.
`Error`	object	`null` on success.

{
  "Success": true,
  "Balance": 4820.50,
  "Currency": "USD",
  "Error": null
}