Skip to content

Latest commit

 

History

History
99 lines (71 loc) · 4.4 KB

reporting.md

File metadata and controls

99 lines (71 loc) · 4.4 KB
Raw

Reporting

IReportingApi reportingApi = client.ReportingApi;

Class Name

ReportingApi

Methods

List Additional Recipient Receivable Refunds

Returns a list of refunded transactions (across all possible originating locations) relating to monies credited to the provided location ID by another Square account using the additional_recipients field in a transaction.

Max results per page: 50

ListAdditionalRecipientReceivableRefundsAsync(
    string locationId,
    string beginTime = null,
    string endTime = null,
    string sortOrder = null,
    string cursor = null)

Parameters

Parameter Type Tags Description
locationId string Template, Required The ID of the location to list AdditionalRecipientReceivableRefunds for.
beginTime string Query, Optional 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.
endTime string Query, Optional 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.
sortOrder string Query, Optional The order in which results are listed in the response (ASC for
oldest first, DESC for newest first).

Default value: DESC
cursor string Query, Optional 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 Type

Task<Models.ListAdditionalRecipientReceivableRefundsResponse>

Example Usage

string locationId = "location_id4";

try
{
    ListAdditionalRecipientReceivableRefundsResponse result = await reportingApi.ListAdditionalRecipientReceivableRefundsAsync(locationId, null, null, null, null);
}
catch (ApiException e){};

List Additional Recipient Receivables

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

ListAdditionalRecipientReceivablesAsync(
    string locationId,
    string beginTime = null,
    string endTime = null,
    string sortOrder = null,
    string cursor = null)

Parameters

Parameter Type Tags Description
locationId string Template, Required The ID of the location to list AdditionalRecipientReceivables for.
beginTime string Query, Optional 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.
endTime string Query, Optional 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.
sortOrder string Query, Optional The order in which results are listed in the response (ASC for
oldest first, DESC for newest first).

Default value: DESC
cursor string Query, Optional 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 Type

Task<Models.ListAdditionalRecipientReceivablesResponse>

Example Usage

string locationId = "location_id4";

try
{
    ListAdditionalRecipientReceivablesResponse result = await reportingApi.ListAdditionalRecipientReceivablesAsync(locationId, null, null, null, null);
}
catch (ApiException e){};