Skip to main content

get revenue report

POST 
/org/:orgId/revenueReport

Get the revenue report of the given organization, product, entitlement, or buyer.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

Body

required

Get Revenue Report Params

    buyerID string

    Optional, if available, return the report for the Buyer.

    entitlementID string

    Optional, if available, return the report for the Entitlement.

    groupBy GroupByInterval (string)

    Possible values: [day, month]

    organizationID stringrequired

    Required. If the productID & entitlementID are emtpy, return the report for the entire Organization.

    partner stringrequired

    Possible values: [AWS, AZURE, GCP]

    productID string

    Optional, if available, return the report for the Product.

    reportType RevenueReportType (string)required

    Possible values: [GrossAmount, InvoicedAmount, CollectableAmount, DisbursedAmount]

    service stringrequired

    Possible values: [MARKETPLACE]

Responses​

OK

Schema

    buyerID string
    entitlementID string
    groupBy GroupByInterval (string)

    Possible values: [day, month]

    organizationID string
    partner string
    productID string
    reportDate date-time
    reportType RevenueReportType (string)

    Possible values: [GrossAmount, InvoicedAmount, CollectableAmount, DisbursedAmount]

    revenueRecords

    object[]

  • 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
    earningID string
    earningUsd number
    entitlementID string

    estimatedPayoutMonth

    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

    invoiceDueDate

    object

    time string
    valid boolean

    Valid is true if Time is not NULL

    invoiceID string
    offerID string
    organizationID string
    paymentID string

    paymentSentDate

    object

    time string
    valid boolean

    Valid is true if Time is not NULL

    paymentStatus string
    payoutStatus string
    productID string
    programName string
    purchaseRecordID string
    resellerCity string
    resellerCompany string
    resellerCountry string
    resellerEmail string
    resellerID string
    resellerState string
    revenueUsd number
    termEndDate string
    termStartDate string

    transactionDate

    object

    time string
    valid boolean

    Valid is true if Time is not NULL

  • ]

    • bankTraceId string

    The bank trace ID of the revenue record if applicable

    billingModel string

    Possible values: [SubscriptionBased, UsageBased]

    The billing model of the revenue record if applicable The value is one of the following:

    • SubscriptionBased: The revenue record is from a subscription or recurring commitment.
    • UsageBased: The revenue record is from a usage-based metering.
    channel RevenueChannel (string)

    Possible values: [DIRECT, RESOLD]

    creditAmount number

    The credit amount used in the revenue record.

    disbursementBillingEventId string

    The disbursement ID of the revenue record if applicable

    disbursementNotificationSent boolean

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

    earningId string

    The earning ID of the revenue record if applicable

    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.

    paymentId string

    The payment ID of the revenue record if applicable

    resellerId string

    The reseller ID of the revenue record if applicable

    resellerName string

    The reseller name of the revenue record if application

    resource string

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

    invoiceAmount number
    invoiceDate date-time
    organizationID string
    partner string

    The value is from type Partner string

    paymentDueDate date-time
    productID string
    refundDisburseAmount number
    refundDisburseDate date-time
    refundInvoiceAmount number
    refundInvoiceDate date-time
    taxAmount number

  • ]

    • service string
Loading...