Ledger Endpoint

Introductionback to top

Use this endpoint to retrieve your commission (ledger) data. All requests require your clientId. You can find your clientId under the Account Profile section when you log into to your GPN account.

Please note, this endpoint DOES NOT support setting the report timezone. All date/times are reported in UTC only.

This endpoint supports the following dimensions

URLback to top

https://partner-int-api.groupon.com/reporting/v2/ledger

Supported Formatsback to top

  • JSON
  • XML (default)
  • CSV

Sample Callsback to top

Sample Requests

Retrieve all my daily commission data for the year 2014, filtered by GBP currency. This effectively groups by day

https://partner-int-api.groupon.com/reporting/v2/ledger.json?clientId=0a1f0db1ba5f4ab4d54e8c1aefebfa641ff3e75f&group=date&date=[2014-01-01&date=2014-12-31]&currency=GBP

Retrieve all my commission data by currency for the year 2014. This effectively groups by currency.

https://partner-int-api.groupon.com/reporting/v2/ledger.json?clientId=0a1f0db1ba5f4ab4d54e8c1aefebfa641ff3e75f&group=currency&date=[2014-01-01&date=2014-12-31]

Note for ledger amounts in different currencies, the currency summary values will be incorrect as we currently do not support currency conversion.

Measuresback to top

The following measures are supported by the campaign endpoint.

Name Type Description
CreditAmount Decimal Ledger credit amount in currency units
DebitAmount Decimal Ledger debit amount in currency units
Total Decimal Ledger total amount (credit minus debit) in currency units
Count Integer Number of ledger

Dimensionsback to top

The following dimensions are supported by the order endpoint.

Dimension Name Default Search Default Grouping Description Mandatory
Invoice cutoff id The invoice No
LedgerType name name The ledger Type No
Currency isocode isocode The ledger currency No
Date datetime datetime The date/time dimension with a granularity level of one hour Yes

Invoice

Information Name Type Description
CutOff String Invoice Date
RunDate DateTime Invoice running date
Currency String Invoice Currency
Amount Integer Amount in currency minor units
PaymentUUID String Payment uuid

Ledger Type

Information Name Type Description
Name String The ledger type (SALE,REFUND,BONUS,PAYMENT)

Ledger Currency

Information Name Type Description
Isocode String Currency Iso Code
Name String Currency Name

Deal

Information Name Type Description
PermaLink String The deal permalink uniquely identifies a Groupon deal

Date

Information Name Type Description
Day Date The day
Datetime Datetime The day and hour
Year Integer The Year
Month String The month in year (eg: 2014-07)
MonthName String The month name (eg: July)
MonthNum Integer The month number (eg: 7)
DayOfMonth Integer The day in the month (eg 15 for 15th July 2014)
DayOfWeek Integer The day in the week (1 for Sunday)
DayOfWeekName String The day of week name
HourOfDay Integer The hour in the day (00 to 23)