All REST Endpoints

AutoInvoice Interface Lines
The AutoInvoice interface lines resource is used to get, find, and update the interface line information.
Get all AutoInvoice interface lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines
Get an AutoInvoice interface line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines/{InterfaceLineGUID}
Update an AutoInvoice interface line
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines/{InterfaceLineGUID}
AutoInvoice Interface Lines/AutoInvoice Header Information Descriptive Flexfields
The AutoInvoice interface lines header information descriptive flexfields resource is used to get, find, and update the descriptive flexfield values associated with an interface line.
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines/{InterfaceLineGUID}/child/autoInvoiceHeaderInformationDFF/{InterfaceLineGuid}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines/{InterfaceLineGUID}/child/autoInvoiceHeaderInformationDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines/{InterfaceLineGUID}/child/autoInvoiceHeaderInformationDFF/{InterfaceLineGuid}
AutoInvoice Interface Lines/AutoInvoice Interface Line Transaction Descriptive Flexfields
The AutoInvoice interface line transaction global descriptive flexfields resource is used to get, find, and update the descriptive flexfield values associated with an interface line.
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines/{InterfaceLineGUID}/child/autoInvoiceInterfaceLineTransactionDFF/{InterfaceLineGuid}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines/{InterfaceLineGUID}/child/autoInvoiceInterfaceLineTransactionDFF
AutoInvoice Interface Lines/AutoInvoice Line Information Descriptive Flexfields
The AutoInvoice interface line information descriptive flexfields resource is used to get, find, and update the descriptive flexfield values associated with an interface line.
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines/{InterfaceLineGUID}/child/autoInvoiceLineInformationDFF/{InterfaceLineGuid}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines/{InterfaceLineGUID}/child/autoInvoiceLineInformationDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/autoInvoiceInterfaceLines/{InterfaceLineGUID}/child/autoInvoiceLineInformationDFF/{InterfaceLineGuid}
Bank Account User Rules
The bank account user rules resource is used to create country-specific rules on a simplified bank account UI. Label changes are also supported through this service.
Create a country-specific rule
Method: post
Path: /fscmRestApi/resources/11.13.18.05/bankAccountUserRules
Get a country-specific rule
Method: get
Path: /fscmRestApi/resources/11.13.18.05/bankAccountUserRules/{CountrySpecificUIRuleId}
Get all country-specific rules
Method: get
Path: /fscmRestApi/resources/11.13.18.05/bankAccountUserRules
Update an existing country-specific rule
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/bankAccountUserRules/{CountrySpecificUIRuleId}
Bank Accounts
The bank accounts resource is used to view, create, and modify bank accounts.
Create a bank account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts
Get a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}
Get all bank accounts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts
Update a bank account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}
Bank Accounts/Bank Account Descriptive Flexfields
The bank account descriptive flexfields resource manages details about the descriptive flexfield references for a bank account.
Create a descriptive flexfield for a bank account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/cashBankAccountDFF
Get a descriptive flexfield for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/cashBankAccountDFF/{BankAccountId2}
Get all descriptive flexfields for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/cashBankAccountDFF
Update a descriptive flexfield for a bank account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/cashBankAccountDFF/{BankAccountId2}
Bank Accounts/Bank Account Global Descriptive Flexfields
The bank account global descriptive flexfields resource manages details about the global descriptive flexfield references for a bank account.
Create a global descriptive flexfield for a bank account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/cashBankAccountGlobalDFF
Get a global descriptive flexfield for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/cashBankAccountGlobalDFF/{BankAccountId3}
Get all global descriptive flexfields for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/cashBankAccountGlobalDFF
Update a global descriptive flexfield for a bank account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/cashBankAccountGlobalDFF/{BankAccountId3}
Bank Accounts/Bank Account Grants
The bank account grants resource manages the security and access to the bank account.
Create a grant for a bank account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountGrants
Get a grant for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountGrants/{GrantId}
Get all grants for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountGrants
Update a grant for a bank account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountGrants/{GrantId}
Bank Accounts/Bank Account Payment Documents
The bank account payment documents resource manages details about the payment documents, paper stock type, document numbers, and payment formats associated to the bank account.
Create a payment document for a bank account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments
Get a payment document for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments/{PaymentDocumentId}
Get all payment documents for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments
Update a payment document for a bank account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments/{PaymentDocumentId}
Bank Accounts/Bank Account Payment Documents/Bank Account Checkbooks
The bank account checkbooks resource manages details about the payment checkbook, including checkbook name, prefix, start number, and received date.
Create a checkbook for a bank account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments/{PaymentDocumentId}/child/bankAccountCheckbooks
Get a checkbook for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments/{PaymentDocumentId}/child/bankAccountCheckbooks/{CheckbookId}
Get all checkbooks for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments/{PaymentDocumentId}/child/bankAccountCheckbooks
Update a checkbook for a bank account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountPaymentDocuments/{PaymentDocumentId}/child/bankAccountCheckbooks/{CheckbookId}
Bank Accounts/Bank Account Transaction Creation Rules
The bank account transaction creation rules resource is used to add one or more bank statement transaction creation rules to a bank account. The transaction creation rule is used to create external cash transactions based on the unreconciled bank statements.
Create a bank statement transaction creation rule for a bank account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountTransactionCreationRules
Delete a bank statement transaction creation rule for a bank account
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountTransactionCreationRules/{AccountTrxCreationRuleId}
Get a bank statement transaction creation rule for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountTransactionCreationRules/{AccountTrxCreationRuleId}
Get all bank statement transaction creation rules for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountTransactionCreationRules
Update a bank statement transaction creation rule for a bank account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountTransactionCreationRules/{AccountTrxCreationRuleId}
Bank Accounts/Bank Account Uses
The bank account uses resource manages the business unit assignments, and accounting combination for each business unit.
Create a bank account use for a bank account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses
Get a bank account use for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses/{bankAccountUsesUniqID}
Get all bank account uses for a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses
Update a bank account use for a bank account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses/{bankAccountUsesUniqID}
Bank Accounts/Bank Account Uses/Bank Account Payment Document Categories
The bank account payment document categories resource manages the payment method and payment document category associated to the business unit.
Create a payment document category for a business unit
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses/{bankAccountUsesUniqID}/child/bankAccountPaymentDocumentCategories
Delete a payment document category for a business unit
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses/{bankAccountUsesUniqID}/child/bankAccountPaymentDocumentCategories/{ApPmDocumentCategoryId}
Get a payment document category for a business unit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses/{bankAccountUsesUniqID}/child/bankAccountPaymentDocumentCategories/{ApPmDocumentCategoryId}
Get all payment document categories for a business unit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses/{bankAccountUsesUniqID}/child/bankAccountPaymentDocumentCategories
Update a payment document category for a business unit
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccounts/{BankAccountId}/child/bankAccountUses/{bankAccountUsesUniqID}/child/bankAccountPaymentDocumentCategories/{ApPmDocumentCategoryId}
Bank Branches
The bank branches resource is used to view, create, modify, or delete bank branches.
Create a bank branch
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankBranches
Delete a bank branch
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/cashBankBranches/{BranchPartyId}
Get a bank branch
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankBranches/{BranchPartyId}
Get all bank branches
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankBranches
Update a bank branch
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankBranches/{BranchPartyId}
Banks
The banks resource is used to view, create, modify, or delete banks.
Create a bank
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBanks
Delete a bank
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/cashBanks/{BankPartyId}
Get a bank
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBanks/{BankPartyId}
Get all banks
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBanks
Update a bank
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBanks/{BankPartyId}
Bill Management Users
The bill management users resource is used to enroll users for bill management. Prior to using this resource, the user must be defined as a customer contact for the customer account and as a user in Oracle Applications Cloud.
Create a bill management user
Method: post
Path: /fscmRestApi/resources/11.13.18.05/billManagementUsers
Get a bill management user
Method: get
Path: /fscmRestApi/resources/11.13.18.05/billManagementUsers/{BillManagementUserRegistrationId}
Get all bill management users
Method: get
Path: /fscmRestApi/resources/11.13.18.05/billManagementUsers
Brazilian Fiscal Documents
The Brazilian fiscal documents resource is used to view fiscal documents of Brazil.
Get a fiscal document
Method: get
Path: /fscmRestApi/resources/11.13.18.05/brazilianFiscalDocuments/{DocumentRelationId}
Get all fiscal documents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/brazilianFiscalDocuments
Budgetary Control Results Budget Impacts for Labor Cost Management
The budgetary control results budget impacts for labor cost management resource is used to view budgetary control validation information with budget balances for a labor schedule derived from the Labor Cost Management page in Project Portfolio Management.
Get the budget impacts of a budgetary control result
Method: get
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts/{budgetaryControlResultsBudgetImpactsUniqID}
Get the budget impacts of all budgetary control results
Method: get
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetImpacts
Budgetary Control Results for Enterprise Performance Management Budget Transactions
The budgetary control results resource is used internally for budget adjustments in Enterprise Performance Management to display budgetary control validation information.
Get a budget entry transaction budgetary control result
Method: get
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions/{TransactionNumber}
Get all latest budget entry transaction budgetary control results
Method: get
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlResultsBudgetTransactions
Budgetary Control Results for Labor Cost Management
The budgetary control results for labor cost management resource is used to view budgetary control validation information for a labor schedule derived from the Labor Cost Management page in Project Portfolio Management.
Get a budgetary control result
Method: get
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlResults/{budgetaryControlResultsUniqID}
Get all latest budgetary control results
Method: get
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlResults
Budgetary Control for Enterprise Performance Management Budget Transactions
The budgetary control for Enterprise Performance Management budget transactions resource creates budget entries and performs budgetary control validation.
Create and perform budgetary control validation on a budget entry transaction
Method: post
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions
Delete a budgetary control budget entry transaction interface row
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions/{budgetaryControlBudgetTransactionsUniqID}
Get a budgetary control budget entry transaction interface row
Method: get
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions/{budgetaryControlBudgetTransactionsUniqID}
Get all budgetary control budget entry transaction interface rows
Method: get
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions
Update a budgetary control budget entry transaction interface row
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions/{budgetaryControlBudgetTransactionsUniqID}
Budgetary Control for Enterprise Performance Management Budget Transactions/Large Object (LOB) Attributes - BudgetTransactionPayload
Delete a BudgetTransactionPayload
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions/{budgetaryControlBudgetTransactionsUniqID}/enclosure/BudgetTransactionPayload
Get a BudgetTransactionPayload
Method: get
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions/{budgetaryControlBudgetTransactionsUniqID}/enclosure/BudgetTransactionPayload
Replace a BudgetTransactionPayload
Method: put
Path: /fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions/{budgetaryControlBudgetTransactionsUniqID}/enclosure/BudgetTransactionPayload
Cash Bank Account Transfers
The bank account transfers resource is used to create, update, and view bank account transfers.
Create a bank account transfer
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccountTransfers
Get a bank account transfer
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccountTransfers/{BankAccountTransferId}
Get all bank account transfers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccountTransfers
Update a bank account transfer
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccountTransfers/{BankAccountTransferId}
Cash Pools
The cash pools resource is used to create, update, view, and delete the notional and physical cash pools with two or more bank accounts.
Create a cash pool
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashPools
Delete a cash pool
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}
Get a cash pool
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}
Get all cash pools
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashPools
Update a cash pool
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}
Cash Pools/Cash Pool Members
The cash pool members resource is used to create, view, and delete the members of the cash pool. The members can be individual bank accounts or another cash pool.
Create a cash pool member
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}/child/cashPoolMembers
Delete a cash pool member
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}/child/cashPoolMembers/{CashPoolMemberId}
Get a cash pool member
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}/child/cashPoolMembers/{CashPoolMemberId}
Get all cash pool members
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}/child/cashPoolMembers
Update a cash pool member
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashPools/{CashPoolId}/child/cashPoolMembers/{CashPoolMemberId}
Chart of Accounts Filters
The chart of accounts filters resource is used to return a filter ID value for the chart of accounts filter criteria that a user provides. This ID is used as a job parameter for process submissions.
Create a chart of accounts filter
Method: post
Path: /fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/{chartOfAccountsFiltersUniqID}
Chart of Accounts Filters/Filter Criteria
The filter criteria resource is used to specify criteria for a chart of accounts filter.
Create a set of filter criteria
Method: post
Path: /fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/{chartOfAccountsFiltersUniqID}/child/filterCriteria
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/{chartOfAccountsFiltersUniqID}/child/filterCriteria
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/chartOfAccountsFilters/{chartOfAccountsFiltersUniqID}/child/filterCriteria/{filterCriteriaUniqID}
Collection Promises
The collection promises resource is used to query and create promises to pay.
Create a collection promise
Method: post
Path: /fscmRestApi/resources/11.13.18.05/collectionPromises
Get a collection promise
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionPromises/{PromiseDetailId}
Get all collection promises
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionPromises
Collection Promises/Collection Promises Descriptive Flexfields
The collection promises descriptive flexfields resource is used to query and add descriptive flexfield values to a promise to pay.
Create a collection promise descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/collectionPromises/{PromiseDetailId}/child/collectionPromiseDFF
Get a collection promise descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionPromises/{PromiseDetailId}/child/collectionPromiseDFF/{PromiseDetailId2}
Get all descriptive flexfields for a collection promise group
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionPromises/{PromiseDetailId}/child/collectionPromiseDFF
Collections Delinquencies
The collections delinquencies resource provides details of customer delinquencies.
Create a collections delinquency
Method: post
Path: /fscmRestApi/resources/11.13.18.05/collectionsDelinquencies
Get a collections delinquency
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionsDelinquencies/{DelinquencyId}
Get all collections delinquencies
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionsDelinquencies
Update a collections delinquency
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/collectionsDelinquencies/{DelinquencyId}
Collections Strategies
The collections strategies resource is used to create, update, or view strategies assigned to customers, customer accounts, or sites, depending on the customers' business levels. A strategy assignment consists of strategy tasks that describe the steps in a collection activity based on the strategy group setup. The collection activity can also follow ad-hoc, user-defined strategy tasks that are not part of the setup.
Create a strategy assignment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies
Get a strategy assignment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}
Get all strategy assignments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies
Update a strategy assignment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}
Collections Strategies/Strategy Template Tasks
A strategy template task resource is used to retrieve all future tasks that are defined from the strategy setup template and skipped template tasks.
Get a strategy template task
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyTemplateTasks/{TemplateTaskId}
Get all strategy template tasks
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyTemplateTasks
Update a strategy template task status
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyTemplateTasks/{TemplateTaskId}
Collections Strategies/Tasks
The tasks resource is used to create, update, or view strategy tasks assigned to customers, customer accounts, or sites, depending on the customers' business levels. These strategy tasks can be executed or non-executed when they are predefined based on strategy group setup, or executed ad hoc, user-defined tasks.
Create a task assignment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyExecutionTasks
Get a task assignment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyExecutionTasks/{WorkItemId}
Get all task assignments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyExecutionTasks
Update a task assignment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyExecutionTasks/{WorkItemId}
Collections Strategies/User Tasks
The user tasks resource is used to create, update, or view any ad hoc strategy tasks that collectors want to add to the list of predefined strategy tasks for a particular strategy assignment.
Create a user task assignment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyUserTasks
Get a user task assignment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyUserTasks/{UserItemId}
Get all user task assignments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyUserTasks
Update a user task assignment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/collectionStrategies/{StrategyId}/child/strategyUserTasks/{UserItemId}
Credit Data Point Values
The data point values resource contains the value for credit and collections data points mapped to a party or account. The value is provided by customers. The data point value may be a number, date, or string data type.
Create a data point value
Method: post
Path: /fscmRestApi/resources/11.13.18.05/dataPointValues
Get a data point value
Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataPointValues/{DataPointRepositoryId}
Get all data point values
Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataPointValues
Update a data point value
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dataPointValues/{DataPointRepositoryId}
Credit Data Points
The credit and collections data point resource contains customer's firmographic, receivables, and financial information. The data point resources can be system derived or customer configured. The data point categories are Bank References, Billing and Payments, Business Information and Credit, Collateral, Financial Data, Guarantors, References, Trade References, Venture Funding, and Additional. For example, Total Amount Past Due is a system-derived credit and collections data point, categorized under Billing and Payments
Create a credit and collections data point
Method: post
Path: /fscmRestApi/resources/11.13.18.05/creditAndCollectionsDataPoints
Get a credit and collections data point
Method: get
Path: /fscmRestApi/resources/11.13.18.05/creditAndCollectionsDataPoints/{DataPointId}
Get all credit and collections data points
Method: get
Path: /fscmRestApi/resources/11.13.18.05/creditAndCollectionsDataPoints
Update a credit and collections data point
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/creditAndCollectionsDataPoints/{DataPointId}
Currency Rates
The currency rates resource is used to retrieve information on currency rates and dates for which rates are available for a source and target currency combination.
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/currencyRates/{currencyRatesUniqID}
Get all currency rates
Method: get
Path: /fscmRestApi/resources/11.13.18.05/currencyRates
Data Security for Users
The data security for users resource is used to deliver centralized and streamlined data assignment access and management across different applications.
Create a data assignment for a user
Method: post
Path: /fscmRestApi/resources/11.13.18.05/dataSecurities
Get a data assignment by user and role
Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataSecurities/{UserRoleDataAssignmentId}
Get all data assignments by user and role
Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataSecurities
Update a data assignment for a user
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/dataSecurities/{UserRoleDataAssignmentId}
Debit Authorizations
The debit authorization resource is used to view, create, and modify a debit authorization.
Create a debit authorization
Method: post
Path: /fscmRestApi/resources/11.13.18.05/debitAuthorizations
Get a debit authorization
Method: get
Path: /fscmRestApi/resources/11.13.18.05/debitAuthorizations/{debitAuthorizationsUniqID}
Get all debit authorizations
Method: get
Path: /fscmRestApi/resources/11.13.18.05/debitAuthorizations
Update a debit authorization
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/debitAuthorizations/{debitAuthorizationsUniqID}
Debit Authorizations/Debit Authorization Versions
The debit authorization version resource is used to view a debit authorization version.
Get a debit authorization version
Method: get
Path: /fscmRestApi/resources/11.13.18.05/debitAuthorizations/{debitAuthorizationsUniqID}/child/debitAuthorizationVersions/{debitAuthorizationVersionsUniqID}
Get all debit authorization versions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/debitAuthorizations/{debitAuthorizationsUniqID}/child/debitAuthorizationVersions
Document Sequence Derivations
The document sequence derivations resource is used to view, create, modify, and delete document sequence derivation records.
Create multiple document sequence derivation records
Method: post
Path: /fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations
Delete a document sequence derivation record
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/{DocumentSequenceDerivationId}
Get a document sequence derivation record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/{DocumentSequenceDerivationId}
Get all document sequence derivation records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations
Update a document sequence derivation record
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/localizationDocumentSequenceDerivations/{DocumentSequenceDerivationId}
ERP Business Events
The ERP business events resource is used to retrieve or update a business event-enabled record to determine whether the business event can be initiated.
Get a business event record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/erpBusinessEvents/{ErpBusinessEventId}
Get all business event records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/erpBusinessEvents
Update the enabled indicator for a business event
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/erpBusinessEvents/{ErpBusinessEventId}
ERP Integrations
The ERP integrations resource automates bulk data import and export flows. It also provides key features such as callback and error notifications, as part of these flows.
Create an inbound or outbound set of data
Method: post
Path: /fscmRestApi/resources/11.13.18.05/erpintegrations
Get all job details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/erpintegrations
Get job details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/erpintegrations/{OperationName}
Early Payment Offers
The early payment offers resource is used to manage details about buyer-initiated standing discount offers which includes assignments and descriptive flexfields.
Create a standing early payment offer
Method: post
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers
Get a standing early payment offer
Method: get
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}
Get all standing early payment offer
Method: get
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers
Retrieve the list of supplier contacts for a vendor
Method: post
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/action/getSupplierContacts
Send early payment offers to suppliers
Method: post
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/action/sendEarlyPaymentOffers
Update a standing early payment offer
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}
Update supplier contact for early payment offers
Method: post
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/action/updateSupplierAssignments
Early Payment Offers/Early Payment Offer Assignments
The early payment offer assignments resource is used to manage details about supplier assignment to the standing discount offers which includes descriptive flexfields.
Create a standing offer assignment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}/child/assignments
Get a standing offer assignment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}/child/assignments/{offerAssignmentId}
Get all standing offer assignments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}/child/assignments
Update a standing offer assignment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}/child/assignments/{offerAssignmentId}
Early Payment Offers/Early Payment Offer Assignments/Early Payment Offers Descriptive Flexfields
The early payment offers descriptive flexfields resource is used to manage details about the descriptive flexfield references for an assignment.
Create descriptive flexfields for a standing offer assignment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}/child/assignments/{offerAssignmentId}/child/assignmentDff
Get a descriptive flexfield for a standing offer assignment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}/child/assignments/{offerAssignmentId}/child/assignmentDff/{OfferAssignmentId}
Get all descriptive flexfields for a standing offer assignment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}/child/assignments/{offerAssignmentId}/child/assignmentDff
Update a descriptive flexfield for a standing offer assignment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/buyerInitiatedEarlyPaymentOffers/{discountOfferId}/child/assignments/{offerAssignmentId}/child/assignmentDff/{OfferAssignmentId}
Expense Accommodations Polices
The expense accommodations policies resource is used to contain details of all accommodations expense policies.
Get a single accommodations expense policy record for an accommodations expense policy identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies/{AccommodationsPolicyId}
Get all accommodations expense policy records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies
Expense Accommodations Polices/Expense Accommodations Policy Lines
The expense accommodations policy lines resource is used to contain details of an accommodations expense policy.
Get a single accommodations expense policy line record using an accommodations expense policy rate line identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies/{AccommodationsPolicyId}/child/expenseAccommodationsPolicyLines/{PolicyLineId}
Get all accommodations expense policy line records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseAccommodationsPolicies/{AccommodationsPolicyId}/child/expenseAccommodationsPolicyLines
Expense Airfare Policies
The expense airfare policies resource is used to view airfare expense policies.
Get all expense airfare policies
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseAirfarePolicies
Get an expense airfare policy
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseAirfarePolicies/{AirfarePolicyId}
Expense Airfare Policies/Expense Airfare Policy Lines
The expense airfare policy lines resource is used to view airfare expense policy line records.
Get all expense airfare policy lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseAirfarePolicies/{AirfarePolicyId}/child/expenseAirfarePolicyLines
Get an expense airfare policy line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseAirfarePolicies/{AirfarePolicyId}/child/expenseAirfarePolicyLines/{PolicyLineId}
Expense Audit Predictions
The expense audit predictions resource predicts the likelihood of an expense report to be audited.
Create an audit recommendation
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseAuditPredictions
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseAuditPredictions
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseAuditPredictions/{expenseReportId}
Expense Business Unit Settings
The expense business unit settings resource is used to get user entered setup options.
Get a business unit setting record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseOrganizationSettings/{expenseOrganizationSettingsUniqID}
Get all business unit setting records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseOrganizationSettings
Expense Cash Advances
The cash advance resource is used to manage all employee cash advances, which includes creation, update, deletion, and selection.
Create a cash advance record
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances
Delete a cash advance
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}
Get a cash advance record for the requested cash advance identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}
Get all cash advance records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances
Update a cash advance
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}
Expense Cash Advances/Attachments
The attachments resource is used to view, create, and update attachments.
Create an attachment.
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/Attachments
Delete an attachment.
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/Attachments/{AttachmentsUniqID}
Get all attachments.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/Attachments
Get an attachment.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/Attachments/{AttachmentsUniqID}
Update an attachment.
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/Attachments/{AttachmentsUniqID}
Expense Cash Advances/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Expense Cash Advances/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage
Expense Cash Advances/Cash Advance Descriptive Flexfields
The cash advance descriptive flexfield resource is used to manage details about the descriptive flexfield references for a cash advance.
Create a cash advance descriptive flexfield record for a cash advance
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/CashAdvanceDff
Get a descriptive flexfield record for the cash advance
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/CashAdvanceDff/{CashAdvanceId}
Get all descriptive flexfield records for the related cash advance
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/CashAdvanceDff
Update the descriptive flexfield record for a cash advance
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseCashAdvances/{expenseCashAdvancesUniqID}/child/CashAdvanceDff/{CashAdvanceId}
Expense Conversion Rate Options
The expense conversion rate options resource is used to provide conversion rate policies for business units.
Get a single conversion rate option record for a given conversion rate option row identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseConversionRateOptions/{ConversionRateId}
Get all conversion rate option records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseConversionRateOptions
Expense Conversion Rate Options/Conversion Rate Tolerances
The conversion rate tolerance resource is used to contain the conversion rate policy exceptions for specific currencies within a business unit.
Get a single conversion rate tolerance record for a given identifier of a conversion rate exception for a specific currency within a business unit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseConversionRateOptions/{ConversionRateId}/child/conversionRateTolerances/{ConversionRateToleranceId}
Get all conversion rate tolerance records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseConversionRateOptions/{ConversionRateId}/child/conversionRateTolerances
Expense Credit Card Transactions
The expense credit card transactions resource is used to describe all corporate card transactions of an employee. Only a selection of employee corporate card transactions are currently supported by this resource.
Get a corporate card transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseCreditCardTransactions/{CreditCardTrxnId}
Get all corporate card transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseCreditCardTransactions
Expense Delegations
The delegations resource is used to manage all information related to delegation that describes authorized delegation between employees.
Create an expense delegation
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseDelegations
Get all expense delegations
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseDelegations
Get an expense delegation
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseDelegations/{expenseDelegationsUniqID}
Update an expense delegation
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseDelegations/{expenseDelegationsUniqID}
Expense Descriptive Flexfield Contexts
The expense descriptive flexfield contexts resource is used for expenses and expense reports.
Get a descriptive flexfield context for expenses and expense reports
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseDffContexts/{RowIdentifier}
Get all descriptive flexfield contexts for expenses and expense reports
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseDffContexts
Expense Descriptive Flexfield Segments
The expense descriptive flexfield segments resource is used for expenses and expense reports.
Get a descriptive flexfield segment for expenses and expense reports
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseDffSegments/{RowIdentifier}
Get all descriptive flexfield segments for expenses and expense reports
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseDffSegments
Expense Distributions
The expense distributions resource is a child resource that contains distribution information about an expense item.
Create a distribution record for the related expense
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseDistributions
Get all distribution records for the related expense
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseDistributions
Get an expense distribution record for a specific expense distribution identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseDistributions/{ExpenseDistId}
Update a distribution record for a specific expense distribution identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseDistributions/{ExpenseDistId}
Expense Distributions/Project Descriptive Flexfields
The project-related descriptive flexfields resource is a child resource that maintains project flexfields related to an expense.
Create a project-related descriptive flexfield record for a specific expense distribution identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseDistributions/{ExpenseDistId}/child/PJCDFF
Get a project-related descriptive flexfield record for a specific expense distribution identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseDistributions/{ExpenseDistId}/child/PJCDFF/{ExpenseDistId2}
Get all project-related descriptive flexfield records for a specific expense distribution identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseDistributions/{ExpenseDistId}/child/PJCDFF
Update a project-related descriptive flexfield record for a specific expense distribution identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseDistributions/{ExpenseDistId}/child/PJCDFF/{ExpenseDistId2}
Expense Entertainment Policies
The expense entertainment policies resource is used to view entertainment expense policies.
Get all expense entertainment policies
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseEntertainmentPolicies
Get an expense entertainment policy
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseEntertainmentPolicies/{EntertainmentPolicyId}
Expense Entertainment Policies/Expense Entertainment Policy Lines
The expense entertainment policy lines resource is used to view entertainment expense policy line records.
Get all expense entertainment policy lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseEntertainmentPolicies/{EntertainmentPolicyId}/child/expenseEntertainmentPolicyLines
Get an expense entertainment policy line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseEntertainmentPolicies/{EntertainmentPolicyId}/child/expenseEntertainmentPolicyLines/{PolicyLineId}
Expense Locations
Expense locations resource is used to provide data that represents physical geographies.
Get a single expense location record using the expense location identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseLocations/{GeographyId}
Get all expense location records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseLocations
Expense Meals Policies
The expense meals policies resource is used to get all meals expense policies.
Get a single expense meals policy record for a meals policy identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMealsPolicies/{MealsPolicyId}
Get all expense meals policy records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMealsPolicies
Expense Meals Policies/Expense Meals Policy Lines
The expense meals policy lines resource is used to get all meals expense policy line records.
Get a single expense meals policy line record for a meals policy rate line identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMealsPolicies/{MealsPolicyId}/child/expenseMealsPolicyLines/{PolicyLineId}
Get all expense meals policy line records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMealsPolicies/{MealsPolicyId}/child/expenseMealsPolicyLines
Expense Mileage Policies
The expense mileage policies resource is used to get all mileage-related policies.
Get a single expense mileage policy record for a given mileage policy identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/{MileagePolicyId}
Get all expense mileage policy line records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMileagePolicies
Expense Mileage Policies/Expense Mileage Policy Lines
The expense mileage policy lines resource is used to get all records related to mileage policy lines.
Get a single expense mileage policy line record for a given mileage policy rate line identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/{MileagePolicyId}/child/expenseMileagePolicyLines/{PolicyLineId}
Get all expense mileage policy records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMileagePolicies/{MileagePolicyId}/child/expenseMileagePolicyLines
Expense Miscellaneous Policies
The expense miscellaneous policies resource is used to view miscellaneous expense policy records.
Get all expense miscellaneous policies
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMiscPolicies
Get an expense miscellaneous policy
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMiscPolicies/{MiscPolicyId}
Expense Miscellaneous Policies/Expense Miscellaneous Policy Lines
The expense miscellaneous policy lines resource is used to view miscellaneous expense policy line records.
Get all expense miscellaneous policy lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMiscPolicies/{MiscPolicyId}/child/expenseMiscPolicyLines
Get an expense miscellaneous policy line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseMiscPolicies/{MiscPolicyId}/child/expenseMiscPolicyLines/{PolicyLineId}
Expense Per Diem Calculations
The expense per diem calculations resource is used to calculate the reimbursement of a trip upon which a per diem policy applies.
Create a per diem calculation
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expensePerDiemCalculations
Get all expense per diem policies
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePerDiemCalculations
Get an expense per diem policy
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePerDiemCalculations/{expensePerDiemCalculationsUniqID}
Expense Per Diem Policies
The expense per diem policies resource is used to view per diem expense policy records.
Get all expense per diem policies
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePerDiemPolicies
Get an expense per diem policy
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePerDiemPolicies/{PerDiemPolicyId}
Expense Per Diem Policies/Expense Per Diem Policy Lines
The expense per diem policy lines resource is used to view per diem expense policy line records.
Get all expense per diem policy lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePerDiemPolicies/{PerDiemPolicyId}/child/expensePerDiemPolLines
Get an expense per diem policy line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePerDiemPolicies/{PerDiemPolicyId}/child/expensePerDiemPolLines/{PolicyLineId}
Expense Per Diem Policies/Expense Per Diem Policy Values
The expense per diem policy values resource is used to view records of per diem expense policy values in percentages.
Get all expense per diem policy values
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePerDiemPolicies/{PerDiemPolicyId}/child/expensePerDiemPolValues
Get an expense per diem policy value
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePerDiemPolicies/{PerDiemPolicyId}/child/expensePerDiemPolValues/{PolicyValueId}
Expense Persons
The expense persons resource is used to get details like BU name and currency name for a person.
Get all expense person records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePersons
Get an expense person record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePersons/{PersonId}
Expense Preferences
The expense preferences resource is used to get a person's expense preferences record.
Create an expense preferences record for a person
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expensePreferences
Delete an expense preferences record for a person
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expensePreferences/{PersonId}
Get all expense preferences records for a person
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePreferences
Get an expense preferences record for a person
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePreferences/{PersonId}
Update an expense preferences record for a person
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expensePreferences/{PersonId}
Expense Preferred Types
The expense preferred types resource is used to query preferred expense types for a chatbot user.
Get a single preferred expense type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePreferredTypes/{RecordId}
Get all preferred expense types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expensePreferredTypes
Expense Profile Attributes
The expense profile attributes resource is used to get a person's expense profile attributes record.
Get all records of a person's expense profile attributes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseProfileAttributes
Get the record of a person's expense profile attributes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseProfileAttributes/{PersonId}
Expense Reports
The expense reports resource contains information about an expense report.
Apply a cash advance
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/action/applyCashAdvances
Create an expense report record
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports
Get all expense report records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports
Get an expense report record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}
Process a workflow action
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/action/processWFAction
Remove a cash advance
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/action/revertCashAdvances
Submit an expense report
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/action/submit
Update an expense report record for a specific expense report identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}
Expense Reports/Attachments
The attachments resource is used to manage documents that the user attaches to an expense report.
Create an attachment record for a specific attachment identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Attachments
DELETE action not supported
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Attachments/{AttachmentsUniqID}
Get an attachment record related to an expense report
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Attachments/{AttachmentsUniqID}
Get attachment records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Attachments
Update an attachment record for a specific attachment identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Attachments/{AttachmentsUniqID}
Expense Reports/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Expense Reports/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage
Expense Reports/Expense Notes
The expense notes resource is a child resource that contains notes entered by an approver or an auditor about an expense report.
Get a single expense note record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/expenseNotes/{expenseNotesUniqID}
Get all expense note records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/expenseNotes
Expense Reports/Expense Notes/Large Object (LOB) Attributes - NoteText
Get a NoteText
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/expenseNotes/{expenseNotesUniqID}/enclosure/NoteText
Expense Reports/Expense Processing Details
The expense processing details resource is a child resource that contains information about status changes of an expense report.
Get a single processing detail record of an expense report
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/processingDetails/{processingDetailsUniqID}
Get all processing detail records of an expense report
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/processingDetails
Expense Reports/Expense Report Descriptive Flexfields
The expense report descriptive flexfields resource is used to store additional company-specific information that is captured for an expense report.
Create an expense report descriptive flexfield record
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/ExpenseReportDff
Get all expense report header descriptive flexfield records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/ExpenseReportDff
Get an expense report header descriptive flexfield record for a specific expense report identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/ExpenseReportDff/{ExpenseReportId}
Update an expense report header descriptive flexfields for a specific expense report identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/ExpenseReportDff/{ExpenseReportId}
Expense Reports/Expense Report Payments
The expense report payments resource is a child resource that contains payment information for a paid expense report.
Get all expense report payments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/ExpensePayment
Get an expense report payment record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/ExpensePayment/{ExpenseReportId}
Expense Reports/Expenses
The expenses resource is a child resource that contains information about an expense item.
Create a duplicate of an expense
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/action/duplicate
Create an expense record
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense
Get all expense records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense
Get an expense record for a specific expense identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}
Update an expense record for a specific expense identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}
Expense Reports/Expenses/Attachments
The attachments resource is used to manage documents that the user attaches to an expense item.
Create an attachment record for a specific attachment identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/Attachments
DELETE action not supported
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/Attachments/{AttachmentsUniqID}
Get an attachment record related to an expense report
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/Attachments/{AttachmentsUniqID}
Get attachment records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/Attachments
Update an attachment record for a specific attachment identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/Attachments/{AttachmentsUniqID}
Expense Reports/Expenses/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Expense Reports/Expenses/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage
Expense Reports/Expenses/Duplicate Expenses
The duplicate expenses resource is a child resource that contains information about all duplicate expense items related to an expense.
Get a duplicate expense record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/duplicateExpenses/{duplicateExpensesUniqID}
Get all duplicate expense records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/duplicateExpenses
Update a duplicate expense record
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/duplicateExpenses/{duplicateExpensesUniqID}
Expense Reports/Expenses/Expense Attendees
The expense attendees resource is a child resource that contains attendee information about an expense item.
Create an expense attendee record for an expense identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseAttendee
Get all expense attendee records for an expense identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseAttendee
Get an expense attendee record for a specific expense attendee identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseAttendee/{ExpenseAttendeeId}
Update an expense attendee record for a specific expense identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseAttendee/{ExpenseAttendeeId}
Expense Reports/Expenses/Expense Descriptive Flexfields
The expense descriptive flexfields resource is used to manage details about the descriptive flexfield references for an expense item.
Create an expense descriptive flexfield record for a specific expense identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDff
Get a descriptive flexfield record for the related expense
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDff/{ExpenseId}
Get all descriptive flexfield records for the related expense
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDff
Update a descriptive flexfield record for a specific expense identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDff/{ExpenseId}
Expense Reports/Expenses/Expense Distributions
The expense distributions resource is a child resource that contains distribution information about an expense item.
Create a distribution record for the related expense
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDistribution
Get all distribution records for the related expense
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDistribution
Get an expense distribution record for a specific expense distribution identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDistribution/{ExpenseDistId}
Update a distribution record for a specific expense distribution identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDistribution/{ExpenseDistId}
Expense Reports/Expenses/Expense Distributions/Projects Descriptive Flexfields
The project-related descriptive flexfields resource is a child resource that maintains project flexfields related to an expense.
Create a project-related descriptive flexfield record for a specific expense distribution identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDistribution/{ExpenseDistId}/child/PJCDFF
Get a project-related descriptive flexfield record for a specific expense distribution identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDistribution/{ExpenseDistId}/child/PJCDFF/{ExpenseDistId2}
Get all project-related descriptive flexfield records for a specific expense distribution identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDistribution/{ExpenseDistId}/child/PJCDFF
Update a project-related descriptive flexfield record for a specific expense distribution identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseDistribution/{ExpenseDistId}/child/PJCDFF/{ExpenseDistId2}
Expense Reports/Expenses/Expense Errors
The expense errors resource is a child resource that contains information about all validation errors of an expense.
Get all expense error records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/expenseErrors
Get an expense error record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/expenseErrors/{ErrorSequence}
Expense Reports/Expenses/Expense Itemizations
The expense itemizations resource is a child resource used to manage details about the itemized lines of an expense item.
Create an itemization record for a specific expense identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseItemization
Get all expense itemization records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseItemization
Get an expense itemization record for a specific expense
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseItemization/{ExpenseId}
Update an expense itemization record for a specific expense identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/ExpenseItemization/{ExpenseId}
Expense Reports/Expenses/Matched Expenses
The matched expenses resource is a child resource that contains information about all matched expense items related to an expense.
Get a matched expense record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/matchedExpenses/{MatchReference}
Get all matched expense records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/matchedExpenses
PATCH action not supported
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseReports/{expenseReportsUniqID}/child/Expense/{ExpenseUniqID}/child/matchedExpenses/{MatchReference}
Expense Scanned Images
The expense scanned images resource uploads images to the image recognition application and obtains receipt details.
GET action for multiple images not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseScanImages
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseScanImages/{DocumentId}
Upload an image to the image recognition application
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseScanImages
Expense System Options
The expense setup options resource is used to get user selected setup options.
Get a setup option record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseSetupOptions/{OptionId}
Get all setup option records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseSetupOptions
Expense Templates
The expense templates resource is used to group sets of expense types by business unit for purposes such as Education, Travel, and Relocation.
Get a single expense template
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}
Get all expense templates
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates
Expense Templates/Expense Types
The expense types resource is used to define the expense types for an expense report template and the associated corporate policies.
Get a single expense type in an expense template
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}/child/expenseTypes/{ExpenseTypeId}
Get all expense types in an expense template record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}/child/expenseTypes
Expense Templates/Expense Types/Itemized Expense Types
The itemized expense types resource is used to itemize expense types.
Get a single itemized expense type record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}/child/expenseTypes/{ExpenseTypeId}/child/itemizedExpenseTypes/{itemizedExpenseTypesUniqID}
Get all itemized expense type records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}/child/expenseTypes/{ExpenseTypeId}/child/itemizedExpenseTypes
Expense Templates/Expense Types/Preferred Agency Lists
The preferred agency lists resource is used to view the preferred agency lists that are defined for the expense type.
Get a single preferred agency list record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}/child/expenseTypes/{ExpenseTypeId}/child/preferredAgencyLists/{preferredAgencyListsUniqID}
Get all preferred agency list records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}/child/expenseTypes/{ExpenseTypeId}/child/preferredAgencyLists
Expense Templates/Expense Types/Preferred Merchant Lists
The preferred merchant lists resource is used to view the preferred merchant lists that are defined for the expense type.
Get a single preferred merchant list record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}/child/expenseTypes/{ExpenseTypeId}/child/preferredMerchantLists/{preferredMerchantListsUniqID}
Get all preferred merchant list records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}/child/expenseTypes/{ExpenseTypeId}/child/preferredMerchantLists
Expense Templates/Mobile Expense Types
The mobile expense types resource is used to view the expense types that are defined for an expense template.
Get a single mobile expense type record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}/child/mobileExpenseTypes/{ExpenseTypeId}
Get all mobile expense type records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTemplates/{ExpenseTemplateId}/child/mobileExpenseTypes
Expense Travel Itineraries
The expense travel itineraries resource is used to get travel itinerary information from third-party travel partner sites.
Create a travel itinerary
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries
Get a travel itinerary
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}
Get all travel itineraries
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries
Update a travel itinerary
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}
Expense Travel Itineraries/Expense Travel Itinerary Reservations
The expense itinerary reservations resource is used to get travel reservation information from third-party travel partner sites.
Create a travel itinerary reservation
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}/child/itineraryReservations
Get a travel itinerary reservation
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}/child/itineraryReservations/{itineraryReservationsUniqID}
Get all travel itinerary reservations
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}/child/itineraryReservations
Update a travel itinerary reservation
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}/child/itineraryReservations/{itineraryReservationsUniqID}
Expense Travel Itineraries/Expense Travel Itinerary Reservations/Expense Travel Itinerary Reservation Items
The expense reservation items resource is used to get travel reservation item information from third-party travel partner sites.
Create a travel itinerary reservation item
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}/child/itineraryReservations/{itineraryReservationsUniqID}/child/reservationItems
Get a travel itinerary reservation item
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}/child/itineraryReservations/{itineraryReservationsUniqID}/child/reservationItems/{reservationItemsUniqID}
Get all travel itinerary reservation items
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}/child/itineraryReservations/{itineraryReservationsUniqID}/child/reservationItems
Update a travel itinerary reservation item
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenseTravelItineraries/{expenseTravelItinerariesUniqID}/child/itineraryReservations/{itineraryReservationsUniqID}/child/reservationItems/{reservationItemsUniqID}
Expense Types
The expense types resource is used to define an expense report template and the associated corporate expense policies.
Get a single expense type record for the requested expense type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTypes/{ExpenseTypeId}
Get all expense type records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTypes
Expense Types/Expenses Type Itemize
The itemized expense types resource is used to define expense types that are eligible for itemization.
Get a single itemized expense type record for the requested itemized expense type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTypes/{ExpenseTypeId}/child/itemizedExpenseTypes/{itemizedExpenseTypesUniqID}
Get all itemized expense type records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTypes/{ExpenseTypeId}/child/itemizedExpenseTypes
Expense Types/Preferred Agency Lists
The preferred agency lists resource is used to view the preferred agency lists that are defined for the expense type.
Get a single preferred agency list record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTypes/{ExpenseTypeId}/child/preferredAgencyLists/{preferredAgencyListsUniqID}
Get all preferred agency list records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTypes/{ExpenseTypeId}/child/preferredAgencyLists
Expense Types/Preferred Merchant Lists
The preferred merchant lists resource is used to view the preferred merchant lists that are defined for the expense type.
Get a single preferred merchant list record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTypes/{ExpenseTypeId}/child/preferredMerchantLists/{preferredMerchantListsUniqID}
Get all preferred merchant list records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenseTypes/{ExpenseTypeId}/child/preferredMerchantLists
Expenses
The expenses resource is a parent resource that contains all the expense information incurred by an employee.
Create a duplicate of an expense.
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/action/duplicate
Create an expense record
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenses
DELETE action not supported
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}
Get all expense records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses
Get an expense record of an expense identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}
Update an expense record
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}
Expenses/Attachments
The attachments resource is used to manage documents that the user has attached to the expense item.
Create an attachment record for an attachment identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/Attachments
DELETE action not supported
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/Attachments/{AttachmentsUniqID}
Get all attachment records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/Attachments
Get the attachment record related to the expense report
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/Attachments/{AttachmentsUniqID}
Update an attachment record
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/Attachments/{AttachmentsUniqID}
Expenses/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileContents
Expenses/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/Attachments/{AttachmentsUniqID}/enclosure/FileWebImage
Expenses/Duplicate Expenses
The duplicate expenses resource is a child resource that contains information about all duplicate expense items related to an expense.
Get a duplicate expense record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/duplicateExpenses/{duplicateExpensesUniqID}
Get all duplicate expense records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/duplicateExpenses
Update a duplicate expense record
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/duplicateExpenses/{duplicateExpensesUniqID}
Expenses/Expense Attendees
The expense attendees resource is a child resource that contains expense attendee information.
Create an expense attendee record for an expense identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseAttendee
Get all expense attendee records for an expense identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseAttendee
Get an expense attendee record for an expense attendee identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseAttendee/{ExpenseAttendeeId}
Update an expense attendee record for an expense identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseAttendee/{ExpenseAttendeeId}
Expenses/Expense Descriptive Flexfields
The expense descriptive flexfields resource is used to manage details about the descriptive flexfield references for an expense item.
Create an expense descriptive flexfield record for an expense identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDff
Get all descriptive flexfield records for the related expense
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDff
Get the descriptive flexfield record for the related expense
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDff/{ExpenseId}
Update the descriptive flexfield record for an expense identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDff/{ExpenseId}
Expenses/Expense Distributions
The expense distributions resource manages details about all expenses incurred by an employee, which includes attendees, distributions, descriptive flexfields, itemizations, and attachment information.
Create a distribution record for the related expense
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDistribution
Get all distribution records for the related expense
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDistribution
Get an expense distribution record for an expense distribution identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDistribution/{ExpenseDistId}
Update the distribution record for an expense distribution identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDistribution/{ExpenseDistId}
Expenses/Expense Distributions/Project Descriptive Flexfields
The project-related descriptive flexfields resource is a child resource that maintains project flexfields related to an expense.
Create a project-related descriptive flexfield record
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDistribution/{ExpenseDistId}/child/PJCDFF
Get all project-related descriptive flexfield records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDistribution/{ExpenseDistId}/child/PJCDFF
Get the project-related descriptive flexfield record for an expense distribution identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDistribution/{ExpenseDistId}/child/PJCDFF/{ExpenseDistId2}
Update the project-related descriptive flexfield record for an expense distribution identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseDistribution/{ExpenseDistId}/child/PJCDFF/{ExpenseDistId2}
Expenses/Expense Errors
The expense errors resource is a child resource that contains information about all validation errors of an expense.
Get all expense error records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/expenseErrors
Get an expense error record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/expenseErrors/{ErrorSequence}
Expenses/Expense Itemizations
The expense itemizations resource is a child resource used to manage details about the itemized lines of an expense incurred by an employee.
Create an itemization record for an expense identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseItemization
Get all expense itemization records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseItemization
Get an expense itemization record for an expense
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseItemization/{ExpenseId}
Update the expense itemization record for an expense identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/ExpenseItemization/{ExpenseId}
Expenses/Matched Expenses
The matched expenses resource is a child resource that contains information about all matched expense items related to an expense.
Get a matched expense record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/matchedExpenses/{MatchReference}
Get all matched expense records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/matchedExpenses
PATCH action not supported
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/expenses/{expensesUniqID}/child/matchedExpenses/{MatchReference}
External Bank Accounts
The external bank accounts resource is used to view, create, and modify an external bank account.
Create an external bank account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/externalBankAccounts
Get all external bank accounts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalBankAccounts
Get an external bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}
Update an external bank account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}
External Bank Accounts/Account Owners
The account owners resource is used to view, create, and modify the account owner of an external bank account.
Create an account owner for an external bank account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}/child/accountOwners
Get all account owners for an external bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}/child/accountOwners
Get an account owner for an external bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}/child/accountOwners/{AccountOwnerId}
Update an account owner for an external bank account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/externalBankAccounts/{BankAccountId}/child/accountOwners/{AccountOwnerId}
External Cash Transactions
The external cash transactions resource is used to view, create, modify, or delete external transactions. The voiding of external transactions is also supported through the update of the status attribute.
Create an external transaction
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions
Get all external transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions
Get an external transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}
Update an external transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}
External Cash Transactions/Attachments
The attachments resource manages documents that are attached by the user to the external transaction.
Create an attachment for an external transaction
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments
Delete an attachment for an external transaction
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments/{attachmentsUniqID}
Get all attachments for an external transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments
Get an attachment for an external transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments/{attachmentsUniqID}
Update an attachment for an external transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments/{attachmentsUniqID}
External Cash Transactions/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
External Cash Transactions/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
External Cash Transactions/Descriptive Flexfields
The descriptive flexfields resource manages details about the descriptive flexfield references for an external transaction.
Create a descriptive flexfield for an external transaction
Method: post
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/cashExternalTransactionDFF
Get a descriptive flexfield for an external transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/cashExternalTransactionDFF/{ExternalTransactionId2}
Get all descriptive flexfields for an external transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/cashExternalTransactionDFF
Update a descriptive flexfield for an external transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/cashExternalTransactions/{ExternalTransactionId}/child/cashExternalTransactionDFF/{ExternalTransactionId2}
External Payees
The payments external payees resource is used to view, create, and modify an external payee.
Create an external payee
Method: post
Path: /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Get all external payees
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees
Get an external payee
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/{PayeeId}
Update an external payee
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/{PayeeId}
External Payees/External Party Payment Methods
The external party payment methods resource is used to view, create, and modify payment methods assigned to supplier payees.
Create a payment method assignment to a payee
Method: post
Path: /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/{PayeeId}/child/externalPartyPaymentMethods
Get a payment method assigned to a payee
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/{PayeeId}/child/externalPartyPaymentMethods/{ExternalPartyPaymentMethodsId}
Get all payment methods assigned to a payee
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/{PayeeId}/child/externalPartyPaymentMethods
Update a payment method assigned to a payee
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentsExternalPayees/{PayeeId}/child/externalPartyPaymentMethods/{ExternalPartyPaymentMethodsId}
Federal Account Symbols
The federal account symbols resource is used to query, create and update federal account symbols.
Create a federal account symbol
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols
Delete a federal account symbol
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols/{FedAccountSymbolId}
Get a federal account symbol
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols/{FedAccountSymbolId}
Get all federal account symbols
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols
Update a federal account symbol
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols/{FedAccountSymbolId}
Federal Account Symbols/Federal Account Symbols Descriptive Flexfields
The federal account symbols descriptive flexfields resource manages the descriptive flexfield references for a federal account symbol.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols/{FedAccountSymbolId}/child/fedAccountSymbolDFF
Delete
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols/{FedAccountSymbolId}/child/fedAccountSymbolDFF/{FedAccountSymbolId2}
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols/{FedAccountSymbolId}/child/fedAccountSymbolDFF/{FedAccountSymbolId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols/{FedAccountSymbolId}/child/fedAccountSymbolDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbols/{FedAccountSymbolId}/child/fedAccountSymbolDFF/{FedAccountSymbolId2}
Federal Agency Location Codes
The federal agency location codes resource is used to set up agency locations. You can query, create, delete, and update agency locations.
Create an agency location code
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes
Delete an agency location code
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/{AgencyLocationCodeId}
Get all agency location codes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes
Get an agency location code
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/{AgencyLocationCodeId}
Update an agency location code
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/{AgencyLocationCodeId}
Federal Agency Location Codes/Federal Agency Location Codes Descriptive Flexfields
The federal agency location codes descriptive flexfields resource manages details about the descriptive flexfield references for an agency location.
Create an agency location code descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/{AgencyLocationCodeId}/child/fedAgencyLocationCodeDFF
Delete an agency location code descriptive flexfield
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/{AgencyLocationCodeId}/child/fedAgencyLocationCodeDFF/{AgencyLocationCodeId2}
Get all agency location code descriptive flexfields
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/{AgencyLocationCodeId}/child/fedAgencyLocationCodeDFF
Get an agency location code descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/{AgencyLocationCodeId}/child/fedAgencyLocationCodeDFF/{AgencyLocationCodeId2}
Update an agency location code descriptive flexfield
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodes/{AgencyLocationCodeId}/child/fedAgencyLocationCodeDFF/{AgencyLocationCodeId2}
Federal Budget Execution Controls
The federal budget execution controls resource is used to query, create, and update budget execution controls.
Create a budget execution control
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls
Delete a budget execution control
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls/{fedBudgetExecutionControlsUniqID}
Get a budget execution control
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls/{fedBudgetExecutionControlsUniqID}
Get all budget execution controls
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls
Update a budget execution control
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls/{fedBudgetExecutionControlsUniqID}
Federal Budget Execution Controls/Federal Budget Execution Control Segments
The federal budget execution control segments resource is used to query, create, and update budget execution control segments.
Create a budget execution control segment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls/{fedBudgetExecutionControlsUniqID}/child/fedBudgetControlSegments
Delete a budget execution control segment
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls/{fedBudgetExecutionControlsUniqID}/child/fedBudgetControlSegments/{KeySegmentId}
Get a budget execution control segment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls/{fedBudgetExecutionControlsUniqID}/child/fedBudgetControlSegments/{KeySegmentId}
Get all budget execution control segments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls/{fedBudgetExecutionControlsUniqID}/child/fedBudgetControlSegments
Update a budget execution control segment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetExecutionControls/{fedBudgetExecutionControlsUniqID}/child/fedBudgetControlSegments/{KeySegmentId}
Federal Budget Transaction Types
The budget transaction types resource is used to query, create, and update budget transaction types.
Create a budget transaction type
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes
Delete a budget transaction type
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}
Get a budget transaction type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}
Get all budget transaction types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes
Update a budget transaction type
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}
Federal Budget Transaction Types/Federal Budget Transaction Type Accounts
The budget transaction type accounts resource is used to query, create, and update budget transaction type accounts.
Create a budget transaction type account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeAccounts
Delete a budget transaction type account
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeAccounts/{AccountAssignmentId}
Get a budget transaction type account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeAccounts/{AccountAssignmentId}
Get all budget transaction type accounts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeAccounts
Update a budget transaction type account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeAccounts/{AccountAssignmentId}
Federal Budget Transaction Types/Federal Budget Transaction Type Accounts/Federal Budget Transaction Type Accounts Descriptive Flexfields
The budget transaction type accounts descriptive flexfields resource manages the descriptive flexfield references for a budget transaction type account.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeAccounts/{AccountAssignmentId}/child/fedBudgetTransactionAccountDFF
Delete
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeAccounts/{AccountAssignmentId}/child/fedBudgetTransactionAccountDFF/{AccountAssignmentId2}
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeAccounts/{AccountAssignmentId}/child/fedBudgetTransactionAccountDFF/{AccountAssignmentId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeAccounts/{AccountAssignmentId}/child/fedBudgetTransactionAccountDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeAccounts/{AccountAssignmentId}/child/fedBudgetTransactionAccountDFF/{AccountAssignmentId2}
Federal Budget Transaction Types/Federal Budget Transaction Types Descriptive Flexfields
The budget transaction types descriptive flexfields resource manages the descriptive flexfield references for a budget transaction type.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeDFF
Delete
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeDFF/{TransactionTypeId2}
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeDFF/{TransactionTypeId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetTransactionTypes/{TransactionTypeId}/child/fedBudgetTransactionTypeDFF/{TransactionTypeId2}
Federal Business Event Type Codes
The federal business event type codes resource is used to query, create and update business event type codes.
Create business event type codes
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes
Delete a business event type code
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/{BusinessEventTypeId}
Get a business event type code
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/{BusinessEventTypeId}
Get all business event type codes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes
Update a business event type code
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/{BusinessEventTypeId}
Federal Business Event Type Codes/Federal Business Event Type Codes Descriptive Flexfields
The federal business event type codes descriptive flexfields resource manages the descriptive flexfield references for a business event type code.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/{BusinessEventTypeId}/child/fedBusinessEventTypeCodeDFF
Delete
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/{BusinessEventTypeId}/child/fedBusinessEventTypeCodeDFF/{BusinessEventTypeId2}
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/{BusinessEventTypeId}/child/fedBusinessEventTypeCodeDFF/{BusinessEventTypeId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/{BusinessEventTypeId}/child/fedBusinessEventTypeCodeDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodes/{BusinessEventTypeId}/child/fedBusinessEventTypeCodeDFF/{BusinessEventTypeId2}
Federal Fund Attributes
The federal fund attributes resource is used to query, create and update fund attributes.
Create fund attributes
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedFundAttributes
Delete a fund attribute
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedFundAttributes/{FundValueId}
Get a fund attribute
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedFundAttributes/{FundValueId}
Get all fund attributes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedFundAttributes
Update a fund attribute
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedFundAttributes/{FundValueId}
Federal Fund Attributes/Federal Fund Attributes Descriptive Flexfields
The federal fund attributes descriptive flexfields resource manages the descriptive flexfield references for a fund attribute.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedFundAttributes/{FundValueId}/child/fedFundAttributeDFF
Delete
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedFundAttributes/{FundValueId}/child/fedFundAttributeDFF/{FundValueId2}
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedFundAttributes/{FundValueId}/child/fedFundAttributeDFF/{FundValueId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedFundAttributes/{FundValueId}/child/fedFundAttributeDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedFundAttributes/{FundValueId}/child/fedFundAttributeDFF/{FundValueId2}
Federal Groups
The federal groups resource is used to query, create, and update federal groups.
Create a federal group
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedGroups
Delete a federal group
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedGroups/{LedgerGroupId}
Get a federal group
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedGroups/{LedgerGroupId}
Get all federal groups
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedGroups
Update a federal group
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedGroups/{LedgerGroupId}
Federal Groups/Federal Group Budget Levels
The group budget levels resource is used to query, create, and update group budget levels.
Create federal group budget levels
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedGroups/{LedgerGroupId}/child/fedGroupBudgetLevels
Delete a federal group budget level
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedGroups/{LedgerGroupId}/child/fedGroupBudgetLevels/{GroupBeLevelId}
Get a federal group budget level
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedGroups/{LedgerGroupId}/child/fedGroupBudgetLevels/{GroupBeLevelId}
Get all federal group budget levels
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedGroups/{LedgerGroupId}/child/fedGroupBudgetLevels
Update a federal group budget level
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedGroups/{LedgerGroupId}/child/fedGroupBudgetLevels/{GroupBeLevelId}
Federal Ledger Options
The ledger options resource is used to query, create, and update ledger options.
Create a ledger option
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions
Delete a ledger option
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}
Get a ledger option
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}
Get all ledger options
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions
Update a ledger option
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}
Federal Ledger Options/Federal Ledger Option Budget Levels
The ledger option budget levels resource is used to query, create, and update ledger option budget levels.
Get a ledger option budget level
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}/child/fedLedgerOptionBudgetLevels/{BudgetLevelId}
Get all ledger option budget levels
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}/child/fedLedgerOptionBudgetLevels
Federal Ledger Options/Federal Ledger Options Descriptive Flexfields
The ledger options descriptive flexfields resource manages the descriptive flexfield references for a ledger option.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}/child/fedLedgerOptionDFF
Delete
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}/child/fedLedgerOptionDFF/{LevelOptionId2}
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}/child/fedLedgerOptionDFF/{LevelOptionId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}/child/fedLedgerOptionDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}/child/fedLedgerOptionDFF/{LevelOptionId2}
Federal Payment Format Mappings
The federal payment format mappings resource is used to query, create, and update payment format mappings.
Create payment format mappings
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings
Delete a payment format mapping
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/{FormatMappingId}
Get a payment format mapping
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/{FormatMappingId}
Get all payment format mappings
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings
Update a payment format mapping
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/{FormatMappingId}
Federal Payment Format Mappings/Federal Payment Format Mappings Descriptive Flexfields
The federal payment format mappings descriptive flexfields resource manages the descriptive flexfield references for a payment format mapping.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/{FormatMappingId}/child/fedPaymentFormatMappingDFF
Delete
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/{FormatMappingId}/child/fedPaymentFormatMappingDFF/{FormatMappingId2}
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/{FormatMappingId}/child/fedPaymentFormatMappingDFF/{FormatMappingId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/{FormatMappingId}/child/fedPaymentFormatMappingDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedPaymentFormatMappings/{FormatMappingId}/child/fedPaymentFormatMappingDFF/{FormatMappingId2}
Federal Setup Options
The federal setup options resource is used to query, create, and update setup options.
Create setup options
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedSetupOptions
Delete a setup option
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}
Get a setup option
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}
Get all setup options
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedSetupOptions
Update a setup option
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}
Federal Setup Options/Federal Setup Options Descriptive Flexfields
The federal setup options descriptive flexfields resource manages the descriptive flexfield references for a federal setup option.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}/child/fedSetupOptionDFF
Delete
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}/child/fedSetupOptionDFF/{ConfigOptionId2}
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}/child/fedSetupOptionDFF/{ConfigOptionId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}/child/fedSetupOptionDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedSetupOptions/{ConfigOptionId}/child/fedSetupOptionDFF/{ConfigOptionId2}
Federal Treasury Account Symbols
The federal treasury account symbols resource is used to query, create and update treasury account symbols.
Create treasury account symbols
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols
Delete a treasury account symbol
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}
Get a treasury account symbol
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}
Get all treasury account symbols
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols
Update a treasury account symbol
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}
Federal Treasury Account Symbols/Federal Treasury Account Symbols Business Event Type Codes
The federal treasury account symbols business event type codes resource manages the business event type code references, or BETC references, for a treasury account symbol, or TAS.
Create treasury account symbols business event type codes
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes
Delete a treasury account symbol business event type code
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes/{TasBetcMapId}
Get a treasury account symbol business event type code
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes/{TasBetcMapId}
Get all treasury account symbols business event type codes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes
Update a treasury account symbol business event type code
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes/{TasBetcMapId}
Federal Treasury Account Symbols/Federal Treasury Account Symbols Business Event Type Codes/Federal Treasury Account Symbols Business Event Type Codes Descriptive Flexfields
The federal treasury account symbols business event type code descriptive flexfields resource manages the descriptive flexfield references for a treasury account symbols business event type code, or TAS BETC.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes/{TasBetcMapId}/child/fedTASBusinessEventTypeCodeDFF
Delete
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes/{TasBetcMapId}/child/fedTASBusinessEventTypeCodeDFF/{TasBetcMapId2}
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes/{TasBetcMapId}/child/fedTASBusinessEventTypeCodeDFF/{TasBetcMapId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes/{TasBetcMapId}/child/fedTASBusinessEventTypeCodeDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTASBusinessEventTypeCodes/{TasBetcMapId}/child/fedTASBusinessEventTypeCodeDFF/{TasBetcMapId2}
Federal Treasury Account Symbols/Federal Treasury Account Symbols Descriptive Flexfields
The federal treasury account symbols descriptive flexfields resource manages the descriptive flexfield references for a treasury account symbol, or TAS.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTreasuryAccountSymbolDFF
Delete
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTreasuryAccountSymbolDFF/{TreasuryAccountSymbolId2}
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTreasuryAccountSymbolDFF/{TreasuryAccountSymbolId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTreasuryAccountSymbolDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbols/{TreasuryAccountSymbolId}/child/fedTreasuryAccountSymbolDFF/{TreasuryAccountSymbolId2}
Federal Treasury Confirmation Payments
The treasury confirmation payments resource is used to query treasury confirmation payments.
Get a treasury confirmation payment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationPayments/{CheckId}
Get all treasury confirmation payments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationPayments
Federal Treasury Confirmation Schedules
The federal treasury confirmation schedules resource is used to query treasury confirmation schedules.
Confirm a federal treasury confirmation schedule
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/action/confirm
Delete a federal treasury confirmation schedule
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}
Get a federal treasury confirmation schedule
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}
Get all federal treasury confirmation schedules
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules
Reverse a federal treasury confirmation schedule
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/action/backOut
Update a federal treasury confirmation schedule
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}
Federal Treasury Confirmation Schedules/Federal Treasury Check Ranges
The federal treasury check ranges resource is used to query treasury check ranges.
Create a federal treasury check range
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}/child/fedTreasuryCheckRanges
Delete a federal treasury check range
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}/child/fedTreasuryCheckRanges/{CheckRangeId}
Get a federal treasury check range
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}/child/fedTreasuryCheckRanges/{CheckRangeId}
Get all federal treasury check ranges
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}/child/fedTreasuryCheckRanges
Update a federal treasury check range
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryConfirmationSchedules/{TreasuryConfirmationId}/child/fedTreasuryCheckRanges/{CheckRangeId}
Federal Treasury Offset Amounts
The treasury offset amounts resource is used to query, create, and update treasury offset amounts.
Create a treasury offset amount
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryOffsetAmounts
Delete a treasury offset amount
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryOffsetAmounts/{OffsetId}
Get a treasury offset amount
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryOffsetAmounts/{OffsetId}
Get all treasury offset amounts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryOffsetAmounts
Update a treasury offset amount
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryOffsetAmounts/{OffsetId}
Federal USSGL Accounts
The USSGL Accounts resource is used to set up USSGL accounts. You can query, create, and update USSGL accounts.
Create USSGL accounts
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts
Get a USSGL account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}
Get all USSGL accounts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts
Update a USSGL account
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}
Federal USSGL Accounts/Federal USSGL Accounts Descriptive Flexfields
The federal USSGL accounts descriptive flexfields resource manages details about the descriptive flexfield references for a USSGL account.
Create a federal USSGL account descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}/child/fedUSSGLAccountDFF
Delete a USSGL descriptive flexfield
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}/child/fedUSSGLAccountDFF/{UssglAccountId}
Get a federal USSGL account descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}/child/fedUSSGLAccountDFF/{UssglAccountId}
Get all federal USSGL account descriptive flexfields
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}/child/fedUSSGLAccountDFF
Update a federal USSGL account descriptive flexfield
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}/child/fedUSSGLAccountDFF/{UssglAccountId}
Income Tax Types
The payables income tax types resource is used to manage details about the 1099-MISC types that can be assigned to a supplier for 1099 tax reporting.
Get all income tax types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesIncomeTaxTypes
Get an income tax type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesIncomeTaxTypes/{incomeTaxType}
Instrument Assignments
The instrument assignment resource is used to view, create, and modify a payment instrument assignment.
Create a payment instrument assignment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/instrumentAssignments
Get a payment instrument assignment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/instrumentAssignments/{PaymentInstrumentAssignmentId}
Get all payment instrument assignments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/instrumentAssignments
Update a payment instrument assignment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/instrumentAssignments/{PaymentInstrumentAssignmentId}
Interim Payables Documents
The interim payables documents resource is used to view, create, and modify an interim payables document for validation and payment processing.
Create an interim payables document
Method: post
Path: /fscmRestApi/resources/11.13.18.05/interimDocumentsPayables
Delete an interim payables document
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/interimDocumentsPayables/{DocumentPayableId}
Get all interim payables documents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/interimDocumentsPayables
Get an interim payables document
Method: get
Path: /fscmRestApi/resources/11.13.18.05/interimDocumentsPayables/{DocumentPayableId}
Update an interim payables document
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/interimDocumentsPayables/{DocumentPayableId}
Invoice Approvals and Notifications History
The payables invoice approvals and notifications history resource is used to view invoice approvals and holds resolution related actions and notifications history information.
Get all invoice approvals and notifications history
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoiceApprovalsAndNotificationsHistory
Get an invoice approvals and notifications history
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoiceApprovalsAndNotificationsHistory/{ApprovalHistoryId}
Invoice Holds
The payables invoice holds resource is used to manage details about the holds placed and released on invoices. An invoice hold represents a hold that is placed on an invoice so that the invoice cannot be paid until the hold is released.
Create an invoice hold
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoiceHolds
Get all holds
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoiceHolds
Get an invoice hold
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoiceHolds/{HoldId}
Update an invoice hold
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoiceHolds/{HoldId}
Invoice Holds/Invoice Holds Descriptive Flexfields
The invoice holds descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice hold.
Create a descriptive flexfield for an invoice hold
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoiceHolds/{HoldId}/child/invoiceHoldDff
Get descriptive flexfields for an invoice hold
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoiceHolds/{HoldId}/child/invoiceHoldDff
Get descriptive flexfields for an invoice hold
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoiceHolds/{HoldId}/child/invoiceHoldDff/{HoldId2}
Update descriptive flexfields for an invoice hold
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoiceHolds/{HoldId}/child/invoiceHoldDff/{HoldId2}
Invoice Tolerances
The invoice tolerances resource is used to manage the details for the tolerance levels that are applied to invoices. Tolerances are used when matching to a purchase order or receipt and the appropriate invoice variance is created.
Get a payables invoice tolerance
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesInvoiceTolerances/{toleranceId}
Get all payables invoice tolerances
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesInvoiceTolerances
Invoices
The payables invoices resource is used to manage details about supplier invoices, that includes header, lines, distributions, installments, descriptive flexfields, global descriptive flexfields, and attachments. Note: You can only update certain attributes and the update applies only to those attributes. Related fields don't automatically get populated. In summary, the cascade defaulting doesn't automatically happen and you must review and update the dependent attributes. For example, when you update the invoice date in the Create or Edit Invoice pages, related fields, such as the terms date or due date, may be autopopulated based on the invoice date you enter. Using REST API, the invoice date is updated, but the related fields aren't autopopulated. Before updating a key attribute, consider the impact on the related attributes.
Apply prepayments to an invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/action/applyPrepayments
Calculate tax for the invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/action/calculateTax
Cancel an invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/action/cancelInvoice
Cancel an invoice line
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/action/cancelLine
Create an invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices
Delete an invoice
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}
Generate distributions for the invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/action/generateDistributions
Get all invoices
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices
Get an invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}
Reverse distributions for an Invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/action/reverseDistributions
Unapply a prepayment from an invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/action/unapplyPrepayments
Update an invoice
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}
Validate an invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/action/validateInvoice
Invoices/Applied Prepayments
The applied prepayments resource is used to view the prepayments that are applied to an invoice.
Get all applied prepayments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/appliedPrepayments
Get an applied prepayment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/appliedPrepayments/{appliedPrepaymentsUniqID}
Invoices/Attachments
The attachments resource for a payables invoice is used to manage attachments that the user has attached to the invoice header.
Create an attachment for an invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/attachments
Delete an attachment for an invoice
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/attachments/{attachmentsUniqID}
Get all attachments for an invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/attachments
Get an attachment for an invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/attachments/{attachmentsUniqID}
Invoices/Attachments/Large Object (LOB) Attributes - File Contents
The contents of the attachment.
Delete a File Contents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Invoices/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Invoices/Available Prepayments
The available prepayments resource is used to view the available prepayment that can be applied to invoices.
Get all available prepayments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/availablePrepayments
Get an available prepayment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/availablePrepayments/{availablePrepaymentsUniqID}
Invoices/Invoice Installments
The payables invoice installments resource is used to manage details about the payment due dates, amounts, and other payment information. An invoice can have one or more installments.
Create an invoice installment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments
Delete an invoice installment
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}
Get all installments for an invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments
Get an invoice installment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}
Update an invoice installment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}
Invoices/Invoice Installments/Invoice Installments Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice installment.
Create a descriptive flexfield for an invoice installment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentDff
Get all descriptive flexfields for an invoice installment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentDff
Get descriptive flexfields for an invoice installment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentDff/{invoiceInstallmentDffUniqID}
Update descriptive flexfields for an invoice installment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentDff/{invoiceInstallmentDffUniqID}
Invoices/Invoice Installments/Invoice Installments Global Descriptive Flexfields
The payables invoice installments descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice installment.
Create a global descriptive flexfield for an invoice installment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentGdf
Get all global descriptive flexfields for an invoice installment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentGdf
Get global descriptive flexfields for an invoice installment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentGdf/{invoiceInstallmentGdfUniqID}
Update global descriptive flexfields for an invoice installment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceInstallments/{invoiceInstallmentsUniqID}/child/invoiceInstallmentGdf/{invoiceInstallmentGdfUniqID}
Invoices/Invoice Lines
The payables invoice lines resource is used to manage details about goods and services, which includes freight, and miscellaneous charges that can be allocated to item lines. It also captures details necessary for integration with applications, such as Oracle Fusion Assets.
Create an invoice line
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines
Delete an invoice line
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}
Get all lines for an invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines
Get an invoice line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}
Update an invoice line
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}
Invoices/Invoice Lines/Invoice Distributions
The payables invoice distributions resource is used to manage details that are used to create accounting entries, and includes information, such as accounting date, distribution combinations, and the details necessary for integration with applications, such as Oracle Fusion Assets.
Create an invoice distribution
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions
Delete an invoice distribution
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}
Get all distributions for an invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions
Get an invoice distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}
Update an invoice distribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}
Invoices/Invoice Lines/Invoice Distributions/Invoice Distributions Descriptive Flexfields
The payables invoice distributions descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice distribution.
Create a descriptive flexfield for an invoice distribution
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionDff
Get all descriptive flexfields for an invoice distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionDff
Get descriptive flexfields for an invoice distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionDff/{InvoiceDistributionId2}
Update descriptive flexfields for an invoice distribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionDff/{InvoiceDistributionId2}
Invoices/Invoice Lines/Invoice Distributions/Invoice Distributions Global Descriptive Flexfields
The payables invoice distributions global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice distribution.
Create a global descriptive flexfield for an invoice distribution
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionGdf
Get all global descriptive flexfields for an invoice distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionGdf
Get global descriptive flexfields for an invoice distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionGdf/{InvoiceDistributionId3}
Update global descriptive flexfields for an invoice distribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionGdf/{InvoiceDistributionId3}
Invoices/Invoice Lines/Invoice Distributions/Invoice Distributions Project Descriptive Flexfields
The payables invoice distribution project descriptive flexfields resource is used to manage details about the project information for an invoice distribution.
Create a project-related descriptive flexfield for an invoice distribution
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionProjectDff
Get a project-related descriptive flexfield for an invoice distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionProjectDff/{InvoiceDistributionId4}
Get all project-related descriptive flexfields for an invoice distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionProjectDff
Update a project-related descriptive flexfield for an invoice distribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceDistributions/{InvoiceDistributionId}/child/invoiceDistributionProjectDff/{InvoiceDistributionId4}
Invoices/Invoice Lines/Invoice Lines Descriptive Flexfields
The payables invoice lines descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice line.
Create a descriptive flexfield for an invoice line
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineDff
Get all descriptive flexfields for an invoice line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineDff
Get descriptive flexfields for an invoice line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineDff/{invoiceLineDffUniqID}
Update descriptive flexfields for an invoice line
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineDff/{invoiceLineDffUniqID}
Invoices/Invoice Lines/Invoice Lines Global Descriptive Flexfields
The payables invoice lines descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice line.
Create a global descriptive flexfield for an invoice line
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineGdf
Get all global descriptive flexfields for an invoice line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineGdf
Get global descriptive flexfields for an invoice line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineGdf/{invoiceLineGdfUniqID}
Update global descriptive flexfields for an invoice line
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineGdf/{invoiceLineGdfUniqID}
Invoices/Invoice Lines/Invoice Lines Project Descriptive Flexfields
The payables invoice line project descriptive flexfields resource is used to manage details about the project information for an invoice line.
Create a project-related descriptive flexfield for an invoice line
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineProjectDff
Get a project-related descriptive flexfield for an invoice line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineProjectDff/{invoiceLineProjectDffUniqID}
Get all project-related descriptive flexfields for an invoice line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineProjectDff
Update a project-related descriptive flexfield for an invoice line
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceLines/{invoiceLinesUniqID}/child/invoiceLineProjectDff/{invoiceLineProjectDffUniqID}
Invoices/Invoices Descriptive Flexfields
The payables invoices descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice.
Create a descriptive flexfield for an invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceDff
Get all descriptive flexfields for an invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceDff
Get descriptive flexfields for an invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceDff/{InvoiceId}
Update descriptive flexfields for an invoice
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceDff/{InvoiceId}
Invoices/Invoices Global Descriptive Flexfields
The payables invoices global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for an invoice.
Create a global descriptive flexfield for an invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceGdf
Get all global descriptive flexfields for an invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceGdf
Get global descriptive flexfields for an invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceGdf/{InvoiceId}
Update global descriptive flexfields for an invoice
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/invoices/{invoicesUniqID}/child/invoiceGdf/{InvoiceId}
Joint Venture Account Sets
The joint venture account sets resource is used to view, create, update, or delete account sets that are used to identify accounts on financial transactions to be processed by Joint Venture Management.
Create a joint venture account set
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets
Delete a joint venture account set
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}
Get a joint venture account set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}
Get all joint venture account sets
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets
Update a joint venture account set
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}
Joint Venture Account Sets/Account Set Descriptive Flexfields
The account set descriptive flexfields resource is used to manage details about the descriptive flexfield references for an account set.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/accountSetDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/accountSetDFF/{AccountSetId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/accountSetDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/accountSetDFF/{AccountSetId}
Joint Venture Account Sets/Filter Sets
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set.
Create a filter set
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets
Delete a filter set
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}
Get a filter set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}
Get all filter sets
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets
Update a filter set
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}
Joint Venture Account Sets/Filter Sets/Filter Set Descriptive Flexfields
The filter set descriptive flexfields resource is used to manage details about the descriptive flexfield references for a filter set.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filterSetDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filterSetDFF/{AccountFilterSetId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filterSetDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filterSetDFF/{AccountFilterSetId}
Joint Venture Account Sets/Filter Sets/Filters
The filters resource is used to view, create, update, or delete filters. These filters are used to identify accounts on financial transactions to be processed by Joint Venture Management.
Create a filter
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters
Delete a filter
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters/{filterId}
Get a filter
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters/{filterId}
Get all filters
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters
Update a filter
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters/{filterId}
Joint Venture Account Sets/Filter Sets/Filters/Filter Descriptive Flexfields
The filter descriptive flexfields resource is used to manage details about the descriptive flexfield references for a filter.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters/{filterId}/child/filterDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters/{filterId}/child/filterDFF/{AccountFilterId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters/{filterId}/child/filterDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSets/{filterSetId}/child/filters/{filterId}/child/filterDFF/{AccountFilterId}
Joint Venture Accounting Headers
The joint venture accounting headers resource is used to view the joint venture distributions associated with an internal transfer.
Delete a joint venture accounting header
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}
Get a joint venture accounting header
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}
Get all joint venture accounting headers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders
Joint Venture Accounting Headers/Accounting Header Descriptive Flexfields
The accounting header descriptive flexfields resource is used to manage details about the descriptive flexfield references for an accounting header.
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}/child/accountingHeaderDFF/{AccountingHeaderId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}/child/accountingHeaderDFF
Joint Venture Accounting Headers/Joint Venture Distributions
The distributions resource is used to view joint venture distributions.
Get a joint venture distribution associated with the accounting header
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}/child/distributions/{distributionId}
Get all joint venture distributions associated with the accounting header
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}/child/distributions
Joint Venture Accounting Headers/Joint Venture Operational Measures
The joint venture operational measures resource is used to view, create, update, or delete the operational measures associated with a joint venture.
Get a joint venture operational measure
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}/child/operationalMeasures/{operationalMeasureId}
Get all joint venture operational measures
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}/child/operationalMeasures
Reverse an operational measure
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}/child/operationalMeasures/{operationalMeasureId}/action/reverseOperationalMeasure
Joint Venture Approval Counts
The joint venture approval counts resource is used to view an aggregated count of joint ventures grouped by approved date.
Get a count of joint ventures with the specified approved date
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureApprovalCounts/{approvedDate}
Get all counts for joint ventures with any approved dates
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureApprovalCounts
Joint Venture Assignment Rules
The joint venture assignment rules resource is used to view, create, update, or delete ownership definition assignment rules for assigning an ownership definition or direct billed stakeholder to joint venture transactions.
Create an assignment rule
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules
Delete an assignment rule
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}
Get all assignment rules
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules
Get an assignment rule
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}
Update an assignment rule
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}
Joint Venture Assignment Rules/Assignment Rule Descriptive Flexfields
The assignment rule descriptive flexfields resource is used to manage details about the descriptive flexfield references for an assignment rule.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/assignmentRuleDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/assignmentRuleDFF/{AssignmentRuleId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/assignmentRuleDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/assignmentRuleDFF/{AssignmentRuleId}
Joint Venture Assignment Rules/Project Value Sets
The project value sets resource is used to view, create, update, or delete project value sets for an assignment rule.
Create a project value set
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets
Delete a project value set
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets/{projectValueSetId}
Get a project value set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets/{projectValueSetId}
Get all project value sets for an assignment rule
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets
Update a project value set
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets/{projectValueSetId}
Joint Venture Assignment Rules/Project Value Sets/Project Value Set Descriptive Flexfields
The project value set descriptive flexfields resource is used to manage details about the descriptive flexfield references for a project value set.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets/{projectValueSetId}/child/projectValueSetDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets/{projectValueSetId}/child/projectValueSetDFF/{ProjectValueSetId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets/{projectValueSetId}/child/projectValueSetDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureAssignmentRules/{assignmentRuleId}/child/projectValueSets/{projectValueSetId}/child/projectValueSetDFF/{ProjectValueSetId}
Joint Venture General Ledger Distribution Totals
The joint venture distribution totals resource is used to view aggregated totals of distributed amounts from general ledger for a joint venture grouped by distribution status.
Get all distribution totals for a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributionTotals
Get distribution totals for a joint venture with the specified distribution status
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributionTotals/{jointVentureGLDistributionTotalsUniqID}
Joint Venture General Ledger Distributions
The joint venture distributions resource is used to view, update, or delete joint venture distributions originating from the general ledger.
Delete a joint venture general ledger distribution
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}
Get a joint venture general ledger distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}
Get all joint venture general ledger distributions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions
Update a joint venture general ledger distribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}
Joint Venture General Ledger Distributions/Account Key Flexfields
The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses.
Get account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}/child/Account/{_CODE_COMBINATION_ID}
Get all account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}/child/Account
Joint Venture General Ledger Distributions/Joint Venture Distribution Descriptive Flexfields
The joint venture distribution descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture distribution.
Create the set of descriptive flexfields for a joint venture distribution
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}/child/distributionDFF
Get all descriptive flexfields for a joint venture distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}/child/distributionDFF
Get descriptive flexfields for a joint venture distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}/child/distributionDFF/{DistributionId}
Update descriptive flexfields for a joint venture distribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}/child/distributionDFF/{DistributionId}
Joint Venture General Ledger Distributions/Offset Account Key Flexfields
The code identifying the subledger accounting offset account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses.
Get account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}/child/partnerOffsetAccount/{_CODE_COMBINATION_ID}
Get all account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}/child/partnerOffsetAccount
Joint Venture General Ledger Transaction Totals
The joint venture transaction totals resource is used to view aggregated totals of general ledger amounts for a joint venture grouped by transaction status.
Get all transaction totals for a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactionTotals
Get transaction totals for a joint venture with the specified transaction status
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactionTotals/{jointVentureGLTransactionTotalsUniqID}
Joint Venture General Ledger Transactions
The joint venture transactions resource is used to view, update, or delete transactions replicated from the general ledger.
Clear ownership definition assignment values
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}/action/clearOwnershipAssignment
Delete a joint venture general ledger transaction
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}
Get a joint venture general ledger transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}
Get all joint venture general ledger transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions
Update a joint venture general ledger transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}
Joint Venture General Ledger Transactions/Account Key Flexfields
The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, expenses, and fund balances.
Get account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}/child/transactionAccount/{_CODE_COMBINATION_ID}
Get all account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}/child/transactionAccount
Joint Venture General Ledger Transactions/Joint Venture Transaction Changes
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions.
Get a joint venture transaction change
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}/child/transactionChanges/{transactionChangeId}
Get all joint venture transaction changes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}/child/transactionChanges
Joint Venture General Ledger Transactions/Joint Venture Transaction Descriptive Flexfields
The joint venture transaction descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture transaction.
Create the set of descriptive flexfields for a joint venture transaction
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}/child/transactionDFF
Get all descriptive flexfields for a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}/child/transactionDFF
Get descriptive flexfields for a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}/child/transactionDFF/{TransactionId}
Update descriptive flexfields for a joint venture transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}/child/transactionDFF/{TransactionId}
Joint Venture Invoicing Partners
The joint venture invoicing partners resource is used to view, create, update, or delete a joint venture invoicing partner. A joint venture invoicing partner is a participating entity in a joint venture.
Create a joint venture invoicing partner
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners
Delete a joint venture invoicing partner
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners/{invoicingPartnerId}
Get a joint venture invoicing partner
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners/{invoicingPartnerId}
Get all joint venture invoicing partners
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners
Update a joint venture invoicing partner
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners/{invoicingPartnerId}
Joint Venture Invoicing Partners/Invoicing Partner Descriptive Flexfields
The joint venture invoicing partner descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.
Create a set of descriptive flexfields for a joint venture
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners/{invoicingPartnerId}/child/invoicingPartnerDFF
Get all descriptive flexfields for a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners/{invoicingPartnerId}/child/invoicingPartnerDFF
Get descriptive flexfields for a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners/{invoicingPartnerId}/child/invoicingPartnerDFF/{InvoicingPartnerId}
Update a descriptive flexfield for a joint venture
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartners/{invoicingPartnerId}/child/invoicingPartnerDFF/{InvoicingPartnerId}
Joint Venture Operational Measure Types
The joint venture operational measure types resource is used to view, create, update, or delete operational measure types.
Create a joint venture operational measure type
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes
Delete a joint venture operational measure type
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/{measureTypeId}
Get a joint venture operational measure type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/{measureTypeId}
Get all joint venture operational measure types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes
Update a joint venture operational measure type
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/{measureTypeId}
Joint Venture Operational Measure Types/Measure Type Descriptive Flexfields
The measure type descriptive flexfields resource is used to manage details about the descriptive flexfield references for an operational measure type.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/{measureTypeId}/child/measureTypeDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/{measureTypeId}/child/measureTypeDFF/{MeasureTypeId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/{measureTypeId}/child/measureTypeDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/{measureTypeId}/child/measureTypeDFF/{MeasureTypeId}
Joint Venture Operational Measures
The joint venture operational measures resource is used to view, create, update, or delete the operational measures associated with a joint venture.
Create a joint venture operational measure
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures
Delete a joint venture operational measure
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}
Get a joint venture operational measure
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}
Get all joint venture operational measures
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures
Reverse an operational measure
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}/action/reverseOperationalMeasure
Update a joint venture operational measure
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}
Joint Venture Operational Measures/Operational Measure Descriptive Flexfields
The operational measure descriptive flexfields resource is used to manage details about the descriptive flexfield references for an operational measure.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}/child/operationalMeasureDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}/child/operationalMeasureDFF/{OperationalMeasureId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}/child/operationalMeasureDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}/child/operationalMeasureDFF/{OperationalMeasureId}
Joint Venture Operational States
The joint venture operational states resource is used to view, create, update, or delete operational states.
Create a joint venture operational state
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates
Delete a joint venture operational state
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}
Get a joint venture operational state
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}
Get all joint venture operational states
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates
Update a joint venture operational state
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}
Joint Venture Operational States/Operational State Descriptive Flexfields
The operational state descriptive flexfields resource is used to manage details about the descriptive flexfield references for an operational state.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}/child/operationalStateDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}/child/operationalStateDFF/{OperationalStateId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}/child/operationalStateDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}/child/operationalStateDFF/{OperationalStateId}
Joint Venture Options
The joint venture options resource is used to view, create, or update the set of functional options for joint venture.
Create joint venture options
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOptions
Get joint venture options
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOptions
Get joint venture options
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOptions/{applicationId}
Update joint venture options
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOptions/{applicationId}
Joint Venture Options/Joint Venture Options Descriptive Flexfields
The joint venture options descriptive flexfields resource is used to manage details about the descriptive flexfield references for joint venture options.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOptions/{applicationId}/child/optionsDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOptions/{applicationId}/child/optionsDFF/{ApplicationId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOptions/{applicationId}/child/optionsDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOptions/{applicationId}/child/optionsDFF/{ApplicationId}
Joint Venture Overhead Distributions
The joint venture overhead distributions resource is used to view, update, or delete overhead distributions.
Delete an overhead distribution
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadDistributions/{distributionId}
Get all overhead distributions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadDistributions
Get an overhead distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadDistributions/{distributionId}
Update an overhead distribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadDistributions/{distributionId}
Joint Venture Overhead Distributions/Joint Venture Distribution Descriptive Flexfields
The joint venture distribution descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture distribution.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadDistributions/{distributionId}/child/distributionDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadDistributions/{distributionId}/child/distributionDFF/{DistributionId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadDistributions/{distributionId}/child/distributionDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadDistributions/{distributionId}/child/distributionDFF/{DistributionId}
Joint Venture Overhead Methods
The joint venture overhead methods resource is used to view, create, update, or delete overhead methods.
Create a joint venture overhead method
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods
Delete a joint venture overhead method
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}
Get a joint venture overhead method
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}
Get all joint venture overhead methods
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods
Update a joint venture overhead method
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}
Joint Venture Overhead Methods/Overhead Measure Types
The overhead measure types resource is used to view, create, or delete overhead measure types.
Create an overhead measure type
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/measureTypes
Delete an overhead measure type
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/measureTypes/{overheadMeasureTypeId}
Get all overhead measure types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/measureTypes
Get an overhead measure type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/measureTypes/{overheadMeasureTypeId}
Joint Venture Overhead Methods/Overhead Method Descriptive Flexfields
The overhead method descriptive flexfields resource is used to manage details about the descriptive flexfield references for an overhead method.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/overheadMethodDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/overheadMethodDFF/{OverheadMethodId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/overheadMethodDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/overheadMethodDFF/{OverheadMethodId}
Joint Venture Overhead Methods/Sliding Scale Thresholds
The sliding scale threshold resource is used to view, create, update, or delete sliding scale thresholds for an overhead method.
Create a sliding scale threshold
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds
Delete a sliding scale threshold
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds/{thresholdId}
Get a sliding scale threshold
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds/{thresholdId}
Get all sliding scale thresholds for an overhead method
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds
Update a sliding scale threshold
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds/{thresholdId}
Joint Venture Overhead Methods/Sliding Scale Thresholds/Sliding Scale Threshold Descriptive Flexfields
The sliding scale threshold descriptive flexfields resource is used to manage details about the descriptive flexfield references for a sliding scale threshold.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds/{thresholdId}/child/thresholdDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds/{thresholdId}/child/thresholdDFF/{ThresholdId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds/{thresholdId}/child/thresholdDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadMethods/{overheadMethodId}/child/slidingScaleThresholds/{thresholdId}/child/thresholdDFF/{ThresholdId}
Joint Venture Overhead Transactions
The joint venture overhead transactions resource is used to view, update, or delete overhead transactions.
Delete an overhead transaction
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/{transactionId}
Get all overhead transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions
Get an overhead transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/{transactionId}
Update an overhead transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/{transactionId}
Joint Venture Overhead Transactions/Joint Venture Transaction Changes
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions.
Get a joint venture transaction change
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/{transactionId}/child/transactionChanges/{transactionChangeId}
Get all joint venture transaction changes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/{transactionId}/child/transactionChanges
Joint Venture Overhead Transactions/Joint Venture Transaction Descriptive Flexfields
The joint venture transaction descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture transaction.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/{transactionId}/child/transactionDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/{transactionId}/child/transactionDFF/{TransactionId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/{transactionId}/child/transactionDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/{transactionId}/child/transactionDFF/{TransactionId}
Joint Venture Partner Contribution Requests
The joint venture contribution requests resource is used to view, create, update, or delete joint venture partner contribution requests.
Create a joint venture partner contribution request
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests
Delete a joint venture partner contribution request
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/{contributionRequestId}
Get a joint venture partner contribution request
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/{contributionRequestId}
Get all joint venture partner contribution requests
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests
Update a joint venture partner contribution request
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/{contributionRequestId}
Joint Venture Partner Contributions
The joint venture contributions resource is used to view, create, update, or delete joint venture partner contributions.
Create a joint venture partner contribution
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions
Delete a joint venture partner contribution
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}
Get a joint venture partner contribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}
Get all joint venture partner contributions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions
Update a joint venture partner contribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}
Joint Venture Partner Contributions/Attachments
The attachments resource is used to view, create, and update attachments.
Create an attachment.
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/attachments
Delete an attachment.
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/attachments/{attachmentsUniqID}
Get all attachments.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/attachments
Get an attachment.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/attachments/{attachmentsUniqID}
Update an attachment.
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/attachments/{attachmentsUniqID}
Joint Venture Partner Contributions/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Joint Venture Partner Contributions/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Joint Venture Partner Contributions/Partner Contribution Descriptive Flexfields
The contribution descriptive flexfields resource is used to manage details about the descriptive flexfield references for a partner contribution.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionDFF/{ContributionId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionDFF/{ContributionId}
Joint Venture Partner Contributions/Partner Contribution References
The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.
Delete a transaction reference for a partner contribution
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionReferences/{contributionReferenceId}
Get a transaction reference for a joint venture partner contribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionReferences/{contributionReferenceId}
Get all transaction references for a joint venture partner contribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionReferences
Update a transaction reference for a partner contribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionReferences/{contributionReferenceId}
Joint Venture Source Transactions
The joint venture source transactions resource is used to view, update, or delete transactions created by Joint Venture Management.
Delete a joint venture source transaction
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/{transactionId}
Get a joint venture source transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/{transactionId}
Get all joint venture source transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions
Update a joint venture source transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/{transactionId}
Joint Venture Source Transactions/Source Transaction Descriptive Flexfields
The source transaction descriptive flexfields resource is used to manage details about the descriptive flexfield references for a source transaction.
Create
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/{transactionId}/child/sourceTransactionDFF
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/{transactionId}/child/sourceTransactionDFF/{TransactionId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/{transactionId}/child/sourceTransactionDFF
Update
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/{transactionId}/child/sourceTransactionDFF/{TransactionId}
Joint Venture Status Counts
The joint venture status counts resource is used to view an aggregated count of joint ventures grouped by status.
Get a count of joint ventures with the specified status
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureStatusCounts/{jointVentureStatusCountsUniqID}
Get all counts for joint ventures at every status
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureStatusCounts
Joint Venture Subledger Accounting Distribution Totals
The joint venture distribution totals resource is used to view aggregated totals of distributed amounts from subledger accounting for a joint venture grouped by distribution status.
Get all distribution totals for a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributionTotals
Get distribution totals for a joint venture with the specified distribution status
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributionTotals/{jointVentureSLADistributionTotalsUniqID}
Joint Venture Subledger Accounting Transaction Totals
The joint venture transaction totals resource is used to view aggregated totals of subledger accounting amounts for a joint venture grouped by transaction status.
Get all transaction totals for a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactionTotals
Get transaction totals for a joint venture with the specified transaction status
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactionTotals/{jointVentureSLATransactionTotalsUniqID}
Joint Venture Subledger Distributions
The joint venture distributions resource is used to view, update, or delete joint venture distributions originating from subledger accounting.
Delete a joint venture subledger distribution
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}
Get a joint venture subledger distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}
Get all joint venture subledger distributions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions
Update a joint venture subledger distribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}
Joint Venture Subledger Distributions/Account Key Flexfields
The code identifying the subledger accounting account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses.
Get account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}/child/Account/{_CODE_COMBINATION_ID}
Get all account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}/child/Account
Joint Venture Subledger Distributions/Joint Venture Distribution Descriptive Flexfields
The joint venture distribution descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture distribution.
Create the set of descriptive flexfields for a joint venture distribution
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}/child/distributionDFF
Get all descriptive flexfields for a joint venture distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}/child/distributionDFF
Get descriptive flexfields for a joint venture distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}/child/distributionDFF/{DistributionId}
Update descriptive flexfields for a joint venture distribution
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}/child/distributionDFF/{DistributionId}
Joint Venture Subledger Distributions/Offset Account Key Flexfields
The code identifying the subledger accounting offset account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses.
Get account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}/child/partnerOffsetAccount/{_CODE_COMBINATION_ID}
Get all account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADistributions/{distributionId}/child/partnerOffsetAccount
Joint Venture Subledger Transactions
The joint venture transactions resource is used to view, update, or delete transactions replicated from subledger accounting.
Clear ownership definition assignment values
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}/action/clearOwnershipAssignment
Delete a joint venture subledger transaction
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}
Get a joint venture subledger transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}
Get all joint venture subledger transactions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions
Update a joint venture subledger transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}
Joint Venture Subledger Transactions/Account Key Flexfields
The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, expenses, and fund balances.
Get account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}/child/transactionAccount/{_CODE_COMBINATION_ID}
Get all account key flexfields for a journal line associated with a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}/child/transactionAccount
Joint Venture Subledger Transactions/Joint Venture Transaction Changes
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions.
Get a joint venture transaction change
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}/child/transactionChanges/{transactionChangeId}
Get all joint venture transaction changes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}/child/transactionChanges
Joint Venture Subledger Transactions/Joint Venture Transaction Descriptive Flexfields
The joint venture transaction descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture transaction.
Create the set of descriptive flexfields for a joint venture transaction
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}/child/transactionDFF
Get all descriptive flexfields for a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}/child/transactionDFF
Get descriptive flexfields for a joint venture transaction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}/child/transactionDFF/{TransactionId}
Update descriptive flexfields for a joint venture transaction
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{transactionId}/child/transactionDFF/{TransactionId}
Joint Ventures
The joint ventures resource is used to view, create, update, or delete a joint venture. A joint venture is an agreement between two or more parties to share assets, resources, costs, and revenue.
Create a joint venture
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures
Delete a joint venture
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}
Get a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}
Get all joint ventures
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures
Update a joint venture
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}
Joint Ventures/Attachments
The attachments resource is used to view, create, and update attachments.
Create an attachment.
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/attachments
Delete an attachment.
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/attachments/{attachmentsUniqID}
Get all attachments.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/attachments
Get an attachment.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/attachments/{attachmentsUniqID}
Update an attachment.
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/attachments/{attachmentsUniqID}
Joint Ventures/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Joint Ventures/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Joint Ventures/Cost Centers
The cost centers resource is used to view, create, or delete a cost center associated with a joint venture. The joint venture cost center is used as selection criteria for retrieving transactions from the General Ledger and Subledger Accounting.
Create a joint venture cost center
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters
Delete a joint venture cost center
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}
Get a joint venture cost center
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}
Get all cost centers associated with the joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters
Joint Ventures/Cost Centers/Cost Center Descriptive Flexfields
The cost center descriptive flexfields resource is used to manage details about the descriptive flexfield references for a cost center associated with a joint venture.
Create a descriptive flexfield for a cost center associated with a joint venture
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/costCenterDFF
Get all descriptive flexfields for a cost center associated with a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/costCenterDFF
Get descriptive flexfields for a cost center associated with a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/costCenterDFF/{CostCenterId}
Update a descriptive flexfield for a cost center associated with a joint venture
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/costCenterDFF/{CostCenterId}
Joint Ventures/Cost Centers/Distributable Value Sets
The distributable value sets resource is used to view, create, update, or delete a group of segment values for a chart of accounts instance. The group of segment values is used to identify code combinations of financial transactions to be distributed among joint venture stakeholders.
Create a distributable value set
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/distributableValueSets
Delete a distributable value set
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/distributableValueSets/{distributableValuesId}
Get a distributable value set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/distributableValueSets/{distributableValuesId}
Get all distributable value sets associated with a joint venture cost center
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/distributableValueSets
Update a distributable value set
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/distributableValueSets/{distributableValuesId}
Joint Ventures/Cost Centers/Distributable Value Sets/Distributable Value Set Descriptive Flexfields
The distributable value set descriptive flexfields resource is used to manage details about the descriptive flexfield references for a distributable value set.
Create the set of descriptive flexfields for a distributable value set
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/distributableValueSets/{distributableValuesId}/child/distributableValueSetDFF
Get all descriptive flexfields for a distributable value set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/distributableValueSets/{distributableValuesId}/child/distributableValueSetDFF
Get descriptive flexfields for a distributable value set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/distributableValueSets/{distributableValuesId}/child/distributableValueSetDFF/{DistributableValuesId}
Update descriptive flexfields for a distributable value set
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureCostCenters/{costCenterId}/child/distributableValueSets/{distributableValuesId}/child/distributableValueSetDFF/{DistributableValuesId}
Joint Ventures/Distributable Project Rules
The distributable project rules resource is used to view, create, update, or delete distributable project rules for a joint venture. The project rules are used to identify project-related transactions that are distributable for a joint venture.
Create a distributable project rule
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/distributableProjectRules
Delete a distributable project rule
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/distributableProjectRules/{distributableProjectRuleId}
Get a distributable project rule
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/distributableProjectRules/{distributableProjectRuleId}
Get all distributable project rules associated with a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/distributableProjectRules
Update a distributable project rule
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/distributableProjectRules/{distributableProjectRuleId}
Joint Ventures/Distributable Project Rules/Distributable Project Rule Descriptive Flexfields
The distributable project rule descriptive flexfields resource is used to manage details about the descriptive flexfield references for a distributable project rule associated with a joint venture.
Create the set of descriptive flexfields for a distributable project rule
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/distributableProjectRules/{distributableProjectRuleId}/child/distributableProjectDFF
Get all descriptive flexfields for a distributable project rule
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/distributableProjectRules/{distributableProjectRuleId}/child/distributableProjectDFF
Get descriptive flexfields for a distributable project rule
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/distributableProjectRules/{distributableProjectRuleId}/child/distributableProjectDFF/{DistributableProjectValueId}
Update descriptive flexfields for a distributable project rule
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/distributableProjectRules/{distributableProjectRuleId}/child/distributableProjectDFF/{DistributableProjectValueId}
Joint Ventures/Joint Venture Descriptive Flexfieds
The joint venture descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture.
Create a set of descriptive flexfields for a joint venture
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureDFF
Get all descriptive flexfields for a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureDFF
Get descriptive flexfields for a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureDFF/{JointVentureId}
Update a descriptive flexfield for a joint venture
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/jointVentureDFF/{JointVentureId}
Joint Ventures/Joint Venture Messages
The messages resource is used to view warning messages generated from the validation of a joint venture definition.
Get a joint venture message
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/messages/{errorCode}
Get all joint venture messages
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/messages
Joint Ventures/Ownership Definitions
The ownership definitions resource is used to view, create, update, or delete an ownership definition associated with a joint venture. Joint Venture Management uses the ownership definition to calculate the split of costs and revenue among the stakeholders or partners in a joint venture.
Create a set of ownership definitions for a joint venture
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions
Delete an ownership definition
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}
Get all ownership definitions associated with a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions
Get an ownership definition
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}
Update an ownership definition
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}
Joint Ventures/Ownership Definitions/Attachments
The attachments resource is used to view, create, and update attachments.
Create an attachment.
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/attachments
Delete an attachment.
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/attachments/{attachmentsUniqID}
Get all attachments.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/attachments
Get an attachment.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/attachments/{attachmentsUniqID}
Update an attachment.
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/attachments/{attachmentsUniqID}
Joint Ventures/Ownership Definitions/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Joint Ventures/Ownership Definitions/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Joint Ventures/Ownership Definitions/Ownership Definition Descriptive Flexfields
The ownership definition descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership definition associated with a joint venture.
Create a descriptive flexfield for an ownership definition associated with a joint venture
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipDefinitionDFF
Get all descriptive flexfields for an ownership definition associated with a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipDefinitionDFF
Get descriptive flexfields for an ownership definition associated with a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipDefinitionDFF/{OwnershipPercentageId}
Update a descriptive flexfield for an ownership definition associated with a joint venture
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipDefinitionDFF/{OwnershipPercentageId}
Joint Ventures/Ownership Definitions/Ownership Percentages
The ownership percentages resource is used to view, create, update, or delete each stakeholder's percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.
Create a set of ownership percentage for an ownership definition
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages
Delete an ownership percentage for a stakeholder
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages/{ownershipPercentageId}
Get all ownership percentages associated with an ownership definition
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages
Get an ownership percentage for a stakeholder
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages/{ownershipPercentageId}
Update an ownership percentage for a stakeholder
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages/{ownershipPercentageId}
Joint Ventures/Ownership Definitions/Ownership Percentages/Ownership Percentage Descriptive Flexfields
The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.
Create a descriptive flexfield for an ownership percentage associated with an ownership definition
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages/{ownershipPercentageId}/child/ownershipPercentageDFF
Get all descriptive flexfields for an ownership percentage associated with an ownership definition
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages/{ownershipPercentageId}/child/ownershipPercentageDFF
Get descriptive flexfields for an ownership percentage associated with an ownership definition
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages/{ownershipPercentageId}/child/ownershipPercentageDFF/{OwnershipLineId}
Update a descriptive flexfield for an ownership percentage associated with an ownership definition
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages/{ownershipPercentageId}/child/ownershipPercentageDFF/{OwnershipLineId}
Joint Ventures/Stakeholders
The stakeholders resource is used to view, create, update, or delete a joint venture stakeholder. A joint venture stakeholder is a participating entity in a joint venture.
Create a joint venture stakeholder
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders
Delete a joint venture stakeholder
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}
Get a joint venture stakeholder
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}
Get all joint venture stakeholders
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders
Update a joint venture stakeholder
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}
Joint Ventures/Stakeholders/Attachments
The attachments resource is used to view, create, and update attachments.
Create an attachment.
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/attachments
Delete an attachment.
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/attachments/{attachmentsUniqID}
Get all attachments.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/attachments
Get an attachment.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/attachments/{attachmentsUniqID}
Update an attachment.
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/attachments/{attachmentsUniqID}
Joint Ventures/Stakeholders/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Joint Ventures/Stakeholders/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Joint Ventures/Stakeholders/Stakeholder Descriptive Flexfields
The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.
Create a set of descriptive flexfields for a joint venture stakeholder
Method: post
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/stakeholderDFF
Get all descriptive flexfields for a joint venture stakeholder
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/stakeholderDFF
Get descriptive flexfields for a joint venture stakeholder
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/stakeholderDFF/{StakeholderId}
Update a descriptive flexfield for a joint venture stakeholder
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/stakeholderDFF/{StakeholderId}
Journal Batches
The journal batches resource is used to view journal batches, update batch completion status and reversal attributes, and delete journal batches. Note that for the PATCH action, you can only update the batch completion status and the reversal attributes. Updates to other attributes are not allowed.
Delete a batch
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}
Get a batch
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}
Get all batches
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches
Update a batch
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}
Journal Batches/Action Logs
The journal action logs resource is used to view action logs for a journal.
Get a log entry
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalActionLogs/{journalActionLogsUniqID}
Get all log entries
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalActionLogs
Journal Batches/Attachments
The attachments resource is used to view attachment information for a batch.
Get all attachments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/batchAttachment
Get an attachment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/batchAttachment/{batchAttachmentUniqID}
Journal Batches/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/batchAttachment/{batchAttachmentUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/batchAttachment/{batchAttachmentUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/batchAttachment/{batchAttachmentUniqID}/enclosure/FileContents
Journal Batches/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/batchAttachment/{batchAttachmentUniqID}/enclosure/FileWebImage
Journal Batches/Descriptive Flexfields
The descriptive flexfields resource is used to view values for a journal batch that are captured using the Journal Batches descriptive flexfield.
Get a descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalBatchDFF
Get a descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalBatchDFF/{JeBatchId2}
Journal Batches/Errors
The journal errors resource is used to view the errors for a journal.
Get all errors
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalErrors
Get an error
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalErrors/{journalErrorsUniqID}
Journal Batches/Journal Headers
The journal headers resource is used to view header information for a journal.
Get a journal
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}
Get all journals
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders
Journal Batches/Journal Headers/Attachments
The attachments resource is used to view attachment information for a journal.
Get all attachments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalAttachment
Get an attachment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalAttachment/{journalAttachmentUniqID}
Journal Batches/Journal Headers/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalAttachment/{journalAttachmentUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalAttachment/{journalAttachmentUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalAttachment/{journalAttachmentUniqID}/enclosure/FileContents
Journal Batches/Journal Headers/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalAttachment/{journalAttachmentUniqID}/enclosure/FileWebImage
Journal Batches/Journal Headers/Descriptive Flexfields
The descriptive flexfields resource is used to view values for a journal header that are captured using the Journals descriptive flexfield.
Get a descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalDFF
Get a descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalDFF/{JeHeaderId}
Journal Batches/Journal Headers/Global Descriptive Flexfields
The global descriptive flexfields resource is used to view values for a journal that are captured using the General Ledger Journal Regional Information global descriptive flexfield.
Get a global descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalGDF
Get a global descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalGDF/{JeHeaderId}
Journal Batches/Journal Headers/Journal Lines
The journal lines resource is used to view the journal lines for a batch.
Get a line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalLines/{journalLinesUniqID}
Get all lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalLines
Journal Batches/Journal Headers/Journal Lines/Captured Information Descriptive Flexfields
The captured information descriptive flexfields resource is used to view values for a journal line that are captured using the Journals Captured Information descriptive flexfield.
Get captured information descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalLines/{journalLinesUniqID}/child/capturedInformationDFF
Get captured information descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalLines/{journalLinesUniqID}/child/capturedInformationDFF/{capturedInformationDFFUniqID}
Journal Batches/Journal Headers/Journal Lines/Descriptive Flexfields
The descriptive flexfields resource is used to view values for a journal line that are captured using the Journal Lines descriptive flexfield.
Get a descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalLines/{journalLinesUniqID}/child/journalLineDFF
Get a descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalLines/{journalLinesUniqID}/child/journalLineDFF/{journalLineDFFUniqID}
Journal Batches/Journal Headers/Journal Lines/Global Descriptive Flexfields
The global descriptive flexfields resource is used to view values for a journal line that are captured using the General Ledger Journal Line Regional Information global descriptive flexfield.
Get a global descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalLines/{journalLinesUniqID}/child/journalLineGDF
Get a global descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalLines/{journalLinesUniqID}/child/journalLineGDF/{journalLineGDFUniqID}
Lease Accounting Payment Items
Lease Accounting Payment Items
Get a payment item
Method: get
Path: /fscmRestApi/resources/11.13.18.05/leaseAccountingPaymentItems/{PaymentItemId}
Get all payment items
Method: get
Path: /fscmRestApi/resources/11.13.18.05/leaseAccountingPaymentItems
Update a payment item
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/leaseAccountingPaymentItems/{PaymentItemId}
Ledger Balances
The ledger balances resource is used to view the balance amount for any account combination or an account that is defined as part of an account group.
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/ledgerBalances/{ledgerBalancesUniqID}
Get all account balances
Method: get
Path: /fscmRestApi/resources/11.13.18.05/ledgerBalances
List of Values/Account Combinations List of Values
The account combinations list of values resource is used to identify general ledger account combinations. An account combination is a complete set of segment values that uniquely identifies an account in a chart of accounts.
Get all account combinations
Method: get
Path: /fscmRestApi/resources/11.13.18.05/accountCombinationsLOV
Get an account combination
Method: get
Path: /fscmRestApi/resources/11.13.18.05/accountCombinationsLOV/{_CODE_COMBINATION_ID}
List of Values/Account Combinations Shorthand Aliases List of Values
The account combinations shorthand aliases list of values resource is used to view information on shorthand aliases defined for a chart of accounts. A shorthand alias is a word or code that represents a complete or partial account combination in a chart of accounts.
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/accountCombinationsShorthandAliasesLOV/{accountCombinationsShorthandAliasesLOVUniqID}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/accountCombinationsShorthandAliasesLOV
List of Values/Accounting Calendars List of Values
The accounting calendars list of values resource is used to view information on defined calendars. A calendar can either be an accounting calendar or a commitment calendar.
Get a calendar
Method: get
Path: /fscmRestApi/resources/11.13.18.05/accountingCalendarsLOV/{CalendarId}
Get all calendars
Method: get
Path: /fscmRestApi/resources/11.13.18.05/accountingCalendarsLOV
List of Values/Accounting Period Status List of Values
The accounting period status list of values resource is used to view the period status of a period in a calendar.
Get a period status
Method: get
Path: /fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV/{accountingPeriodStatusLOVUniqID}
Get all period statuses
Method: get
Path: /fscmRestApi/resources/11.13.18.05/accountingPeriodStatusLOV
List of Values/Accounting Periods List of Values
The accounting periods list of values resource is used to view period details in a calendar.
Get a period
Method: get
Path: /fscmRestApi/resources/11.13.18.05/accountingPeriodsLOV/{accountingPeriodsLOVUniqID}
Get all periods
Method: get
Path: /fscmRestApi/resources/11.13.18.05/accountingPeriodsLOV
List of Values/Asset Books List of Values
The asset books list of values resource is used to query the books setup in Assets.
Get all asset books
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fixedAssetBooksLOV
Get an asset book
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fixedAssetBooksLOV/{fixedAssetBooksLOVUniqID}
List of Values/Bank Accounts List of Values
The bank accounts list of values resource is used to query bank accounts.
Get a bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccountsLOV/{BankAccountId}
Get all bank accounts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankAccountsLOV
List of Values/Bank Branches List of Values
The bank branches list of values resource is used to query bank branches.
Get a bank branch
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankBranchesLOV/{BranchPartyId}
Get all bank branches
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBankBranchesLOV
List of Values/Bank Collection Business Units List of Values
The bank collection business units list of values resource is used to view valid business units.
Get a bank collection business unit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/bankCollectionBusinessUnitsLOV/{BusinessUnitId}
Get all bank collection business units
Method: get
Path: /fscmRestApi/resources/11.13.18.05/bankCollectionBusinessUnitsLOV
List of Values/Banks List of Values
The banks list of values resource is used to query banks.
Get a bank
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBanksLOV/{BankPartyId}
Get all banks
Method: get
Path: /fscmRestApi/resources/11.13.18.05/cashBanksLOV
List of Values/Calendar Types List of Values
The payables calendar types list of values resource is used to manage details about the calendars list of values that are used within the Payables application.
Get a payables calendar
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesCalendarTypesLOV/{payablesCalendarTypesLOVUniqID}
Get all payables calendars
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesCalendarTypesLOV
List of Values/Chart of Accounts List of Values
The chart of accounts list of values resource is used to view details about a general ledger chart of accounts.
Get a chart of account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/chartOfAccountsLOV/{StructureInstanceId}
Get all chart of accounts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/chartOfAccountsLOV
List of Values/Control Budget Periods List of Values
The control budget periods list of values resource is used to view the period details of the control budget.
Get a control budget period
Method: get
Path: /fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV/{controlBudgetPeriodsLOVUniqID}
Get all control budget periods
Method: get
Path: /fscmRestApi/resources/11.13.18.05/controlBudgetPeriodsLOV
List of Values/Control Budgets List of Values
The control budgets list of values resource is used to view the details of a control budget. Control budgets are used in budgetary control to validate spending against budget.
Get a control budget
Method: get
Path: /fscmRestApi/resources/11.13.18.05/controlBudgetsLOV/{ControlBudgetId}
Get all control budgets
Method: get
Path: /fscmRestApi/resources/11.13.18.05/controlBudgetsLOV
List of Values/Currency Conversion Types List of Values
The currency conversion types list of values resource is used to view information on currency conversion rate types. Currency conversion rate types are used to automatically assign a rate when converting foreign currency journal amounts to ledger currency equivalents.
Get a currency conversion type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/currencyConversionTypesLOV/{ConversionTypeId}
Get all currency conversion types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/currencyConversionTypesLOV
List of Values/Customer Account Sites List of Values
The customer account sites list of values resource is used to view the details of a customer account site.
Get a customer account site details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/customerAccountSitesLOV/{SiteUseId}
Get all customer account sites details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/customerAccountSitesLOV
List of Values/Data Access Set Ledgers List of Values
The data access set ledgers list of values resource is used to view information on ledgers and ledger sets associated with a given data access set.
Get a ledger or ledger set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataAccessSetLedgersLOV/{LedgerId}
Get all ledgers or ledger sets
Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataAccessSetLedgersLOV
List of Values/Data Access Sets List of Values
The data access sets list of values resource is used to view information on data access sets.
Get a data access set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataAccessSetsLOV/{AccessSetId}
Get all data access sets
Method: get
Path: /fscmRestApi/resources/11.13.18.05/dataAccessSetsLOV
List of Values/Descriptive Flexfield Contexts
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts
List of Values/Distribution Sets List of Values
The payables distribution sets list of values resource is used to manage details about the list of distribution sets.
Get a distribution set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesDistributionSetsLOV/{DistributionSetId}
Get all distribution sets
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesDistributionSetsLOV
List of Values/Document Fiscal Classifications List of Values
The document fiscal classifications list of values resource is used to view existing document fiscal classifications.
Get a document fiscal classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/documentFiscalClassificationsLOV/{documentFiscalClassificationsLOVUniqID}
Get all document fiscal classifications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/documentFiscalClassificationsLOV
List of Values/Encumbrance Types List of Values
The encumbrance types list of values resource is used to view defined journal encumbrance types.
Get a journal encumbrance type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/encumbranceTypesLOV/{EncumbranceTypeId}
Get all journal encumbrance types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/encumbranceTypesLOV
List of Values/Federal Account Symbols List of Values
The federal account symbols list of values resource is used to view details of federal account symbols.
Get a federal account symbol
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbolsLOV/{FederalAccountSymbolId}
Get all federal account symbols
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAccountSymbolsLOV
List of Values/Federal Adjustment Business Event Type Codes List of Values
The federal adjustment business event type codes list of values resource is used to view details of federal adjustment business event type codes.
Get all Adjustment BETC
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBETCAdjustmentsLOV
Get an Adjustment BETC
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBETCAdjustmentsLOV/{BusinessEventTypeId}
List of Values/Federal Agency Location Codes List of Values
The federal agency location codes list of values resource is used to view details of federal agency location codes.
Get a federal agency location code
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodesLOV/{AgencyLocationCodeId}
Get all federal agency location codes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedAgencyLocationCodesLOV
List of Values/Federal Budget Control Tree Labels List of Values
The federal budget control tree labels list of values resource is used to view details of federal budget control tree labels.
Get a federal budget control tree label
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetControlTreeLabelsLOV/{fedBudgetControlTreeLabelsLOVUniqID}
Get all federal budget control tree labels
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetControlTreeLabelsLOV
List of Values/Federal Budget Control Tree Nodes List of Values
The federal budget control tree nodes list of values resource is used to view details of federal budget control tree nodes.
Get a federal budget control tree node
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetControlTreeNodesLOV/{fedBudgetControlTreeNodesLOVUniqID}
Get all federal budget control tree nodes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetControlTreeNodesLOV
List of Values/Federal Budget Control Tree Versions List of Values
The federal budget control tree versions list of values resource is used to view details of federal budget control tree versions.
Get a federal budget control tree version
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetControlTreeVersionsLOV/{fedBudgetControlTreeVersionsLOVUniqID}
Get all federal budget control tree versions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetControlTreeVersionsLOV
List of Values/Federal Budget Control Trees List of Values
The federal budget control trees list of values resource is used to view details of federal budget control trees.
Get a federal budget control tree
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetControlTreesLOV/{fedBudgetControlTreesLOVUniqID}
Get all federal budget control trees
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetControlTreesLOV
List of Values/Federal Budget Level Operations List of Values
The budget level operations list of values resource is used to view details of budget level operations.
Get a budget level operation
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetLevelOperationsLOV/{BudgetLevelId}
Get all budget level operations
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBudgetLevelOperationsLOV
List of Values/Federal Business Event Type Codes List of Values
The federal business event type codes list of values resource is used to view details of federal business event type codes.
Get a BETC
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodesLOV/{BusinessEventTypeId}
Get all BETC
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedBusinessEventTypeCodesLOV
List of Values/Federal Closing Segments List of Values
The federal closing segments list of values resource is used to view details of federal closing segments.
Get a federal closing segment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedClosingSegmentsLOV/{StructureId}
Get all federal closing segments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedClosingSegmentsLOV
List of Values/Federal Group Budget Levels List of Values
The federal group budget levels list of values resource is used to view details of federal group budget levels.
Get a federal group budget level
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedGroupBudgetLevelsLOV/{GroupBeLevelId}
Get all federal group budget levels
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedGroupBudgetLevelsLOV
List of Values/Federal Groups List of Values
The federal groups list of values resource is used to view details of federal groups.
Get a Federal group
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedGroupsLOV/{LedgerGroupId}
Get all Federal groups
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedGroupsLOV
List of Values/Federal Ledger Group Trees List of Values
The federal ledger group trees list of values resource is used to view details of federal ledger group trees.
Get a federal ledger group tree
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerGroupTreesLOV/{fedLedgerGroupTreesLOVUniqID}
Get all federal ledger group trees
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedLedgerGroupTreesLOV
List of Values/Federal Natural Account Value Sets List of Values
The federal natural account value sets list of values resource is used to view details of federal natural account value sets.
Get a federal natural account value set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedNaturalAccountValueSetsLOV/{ValueSetId}
Get all federal natural account value sets
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedNaturalAccountValueSetsLOV
List of Values/Federal Partial Segments List of Values
The federal partial segments list of values resource is used to view details of partial segments.
Get a partial segment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedPartialSegmentsLOV/{fedPartialSegmentsLOVUniqID}
Get all partial segments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedPartialSegmentsLOV
List of Values/Federal Transaction Types List of Values
The federal transaction types list of values resource is used to view details of federal transaction types.
Get a federal transaction type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTransactionTypesLOV/{TransactionTypeId}
Get all federal transaction types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTransactionTypesLOV
List of Values/Federal Treasury Account Symbol Business Event Type Codes List of Values
The treasury account symbol business event type codes list of values resource is used to view details of treasury account symbol business event type codes.
Get a treasury account symbol business event type code
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTASBusinessEventTypeCodesLOV/{TasBetcMapId}
Get all treasury account symbols business event type codes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTASBusinessEventTypeCodesLOV
List of Values/Federal Treasury Account Symbols List of Values
The treasury account symbols list of values resource is used to view details of treasury account symbols.
Get a treasury account symbol
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbolsLOV/{TreasuryAccountSymbolId}
Get all treasury account symbols
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedTreasuryAccountSymbolsLOV
List of Values/Federal USSGL Trees List of Values
The federal USSGL trees list of values resource is used to view details of federal USSGL trees.
Get a USSGL tree
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLTreesLOV/{fedUSSGLTreesLOVUniqID}
Get all USSGL trees
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fedUSSGLTreesLOV
List of Values/Financials Business Units List of Values
The Financials business units list of values resource is used to view information on defined business units. A business unit is a unit of an enterprise that performs one or many business functions that can be rolled up in a management hierarchy and can process transactions on behalf of many legal entities.
Get a business unit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/finBusinessUnitsLOV/{finBusinessUnitsLOVUniqID}
Get all business units
Method: get
Path: /fscmRestApi/resources/11.13.18.05/finBusinessUnitsLOV
List of Values/Fiscal Document Business Units List of Values
The fiscal document business units list of values resource is used to view valid business units.
Get a fiscal document business unit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fiscalDocumentBusinessUnitsLOV/{BusinessUnitId}
Get all fiscal document business units
Method: get
Path: /fscmRestApi/resources/11.13.18.05/fiscalDocumentBusinessUnitsLOV
List of Values/Generic Value Set Values
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/FlexFndPvsCharacterIdCharacterValues
List of Values/Income Tax Regions List of Values
The payables income tax regions list of values resource is used to manage details about the list of income tax regions.
Get all income tax regions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesIncomeTaxRegionsLOV
Get an income tax region
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesIncomeTaxRegionsLOV/{RegionShortName}
List of Values/Income Tax Types List of Values
The payables income tax types list of values resource is used to manage details about the list of income tax types.
Get all income tax types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesIncomeTaxTypesLOV
Get an income tax type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesIncomeTaxTypesLOV/{IncomeTaxType}
List of Values/Input Tax Classifications List of Values
The input tax classifications list of values resource is used to query the existing input tax classifications.
Get all input tax classifications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/inputTaxClassificationsLOV
Get an input tax classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/inputTaxClassificationsLOV/{inputTaxClassificationsLOVUniqID}
List of Values/Intercompany Organizations List of Values
The Intercompany organizations list of values resource is used to view details on defined Intercompany organizations. Intercompany organizations are defined for diverse business needs that represent the initiators and recipients of Intercompany transactions.
Get all intercompany organizations
Method: get
Path: /fscmRestApi/resources/11.13.18.05/intercompanyOrganizationsLOV
Get an intercompany organization
Method: get
Path: /fscmRestApi/resources/11.13.18.05/intercompanyOrganizationsLOV/{IntercoOrgId}
List of Values/Intercompany Transaction Types List of Values
The Intercompany transaction types list of values resource is used to view information on defined intercompany transaction types. They are processing rules that ensure intercompany transactions are processed in a systematic way.
Get all intercompany transaction types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/intercompanyTransactionTypesLOV
Get an intercompany transaction type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/intercompanyTransactionTypesLOV/{TrxTypeId}
List of Values/Invoice Holds List of Values
The invoice holds list of values resource is used to manage the details of the holds placed on an invoice and provides a list of invoice holds.
Get all invoice holds
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV
Get an invoice hold
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesInvoiceHoldsLOV/{HoldLookupCode}
List of Values/Invoice Tolerances List of Values
The payables invoice tolerances list of values resource is used to manage details about tolerances applied to invoices. A list of defined quantity and amount tolerances is provided.
Get all invoice tolerances
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesInvoiceTolerancesLOV
Get an invoice tolerance
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesInvoiceTolerancesLOV/{payablesInvoiceTolerancesLOVUniqID}
List of Values/Joint Venture Invoicing Partners List of Values
The joint venture invoicing partners list of values resource is used to view invoicing partners.
Get a joint venture invoicing partner
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV/{invoicingPartnerId}
Get all joint venture invoicing partners
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureInvoicingPartnersLOV
List of Values/Joint Venture SLA Date References List of Values
The joint venture SLA date references list of values resource is used to view supporting references for subledger accounting that derive a date value.
Get a supporting reference that derives a date value
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADateReferencesLOV/{shortName}
Get all supporting references that derive a date value
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLADateReferencesLOV
List of Values/Joint Venture SLA Supporting References List of Values
The joint venture SLA supporting references list of values resource is used to view supporting references for subledger accounting.
Get a supporting reference
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLASupportingReferencesLOV/{shortName}
Get all supporting references
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureSLASupportingReferencesLOV
List of Values/Joint Venture Stakeholders List of Values
The joint venture stakeholders list of values resource is used to view the stakeholders associated with a joint venture.
Get a stakeholder associated with a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureStakeholdersLOV/{jointVentureStakeholdersLOVUniqID}
Get all stakeholders associated with a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/jointVentureStakeholdersLOV
List of Values/Journal Categories List of Values
The journal categories list of values resource is used to view journal category details.
Get a journal category
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalCategoriesLOV/{JeCategoryName}
Get all journal categories
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalCategoriesLOV
List of Values/Journal Sources List of Values
The journal sources list of values resource is used to view journal entry source details.
Get a journal source
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalSourcesLOV/{JeSourceName}
Get all journal sources
Method: get
Path: /fscmRestApi/resources/11.13.18.05/journalSourcesLOV
List of Values/Ledgers List of Values
The ledgers list of values resource is used to view information on defined ledgers including primary, secondary, reporting currencies and average balancing enabled ledgers.
Get a ledger
Method: get
Path: /fscmRestApi/resources/11.13.18.05/ledgersLOV/{LedgerId}
Get all ledgers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/ledgersLOV
List of Values/Legal Entities List of Values
The legal entities list of values resource is used to view information on defined legal entities. A legal entity is a recognized party with rights and responsibilities given by legislation.
Get a legal entity
Method: get
Path: /fscmRestApi/resources/11.13.18.05/legalEntitiesLOV/{LegalEntityId}
Get all legal entities
Method: get
Path: /fscmRestApi/resources/11.13.18.05/legalEntitiesLOV
List of Values/Legal Jurisdictions List of Values
The legal jurisdictions list of values resource is used to view information on defined legal jurisdictions. A legal jurisdiction serves as a geographic area or areas for which a legal authority is responsible.
Get a legal jurisdiction
Method: get
Path: /fscmRestApi/resources/11.13.18.05/legalJurisdictionsLOV/{JurisdictionId}
Get all legal jurisdictions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/legalJurisdictionsLOV
List of Values/Legal Reporting Units List of Values
The legal reporting units list of values resource is used to view information about defined legal reporting units. A legal reporting unit represents the lowest level component of a legal structure that requires registration, and is used for reporting, such as statutory and tax.
Get a legal reporting unit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/legalReportingUnitsLOV/{LegalReportingUnitId}
Get all legal reporting units
Method: get
Path: /fscmRestApi/resources/11.13.18.05/legalReportingUnitsLOV
List of Values/Lookups
The lookups resource is used to view standard lookup codes.
Get all lookups.
Method: get
Path: /crmRestApi/resources/11.13.18.05/fndStaticLookups
List of Values/Netting Legal Entities List of Values
The netting legal entities list of values resource is used to view agreement and settlement details.
Get a netting legal entity
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingLegalEntitiesLOV/{LegalEntityId}
Get all netting legal entities
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingLegalEntitiesLOV
List of Values/Note Types
The note types resource is used to view the note type.
Get all note types
Method: get
Path: /crmRestApi/resources/11.13.18.05/noteTypes
List of Values/Output Tax Classifications List of Values
The output tax classifications list of values resource is used to query existing output tax classifications.
Get all output tax classifications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/outputTaxClassificationsLOV
Get an output tax classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/outputTaxClassificationsLOV/{outputTaxClassificationsLOVUniqID}
List of Values/Ownership Definition Names List of Values
The ownership definition names list of values resource is used to view ownership definition names assigned to a joint venture.
Get all ownership definition names assigned to a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/ownershipDefinitionNamesLOV
Get an ownership definition name assigned to a joint venture
Method: get
Path: /fscmRestApi/resources/11.13.18.05/ownershipDefinitionNamesLOV/{ownershipDefinitionNamesLOVUniqID}
List of Values/Payment Codes List of Values
The payment codes list of values resource is used to query payment codes.
Get a payment code
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentCodesLOV/{paymentCodesLOVUniqID}
Get all payment codes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentCodesLOV
List of Values/Payment Methods List of Values
The disbursement payment methods list of values resource is used to query payment methods on the user interface.
Get a payment method
Method: get
Path: /fscmRestApi/resources/11.13.18.05/disbursementPaymentMethodsLOV/{PaymentMethodCode}
Get all payment methods
Method: get
Path: /fscmRestApi/resources/11.13.18.05/disbursementPaymentMethodsLOV
List of Values/Payment Process Profiles List of Values
The payment process profiles list of values resource is used to query payment process profiles on the user interface.
Get a payment process profile
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentProcessProfilesLOV/{PaymentProcessProfileId}
Get all payment process profiles
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentProcessProfilesLOV
List of Values/Payment Terms List of Values
The payables payment terms list of values resource is used to manage details about the list of payables payment terms.
Get a payables payment term
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPaymentTermsLOV/{TermId}
Get all payables payment terms
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPaymentTermsLOV
List of Values/Preferred Currencies List of Values
The preferred currencies list of values resource is used to view user preferred currencies.
Get a currency
Method: get
Path: /fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV/{CurrencyCode}
Get all currencies
Method: get
Path: /fscmRestApi/resources/11.13.18.05/preferredCurrenciesLOV
List of Values/Product Fiscal Classifications List of Values
The product fiscal classifications list of values resource is used to view existing product fiscal classifications.
Get a product fiscal classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/productFiscalClassificationsLOV/{productFiscalClassificationsLOVUniqID}
Get all product fiscal classifications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/productFiscalClassificationsLOV
List of Values/Product Types List of Values
The product types list of values resource is used to view existing product types.
Get a product type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/productTypesLOV/{ClassificationCode}
Get all product types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/productTypesLOV
List of Values/Purchase to Pay Legal Entities List of Values
The purchase to pay legal entities list of values resource is used to retrieve the legal entity associated to a business unit, location or code combination, registration code, and registration number.
Get a purchase to pay legal entity
Method: get
Path: /fscmRestApi/resources/11.13.18.05/purchaseToPayLegalEntitiesLOV/{LegalEntityId}
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/purchaseToPayLegalEntitiesLOV
List of Values/Rated Currencies
The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
Get all rated currencies
Method: get
Path: /crmRestApi/resources/11.13.18.05/ratedCurrencies
List of Values/Receivables Business Units List of Values
The Receivables business units list of values resource is used to view valid business units.
Get a business unit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesBusinessUnitsLOV/{BusinessUnitId}
Get all business units
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesBusinessUnitsLOV
List of Values/Receivables Memo Lines List of Values
The Receivables memo lines list of values resource is used to view valid memo lines.
Get a memo line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/memoLinesLOV/{MemoLineId}
Get all memo lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/memoLinesLOV
List of Values/Receivables Payment Terms List of Values
The Receivables payment terms list of values resource is used to view valid payment terms.
Get all payment terms
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentTermsLOV
Get payment terms
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentTermsLOV/{PaymentTermsId}
List of Values/Receivables Transaction Sources List of Values
The Receivables transaction sources list of values resource is used to view valid transaction sources.
Get a transaction source
Method: get
Path: /fscmRestApi/resources/11.13.18.05/transactionSourcesLOV/{TransactionSourceId}
Get all transaction sources
Method: get
Path: /fscmRestApi/resources/11.13.18.05/transactionSourcesLOV
List of Values/Receivables Transaction Types List of Values
The Receivables transaction types list of values resource is used to view valid transaction types.
Get a transaction type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/transactionTypesLOV/{TransactionTypeId}
Get all transaction types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/transactionTypesLOV
List of Values/Tax Classifications List of Values
The tax classifications resource is used to query existing tax classifications.
Get a tax classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxClassifications/{taxClassificationsUniqID}
Get all tax classifications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxClassifications
List of Values/Tax Intended Uses List of Values
The tax intended uses list of values resource is used to query existing intended use values.
Get all intended use fiscal classifications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxIntendedUsesLOV
Get an intended use fiscal classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxIntendedUsesLOV/{ClassificationId}
List of Values/Tax Rates List of Values
The tax rates list of values resource is used to query existing tax rates.
Get a tax rate
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxRatesLOV/{TaxRateId}
Get all tax rates
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxRatesLOV
List of Values/Tax Regimes List of Values
The tax regimes list of values resource is used to query existing tax regimes.
Get a tax regime
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxRegimesLOV/{TaxRegimeId}
Get all tax regimes
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxRegimesLOV
List of Values/Tax Reporting Entities List of Values
The payables tax reporting entities list of values resource is used to manage the details about entities for tax reporting purposes.
Get a tax reporting entity
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesTaxReportingEntitiesLOV/{EntityId}
Get all tax reporting entities
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesTaxReportingEntitiesLOV
List of Values/Withholding Tax Groups List of Values
The withholding tax groups list of values resource is used to view existing withholding tax groups.
Get a withholding tax group
Method: get
Path: /fscmRestApi/resources/11.13.18.05/withholdingTaxGroupsLOV/{GroupId}
Get all withholding tax groups
Method: get
Path: /fscmRestApi/resources/11.13.18.05/withholdingTaxGroupsLOV
List of Values/Workflow Users List of Values
The workflow users resource is used to view the users associated with the workflow.
Get a workflow user
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowUsers/{PersonId}
Get all workflow users
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowUsers
Netting Agreements
The netting agreements resource is used to view, create, or modify a netting agreement. A netting agreement specifies the netting business rules and transaction criteria that support your netting practices.
Create a netting agreement
Method: post
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements
Get a netting agreement
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}
Get all netting agreements
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements
Update a netting agreement
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}
Netting Agreements/Customer Trading Partners
The customer trading partners resource is used to add, modify, or remove a customer trading partner from a netting agreement. A netting customer trading partner represents a customer that is part of the netting agreement.
Create a customer trading partner
Method: post
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingCustomerTradingPartners
Delete a customer trading partner
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingCustomerTradingPartners/{NettingCustomerId}
Get a customer trading partner
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingCustomerTradingPartners/{NettingCustomerId}
Get all customer trading partners
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingCustomerTradingPartners
Update a customer trading partner
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingCustomerTradingPartners/{NettingCustomerId}
Netting Agreements/Pay Groups
The pay groups resource is used to add, modify, or remove an invoice pay group from a netting agreement. A pay group is used as a selection criteria to include or exclude payables invoices from the netting settlements created for a netting agreement.
Create a pay group
Method: post
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayGroups
Delete a pay group
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayGroups/{NettingPayGroupId}
Get a pay group
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayGroups/{NettingPayGroupId}
Get all pay groups
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayGroups
Update a pay group
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayGroups/{NettingPayGroupId}
Netting Agreements/Payables Invoice Types
The payables invoice types resource is used to add, modify, or remove invoice types from a netting agreement. An invoice type is used as a selection criteria to include or exclude payables invoices from the netting settlements created for a netting agreement.
Create a payables invoice type
Method: post
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayablesInvoiceTypes
Delete a payables invoice type
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayablesInvoiceTypes/{NettingInvTypeId}
Get a payables invoice type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayablesInvoiceTypes/{NettingInvTypeId}
Get all payables invoice types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayablesInvoiceTypes
Update a payables invoice type
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayablesInvoiceTypes/{NettingInvTypeId}
Netting Agreements/Receivables Transaction Types
The receivables transaction types resource is used to add, modify, or remove transaction types from a netting agreement. A transaction type is used as a selection criteria to include or exclude receivables transactions from the netting settlements created for a netting agreement.
Create a receivables transaction type
Method: post
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingReceivablesTransactionTypes
Delete a receivables transaction type
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingReceivablesTransactionTypes/{NetTrxTypeId}
Get a receivables transaction type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingReceivablesTransactionTypes/{NetTrxTypeId}
Get all receivables transaction types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingReceivablesTransactionTypes
Update a receivables transaction type
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingReceivablesTransactionTypes/{NetTrxTypeId}
Netting Agreements/Supplier Trading Partners
The supplier trading partners resource is used to add, modify, or remove a supplier trading partner from a netting agreement. A netting supplier trading partner represents a supplier that is part of the netting agreement.
Create a supplier trading partner
Method: post
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingSupplierTradingPartners
Delete a supplier trading partner
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingSupplierTradingPartners/{NettingSupplierId}
Get a supplier trading partner
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingSupplierTradingPartners/{NettingSupplierId}
Get all supplier trading partners
Method: get
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingSupplierTradingPartners
Update a supplier trading partner
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingSupplierTradingPartners/{NettingSupplierId}
Party Fiscal Classifications
The party fiscal classifications resource is used to query, update, and create party fiscal classifications.
Create a party fiscal classification
Method: post
Path: /fscmRestApi/resources/11.13.18.05/partyFiscalClassifications
Get a party fiscal classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/{ClassificationTypeId}
Get all party fiscal classifications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/partyFiscalClassifications
Update a party fiscal classification
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/{ClassificationTypeId}
Party Fiscal Classifications/Tax Regime Associations
The fiscal classification type tax regime association resource is used to query, update, and create party fiscal classifications for purposes of assigning the appropriate tax regime to a specific party fiscal classification.
Create a tax regime for a party fiscal classification
Method: post
Path: /fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/{ClassificationTypeId}/child/fiscalClassificationTypeTaxRegimeAssociations
Get a tax regime for a party fiscal classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/{ClassificationTypeId}/child/fiscalClassificationTypeTaxRegimeAssociations/{fiscalClassificationTypeTaxRegimeAssociationsUniqID}
Get all tax regimes for a party fiscal classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/{ClassificationTypeId}/child/fiscalClassificationTypeTaxRegimeAssociations
Update a tax regime for a party fiscal classification
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/partyFiscalClassifications/{ClassificationTypeId}/child/fiscalClassificationTypeTaxRegimeAssociations/{fiscalClassificationTypeTaxRegimeAssociationsUniqID}
Party Tax Profiles
The party tax profiles resource is used to query and update party tax profiles.
Create a party tax profile
Method: post
Path: /fscmRestApi/resources/11.13.18.05/partyTaxProfiles
Get a party tax profile
Method: get
Path: /fscmRestApi/resources/11.13.18.05/partyTaxProfiles/{PartyTaxProfileId}
Get all party tax profiles
Method: get
Path: /fscmRestApi/resources/11.13.18.05/partyTaxProfiles
Update a party tax profile
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/partyTaxProfiles/{PartyTaxProfileId}
Payables Calendar Types
The payables calendar types resource is used to manage details about calendar types that are used for general purpose like Recurring Invoice Calendars, Withholding Calendars, or special purposes such as a payment term calendar.
Get all calendar types
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesCalendarTypes
Get one calendar type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesCalendarTypes/{payablesCalendarTypesUniqID}
Payables Calendar Types/Payables Calendar Periods
The payables calendar periods resource is used to manage details about calendar periods defined for a calendar and other important information like the number of periods, the start date, and the end date.
Get all calendar periods for one calendar type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesCalendarTypes/{payablesCalendarTypesUniqID}/child/payablesCalendarPeriods
Get calendar periods for one calendar type
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesCalendarTypes/{payablesCalendarTypesUniqID}/child/payablesCalendarPeriods/{payablesCalendarPeriodsUniqID}
Payables Distribution Sets
The payables distribution sets resource is used to manage the details about the distribution sets used to automatically create the invoice distribution lines.
Get a distribution set header for a distribution set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesDistributionSets/{distributionSetId}
Get all distribution sets
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesDistributionSets
Payables Distribution Sets/Payables Distribution Set Lines
The payables distribution set lines resource is used to manage the details about the individual distribution lines defined for a distribution set.
Get a distribution set line for a distribution set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesDistributionSets/{distributionSetId}/child/payablesDistributionSetsLines/{payablesDistributionSetsLinesUniqID}
Get all distribution set lines for a distribution set
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesDistributionSets/{distributionSetId}/child/payablesDistributionSetsLines
Payables Income Tax Regions
The payables income tax regions resource is used to manage details about income tax regions that are used to record payment information for 1099 suppliers and used in 1099 reporting to the tax authorities.
Get all income tax regions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesIncomeTaxRegions
Get an income tax region
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesIncomeTaxRegions/{state}
Payables Invoice Holds
The payables invoice holds resource is used to manage the information about invoice holds. Detailed information about the various attributes of each hold is provided.
Get a hold details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesInvoiceHolds/{payablesInvoiceHoldsUniqID}
Get all holds details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesInvoiceHolds
Payables Options
The payables options resource is used to manage the details about the parameters and defaults for operating the Payables application. The resource contains information such as the ledger, the functional currency of the ledger, and the defaults such as payment terms. This resource also contains information to determine default values that cascade down to the invoice entry.
Get payables options for a business unit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesOptions/{businessUnitId}
Get payables options for all business units
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesOptions
Payables Payments
The payables payments resource is used to manage payment details. You can create manual payments, update descriptive and global flexfields for a payment, and void a payment.
Create a payment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments
Get a payment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}
Get all payments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments
Update a payment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}
Payables Payments/Payments Descriptive Flexfields
The payables payments descriptive flexfields resource is used to manage details about the descriptive flexfield references for a payment.
Create a descriptive flexfield for a payment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentDff
Get all descriptive flexfields for a payment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentDff
Get descriptive flexfields for a payment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentDff/{CheckId2}
Update descriptive flexfields for a payment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentDff/{CheckId2}
Payables Payments/Payments Global Descriptive Flexfields
The payables payments global descriptive flexfields resource is used to manage details about the global descriptive flexfield references for a payment.
Create a global descriptive flexfield for a payment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentGdf
Get all global descriptive flexfields for a payment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentGdf
Get global descriptive flexfields for a payment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentGdf/{CheckId3}
Update global descriptive flexfields for a payment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/paymentGdf/{CheckId3}
Payables Payments/Related Invoices
The related invoices resource is used to manage details of invoices related to a payment.
Get a paid invoice for a payment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/relatedInvoices/{InvoicePaymentId}
Get all paid invoices for a payment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/relatedInvoices
Invoices to be paid
Method: post
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/relatedInvoices
Payables Payments/Related Invoices/Related Invoice Global Descriptive Flexfields
The related invoice global descriptive flexfields resource is used to manage details about the descriptive flexfield references for an invoice payment.
Create a global descriptive flexfield for an invoice payment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/relatedInvoices/{InvoicePaymentId}/child/relatedInvoiceGdf
Get all global descriptive flexfields for an invoice payment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/relatedInvoices/{InvoicePaymentId}/child/relatedInvoiceGdf
Get global descriptive flexfields for an invoice payment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/relatedInvoices/{InvoicePaymentId}/child/relatedInvoiceGdf/{InvoicePaymentId2}
Update global descriptive flexfields for an invoice payment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/payablesPayments/{CheckId}/child/relatedInvoices/{InvoicePaymentId}/child/relatedInvoiceGdf/{InvoicePaymentId2}
Payables and Procurement Options
The payables and procurement options resource contains options and defaults that are shared between the Payables and Purchasing applications.
Get payables and procurement options for a business unit
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesAndProcurementOptions/{businessUnitId}
Get payables and procurement options for all business units
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesAndProcurementOptions
Payee Bank Accounts List of Values
The payee bank account list of values resource is used to query payee bank accounts.
Get a payee bank account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV/{AccountNumber}
Get all payee bank accounts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payeeBankAccountsLOV
Payment Process Requests
The payment process request resource is used to view and take action on a payment process request.
Get a payment process request
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentProcessRequests/{PaymentProcessRequestId}
Get all payment process requests
Method: get
Path: /fscmRestApi/resources/11.13.18.05/paymentProcessRequests
Update a payment process request
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/paymentProcessRequests/{PaymentProcessRequestId}
Payment Terms
The payables payment terms resource is used to manage the details about payment terms that's used in computing the installments that are due to the supplier.
Get a payment term header for a terms ID
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPaymentTerms/{termsId}
Get all payment terms headers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPaymentTerms
Payment Terms/Payment Terms Lines
The payables payment terms lines resource is used to manage the details about payment term lines that assist in determining the installment amount and the due date of each installment.
Get a payment term line for a terms ID
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPaymentTerms/{termsId}/child/payablesPaymentTermsLines/{payablesPaymentTermsLinesUniqID}
Get all payment terms lines for a terms ID
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPaymentTerms/{termsId}/child/payablesPaymentTermsLines
Payment Terms/Payment Terms Sets
The payables payment terms sets resource is used to manage the details about payments terms associated to the reference data set.
Get a set name for the payment term
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPaymentTerms/{termsId}/child/payablesPaymentTermsSets
Get all set names associated to the payment terms
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPaymentTerms/{termsId}/child/payablesPaymentTermsSets/{payablesPaymentTermsSetsUniqID}
Payment Terms/Payment Terms Translations
The payables payment terms translations resource is used to manage the details about payments terms and the languages that the contents of the columns are translated in the supported languages.
Get a payment term details for a term ID in a specific language
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPaymentTerms/{termsId}/child/payablesPaymentTermsTranslations/{payablesPaymentTermsTranslationsUniqID}
Get all payment terms details for a term ID in all supported languages
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesPaymentTerms/{termsId}/child/payablesPaymentTermsTranslations
Receipt Method Assignments
The receipt method assignments resource is used to assign a new receipt method to a customer account or site, and to find, update, and delete existing receipt methods of a customer account or site.
Create a receipt method assignment at customer account or site
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receiptMethodAssignments
Delete a receipt method assigned to a customer account or site
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/receiptMethodAssignments/{CustomerReceiptMethodId}
Get a receipt method assigned to a customer account or site
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receiptMethodAssignments/{CustomerReceiptMethodId}
Get all receipt methods assigned to a customer account or site
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receiptMethodAssignments
Update a receipt method assigned to a customer account or site
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/receiptMethodAssignments/{CustomerReceiptMethodId}
Receipt Methods
The resource that provides details of receipt methods that associate receipt class, remittance bank, and receipt account information with receipts.
Get a receipt method details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receiptMethods/{ReceiptMethodId}
Get all receipt method details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receiptMethods
Receipt Methods/Receipt Methods Descriptive Flexfields
The resource that provides details of descriptive flexfields associated with the receipt method. This is a child resource of the receiptMethods root resource.
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receiptMethods/{ReceiptMethodId}/child/receiptMethodDFF/{ReceiptMethodId2}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receiptMethods/{ReceiptMethodId}/child/receiptMethodDFF
Receivables Adjustments
The receivables adjustments resource is used to reduce or increase the value of a transaction. You can perform an adjustment against an invoice, debit memo, and credit memo, and against any of these parts of the transaction: Charges, Freight, Invoice (transaction header), Line, Tax.
Get a receivables adjustment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesAdjustments/{AdjustmentId}
Get all receivables adjustments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesAdjustments
Receivables Adjustments/Receivables Adjustments Descriptive Flexfields
The receivables adjustments descriptive flexfields resource is used to get the descriptive flexfield values associated with an invoice adjustment.
Get a receivables adjustment descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesAdjustments/{AdjustmentId}/child/receivablesAdjustmentDFF/{AdjustmentId2}
Get all receivables adjustment descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesAdjustments/{AdjustmentId}/child/receivablesAdjustmentDFF
Receivables Credit Memos
The receivables credit memos resource is used to get and find a receivables credit memo.
Create a receivables credit memo
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos
Get a receivables credit memo
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}
Get all receivables credit memos
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos
Update a receivables credit memo
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}
Receivables Credit Memos/Attachments
The attachments resource is used to view, create, and update attachments.
Create an attachment.
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/attachments
Get all attachments.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/attachments
Get an attachment.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/attachments/{attachmentsUniqID}
Receivables Credit Memos/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Receivables Credit Memos/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Receivables Credit Memos/Notes
The note objects resource is used to view the note objects.
Create a note
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/notes
Get a note object
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/notes/{NoteId}
Get all note objects
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/notes
Receivables Credit Memos/Notes/Large Object (LOB) Attributes - NoteTxt
Delete a NoteTxt
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/notes/{NoteId}/enclosure/NoteTxt
Get a NoteTxt
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/notes/{NoteId}/enclosure/NoteTxt
Replace a NoteTxt
Method: put
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/notes/{NoteId}/enclosure/NoteTxt
Receivables Credit Memos/Receivables Credit Memo Descriptive Flexfields
The receivables credit memo descriptive flexfields resource is used to create, get, and find the descriptive flexfield values associated with a credit memo.
Create a receivables credit memo descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoDFF
Get a receivables credit memo descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoDFF/{CustomerTrxId}
Get all descriptive flexfields for a group of receivables credit memos
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoDFF
Receivables Credit Memos/Receivables Credit Memo Distributions
The receivables credit memo distributions resource is used to create, get, and find distributions associated with the credit memo.
Create a receivables credit memo distribution
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoDistributions
Get a receivables credit memo distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoDistributions/{DistributionId}
Get all credit memo distributions for a receivables credit memo
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoDistributions
Receivables Credit Memos/Receivables Credit Memo Distributions/Receivables Credit Memo Distribution Descriptive Flexfields
The receivables credit memo distributions descriptive flexfields resource is used to create, get, and find the descriptive flexfield values associated with credit memo distributions.
Create a receivables credit memo distribution descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoDistributions/{DistributionId}/child/receivablesCreditMemoDistributionDFF
Get a receivables credit memo distribution descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoDistributions/{DistributionId}/child/receivablesCreditMemoDistributionDFF/{CustTrxLineGlDistId}
Get all descriptive flexfields for a group of receivables credit memo distributions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoDistributions/{DistributionId}/child/receivablesCreditMemoDistributionDFF
Receivables Credit Memos/Receivables Credit Memo Global Descriptive Flexfields
The receivables credit memo global descriptive flexfields resource is used to create, get, and find the global descriptive flexfield values associated with a credit memo.
Create a receivables credit memo global descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoGdf
Get a receivables credit memo global descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoGdf/{CustomerTrxId}
Get all global descriptive flexfields for a group of receivables credit memos
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoGdf
Receivables Credit Memos/Receivables Credit Memo Lines
The receivables credit memo lines resource is used to get and find the lines of a credit memo.
Create a set of receivables credit memo lines
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines
Get a receivables credit memo line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}
Get all receivables credit memo lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines
Receivables Credit Memos/Receivables Credit Memo Lines/Attachments
The attachments resource is used to view, create, and update attachments.
Create an attachment.
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/attachments
Get all attachments.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/attachments
Get an attachment.
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/attachments/{attachmentsUniqID}
Receivables Credit Memos/Receivables Credit Memo Lines/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Receivables Credit Memos/Receivables Credit Memo Lines/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Receivables Credit Memos/Receivables Credit Memo Lines/Receivables Credit Memo Line Descriptive Flexfields
The receivables credit memo line descriptive flexfields resource is used to create, get, and find the descriptive flexfield values associated with credit memo lines.
Create a receivables credit memo line descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineDFF
Get a receivables credit memo line descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineDFF/{CustomerTrxLineId}
Get all descriptive flexfields for a group of receivables credit memo lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineDFF
Receivables Credit Memos/Receivables Credit Memo Lines/Receivables Credit Memo Line Global Descriptive Flexfields
The receivables credit memo line global descriptive flexfields resource is used to create, get, and find the global descriptive flexfield values associated with credit memo lines.
Create a receivables credit memo line global descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineGdf
Get a receivables credit memo line global descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineGdf/{CustomerTrxLineId}
Get all global descriptive flexfields for a group of receivables credit memo lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineGdf
Receivables Credit Memos/Receivables Credit Memo Lines/Receivables Credit Memo Line Tax Lines
The receivables credit memo line tax lines resource is used to create, get, and find the tax lines of a credit memo line.
Create a receivables credit memo tax line
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineTaxLines
Get a receivables credit memo line tax line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineTaxLines/{CustomerTrxLineId}
Get all receivables credit memo tax lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineTaxLines
Receivables Credit Memos/Receivables Credit Memo Lines/Receivables Credit Memo Line Transaction Descriptive Flexfields
The receivables credit memo line transaction descriptive flexfields resource is used to create, get, and find the transaction descriptive flexfield values associated with credit memo lines.
Create a receivables credit memo line transaction descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineTransactionDFF
Get a receivables credit memo line transaction descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineTransactionDFF/{CustomerTrxLineId}
Get all transaction descriptive flexfields for a group of receivables credit memo lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoLines/{CustomerTransactionLineId}/child/receivablesCreditMemoLineTransactionDFF
Receivables Credit Memos/Receivables Credit Memo Transaction Descriptive Flexfields
The receivables credit memo transaction descriptive flexfields resource is used to create, get, and find the transaction descriptive flexfield values associated with a credit memo.
Create a receivables credit memo transaction descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoTransactionDFF
Get a receivables credit memo transaction descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoTransactionDFF/{CustomerTrxId}
Get all transaction descriptive flexfields for a group of receivables credit memos
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCreditMemos/{CustomerTransactionId}/child/receivablesCreditMemoTransactionDFF
Receivables Customer Account Activities
The resource that provides details of a customer and its associated accounts. Customer transaction details are captured in the child resources.
Get a customer account activity
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}
Get all customer account activities
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities
Receivables Customer Account Activities/Credit Memo Applications
The resource that provides details of credit memo applications created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get a credit memo application
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/creditMemoApplications/{ApplicationId}
Get all credit memo applications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/creditMemoApplications
Receivables Customer Account Activities/Credit Memo Applications/Credit Memo Applications Descriptive Flexfields
The resource that provides details of descriptive flexfields associated with the credit memo applications created against transactions belonging to customer account sites. This is a child resource to CreditMemoApplications, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/creditMemoApplications/{ApplicationId}/child/creditMemoApplicationDFF/{ReceivableApplicationId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/creditMemoApplications/{ApplicationId}/child/creditMemoApplicationDFF
Receivables Customer Account Activities/Credit Memos
The resource that provides details of credit memos created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. It includes standard and on account credit memos.
Get a credit memo
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/creditMemos/{CreditMemoId}
Get all credit memos
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/creditMemos
Receivables Customer Account Activities/Standard Receipt Applications
The resource that provides details of standard receipt applications created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get a standard receipt application
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/standardReceiptApplications/{ApplicationId}
Get all standard receipt applications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/standardReceiptApplications
Receivables Customer Account Activities/Standard Receipt Applications/Credit Memo Applications Descriptive Flexfields
The resource that provides details of descriptive flexfields associated with the credit memo applications created against transactions belonging to customer account sites. This is a child resource to CreditMemoApplications, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/standardReceiptApplications/{ApplicationId2}/child/standardReceiptApplicationDFF/{ReceivableApplicationId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/standardReceiptApplications/{ApplicationId}/child/standardReceiptApplicationDFF
Receivables Customer Account Activities/Standard Receipts
The resource that provides details of standard receipts created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get a standard receipt
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/standardReceipts/{StandardReceiptId}
Get all standard receipts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/standardReceipts
Receivables Customer Account Activities/Transaction Adjustments
The resource that provides details of adjustments created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get a transaction adjustment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/transactionAdjustments/{AdjustmentId}
Get all transaction adjustments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/transactionAdjustments
Receivables Customer Account Activities/Transaction Payment Schedules
The resource that provides details of payment schedules for transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. Transactions include invoices, debit memos, and chargebacks.
Get a transaction payment schedule
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/transactionPaymentSchedules/{InstallmentId}
Get all transaction payment schedules
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/transactionPaymentSchedules
Receivables Customer Account Activities/Transactions Paid by Other Customers
The transactions paid by other customers resource provides details of receipt applications for transactions that are paid on behalf of the customer account.
Get a transaction paid by other customers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/transactionsPaidByOtherCustomers/{ApplicationId}
Get all transactions paid by other customers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountActivities/{AccountId}/child/transactionsPaidByOtherCustomers
Receivables Customer Account Site Activities
The resource that provides details of a customer, and the associated accounts and billing sites. Transactional details are captured in the child resources.
Get a customer account activity
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}
Get all customer account activities
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities
Receivables Customer Account Site Activities/Credit Memo Applications
The resource that provides details of credit memo applications created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get a credit memo application
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/creditMemoApplications/{ApplicationId}
Get all credit memo applications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/creditMemoApplications
Receivables Customer Account Site Activities/Credit Memo Applications/Credit Memo Applications Descriptive Flexfields
The resource that provides details of descriptive flexfields associated with the credit memo applications created against transactions belonging to customer account sites. This is a child resource to CreditMemoApplications, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/creditMemoApplications/{ApplicationId}/child/creditMemoApplicationDFF/{ReceivableApplicationId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/creditMemoApplications/{ApplicationId}/child/creditMemoApplicationDFF
Receivables Customer Account Site Activities/Credit Memos
The resource that provides details of credit memos created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. It includes standard and on account credit memos.
Get a credit memo
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/creditMemos/{CreditMemoId}
Get all credit memos
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/creditMemos
Receivables Customer Account Site Activities/Standard Receipt Applications
The resource that provides details of standard receipt applications created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get a standard receipt application
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/standardReceiptApplications/{ApplicationId}
Get all standard receipt applications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/standardReceiptApplications
Receivables Customer Account Site Activities/Standard Receipt Applications/Credit Memo Applications Descriptive Flexfields
The resource that provides details of descriptive flexfields associated with the credit memo applications created against transactions belonging to customer account sites. This is a child resource to CreditMemoApplications, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/standardReceiptApplications/{ApplicationId2}/child/standardReceiptApplicationDFF/{ReceivableApplicationId}
Get all
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/standardReceiptApplications/{ApplicationId}/child/standardReceiptApplicationDFF
Receivables Customer Account Site Activities/Standard Receipts
The resource that provides details of standard receipts created for customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get a standard receipt
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/standardReceipts/{StandardReceiptId}
Get all standard receipts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/standardReceipts
Receivables Customer Account Site Activities/Transaction Adjustments
The resource that provides details of adjustments created against transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource.
Get a transaction adjustment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/transactionAdjustments/{AdjustmentId}
Get all transaction adjustments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/transactionAdjustments
Receivables Customer Account Site Activities/Transaction Payment Schedules
The resource that provides details of payment schedules for transactions belonging to customer account sites, which is part of the receivablesCustomerAccountSiteActivities root resource. Transactions include invoices, debit memos, and chargebacks.
Get a transaction payment schedule
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/transactionPaymentSchedules/{InstallmentId}
Get all transaction payment schedules
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/transactionPaymentSchedules
Receivables Customer Account Site Activities/Transactions Paid by Other Customers
The transactions paid by other customers resource provides details of receipt applications for transactions that are paid on behalf of the customer account.
Get a transaction paid by other customers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/transactionsPaidByOtherCustomers/{ApplicationId}
Get all transactions paid by other customers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesCustomerAccountSiteActivities/{BillToSiteUseId}/child/transactionsPaidByOtherCustomers
Receivables Disputes
The receivables disputes resource provides details of disputes created on a transaction.
Create a receivables dispute
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesDisputes
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesDisputes
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesDisputes/{receivablesDisputesUniqID}
Receivables Disputes/Receivables Dispute Lines
The receivables dispute lines resource provides details of disputes created on transaction lines.
Create a receivables line dispute
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesDisputes/{receivablesDisputesUniqID}/child/receivablesDisputeLines
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesDisputes/{receivablesDisputesUniqID}/child/receivablesDisputeLines
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesDisputes/{receivablesDisputesUniqID}/child/receivablesDisputeLines/{receivablesDisputeLinesUniqID}
Receivables Invoices
The receivables invoices resource is used to create, get, update, and delete a receivables invoice. Note: You can update only the InvoiceStatus, PaymentTerms, and TransactionDate attributes.
Create a receivables invoice
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices
Delete a receivables invoice
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}
Get a receivables invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}
Get all receivables invoices
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices
Update a receivables invoice
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}
Receivables Invoices/Receivables Invoice Attachments
The receivables invoice attachments resource is used to create, find, and delete the attachments associated with an invoice.
Create a receivables invoice attachment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/attachments
Get a receivables invoice attachment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/attachments/{attachmentsUniqID}
Get all attachments for a group of receivables invoices
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/attachments
Receivables Invoices/Receivables Invoice Attachments/Large Object (LOB) Attributes - File Contents
The contents of the attachment file.
Delete a File Contents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Receivables Invoices/Receivables Invoice Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Receivables Invoices/Receivables Invoice Descriptive Flexfields
The receivables invoice descriptive flexfields resource is used to create, get, find, and delete the descriptive flexfield values associated with an invoice.
Create a receivables invoice descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceDFF
Get a receivables invoice descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceDFF/{CustomerTrxId}
Get all descriptive flexfields for a group of receivables invoices
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceDFF
Receivables Invoices/Receivables Invoice Distributions
The receivables invoice distributions resource is used to create and get the invoice distributions associated to an invoice.
Create a receivables invoice distribution
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceDistributions
Get a receivables invoice distribution
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceDistributions/{DistributionId}
Get all invoice distributions for a receivables invoice
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceDistributions
Receivables Invoices/Receivables Invoice Distributions/Receivables Invoice Distribution Descriptive Flexfields
The receivables invoice distributions descriptive flexfields resource is used to create and get descriptive flexfield values associated with an invoice distribution.
Create a receivables invoice distribution descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceDistributions/{DistributionId}/child/receivablesInvoiceDistributionDFF
Get a receivables invoice distribution descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceDistributions/{DistributionId}/child/receivablesInvoiceDistributionDFF/{CustTrxLineGlDistId}
Get all descriptive flexfields for a group of receivables invoice distributions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceDistributions/{DistributionId}/child/receivablesInvoiceDistributionDFF
Receivables Invoices/Receivables Invoice Global Descriptive Flexfields
The receivables invoice global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with an invoice.
Create a receivables invoice global descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceGdf
Get a receivables invoice global descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceGdf/{CustomerTrxId}
Get all global descriptive flexfields for a group of receivables invoices
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceGdf
Receivables Invoices/Receivables Invoice Installments
The receivables invoice installments resource is used to edit and get the installments of an invoice. Note: You can update only the InstallmentDueDate and OriginalAmount attributes.
Get a receivables invoice installment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}
Get all installments for a group of receivables invoices
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments
Update a receivables invoice installment
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}
Receivables Invoices/Receivables Invoice Installments/Receivables Invoice Installment Global Descriptive Flexfields
The receivables invoice installment global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice installments.
Create a receivables invoice installment global descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentGDF
Get a receivables invoice installment global descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentGDF/{PaymentScheduleId}
Get all global descriptive flexfields for a group of receivables invoice installments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentGDF
Receivables Invoices/Receivables Invoice Installments/Receivables Invoice Installment Notes
The receivables invoice installment notes resource is used to create and find comments, information, or instructions on an invoice installment.
Create a receivables invoice installment note
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentNotes
Get a receivables invoice installment note
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentNotes/{NoteId}
Get all notes for a group of receivables invoice installments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentNotes
Receivables Invoices/Receivables Invoice Installments/Receivables Invoice Installment Notes/Large Object (LOB) Attributes - Note Text
The text of the note on the installment.
Delete a Note Text
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentNotes/{NoteId}/enclosure/NoteTxt
Get a Note Text
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentNotes/{NoteId}/enclosure/NoteTxt
Replace a Note Text
Method: put
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceInstallments/{InstallmentId}/child/receivablesInvoiceInstallmentNotes/{NoteId}/enclosure/NoteTxt
Receivables Invoices/Receivables Invoice Lines
The receivables invoice lines resource is used to create, get, find, and delete the lines of an invoice.
Create a receivables invoice line
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines
Get a receivables invoice line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}
Get all receivables invoice lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines
Receivables Invoices/Receivables Invoice Lines/Receivables Invoice Attachments
The attachments resource is used to view, create, and update attachments.
Create a receivables invoice attachment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/attachments
Get a receivables invoice attachment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/attachments/{attachmentsUniqID}
Get all attachments for a group of receivables invoices
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/attachments
Receivables Invoices/Receivables Invoice Lines/Receivables Invoice Attachments/Large Object (LOB) Attributes - File Contents
The contents of the attachment file.
Delete a File Contents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a File Contents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a File Contents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Receivables Invoices/Receivables Invoice Lines/Receivables Invoice Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Receivables Invoices/Receivables Invoice Lines/Receivables Invoice Line Descriptive Flexfields
The receivables invoice line descriptive flexfields resource is used to create, get, find, and delete the descriptive flexfield values associated with invoice lines.
Create a receivables invoice line descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineDFF
Get a receivables invoice line descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineDFF/{CustomerTrxLineId}
Get all descriptive flexfields for a group of receivables invoice lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineDFF
Receivables Invoices/Receivables Invoice Lines/Receivables Invoice Line Global Descriptive Flexfields
The receivables invoice line global descriptive flexfields resource is used to create, get, find, and delete the global descriptive flexfield values associated with invoice lines.
Create a receivables invoice line global descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineGdf
Get a receivables invoice line global descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineGdf/{CustomerTrxLineId}
Get all global descriptive flexfields for a group of receivables invoice lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineGdf
Receivables Invoices/Receivables Invoice Lines/Receivables Invoice Line Tax Lines
The receivables invoice line tax lines resource is used to create and get tax lines on an invoice.
Create a receivables invoice line tax line
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineTaxLines
Get a receivables invoice line tax line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineTaxLines/{CustomerTransactionLineId2}
Get all receivables invoice line tax lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineTaxLines
Receivables Invoices/Receivables Invoice Lines/Receivables Invoice Line Transaction Descriptive Flexfields
The receivables invoice line transaction descriptive flexfields resource is used to create, get, find, and delete the transaction descriptive flexfield values associated with invoice lines.
Create a receivables invoice line transaction descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineTransactionDFF
Get a receivables invoice line transaction descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineTransactionDFF/{CustomerTrxLineId}
Get all transaction descriptive flexfields for a group of receivables invoice lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceLines/{CustomerTransactionLineId}/child/receivablesInvoiceLineTransactionDFF
Receivables Invoices/Receivables Invoice Notes
The receivables invoice notes resource is used to capture, find, and delete the comments, information, or instructions on an invoice.
Create a receivables invoice note
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/notes
Get a receivables invoice note
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/notes/{NoteId}
Get all notes for a group of receivables invoices
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/notes
Receivables Invoices/Receivables Invoice Notes/Large Object (LOB) Attributes - Note Text
The text of the note on the invoice.
Delete a Note Text
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/notes/{NoteId}/enclosure/NoteTxt
Get a Note Text
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/notes/{NoteId}/enclosure/NoteTxt
Replace a Note Text
Method: put
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/notes/{NoteId}/enclosure/NoteTxt
Receivables Invoices/Receivables Invoice Transaction Descriptive Flexfields
The receivables invoice transaction descriptive flexfields resource is used to create, get, find, and delete the transaction descriptive flexfield values associated with an invoice.
Create a receivables invoice transaction descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceTransactionDFF
Get a receivables invoice transaction descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceTransactionDFF/{CustomerTrxId}
Get all transaction descriptive flexfields for a group of receivables invoices
Method: get
Path: /fscmRestApi/resources/11.13.18.05/receivablesInvoices/{CustomerTransactionId}/child/receivablesInvoiceTransactionDFF
Revenue Contracts
The revenue contracts resource is used to search for revenue contracts created in Revenue Management.
Get a revenue contract
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}
Get all revenue contracts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts
Revenue Contracts/Performance Obligations
The performance obligations resource is used to retrieve the performance obligations of a revenue contract.
Get a performance obligation
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}
Get all performance obligations
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations
Revenue Contracts/Performance Obligations/Performance Obligation Series
The performance obligation series resource is used to retrieve the series of a devolved performance obligation.
Get a performance obligation series
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/performanceObligationSeries/{DevolvedPerfObligDtlId}
Get all performance obligation series
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/performanceObligationSeries
Revenue Contracts/Performance Obligations/Promised Details
The promised detail resource is used to retrieve the promised detail lines of a performance obligation.
Get a promised detail
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/promisedDetails/{PromisedDetailLineId}
Get all promised details
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/promisedDetails
Revenue Contracts/Performance Obligations/Promised Details/Satisfaction Events
The satisfaction events resource is used to retrieve the satisfaction events for a promised detail.
Get a satisfaction event
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/promisedDetails/{PromisedDetailLineId}/child/satisfactionEvents/{SatisfactionEventId}
Get all satisfaction events
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/promisedDetails/{PromisedDetailLineId}/child/satisfactionEvents
Revenue Contracts/Performance Obligations/Promised Details/Source Documents
The source documents resource is used to retrieve source document details associated with a promised detail line.
Get a source document
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/promisedDetails/{PromisedDetailLineId}/child/sourceDocuments/{DocumentId}
Get all source documents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/promisedDetails/{PromisedDetailLineId}/child/sourceDocuments
Revenue Contracts/Performance Obligations/Promised Details/Source Documents/Source Document Lines
The source document lines resource is used to retrieve details of source document lines associated with a promised detail line.
Get a source document line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/promisedDetails/{PromisedDetailLineId}/child/sourceDocuments/{DocumentId}/child/sourceDocumentLines/{DocumentLineId}
Get all source document lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/promisedDetails/{PromisedDetailLineId}/child/sourceDocuments/{DocumentId}/child/sourceDocumentLines
Revenue Contracts/Performance Obligations/Promised Details/Source Documents/Source Document Lines/Source Document Sublines
The source document sublines resource is used to retrieve details of source document sublines associated with a promised detail line.
Get a source document subline
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/promisedDetails/{PromisedDetailLineId}/child/sourceDocuments/{DocumentId}/child/sourceDocumentLines/{DocumentLineId}/child/sourceDocumentSubLines/{DocumentSubLineId}
Get all source document sublines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/revenueContracts/{CustomerContractHeaderId}/child/performanceObligations/{PerformanceObligationId}/child/promisedDetails/{PromisedDetailLineId}/child/sourceDocuments/{DocumentId}/child/sourceDocumentLines/{DocumentLineId}/child/sourceDocumentSubLines
Salesperson Reference Accounts
The receivables salesperson reference accounts resource is used to create, get, find, and delete a reference account associated with a salesperson.
Create a salesperson reference account
Method: post
Path: /fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts
Delete a salesperson reference account
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts/{salespersonReferenceAccountsUniqID}
Get a salesperson reference account
Method: get
Path: /fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts/{salespersonReferenceAccountsUniqID}
Get all salesperson reference accounts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts
Standard Receipts
The standard receipts resource is used to create standard receipts in Receivables to record payment from customers for goods received or services rendered. Standard receipts can be applied to one or more transactions. One or more remittance references can also be provided for applying the receipt to the transactions when the Apply Receipts Using AutoMatch process is run asynchronously.
Create a standard receipt
Method: post
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts
Delete a standard receipt
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}
Get a standard receipt
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}
Get all standard receipts
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts
Update a standard receipt
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}
Standard Receipts/Attachments
The attachments resource is used to add one or more attachments to a standard receipt.
Create a standard receipt attachment
Method: post
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/attachments
Get a standard receipt attachment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/attachments/{attachmentsUniqID}
Get all standard receipt attachments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/attachments
Standard Receipts/Attachments/Large Object (LOB) Attributes - FileContents
Delete a FileContents
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Get a FileContents
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Replace a FileContents
Method: put
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/attachments/{attachmentsUniqID}/enclosure/FileContents
Standard Receipts/Attachments/Large Object (LOB) Attributes - FileWebImage
Get a FileWebImage
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/attachments/{attachmentsUniqID}/enclosure/FileWebImage
Standard Receipts/Remittance References
The remittance references resource is used to add one or more remittance references to a standard receipt.
Create a remittance reference
Method: post
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/remittanceReferences
Get a remittance reference
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/remittanceReferences/{RemittanceReferenceId}
Get all remittance references
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/remittanceReferences
Standard Receipts/Standard Receipt Descriptive Flexfields
The standard receipts DFF resource is used to add one or more descriptive flexfield values to a standard receipt.
Create a standard receipt descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/standardReceiptDFF
Get a standard receipt descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/standardReceiptDFF/{CashReceiptId}
Get all standard receipt descriptive flexfields
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/standardReceiptDFF
Standard Receipts/Standard Receipt Global Descriptive Flexfields
The standard receipts GDF resource is used to add one or more global descriptive flexfield values to a standard receipt.
Create a standard receipt global descriptive flexfield
Method: post
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/standardReceiptGdf
Get a standard receipt global descriptive flexfield
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/standardReceiptGdf/{CashReceiptId}
Get all standard receipt global descriptive flexfields
Method: get
Path: /fscmRestApi/resources/11.13.18.05/standardReceipts/{StandardReceiptId}/child/standardReceiptGdf
Tax Authority Profiles
The tax authority profiles resource is used to query tax authority profiles.
Get a tax authority profile
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxAuthorityProfiles/{PartyTaxProfileId}
Get all tax authority profiles
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxAuthorityProfiles
Tax Exemptions
The tax exemptions resource is used to query, update, and create tax exemptions.
Create a tax exemption
Method: post
Path: /fscmRestApi/resources/11.13.18.05/taxExemptions
Get a tax exemption
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxExemptions/{TaxExemptionId}
Get all tax exemptions
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxExemptions
Update a tax exemption
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/taxExemptions/{TaxExemptionId}
Tax Intended Uses
The tax intended uses resource is used to retrieve intended use fiscal classification records.
Get all intended use fiscal classification records
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxIntendedUses
Get an intended use fiscal classification record
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxIntendedUses/{ClassificationName}
Tax Partner Registrations
The tax partner registrations resource is used to create a tax partner. The tax partner's tax calculation application is used for determining transaction tax.
Create a tax partner for tax calculation integration
Method: post
Path: /fscmRestApi/resources/11.13.18.05/taxPartnerRegistrations
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxPartnerRegistrations
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxPartnerRegistrations/{OperationName}
Tax Product Categories
The tax product categories resource is used to retrieve existing product categories.
Get a product category
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxProductCategories/{ClassificationName}
Get all product categories
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxProductCategories
Tax Registrations
The tax registrations resource is used to query, update, and create tax registrations.
Create a tax registration
Method: post
Path: /fscmRestApi/resources/11.13.18.05/taxRegistrations
Get a tax registration
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxRegistrations/{RegistrationId}
Get all tax registrations
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxRegistrations
Update a tax registration
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/taxRegistrations/{RegistrationId}
Tax Reporting Entities
The payables tax reporting entities resource is used to manage details about the reporting entities that are required for 1099 reporting.
Get a single tax reporting entity
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesTaxReportingEntities/{payablesTaxReportingEntitiesUniqID}
Get all tax reporting entities
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesTaxReportingEntities
Tax Reporting Entities/Tax Reporting Entity Lines
The payables tax reporting entity lines resource is used to manage details about the tax reporting of entity lines. A reporting entity may be defined with a single balancing segment line for each organization or with multiple lines to combine 1099 reporting for the entire organizations.
Get all tax reporting entity lines for a tax reporting entity
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesTaxReportingEntities/{payablesTaxReportingEntitiesUniqID}/child/payablesTaxReportingEntityLine
Get tax reporting entity lines for a tax reporting entity
Method: get
Path: /fscmRestApi/resources/11.13.18.05/payablesTaxReportingEntities/{payablesTaxReportingEntitiesUniqID}/child/payablesTaxReportingEntityLine/{payablesTaxReportingEntityLineUniqID}
Tax Transaction Business Categories
The tax transaction business categories resource is used to retrieve transaction business categories.
Get a transaction business category
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxTransactionBusinessCategories/{ClassificationName}
Get all transaction business categories
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxTransactionBusinessCategories
Taxpayer Identifiers
The taxpayer identifiers resource is used to query, update, and create taxpayer identifiers.
Create a taxpayer identifier
Method: post
Path: /fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers
Get a taxpayer identifier
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers/{PartyTaxpayerIdntfsId}
Get all taxpayer identifiers
Method: get
Path: /fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers
Update a taxpayer identifier
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/taxPayerIdentifiers/{PartyTaxpayerIdntfsId}
Third Party Fiscal Classifications
The third-party fiscal classifications resource contains details of the association between third parties, such as supplier or customer, and their fiscal classifications.
Create a third-party fiscal classification
Method: post
Path: /fscmRestApi/resources/11.13.18.05/thirdPartyFiscalClassifications
Get a third-party fiscal classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/thirdPartyFiscalClassifications/{CodeAssignmentId}
Get all third-party fiscal classifications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/thirdPartyFiscalClassifications
Update a third-party fiscal classification
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/thirdPartyFiscalClassifications/{CodeAssignmentId}
Third Party Site Fiscal Classifications
The third-party site fiscal classifications resource contains details about the association between third-party sites, such as supplier site or customer site, and their fiscal classifications.
Create a third-party site fiscal classification
Method: post
Path: /fscmRestApi/resources/11.13.18.05/thirdPartySiteFiscalClassifications
Get a third-party site fiscal classification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/thirdPartySiteFiscalClassifications/{CodeAssignmentId}
Get all third-party site fiscal classifications
Method: get
Path: /fscmRestApi/resources/11.13.18.05/thirdPartySiteFiscalClassifications
Update a third-party site fiscal classification
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/thirdPartySiteFiscalClassifications/{CodeAssignmentId}
Third-Party Site Tax Reporting Code Associations
The third-party site tax reporting code associations resource contains details of the association between third party sites and the reporting codes.
Create a third-party site tax reporting code association
Method: post
Path: /fscmRestApi/resources/11.13.18.05/thirdPartySiteTaxReportingCodeAssociations
Get a third-party site tax reporting code association
Method: get
Path: /fscmRestApi/resources/11.13.18.05/thirdPartySiteTaxReportingCodeAssociations/{ReportingCodeAssocId}
Get all third-party site tax reporting code associations
Method: get
Path: /fscmRestApi/resources/11.13.18.05/thirdPartySiteTaxReportingCodeAssociations
Update a third-party site tax reporting code association
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/thirdPartySiteTaxReportingCodeAssociations/{ReportingCodeAssocId}
Third-Party Tax Reporting Code Associations
The third-party tax reporting code associations resource contains details of the association between third parties and the reporting codes.
Create a third-party tax reporting code association
Method: post
Path: /fscmRestApi/resources/11.13.18.05/thirdPartyTaxReportingCodeAssociations
Get a third-party tax reporting code association
Method: get
Path: /fscmRestApi/resources/11.13.18.05/thirdPartyTaxReportingCodeAssociations/{ReportingCodeAssocId}
Get all third-party tax reporting code associations
Method: get
Path: /fscmRestApi/resources/11.13.18.05/thirdPartyTaxReportingCodeAssociations
Update a third-party tax reporting code association
Method: patch
Path: /fscmRestApi/resources/11.13.18.05/thirdPartyTaxReportingCodeAssociations/{ReportingCodeAssocId}
Transaction Tax Lines
The transaction tax lines resource is used to get, insert, and update a manual tax line.
Get a transaction tax line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/transactionTaxLines/{TaxLineId}
Get all transaction tax lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/transactionTaxLines
Withholding Tax Lines
The withholding tax lines resource is used to view, create and update a withholding tax line.
Get a withholding tax line
Method: get
Path: /fscmRestApi/resources/11.13.18.05/withholdingTaxLines/{TaxLineId}
Get all withholding tax lines
Method: get
Path: /fscmRestApi/resources/11.13.18.05/withholdingTaxLines
Workflow Notification Contents
The workflow notification content resource is used to view the workflow notifications.
Get a workflow notification
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}
GET action not supported
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents
Retrieve task ID
Method: post
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/action/retrieveTaskId
Workflow Notification Contents/Approval Activities
The approval activity resource is used to view the actions performed by users on tasks.
Get all approval activities
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/child/ApprovalActivities
Get an approval activity
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/child/ApprovalActivities/{SequenceNumber}
Workflow Notification Contents/Approval Activities/Attachments
The attachments resource is used to view the attachments added by users.
Get all attachments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/child/ApprovalActivities/{SequenceNumber}/child/Attachments
Get an attachment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/child/ApprovalActivities/{SequenceNumber}/child/Attachments/{AttachmentSequenceNo}
Workflow Notification Contents/Approval Activities/Comments
The comments resource is used to view the comments added by users.
Get a comment
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/child/ApprovalActivities/{SequenceNumber}/child/Comments/{CommentSequenceNo}
Get all comments
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/child/ApprovalActivities/{SequenceNumber}/child/Comments
Workflow Notification Contents/Large Object (LOB) Attributes - approvalHistory
Delete an approvalHistory
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/approvalHistory
Get an approvalHistory
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/approvalHistory
Replace an approvalHistory
Method: put
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/approvalHistory
Workflow Notification Contents/Large Object (LOB) Attributes - bipReportParameters
Delete a bipReportParameters
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/bipReportParameters
Get a bipReportParameters
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/bipReportParameters
Replace a bipReportParameters
Method: put
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/bipReportParameters
Workflow Notification Contents/Large Object (LOB) Attributes - notificationBody
Delete a notificationBody
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/notificationBody
Get a notificationBody
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/notificationBody
Replace a notificationBody
Method: put
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/notificationBody
Workflow Notification Contents/Large Object (LOB) Attributes - workflowTaskSequence
Delete a workflowTaskSequence
Method: delete
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/workflowTaskSequence
Get a workflowTaskSequence
Method: get
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/workflowTaskSequence
Replace a workflowTaskSequence
Method: put
Path: /fscmRestApi/resources/11.13.18.05/workflowNotificationContents/{taskId}/enclosure/workflowTaskSequence