Get contacts balance with advanced filters

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL


        
          
            https://restapi.wyzio.com/mcp

Standard setup for AI tools providing an mcp.json file

{
  "Wyzio MCP server": {
    "url": "https://restapi.wyzio.com/mcp"
  }
}

GET /api-v1/contact-balance/report/advanced

Returns a contacts balance report based on advanced filters.

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.
date string(date-time)

Report generation date.
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.
contactType string

Contact type filter. Used to select contacts

Values are ORGANIZATION or PERSON.
name string

Contact name filter. Applicable only when contactType = ORGANIZATION. Used to select contacts
isCustomer boolean

Whether the contact is a customer. Used to select contacts
isVendor boolean

Whether the contact is a vendor/supplier. Used to select contacts
isStaff boolean

Whether the contact is a staff member. Applicable only when contactType = PERSON. Used to select contacts
isUser boolean

Whether the contact has a user account. Applicable only when contactType = PERSON. Used to select contacts
email string

Email address filter. Used to select contacts
externalId string

External identifier filter. Used to select contacts
hasWarnings boolean

Whether the contact has warnings. Used to select contacts
lastName string

Last name filter. Applicable only when contactType = PERSON. Used to select contacts
firstName string

First name filter. Applicable only when contactType = PERSON. Used to select contacts
middleName string

Middle name filter. Applicable only when contactType = PERSON. Used to select contacts
nationality string

Nationality filter. Applicable only when contactType = PERSON. Used to select contacts
gender string

Gender filter. Applicable only when contactType = PERSON. Used to select contacts

Values are MALE, FEMALE, or OTHER.
birthDate string(date-time)

Birth date filter. Applicable only when contactType = PERSON. Used to select contacts
language string

Default language filter. Used to select contacts

Values are EN, FR, DE, IT, or UNDEFINED.
nogaCode string

NOGA economic activity code filter. Applicable only when contactType = ORGANIZATION. Used to select contacts
phone string

Phone number filter. Used to select contacts
fax string

Fax number filter. Used to select contacts
mobile string

Mobile number filter. Used to select contacts
webSite string

Website URL filter. Used to select contacts
addressId string

Address ID filter. Used to select contacts.

Multi-value supported. Example: value1;value2
addressName string

Address label / name filter. Used to select contacts
addressStreet string

Address street filter. Used to select contacts
addressHouseNumber string

Address house number filter. Used to select contacts
addressStreetPoBox string

Address P.O. box / street line 2 filter. Used to select contacts
addressCity string

Address city filter. Used to select contacts
addressPostCode string

Address postal code filter. Used to select contacts
addressCountry string

Address country filter. Used to select contacts
addressRegion string

Address region filter. Used to select contacts
addressToTheAttentionOf string

Address 'to the attention of' filter. Used to select contacts
bankId string

Bank ID filter. Used to select contacts.

Multi-value supported. Example: value1;value2
bankName string

Bank account label / name filter. Used to select contacts
bankAccountNumber string

Bank account number filter. Used to select contacts
bankSwiftBic string

Bank SWIFT/BIC code filter. Used to select contacts
bankRemark string

Bank account remark filter. Used to select contacts
clientDefaultDepartmentId string

Client default department ID filter. Used to select contacts.

Multi-value supported. Example: value1;value2
clientDefaultAccountForPaymentsNumber integer(int64)

Client default payment chart of accounts number filter. Used to select contacts
clientDefaultPlAccountNumber integer(int64)

Client default P&L chart of accounts number filter. Used to select contacts
clientDefaultBalanceSheetAccountNumber integer(int64)

Client default balance sheet chart of accounts number filter. Used to select contacts
clientDefaultPaymentCurrencyCode string

Client default payment currency code filter. Used to select contacts
clientVatNumber string

Client VAT number filter. Used to select contacts
clientVatType string

Client VAT type filter. Used to select contacts
clientRequestedPaymentTerms integer(int64)

Client requested payment terms in days filter. Used to select contacts
clientLateNoticeMargin integer(int64)

Client late notice margin in days filter. Used to select contacts
clientDiscountRate number

