RevRecFD

Last updated
Save as PDF

Overview

This reference defines fields associated with Revenue Recognition REST API calls. See the specific REST API reference on the call details.

accountId

An account ID.

accountingPeriodEndDate

The accounting period end date. The accounting period end date of the open-ended accounting period is null.

accountingPeriodName

Name of the accounting period. The open-ended accounting period is named Open-Ended.

accountingPeriodStartDate

The accounting period start date.

amount

The revenue schedule amount, which is the sum of all revenue items. This field cannot be null and must be formatted based on the currency, such as JPY 30 or USD 30.15. Test out the currency to ensure you are using the proper formatting otherwise, the response will fail and this error message is returned: "Allocation amount with wrong decimal places."

amount-revenueItem

The amount of the revenue item.

cf_pkn__c

One or more optional custom fields, where n is the maximum number of custom fields allowed.

cf_txtn__c

One or more optional custom fields, where n is the maximum number of custom fields allowed.

code

An eight-digit numeric error code.

charge-id

The charge ID.

charge-key

ID of the subscription rate plan charge; for example, 402892793e173340013e173b81000012.

createdOn

The date when the record was created in YYYY-MM-DD HH:MM:SS format.

crs-number

The charge revenue summary number.

currency

The type of currency used.

deferredRevenueAccountingCode

The accounting code for deferred revenue, such as Monthly Recurring Liability. Required only when overrideChargeAccountingCodes is true. Otherwise this value is ignored.

deferredRevenueAccountingCodeType

The type associated with the deferred revenue accounting code, such as Deferred Revenue. Required only when overrideChargeAccountingCodes is true. Otherwise this value is ignored.

distributeOn_milestone

The recognition date on which to distribute revenue for milestone-based recognition.

Type: date in YYYY-MM-DD format.

distributionType_milestone

How to distribute the revenue for milestone-based recognition.

Type: string (enum)

Values are:

specific date (delta fixed amount)
specific date (delta percent total)
specific date (delta percent undistributed)

distributionType

How you want to distribute the revenue. The distribution types are described in the following table.

Value	Description
Daily Distribution	Distributes revenue evenly across each day between the recognitionStart and recognitionEnd dates.
Monthly Distribution (Back Load)	Back loads the revenue so you distribute the monthly amount in the partial month at the end only.
Monthly Distribution (Front Load)	Front loads the revenue so you distribute the monthly amount in the partial month at the beginning only.
Monthly Distribution (Proration by Days)	Splits the revenue amount between the two partial months.

See Components and Configuration Options for more information about Front Load, Back Load, and Proration by Days for Monthly Distribution.

The default value is Daily Distribution.

To use any of the Monthly Distribution options, you must have the "Monthly recognition over time" model enabled in Settings > Z-Finance Settings > Manage Revenue Recognition Models.

event-number

The number associated with the revenue event.

eventType

Label of the revenue event type. Revenue event type labels can be duplicated. You can configure your revenue event type labels by navigating to Settings > Z-Finance Settings > Configure Revenue Event Types in the Zuora UI. The default revenue event types are:

Invoice Posted
Invoice Item Adjustment Created
Invoice Canceled
Invoice Item Adjustment Canceled
Revenue Distributed

eventTypeSystemId

System ID of the revenue event type. Each eventType has a unique system ID. You can configure your revenue event type system IDs by navigating to Settings > Z-Finance Settings > Configure Revenue Event Types in the Zuora UI.

invoice-item-adj-key

ID or number of the Invoice Item Adjustment, for example, e20b07fd416dcfcf0141c81164fd0a72.

invoice-item-id

ID of the Invoice Item, for example, e20b07fd416dcfcf0141c81164fd0a75.

isAccountingPeriodClosed

Indicates if the accounting period is closed or open.

linkedTransactionId

The linked transaction ID for billing transactions. This field is used for all rules except the custom unlimited or manual recognition rule models. If using the custom unlimited rule model, then the field value must be null. If the field is not null, then the referenceId field must be null.

linkedTransactionNumber

