Get All Balance

GET /api/v1/InvoiceAccounts/getallBalance

Description

This endpoint is used to retrieve the total account balance for all Invoice Accounts. It returns a TotalAccountBalanceResponseResponse object containing the total balance.

Headers:

• Content-Type: application/json

ApiKey:

• No API key required

Path Parameters:

• version: string, required

Query Parameters:

• None

URL:

• GET: {{baseUrl API url}}/api/v1/InvoiceAccounts/getallBalance

Response:

• A TotalAccountBalanceResponseResponse object containing the total balance for all Invoice Accounts.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example Request URL:

GET /api/v1/InvoiceAccounts/getallBalance
Content-Type: application/json

Example Response:

HTTP/1.1 200 OK
{
  "totalBalance": 8000.00,
  "currencyCode": "USD"
}

Method: GET

/api/v1/InvoiceAccounts/getallBalance

Headers

Content-Type	Value
Accept	text/plain

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "availableBalance": "<double>",
    "ledgerBalance": "<double>",
    "interestBalance": "<double>"
  }
}