XML and SOAP API Business Object Reference

This section provides reference information for business objects supported by the XML API and SOAP API.

Note:

This section provides reference information for supported business objects only. These are the objects that are used to pass your SuiteProjects Pro data.

Except where indicated otherwise, all listed business object types are supported in both the XML API and SOAP API. Business object type names in the SOAP API include the prefix oa.

The SOAP API also uses method objects (complex types) to hold parameters for SOAP requests and return values in SOAP responses. For reference information about the SOAP API commands and method objects, see SOAP API Commands.

The term "object" is equivalent to the term "record" and describes a particular occurrence of an object type. Depending on the object type, an object represents an entity -such as a customer, a project, or an employee, for example-, a transaction -such as a receipt, expense report, or an invoice, for example-, or a relationship between other objects. The term "object property" is equivalent to the term "field". SuiteProjects Pro object types and object properties are analogous to database tables and the table columns. An object is analogous to a row in a database table.

For a list of supported business object types, see List of Supported Business Object Types.

Reference information for each business object types include:

The name of the object types in the XML API and SOAP API, the equivalent REST API object, where supported, and the corresponding table in the SuiteProjects Pro database as documented in the SuiteProjects Pro Data Dictionary.
A short description of what an object of that type represents.
The operations you can perform on objects of that type. Most of the objects accessible through the API are read-write objects. However, there are a few objects that are read-only.
A table listing the object properties in the XML API, SOAP API and REST API, and the corresponding column in the SuiteProjects Pro database table as documented in the SuiteProjects Pro Data Dictionary.

For information and guidelines about the main types of object properties, including custom fields, see Business Object Properties Overview.
Usage guidelines for the business object type, where relevant. These usage guidelines are not exhaustive.

Important:

Your applications work with only the objects that you are authorized to access. Programmatic access to objects is determined by your company's SuiteProjects Pro account configuration, the user role permissions and access settings configured by your account administrator, and other factors related specifically to the object.

List of Supported Business Object Types

The following table lists the business object types available in the XML API and SOAP API with a link to additional information about each object.

For each business object type, the table also shows:

The equivalent REST API object, where supported.
The corresponding table in the SuiteProjects Pro database as documented in the SuiteProjects Pro Data Dictionary.
A summary of supported CRUD operations (Create, Read, Update, Delete). For information about each operation type

Note:
Review the usage guidelines in the help topic for the business object where provided.

Some operations may be subject to limitations. Asterisks (*) in CRUD operation columns indicate that the operation is supported in special cases only.

For a list of objects supporting approval operations (submit, approve, reject, unapprove), see Object Types Supporting Approval-Related Operations.

