Joint Ventures API

https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/
Admin
This project documents the API for managing joint ventures, including financial transactions,...
Tokens:32,934,676
Snippets:487,060
Trust Score:9.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Started

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/Resource_Types.html

This section provides guidance on how to get started with the REST API for Oracle Fusion Cloud Financials, including quick start information and use cases.

```APIDOC
## Get Started

### Description
This section provides guidance on how to get started with the REST API for Oracle Fusion Cloud Financials, including quick start information and use cases.

#### Quick Start
- **Purpose**: Provides a quick start guide for using the REST API.

#### Use Cases
- **Purpose**: Details various use cases for the REST API.
```

--------------------------------

### Get all setup options

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/api-federal-setup-options.html

Retrieves a list of all federal setup options.

```APIDOC
## GET /fscmRestApi/resources/11.13.18.05/fedSetupOptions

### Description
Retrieves a list of all federal setup options.

### Method
GET

### Endpoint
/fscmRestApi/resources/11.13.18.05/fedSetupOptions
```

--------------------------------

### GET Method Example URL

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/Resource_Methods.html

This example URL demonstrates how to use the 'expand' parameter with the GET method to retrieve child resources along with the parent resource.

```HTTP
Copy/fscmRestApi/resources/<version>/invoices/359240?expand=invoiceLines
```

--------------------------------

### Get Setup Options

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-fedsetupoptions-post.html

Retrieves a list of setup options with detailed information.

```APIDOC
## GET /fedSetupOptions

### Description
Retrieves a list of federal setup options.

### Method
GET

### Endpoint
/fedSetupOptions

### Response
#### Success Response (200)
- **AgencyAbbreviation** (string) - Agency abbreviation of the setup option.
- **BusinessUnit** (string) - Business unit of the setup option.
- **ConfigOptionId** (integer) - Unique identifier of the setup option.
- **CreatedBy** (string) - User who created the record.
- **CreationDate** (string) - Date when the record was created.
- **DefaultDiscountLostReason** (string) - Default discount lost reason for the setup option.
- **DefaultInterestReason** (string) - Default interest reason for the setup option.
- **FederalEmployerNumber** (integer) - Federal employer ID for the setup option.
- **fedSetupOptionDFF** (array) - Descriptive Flexfields for the setup option.
- **LastUpdateDate** (string) - Date when the record was last updated.
- **LastUpdatedBy** (string) - User who last updated the record.
- **LastUpdateLogin** (string) - The session login associated to the user who last updated the record.
- **links** (array) - The link relations associated with the resource instance.
- **PamInputSystemName** (string) - The name of the PAM input system associated with the setup option.
- **SAMDefaultBank** (string) - SAM default bank for the setup option.
- **SAMDefaultBranch** (string) - SAM default branch for the setup option.

### Response Example
{
  "AgencyAbbreviation": "ABC",
  "BusinessUnit": "US1",
  "ConfigOptionId": 12345,
  "CreatedBy": "user1",
  "CreationDate": "2023-10-27T10:00:00Z",
  "DefaultDiscountLostReason": "Discount too high",
  "DefaultInterestReason": "Market rate",
  "FederalEmployerNumber": 123456789,
  "fedSetupOptionDFF": [],
  "LastUpdateDate": "2023-10-27T10:00:00Z",
  "LastUpdatedBy": "user1",
  "LastUpdateLogin": "session123",
  "links": [],
  "PamInputSystemName": "PAM_SYS",
  "SAMDefaultBank": "Bank of Example",
  "SAMDefaultBranch": "Main Branch"
}
```

--------------------------------

### Get Started with REST APIs

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-stakeholdergroups-stakeholdergroupid-child-stakeholderpercentages-stakeholderpercentageid-child-stakeholderpercentagedff-grouplineid-patch.html

Provides introductory information and guidance on getting started with the Oracle Fusion Cloud Financials REST APIs.

```APIDOC
## Get Started

### Description
This section provides guidance on how to get started with the Oracle Fusion Cloud Financials REST APIs, including quick start information and use cases.
```

--------------------------------

### Get all setup option records

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-autoinvoiceinterfacelines-interfacelineguid-child-autoinvoiceinterfacelinetransactiondff-interfacelineguid-get.html

Retrieves all system setup option records.

```APIDOC
## GET /expenses/system-options

### Description
Retrieves all system setup option records.

### Method
GET

### Endpoint
/expenses/system-options

### Response
#### Success Response (200)
- **optionRecords** (array) - A list of system setup option records.
```

