list daily revenue records

GET 
/org/:orgId/dailyRevenueRecord

list daily revenue records for the given organization, partner, entitlement, or buyer, within the given date range.

Request

Path Parameters

orgId stringrequired

Organization ID

Query Parameters

partner string

Possible values: [AWS, AZURE, GCP]

Cloud Partner

productId string

Filter daily revenue records by the given product ID

buyerId string

Filter daily revenue records by the given buyer ID

entitlementId string

Filter daily revenue records by the given entitlement ID

startDate string

start date (UTC) in YYYY-MM-DD format, default is 30 days before the endDate

endDate string

end date (UTC) in YYYY-MM-DD format, default is today

Responses

200

OK

application/json

Schema

Schema

• Array [

amount number

The revenue amount for the revenue report

buyerID string
collectableAmount number

The revenue amount that the seller/ISV can collect.

currency string

The currency of the revenue in ISO 4217 format, such as "USD".

date date-time

The date for the revenue report

disburseAmount number
disburseDate date-time
entitlementID string
id string

info

object

awsRevenueRecords

object[]

For raw revenue records in AWS Marketplace

Array [

action string

agreementID string

amount number

balanceImpacting integer

bankTraceID string

billingAddressID string

brokerID string

buyerID string

currency string

dataFeedProductID string

disbursementBillingEventID string

endUserAccountID string

entitlementID string

fromAccountID string

id string

insertDate

object

time string

valid boolean

Valid is true if Time is not NULL

invoiceDate

object

time string

valid boolean

Valid is true if Time is not NULL

invoiceID string

offerID string

organizationID string

parentBillingEventID string

paymentDueDate

object

time string

valid boolean

Valid is true if Time is not NULL

productID string

toAccountID string

transactionReferenceID string

transactionType string

usagePeriodEndDate

object

time string

valid boolean

Valid is true if Time is not NULL

usagePeriodStartDate

object

time string

valid boolean

Valid is true if Time is not NULL

]

azureRevenueRecords

object[]

For raw revenue records in Azure Marketplace

Array [

azureAssetID string

azureBillingAccountID string

azureCustomerID string

azureOfferID string

azurePlanID string

billingModel string

buyerID string

earningUsd number

entitlementID string

estimatedPayoutMonth

object

time string

valid boolean

Valid is true if Time is not NULL

offerID string

organizationID string

paymentSentDate

object

time string

valid boolean

Valid is true if Time is not NULL

payoutStatus string

productID string

purchaseRecordID string

revenueUsd number

termEndDate string

termStartDate string

]

creditAmount number

The credit amount used in the revenue record.

disbursementNotificationSent boolean

Whether the disbursement notification has been sent to the seller/ISV.

gcpRevenueRecords

object[]

For raw revenue records in GCP Marketplace

Array [

abandoned number

accountID string

buyerID string

charges number

currency string

dueVendor number

entitlementID string

googleEntity string

insightAccountID string

offerID string

ordinal integer

organizationID string

paymentSchedule string

paymentType string

prepayCredits number

productID string

refundBalanceDeductedThisMonth number

refundBalanceOutstanding number

refundReason string

released number

reportDate string

resource string

sku string

trialUse number

unit string

usage number

usedBy string

withheld number

]

idSource string

Source of the revenue record ID.

resource string

Resource name for the revenue record. Applicable only to GCP Marketplace.

invoiceAmount number
invoiceDate date-time
organizationID string
partner string
paymentDueDate date-time
productID string
refundDisburseAmount number
refundDisburseDate date-time
refundInvoiceAmount number
refundInvoiceDate date-time
taxAmount number

• ]

Example (from schema)

[
  {
    "amount": 0,
    "buyerID": "string",
    "collectableAmount": 0,
    "currency": "string",
    "date": "2024-08-12T01:02:13.065Z",
    "disburseAmount": 0,
    "disburseDate": "2024-08-12T01:02:13.065Z",
    "entitlementID": "string",
    "id": "string",
    "info": {
      "awsRevenueRecords": [
        {
          "action": "string",
          "agreementID": "string",
          "amount": 0,
          "balanceImpacting": 0,
          "bankTraceID": "string",
          "billingAddressID": "string",
          "brokerID": "string",
          "buyerID": "string",
          "currency": "string",
          "dataFeedProductID": "string",
          "disbursementBillingEventID": "string",
          "endUserAccountID": "string",
          "entitlementID": "string",
          "fromAccountID": "string",
          "id": "string",
          "insertDate": {
            "time": "string",
            "valid": true
          },
          "invoiceDate": {
            "time": "string",
            "valid": true
          },
          "invoiceID": "string",
          "offerID": "string",
          "organizationID": "string",
          "parentBillingEventID": "string",
          "paymentDueDate": {
            "time": "string",
            "valid": true
          },
          "productID": "string",
          "toAccountID": "string",
          "transactionReferenceID": "string",
          "transactionType": "string",
          "usagePeriodEndDate": {
            "time": "string",
            "valid": true
          },
          "usagePeriodStartDate": {
            "time": "string",
            "valid": true
          }
        }
      ],
      "azureRevenueRecords": [
        {
          "azureAssetID": "string",
          "azureBillingAccountID": "string",
          "azureCustomerID": "string",
          "azureOfferID": "string",
          "azurePlanID": "string",
          "billingModel": "string",
          "buyerID": "string",
          "earningUsd": 0,
          "entitlementID": "string",
          "estimatedPayoutMonth": {
            "time": "string",
            "valid": true
          },
          "offerID": "string",
          "organizationID": "string",
          "paymentSentDate": {
            "time": "string",
            "valid": true
          },
          "payoutStatus": "string",
          "productID": "string",
          "purchaseRecordID": "string",
          "revenueUsd": 0,
          "termEndDate": "string",
          "termStartDate": "string"
        }
      ],
      "creditAmount": 0,
      "disbursementNotificationSent": true,
      "gcpRevenueRecords": [
        {
          "abandoned": 0,
          "accountID": "string",
          "buyerID": "string",
          "charges": 0,
          "currency": "string",
          "dueVendor": 0,
          "entitlementID": "string",
          "googleEntity": "string",
          "insightAccountID": "string",
          "offerID": "string",
          "ordinal": 0,
          "organizationID": "string",
          "paymentSchedule": "string",
          "paymentType": "string",
          "prepayCredits": 0,
          "productID": "string",
          "refundBalanceDeductedThisMonth": 0,
          "refundBalanceOutstanding": 0,
          "refundReason": "string",
          "released": 0,
          "reportDate": "string",
          "resource": "string",
          "sku": "string",
          "trialUse": 0,
          "unit": "string",
          "usage": 0,
          "usedBy": "string",
          "withheld": 0
        }
      ],
      "idSource": "string",
      "resource": "string"
    },
    "invoiceAmount": 0,
    "invoiceDate": "2024-08-12T01:02:13.065Z",
    "organizationID": "string",
    "partner": "string",
    "paymentDueDate": "2024-08-12T01:02:13.065Z",
    "productID": "string",
    "refundDisburseAmount": 0,
    "refundDisburseDate": "2024-08-12T01:02:13.065Z",
    "refundInvoiceAmount": 0,
    "refundInvoiceDate": "2024-08-12T01:02:13.065Z",
    "taxAmount": 0
  }
]

400

Bad request error

application/json

Schema

Schema

string

500

Internal server error

application/json

Schema

Schema

string

Loading...