XML	SOAP	REST	Database	Create	Update	Delete
`AccountingPeriod`	`oaAccountingPeriod`	-	`accounting_period`
`Actualcost`	`oaActualcost`	-	`actual_cost`			-
`Address`	`oaAddress`	-	`address`
`Agreement`	`oaAgreement`	-	`agreement`
`Agreement_to_project`	`oaAgreement_to_project`	-	`agreement_to_project`
`ApprovalLine`	`oaApprovalLine`	-	`approval`	-	-	-
`ApprovalProcess`	`oaApprovalProcess`	-	`approvalprocess`
`Attachment`	`oaAttachment`	`Attachment` Must be accessed using endpoints for the parent object - See Attachments	`attachment`		^*
`Attribute`	`oaAttribute`	-	`attribute`	-	-	-
`AttributeDescription`	`oaAttributeDescription`	-	`attribute_description`
`Attributeset`	`oaAttributeset`	-	`attribute_set`	-	-	-
`BillingSplit`	`oaBillingSplit`	-	`billing_split`	-	-	-
`Booking`	`oaBooking`	-	`booking`
`BookingByDay`	`oaBookingByDay`	-	`booking_by_day`	-	-	-
`BookingType`	`oaBookingType`	-	`booking_type`			-
`Booking_request`	`oaBooking_request`	-	`booking_request`	-	-	-
`Budget`	`oaBudget`	-	`budget`			-
`BudgetAllocation`	`oaBudgetAllocation`	-	`budget_allocation`			-
`Category`	`oaCategory`	-	`category`
`Category_<N>`	`oaCategory_<N>`	-	`category_<N>` (`category_1`)
`Ccrate`	`oaCcrate`	-	`cc_rate`	-	-	-
`Company`	`oaCompany`	-	`account`	-		-
`Contact`	`oaContact`	`Contact` See Contacts	`contact`
`Costcategory`	`oaCostcategory`	-	`cost_category`			-
`Costcenter`	`oaCostcenter`	-	`cost_center`
`Costtype`	`oaCosttype`	-	`cost_type`			-
`Currency`	`oaCurrency`	-	`currency`			-
`Currencyrate`	`oaCurrencyrate`	-	-	-	-	-
`CustField`	`oaCustField`	-	`cust_field`	-		-
`Customer`	`oaCustomer`	`Customer` See Customers	`customer`
`CustomerLocation`	`oaCustomerLocation`	-	`customer_location`
`Customerpo`	`oaCustomerpo`	-	`customerpo`
`Customerpo_to_project`	`oaCustomerpo_to_project`	-	`customerpo_to_project`			-
`CustomerProspect`	`oaCustomer`	-	`customer`
`Deal`	`oaDeal`	-	`deal`	-	-	-
`Dealcontact`	`oaDealcontact`	-	`deal_contact`	-	-	-
`Dealschedule`	`oaDealschedule`	-	`deal_schedule`	-	-	-
`Department`	`oaDepartment`	-	`department`
`Entitytag`	`oaEntitytag`	-	`entity_tag`
`Envelope`	`oaEnvelope`	`ExpenseReport` See Expense Reports	`envelope`
`Estimate`	`oaEstimate`	-	`estimate`	-	-	-
`Estimateadjustment`	`oaEstimateadjustment`	-	`estimate_adjustment`	-	-	-
`Estimateexpense`	`oaEstimateexpense`	-	`estimate_expense`	-	-	-
`Estimatelabor`	`oaEstimatelabor`	-	`estimate_labor`	-	-	-
`Estimatemarkup`	`oaEstimatemarkup`	-	`estimate_markup`	-	-	-
`Estimatephase`	`oaEstimatephase`	-	`estimate_phase`	-	-	-
`Event`	`oaEvent`	-	`event`			-
`ExpensePolicy`	`oaExpensePolicy`	-	`expense_policy`
`ExpensePolicyItem`	`oaExpensePolicyItem`	-	`expense_policy_item`
`Filter`	-	-	`filter`	-	-	-
`Filterset`	`oaFilterset`	-	`filter_set`	-	-	-
`ForexInput`	`oaForexInput`	-	-			-
`Fulfillment`	`oaFulfillment`	-	`fulfillment`	-		-
`Hierarchy`	`oaHierarchy`	-	`hierarchy`			-
`HierarchyNode`	`oaHierarchyNode`	-	`hierarchy_node`
`History`	`oaHistory`	-	`approval`	-	-	-
`HistoryNotes`	`oaHistoryNotes`	-	`approval`	-	-	-
`ImportExport`	`oaImportExport`	-	`import_export`
`Invoice`	`oaInvoice`	-	`invoice`
`InvoiceLayout`	`oaInvoiceLayout`	-	`invoice_layout`	-	-	-
`Issue`	`oaIssue`	-	`issue`
`IssueCategory`	`oaIssueCategory`	-	`issue_category`			-
`IssueSeverity`	`oaIssueSeverity`	-	`issue_severity`			-
`IssueSource`	`oaIssueSource`	-	`issue_source`			-
`IssueStage`	`oaIssueStage`	-	`issue_stage`			-
`IssueStatus`	`oaIssueStatus`	-	`issue_status`	-	-	-
`Item`	`oaItem`	-	`item`
`ItemToUserLocation`	`oaItemToUserLocation`	-	`item_to_user_location`
`Jobcode`	`oaJobcode`	`JobCode` See Job Codes	`job_code`			-
`JobCodeUsed`	`oaJobCodeUsed`	-	`job_code_used`	-	-	-
`Leave_accrual_rule`	`oaLeave_accrual_rule`	-	`leave_accrual_rule`			-
`Leave_accrual_rule_to_user`	`oaLeave_accrual_rule_to_user`	-	`leave_accrual_rule_to_user`			-
`Leave_accrual_transaction`	`oaLeave_accrual_transaction`	-	`leave_accrual_transaction`			-
`LoadedCost`	`oaLoadedCost`	-	`loaded_cost`			-
`Module`	`oaModule`	-	-	-	-	-
`Newsfeed`	`oaNewsfeed`	-	`newsfeed`
`NewsfeedMessage`	`oaNewsfeedMessage`	-	`newsfeed_message`
`Payment`	`oaPayment`	-	`payment`
`Paymentterms`	`oaPaymenttems`	-	`payment_tems`			-
`Paymenttype`	`oaPaymenttype`	-	`payment_type`
`Payrolltype`	`oaPayrolltype`	-	`payroll_type`
`PendingBooking`	`oaPendingBooking`	-	`pending_booking`	-	-	-
`Preference`	`oaPreference`	-	`preference`			-
`Product`	`oaProduct`	-	`product`			-
`Project`	`oaProject`	`Project` See Projects	`project`
`Projectassign`	`oaProjectassign`	-	`project_assign`
`ProjectAssignmentProfile`	`oaProjectAssignmentProfile`	-	`project_assignment_profile`
`Projectbillingrule`	`oaProjectbillingrule`	-	`project_billing_rule`			-
`Projectbillingtransaction`	`oaProjectbillingtransaction`	-	`project_billing_transaction`	^*	^*	^*
`ProjectBudgetGroup`	`oaProjectBudgetGroup`	-	`project_budget_group`
`ProjectBudgetRule`	`oaProjectBudgetRule`	-	`project_budget_rule`
`ProjectBudgetTransaction`	`oaProjectBudgetTransaction`	-	`project_budget_transaction`
`Projectgroup`	`oaProjectgroup`	-	`project_group`			-
`Projectlocation`	`oaProjectlocation`	-	`project_location`	-	-	-
`ProjectPricing`	`oaProjectPricing`	-	`project_pricing`
`ProjectStage`	`oaProjectstage`	-	`project_stage`
`Projecttask`	`oaProjecttask`	`ProjectMilestone` - See Project Milestones `ProjectPhase` - See Project Phases `ProjectTask` - See Project Tasks	`project_task` `classification` set to `M` for milestones, `P` for phases, or `T` for tasks
`Projecttaskassign`	`oaProjecttaskassign`	-	`project_task_assign`
`ProjecttaskEstimate`	`oaProjecttaskEstimate`	-	`project_task_estimate`
`Projecttask_type`	`oaProjecttask_type`	-	`project_task_type`			-
`Proposal`	`oaProposal`	-	`proposal`	-	-	-
`Proposalblock`	`oaProposalblock`	-	`proposal_block`	-	-	-
`Proxy`	`oaProxy`	-	`proxy`
`Purchase_item`	`oaPurchase_item`	-	`purchase_item`	^*	^*
`Purchaseorder`	`oaPurchaseorder`	-	`purchaseorder`
`Purchaser`	`oaPurchaser`	-	`purchaser`	-	-	-
`Purchaserequest`	`oaPurchaserequest`	-	`purchase_request`	-	-	-
`Ratecard`	`oaRatecard`	-	`rate_card`			-
`RateCardItem`	`oaRateCardItem`	-	`rate_card_item`			-
`Reimbursement`	`oaReimbursement`	-	`reimbursement`
`Repeat`	`oaRepeat`	-	`repeat`			-
`Report`	`oaReport`	-	`report`	-	-	-
`Request_item`	`oaRequest_item`	-	`request_item`	-	-
`ResourceAttachment`	`oaResourceAttachment`	-	`resource_attachment`
`Resourceprofile`	`oaResourceprofile`	-	`resourceprofile`
`Resourceprofile_type`	`oaResourceprofile_type`	-	`resourceprofile_type`
`ResourceRequest`	`oaResourceRequest`	-	`resource_request`
`ResourceRequestQueue`	`oaResourceRequestQueue`	-	`resource_request_queue`
`Resourcesearch`	`oaResourcesearch`	-	`resourcesearch`
`RevenueContainer`	`oaRevenueContainer`	-	`revenue_container`	-	^*	-
`RevenueProjection`	`oaRevenueProjection`	-	`revenue_projection`	-	-	-
`Revenue_recognition_rule`	`oaRevenue_recognition_rule`	-	`revenue_recognition_rule`			-
`Revenue_recognition_rule_amount`	`oaRevenue_recognition_rule_amount`	-	`revenue_recognition_rule_amount`			-
`Revenue_recognition_transaction`	`oaRevenue_recognition_transaction`	-	`revenue_recognition_transaction`			-
`RevenueStage`	`oaRevenueStage`	-	`revenue_stage`	-	-	-
`Role`	`oaRole`	-	`role`	-	-	-
`Schedulebyday`	`oaSchedulebyday`	-	`schedule_by_day`	-	-	-
`Scheduleexception`	`oaScheduleexception`	-	`scheduleexception`
`Schedulerequest`	`oaSchedulerequest`	-	`schedule_request`
`Schedulerequest_item`	`oaSchedulerequest_item`	-	`schedule_request_item`	-
`Slip`	`oaSlip`	-	`slip`
`SlipProjection`	`oaSlipProjection`	-	`slip_projection`, `slip`	-	-	-
`Slipstage`	`oaSlipstage`	-	`slip_stage`			-
`SummaryView`	`oaSummaryView`	-	-	-	-	-
`TagGroup`	`oaTagGroup`	-	`tag_group`
`TagGroupAttribute`	`oaTagGroupAttribute`	-	`tag_group_attribute`
`TargetUtilization`	`oaTargetUtilization`	-	`target_utilization`
`Task`	`oaTask`	- `TimeEntry` - See Time Entries	`task`
`TaskAdjustment`	`oaTaskAdjustment`	-	`task_adjustment`	-	-	-
`TaskTimecard`	`oaTaskTimecard`	-	-	-	-	-
`TaxLocation`	`oaTaxLocation`	-	`tax_location`			-
`TaxRate`	`oaTaxRate`	-	`tax_rate`			-
`Term`	`oaTerm`	-	`term`	-	-	-
`ThreadedMessage`	`oaThreadedMessage`	`ThreadedMessage` See Threaded Discussion Messages	`threaded_messages`
`Ticket`	`oaTicket`	`Receipt` See Receipts	`ticket`
`Timecard`	`oaTimecard`	-	`time_card`	-	-	-
`Timesheet`	`oaTimesheet`	-	`timesheet`
`Timetype`	`oaTimetype`	-	`time_type`
`Todo`	`oaTodo`	-	`todo`	-	-	-
`Uprate`	`oaUprate`	-	`up_rate`
`User`	`oaUser`	`User` See Users	`user`
`UserLocation`	`oaUserLocation`	-	`user_location`
`UserWorkschedule`	`oaUserWorkschedule`	-	`workschedule`
`Vendor`	`oaVendor`	-	`vendor`
`Viewfilter`	`oaViewfilter`	-	`viewfilter`	-	-	-
`Viewfilterrule`	`oaViewfilterrule`	-	`viewfilter_rule`	-	-	-
`WorkscheduleWorkhour`	`oaWorkscheduleWorkhour`	-	`workschedule_workhour`	-	-	-
`Workspace`	`oaWorkspace`	-	`workspace`
`Workspacelink`	`oaWorkspacelink`	-	`workspace_link`			-
`Workspaceuser`	`oaWorkspaceuser`	-	`workspace_user`			-