Client discount rate filter. Used to select contacts
clientCreditLimit string
Client credit limit filter. Used to select contactsSupports 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.
supplierDefaultDepartmentId string

Supplier default department ID filter. Used to select contacts.

Multi-value supported. Example: value1;value2
supplierDefaultAccountForPaymentsNumber integer(int64)

Supplier default payment chart of accounts number filter. Used to select contacts
supplierDefaultPlAccountNumber integer(int64)

Supplier default P&L chart of accounts number filter. Used to select contacts
supplierDefaultBalanceSheetAccountNumber integer(int64)

Supplier default balance sheet chart of accounts number filter. Used to select contacts
supplierDefaultPaymentCurrencyCode string

Supplier default payment currency code filter. Used to select contacts
supplierVatNumber string

Supplier VAT number filter. Used to select contacts
supplierVatTypeEnum string

Supplier VAT type filter. Used to select contacts

Values are NO_VAT, NATIVE, or IMPORT_OF_SERVICE.
supplierVatTypeCode string

Supplier VAT type code filter. Used to select contacts
supplierRequestedPaymentTerms integer(int64)

Supplier requested payment terms in days filter. Used to select contacts
supplierPaymentFeesSplit string

Supplier payment fees split filter. Used to select contacts

Values are CHARGED_TO_THE_BENEFICIARY, FIFTY_FIFTY_SPLIT, or CHARGED_TO_THE_ORDERER.
staffAvsNumber string

Staff AVS/social security number filter. Applicable only when contactType = PERSON. Used to select contacts
staffPermitExpiryDate string
Staff work permit expiry date filter. Applicable only when contactType = PERSON. Used to select contactsSupports comparison operators:
- Range ( .. )
- Greater than ( > )
- Greater than or equal ( >= )
- Less than ( < )
- Less than or equal ( <= )
- Not equal ( <> )
Examples:
- 01/01/2026..31/12/2026
- >=01/01/2026
- <=01/01/2026
- <>01/01/2026
Use <>01/01/2026 to return only records where the selected date is not equal to the filter date.
staffContractType string

Staff contract type filter. Applicable only when contactType = PERSON. Used to select contacts

Values are OPEN_ENDED, OPEN_ENDED_YEAR, FIXED, APPRENTICESHIP, INTERN, INDEFINITE_SALARY_NO_TIME_CONSTRAINT, FIXED_SALARY_NO_TIME_CONSTRAINT, or ADMINISTRATIVE_BOARD.
staffMaritalType string

Staff marital status filter. Applicable only when contactType = PERSON. Used to select contacts

Values are SINGLE, MARRIED, DIVORCED, SEPARATED, WIDOWED, PARTNERED, DISSOLVED_LAW, DISSOLVED_LOST, or DISSOLVED_DEATH.
staffTrainingLevel string

Staff training level filter. Applicable only when contactType = PERSON. Used to select contacts

Values are PHD, MASTER_ETH, BACHELOR_ETH, MASTER_UAS, BACHELOR_UAS, HES, MASTER, BACHELOR, TC, MATU, CVT, IN_HOUSE, or COMP_SCHOOL.
staffPosition string

Staff position filter. Applicable only when contactType = PERSON. Used to select contacts

Values are SENIOR, MIDDLE, LOWER, or RESP.
status string

Contact status filter. Used to select contacts

Values are ACTIVE or ARCHIVED.
filterStaffContacts boolean

Whether to filter for staff contacts only. Used to select contacts

Responses

200 application/json

OK
Hide response attributes Show response attributes object
- id integer(int64)
- contactId integer(int64)
- contactName string
- contactRoleType string
- currencyCode string
- balance number
400

400 Bad Request
401

401 Unauthorized
403

403 Access Denied
404

404 Not Found
500

500 Internal Server Error

GET /api-v1/contact-balance/report/advanced

curl \
 --request GET 'https://wyzio.app/api-v1/contact-balance/report/advanced'

Response examples (200)

[
  {
    "id": 42,
    "contactId": 42,
    "contactName": "string",
    "contactRoleType": "string",
    "currencyCode": "string",
    "balance": 42.0
  }
]