--------------------------------

### Quick Start

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-workflownotificationcontents-taskid-enclosure-notificationbody-get.html

This section offers a quick start guide for users new to the REST API for Oracle Fusion Cloud Financials.

```APIDOC
## Quick Start

### Description
This guide provides essential steps and information for users to quickly begin interacting with the REST API for Oracle Fusion Cloud Financials.
```

--------------------------------

### Get all foreign exchange revaluation setup

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-workflownotificationcontents-taskid-get.html

Retrieves a list of all foreign exchange transfer setups. Note: This appears to be a duplicate of the revaluation setup retrieval.

```APIDOC
## GET /foreignexchange/fx/transfer/setups

### Description
Retrieves a list of all foreign exchange transfer setups. Note: This appears to be a duplicate of the revaluation setup retrieval.

### Method
GET

### Endpoint
/foreignexchange/fx/transfer/setups
```

--------------------------------

### Retrieve Workflow Users with Basic Search

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-workflowusers-get.html

This example demonstrates how to perform a basic search for workflow users by including a search string in the GET request. Replace placeholders as needed.

```shell
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/workflowUsers?finder=basicSearch;searchString=finuser
```

--------------------------------

### Get Tax Configurations

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-validatetaxconfigurations-operationname-get.html

Retrieves detailed information about tax configurations, including counts of taxes, jurisdictions, rates, regimes, and statuses, along with geography and subscription data. This endpoint is useful for validating the completeness and correctness of tax setups.

```APIDOC
## GET /websites/oracle_en_cloud_saas_financials_26b_farfa/op-validatetaxconfigurations-operationname-get

### Description
Retrieves detailed information about tax configurations, including counts of taxes, jurisdictions, rates, regimes, and statuses, along with geography and subscription data. This endpoint is useful for validating the completeness and correctness of tax setups.

### Method
GET

### Endpoint
/websites/oracle_en_cloud_saas_financials_26b_farfa/op-validatetaxconfigurations-operationname-get

### Parameters
#### Query Parameters
- **BusinessUnitId** (string) - Optional - The unique identifier of the business unit.
- **CountryCode** (string) - Optional - The country code of the tax configuration.
- **OperationName** (string) - Optional - Name of the operation that indicates the requested information, such as jurisdiction count or tax status count.

### Response
#### Success Response (200)
- **BusinessUnitId** (string) - The unique identifier of the business unit.
- **CountryCode** (string) - The country code of the tax configuration.
- **GeographyDataCountList** (string) - List of geography counts by geography type, use, and module.
- **GeographyProviderList** (string) - Number of geography providers defined for a tax configuration.
- **GeographyStructureList** (string) - List of geography structures defined for a tax configuration.
- **OperationName** (string) - Name of the operation that indicates the requested information, such as jurisdiction count or tax status count.
- **RegimeSubscriptionsList** (string) - Number of regime subscriptions defined for a tax configuration.
- **TaxConfigOptionsList** (string) - Number of tax options defined for a configuration owner.
- **TaxCountList** (string) - Number of taxes defined for a tax configuration.
- **TaxJurisdictionCountList** (string) - Number of tax jurisdictions defined for a tax configuration.
- **TaxRateCountList** (string) - Number of tax rates defined for a tax configuration.
- **TaxRegimeCode** (string) - Tax regime code for the tax configuration.
- **TaxRegimeCountList** (string) - Number of tax regimes defined for a tax configuration.
- **TaxStatusCountList** (string) - Number of tax statuses defined for a tax configuration.
- **links** (array) - The link relations associated with the resource instance.

#### Response Example
{
  "BusinessUnitId": "string",
  "CountryCode": "string",
  "GeographyDataCountList": "string",
  "GeographyProviderList": "string",
  "GeographyStructureList": "string",
  "OperationName": "string",
  "RegimeSubscriptionsList": "string",
  "TaxConfigOptionsList": "string",
  "TaxCountList": "string",
  "TaxJurisdictionCountList": "string",
  "TaxRateCountList": "string",
  "TaxRegimeCode": "string",
  "TaxRegimeCountList": "string",
  "TaxStatusCountList": "string",
  "links": [
    {
      "href": "string",
      "kind": "string",
      "name": "string",
      "properties": {},
      "rel": "string"
    }
  ]
}
```

--------------------------------

### Workflow User Response Body Example

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-workflowusers-personid-get.html

This is an example of the JSON response body when successfully retrieving a workflow user. It contains user details and links to related resources.

