API referenceReferenceSales payouts
Sales payouts - List
List card/POS processor payouts ingested for this business. These records are the source for later bank matching and booking.
Path Parameters
business_slug*string
Business slug that scopes this request. If you do not have one yet, call common_accessible_businesses_list and pick a slug from the response.
Query Parameters
page?integer
A page number within the paginated result set.
page_size?integer
Number of results to return per page.
Response Body
application/json
curl -X GET "https://example.com/v1/business/string/sales_payouts/"{ "count": 123, "next": 2, "prev": 1, "size": 30, "results": [ { "id": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "external_id": "string", "end_to_end_id": "string", "source": "string", "date": "2019-08-24", "amount": 0.1, "currency": "str", "description": "string", "attachments": [ 0 ], "items": [ { "id": 0, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "amount": 0.1, "description": "string", "vat_code": 1, "vat_rate": "string", "account_number": "string" } ] } ]}VAT period - Replace PUT
Replace one VAT period (`vat_period_id`) for the selected business (`business_slug`) using a full payload.
Sales payout - Create POST
Create a sales payout with signed line items. The sum of item amounts must equal the net payout amount. external_id must be unique per business. end_to_end_id is the bank-statement reference used for later matching.