Jump to

• Request
• Response

Update an expense spend authorization

patch

/fscmRestApi/resources/11.13.18.05/expenseSpendAuthorizations/{expenseSpendAuthorizationsUniqID}

Request

Path Parameters

• expenseSpendAuthorizationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Spend Authorizations resource and used to uniquely identify an instance of Spend Authorizations. The client should not generate the hash key value. Instead, the client should query on the Spend Authorizations collection resource in order to navigate to a specific instance of Spend Authorizations to get the hash key.

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context: string
  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: string
  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

• endDate: string (date)
  Title: End Date

  End date for the expense spend authorization.
• lines: array Lines
  Title: Lines

  An expense spend authorization line represents an individual estimated expense item within an expense spend authorization request and supports operations such as creation, viewing, updating, and deletion.
• location: string
  Title: Expense Location

  Maximum Length: 80

  Location where the expense was incurred.
• personEmailAddress: string
  Maximum Length: 255

  Email address of the person associated with the expense spend authorization.
• purpose: string
  Title: Purpose

  Maximum Length: 240

  Purpose for the expense spend authorization
• startDate: string (date)
  Title: Start Date

  Start date for the expense spend authorization.
• status: string
  Maximum Length: 255

  Status of the expense spend authorization.

{
    "type":"object",
    "properties":{
        "endDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date for the expense spend authorization.",
            "format":"date",
            "nullable":true
        },
        "lines":{
            "title":"Lines",
            "type":"array",
            "description":"An expense spend authorization line represents an individual estimated expense item within an expense spend authorization request and supports operations such as creation, viewing, updating, and deletion.",
            "items":{
                "$ref":"#/components/schemas/expenseSpendAuthorizations-lines-item-patch-request"
            }
        },
        "location":{
            "title":"Expense Location",
            "maxLength":80,
            "type":"string",
            "description":"Location where the expense was incurred.",
            "nullable":true
        },
        "personEmailAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Email address of the person associated with the expense spend authorization.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "emailAddressId"
                ]
            }
        },
        "purpose":{
            "title":"Purpose",
            "maxLength":240,
            "type":"string",
            "description":"Purpose for the expense spend authorization",
            "nullable":true
        },
        "startDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date for the expense spend authorization.",
            "format":"date",
            "nullable":true
        },
        "status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the expense spend authorization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "lookupCodeStatus"
                ]
            }
        }
    }
}

Nested Schema : Lines

Type: array

Title: Lines

An expense spend authorization line represents an individual estimated expense item within an expense spend authorization request and supports operations such as creation, viewing, updating, and deletion.

Show Source

• Array of: object expenseSpendAuthorizations-lines-item-patch-request

{
    "title":"Lines",
    "type":"array",
    "description":"An expense spend authorization line represents an individual estimated expense item within an expense spend authorization request and supports operations such as creation, viewing, updating, and deletion.",
    "items":{
        "$ref":"#/components/schemas/expenseSpendAuthorizations-lines-item-patch-request"
    }
}

Nested Schema : expenseSpendAuthorizations-lines-item-patch-request

Type: object

Show Source

• additionalInformation: string
  Maximum Length: 4000

  Additional information captured during expense spend authorization creation.
• amount: number
  Title: Amount

  Amount for the expense spend authorization line.
• currencyCode: string
  Maximum Length: 15

  Currency code for the expense spend authorization line.
• description: string
  Title: Description

  Maximum Length: 240

  A brief description of the expense spend authorization line.
• merchant: string
  Maximum Length: 240

  Name of the merchant where the expense was incurred.
• merchantEmailAddress: string
  Maximum Length: 240

  Email address of the associated merchant.
• template: string
  Maximum Length: 255

  Expense template against which the expense is incurred.
• type: string
  Maximum Length: 255

  Expense type against which the expense is incurred.

