Jump to

• Request
• Response
• Examples

Get all expense type records

get

/fscmRestApi/resources/11.13.18.05/expenseTypes

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds an expense type record using an expense type identifier that matches the primary key criteria specified.
    Finder Variables:
    • ExpenseTypeId; integer; Unique identifier of an expense type in an expense template.
  • findByTemplateIdAndDate: Finds all expense types for a given date and expense template.
    Finder Variables:
    • bindDate; string; Expense types found using a given date that is less than or equal to the end date.
    • bindTemplateId; integer; Expense types found using a given date and expense template.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BusinessUnit; string; Name of a person's business unit.
  • Category; string; Expense category assigned to an expense item.
  • CategoryCode; string; Code associated with an expense category.
  • CcReceiptRequiredFlag; boolean; Indicates whether receipts are required for corporate card expenses above a specified limit.
  • CcReceiptThreshold; number; Amount limit, above which a corporate card expense requires a receipt.
  • CreatedBy; string; User who created an expense type.
  • CreationDate; string; Date when the expense type was created.
  • DefaultProjExpendType; integer; Project expenditure type that is assigned to an expense type that has not been set up at the project level.
  • Description; string; Description of the expense type.
  • DescriptionBehaviour; string; Behavior of the expense item Description field, which is defined at the expense type level.
  • DescriptionBehaviourCode; string; Code that is associated with the description behavior.
  • DispRcptViolationFlag; boolean; Indicates whether a missing receipt policy warning is displayed to the user.
  • EnableProjectsFlag; boolean; Indicates whether an expense type can be used to charge project expenses.
  • EndDate; string; Date when the expense template can no longer be used.
  • ExpenseTemplateId; integer; Value that uniquely identifies an expense template that contains expense types.
  • ExpenseTypeId; integer; Value that uniquely identifies an expense type in an expense template.
  • ItemizationBehaviour; string; Behavior of an itemized expense type, whether disabled, enabled, or required.
  • ItemizationBehaviourCode; string; Code that is associated with the itemization behavior.
  • ItemizationOnlyFlag; boolean; Indicates whether an expense type is only used to itemize.
  • LastUpdateDate; string; Date when the expense type was last updated.
  • LastUpdateLogin; string; Session login that is associated with the user who last updated the expense type.
  • LastUpdatedBy; string; User who last updated the expense type.
  • LocationBehaviour; string; Behavior of the Expense Location field, which is defined at the expense type level.
  • LocationBehaviourCode; string; Code that is associated with the expense location behavior.
  • MerchantBehaviour; string; Behavior of the Merchant field, which is defined at the expense type level.
  • MerchantBehaviourCode; string; Code that is associated with the merchant behavior.
  • Name; string; Name of the expense type as appears in the expense report.
  • NegativeRcptRequiredCode; string; Code that is associated with receipt requirement rules that are applied to negative expense lines.
  • NumberOfDaysBehaviour; string; Behavior of the Number of Days field, which is defined at the expense type level.
  • NumberOfDaysBehaviourCode; string; Code that is associated with the number of days behavior.
  • OrgId; integer; Value that uniquely identifies the business unit associated with the row.
  • RcptRequiredProjFlag; boolean; Indicates whether a receipt is required for a project-enabled expense type.
  • ReceiptRequiredFlag; boolean; Indicates whether receipts are required for cash expenses above a specified amount.
  • ReceiptThreshold; number; Amount limit, above which a cash expense requires a receipt.
  • StartDate; string; Date when the expense template is available for use in expense reports.
  • TaxClassification; string; Default tax code that is assigned to an expense item.
  • TaxClassificationCode; string; Code that is associated with a tax classification.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : expenseTypes

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/expenseTypes-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object expenseTypes-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/expenseTypes-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 : expenseTypes-item-response

Type: object

Show Source

• BusinessUnit: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  Name of a person's business unit.
• Category: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Expense category assigned to an expense item.
• CategoryCode: string
  Maximum Length: 30

  Code associated with an expense category.
• CcReceiptRequiredFlag: boolean
  Maximum Length: 1

  Indicates whether receipts are required for corporate card expenses above a specified limit.
• CcReceiptThreshold: number
  Amount limit, above which a corporate card expense requires a receipt.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created an expense type.
