Jump to

• Request
• Response

View a Project Actual

get

/api/restapi/projectActuals/{projectActualsId}

This endpoint returns project actuals that meet the following requirements:

• The object has an ID that matches the value of the {projectActualsId} path parameter.

Request

Path Parameters

• projectActualsId(required): integer(int64)
  The system-generated identifier of a project actual.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityProjectActuals

Type: object

Title: ApiEntityProjectActuals

This entity represents a ProjectActuals object, a unique ProjectActuals object can be identified by the following combinations of the fields.

• projectActualsId
• projectActualsCode,projectId
• projectActualsCode,projectCode,workspaceCode

Show Source

• approvedByUserId: integer (int64)
  The username of the user who approved the item.
• approvedDate: string (date-time)
  The date that the actual was approved.
• companyName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of a company.
• companySourceId: string
  Maximum Length: 255

  The unique identifier of company data in an external source.
• configuredFields: array configuredFields
  The list of configured fields for a project actuals.
• confirmedByEmailAddress: string
  Maximum Length: 255

  Indicates whether or not the project actual has been confirmed via email.
• currencyCode: string
  Minimum Length: 1

  Maximum Length: 3

  The user-specified identifier of a currency.
• currencyId: integer (int64)
  The system-generated identifier of the currency associated with the project actual.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Details about the project actual.
• effectiveDate: string (date-time)
  The date the actual is effective.
• fixedExchangeRate: number
  The exchange rate used to convert the Total Amount value from the record currency to the base currency.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectActualName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the actual.
• projectActualsCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for an actual.
• projectActualsCost: projectActualsCost
  An object containing cost fields in the form of key-value pairs.
• projectActualsId: integer (int64)
  The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of a project.
• projectCompanyId: integer (int64)
  The name of the company associated with the actual.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• projectSourceId: string
  Maximum Length: 255

  The unique identifier of project data in an external source.
• sourceId: string
  Maximum Length: 255

  The unique identifier of project actual data in an external source.

  Example: coarse
• status: string
  Allowed Values: [ "PENDING", "CONFIRMED" ]

  That status of the actual. Valid values are Pending and Confirmed.
• totalHours: number (double)
  Total Hours is calculated as the sum of the Hours of each actual line item. The value can be positive or negative.
• updateDate: string (date-time)
  Date when the record was last updated.
• withdrawByUserId: integer (int64)
  The system-generated identifier of the user who withdrew confirmation of the project actual.
• withdrawConfirmedByEmailAddress: string
  Maximum Length: 255

  Indicates whether or not the actual withdrawl has been confirmed via email.
