afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/BillingSchedule.json

{
  "sections": [
    "title",
    "description",
    "fields",
    "special_access_rules",
    "field_reference"
  ],
  "title": "BillingSchedule - Data API",
  "description": "Stores the order item information used in the invoicing process. This object is available in API version 55.0 and later.",
  "fields_columns": [
    "type",
    "properties",
    "description",
    "relationship_name",
    "refers_to",
    "relationship_type"
  ],
  "fields": {
    "BillDayOfMonth": {
      "type": "int",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "An integer from 1 to 31 that indicates the day of the month."
    },
    "BilledAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The total amount (excluding tax) that has been invoiced from the billing schedule. This field is a calculated field."
    },
    "BillingAccountId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "This field is a relationship field.",
      "relationship_name": "BillingAccount",
      "refers_to": "Account"
    },
    "BillingPeriodAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The amount to be invoiced each billing period. For example, if the billing period is monthly, this field shows the monthly amount that appears on the invoice line."
    },
    "BillingScheduleEndDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The last date that the billing schedule is available for invoicing. Inherited from the EndDate field on the order item."
    },
    "BillingScheduleGroupId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "ID of the billing schedule group that contains the billing schedule. Billing schedules are grouped when they have the same source order item. The source order item is the original order item that a customer bought. Afterwards, if the customer amends, cancels, or renews the order item, a new billing schedule is created with the BillingScheduleGroupId for the original order item. This field is a relationship field.",
      "relationship_name": "BillingScheduleGroup",
      "relationship_type": "Lookup",
      "refers_to": "BillingScheduleGroup"
    },
    "BillingScheduleNumber": {
      "type": "string",
      "properties": "Autonumber, Defaulted on create, Filter, idLookup, Sort",
      "description": "Autogenerated reference number for the billing schedule."
    },
    "BillingScheduleStartDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The date that the billing schedule is available for invoicing. Inherited from the ServiceDate on the order item."
    },
    "BilledThroughPeriod": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The last billing period that includes this date."
    },
    "BillingTreatmentItemId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "The billing treatment item used to configure invoiceable amounts on the billing schedule. This field is a relationship field.",
      "relationship_name": "BillingTreatmentItem",
      "relationship_type": "Lookup",
      "refers_to": "BillingTreatmentItem"
    },
    "CancellationDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The date on which the subscriber can no longer access the service. For example, if a service ends on August 31, then the cancellation date is September 1, because that’s the date when the subscriber can no longer use the service. Subscription Management doesn't invoice billing schedules past their cancellation date."
    },
    "Category": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "The business action represented by the billing schedule. Possible values are: AmendQuantity—A billing schedule for an order that changes the quantity. This object is available in API version 56.0 and later. Cancellation—A billing schedule for an order that was canceled Original—A billing schedule for the initial order Renewal—A billing schedule for an order that was renewed"
    },
    "CurrencyIsoCode": {
      "type": "picklist",
      "properties": "Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
      "description": "Three-letter ISO 4217 currency code associated with the invoice. The default value is USD."
    },
    "InvoiceBatchRunId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The invoice batch run that evaluated this billing schedule and its billing period items to produce an invoice. This field is a relationship field.",
      "relationship_name": "InvoiceBatchRun",
      "relationship_type": "Lookup",
      "refers_to": "InvoiceBatchRun"
    },
    "InvoiceRunBatch": {
      "type": "picklist",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The batch value used by the invoice run that evaluated this billing schedule. During an invoice run, billing schedules with the same batch value (including null) are grouped to the same invoice run. For example, create one batch of invoices for Premium Customers and another batch for Regular Customers. Possible values are: Premium Customers Regular Customers"
    },
    "NextBillingDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The date that the next billing period starts for the invoice. Used to calculate which invoice lines are included on an invoice. When an invoice scheduler or API evaluates an order for invoicing, billing schedules with a next billing date on or before the invoice's target date are included on the invoice."
    },
    "NextChargeFromDate": {
      "type": "date",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The date that the billing schedule is invoiced in the upcoming billing period. For example, if you invoiced a customer for a billing period of 01/01/22 through 01/31/22, the billing schedule's NextChargeFromDate is 02/01/22."
    },
    "OriginalBillingScheduleId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "If this billing schedule is an amended or canceled billing schedule, then this field shows the original billing schedule. Otherwise, this field is null. This field is a relationship field.",
      "relationship_name": "OriginalBillingSchedule",
      "relationship_type": "Lookup",
      "refers_to": "BillingSchedule"
    },
    "PendingAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The amount from the current billing term that hasn't been billed yet. For example, the unbilled amount for a month, quarter, or year, depending on this billing schedule's billing term."
    },
    "Quantity": {
      "type": "double",
      "properties": "Filter, Nillable, Sort",
      "description": "The quantity of the order item that created the billing schedule."
    },
    "ReferenceEntityId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The parent order of the order item that created the billing schedule. This field is a polymorphic relationship field.",
      "relationship_name": "ReferenceEntity",
      "relationship_type": "Lookup",
      "refers_to": "Order"
    },
    "ReferenceEntityItemId": {
      "type": "reference",
      "properties": "Filter, Group, Nillable, Sort",
      "description": "The order item or asset that created the billing schedule. This field is a polymorphic relationship field.",
      "relationship_name": "ReferenceEntityItem",
      "relationship_type": "Lookup",
      "refers_to": "OrderItem, OrderItemAdjustementLineTime, or OrderItemSummary"
    },
    "Status": {
      "type": "picklist",
      "properties": "Filter, Group, Restricted picklist, Sort",
      "description": "The state of the order item that the billing schedule represents. Possible values are: CompletelyBilled Error Processing ReadyForInvoicing"
    },
    "TaxTreatmentId": {
      "type": "reference",
      "properties": "Filter, Group, Sort",
      "description": "Shows the treatment used to calculate tax for the billing schedule. Defined based on the order item's tax policy. This field is a relationship field.",
      "relationship_name": "TaxTreatment",
      "relationship_type": "Lookup",
      "refers_to": "TaxTreatment"
    },
    "TotalAmount": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The total amount of the order item represented by the billing schedule."
    },
    "UnitPrice": {
      "type": "currency",
      "properties": "Filter, Nillable, Sort",
      "description": "The price for an individual unit of the billing schedule's parent order item, including charges, adjustments, and discounts. Inherited from the order item's UnitPrice field."
    }
  },
  "special_access_rules": "This object is available with Subscription Management and Billing (Revenue Cloud). For information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.\n\nThis object is available with Subscription Management and Billing (Revenue Cloud).\n\nFor information about this object that's available with Billing (Revenue Cloud), including its special access rules, see the Revenue Cloud Developer Guide.",
  "field_reference": {
    "BilledAmount": {
      "field_label": "Billed Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "BilledThroughPeriod": {
      "field_label": "Last billing period that includes this date",
      "type": "date"
    },
    "BillingPeriodAmount": {
      "field_label": "Billing Period Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "BillingScheduleEndDate": {
      "field_label": "Billing Schedule End Date",
      "type": "date"
    },
    "BillingScheduleGroupId": {
      "field_label": "Billing Schedule Group ID",
      "type": "reference",
      "length": "18"
    },
    "BillingScheduleNumber": {
      "field_label": "Name",
      "type": "string",
      "length": "255"
    },
    "BillingScheduleStartDate": {
      "field_label": "Billing Schedule Start Date",
      "type": "date"
    },
    "BillingTreatmentItemId": {
      "field_label": "Billing Treatment Item ID",
      "type": "reference",
      "length": "18"
    },
    "CancellationDate": {
      "field_label": "Cancellation Date",
      "type": "date"
    },
    "Category": {
      "field_label": "Category",
      "type": "picklist",
      "length": "255"
    },
    "CreatedById": {
      "field_label": "Created By ID",
      "type": "reference",
      "length": "18"
    },
    "CreatedDate": {
      "field_label": "Created Date",
      "type": "datetime"
    },
    "ExternalReference": {
      "field_label": "External Reference Id",
      "type": "string",
      "length": "18"
    },
    "ExternalReferenceItem": {
      "field_label": "External Reference Item Id",
      "type": "string",
      "length": "18"
    },
    "Id": {
      "field_label": "Billing Schedule ID",
      "type": "id",
      "length": "18"
    },
    "InvoiceRunMatchingValue": {
      "field_label": "Invoice Run Matching Value",
      "type": "picklist",
      "length": "40"
    },
    "IsBilledThroughPeriodUpdated": {
      "field_label": "Is Billed Through Period Updated",
      "type": "boolean"
    },
    "IsDeleted": {
      "field_label": "Deleted",
      "type": "boolean"
    },
    "LastModifiedById": {
      "field_label": "Last Modified By ID",
      "type": "reference",
      "length": "18"
    },
    "LastModifiedDate": {
      "field_label": "Last Modified Date",
      "type": "datetime"
    },
    "NetUnitPrice": {
      "field_label": "Net Unit Price",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "NextBillingDate": {
      "field_label": "Next Billing Date",
      "type": "date"
    },
    "NextChargeFromDate": {
      "field_label": "Next Charge From Date",
      "type": "date"
    },
    "OriginalBillingScheduleId": {
      "field_label": "Billing Schedule ID",
      "type": "reference",
      "length": "18"
    },
    "PendingAmount": {
      "field_label": "Pending Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "Quantity": {
      "field_label": "Quantity",
      "type": "double",
      "precision": "18",
      "scale": "2"
    },
    "ReferenceEntityId": {
      "field_label": "ReferenceEntity ID",
      "type": "reference",
      "length": "18"
    },
    "ReferenceEntityItemId": {
      "field_label": "ReferenceEntityItem ID",
      "type": "reference",
      "length": "18"
    },
    "Status": {
      "field_label": "Status",
      "type": "picklist",
      "length": "255"
    },
    "SystemModstamp": {
      "field_label": "System Modstamp",
      "type": "datetime"
    },
    "TaxTreatmentId": {
      "field_label": "Tax Treatment ID",
      "type": "reference",
      "length": "18"
    },
    "TotalAmount": {
      "field_label": "Total Amount",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    },
    "UnitPrice": {
      "field_label": "Unit Price",
      "type": "currency",
      "precision": "18",
      "scale": "2"
    }
  },
  "field_reference_columns": [
    "field_label",
    "type",
    "precision",
    "scale",
    "length"
  ]
}