• CreationDate: string (date-time)
  Read Only: true

  Date when the expense type was created.
• DefaultProjExpendType: integer (int64)
  Project expenditure type that is assigned to an expense type that has not been set up at the project level.
• Description: string
  Maximum Length: 240

  Description of the expense type.
• DescriptionBehaviour: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Behavior of the expense item Description field, which is defined at the expense type level.
• DescriptionBehaviourCode: string
  Maximum Length: 30

  Code that is associated with the description behavior.
• DispRcptViolationCode: string
  Indicates whether a missing receipt policy warning is displayed to the user.
• DispRcptViolationFlag: boolean
  Maximum Length: 1

  Indicates whether a missing receipt policy warning is displayed to the user.
• EnableProjectsFlag: boolean
  Maximum Length: 1

  Indicates whether an expense type can be used to charge project expenses.
• EndDate: string (date)
  Date when the expense template can no longer be used.
• ExpenseTemplateId: integer (int64)
  Value that uniquely identifies an expense template that contains expense types.
• ExpenseTypeId: integer (int64)
  Value that uniquely identifies an expense type in an expense template.
• ItemizationBehaviour: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Behavior of an itemized expense type, whether disabled, enabled, or required.
• ItemizationBehaviourCode: string
  Maximum Length: 15

  Code that is associated with the itemization behavior.
• ItemizationOnlyFlag: boolean
  Maximum Length: 1

  Indicates whether an expense type is only used to itemize.
• itemizedExpenseTypes: array Expenses Type Itemize
  Title: Expenses Type Itemize

  The itemized expense types resource is used to define expense types that are eligible for itemization.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the expense type was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the expense type.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login that is associated with the user who last updated the expense type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LocationBehaviour: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Behavior of the Expense Location field, which is defined at the expense type level.
• LocationBehaviourCode: string
  Maximum Length: 30

  Code that is associated with the expense location behavior.
• MerchantBehaviour: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Behavior of the Merchant field, which is defined at the expense type level.
• MerchantBehaviourCode: string
  Maximum Length: 30

  Code that is associated with the merchant behavior.
• Name: string
  Maximum Length: 80

  Name of the expense type as appears in the expense report.
• NegativeRcptRequiredCode: string
  Maximum Length: 30

  Code that is associated with receipt requirement rules that are applied to negative expense lines.
• NumberOfDaysBehaviour: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Behavior of the Number of Days field, which is defined at the expense type level.
• NumberOfDaysBehaviourCode: string
  Maximum Length: 30

  Code that is associated with the number of days behavior.
• OrgId: integer (int64)
  Value that uniquely identifies the business unit associated with the row.
• preferredAgencyLists: array Preferred Agency Lists
  Title: Preferred Agency Lists

  The preferred agency lists resource is used to view the preferred agency lists that are defined for the expense type.
• preferredMerchantLists: array Preferred Merchant Lists
  Title: Preferred Merchant Lists

  The preferred merchant lists resource is used to view the preferred merchant lists that are defined for the expense type.
• RcptRequiredProjFlag: boolean
  Maximum Length: 1

  Indicates whether a receipt is required for a project-enabled expense type.
• ReceiptRequiredFlag: boolean
  Maximum Length: 1

  Indicates whether receipts are required for cash expenses above a specified amount.
• ReceiptThreshold: number
  Amount limit, above which a cash expense requires a receipt.
• StartDate: string (date)
  Date when the expense template is available for use in expense reports.
• TaxClassification: string
  Read Only: true

  Default tax code that is assigned to an expense item.
