curl --request GET \
--url https://api.firstpromoter.com/api/v2/company/payouts/due_stats \
--header 'Account-ID: <account-id>' \
--header 'Authorization: Bearer <token>'{
"meta": {
"net_payout_days": 123,
"payout_cycle": "<string>",
"min_payment": 123,
"min_paying_customers": 123,
"terms_description": "<string>",
"selected_payout_methods": [
"<string>"
],
"payout_method_options": {},
"managed_payouts": true
},
"data": {
"next": {
"promoters_count": 123,
"amounts": {},
"total_incl_tax": 123,
"due_date": "2023-12-25",
"period_end": "2023-12-25"
},
"overdue": {
"promoters_count": 123,
"amounts": {},
"total_incl_tax": 123,
"due_date": "2023-12-25",
"period_end": "2023-12-25"
},
"custom": {
"promoters_count": 123,
"amounts": {},
"total_incl_tax": 123
}
}
}This endpoint returns statistics about due payouts.
GET https://api.firstpromoter.com/api/v2/company/payouts/due_statscurl --request GET \
--url https://api.firstpromoter.com/api/v2/company/payouts/due_stats \
--header 'Account-ID: <account-id>' \
--header 'Authorization: Bearer <token>'{
"meta": {
"net_payout_days": 123,
"payout_cycle": "<string>",
"min_payment": 123,
"min_paying_customers": 123,
"terms_description": "<string>",
"selected_payout_methods": [
"<string>"
],
"payout_method_options": {},
"managed_payouts": true
},
"data": {
"next": {
"promoters_count": 123,
"amounts": {},
"total_incl_tax": 123,
"due_date": "2023-12-25",
"period_end": "2023-12-25"
},
"overdue": {
"promoters_count": 123,
"amounts": {},
"total_incl_tax": 123,
"due_date": "2023-12-25",
"period_end": "2023-12-25"
},
"custom": {
"promoters_count": 123,
"amounts": {},
"total_incl_tax": 123
}
}
}Access token passed as a Bearer token in the Authorization header
Account identifier that specifies which account is making the request
"acc_123456"
Search params. Searches by 'promoter.profile.first_name,promoter.profile.last_name,promoter.user.email`
Filter by status
pending, completed, failed, processing, cancelled Campaign ids. Can be Integer or Array of Integers
Successful response
Show child attributes
Number of days for net payout
Payout cycle (e.g., monthly)
Minimum payment amount
Minimum number of paying customers
Description of payment terms
List of selected payout methods
Options for payout methods
Whether payouts are managed by us (auto-payouts)
Show child attributes
Show child attributes
Count of promoters
Total amount including tax
Due date for the next payout
End date of the period
Show child attributes
Count of promoters
Total amount including tax
Due date for overdue payout
End date of the period