API referenceReferenceSales payouts
Sales payout - Create
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.
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.
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/business/string/sales_payouts/" \ -H "Content-Type: application/json" \ -d '{ "external_id": "string", "date": "2019-08-24", "amount": 0.1, "items": [ { "amount": 0.1 } ] }'{ "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" } ]}