RevenueProjection

A revenue projection [RevenueProjection] is a charge (slip) created from a charge projection run.

—	XML	SOAP	REST	Database table
Object	`RevenueProjection`	`oaRevenueProjection`	—	revenue_projection, slip
Supported Commands	`Read`	`read()`	—	—

—

XML

SOAP

REST

Database table

Object

RevenueProjection

oaRevenueProjection

—

revenue_projection, slip

Supported Commands

Read

read()

—

The RevenueProjection object has the following standard properties:

Note:

RevenueProjection 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	XML / SOAP	Description
`acct_date`	`slip.acct_date`	[Read-only] The accounting period date of the slip. See Date Fields.
`agreement_id`	`slip.agreement_id`	[Read-only] The ID of the associated agreement.
`booking_type_id`	`revenue_projection.booking_type_id`	[Read-only] ID of the booking type if this was generated from bookings.
`category_<N>_id` where `<N>` is an integer from `1` to `5`	`slip.category_<N>_id` where `<N>` is an integer from `1` to `5`	[Read-only] The ID of the associated `category_<N>`.
`category_id`	`slip.category_id`	[Read-only] The ID of the associated category. If this is set, the slip is based on this category.
`city`	`slip.city`	[Read-only] The slip city or location.
`cost`	`slip.cost`	[Read-only] The cost per unit of measure for an E or P slip, the billing rate for an O slip, or the fixed price for a F slip. Dated by the date field.
`cost_center_id`	`slip.cost_center_id`	[Read-only] The ID of the associated cost center.
`cost_includes_tax`	`slip.cost_includes_tax`	[Read-only] A 1/0 field indicating whether the cost includes the tax.
`created`	`slip.created`	[Read-only] Time the record was created. See Date Fields.
`currency`	`slip.currency`	[Read-only] Currency for the money fields in the record.
`customer_id`	`slip.customer_id`	[Read-only] The ID of the associated customer.
`customerpo_id`	`slip.customerpo_id`	[Read-only] The ID of the associated customerpo.
`date`	`slip.date`	[Read-only] The date of the billing slip. See Date Fields.
`description`	`slip.description`	[Read-only] The description of the billing slip.
`exported`	`slip.exported`	[Read-only] Date and time the record was marked as exported. See Date Fields.
`hour`	`slip.hour`	[Read-only] The number of hours for a T slip.
`id`	`slip.id`	[Read-only] Unique ID. Automatically assigned by OpenAir.
`incomplete`	`slip.incomplete`	[Read-only] Is the slip complete, e.g. can it be included in an invoice. If 1 it must be edited before it can be added to an invoice.
`invoice_id`	`slip.invoice_id`	[Read-only] The ID of the associated invoice once billed.
`item_id`	`slip.item_id`	[Read-only] The ID of the associated item. If this is set, the slip is based on this item. Use the associated item type to determine the subtype of this slip.
`job_code_id`	`slip.job_code_id`	[Read-only] The ID of the associated job code.
`minute`	`slip.minute`	[Read-only] The number of minutes for a T slip.
`name`	`slip.name`	[Read-only] The name of the slip. This field is never populated.
`notes`	`slip.notes`	[Read-only] Notes associated with the slip.
`originating_id`	`slip.originating_id`	[Read-only] For use with split slips feature. If set, the slip.id of the originating slip for this split portion.
`payment_type_id`	`slip.payment_type_id`	[Read-only] The ID of the associated payment type.
`payroll_type_id`	`slip.payroll_type_id`	[Read-only] The ID of the associated payroll type.
`portfolio_project_id`	`slip.portfolio_project_id`	[Read-only] The ID of the associated portfolio project.
`product_id`	`slip.product_id`	[Read-only] The ID of the associated product.
`project_billing_rule_id`	`revenue_projection.project_billing_rule_id`	[Read-only] The ID of the associated project billing rule.
`project_id`	`slip.project_id`	[Read-only] The ID of the associated project.
`project_task_id`	`slip.project_task_id`	[Read-only] The ID of the task within the associated project.
`projecttask_type_id`	`slip.projecttask_type_id`	[Read-only] The ID of the projecttask_type of the associated projecttask.
`quantity`	`slip.quantity`	[Read-only] The quantity for an E, O, or P slip.
`rate`	`slip.rate`	[Read-only] The hourly rate for a T slip. Dated by the date field.
`ref_slip_id`	`slip.ref_slip_id`	[Read-only] For credit/rebill, ID of the original slip ID.
`repeat_id`	`slip.repeat_id`	[Read-only] The ID of the associated repeating event.
`revenue_projection_type`	`revenue_projection.revenue_projection_type`	[Read-only] The type of the projection: R - Revenue from an "As billed" recognition rule F - Revenue from an "Fixed fee" recognition rule G - Revenue from an "Percent complete" recognition rule H - Revenue from an "Incurred vs. forecast" recognition rule J - Revenue from a "Time project billing rule" rule U - Time billed but not recognized T - Time not billed
`revenue_recognition_rule_id`	`revenue_projection.revenue_recognition_rule_id`	[Read-only] Id of the revenue recognition rule that created this projection.
`revenue_stage_id`	`revenue_projection.revenue_stage_id`	[Read-only] Id of the revenue_stage. This will always be 'no revenue stage' 0 for revenue projections.
`slip_projection_id`	`revenue_projection.slip_projection_id`	[Read-only] Id of the slip_projection that was used for an as billed rule
`slip_projection_type`	`revenue_projection.slip_projection_type`	[Read-only] The type of the slip_projection: X - slip projection generated from billing rule B - Time from potentially billable transaction which did not match any billing rule N - Time from transaction with non-billable project-task P - Time from transaction matching a billing rule, but is Partially over cap S - Time from transaction matching a billing rule, but is completely over cap and rule indicates to Stop if capped C - Time from transaction matching a billing rule, but is completely over cap and no more rules match
`slip_stage_id`	`slip.slip_stage_id`	[Read-only] The ID of the associated slip stage.
`slip_type_id`	`slip.slip_type_id`	[Read-only] This field is redundant with the type field. It provides a linkage to the slip type table allowing the slip_type table to be used in the reporting mechanism.
`timer_start`	`slip.timer_start`	[Read-only] The starting time of the timer. See Date Fields.
`timetype_id`	`slip.timetype_id`	[Read-only] The ID of the associated time type.
`total`	`slip.total`	[Read-only] The total value of the slip. Dated by the date field.
`total_hp`	`revenue_projection.total_hp`	[Read-only] A high precision version of the total field. This is used for G" type transactions as the percent complete is calculated on a daily basis can can be a small number Dated by the date field."
`total_tax_paid`	`slip.total_tax_paid`	[Read-only] The total tax paid. Dated by the date field.
`transaction_id`	`revenue_projection.transaction_id`	[Read-only] For internal user only. It is used only to satisfy subtotalling by slip in summary reports.
`type`	`slip.type`	[Read-only] The type of the slip: T - hourly rate slip, E - expense slip, F - flat price slip, O - other time slip, M - incomplete slip, or P - product slip.
`um`	`slip.um`	[Read-only] The unit of measure for an E or P slip or the rate description for an O slip.
`updated`	`slip.updated`	[Read-only] Time the record was last updated or modified. See Date Fields.
`user_id`	`slip.user_id`	[Read-only] The ID of the associated user.
`vehicle_id`	`slip.vehicle_id`	[Read-only] The ID of the associated vehicle.

