What you’ll achieve
Your finance system holds the commission detail for every period, in the columns it needs, with statuses that match Introw. Payouts you settle elsewhere read Paid in Introw and in the partner portal, with the PO number on the statement. Rewards decided outside a commission plan, a bonus for finishing onboarding or a spiff booked by an agent, arrive as normal commission lines and are paid in the next run.Before you start
1
Confirm access
You need read access to commissions for exports, write access to advance payouts, and an API key with the commissions:read or commissions:write scope for the API steps. See Create and manage API keys.
2
Know which direction you need
Exporting and reading need nothing else. Writing status back assumes your payout method is Manual invoicing; on Introw Pay the stages advance on their own once you pay the consolidated invoice.
Steps
Phase 1 - Export commission lines as CSV
1
Build a commissions report
Go to Reports and create a report with Commissions as its data source. Each row is one commission line, and the default columns are Partner, Commission Item, Commission Plan, Amount, Currency, Status, Origin, Source and Date. Commission Item is the deal or description the partner reads on their statement. Commission Plan carries the installment after the plan name, such as
(2/5), and a line with no plan shows how it was made instead, such as Manual. Origin says how the line was made: Plan, Manual, Api, Workflow or Affiliate. Source says where its figures came from, such as CRM, Stripe, Chargebee, File upload, Manual or API. Add partner CRM properties as extra columns when your finance system keys partners on a CRM id or a supplier number. Filter on Status and Date to match the period you are booking, and on Commission Item, Origin or Source to split a file import or the manual adjustments out of a run. Potential is forecast on open pipeline, Expected is earned but not yet on a payout, In Payout is on a payout, Paid is settled and Voided was declined.2
Export the rows
Open the report’s Data tab and export the rows to CSV. Money columns carry a matching currency column so multi-currency programs import cleanly. The same tab works on any saved commissions report, so save one per period or per finance entity and re-export it each cycle. See Export report data to CSV for the export itself.
3
Or export straight from the Payouts page
For a quick pull, go to Payouts and click a metric card such as Expected, Upcoming payouts, Total paid or Declined. The dialog lists the lines behind that figure with Partner, Commission item, Close date, Amount, Commission and Plan, plus Status and Description for declined or postponed lines, and exports them to CSV named after the metric.
Phase 2 - Read and write through the API
1
Read payouts and the lines behind them
List payouts for a period or a stage, then the commission lines on each. A payout carries the partner, the period, the amount in your company currency, its stage and the PO number. A line carries the partner, the amount and currency, the plan it came from, its status and the payout it sits on, if any. This is the same data as the CSV, without the export step, and it is how an ERP polls for new payouts to book.
2
Write status, PO numbers and statement notes back
When your ERP approves or pays a payout, update its stage and PO number in Introw so the partner sees the same status in the portal and the statement carries the PO. Advance through APPROVED and PENDING_PAYMENT to PAID as your process moves.Send The full walkthrough and every stage value are in the Commissions API.
metadata to print your own free text on the statement PDF, below the commission table: a remittance reference, the account the money left, or who to contact about it. Newlines in the value become line breaks on the PDF, up to 2000 characters, and passing null clears it. The statement is regenerated when the PO number or the statement note changes, so the partner’s next download carries the new text.Phase 3 - Book rewards along the way
1
From a workflow
Open Workflows and add the Give commission action under Rewards to any trigger that marks an achievement, such as Journey completed or Certificate issued. Set Amount, leave Currency on Partner’s currency unless the bonus is fixed in one currency, and write a Description the partner will read on their statement. The line is created as pending and joins the next payout batch, so it still goes through your normal review. See Reward a partner for finishing a journey.
2
From any other system
Create a commission line through the API when the decision lives elsewhere: a spiff approved in your CRM, a bonus from a sales contest tool, or an agent acting on your rules. Give it the partner, an amount, a currency and a description; leave the payout out and it waits in the pending pool for the next batch, or pass a payout to attach it straight away. Lines created this way are labeled Api in the source column, so finance can tell them from plan-calculated lines.
Phase 4 - Build a whole payout over the API
1
Open the payout
Create the payout for one partner and one period. It opens empty and in Draft, so you decide what goes on it. Pass
metadata to write the statement note in the same call, or set it later with PATCH /api/v1/payouts/{id}. Pass attachPendingLines: true instead if you want the partner’s pending lines for that period pulled in, the way creating a payout in the app does.2
Keep a multi-partner run in one batch
A payout covers one partner. The batch is the run around them: one period holding one payout per partner, which is what the Payouts page lists as a period. A payout created on its own gets a batch of its own, so paying ten partners for the same quarter that way leaves ten separate runs.Open the batch first when the run covers several partners. Pass To add a partner to a run that already exists, create their payout with the batch’s id. The batch dates the payout, and a partner already on it keeps the payout they have rather than gaining a second.
partnerIds to open every partner’s payout in that one call, then fill each one with lines as usual. Each partner still gets their own commission statement.3
Attach the lines
Post each commission line against the payout id the create call returned. Send
sourceAmount alongside amount when the commission came off a deal value: the statement then prints the calculation, EUR 4,200.00 x 10%, instead of the amount alone.4
Generate the statement
Render the commission statement PDF and get a link to it. The PDF is rebuilt only when something on it changed, so you can call this after every edit and it stays cheap. The link is signed and expires in an hour; You need complete commission billing information and at least one line on the payout, or the call answers
expiresAt tells you when.422 with NO_BILLING_INFO or NO_COMMISSION_LINES. When someone has uploaded their own statement in the app, that PDF is returned untouched and isUploaded is true.Verify it worked
Your finance system shows one row per commission line for the period, and its totals match the batch Total on the Payouts page. Payouts you settled elsewhere read Paid in Introw and in the partner portal, with the PO number printed on the statement. A reward booked from a workflow or the API appears as a pending line on the partner, then inside the next batch, with its description on the partner’s statement.Related
Run a payout cycle
The batch and stages your exports and writes refer to.
Pay a payout cycle with Introw Pay
Let Introw Pay settle the batch instead of your ERP.
Commissions API
Endpoints, stages and request examples.
Implementation reference
Full configuration options.