{
    "type":"object",
    "properties":{
        "additionalInformation":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional information captured during expense spend authorization creation.",
            "nullable":true
        },
        "amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount for the expense spend authorization line.",
            "nullable":true
        },
        "currencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code for the expense spend authorization line.",
            "nullable":true
        },
        "description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the expense spend authorization line.",
            "nullable":true
        },
        "merchant":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the merchant where the expense was incurred.",
            "nullable":true
        },
        "merchantEmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"Email address of the associated merchant.",
            "nullable":true
        },
        "template":{
            "maxLength":255,
            "type":"string",
            "description":"Expense template against which the expense is incurred.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "expenseTemplateIdExpTemp"
                ]
            }
        },
        "type":{
            "maxLength":255,
            "type":"string",
            "description":"Expense type against which the expense is incurred.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "expenseTypeIdExpType"
                ]
            }
        }
    }
}

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 : expenseSpendAuthorizations-item-response

Type: object

Show Source

• assignmentId: integer (int64)
  Read Only: true

  Identifier of the assignment of the person on the expense report.
• authorizationNumber: string
  Read Only: true

  Maximum Length: 50

  Spend authorization number for the expense spend authorization.
• authorizedTotal: number
  Title: Estimated Total

  Read Only: true

  Authorized total amount for the expense spend authorization.
• createdBy: string
  Read Only: true

  Maximum Length: 64

  User who created the row.
• creationDate: string (date-time)
  Read Only: true

  Date and time when the row was created.
• currencyCode: string
  Read Only: true

  Maximum Length: 15

  Currency code for the expense spend authorization.
• endDate: string (date)
  Title: End Date

  End date for the expense spend authorization.
• lastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the row was last updated.
• lastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the row.
• lines: array Lines
  Title: Lines

  An expense spend authorization line represents an individual estimated expense item within an expense spend authorization request and supports operations such as creation, viewing, updating, and deletion.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• location: string
  Title: Expense Location

  Maximum Length: 80

  Location where the expense was incurred.
• organizationId: integer (int64)
  Read Only: true

  Unique identifier of a person's organization.
• person: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Name of the person associated with the expense spend authorization.
• personEmailAddress: string
  Maximum Length: 255

  Email address of the person associated with the expense spend authorization.
• purpose: string
  Title: Purpose

  Maximum Length: 240

  Purpose for the expense spend authorization
• spendAuthorizationId: integer (int64)
  Read Only: true

  Unique identifier for the expense spend authorization.
• startDate: string (date)
  Title: Start Date

  Start date for the expense spend authorization.
• status: string
  Maximum Length: 255

  Status of the expense spend authorization.

{
    "type":"object",
    "properties":{
        "assignmentId":{
            "type":"integer",
            "description":"Identifier of the assignment of the person on the expense report.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "authorizationNumber":{
            "maxLength":50,
            "type":"string",
            "description":"Spend authorization number for the expense spend authorization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "authorizedTotal":{
            "title":"Estimated Total",
            "type":"number",
            "description":"Authorized total amount for the expense spend authorization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"Date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "currencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code for the expense spend authorization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "endDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date for the expense spend authorization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "type":"string",
            "description":"Date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lines":{
            "title":"Lines",
            "type":"array",
            "description":"An expense spend authorization line represents an individual estimated expense item within an expense spend authorization request and supports operations such as creation, viewing, updating, and deletion.",
            "items":{
                "$ref":"#/components/schemas/expenseSpendAuthorizations-lines-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "location":{
            "title":"Expense Location",
            "maxLength":80,
            "type":"string",
            "description":"Location where the expense was incurred.",
            "nullable":true,
            "x-queryable":true
        },
        "organizationId":{
            "type":"integer",
            "description":"Unique identifier of a person's organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "person":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the person associated with the expense spend authorization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "personEmailAddress":{
            "maxLength":255,
            "type":"string",
            "description":"Email address of the person associated with the expense spend authorization.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "emailAddressId"
                ]
            },
            "x-queryable":true
        },
        "purpose":{
            "title":"Purpose",
            "maxLength":240,
            "type":"string",
            "description":"Purpose for the expense spend authorization",
            "nullable":true,
            "x-queryable":true
        },
        "spendAuthorizationId":{
            "type":"integer",
            "description":"Unique identifier for the expense spend authorization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "startDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date for the expense spend authorization.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "status":{
            "maxLength":255,
            "type":"string",
            "description":"Status of the expense spend authorization.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "lookupCodeStatus"
                ]
            }
        }
    }
}

