• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

You are viewing an old version of the API
List additional recipient receivables

Deprecated

Returns a list of receivables (across all possible sending locations) representing monies credited to the provided location ID by another Square account using the additional_recipients field in a transaction.

Max results per page: 50

Required permissions: PAYMENTS_READ

Path Parameters

Name Description
location_id
string

Required

The ID of the location to list AdditionalRecipientReceivables for.

Query Parameters

Name Description
begin_time
string

The beginning of the requested reporting period, in RFC 3339 format.

See Date ranges for details on date inclusivity/exclusivity.

Default value: The current time minus one year.

end_time
string

The end of the requested reporting period, in RFC 3339 format.

See Date ranges for details on date inclusivity/exclusivity.

Default value: The current time.

sort_order
string

The order in which results are listed in the response (ASC for oldest first, DESC for newest first).

Default value: DESC

cursor
string

A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.

See Paginating results for more information.

Response Fields

Name Description
errors
Error [ ]

Any errors that occurred during the request.

receivables
AdditionalRecipientReceivable [ ]

An array of AdditionalRecipientReceivables that match your query.

cursor
string

A pagination cursor for retrieving the next set of results, if any remain. Provide this value as the cursor parameter in a subsequent request to this endpoint.

See Paginating results for more information.

Examples

You are viewing an old version of the API