XML / SOAP

Description

acct_date

slip.acct_date

[Read-only] The accounting period date of the slip. See Date Fields.

agreement_id

slip.agreement_id

[Read-only] The ID of the associated agreement.

booking_type_id

revenue_projection.booking_type_id

[Read-only] ID of the booking type if this was generated from bookings.

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

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

[Read-only] The ID of the associated category_<N>.

category_id

slip.category_id

[Read-only] The ID of the associated category. If this is set, the slip is based on this category.

city

slip.city

[Read-only] The slip city or location.

cost

slip.cost

[Read-only] The cost per unit of measure for an E or P slip, the billing rate for an O slip, or the fixed price for a F slip. Dated by the date field.

cost_center_id

slip.cost_center_id

[Read-only] The ID of the associated cost center.

cost_includes_tax

slip.cost_includes_tax

[Read-only] A 1/0 field indicating whether the cost includes the tax.

created

slip.created

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

currency

slip.currency

[Read-only] Currency for the money fields in the record.

customer_id

slip.customer_id

[Read-only] The ID of the associated customer.

customerpo_id

slip.customerpo_id

[Read-only] The ID of the associated customerpo.

date

slip.date

[Read-only] The date of the billing slip. See Date Fields.

description

slip.description

[Read-only] The description of the billing slip.

exported

slip.exported

[Read-only] Date and time the record was marked as exported. See Date Fields.

hour

slip.hour

[Read-only] The number of hours for a T slip.

id

slip.id

[Read-only] Unique ID. Automatically assigned by OpenAir.

incomplete

slip.incomplete

[Read-only] Is the slip complete, e.g. can it be included in an invoice. If 1 it must be edited before it can be added to an invoice.

invoice_id

slip.invoice_id