The number for the linked invoice item or invoice item adjustment transaction. This field is used for all rules except the custom unlimited or manual recognition rule models. If using the custom unlimited or manual recognition rule models, then the field value is null.

linkedTransactionType

The type of linked transaction for billing transactions, which can be invoice item or invoice item adjustment. This field is used for all rules except the custom unlimited or manual recognition rule models.

message

A description of the error.

Provides hyperlinks to view the next pages.

newAmount

Amount of revenue you want to distribute into the accounting period.

The value must be formatted based on the currency, for example, JPY 30 or USD 30.15. If the value is formatted incorrectly, the following error message is returned:

"Allocation amount with wrong decimal places."

notes

Additional information about this record.

number

The charge summary revenue number.

overrideChargeAccountingCodes

When overriding accounting codes from a charge,recognizedRevenueAccountingCode and deferredRevenue AccountingCode must be in the request body and can have empty value.

True or False. A false value will be used if this field is empty in the request body.

pageSize

Must be an integer. A maximum number of 300 pages can be returned in a response. Any value greater than 300 is treated as 300.

percentage_milestone

Percentage of the total recognition amount or total undistributed to distribute.

Type: decimal

Required if distributionType is either:

specific date (delta percent total)
specific date (delta percent undistributed)

processId

The internal process ID used to assist Zuora support. Returned only if success is false.

reasons

Information describing the reason for the result. Returned only if success is false.

recognitionEnd

The end date of a recognition period in YYYY-MM-DD format.

The maximum difference of the recognitionStart and recognitionEnd date fields is equal to 250 multiplied by the length of an accounting period.

recognitionRuleName

The name of the recognition rule.

recognitionStart

The start date of a recognition period in YYYY-MM-DD format.

recognizedRevenue

The revenue that was distributed in a closed accounting period.

recognizedRevenueAccountingCode

The accounting code for recognized revenue, such as Monthly Recurring Charges or Overage Charges. Required only when overrideChargeAccountingCodes is true. Otherwise the value is ignored.

recognizedRevenueAccountingCodeType

The type associated with the recognized revenue accounting code, such as Sales Revenue or Sales Discount. Required only when overrideChargeAccountingCodes is true. Otherwise this value is ignored.

referenceId

Reference ID is used only in the custom unlimited rule to create a revenue schedule. In this scenario, the revenue schedule is not linked to an invoice item or invoice item adjustment.

revenueDistributions

An array of revenue distributions. Represents how you want to distribute revenue for this revenue schedule. You can distribute revenue into a maximum of 250 accounting periods with one revenue schedule.

revenueEvent

Represents a change to a revenue schedule, such as posting an invoice or distributing revenue.

revenueEventsListURL

Returns the URLs of the revenue events.

revenueEventNumber

The revenue event number created when a revenue event occurs.

revenueItems

Revenue items are listed in ascending order by the accounting period start date.

revenueItemListURL

The list of revenue Items.

revenueRecognitionRuleName

The name of the revenue recognition rule governing the revenue schedule.

revenueScheduleDate

The effective date of the revenue schedule. For example, the revenue schedule date for bookings-based revenue recognition is typically set to the order date or contract date.

The date cannot be in a closed accounting period. The date must be in the YYYY-MM-DD format.

revenueScheduleNumber

revenueSchedules

Represents how revenue will be recognized over time.

revenueScheduleListURL

Returns the URLs of revenue schedules.

rs-number

Revenue schedule number. The revenue schedule number is always prefixed with "RS", for example, "RS-00000001".

startDate

The date on which revenue automation starts. This is the first day of an accounting period.

subscriptionChargeId

The original subscription charge ID.

subscriptionId

The original subscription ID.

success

Returns true if the request is successful. Otherwise, returns false.

undistributedDeferredRevenue

Any revenue that cannot be distributed for some reason is placed in an open-ended accounting period, such as missing accounting periods or awaiting manual distribution.

undistributedUnrecognizedRevenue

Revenue in the open-ended accounting period.

unrecognizedRevenue

Revenue distributed in all open accounting periods, which includes the open-ended accounting period.

updatedBy

The user who made the change.

updatedOn

The date when the revenue automation start date was set.