Skip to main content
POST
/
v5
/
banks
/
beginningBalance
Save beginning balance
curl --request POST \
  --url https://sandbox.hurdlr.com/rest/v5/banks/beginningBalance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: */*' \
  --data '
{
  "bankAccountId": 52320,
  "balance": 234.56,
  "date": "2020-12-31",
  "description": "Beginning Balance"
}
'
[
  {
    "result": "SUCCESS",
    "errors": {
      "fieldErrors": {},
      "globalErrors": [
        {
          "type": "DUPLICATE",
          "errorMessage": "<string>"
        }
      ]
    },
    "id": "<string>",
    "webhook": {
      "userId": "<string>",
      "accountantUserId": "<string>",
      "type": "ENTITY_UPDATE"
    }
  }
]

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

*/*

Beginning balance data

​
bankAccountId
integer<int64>

Id of the bank account account (from Tight's API) for which we are setting the beginning balance. Either this or apiAccountId is required.

Example:

52320

​
balance
number

The balance of this account on the date specified in the date field

Example:

234.56

​
date
string<date>

The date on which to apply this beginning balance; generally the day before the user started tracking their accounting in your system

Example:

"2020-12-31"

​
description
string

The description of this beginning balance. Defaults to 'Beginning Balance'.

Example:

"Beginning Balance"

Response

200 - application/json

Successful operation

​
result
enum<string>

The result of the action performed

Available options:
SUCCESS,
FAILURE
​
errors
object

Error object containing details errors incurred, if any

​
id
string

Id of the entity being acted upon

​
webhook
object