```json
{
      "Username": "1/1/1980",
      "FirstName": null,
      "LastName": "1/1/1980",
      "EmailAddress": null,
      "ManagerName": null,
      "WorkflowName": null,
      "TransactionIdentifier": null,
      "LoggedInUser": "FINUSER2",
      "PersonId": "300100129313477",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/workflowUsers/300100129313477",
          "name": "workflowUsers",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/workflowUsers/300100129313477",
          "name": "workflowUsers",
          "kind": "item"
        }
	    ]
 }
```

--------------------------------

### Get Tax Configurations

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-validatetaxconfigurations-operationname-get.html

Retrieves tax configurations for validation. This operation allows you to check the current tax setup.

```APIDOC
## GET /op/validatetaxconfigurations

### Description
Retrieves tax configurations for validation. This operation allows you to check the current tax setup.

### Method
GET

### Endpoint
/op/validatetaxconfigurations

### Parameters
#### Query Parameters
- **operationName** (string) - Required - The name of the operation to validate.

### Response
#### Success Response (200)
- **message** (string) - A message indicating the status of the tax configuration validation.

#### Response Example
{
  "message": "Tax configurations validated successfully."
}
```

--------------------------------

### Example Response Body for Transfer Authorization DFF Creation

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-transferauthorizationgroups-transferauthorizationgroupid-child-transferauthorizations-transferauthorizationid-child-transferauthorizationdff-post.html

This is an example of a successful response when creating transfer authorization descriptive flexfields. It includes the resource ID, flexfield context, and associated links.

```json
{
    "TransferAuthorizationId": "300100581736070",
    "__FLEX_Context": "TransferType",
    "__FLEX_Context_DisplayValue": "TransferType",
    "transfertype": "Interest Amount",
    "@context": {
        "key": "300100581736070",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/300100581686169/child/transferAuthorizationGroups/300100581736069/child/transferAuthorizations/300100581736070/child/transferAuthorizationDFF/300100581736070",
                "name": "transferAuthorizationDFF",
                "kind": "item"
            }
           ...
        ]
    }
}
```

--------------------------------

### Get Value Sets

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-withholdingtaxlines-taxlineid-get.html

Retrieves all value sets.

```APIDOC
## GET /value-sets

### Description
Retrieves a list of all value sets.

### Method
GET

### Endpoint
/value-sets

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Specifies the fields to be included in the response.

### Response
#### Success Response (200)
- **items** (array) - A list of value sets.
```

--------------------------------

### Get a BudgetTransactionPayload

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-withholdingtaxgroupslov-groupid-get.html

Retrieves a BudgetTransactionPayload.

```APIDOC
## GET /budget-transactions/{budgetTransactionId}/lob-attributes

### Description
Retrieves the details of a BudgetTransactionPayload for a specific budget transaction.

### Method
GET

### Endpoint
/budget-transactions/{budgetTransactionId}/lob-attributes

### Parameters
#### Path Parameters
- **budgetTransactionId** (string) - Required - The ID of the budget transaction.
```

--------------------------------

### Conditionally Get Resource (If-None-Match)

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/verify_your_resource_using_the_etag_value.html

Use the If-None-Match header with a GET request to retrieve new content only if the resource has been modified since the ETag was last obtained. A 200 OK indicates modification, while a 304 Not Modified indicates no changes.

```APIDOC
## GET /hcmRestApi/resources/11.13.18.05/workers/{workerId}

### Description
Conditionally retrieves a worker resource. Returns the resource only if the ETag in the If-None-Match header does not match the current ETag of the resource.

### Method
GET

### Endpoint
/hcmRestApi/resources/11.13.18.05/workers/{workerId}

### Parameters
#### Path Parameters
- **workerId** (string) - Required - The unique identifier of the worker.
#### Request Headers
- **If-None-Match** (string) - Required - The ETag value to compare against the resource's current ETag.

### Response
#### Success Response (200 OK)
- The requested resource is modified and returned in the response body.

#### Success Response (304 Not Modified)
- The requested resource is not modified. An empty response body is returned.
```

--------------------------------

### Get Currencies

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-withholdingtaxlines-taxlineid-get.html

Retrieves all currencies.

```APIDOC
## GET /currencies

### Description
Retrieves a list of all currencies.

### Method
GET

### Endpoint
/currencies

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Specifies the fields to be included in the response.

### Response
#### Success Response (200)
- **items** (array) - A list of currencies.
```

--------------------------------

