Returns the total number of receivables matching the specified filters.
Headers
-
API token (can be retrieved from account settings)
-
ID of organization, for which the operation must be performed
Query parameters
-
Supported type filter
Values are
PURCHASE_INVOICESorSALES_INVOICES. -
Payment ID filter.
Multi-value supported. Example: value1;value2 -
Invoice ID filter.
Multi-value supported. Example: value1;value2 -
Invoice date filter.Supports 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.
- Range (
-
Requested date filter.Supports 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.
- Range (
-
Invoice number filter
-
Requested amount 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
<>0to return only records where the selected amount is not equal to zero. - Range (
-
Contact ID filter (client or supplier, depending on module).
Multi-value supported. Example: value1;value2 -
Currency ID filter.
Multi-value supported. Example: value1;value2 -
Whether the receivable has warnings
curl \
--request GET 'https://wyzio.app/api-v1/receivable/overall'
42