Revenue_recognition_rule

A revenue recognition rule [Revenue_recognition_rule] is a rule governing how and when revenue is recognized.

—	XML	SOAP	REST	Database table
Object	`Revenue_recognition_rule`	`oaRevenue_recognition_rule`	—	`revenue_recognition_rule`
Supported Commands	`Add`, `Read`, `Modify`	`add()`, `read()`, `modify()`, `upsert()`	—	—

—

XML

SOAP

REST

Database table

Object

Revenue_recognition_rule

oaRevenue_recognition_rule

—

revenue_recognition_rule

Supported Commands

Add, Read, Modify

add(), read(), modify(), upsert()

—

The Revenue_recognition_rule object has the following standard properties:

Note:

Revenue_recognition_rule object properties may also include custom fields. The object type supports the custom equal to read method and the enable_custom read attribute.

XML / SOAP	Database	Description
`accounting_period_id`	`accounting_period_id`	The ID of the associated accounting period.
`acct_code`	`acct_code`	Optional accounting system code for integration with external accounting systems.
`acct_date`	`acct_date`	The accounting period date to assign to the transaction. See Date Fields.
`acct_date_how`	`acct_date_how`	The accounting period date of the transaction is determined by: N -none, clear the value E -the entity (no change) C -container of the entity if available (for example, timesheet, envelope) M -set by the specified accounting date P -set by the specified accounting period
`active`	`active`	A 1/0 field indicating whether this is an active rule.
`agreementid`	`agreement_id`	ID of the associated agreement.
`amount`	`amount`	The amount. If we have multiple amounts, the values are held in the revenue_recognition_rule_amount table.
`asb_exclude_slip_type`	`asb_exclude_slip_type`	CSV list of the slip types to exclude from the as billed rule.
`asb_which_slips`	`asb_which_slips`	Which slips should be considered for the as billed rule: A -all slips I -slips on invoices P -slips on approved invoices
`assigned_user`	`assigned_user`	The user to assign to fixed fee recognition. If specified, the user must exist, must not be marked as deleted and must be active.
`break_by_user`	`break_by_user`	Break out the transactions by user. Currently only implemented for the incurred rules.
`category_<N>id` where `<N>` is an integer from `1` to `5`	`category_<N>_id` where `<N>` is an integer from `1` to `5`	The ID of the associated `category_<N>`. Mutually exclusive with project_task_id.
`categoryid`	`category_id`	The ID of the associated category.
`cost_center_id`	`cost_center_id`	The ID of the associated cost center.
`created`	`created`	[Read-only] Time the record was created. See Date Fields.
`currency`	`currency`	Currency for the money fields in the record.
`customerid`	`customer_id`	The ID of the associated customer.
`customerpo_id`	`customerpo_id`	ID of the associated customerpo.
`end_date`	`end_date`	End date of the rule. See Date Fields.
`end_milestone`	`end_milestone`	ID of the ending milestone (project_task).
`expense_how`	`expense_how`	How expenses should be recognized: M -mark up/down on billed expenses. B -billed expenses. I -incurred expenses.
`extra_data`	`extra_data`	Holds extra data fields associated with the rule.
`id`	`id`	[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.
`item_filter`	`item_filter`	CSV list of items to limit the rule to.
`marked_as_ready`	`marked_as_ready`	Trigger recognition when a task (ID in phase) is marked as ready to recognize.
`name`	`name`	Name of the rule.
`notes`	`notes`	Notes associated with this revenue recognition rule.
`percent`	`percent`	The percentage value for a fixed fee percent trigger.
`percent_complete`	—	[Read-only] The calculated percent complete value if a type P transaction.
`percent_how`	`percent_how`	How percent complete should be calculated: A -% complete of planned hours for the project. B -% complete of planned hours for a phase. C -Approved hours versus planned hours for the project. D -Approved hours versus planned hours for a phase. E -Approved hours versus budget hours for the project.
`percent_trigger`	`percent_trigger`	If the fixed fee is triggered by a percent complete, this holds how it is triggered: A -% complete of planned hours for the project. B -% complete of planned hours for a phase or task (the task ID is held in the phase field).
`phase`	`phase`	ID of the phase if percent_how is B or D. ID of the phase/task if this is a marked_as_ready or percent_trigger rule.
`product_filter`	`product_filter`	CSV list of products to limit the rule to.
`project_billing_rule_filter`	`project_billing_rule_filter`	CSV list of project billing rule id's to limit a type T rule to.
`project_billing_ruleid`	`project_billing_rule_id`	The ID of the associated project billing rule. Only available if the optional feature Show billing rules on revenue recognition forms" is enabled."
`project_task_filter`	`project_task_filter`	CSV list of tasks to limit the rule to.
`projectid`	`projectid`	The ID of the associated project.
`purchase_how`	`purchase_how`	How purchases should be recognized: M -mark up/down on billed purchases. B -billed purchases.
`recognition_type`	`recognition_type`	What we are recognizing: R -revenue C -cost O -other
`repeatid`	`repeat_id`	The ID of the associated repeating event.
`slip_stage_filter`	`slip_stage_filter`	CSV list of slip_stage ID to limit a type A rule to.
`start_date`	`start_date`	Start date of the rule. See Date Fields.
`start_milestone`	`start_milestone`	ID of the starting milestone (project_task).
`timetype_filter`	`timetype_filter`	CSV list of timetypes to limit the rule to.
`type`	`type`	The type of the rule: A -as billed rule P -percent of time complete rule E -expense incurred rule F -fixed amount rule U -purchase item rule I -incurred versus forecast rule T -generated from a time project billing rule
`updated`	`updated`	[Read-only] Time the record was last updated or modified. See Date Fields.
`user_filter`	`user_filter`	CSV list of users to limit the rule to.

XML / SOAP

Database

Description

accounting_period_id

The ID of the associated accounting period.

acct_code

Optional accounting system code for integration with external accounting systems.

acct_date

The accounting period date to assign to the transaction. See Date Fields.

acct_date_how

The accounting period date of the transaction is determined by:

N -none, clear the value
E -the entity (no change)
C -container of the entity if available (for example, timesheet, envelope)
M -set by the specified accounting date
P -set by the specified accounting period

active

A 1/0 field indicating whether this is an active rule.

agreementid

agreement_id

ID of the associated agreement.

amount

The amount. If we have multiple amounts, the values are held in the revenue_recognition_rule_amount table.

asb_exclude_slip_type

CSV list of the slip types to exclude from the as billed rule.

asb_which_slips

Which slips should be considered for the as billed rule:

A -all slips
I -slips on invoices
P -slips on approved invoices

assigned_user

The user to assign to fixed fee recognition. If specified, the user must exist, must not be marked as deleted and must be active.

break_by_user

Break out the transactions by user. Currently only implemented for the incurred rules.

category_<N>id where <N> is an integer from 1 to 5

category_<N>_id where <N> is an integer from 1 to 5

The ID of the associated category_<N>. Mutually exclusive with project_task_id.

categoryid

category_id

The ID of the associated category.

cost_center_id

The ID of the associated cost center.

created

[Read-only] Time the record was created. See Date Fields.

currency

Currency for the money fields in the record.

customerid

customer_id

The ID of the associated customer.

customerpo_id

ID of the associated customerpo.

end_date

End date of the rule. See Date Fields.

end_milestone

ID of the ending milestone (project_task).

expense_how

How expenses should be recognized:

M -mark up/down on billed expenses.
B -billed expenses.
I -incurred expenses.

extra_data

Holds extra data fields associated with the rule.

id

[Read-only] Unique ID. Automatically assigned by SuiteProjects Pro.

item_filter

CSV list of items to limit the rule to.

marked_as_ready

Trigger recognition when a task (ID in phase) is marked as ready to recognize.

name

Name of the rule.

notes

Notes associated with this revenue recognition rule.

percent

The percentage value for a fixed fee percent trigger.

percent_complete

—

[Read-only] The calculated percent complete value if a type P transaction.

percent_how

How percent complete should be calculated:

A -% complete of planned hours for the project.
B -% complete of planned hours for a phase.
C -Approved hours versus planned hours for the project.
D -Approved hours versus planned hours for a phase.
E -Approved hours versus budget hours for the project.

percent_trigger

If the fixed fee is triggered by a percent complete, this holds how it is triggered:

A -% complete of planned hours for the project.
B -% complete of planned hours for a phase or task (the task ID is held in the phase field).

phase

ID of the phase if percent_how is B or D. ID of the phase/task if this is a marked_as_ready or percent_trigger rule.

product_filter

CSV list of products to limit the rule to.

project_billing_rule_filter

CSV list of project billing rule id's to limit a type T rule to.

project_billing_ruleid

project_billing_rule_id

The ID of the associated project billing rule. Only available if the optional feature Show billing rules on revenue recognition forms" is enabled."

project_task_filter

CSV list of tasks to limit the rule to.

projectid

The ID of the associated project.

purchase_how

How purchases should be recognized:

M -mark up/down on billed purchases.
B -billed purchases.

recognition_type

What we are recognizing:

R -revenue
C -cost
O -other

repeatid

repeat_id

The ID of the associated repeating event.

slip_stage_filter

CSV list of slip_stage ID to limit a type A rule to.

start_date

Start date of the rule. See Date Fields.

start_milestone

ID of the starting milestone (project_task).

timetype_filter

CSV list of timetypes to limit the rule to.

type

The type of the rule:

A -as billed rule
P -percent of time complete rule
E -expense incurred rule
F -fixed amount rule
U -purchase item rule
I -incurred versus forecast rule
T -generated from a time project billing rule

updated

[Read-only] Time the record was last updated or modified. See Date Fields.

user_filter

CSV list of users to limit the rule to.