### Get Started with REST API for Oracle Fusion Cloud Financials

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-collectionstrategies-strategyid-child-strategyusertasks-post.html

Information on how to get started with the REST API for Oracle Fusion Cloud Financials, including quick start guides and use cases.

```APIDOC
## Get Started

### Description
Guidance on how to begin using the REST API for Oracle Fusion Cloud Financials.

### Sections

#### Quick Start
- **Description**: A concise guide to get you started quickly with the API.

#### Use Cases
- **Description**: Examples and explanations of how to leverage the API for various financial tasks.
  - Automated Intercompany Cross Charge of Payables Invoices Using REST APIs
  - Enable Business Events
  - Export Financials Data
  - Import Financials Data
  - LOV REST API Privileges
  - Manage AutoInvoice Interface Lines
  - Manage Bank Accounts
  - Manage Bill Management Users
  - Manage Cash Pools
  - Manage ERP Data Integrations
  - Manage Expense Travel Itineraries
  - Manage Fixed Assets REST Operations
```

--------------------------------

### Example JSON Response

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/Get_Specific_Details_for_Invoices_and_Installments.html

This is a sample JSON response body for the GET request. It shows the structure of the returned data, including invoice details and their corresponding installment information such as UnpaidAmount and PaymentMethod.

```JSON
{
  "items": [
    {
      "InvoiceId": 338908,
      "InvoiceNumber": "Withholding tax - 300100151967070-2",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 50,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 339908,
      "InvoiceNumber": "Withholding tax - 300100152264186-2",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 80,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 338909,
      "InvoiceNumber": "Withholding tax - 300100152264179-2",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 200,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 338910,
      "InvoiceNumber": "Withholding tax - 300100152264183-2",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 30,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 339909,
      "InvoiceNumber": "Withholding tax - 300100152264213-2",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 150,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 300100152264213,
      "InvoiceNumber": "TH_05",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 0,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 300100152264186,
      "InvoiceNumber": "TH_04",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 0,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 300100152264179,
      "InvoiceNumber": "TH_02",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 0,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 300100151967070,
      "InvoiceNumber": "TH_01",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 0,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 300100152264183,
      "InvoiceNumber": "TH_03",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 0,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 361908,
      "InvoiceNumber": "Withholding tax - 300100171617230-4",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 5,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 361909,
      "InvoiceNumber": "Withholding tax - 300100171617230-6",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 1,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 361910,
      "InvoiceNumber": "Withholding tax - 300100171617230-5",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 10,
          "PaymentMethod": "Check"
        }
      ]
    },
    {
      "InvoiceId": 300100171617230,
      "InvoiceNumber": "WHT_181016_1",
      "PayGroup": null,
      "invoiceInstallments": [
        {
          "UnpaidAmount": 0,
          "PaymentMethod": "Check"
        }
      ]
    }
  ]
}
```

--------------------------------

### Get All Invoice Installments

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-invoices-invoicesuniqid-child-invoiceinstallments-invoiceinstallmentsuniqid-get.html

Retrieves all invoice installments associated with a specific invoice. This endpoint is useful for getting a collection of installment records.

```APIDOC
## GET /fscmRestApi/resources/11.13.18.05/invoices/{InvoiceId}/child/invoiceInstallments

### Description
Retrieves a collection of all invoice installments for a given invoice.

### Method
GET

### Endpoint
/fscmRestApi/resources/11.13.18.05/invoices/{InvoiceId}/child/invoiceInstallments

### Parameters
#### Path Parameters
- **InvoiceId** (string) - Required - The unique identifier of the invoice.

### Request Example
```bash
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments
```

### Response
#### Success Response (200)
- **items** (array) - A list of invoice installment objects.
- **count** (integer) - The number of invoice installments returned.
- **hasMore** (boolean) - Indicates if there are more installments than returned in this request.
- **limit** (integer) - The maximum number of installments that can be returned in a single request.
- **offset** (integer) - The offset used for pagination.
- **links** (array) - Links related to the collection.

#### Response Example
```json
{
    "items": [
        {
            "InstallmentNumber": 1,
            "UnpaidAmount": 0,
            "FirstDiscountAmount": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments/00020000000EACED00057708000110F0818EBB290000000EACED000577080000000000000001",
                    "name": "invoiceInstallments",
                    "kind": "item"
                }
           ]
        }
    ],
    "count": 10,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/invoices/300100128521001/child/invoiceInstallments",
            "name": "invoiceInstallments",
            "kind": "collection"
        }
    ]
}
```
```

