Jump to

• Request
• Response

GET action not supported

get

/fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions

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 the budget entry transaction budgetary control results that match the primary key criteria specified.
    Finder Variables
    • TransactionNumber; string; The budget entry transaction number.
  • RowFinder Finds the latest budget entry transaction budgetary control results with the specified finder variable.
    Finder Variables
    • HeaderStatus; string; The budgetary control status for a budget entry transaction, such as passed, warning, or failed.
    • LineStatus; string; The budgetary control status for a budget entry transaction line, such as passed, warning, or failed.
    • SourceBudget; string; The source budget name for a budget entry transaction.
    • TransactionNumber; string; The budget entry transaction number.
• 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:
  

  • ActivityResult; string; The budgetary control result for the control budget activity of the budget entry transaction line.
  • ActivityStatus; string; The budgetary control status for the control budget activity of the budget entry transaction line such as passed, warning, or failed.
  • BatchFatalErrorMessage; string; The message of an unexpected error.
  • BatchResult; string; The budgetary control status code for the batch, such as success or failed.
  • BudgetAccount; string; The combination of budget segment values.
  • BudgetAdjustmentBalance; number; All changes made to the initial budget balance of the control budget.
  • BudgetManager; string; The budget manager who manages the control budget.
  • BudgetTransactionType; string; Indicates whether the budget entry transaction is an initial budget or a budget adjustment.
  • ControlBudget; string; The control budget name.
  • ControlBudgetAmount; number; The budget entry transaction amount in the control budget currency.
  • ControlBudgetCurrency; string; The currency of the control budget.
  • ControlBudgetPeriod; string; The name of the budget period of the control budget.
  • ConversionDate; string; The date when a conversion rate is used to convert the entered budget amount into the control budget currency.
  • ConversionRate; number; The currency conversion rate used to convert the entered transaction amount to the control budget currency amount.
  • FundsAction; string; Indicates whether funds check or funds reservation is performed for the budget entry transaction. Funds check doesn't update budget balances. Funds reservation updates budget balances when budgetary control validation doesn't fail.
  • FundsAvailableBalance; number; Funds available amount for consumption.
  • HeaderResult; string; The budgetary control result for the budget entry transaction.
  • HeaderStatus; string; The budgetary control status for a budget entry transaction, such as passed, warning, or failed.
  • InitialBudgetBalance; number; Initial budget balance of the control budget.
  • LineNumber; string; The budget entry line number.
  • LineResult; string; The budgetary control result for a budget entry transaction line.
  • LineStatus; string; The budgetary control status for a budget entry transaction line, such as passed, warning, or failed.
  • ReservedBudgetAmount; number; The amount that was updated to the budget balance of the control budget.
  • TotalBudgetBalance; number; Total budget balance of the control budget.
  • TotalConsumptionBalance; number; Total budget consumption amount consisting of expenditure amounts incurred and amounts at different degrees of committed stages.
  • TransactionAmount; number; The transaction amount in the budget currency.
  • TransactionCurrency; string; The transaction currency.
  • TransactionNumber; string; The transaction number.
  • UserConversionType; string; The source of a currency conversion rate, such as, user defined or corporate, that's used to convert the transactions.
• 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 : budgetaryControlResultsBudgetTransactions

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/budgetaryControlResultsBudgetTransactions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object budgetaryControlResultsBudgetTransactions-item-response

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

Type: object

Show Source

• ActivityResult: string
  Read Only: true

  Maximum Length: 80

  The budgetary control result for the control budget activity of the budget entry transaction line.
• ActivityStatus: string
  Read Only: true

  Maximum Length: 80

  The budgetary control status for the control budget activity of the budget entry transaction line such as passed, warning, or failed.
• BatchFatalErrorMessage: string
  Read Only: true

  Maximum Length: 2000

  The message of an unexpected error.
• BatchResult: string
  Read Only: true

  Maximum Length: 500

  The budgetary control status code for the batch, such as success or failed.
• BudgetAccount: string
  Read Only: true

  Maximum Length: 4000

  The combination of budget segment values.
• BudgetAdjustmentBalance: number
  Read Only: true

  All changes made to the initial budget balance of the control budget.
• BudgetManager: string
  Read Only: true

  Maximum Length: 240

  The budget manager who manages the control budget.
• BudgetTransactionType: string
  Read Only: true

  Maximum Length: 14

  Indicates whether the budget entry transaction is an initial budget or a budget adjustment.
• ControlBudget: string
  Read Only: true

  Maximum Length: 100

  The control budget name.
• ControlBudgetAmount: number
  Read Only: true

  The budget entry transaction amount in the control budget currency.
• ControlBudgetCurrency: string
  Read Only: true

  Maximum Length: 15

  The currency of the control budget.
• ControlBudgetPeriod: string
  Read Only: true

  Maximum Length: 15

  The name of the budget period of the control budget.
• ConversionDate: string (date)
  Read Only: true

  The date when a conversion rate is used to convert the entered budget amount into the control budget currency.
• ConversionRate: number
  Read Only: true

  The currency conversion rate used to convert the entered transaction amount to the control budget currency amount.
