Developers
API referenceReferenceSales payouts

Sales payout - Retrieve

Retrieve one sales payout by ID, including its line items.

GET
/v1/business/{business_slug}/sales_payouts/{sales_payout_id}/

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.

sales_payout_id*integer

Identifier of the target sales payout. If the ID is not known, use the corresponding list endpoint with relevant filters and/or the search parameter to discover valid IDs.

Response Body

application/json

curl -X GET "https://example.com/v1/business/string/sales_payouts/0/"
{  "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"    }  ]}