• TaxClassificationCode: string
  Maximum Length: 30

  Code that is associated with a tax classification.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code associated with an expense category.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the expense type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultProjExpendType":{
            "type":"integer",
            "description":"Project expenditure type that is assigned to an expense type that has not been set up at the project level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Category":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Expense category assigned to an expense item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the expense type.",
            "nullable":true,
            "x-queryable":true
        },
        "NegativeRcptRequiredCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that is associated with receipt requirement rules that are applied to negative expense lines.",
            "nullable":true,
            "x-queryable":true
        },
        "preferredAgencyLists":{
            "title":"Preferred Agency Lists",
            "type":"array",
            "description":"The preferred agency lists resource is used to view the preferred agency lists that are defined for the expense type.",
            "items":{
                "$ref":"#/components/schemas/expenseTypes-preferredAgencyLists-item-response"
            }
        },
        "ExpenseTemplateId":{
            "type":"integer",
            "description":"Value that uniquely identifies an expense template that contains expense types.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NumberOfDaysBehaviourCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that is associated with the number of days behavior.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the expense type as appears in the expense report.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the expense template is available for use in expense reports.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DescriptionBehaviourCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that is associated with the description behavior.",
            "nullable":true,
            "x-queryable":true
        },
        "LocationBehaviour":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Behavior of the Expense Location field, which is defined at the expense type level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfDaysBehaviour":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Behavior of the Number of Days field, which is defined at the expense type level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CcReceiptThreshold":{
            "type":"number",
            "description":"Amount limit, above which a corporate card expense requires a receipt.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether receipts are required for cash expenses above a specified amount.",
            "nullable":true,
            "x-queryable":true
        },
        "MerchantBehaviourCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that is associated with the merchant behavior.",
            "nullable":true,
            "x-queryable":true
        },
        "DescriptionBehaviour":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Behavior of the expense item Description field, which is defined at the expense type level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MerchantBehaviour":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Behavior of the Merchant field, which is defined at the expense type level.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemizationOnlyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an expense type is only used to itemize.",
            "nullable":true,
            "x-queryable":true
        },
        "RcptRequiredProjFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a receipt is required for a project-enabled expense type.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the expense type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created an expense type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "itemizedExpenseTypes":{
            "title":"Expenses Type Itemize",
            "type":"array",
            "description":"The itemized expense types resource is used to define expense types that are eligible for itemization.",
            "items":{
                "$ref":"#/components/schemas/expenseTypes-itemizedExpenseTypes-item-response"
            }
        },
        "LocationBehaviourCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that is associated with the expense location behavior.",
            "nullable":true,
            "x-queryable":true
        },
        "DispRcptViolationFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a missing receipt policy warning is displayed to the user.",
            "nullable":true,
            "x-queryable":true
        },
        "DispRcptViolationCode":{
            "type":"string",
            "description":"Indicates whether a missing receipt policy warning is displayed to the user.",
            "nullable":true,
            "x-queryable":false
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the expense template can no longer be used.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EnableProjectsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an expense type can be used to charge project expenses.",
            "nullable":true,
            "x-queryable":true
        },
        "CcReceiptRequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether receipts are required for corporate card expenses above a specified limit.",
            "nullable":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit associated with the row.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceiptThreshold":{
            "type":"number",
            "description":"Amount limit, above which a cash expense requires a receipt.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"Name of a person's business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaxClassificationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code that is associated with a tax classification.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemizationBehaviour":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Behavior of an itemized expense type, whether disabled, enabled, or required.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpenseTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies an expense type in an expense template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TaxClassification":{
            "type":"string",
            "description":"Default tax code that is assigned to an expense item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemizationBehaviourCode":{
            "maxLength":15,
            "type":"string",
            "description":"Code that is associated with the itemization behavior.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the expense type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login that is associated with the user who last updated the expense type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "preferredMerchantLists":{
            "title":"Preferred Merchant Lists",
            "type":"array",
            "description":"The preferred merchant lists resource is used to view the preferred merchant lists that are defined for the expense type.",
            "items":{
                "$ref":"#/components/schemas/expenseTypes-preferredMerchantLists-item-response"
            }
        }
    }
}

Nested Schema : Expenses Type Itemize

Type: array

Title: Expenses Type Itemize

The itemized expense types resource is used to define expense types that are eligible for itemization.

Show Source

• Array of: object expenseTypes-itemizedExpenseTypes-item-response