• FundsAction: string
  Read Only: true

  Maximum Length: 5

  Indicates whether funds check or funds reservation is performed for the budget entry transaction. Funds check doesn't update budget balances. Funds reservation updates budget balances when budgetary control validation doesn't fail.
• FundsAvailableBalance: number
  Read Only: true

  Funds available amount for consumption.
• HeaderResult: string
  Read Only: true

  The budgetary control result for the budget entry transaction.
• HeaderStatus: string
  Read Only: true

  Maximum Length: 80

  The budgetary control status for a budget entry transaction, such as passed, warning, or failed.
• InitialBudgetBalance: number
  Read Only: true

  Initial budget balance of the control budget.
• LineNumber: string
  Read Only: true

  Maximum Length: 40

  The budget entry line number.
• LineResult: string
  Read Only: true

  The budgetary control result for a budget entry transaction line.
• LineStatus: string
  Read Only: true

  Maximum Length: 80

  The budgetary control status for a budget entry transaction line, such as passed, warning, or failed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReservedBudgetAmount: number
  Read Only: true

  The amount that was updated to the budget balance of the control budget.
• TotalBudgetBalance: number
  Read Only: true

  Total budget balance of the control budget.
• TotalConsumptionBalance: number
  Read Only: true

  Total budget consumption amount consisting of expenditure amounts incurred and amounts at different degrees of committed stages.
• TransactionAmount: number
  Read Only: true

  The transaction amount in the budget currency.
• TransactionCurrency: string
  Read Only: true

  Maximum Length: 15

  The transaction currency.
• TransactionNumber: string
  Read Only: true

  Maximum Length: 240

  The transaction number.
• UserConversionType: string
  Read Only: true

  Maximum Length: 30

  The source of a currency conversion rate, such as, user defined or corporate, that's used to convert the transactions.

{
    "type":"object",
    "properties":{
        "ActivityStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The budgetary control status for the control budget activity of the budget entry transaction line such as passed, warning, or failed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":240,
            "type":"string",
            "description":"The transaction number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InitialBudgetBalance":{
            "type":"number",
            "description":"Initial budget balance of the control budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ControlBudgetCurrency":{
            "maxLength":15,
            "type":"string",
            "description":"The currency of the control budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FundsAvailableBalance":{
            "type":"number",
            "description":"Funds available amount for consumption.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchResult":{
            "maxLength":500,
            "type":"string",
            "description":"The budgetary control status code for the batch, such as success or failed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetTransactionType":{
            "maxLength":14,
            "type":"string",
            "description":"Indicates whether the budget entry transaction is an initial budget or a budget adjustment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineNumber":{
            "maxLength":40,
            "type":"string",
            "description":"The budget entry line number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The budgetary control status for a budget entry transaction line, such as passed, warning, or failed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionCurrency":{
            "maxLength":15,
            "type":"string",
            "description":"The transaction currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ControlBudgetPeriod":{
            "maxLength":15,
            "type":"string",
            "description":"The name of the budget period of the control budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReservedBudgetAmount":{
            "type":"number",
            "description":"The amount that was updated to the budget balance of the control budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BudgetAdjustmentBalance":{
            "type":"number",
            "description":"All changes made to the initial budget balance of the control budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalConsumptionBalance":{
            "type":"number",
            "description":"Total budget consumption amount consisting of expenditure amounts incurred and amounts at different degrees of committed stages.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalBudgetBalance":{
            "type":"number",
            "description":"Total budget balance of the control budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetAccount":{
            "maxLength":4000,
            "type":"string",
            "description":"The combination of budget segment values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchFatalErrorMessage":{
            "maxLength":2000,
            "type":"string",
            "description":"The message of an unexpected error.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityResult":{
            "maxLength":80,
            "type":"string",
            "description":"The budgetary control result for the control budget activity of the budget entry transaction line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetManager":{
            "maxLength":240,
            "type":"string",
            "description":"The budget manager who manages the control budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderStatus":{
            "maxLength":80,
            "type":"string",
            "description":"The budgetary control status for a budget entry transaction, such as passed, warning, or failed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionAmount":{
            "type":"number",
            "description":"The transaction amount in the budget currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ControlBudgetAmount":{
            "type":"number",
            "description":"The budget entry transaction amount in the control budget currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FundsAction":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates whether funds check or funds reservation is performed for the budget entry transaction. Funds check doesn't update budget balances. Funds reservation updates budget balances when budgetary control validation doesn't fail.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversionRate":{
            "type":"number",
            "description":"The currency conversion rate used to convert the entered transaction amount to the control budget currency amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineResult":{
            "type":"string",
            "description":"The budgetary control result for a budget entry transaction line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderResult":{
            "type":"string",
            "description":"The budgetary control result for the budget entry transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ControlBudget":{
            "maxLength":100,
            "type":"string",
            "description":"The control budget name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversionDate":{
            "type":"string",
            "description":"The date when a conversion rate is used to convert the entered budget amount into the control budget currency.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserConversionType":{
            "maxLength":30,
            "type":"string",
            "description":"The source of a currency conversion rate, such as, user defined or corporate, that's used to convert the transactions.",
            "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."
        }
    }
}

Back to Top