get revenue report
POST/org/:orgId/revenueReport
Get the revenue report of the given organization, product, entitlement, or buyer.
Request
Path Parameters
Organization ID
- application/json
Body
required
Get Revenue Report Params
Optional, if available, return the report for the Buyer.
Optional, if available, return the report for the Entitlement.
Required. If the productID & entitlementID are emtpy, return the report for the entire Organization.
Possible values: [AWS
, AZURE
, GCP
]
Optional, if available, return the report for the Product.
Possible values: [GrossAmount
, InvoicedAmount
, CollectableAmount
, DisbursedAmount
]
Possible values: [MARKETPLACE
]
Responses
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
Array [
]
]
Possible values: [GrossAmount
, InvoicedAmount
, CollectableAmount
, DisbursedAmount
]
revenueRecords
object[]
The revenue amount for the revenue report
The revenue amount that the seller/ISV can collect.
The currency of the revenue in ISO 4217 format, such as "USD".
The date for the revenue report
info
object
awsRevenueRecords
object[]
For raw revenue records in AWS Marketplace
insertDate
object
Valid is true if Time is not NULL
invoiceDate
object
Valid is true if Time is not NULL
paymentDueDate
object
Valid is true if Time is not NULL
usagePeriodEndDate
object
Valid is true if Time is not NULL
usagePeriodStartDate
object
Valid is true if Time is not NULL
azureRevenueRecords
object[]
For raw revenue records in Azure Marketplace
estimatedPayoutMonth
object
Valid is true if Time is not NULL
paymentSentDate
object
Valid is true if Time is not NULL
The credit amount used in the revenue record.
Whether the disbursement notification has been sent to the seller/ISV.
gcpRevenueRecords
object[]
For raw revenue records in GCP Marketplace
Source of the revenue record ID.
Resource name for the revenue record. Applicable only to GCP Marketplace.
{
"buyerID": "string",
"entitlementID": "string",
"organizationID": "string",
"partner": "string",
"productID": "string",
"reportDate": "2024-08-12T01:02:15.870Z",
"reportType": "GrossAmount",
"revenueRecords": [
{
"amount": 0,
"buyerID": "string",
"collectableAmount": 0,
"currency": "string",
"date": "2024-08-12T01:02:15.870Z",
"disburseAmount": 0,
"disburseDate": "2024-08-12T01:02:15.870Z",
"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:15.870Z",
"organizationID": "string",
"partner": "string",
"paymentDueDate": "2024-08-12T01:02:15.870Z",
"productID": "string",
"refundDisburseAmount": 0,
"refundDisburseDate": "2024-08-12T01:02:15.870Z",
"refundInvoiceAmount": 0,
"refundInvoiceDate": "2024-08-12T01:02:15.870Z",
"taxAmount": 0
}
],
"service": "string"
}
Bad request error
- application/json
- Schema
Schema
string
Internal server error
- application/json
- Schema
Schema
string