{
    "title":"Expenses Type Itemize",
    "type":"array",
    "description":"The itemized expense types resource is used to define expense types that are eligible for itemization.",
    "items":{
        "$ref":"#/components/schemas/expenseTypes-itemizedExpenseTypes-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 : Preferred Agency Lists

Type: array

Title: Preferred Agency Lists

The preferred agency lists resource is used to view the preferred agency lists that are defined for the expense type.

Show Source

• Array of: object expenseTypes-preferredAgencyLists-item-response

{
    "title":"Preferred Agency Lists",
    "type":"array",
    "description":"The preferred agency lists resource is used to view the preferred agency lists that are defined for the expense type.",
    "items":{
        "$ref":"#/components/schemas/expenseTypes-preferredAgencyLists-item-response"
    }
}

Nested Schema : Preferred Merchant Lists

Type: array

Title: Preferred Merchant Lists

The preferred merchant lists resource is used to view the preferred merchant lists that are defined for the expense type.

Show Source

• Array of: object expenseTypes-preferredMerchantLists-item-response

{
    "title":"Preferred Merchant Lists",
    "type":"array",
    "description":"The preferred merchant lists resource is used to view the preferred merchant lists that are defined for the expense type.",
    "items":{
        "$ref":"#/components/schemas/expenseTypes-preferredMerchantLists-item-response"
    }
}

Nested Schema : expenseTypes-itemizedExpenseTypes-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the itemized expense type.
• CreationDate: string (date-time)
  Read Only: true

  Date when the itemized expense type was created.
• ExpenseTypeId: integer (int64)
  Value that uniquely identifies the itemized expense type.
• ExpenseTypeParentId: integer (int64)
  Value that uniquely identifies the parent expense type of the itemized expense type.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the itemized expense type was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the itemized expense type.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login that is associated with the user who last updated the itemized expense type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the itemized expense type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the itemized expense type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the itemized expense type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpenseTypeParentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent expense type of the itemized expense type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpenseTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the itemized expense type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the itemized expense type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login that is associated with the user who last updated the itemized expense type.",
            "nullable":true,
            "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."
        }
    }
}

Nested Schema : expenseTypes-preferredAgencyLists-item-response

Type: object

Show Source

• AgencyListName: string
  Read Only: true

  Maximum Length: 80

  Lookup type name that provides name of the preferred agency list.
• AgencyListType: string
  Maximum Length: 30

  Lookup type code of the preferred agency list.
• CreatedBy: string
  Maximum Length: 64

  User who created the preferred agency list.
• CreationDate: string (date-time)
  Date when the preferred agency list was created.
• DispWarningToUserFlag: boolean
  Maximum Length: 1

  Indicates whether policy warning is displayed to user.
• EndDate: string (date)
  Date when this preferred agency list is no longer applicable.
• ExpenseTypeId: integer (int64)
  Value that uniquely identifies the parent expense type.
• LastUpdateDate: string (date-time)
  Date when the preferred agency list was last updated.
• LastUpdatedBy: string
  Maximum Length: 64

  User who last updated the preferred agency list.
• LastUpdateLogin: string
  Maximum Length: 32

  Session login that is associated with the user who last updated the preferred agency list.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PolicyEnforcement: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of policy enforcement applied to this preferred agency list. Values are from lookup EXM_PREFERRED_ENFORCEMENT.
• PolicyEnforcementCode: string
  Maximum Length: 30

  Code of policy enforcement applied to this preferred agency list. Values are from lookup EXM_PREFERRED_ENFORCEMENT.
• StartDate: string (date)
  Date when this preferred agency list is applicable.

