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

• shawAccounts boolean

  Enable display accounts in the file.

• currency integer(int32) Required

  Currency ID

• lastYear boolean

  Include information for last year

• ytd boolean

  Year To Date

  Default value is false.

• margin boolean

  Include margin data

• monthly boolean

  Split the report by month

  Default value is false.

• businessUnitShown boolean

  Split the report by departments

  Default value is false.

• budget boolean

  Include budget information in the report.

  Default value is false.

• splitByOrganization boolean

  Split the report by organizations. Applicable only when organization type is Consolidated!

  Default value is false.

• departmentIds

  Department IDs filter.
  
  Applicable only when businessUnitShown is not set to true.
  
  
  
  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
• startDate string(date-time) Required

  Start date

• endDate string(date-time) Required

  End date

Responses

• 200

  OK

• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error