Nested Schema : Lines

Type: array

Title: Lines

An expense spend authorization line represents an individual estimated expense item within an expense spend authorization request and supports operations such as creation, viewing, updating, and deletion.

Show Source

• Array of: object expenseSpendAuthorizations-lines-item-response

{
    "title":"Lines",
    "type":"array",
    "description":"An expense spend authorization line represents an individual estimated expense item within an expense spend authorization request and supports operations such as creation, viewing, updating, and deletion.",
    "items":{
        "$ref":"#/components/schemas/expenseSpendAuthorizations-lines-item-response"
    }
}

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 : expenseSpendAuthorizations-lines-item-response

Type: object

Show Source

• additionalInformation: string
  Maximum Length: 4000

  Additional information captured during expense spend authorization creation.
• amount: number
  Title: Amount

  Amount for the expense spend authorization line.
• category: string
  Read Only: true

  Maximum Length: 255

  Category for the expense type.
• createdBy: string
  Read Only: true

  Maximum Length: 64

  User who created the row.
• creationDate: string (date-time)
  Read Only: true

  Date and time when the row was created.
• currencyCode: string
  Maximum Length: 15

  Currency code for the expense spend authorization line.
• description: string
  Title: Description

  Maximum Length: 240

  A brief description of the expense spend authorization line.
• lastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the row was last updated.
• lastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the row.
• lineId: integer (int64)
  Read Only: true

  Unique identifier for the expense spend authorization line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• merchant: string
  Maximum Length: 240

  Name of the merchant where the expense was incurred.
• merchantEmailAddress: string
  Maximum Length: 240

  Email address of the associated merchant.
• template: string
  Maximum Length: 255

  Expense template against which the expense is incurred.
• type: string
  Maximum Length: 255

  Expense type against which the expense is incurred.

{
    "type":"object",
    "properties":{
        "additionalInformation":{
            "maxLength":4000,
            "type":"string",
            "description":"Additional information captured during expense spend authorization creation.",
            "nullable":true,
            "x-queryable":true
        },
        "amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount for the expense spend authorization line.",
            "nullable":true,
            "x-queryable":true
        },
        "category":{
            "maxLength":255,
            "type":"string",
            "description":"Category for the expense type.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeCategory"
                ]
            },
            "x-queryable":true
        },
        "createdBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "type":"string",
            "description":"Date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "currencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code for the expense spend authorization line.",
            "nullable":true,
            "x-queryable":true
        },
        "description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A brief description of the expense spend authorization line.",
            "nullable":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "type":"string",
            "description":"Date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lineId":{
            "type":"integer",
            "description":"Unique identifier for the expense spend authorization line.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "merchant":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the merchant where the expense was incurred.",
            "nullable":true,
            "x-queryable":true
        },
        "merchantEmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"Email address of the associated merchant.",
            "nullable":true,
            "x-queryable":true
        },
        "template":{
            "maxLength":255,
            "type":"string",
            "description":"Expense template against which the expense is incurred.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "expenseTemplateIdExpTemp"
                ]
            },
            "x-queryable":true
        },
        "type":{
            "maxLength":255,
            "type":"string",
            "description":"Expense type against which the expense is incurred.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "expenseTypeIdExpType"
                ]
            },
            "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."
        }
    }
}

Links

lines

Operation: /fscmRestApi/resources/11.13.18.05/expenseSpendAuthorizations/{expenseSpendAuthorizationsUniqID}/child/lines

Parameters:

• expenseSpendAuthorizationsUniqID: $request.path.expenseSpendAuthorizationsUniqID

An expense spend authorization line represents an individual estimated expense item within an expense spend authorization request and supports operations such as creation, viewing, updating, and deletion.

Back to Top