Current Liability Report

This report provides the liability at the invoice level, on a given day. If run on-demand, the report runs on the date requested. When creating a scheduled report—whether daily, weekly, or monthly—you specify the start date and the report runs on that date.

The report identifies invoices by Customer ID, Invoice ID, Subscription ID, Billing Plan ID, and Affiliate ID if available. Dates include the service period start and end date, and the invoice date. Currency values include the Invoice Total, Payments Received, Payments Due, and Total Refunds. Earned and Unearned values and Liabilities are calculated based on these values.

This report can be generated using Reports 1.0 or Reports 2.0 data engine.

Reports 1.0 data engineProvides the data you need in the reports up to near real-time. Reports data is displayed in UTC time zone. Reports 1.0 lets you select which display columns to include in the report. Report generation is slow and typically lasts several hours.
Reports 2.0 data engine (default)Supports 20 most commonly used Subscribe reports. Reports 2.0 operates in UTC time zone. You can select which time zone to use for the report data display. Reports display all the available columns. Data is available for the prior two years and up to the previous day according to UTC time. Report generation is quicker as data is prepared ahead of time, once a day.

Invoices are included for reporting if:

  • Service Start Date <= Reporting Date < Service End Date
  • Service Start Date > Reporting Date, and the Invoice has been paid off
  • Service End Date <= Reporting Date and the Invoice has not yet been fully paid off

The Earned value is either the full amount, if the Reporting Date <= Service End Date, zero if the Reporting Date is before the Service Start Date, or the ratio of the amount times how much of the service period has been fulfilled. If the invoice is half way through the service period at the Report Date, the Earned value is half the amount.

The Unearned value is the Invoice Total less the Earned Value.

The Liability is either the payment less Refunds and Earned Value or, if the Earned value is more than the Invoice Total less Refunds, the negative of the payment due.

To generate a one time report:

  1. Select from the calendar an Up to Date entry signifying the date up to which you'd like to see current liablity.
  2. Optional. Enter an Email address where you'd like to receive notifications when the report is available. A single email address can be entered.
  3. For Reports 2.0, select the relevant Time Zone for data range selection and display. Data is available for the previous day at 13:00 UTC time.
    Note: A notification error message appears when attempting to run reports for which data is not yet available. The report can be submitted and includes data up to the available time.
  4. Optional. Select the Include Taxes filter for the report.
  5. Click Submit.

    View the report in the My Reports page.

To schedule a recurring report:

  1. Toggle Recurring toggle to Yes.
  2. Select a date for the first reporting period.
    Note: Reports display data occuring starting from the defined date. For example, a monthly report starting on March 1st displays data for the month of March up to March 31st.
  3. Select the report's Frequency. Choose between Weekly or Monthly.
  4. Optional. Enter an Email address where you'd like to receive notifications when the report is available. A single email address can be entered.
  5. For Reports 2.0, select the relevant Time Zone for data range selection and display.
  6. Optional. If you want to receive the report uploaded to an SFTP Server, enable this option and provide the required details.

    When enabled, a scheduled report will be uploaded to the specified SFTP Server. The SFTP report follows the <report name>-<frequency>-<timestamp>.csv naming convention where:

    • <report name> is the name of the report
    • <frequency> is the defined frequency such as monthly, weekly, quarterly, daily or once
    • <timestamp> is the format YYYY-MM-DD"T"HH_MI_SS.TZ, where TZ is the timezone offset, for example, 2022-01-27T10_57_02.433174455Z.

    For this report, the <report name> is current_liability_report.

    Note: An email notification is sent if there is an issue in generating or downloading the report on the specified SFTP Server.
  7. Optional. Select the Include Taxes filter for the report.
  8. Click Submit.

    The report is submitted and will be generated according to the details provided. If you have provided an email or SFTP details, you will be notified when it is available for viewing.

  9. View the report in the My Reports page.

Display Columns

Note: The report's display columns order is machine-generated and may therefore change without prior notice.
FieldDescription
Reporting DateDate provided by the Merchant. The report data is as-of this date. The report is run at this date at 24:00:00.
Customer IDMerchant’s ID for the customer for whom the invoice is generated.
Subscription IDThe ID of the Subscription for which the invoice is generated.
Affiliate IDAffiliate ID associated with the Subscription—indicates the sub group within merchant.
Invoice IDMerchant’s Invoice ID.
Billing PlanMerchant Billing Plan Identifier of the Subscription.
Service Period StartStart date of the Service Period for the invoice.
Service Period EndEnd date of the Service Period for the invoice.
Invoice DateOriginal activity date of the invoice.
CurrencyCurrency code of the payment.
Invoice TotalTotal Amount of the Invoice.
Payment ReceivedTotal Payments made against this invoice.
Yet to be PaidDifference between Invoice Total and Payments received.
Total RefundsSum of Refunds that have been done against transaction(s) for this invoice.
Earned

Earned and Unearned are calculated on Invoice line items based on the following logic, then summed for Invoice level

  • Earned is calculated as below if (Service Start Date <= Reporting Date < Service End Date):

    Amount * (number of days between Service start Date and Reporting date /number of dates in service period).

    (Service period start date, Service End Date and Reporting date are inclusive)

  • Earned is "0" if Service Period Start Date > Reporting Date.
  • Earned is "Amount" if Service End Date <= Reporting Date.
Yet to be EarnedDifference between Invoice Total and Earned.
Liability

Liability is calculated as below:

If (Total - refunds) < Earned then Liability = -1 * 'Yet to be Paid'

else Liability = (Payments received - Refunds) - Earned