XML

SOAP

REST

Database

Create

Read

Update

Delete

oaAccountingPeriod

Check mark

oaActualcost

Check mark

Address

oaAddress

address

Check mark

Agreement

oaAgreement

agreement

Check mark

Agreement_to_project

oaAgreement_to_project

agreement_to_project

Check mark

oaApprovalLine

Check mark

oaApprovalProcess

Check mark

oaAttachment

Attachment

Must be accessed using endpoints for the parent object - See Attachments

attachment

Check mark

Check mark ^*

Check mark

Attribute

oaAttribute

attribute

Check mark

AttributeDescription

oaAttributeDescription

attribute_description

Check mark

oaAttributeset

Check mark

oaBillingSplit

Check mark

Booking

oaBooking

booking

Check mark

oaBookingByDay

Check mark

oaBookingType

Check mark

oaBooking_request

Check mark

Budget

oaBudget

budget

Check mark

oaBudgetAllocation

Check mark

oaCategory

Check mark

oaCategory_<N>

category_<N> (category_1)

Check mark

Ccrate

oaCcrate

cc_rate

Check mark

Company

oaCompany

account

Check mark

Contact

oaContact

Contact

See Contacts

contact

Check mark

oaCostcategory

Check mark

oaCostcenter

Check mark

oaCosttype