--------------------------------

### Get All Receivables Invoice Installment Notes

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-receivablesinvoices-customertransactionid-child-receivablesinvoiceinstallments-installmentid-child-receivablesinvoiceinstallmentnotes-get.html

Retrieves all notes associated with a receivables invoice installment. This is useful for getting a complete history of notes for an installment.

```APIDOC
## GET /invoices/{customerTransactionId}/receivablesInvoices/{receivablesInvoiceId}/installments/{receivablesInvoiceInstallmentId}/notes

### Description
Retrieves all notes associated with a receivables invoice installment.

### Method
GET

### Endpoint
/invoices/{customerTransactionId}/receivablesInvoices/{receivablesInvoiceId}/installments/{receivablesInvoiceInstallmentId}/notes

### Parameters
#### Path Parameters
- **customerTransactionId** (string) - Required - The ID of the customer transaction.
- **receivablesInvoiceId** (string) - Required - The ID of the receivables invoice.
- **receivablesInvoiceInstallmentId** (string) - Required - The ID of the receivables invoice installment.

### Response
#### Success Response (200)
- **items** (array) - A list of notes.
  - **noteId** (string) - The ID of the note.
  - **noteText** (string) - The content of the note.
  - **creationDate** (string) - The date the note was created.
  - **createdBy** (string) - The user who created the note.

#### Response Example
{
  "items": [
    {
      "noteId": "NOTE123",
      "noteText": "Payment due in 30 days.",
      "creationDate": "2023-10-27T10:00:00Z",
      "createdBy": "user1"
    },
    {
      "noteId": "NOTE456",
      "noteText": "Follow up required.",
      "creationDate": "2023-10-28T11:00:00Z",
      "createdBy": "user2"
    }
  ]
}
```

--------------------------------

### Response Body Example for Get Factor Value

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-jointventureperiodicadjustmentfactors-factorid-child-factorvalues-valueid-get.html

This JSON structure represents a successful response when retrieving a factor value. It includes details such as value ID, start date, percentage, and application status.

```json
{
  "valueId": 300100572162904,
  "valueStartDate": "2023-02-15",
  "valuePercentage": 80,
  "valueAppliedFlag": false,
  "createdBy": "username",
  "creationDate": "2023-02-17T05:01:28+00:00",
  "lastUpdatedBy": "username",
  "lastUpdateDate": "2023-02-17T05:01:28.006+00:00",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVenturePeriodicAdjustmentFactors/300100572162877/child/factorValues/300100572162904",
      "name": "factorValues",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVenturePeriodicAdjustmentFactors/300100572162877/child/factorValues/300100572162904",
      "name": "factorValues",
      "kind": "item"
    },
    {
      "rel": "parent",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVenturePeriodicAdjustmentFactors/300100572162877",
      "name": "jointVenturePeriodicAdjustmentFactors",
      "kind": "item"
    }
  ]
}
```

--------------------------------

### Get all setup options

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/op-fedsetupoptions-get.html

Retrieves a collection of setup options. This endpoint supports various query parameters for filtering, sorting, and expanding related resources.

```APIDOC
## GET /fscmRestApi/resources/11.13.18.05/fedSetupOptions

### Description
Retrieves a collection of setup options. This endpoint supports various query parameters for filtering, sorting, and expanding related resources.

### Method
GET

### Endpoint
/fscmRestApi/resources/11.13.18.05/fedSetupOptions

### Parameters
#### Query Parameters
- **expand** (string) - Optional - When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
- **fields** (string) - Optional - This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered. Format: ?fields=Attribute1,Attribute2 Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
- **finder** (string) - Optional - Used as a predefined finder to search the collection. Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2> The following are the available finder names and corresponding finder variables: PrimaryKey Finds the setup option that matches the primary key specified. Finder Variables: ConfigOptionId; integer; Unique identifier for the setup option.
- **limit** (integer) - Optional - This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
- **links** (string) - Optional - This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation> Example: self,canonical
- **offset** (integer) - Optional - Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
- **onlyData** (boolean) - Optional - The resource item payload will be filtered in order to contain only data (no links section, for example).
- **orderBy** (string) - Optional - This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
- **q** (string) - Optional - This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY Format: ?q=expression1;expression2 You can use these queryable attributes to filter this collection resource using the q query parameter:

### Request Example
(No example provided in source)

### Response
#### Success Response (200)
(No specific fields documented in source)

#### Response Example
(No example provided in source)
```

