Add Sales statements to a batch

Share Business's sales data with finmid so that finmid calculates the collection amounts for you.

Once a Funding Offer has been accepted, payment amounts can be calculated and collected. The platform shares the Business's sales revenue (Sales statements) with finmid, and finmid calculates the repayment_amount based on the repayment_percent specified in the terms of the accepted Offer.

Alternative: Report Payment

If you calculate the collection amounts yourself, use Report Payment APIs instead.

After adding Sales Statements

The API response contains the calculated repayment_amount and platform_commission_amount for each Business. You can also retrieve the aggregated results at any time using Get Sales Statements API.

The next step depends on your integration model:

  • Platform-funded: Collect the funds from your businesses and then confirm the collection using Report Funds Collection API.
  • finmid-funded: Collect the funds from your businesses and send the repayment_amount to finmid's bank account via bank transfer, using the batch_id as reference text (simulated via Sales statements batch payment API in sandbox).

Options

It is possible to limit the maximum value of the repayment_amount calculated for the reported sales_amount by specifying the net_amount. As a result, the repayment_amount for the reported Sales Statement entry will not exceed the net_amount.

Within each Business, you can additionally group Sales statements by providing a Sales Statement group_id value. This allows sales and payment data in the API response to be aggregated separately for each business_id/group_id pair.

Sales statements should be shared periodically. The period is defined in the API as a "Batch", which aggregates the Sales statements of one or several Businesses for a given period.

Language
Credentials
Header
URL
Response
Click Try It! to start a request and see the response here!