Check mark

oaCurrency

Check mark

oaCurrencyrate

Check mark

CustField

oaCustField

cust_field

Check mark

Customer

oaCustomer

Customer

See Customers

Check mark

oaCustomerLocation

Check mark

oaCustomerpo

Check mark

Customerpo_to_project

oaCustomerpo_to_project

customerpo_to_project

Check mark

CustomerProspect

oaCustomer

customer

Check mark

Deal

oaDeal

deal

Check mark

oaDealcontact

Check mark

oaDealschedule

Check mark

oaDepartment

Check mark

oaEntitytag

Check mark

oaEnvelope

ExpenseReport

See Expense Reports

Check mark

oaEstimate

Check mark

oaEstimateadjustment

estimate_adjustment

Check mark

oaEstimateexpense

Check mark

oaEstimatelabor

Check mark

oaEstimatemarkup

Check mark

oaEstimatephase

Check mark

Event

oaEvent

event

Check mark

ExpensePolicy

oaExpensePolicy

expense_policy

Check mark

ExpensePolicyItem

oaExpensePolicyItem

expense_policy_item

Check mark

Filter

filter

Check mark

Filterset

oaFilterset

filter_set

Check mark

ForexInput

oaForexInput

Check mark

oaFulfillment

Check mark

oaHierarchy

