Headers

• WEAL-TOKEN Required

  API token (can be retrieved from account settings)

• TARGET-ORGANIZATION-ID

  ID of organization, for which the operation must be performed

Query parameters

• currency integer(int32) Required

  Currency ID

• lastYear boolean

  Include information for last year

• margin boolean

  Include margin data

• budgetChangeType string

  Budget Change Type

  Values are PERCENT or AMOUNT.

• departmentIds

  Department IDs filter.
  
  
  
  Supported values:

  • -1 — records where value is not assigned
  • ID
  • Multiple values separated by ;

  Examples:

  • -1
  • 10
  • 10;15;20
• officeIds

  Office IDs filter.
  
  
  
  Supported values:

  • -1 — records where value is not assigned
  • ID
  • Multiple values separated by ;

  Examples:

  • -1
  • 10
  • 10;15;20
• articleIds

  Article IDs filter.
  
  
  
  Supported values:

  • -1 — records where value is not assigned
  • ID
  • Multiple values separated by ;

  Examples:

  • -1
  • 10
  • 10;15;20
• articleCategoryIds

  Article Category IDs filter.
  
  
  
  Supported values:

  • -1 — records where value is not assigned
  • ID
  • Multiple values separated by ;

  Examples:

  • -1
  • 10
  • 10;15;20
• orderIds

  Order IDs filter.
  
  
  
  Supported values:

  • -1 — records where value is not assigned
  • ID
  • Multiple values separated by ;

  Examples:

  • -1
  • 10
  • 10;15;20
• contactIds

  Contact IDs filter.
  
  
  
  Supported values:

  • -1 — records where value is not assigned
  • ID
  • Multiple values separated by ;

  Examples:

  • -1
  • 10
  • 10;15;20
• date string(date-time) Required

  Report generation date.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • templateLineName object
    Hide templateLineName attributes Show templateLineName attributes object

    • id integer(int64)
    • en string
    • fr string
    • de string
    • it string
  • children array
  • sign string

    Values are ASSETS, LIABILITY, INCOME, or EXPENSE.

  • type string

    Values are NONE, ACCOUNTS, or CALCULATIONS.

  • calculationTemplateLineIds array[integer(int64)]
  • total number
  • margin number
  • lastYearTotal number
  • lastYearMargin number
  • change number
  • changeAmount number
  • changeAmountProportion number
  • accountBalances array[object]
    Hide accountBalances attributes Show accountBalances attributes object

    • accountId integer(int64)
    • accountNumber integer(int64)
    • account object
      Hide account attributes Show account attributes object

      • en string
      • fr string
      • de string
      • it string
    • balance number
    • lastYearBalance number
    • margin number
    • lastYearMargin number
    • change number
    • changeAmount number
    • changeAmountProportion number
    • hasWarnings boolean
  • hasWarnings boolean
  • id integer(int64)
  • parentId integer(int64)
  • position integer(int32)
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error