• withdrawDate: string (date-time)
  The date that confirmation of the project actual was withdrawn.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityProjectActuals",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currencyCode":{
            "maxLength":"3",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of a currency.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "type":"string",
            "description":"That status of the actual. Valid values are Pending and Confirmed.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "CONFIRMED"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"Details about the project actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date the actual is effective.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "configuredFields":{
            "type":"array",
            "description":"The list of configured fields for a project actuals.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityProjectActualsConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "approvedDate":{
            "type":"string",
            "description":"The date that the actual was approved.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fixedExchangeRate":{
            "type":"number",
            "description":"The exchange rate used to convert the Total Amount value from the record currency to the base currency.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "sourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of project actual data in an external source.",
            "example":"coarse",
            "exampleSetFlag":true,
            "types":[
                "string"
            ]
        },
        "companyName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of a company.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCompanyId":{
            "type":"integer",
            "description":"The name of the company associated with the actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "currencyId":{
            "type":"integer",
            "description":"The system-generated identifier of the currency associated with the project actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "withdrawDate":{
            "type":"string",
            "description":"The date that confirmation of the project actual was withdrawn.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier of project actual data. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "totalHours":{
            "type":"number",
            "description":"Total Hours is calculated as the sum of the Hours of each actual line item. The value can be positive or negative.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectActualsCost":{
            "description":"An object containing cost fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActualsCost"
                }
            ]
        },
        "withdrawByUserId":{
            "type":"integer",
            "description":"The system-generated identifier of the user who withdrew confirmation of the project actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approvedByUserId":{
            "type":"integer",
            "description":"The username of the user who approved the item.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActualName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "confirmedByEmailAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether or not the project actual has been confirmed via email.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawConfirmedByEmailAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"Indicates whether or not the actual withdrawl has been confirmed via email.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectSourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of project data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "companySourceId":{
            "maxLength":"255",
            "type":"string",
            "description":"The unique identifier of company data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for an actual.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ProjectActuals object, a unique ProjectActuals object can be identified by the following combinations of the fields.<ul><li>projectActualsId</li><li>projectActualsCode,projectId</li><li>projectActualsCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : configuredFields

Type: array

The list of configured fields for a project actuals.

Show Source

• Array of: object ApiEntityProjectActualsConfiguredFieldValue
  Title: ApiEntityProjectActualsConfiguredFieldValue

{
    "type":"array",
    "description":"The list of configured fields for a project actuals.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityProjectActualsConfiguredFieldValue",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : projectActualsCost

An object containing cost fields in the form of key-value pairs.

Match All

Show Source

• object ApiEntityProjectActualsCost
  Title: ApiEntityProjectActualsCost

{
    "description":"An object containing cost fields in the form of key-value pairs.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectActualsCost"
        }
    ]
}

Nested Schema : ApiEntityProjectActualsConfiguredFieldValue

Type: object

Title: ApiEntityProjectActualsConfiguredFieldValue

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnDefinitionId: integer (int64)
  Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column label.
• columnName: string
  Minimum Length: 1

  Maximum Length: 100

  The user-specified UDF column name.
• costValue: number
  This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
• costValueProject: number (double)
  This holds value of Cost type configured fields in the project level currency conversion. Input should be provided in numberValue field, in project actuals record level currency.
• costValueWorkspace1: number (double)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  This holds values for Cost type configured fields in the workspace3 currency conversion.
• dateValue: string (date-time)
  This holds values for Date type configured fields.
• exceptionMessage: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• numberValue: number
  This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
• projectActualsConfiguredFieldValueId: integer (int64)
  The unique identifier for the Project Actuals Configured Field.
• projectActualsId: integer (int64)
  The system-generated identifier for an Actual.
• textValue: string
  Maximum Length: 4000

  This holds values for Boolean, List and Text type configured fields.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProjectActualsConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsConfiguredFieldValueId":{
            "type":"integer",
            "description":"The unique identifier for the Project Actuals Configured Field.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "costValueProject":{
            "type":"number",
            "description":"This holds value of Cost type configured fields in the project level currency conversion. Input should be provided in numberValue field, in project actuals record level currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The system-generated identifier for an Actual.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityProjectActualsCost

Type: object

Title: ApiEntityProjectActualsCost

Show Source

• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• projectActuals: projectActuals
  The supporting details for the project actuals.
• projectActualsId: integer (int64)
  The unique identifier of project actual data.
• totalAmount: number (double)
  Total Amount is calculated as the sum of the Amount of each actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalAmountProject field based on the specified exchange rate.
• totalAmountProject: number (double)
  The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the project currency.
• totalAmountProjectActuals: number (double)
  The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the record level currency.
• totalAmountWorkspace1: number (double)
  The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace1 currency.
• totalAmountWorkspace2: number (double)
  The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace2 currency.
• totalAmountWorkspace3: number (double)
  The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace3 currency.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityProjectActualsCost",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectActualsId":{
            "type":"integer",
            "description":"The unique identifier of project actual data.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectActuals":{
            "description":"The supporting details for the project actuals. ",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityProjectActuals"
                }
            ]
        },
        "totalAmount":{
            "type":"number",
            "description":"Total Amount is calculated as the sum of the Amount of each actual line item. The value can be positive or negative. This field is in base currency and is calculated from totalAmountProject field based on the specified exchange rate.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAmountProject":{
            "type":"number",
            "description":"The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the project currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAmountWorkspace1":{
            "type":"number",
            "description":"The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace1 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAmountWorkspace2":{
            "type":"number",
            "description":"The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace2 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAmountWorkspace3":{
            "type":"number",
            "description":"The total amount value for a workspace. Calculated as the sum of the amount of each actual line item. This value is based on the workspace3 currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "totalAmountProjectActuals":{
            "type":"number",
            "description":"The total amount value for a project. Calculated as the sum of the amount of each actual line item. This value is based on the record level currency.",
            "format":"double",
            "exampleSetFlag":false
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : projectActuals

The supporting details for the project actuals.

Match All

Show Source

• object ApiEntityProjectActuals
  Title: ApiEntityProjectActuals

  This entity represents a ProjectActuals object, a unique ProjectActuals object can be identified by the following combinations of the fields.

  • projectActualsId
  • projectActualsCode,projectId
  • projectActualsCode,projectCode,workspaceCode

{
    "description":"The supporting details for the project actuals. ",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityProjectActuals"
        }
    ]
}

404 Response

The requested project actuals do not exist, or you do not have access to them.

Back to Top