HistoryNotes

An approval history event [HistoryNotes] is an event in the chain of approval for an expense report or timesheet.

Review the Usage Guidelines for the HistoryNotes object.

XML

SOAP

REST

Database table

Object

HistoryNotes

oaHistoryNotes

approval

Supported Commands

Read (equal to)

Note:

The HistoryNotes object supports the equal to read method only.

The HistoryNotes has the following properties:

XML

Database

Description

action

action

[Read-only] The approval action: S - Submittal, P - Pending, A - Acceptance, R - Rejection, U - unapproval.

date

date

[Read-only] The date associated with this history event. See Date Fields.

id

id

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

notes

notes

[Read-only] Notes associated with the history event.

parentid

[Read-only] The internal ID of the object.

type

[Read-only] The object type – Supports "Envelope" and "TimeSheet" (with an upper case S) only.

Usage Guidelines

Review the following guidelines:

  • The HistoryNotes object type is listed in the OpenAir WSDL but the SOAP API does not support this object type. Use the History object type instead with the SOAP API.

  • When reading HistoryNotes object with the equal to method, the argument object must be an Envelope or a TimeSheet object with a valid id property.

    Important:

    When reading the approval history of a timesheet, the argument object must be a TimeSheet (with an uppercase S) and not a Timesheet (with an lowercase s) like you would use when working with timesheets.

    The following example shows the syntax used to read the approval history of an expense report with the XML API:

  •                 <Read type="HistoryNotes" method="equal to" limit="100">
       <Envelope>
          <id>471</id>
       </Envelope>
    </Read> 
    
                  

    The following example shows the syntax used to read the approval history of a timesheet with the XML API:

                    <Read type="HistoryNotes" method="equal to"  limit="100">
       <TimeSheet>
          <id>471</id>
       </TimeSheet>
    </Read>