GET /api-v1/balance

Headers

  • WEAL-TOKEN string Required

    API token (can be retrieved from account settings)

  • TARGET-ORGANIZATION-ID integer

    ID of organization, for which the operation must be performed

Query parameters

  • pageNumber integer

    Page Number

    Default value is 1.

  • sortingField string

    Field to sort by

  • direction string

    Sorting direction

    Values are ASC or DESC. Default value is ASC.

  • sizePerPage integer

    Size per page

    Default value is 60.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • id integer
    • organizationId integer
    • accountNumber integer
    • accountType string

      Values are BALANCE_SHEET, PL, or SYSTEM.

    • account object
      Hide account attributes Show account attributes object
      • en string
      • fr string
      • de string
      • it string
    • debit number
    • credit number
    • endingBalance number
    • lastYearDebit number
    • lastYearCredit number
    • lastYearEndingBalance number
    • warnings string
    • accountId integer
    • tenantId integer
  • 400

    400 Bad Request

  • 401

    401 Unauthorized

  • 403

    403 Access Denied

  • 404

    404 Not Found

  • 500

    500 Internal Server Error

GET /api-v1/balance 
curl \
 --request GET 'https://wyzio.app/api-v1/balance' \
 --header "WEAL-TOKEN: string" \
 --header "TARGET-ORGANIZATION-ID: 42"
Response examples (200) 
[
  {
    "id": 42,
    "organizationId": 42,
    "accountNumber": 42,
    "accountType": "BALANCE_SHEET",
    "account": {
      "en": "string",
      "fr": "string",
      "de": "string",
      "it": "string"
    },
    "debit": 42.0,
    "credit": 42.0,
    "endingBalance": 42.0,
    "lastYearDebit": 42.0,
    "lastYearCredit": 42.0,
    "lastYearEndingBalance": 42.0,
    "warnings": "string",
    "accountId": 42,
    "tenantId": 42
  }
]