{
    "type":"object",
    "properties":{
        "AgencyListName":{
            "maxLength":80,
            "type":"string",
            "description":"Lookup type name that provides name of the preferred agency list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the preferred agency list.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the preferred agency list was created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DispWarningToUserFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether policy warning is displayed to user.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the preferred agency list.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyListType":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup type code of the preferred agency list.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when this preferred agency list is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when this preferred agency list is applicable.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PolicyEnforcementCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of policy enforcement applied to this preferred agency list. Values are from lookup EXM_PREFERRED_ENFORCEMENT.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpenseTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent expense type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PolicyEnforcement":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of policy enforcement applied to this preferred agency list. Values are from lookup EXM_PREFERRED_ENFORCEMENT.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the preferred agency list was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login that is associated with the user who last updated the preferred agency list.",
            "nullable":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 : expenseTypes-preferredMerchantLists-item-response

Type: object

Show Source

• CreatedBy: string
  Maximum Length: 64

  User who created the preferred merchant list.
• CreationDate: string (date-time)
  Date when the preferred merchant list was created.
• DispWarningToUserFlag: boolean
  Maximum Length: 1

  Indicates whether policy warning is displayed to user.
• EndDate: string (date)
  Date when this preferred merchant list is no longer applicable.
• ExpenseTypeId: integer (int64)
  Value that uniquely identifies the parent expense type.
• LastUpdateDate: string (date-time)
  Date when the preferred merchant list was last updated.
• LastUpdatedBy: string
  Maximum Length: 64

  User who last updated the preferred merchant list.
• LastUpdateLogin: string
  Maximum Length: 32

  Session login that is associated with the user who last updated the preferred merchant list.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MerchantListName: string
  Read Only: true

  Maximum Length: 80

  Lookup type name that provides name of the preferred merchant list.
• MerchantListType: string
  Maximum Length: 30

  Lookup type code of the preferred merchant list.
• PolicyEnforcement: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Type of policy enforcement applied to this preferred merchant list. Values are from lookup EXM_PREFERRED_ENFORCEMENT.
• PolicyEnforcementCode: string
  Maximum Length: 30

  Code of policy enforcement applied to this preferred merchant list. Values are from lookup EXM_PREFERRED_ENFORCEMENT.
• StartDate: string (date)
  Date when this preferred merchant list is applicable.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the preferred merchant list.",
            "nullable":false,
            "x-queryable":true
        },
        "MerchantListName":{
            "maxLength":80,
            "type":"string",
            "description":"Lookup type name that provides name of the preferred merchant list.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the preferred merchant list was created.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "DispWarningToUserFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether policy warning is displayed to user.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the preferred merchant list.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when this preferred merchant list is no longer applicable.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when this preferred merchant list is applicable.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PolicyEnforcementCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of policy enforcement applied to this preferred merchant list. Values are from lookup EXM_PREFERRED_ENFORCEMENT.",
            "nullable":false,
            "x-queryable":true
        },
        "MerchantListType":{
            "maxLength":30,
            "type":"string",
            "description":"Lookup type code of the preferred merchant list.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ExpenseTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent expense type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PolicyEnforcement":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Type of policy enforcement applied to this preferred merchant list. Values are from lookup EXM_PREFERRED_ENFORCEMENT.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the preferred merchant list was last updated.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login that is associated with the user who last updated the preferred merchant list.",
            "nullable":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"
    }
}

Back to Top

Examples

The following example shows how to retrieve all the expense type records by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTypes

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "items": [
    {
      "BusinessUnit": "Vision Italy",
      "Category": "Car Rental",
      "CategoryCode": "CAR_RENTAL",
      "CcReceiptRequiredFlag": false,
      "CcReceiptThreshold": null,
      "CreatedBy": "3043",
      "CreationDate": "2001-06-26T09:55:16+00:00",
      "DefaultProjExpendType": null,
      "Description": null,
      "DescriptionBehaviour": null,
      "DescriptionBehaviourCode": null,
      "DispRcptViolationFlag": false,
      "EnableProjectsFlag": false,
      "EndDate": null,
      "ExpenseTemplateId": 10040,
      "ExpenseTypeId": 10294,
      "ItemizationBehaviour": "Disabled",
      "ItemizationBehaviourCode": "DISABLED",
      "ItemizationOnlyFlag": false,
      "LastUpdateDate": "2005-03-20T21:45:04+00:00",
      "LastUpdateLogin": "2443710",
      "LastUpdatedBy": "-1",
      "LocationBehaviour": null,
      "LocationBehaviourCode": null,
      "MerchantBehaviour": null,
      "MerchantBehaviourCode": null,
      "Name": "Noleggio Auto",
      "NegativeRcptRequiredCode": "T",
      "NumberOfDaysBehaviour": null,
      "NumberOfDaysBehaviourCode": null,
      "OrgId": 1017,
      "RcptRequiredProjFlag": false,
      "ReceiptRequiredFlag": false,
      "ReceiptThreshold": null,
      "StartDate": "2001-06-26",
      "TaxClassification": null,
      "TaxClassificationCode": "IVA20",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTypes/10294",
          "name": "expenseTypes",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTypes/10294",
          "name": "expenseTypes",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTypes/10294/child/itemizedExpenseTypes",
          "name": "itemizedExpenseTypes",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTypes/10294/child/preferredAgencyLists",
          "name": "preferredAgencyLists",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTypes/10294/child/preferredMerchantLists",
          "name": "preferredMerchantLists",
          "kind": "collection"
        }
      ]
    },
	...
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/expenseTypes",
      "name": "expenseTypes",
      "kind": "collection"
    }
  ]
}

Back to Top