Jump to

• Request
• Response

Update a time transaction type

patch

/fscmRestApi/resources/11.13.18.05/publicSectorTimeTransactionTypes/{TransactionTypeKey}

Request

Path Parameters

• TransactionTypeKey(required): integer(int64)
  The unique identifier for the time transaction type.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllowOverrideFlag: boolean
  Title: Override

  Maximum Length: 1

  Indicates whether the time recording entry associated with this time transaction type allows override.
• AssessNowFlag: boolean
  Title: Assess Now

  Maximum Length: 1

  Default Value: false

  Indicates whether the time recording entry associated with the time transaction type will be assessed immediately for any fees. This can be turned on only if the time transaction type is billable.
• BillableFlag: boolean
  Title: Billable

  Maximum Length: 1

  Indicates whether the time recording entry associated with the time transcation type is billable by default.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the time transcation type is enabled when creating a time recording entry.

{
    "type":"object",
    "properties":{
        "BillableFlag":{
            "title":"Billable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the time recording entry associated with the time transcation type is billable by default.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the time transcation type is enabled when creating a time recording entry.",
            "nullable":false
        },
        "AssessNowFlag":{
            "title":"Assess Now",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the time recording entry associated with the time transaction type will be assessed immediately for any fees. This can be turned on only if the time transaction type is billable.",
            "nullable":true,
            "default":false
        },
        "AllowOverrideFlag":{
            "title":"Override",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the time recording entry associated with this time transaction type allows override.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorTimeTransactionTypes-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Title: Agency ID

  Default Value: 1

  The identifier for the public sector agency associated with the time transaction type.
• AllowOverrideFlag: boolean
  Title: Override

  Maximum Length: 1

  Indicates whether the time recording entry associated with this time transaction type allows override.
• AssessNowFlag: boolean
  Title: Assess Now

  Maximum Length: 1

  Default Value: false

  Indicates whether the time recording entry associated with the time transaction type will be assessed immediately for any fees. This can be turned on only if the time transaction type is billable.
• BillableFlag: boolean
  Title: Billable

  Maximum Length: 1

  Indicates whether the time recording entry associated with the time transcation type is billable by default.
• CategoryId: string
  Title: Category

  Maximum Length: 30

  The unique identifier of the time category that the time transaction type is used for.
• Classification: string
  Title: Classification

  Maximum Length: 10

  The record classification that the time transaction type is used on.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date on which the time transaction type was created.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Indicates whether the time transcation type is enabled when creating a time recording entry.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which the time transaction type was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SubcategoryId: string
  Title: Subcategory

  Maximum Length: 30

  The unique identifier of the time subcategory that the time transaction type is used for.
• TransactionType: string
  Title: Transaction

  Maximum Length: 10

  The record transactions that the time transcation type is used on.
• TransactionTypeCode: string
  Title: Time Type Code

  Maximum Length: 30

  The alternate unique identifier for the time transcation type.
• TransactionTypeKey: integer (int64)
  The unique identifier for the time transaction type.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the time category that the time transaction type is used for.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the time transaction type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction",
            "maxLength":"10",
            "type":"string",
            "description":"The record transactions that the time transcation type is used on.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the time transaction type.",
            "format":"int32",
            "nullable":false,
            "default":"1",
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "SubcategoryId":{
            "title":"Subcategory",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the time subcategory that the time transaction type is used for.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowOverrideFlag":{
            "title":"Override",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the time recording entry associated with this time transaction type allows override.",
            "nullable":false,
            "x-queryable":true
        },
        "BillableFlag":{
            "title":"Billable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the time recording entry associated with the time transcation type is billable by default.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionTypeKey":{
            "type":"integer",
            "description":"The unique identifier for the time transaction type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssessNowFlag":{
            "title":"Assess Now",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the time recording entry associated with the time transaction type will be assessed immediately for any fees. This can be turned on only if the time transaction type is billable.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"10",
            "type":"string",
            "description":"The record classification that the time transaction type is used on.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionTypeCode":{
            "title":"Time Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier for the time transcation type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the time transcation type is enabled when creating a time recording entry.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the time transaction type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top