[Read-only] The ID of the associated invoice once billed.

item_id

slip.item_id

[Read-only] The ID of the associated item. If this is set, the slip is based on this item. Use the associated item type to determine the subtype of this slip.

job_code_id

slip.job_code_id

[Read-only] The ID of the associated job code.

minute

slip.minute

[Read-only] The number of minutes for a T slip.

name

slip.name

[Read-only] The name of the slip. This field is never populated.

notes

slip.notes

[Read-only] Notes associated with the slip.

originating_id

slip.originating_id

[Read-only] For use with split slips feature. If set, the slip.id of the originating slip for this split portion.

payment_type_id

slip.payment_type_id

[Read-only] The ID of the associated payment type.

payroll_type_id

slip.payroll_type_id

[Read-only] The ID of the associated payroll type.

portfolio_project_id

slip.portfolio_project_id

[Read-only] The ID of the associated portfolio project.

product_id

slip.product_id

[Read-only] The ID of the associated product.

project_billing_rule_id

revenue_projection.project_billing_rule_id

[Read-only] The ID of the associated project billing rule.

project_id

slip.project_id

[Read-only] The ID of the associated project.

project_task_id

slip.project_task_id

[Read-only] The ID of the task within the associated project.

projecttask_type_id

slip.projecttask_type_id

[Read-only] The ID of the projecttask_type of the associated projecttask.

quantity

slip.quantity

[Read-only] The quantity for an E, O, or P slip.

rate

slip.rate

[Read-only] The hourly rate for a T slip. Dated by the date field.

ref_slip_id

slip.ref_slip_id

[Read-only] For credit/rebill, ID of the original slip ID.

repeat_id

slip.repeat_id

[Read-only] The ID of the associated repeating event.

revenue_projection_type

revenue_projection.revenue_projection_type

[Read-only] The type of the projection:

R - Revenue from an "As billed" recognition rule
F - Revenue from an "Fixed fee" recognition rule
G - Revenue from an "Percent complete" recognition rule
H - Revenue from an "Incurred vs. forecast" recognition rule
J - Revenue from a "Time project billing rule" rule
U - Time billed but not recognized
T - Time not billed

revenue_recognition_rule_id

revenue_projection.revenue_recognition_rule_id

[Read-only] Id of the revenue recognition rule that created this projection.

revenue_stage_id

revenue_projection.revenue_stage_id

[Read-only] Id of the revenue_stage. This will always be 'no revenue stage' 0 for revenue projections.

slip_projection_id

revenue_projection.slip_projection_id

[Read-only] Id of the slip_projection that was used for an as billed rule

slip_projection_type

revenue_projection.slip_projection_type

[Read-only] The type of the slip_projection:

X - slip projection generated from billing rule
B - Time from potentially billable transaction which did not match any billing rule
N - Time from transaction with non-billable project-task
P - Time from transaction matching a billing rule, but is Partially over cap
S - Time from transaction matching a billing rule, but is completely over cap and rule indicates to Stop if capped
C - Time from transaction matching a billing rule, but is completely over cap and no more rules match

slip_stage_id

slip.slip_stage_id

[Read-only] The ID of the associated slip stage.

slip_type_id

slip.slip_type_id

[Read-only] This field is redundant with the type field. It provides a linkage to the slip type table allowing the slip_type table to be used in the reporting mechanism.

timer_start

slip.timer_start

[Read-only] The starting time of the timer. See Date Fields.

timetype_id

slip.timetype_id

[Read-only] The ID of the associated time type.

total

slip.total

[Read-only] The total value of the slip. Dated by the date field.

total_hp

revenue_projection.total_hp

[Read-only] A high precision version of the total field. This is used for G" type transactions as the percent complete is calculated on a daily basis can can be a small number Dated by the date field."

total_tax_paid

slip.total_tax_paid

[Read-only] The total tax paid. Dated by the date field.

transaction_id

revenue_projection.transaction_id

[Read-only] For internal user only. It is used only to satisfy subtotalling by slip in summary reports.

type

slip.type

[Read-only] The type of the slip: T - hourly rate slip, E - expense slip, F - flat price slip, O - other time slip, M - incomplete slip, or P - product slip.

um

slip.um

[Read-only] The unit of measure for an E or P slip or the rate description for an O slip.

updated

slip.updated

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

user_id

slip.user_id

[Read-only] The ID of the associated user.

vehicle_id

slip.vehicle_id

[Read-only] The ID of the associated vehicle.

Usage Guidelines

You can only read revenue projection objects using the API if there's no charge projection run in progress. Otherwise, no results are returned. This is because the data may be incomplete until the charge projection job completes.