GetCurrentBalance

[POST] .../v1/partner/getcurrentbalance

Returns current balance partner in base currency. Use this method to read the current partner settlement balance in the account base currency before showing partner cards, settlement dashboards or payment decisions. The response returns a decimal balance calculated from performed partner balance rows, optionally limited to one firm when firm_id is supplied. The request body is required and id must identify an existing partner; firm_id is optional, but when it is provided it must identify an existing company. Both selectors can be supplied through filters. The current request user must have partner select permission. Missing body, invalid id, invalid firm_id, denied access, database failures and balance storage errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Filterable Fields

Request Example

{
  "filters": [
    {
      "Field": "id",
      "Operator": "Equal",
      "Value": "15"
    },
    {
      "Field": "firm_id",
      "Operator": "Equal",
      "Value": "2"
    }
  ]
}

Response Parameters

Response Example

{
  "ok": true,
  "result": 1250000.000
}