list revenue record details

GET 
/org/:orgId/partner/:partner/revenueRecordDetail

list the raw revenue record details for the given organization, partner, product, entitlement, or buyer.

Request

Path Parameters

orgId stringrequired

Organization ID

partner stringrequired

Possible values: [AWS, AZURE, GCP]

Cloud Partner

Query Parameters

productId string

Filter revenue record details by the given product ID

buyerId string

Filter revenue record details by the given buyer ID

entitlementId string

Filter revenue record details 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

limit integer

List pagination size, default 1000, max value is 1000

offset integer

List pagination offset, default 0

Responses

200

OK

application/json

Schema

Schema

nextOffset integer

revenueRecordDetails

object[]

Array [

awsRevenueRecordDetail

object

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

azureRevenueRecordDetail

object

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

gcpRevenueRecordDetail

object

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

]

Example (from schema)

{
  "nextOffset": 0,
  "revenueRecordDetails": [
    {
      "awsRevenueRecordDetail": {
        "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
        }
      },
      "azureRevenueRecordDetail": {
        "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"
      },
      "gcpRevenueRecordDetail": {
        "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
      }
    }
  ]
}

400

Bad request error

application/json

Schema

Schema

string

500

Internal server error

application/json

Schema

Schema

string

Loading...