Check mark

oaHierarchyNode

Check mark

History

oaHistory

Check mark

oaHistoryNotes

Check mark

oaImportExport

Check mark

Invoice

oaInvoice

invoice

Check mark

InvoiceLayout

oaInvoiceLayout

invoice_layout

Check mark

Issue

oaIssue

issue

Check mark

oaIssueCategory

Check mark

oaIssueSeverity

Check mark

oaIssueSource

Check mark

oaIssueStage

Check mark

oaIssueStatus

Check mark

Item

oaItem

item

Check mark

ItemToUserLocation

oaItemToUserLocation

item_to_user_location

Check mark

Jobcode

oaJobcode

JobCode

See Job Codes

Check mark

oaJobCodeUsed

Check mark

oaLeave_accrual_rule

leave_accrual_rule

Check mark

Leave_accrual_rule_to_user

oaLeave_accrual_rule_to_user

leave_accrual_rule_to_user

Check mark

Leave_accrual_transaction

oaLeave_accrual_transaction

leave_accrual_transaction

Check mark

LoadedCost

oaLoadedCost

loaded_cost

Check mark

Module

oaModule

Check mark

oaNewsfeed

Check mark

oaNewsfeedMessage

Check mark

Payment

oaPayment

payment

Check mark

oaPaymenttems

Check mark

oaPaymenttype

Check mark

oaPayrolltype

Check mark

oaPendingBooking

Check mark

oaPreference

Check mark

Product

oaProduct

product

Check mark

Project

oaProject

Project

See Projects

project

Check mark

Projectassign

oaProjectassign

project_assign

Check mark

ProjectAssignmentProfile

oaProjectAssignmentProfile

project_assignment_profile

Check mark

Projectbillingrule

oaProjectbillingrule

project_billing_rule

Check mark

Projectbillingtransaction

oaProjectbillingtransaction

project_billing_transaction

Check mark ^*

Check mark

Check mark ^*

ProjectBudgetGroup

oaProjectBudgetGroup

project_budget_group

Check mark

ProjectBudgetRule

oaProjectBudgetRule

project_budget_rule

Check mark

ProjectBudgetTransaction

oaProjectBudgetTransaction

project_budget_transaction

Check mark

oaProjectgroup

Check mark

oaProjectlocation

Check mark

oaProjectPricing

Check mark

oaProjectstage

Check mark

oaProjecttask

ProjectMilestone - See Project Milestones

ProjectPhase - See Project Phases

