Sign in
latestOpenAPI 3.0.12026-08-101292701.1 MB

f21981db32be

Sales summaries

Gets a sales summary by ID

Retrieves the details of a sales summary. Supply the unique identifier of the sales summary.

get/sales-summaries/{id}

Path parameters

idstring required

Sales summary ID

Response

OK.

idstring

Unique identifier for the sales summary

createdTimestring date-time

Time at which the sales summary was created

salesClosingTimestring date-time

Time at which the sales summary was closed

currencystring

Three-letter ISO currency code representing the sales summary currency.

amountnumber double

Represents the total sales summary amount.

payoutIdstring

Payout identifier

paidboolean

If true, indicates that this sales summary has been paid.

payerIdstring

The ID of payer.

payerNamestring

The name of the payer

payeeIdstring

The ID of the payee.

payeeNamestring

The name of the payee.

liveModeboolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example response

{
  "id": "8100000400_1410_2019",
  "createdTime": "2019-04-25T20:36:00Z",
  "salesClosingTime": "2019-04-25T00:00:00Z",
  "currency": "USD",
  "amount": 1180.26,
  "payoutId": "2000028600_1410_2019",
  "paid": true,
  "payerId": "1410",
  "payerName": "DR globalTech, Inc.",
  "payeeId": "0013900100",
  "payeeName": "ACME, Inc.",
  "liveMode": true
}