--------------------------------

### Example GET Request for Opportunities with Sorting

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/Collections.html

Demonstrates how to sort opportunities by 'OptyId' in ascending order using the 'orderBy' query parameter.

```http
GET /opportunities?orderBy=OptyId
```

--------------------------------

### Example Response for Updating Invoice Installments

Source: https://docs.oracle.com/en/cloud/saas/financials/26b/farfa/Update_Installments_on_an_Invoice.html

This is an example of a successful response when updating invoice installments. It includes various details about the invoice, such as CustomerTransactionId, TransactionNumber, and the updated installment information.

```json
{
    "CustomerTransactionId": 300100169169047,
    "DueDate": "2018-02-20",
    "ConversionDate": null,
    "ConversionRate": null,
    "InvoiceCurrencyCode": "USD",
    "SpecialInstructions": null,
    "CrossReference": null,
    "DocumentNumber": null,
    "TransactionNumber": "864",
    "TransactionDate": "2018-02-20",
    "TransactionType": "Invoice",
    "TransactionSource": "Manual-NES",
    "BillToCustomerNumber": "1008",
    "BillToSite": "Foster City (OPS)",
    "Comments": "New Laptop Promotion",
    "InternalNotes": "Best Priced item",
    "PaymentTerms": "30/60/90",
    "LegalEntityIdentifier": "USSYS12030",
    "ConversionRateType": null,
    "PurchaseOrder": null,
    "PurchaseOrderDate": null,
    "PurchaseOrderRevision": null,
    "FirstPartyRegistrationNumber": "4567890",
    "ThirdPartyRegistrationNumber": null,
    "InvoicingRule": null,
    "ShipToCustomerName": "Total Internet",
    "ShipToCustomerNumber": "1008",
    "BillingDate": "2018-02-20",
    "BusinessUnit": "Vision Operations",
    "InvoiceStatus": "Complete",
    "AccountingDate": "2018-02-20",
    "ShipToSite": "1042",
    "PayingCustomerName": "Total Internet",
    "PayingCustomerSite": "Foster City (OPS)",
    "BillToCustomerName": "Total Internet",
    "FreightAmount": null,
    "Carrier": null,
    "ShipDate": null,
    "ShippingReference": null,
    "BillToContact": null,
    "ShipToContact": null,
    "PrintOption": "Yes",
    "CreatedBy": "AR_MGR_OPERATIONS",
    "CreationDate": "2018-11-23T08:53:33.019+00:00",
    "LastUpdatedBy": "AR_MGR_OPERATIONS",
    "LastUpdateDate": "2018-11-23T09:22:18+00:00",
    "PayingCustomerAccount": "1008",
    "SoldToPartyNumber": "1008",
    "RemitToAddress": "ZD, Park Avenue St",
    "DefaultTaxationCountry": "US",
    "EnteredAmount": 1299.99,
    "InvoiceBalanceAmount": 1299.99,
    "Prepayment": "No",
    "Intercompany": "No",
    "DocumentFiscalClassification": null,
    "BankAccountNumber": null,
    "CreditCardAuthorizationRequestIdentifier": null,
    "CreditCardExpirationDate": null,
    "CreditCardIssuerCode": null,
    "CreditCardTokenNumber": null,
    "CreditCardVoiceAuthorizationCode": null,
    "CreditCardErrorCode": null,
    "CreditCardErrorText": null,
    "CardHolderLastName": null,
    "CardHolderFirstName": null,
    "ReceiptMethod": null,
    "SalesPersonNumber": null,
    "StructuredPaymentReference": null,
    "receivablesInvoiceInstallments": [
        {
            "InstallmentId": 321956,
            "InstallmentSequenceNumber": 1,
            "InstallmentDueDate": "2018-03-20",
            "OriginalAmount": 459,
            "PaymentDaysLate": 246,
            "InstallmentBalanceDue": 459,
            "InstallmentStatus": "Open",
            "DisputeAmount": null,
            "DisputeDate": null,
            "InstallmentClosedDate": "4712-12-31",
            "InstallmentGLClosedDate": "4712-12-31",
            "AccountedBalanceDue": 459,
            "InstallmentAmountAdjusted": null,
            "InstallmentAmountCredited": null,
            "AmountPaid": null,
            "PendingAdjustmentAmount": null,
            "InstallmentLineAmountOriginal": 459,
            "InstallmentLineAmountDue": 459
        }
    ]
}
```
Tokens:
Raw