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

• 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.

• contactId string

  Contact ID filter.
  
  Multi-value supported. Example: value1;value2
  
  

• contactRoleType string

  Contact role type filter

  Values are BOTH, SUPPLIER, or CLIENT.

• currencyCode string

  Currency code filter

• balance string

  Balance filterSupports comparison operators:

  • Range ( .. )
  • Greater than ( > )
  • Greater than or equal ( >= )
  • Less than ( < )
  • Less than or equal ( <= )
  • Not equal ( <> )

  Examples:

  • <=100.00
  • >=100.00
  • <>100.00
  • 100.00..200.00

  Use <>0 to return only records where the selected amount is not equal to zero.
  
  

• date string(date-time)

  Report generation date.

Responses

• 200 application/json

  OK

  Hide response attributes Show response attributes object

  • data array[object]
    Hide data attributes Show data attributes object

    • id integer(int64)
    • contactId integer(int64)
    • contactName string
    • contactRoleType string
    • currencyCode string
    • balance number
  • count integer(int64)
  • totalBalance number
• 400

  400 Bad Request

• 401

  401 Unauthorized

• 403

  403 Access Denied

• 404

  404 Not Found

• 500

  500 Internal Server Error