SAP BRIM (Billing and Revenue Innovation Management) · Schema

BillingRecord

BillingEnterpriseOrder to CashRevenue ManagementSAPSubscription ManagementUsage-Based Pricing

Properties

Name	Type	Description
billingRecordId	string
subscriptionId	string
invoiceNumber	string
billingPeriodStart	string
billingPeriodEnd	string
subtotal	object
tax	object
total	object
status	string
issuedAt	string
dueDate	string
paidAt	string
lineItems	array

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BillingRecord",
  "title": "BillingRecord",
  "type": "object",
  "properties": {
    "billingRecordId": {
      "type": "string",
      "format": "uuid"
    },
    "subscriptionId": {
      "type": "string",
      "format": "uuid"
    },
    "invoiceNumber": {
      "type": "string"
    },
    "billingPeriodStart": {
      "type": "string",
      "format": "date"
    },
    "billingPeriodEnd": {
      "type": "string",
      "format": "date"
    },
    "subtotal": {
      "$ref": "#/components/schemas/MonetaryAmount"
    },
    "tax": {
      "$ref": "#/components/schemas/MonetaryAmount"
    },
    "total": {
      "$ref": "#/components/schemas/MonetaryAmount"
    },
    "status": {
      "type": "string",
      "enum": [
        "DRAFT",
        "ISSUED",
        "PAID",
        "OVERDUE",
        "VOID"
      ]
    },
    "issuedAt": {
      "type": "string",
      "format": "date-time"
    },
    "dueDate": {
      "type": "string",
      "format": "date"
    },
    "paidAt": {
      "type": "string",
      "format": "date-time"
    },
    "lineItems": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "description": {
            "type": "string"
          },
          "quantity": {
            "type": "number"
          },
          "unitPrice": {
            "$ref": "#/components/schemas/MonetaryAmount"
          },
          "amount": {
            "$ref": "#/components/schemas/MonetaryAmount"
          }
        }
      }
    }
  }
}