ProjectTask - See Project Tasks

project_task

classification set to M for milestones, P for phases, or T for tasks

Check mark

Projecttaskassign

oaProjecttaskassign

project_task_assign

Check mark

ProjecttaskEstimate

oaProjecttaskEstimate

project_task_estimate

Check mark

oaProjecttask_type

Check mark

oaProposal

Check mark

oaProposalblock

Check mark

Proxy

oaProxy

proxy

Check mark

Purchase_item

oaPurchase_item

purchase_item

Check mark ^*

Check mark

Check mark ^*

Check mark

oaPurchaseorder

Check mark

oaPurchaser

Check mark

oaPurchaserequest

Check mark

oaRatecard

Check mark

oaRateCardItem

Check mark

oaReimbursement

Check mark

Repeat

oaRepeat

repeat

Check mark

Report

oaReport

report

Check mark

Request_item

oaRequest_item

request_item

Check mark

ResourceAttachment

oaResourceAttachment

resource_attachment

Check mark

Resourceprofile

oaResourceprofile

resourceprofile

Check mark

Resourceprofile_type

oaResourceprofile_type

resourceprofile_type

Check mark

ResourceRequest

oaResourceRequest

resource_request

Check mark

ResourceRequestQueue

oaResourceRequestQueue

resource_request_queue

Check mark

oaResourcesearch

Check mark

oaRevenueContainer

Check mark

Check mark ^*

RevenueProjection

oaRevenueProjection

revenue_projection

Check mark

Revenue_recognition_rule

oaRevenue_recognition_rule

revenue_recognition_rule

Check mark

Revenue_recognition_rule_amount

oaRevenue_recognition_rule_amount

revenue_recognition_rule_amount

Check mark

Revenue_recognition_transaction

oaRevenue_recognition_transaction

revenue_recognition_transaction

Check mark

RevenueStage

oaRevenueStage

revenue_stage

Check mark

Role

oaRole

role

Check mark

Schedulebyday

oaSchedulebyday

schedule_by_day

Check mark

Scheduleexception

oaScheduleexception

scheduleexception

Check mark

Schedulerequest

oaSchedulerequest

schedule_request

Check mark

Schedulerequest_item

oaSchedulerequest_item

schedule_request_item

Check mark

Slip

oaSlip

slip

Check mark

SlipProjection

oaSlipProjection

slip_projection, slip

Check mark

Slipstage

oaSlipstage

slip_stage

Check mark

SummaryView

oaSummaryView

Check mark

TagGroup

oaTagGroup

tag_group

Check mark

TagGroupAttribute

oaTagGroupAttribute

tag_group_attribute

Check mark

TargetUtilization

oaTargetUtilization

target_utilization

Check mark

Task

oaTask

TimeEntry - See Time Entries

task

Check mark

TaskAdjustment

oaTaskAdjustment

task_adjustment

Check mark

TaskTimecard

oaTaskTimecard

Check mark

TaxLocation

oaTaxLocation

tax_location

Check mark

TaxRate

oaTaxRate

tax_rate

Check mark

Term

oaTerm

term

Check mark

ThreadedMessage

oaThreadedMessage

ThreadedMessage

See Threaded Discussion Messages

threaded_messages

Check mark

Ticket

oaTicket

Receipt

See Receipts

ticket

Check mark

oaTimecard

Check mark

oaTimesheet

Check mark

oaTimetype

Check mark

Todo

oaTodo

todo

Check mark

Uprate

oaUprate

up_rate

Check mark

User

oaUser

User

See Users

user

Check mark

oaUserLocation

Check mark

oaUserWorkschedule

Check mark

Vendor

oaVendor

vendor

Check mark

oaViewfilter

Check mark

oaViewfilterrule

Check mark

WorkscheduleWorkhour

oaWorkscheduleWorkhour

workschedule_workhour

Check mark

oaWorkspace

Check mark

oaWorkspacelink

Check mark

oaWorkspaceuser

Check mark

Note:

The following object types are listed in the SuiteProjects Pro WSDL but are not available for use by client applications: FormPermissionField, ServerStatus.

The following object types are described in other sections of this guide: Approval, CustomField, Date, Error, oaFieldAttribute, Flag, oaSwitch.