Maintainers
Pricing
Enterprise
More
More
Documentation
Try Live
Rankings
Install
Blog
Docs7
Ask
New
Add Docs
Oracle Financials 26A
https://docs.oracle.com/en/cloud/saas/financials/26a/
Admin
Tokens:
31,984,227
Snippets:
64,612
Trust Score:
9.1
Update:
6 months ago
Context
Chat
Benchmark
14.74
Latest
Show doc for...
Code
Info
Show Results
Tokens:
Raw
Copy
Link
Tokens:
Raw
Copy
Link
### GET /revenueContracts Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Retrieves a list of all revenue contracts. ```APIDOC ## GET /revenueContracts ### Description Retrieves a collection of all revenue contracts available in the system. ### Method GET ### Endpoint /revenueContracts ### Response #### Success Response (200) - **contracts** (array) - List of revenue contract objects. #### Response Example { "contracts": [ { "contractId": "RC-001" }, { "contractId": "RC-002" } ] } ``` -------------------------------- ### GET /ledger-balances Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Retrieves all account balances from the general ledger. ```APIDOC ## GET /ledger-balances ### Description Fetches all account balances currently stored in the ledger. ### Method GET ### Endpoint /ledger-balances ### Response #### Success Response (200) - **balances** (array) - List of account balance objects #### Response Example { "balances": [ { "account": "1001", "balance": 50000.00 } ] } ``` -------------------------------- ### GET /tax-registrations Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Retrieve all tax registrations or a specific registration record. ```APIDOC ## GET /tax-registrations ### Description Fetches tax registration details for the organization. ### Method GET ### Endpoint /tax-registrations ### Response #### Success Response (200) - **registrations** (array) - List of tax registration objects. #### Response Example { "registrations": [ { "registrationId": "REG-001", "taxAuthority": "IRS" } ] } ``` -------------------------------- ### GET /journals Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Retrieves a list of all journal entries within the financial system. ```APIDOC ## GET /journals ### Description Retrieves all journal entries available in the system. ### Method GET ### Endpoint /journals ### Parameters #### Query Parameters - **limit** (integer) - Optional - Number of records to return ### Response #### Success Response (200) - **journals** (array) - List of journal objects #### Response Example { "journals": [ { "id": "JRN-001", "status": "posted" } ] } ``` -------------------------------- ### GET /jointVentureAccountingHeaders Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Retrieves a list of all joint venture accounting headers or a specific header by ID. ```APIDOC ## GET /jointVentureAccountingHeaders ### Description Retrieves a collection of joint venture accounting headers or details for a specific header. ### Method GET ### Endpoint /jointVentureAccountingHeaders/{headerId} ### Parameters #### Path Parameters - **headerId** (string) - Optional - The unique identifier of the accounting header. ### Request Example GET /jointVentureAccountingHeaders ### Response #### Success Response (200) - **headers** (array) - List of accounting header objects. #### Response Example { "headers": [ { "headerId": "JV-1001", "status": "Active" } ] } ``` -------------------------------- ### Retrieve Joint Venture Operational State using cURL Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html This snippet demonstrates how to perform a GET request to the jointVentureOperationalStates REST resource. It requires authentication credentials and returns a JSON object containing the operational state details. ```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/jointVentureOperationalStates/300100544742448" ``` -------------------------------- ### GET /operationalState/{operationalStateId} Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Retrieves a specific operational state resource item based on the provided unique identifier. ```APIDOC ## GET /operationalState/{operationalStateId} ### Description Retrieves a specific operational state resource item. The identifier should be obtained by querying the collection resource with a filter. ### Method GET ### Endpoint /operationalState/{operationalStateId} ### Parameters #### Path Parameters - **operationalStateId** (integer) - Required - The unique hash identifier for the resource item. #### Query Parameters - **dependency** (string) - Optional - Specifies fields to set before and roll back after generating the response (e.g., ProductId=2). - **expand** (string) - Optional - Includes specified children in the payload instead of links (e.g., Employees,Localizations). - **fields** (string) - Optional - Filters the resource fields returned in the response. - **links** (string) - Optional - Filters the links returned in the resource (e.g., self,canonical). - **onlyData** (boolean) - Optional - If true, returns only data without the links section. #### Header Parameters - **Metadata-Context** (string) - Optional - Used for runtime customizations (e.g., sandbox="TrackEmployeeFeature"). - **REST-Framework-Version** (string) - Optional - Specifies the protocol version for the API. ### Request Example GET /operationalState/12345?expand=Employees ### Response #### Success Response (200) - **data** (object) - The requested resource item details. #### Response Example { "id": 12345, "status": "active", "links": [] } ``` -------------------------------- ### Joint Venture Operational State JSON Response Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Example of the JSON response body returned by the jointVentureOperationalStates API, including operational state metadata, segment information, and HATEOAS links. ```json { "operationalStateId": 300100544742448, "jointVenture": "EARTHNORTH", "jointVentureDescription": "Explore Lot2, section 1D2", "primarySegment": "HEPPCostcenter", "segmentValue": "3001", "segmentValueDescription": "Southern North Sea Cost Center", "reportedDate": "2021-08-31", "operationalState": "Maintenance", "reason": "Periodic Service", "reasonDetails": "Monthly maintenance", "createdBy": "username", "creationDate": "2021-08-31T07:39:55+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2021-08-31T07:39:55.050+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/300100544742448", "name": "jointVentureOperationalStates", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/300100544742448", "name": "jointVentureOperationalStates", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/300100544742448/child/operationalStateDFF", "name": "operationalStateDFF", "kind": "collection" } ] } ``` -------------------------------- ### POST /joint-venture-account-sets Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Create a new joint venture account set within the financial system. ```APIDOC ## POST /joint-venture-account-sets ### Description Creates a new joint venture account set to categorize financial transactions. ### Method POST ### Endpoint /joint-venture-account-sets ### Request Body - **name** (string) - Required - Name of the account set. - **description** (string) - Optional - Description of the account set. ### Request Example { "name": "JV_Account_Set_01", "description": "Primary joint venture account set" } ### Response #### Success Response (201) - **id** (string) - The unique identifier of the created account set. #### Response Example { "id": "JV-998877", "status": "created" } ``` -------------------------------- ### Receiver Accounting Previews Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Endpoints for managing receiver accounting previews for transactions. ```APIDOC ## Get a Receiver Accounting Preview for a Transaction ### Description Retrieves a specific receiver accounting preview for a transaction. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/transactions/{transactionId}/receiver-accounting-previews/{previewId} ### Parameters #### Path Parameters - **transactionId** (string) - Required - The ID of the transaction. - **previewId** (string) - Required - The ID of the accounting preview. ### Response #### Success Response (200) - **previewDetails** (object) - Details of the receiver accounting preview. #### Response Example ```json { "previewDetails": { "accountId": "acc_222", "amount": 100.00 } } ``` ## Get All Receiver Accounting Previews for a Transaction ### Description Retrieves all receiver accounting previews for a transaction. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/transactions/{transactionId}/receiver-accounting-previews ### Parameters #### Path Parameters - **transactionId** (string) - Required - The ID of the transaction. ### Response #### Success Response (200) - **previews** (array) - A list of receiver accounting previews. #### Response Example ```json { "previews": [ { "previewId": "preview_bbb", "accountId": "acc_222", "amount": 100.00 } ] } ``` ## Update a Receiver Accounting Preview for a Transaction ### Description Updates an existing receiver accounting preview for a transaction. ### Method PUT ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/transactions/{transactionId}/receiver-accounting-previews/{previewId} ### Parameters #### Path Parameters - **transactionId** (string) - Required - The ID of the transaction. - **previewId** (string) - Required - The ID of the accounting preview to update. #### Request Body - **previewData** (object) - Required - The updated data for the accounting preview. ### Request Example ```json { "previewData": { "amount": 120.00 } } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### POST /receivablesInvoices Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Creates a new receivables invoice in the system. ```APIDOC ## POST /receivablesInvoices ### Description Creates a new receivables invoice record. ### Method POST ### Endpoint /receivablesInvoices ### Parameters #### Request Body - **invoiceNumber** (string) - Required - The unique identifier for the invoice. - **invoiceDate** (string) - Required - The date the invoice was issued. ### Request Example { "invoiceNumber": "INV-1001", "invoiceDate": "2023-10-27" } ### Response #### Success Response (200) - **id** (string) - The unique ID of the created invoice. #### Response Example { "id": "12345" } ``` -------------------------------- ### GET /receivablesInvoices/{id} Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Retrieves details of a specific receivables invoice by its ID. ```APIDOC ## GET /receivablesInvoices/{id} ### Description Fetches the full details of a specific receivables invoice. ### Method GET ### Endpoint /receivablesInvoices/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the invoice. ### Response #### Success Response (200) - **invoiceNumber** (string) - The invoice number. - **status** (string) - The current status of the invoice. #### Response Example { "invoiceNumber": "INV-1001", "status": "OPEN" } ``` -------------------------------- ### Distributable Project Rule Descriptive Flexfields API Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Manage descriptive flexfields for distributable project rules, including creation, retrieval, and updates. ```APIDOC ## POST /websites/oracle_en_cloud_saas_financials_26a/distributable-project-rules/{ruleId}/descriptive-flexfields ### Description Creates a set of descriptive flexfields for a distributable project rule. ### Method POST ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/distributable-project-rules/{ruleId}/descriptive-flexfields ### Parameters #### Path Parameters - **ruleId** (string) - Required - The ID of the distributable project rule. #### Request Body - **flexfields** (array) - Required - An array of descriptive flexfield objects. - **attributeName** (string) - Required - The name of the flexfield attribute. - **attributeValue** (string) - Required - The value for the flexfield attribute. ### Request Example { "flexfields": [ { "attributeName": "CostCenter", "attributeValue": "1001" }, { "attributeName": "ProjectCode", "attributeValue": "PROJ-ABC" } ] } ### Response #### Success Response (201) - **message** (string) - A confirmation message indicating the flexfields were created. #### Response Example { "message": "Descriptive flexfields created successfully for the distributable project rule." } ## GET /websites/oracle_en_cloud_saas_financials_26a/distributable-project-rules/{ruleId}/descriptive-flexfields ### Description Retrieves all descriptive flexfields for a distributable project rule. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/distributable-project-rules/{ruleId}/descriptive-flexfields ### Parameters #### Path Parameters - **ruleId** (string) - Required - The ID of the distributable project rule. ### Response #### Success Response (200) - **flexfields** (array) - A list of descriptive flexfield objects. - **attributeName** (string) - The name of the flexfield attribute. - **attributeValue** (string) - The value for the flexfield attribute. #### Response Example { "flexfields": [ { "attributeName": "CostCenter", "attributeValue": "1001" } ] } ## GET /websites/oracle_en_cloud_saas_financials_26a/distributable-project-rules/{ruleId}/descriptive-flexfields/{flexfieldName} ### Description Retrieves a specific descriptive flexfield for a distributable project rule. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/distributable-project-rules/{ruleId}/descriptive-flexfields/{flexfieldName} ### Parameters #### Path Parameters - **ruleId** (string) - Required - The ID of the distributable project rule. - **flexfieldName** (string) - Required - The name of the descriptive flexfield to retrieve. ### Response #### Success Response (200) - **attributeName** (string) - The name of the flexfield attribute. - **attributeValue** (string) - The value for the flexfield attribute. #### Response Example { "attributeName": "CostCenter", "attributeValue": "1001" } ## PUT /websites/oracle_en_cloud_saas_financials_26a/distributable-project-rules/{ruleId}/descriptive-flexfields/{flexfieldName} ### Description Updates a descriptive flexfield for a distributable project rule. ### Method PUT ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/distributable-project-rules/{ruleId}/descriptive-flexfields/{flexfieldName} ### Parameters #### Path Parameters - **ruleId** (string) - Required - The ID of the distributable project rule. - **flexfieldName** (string) - Required - The name of the descriptive flexfield to update. #### Request Body - **attributeValue** (string) - Required - The new value for the flexfield attribute. ### Request Example { "attributeValue": "1005" } ### Response #### Success Response (200) - **message** (string) - A confirmation message indicating the flexfield was updated. #### Response Example { "message": "Descriptive flexfield updated successfully." } ``` -------------------------------- ### GET /jointVentureOperationalStates Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Retrieves the details of a specific joint venture operational state resource. ```APIDOC ## GET /jointVentureOperationalStates ### Description Retrieves a single joint venture operational state record, including audit information and associated segment values. ### Method GET ### Endpoint /jointVentureOperationalStates/{operationalStateId} ### Parameters #### Path Parameters - **operationalStateId** (integer) - Required - The unique identifier of the joint venture operational state. ### Response #### Success Response (200) - **createdBy** (string) - The user who created the record. - **creationDate** (string) - The date and time of creation. - **jointVenture** (string) - The name of the joint venture. - **operationalState** (string) - The description of the operational state. - **lastUpdateDate** (string) - The date and time of the last update. - **lastUpdatedBy** (string) - The user who last updated the record. - **primarySegment** (string) - The primary segment name. - **segmentValue** (string) - The value defined for the primary segment. #### Response Example { "operationalStateId": 1001, "jointVenture": "JV_Alpha", "operationalState": "Active", "createdBy": "USER_01", "creationDate": "2023-01-01T10:00:00Z" } ``` -------------------------------- ### POST /tax-exemptions Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Create a new tax exemption record within the financial system. ```APIDOC ## POST /tax-exemptions ### Description Creates a new tax exemption record for a specific entity or transaction. ### Method POST ### Endpoint /tax-exemptions ### Request Body - **taxExemptionCode** (string) - Required - The code for the tax exemption. - **effectiveDate** (string) - Required - The date the exemption becomes active. ### Request Example { "taxExemptionCode": "EXEMPT_01", "effectiveDate": "2026-01-01" } ### Response #### Success Response (201) - **id** (string) - The unique identifier of the created tax exemption. #### Response Example { "id": "TX-998877", "status": "created" } ``` -------------------------------- ### POST /assignmentRules Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Creates a new assignment rule for joint venture accounting. ```APIDOC ## POST /assignmentRules ### Description Creates a new assignment rule to govern joint venture distribution logic. ### Method POST ### Endpoint /assignmentRules ### Request Body - **ruleName** (string) - Required - Name of the assignment rule. - **description** (string) - Optional - Description of the rule. ### Request Example { "ruleName": "Revenue_Allocation_Rule", "description": "Standard allocation for JV partners" } ### Response #### Success Response (200) - **ruleId** (string) - The ID of the created assignment rule. #### Response Example { "ruleId": "AR-550", "status": "Created" } ``` -------------------------------- ### GET /invoices/{invoiceId}/lines Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Retrieve all invoice lines associated with a specific invoice ID. ```APIDOC ## GET /invoices/{invoiceId}/lines ### Description Retrieves a list of all invoice lines for a specified invoice. ### Method GET ### Endpoint /invoices/{invoiceId}/lines ### Parameters #### Path Parameters - **invoiceId** (string) - Required - The unique identifier of the invoice. ### Request Example N/A ### Response #### Success Response (200) - **lines** (array) - List of invoice line objects. #### Response Example { "lines": [ { "lineId": "1001", "amount": 500.00, "description": "Consulting Services" } ] } ``` -------------------------------- ### Joint Venture SLA Supporting References API Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Endpoints for retrieving joint venture SLA supporting references. ```APIDOC ## GET /api/jointVentureSlaSupportingReferences ### Description Retrieves all joint venture SLA supporting references. ### Method GET ### Endpoint /api/jointVentureSlaSupportingReferences ### Response #### Success Response (200) - **referenceId** (string) - The ID of the SLA supporting reference. - **name** (string) - The name of the SLA supporting reference. #### Response Example ```json [ { "referenceId": "sla-ref-001", "name": "SLA Reference 1" } ] ``` ## GET /api/jointVentureSlaSupportingReferences/{referenceId} ### Description Retrieves a specific joint venture SLA supporting reference. ### Method GET ### Endpoint /api/jointVentureSlaSupportingReferences/{referenceId} ### Parameters #### Path Parameters - **referenceId** (string) - Required - The ID of the SLA supporting reference. ### Response #### Success Response (200) - **referenceId** (string) - The ID of the SLA supporting reference. - **name** (string) - The name of the SLA supporting reference. #### Response Example ```json { "referenceId": "sla-ref-001", "name": "SLA Reference 1" } ``` ``` -------------------------------- ### GET /jointVentureOperationalStates/{operationalStateId}/child/operationalStateDFF Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Retrieves the Descriptive Flexfield (DFF) information associated with a specific Joint Venture Operational State. ```APIDOC ## GET /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}/child/operationalStateDFF ### Description Retrieves the operational state DFF details for a specific joint venture operational state identified by the ID. ### Method GET ### Endpoint /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/{operationalStateId}/child/operationalStateDFF ### Parameters #### Path Parameters - **operationalStateId** (integer) - Required - The unique identifier of the operational state. ### Request Example GET /fscmRestApi/resources/11.13.18.05/jointVentureOperationalStates/12345/child/operationalStateDFF ### Response #### Success Response (200) - **OperationalStateId** (integer) - The ID of the operational state. - **__FLEX_Context** (string) - The context segment for the flexfield. - **__FLEX_Context_DisplayValue** (string) - The display value of the context segment. - **links** (array) - List of related resource links. #### Response Example { "OperationalStateId": 12345, "__FLEX_Context": "Standard", "__FLEX_Context_DisplayValue": "Standard", "links": [] } ``` -------------------------------- ### Receivables Credit Memo Global Descriptive Flexfields API Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html APIs for managing global descriptive flexfields for receivables credit memos. ```APIDOC ## GET /websites/oracle_en_cloud_saas_financials_26a/receivables/credit-memos/global-descriptive-flexfields ### Description Retrieves a specific receivables credit memo global descriptive flexfield. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/receivables/credit-memos/global-descriptive-flexfields/{flexfieldId} ### Parameters #### Path Parameters - **flexfieldId** (string) - Required - The ID of the global descriptive flexfield to retrieve. ### Response #### Success Response (200) - **flexfield** (object) - Details of the global descriptive flexfield. #### Response Example ```json { "flexfield": { "id": "12345", "name": "CreditMemoGDF", "value": "ExampleValue" } } ``` ## GET /websites/oracle_en_cloud_saas_financials_26a/receivables/credit-memos/global-descriptive-flexfields ### Description Retrieves all global descriptive flexfields for a group of receivables credit memos. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/receivables/credit-memos/global-descriptive-flexfields ### Parameters #### Query Parameters - **creditMemoIds** (string) - Required - A comma-separated list of credit memo IDs. ### Response #### Success Response (200) - **flexfields** (array) - A list of global descriptive flexfields for the specified credit memos. #### Response Example ```json { "flexfields": [ { "creditMemoId": "CM1001", "id": "12345", "name": "CreditMemoGDF", "value": "ExampleValue1" }, { "creditMemoId": "CM1002", "id": "67890", "name": "AnotherGDF", "value": "ExampleValue2" } ] } ``` ``` -------------------------------- ### Receivables Customer Account Activities API Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html APIs for retrieving customer account activities and related credit memo applications. ```APIDOC ## GET /websites/oracle_en_cloud_saas_financials_26a/receivables/customer-account-activities/{activityId} ### Description Retrieves a specific customer account activity. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_ ``` -------------------------------- ### Supporting References API Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Endpoints for managing supporting references, including those that derive date values. ```APIDOC ## GET /api/supportingReferences ### Description Retrieves all supporting references that derive a date value. ### Method GET ### Endpoint /api/supportingReferences ### Response #### Success Response (200) - **referenceId** (string) - The ID of the supporting reference. - **dateValue** (string) - The date value derived from the reference. #### Response Example ```json [ { "referenceId": "ref-001", "dateValue": "2023-10-27" } ] ``` ## GET /api/supportingReferences/{referenceId} ### Description Retrieves a specific supporting reference that derives a date value. ### Method GET ### Endpoint /api/supportingReferences/{referenceId} ### Parameters #### Path Parameters - **referenceId** (string) - Required - The ID of the supporting reference. ### Response #### Success Response (200) - **referenceId** (string) - The ID of the supporting reference. - **dateValue** (string) - The date value derived from the reference. #### Response Example ```json { "referenceId": "ref-001", "dateValue": "2023-10-27" } ``` ``` -------------------------------- ### Interim Payables Documents Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Manage interim payables documents, including creation, deletion, retrieval, and updates. ```APIDOC ## Create an Interim Payables Document ### Description Creates a new interim payables document. ### Method POST ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/interim-payables-documents ### Parameters #### Request Body - **documentDetails** (object) - Required - Details for the interim payables document. ### Request Example ```json { "documentDetails": { "supplierId": "supp_001", "amount": 250.00, "description": "Interim payment for services" } } ``` ### Response #### Success Response (201) - **documentId** (string ``` -------------------------------- ### Preferred Currencies API Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Endpoints for retrieving currency information. ```APIDOC ## GET /api/currencies ### Description Retrieves all currencies. ### Method GET ### Endpoint /api/currencies ### Response #### Success Response (200) - **currencyCode** (string) - The ISO currency code. - **currencyName** (string) - The name of the currency. #### Response Example ```json [ { "currencyCode": "USD", " ``` -------------------------------- ### Joint Venture Distribution Descriptive Flexfields Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Endpoints for managing descriptive flexfields for joint venture distributions. ```APIDOC ## POST /joint-venture/distributions/{DistributionID}/descriptive-flexfields ### Description Creates the set of descriptive flexfields for a joint venture distribution. ### Method POST ### Endpoint /joint-venture/distributions/{DistributionID}/descriptive-flexfields ### Parameters #### Path Parameters - **DistributionID** (string) - Required - The unique identifier of the joint venture distribution. #### Request Body - **flexfieldData** (object) - Required - The descriptive flexfield data to create. ### Request Example ```json { "example": "POST /joint-venture/distributions/D100/descriptive-flexfields" "body": { "flexfieldData": { "AttributeCategory": "Custom", "Attribute2": "Value2" } } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of the creation. #### Response Example ```json { "example": "{\"message\": \"Descriptive flexfields created successfully\"}" } ``` ``` ```APIDOC ## GET /joint-venture/distributions/{DistributionID}/all-descriptive-flexfields ### Description Retrieves all descriptive flexfields for a joint venture distribution. ### Method GET ### Endpoint /joint-venture/distributions/{DistributionID}/all-descriptive-flexfields ### Parameters #### Path Parameters - **DistributionID** (string) - Required - The unique identifier of the joint venture distribution. ### Request Example ```json { "example": "GET /joint-venture/distributions/D100/all-descriptive-flexfields" } ``` ### Response #### Success Response (200) - **descriptiveFlexfields** (object) - All descriptive flexfield data for the distribution. #### Response Example ```json { "example": "{\"descriptiveFlexfields\": {\"AttributeCategory\": \"Custom\", \"Attribute2\": \"Value2\"}}" } ``` ``` ```APIDOC ## GET /joint-venture/distributions/{DistributionID}/descriptive-flexfields/{FlexfieldName} ### Description Retrieves specific descriptive flexfields for a joint venture distribution. ### Method GET ### Endpoint /joint-venture/distributions/{DistributionID}/descriptive-flexfields/{FlexfieldName} ### Parameters #### Path Parameters - **DistributionID** (string) - Required - The unique identifier of the joint venture distribution. - **FlexfieldName** (string) - Required - The name of the descriptive flexfield to retrieve. ### Request Example ```json { "example": "GET /joint-venture/distributions/D100/descriptive-flexfields/Attribute2" } ``` ### Response #### Success Response (200) - **flexfieldValue** (string) - The value of the requested descriptive flexfield. #### Response Example ```json { "example": "{\"flexfieldValue\": \"Value2\"}" } ``` ``` ```APIDOC ## PUT /joint-venture/distributions/{DistributionID}/descriptive-flexfields/{FlexfieldName} ### Description Updates descriptive flexfields for a joint venture distribution. ### Method PUT ### Endpoint /joint-venture/distributions/{DistributionID}/descriptive-flexfields/{FlexfieldName} ### Parameters #### Path Parameters - **DistributionID** (string) - Required - The unique identifier of the joint venture distribution. - **FlexfieldName** (string) - Required - The name of the descriptive flexfield to update. #### Request Body - **newValue** (string) - Required - The new value for the descriptive flexfield. ### Request Example ```json { "example": "PUT /joint-venture/distributions/D100/descriptive-flexfields/Attribute2" "body": { "newValue": "UpdatedValue2" } } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message of the update. #### Response Example ```json { "example": "{\"message\": \"Descriptive flexfield updated successfully\"}" } ``` ``` -------------------------------- ### Payment Methods API Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Endpoints for retrieving payment method information. ```APIDOC ## GET /api/paymentMethods ### Description Retrieves all payment methods. ### Method GET ### Endpoint /api/paymentMethods ### Response #### Success Response (200) - **paymentMethodId** (string) - The ID of the payment method. - **name** (string) - The name of the payment method. #### Response Example ```json [ { "paymentMethodId": "pm-001", "name": "Credit Card" } ] ``` ## GET /api/paymentMethods/{paymentMethodId} ### Description Retrieves a specific payment method. ### Method GET ### Endpoint /api/paymentMethods/{paymentMethodId} ### Parameters #### Path Parameters - **paymentMethodId** (string) - Required - The ID of the payment method. ### Response #### Success Response (200) - **paymentMethodId** (string) - The ID of the payment method. - **name** (string) - The name of the payment method. #### Response Example ```json { "paymentMethodId": "pm-001", "name": "Credit Card" } ``` ``` -------------------------------- ### Descriptive Flexfields for Transfer Authorizations Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Manage descriptive flexfields associated with transfer authorizations. ```APIDOC ## Create a Descriptive Flexfield for a Transfer Authorization ### Description Creates a new descriptive flexfield for a transfer authorization. ### Method POST ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/transfer-authorizations/{authId}/flexfields ### Parameters #### Path Parameters - **authId** (string) - Required - The ID of the transfer authorization. #### Request Body - **flexfieldData** (object) - Required - The data for the descriptive flexfield. ### Request Example ```json { "flexfieldData": { "context": "DEFAULT", "attribute1": "AuthValue1" } } ``` ### Response #### Success Response (201) - **flexfieldId** (string) - The ID of the newly created descriptive flexfield. #### Response Example ```json { "flexfieldId": "flexfield_def456" } ``` ## Get a Descriptive Flexfield for a Transfer Authorization ### Description Retrieves a specific descriptive flexfield for a transfer authorization. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/transfer-authorizations/{authId}/flexfields/{flexfieldId} ### Parameters #### Path Parameters - **authId** (string) - Required - The ID of the transfer authorization. - **flexfieldId** (string) - Required - The ID of the descriptive flexfield. ### Response #### Success Response (200) - **flexfieldData** (object) - The data of the descriptive flexfield. #### Response Example ```json { "flexfieldData": { "context": "DEFAULT", "attribute1": "AuthValue1" } } ``` ## Get All Descriptive Flexfields for a Transfer Authorization ### Description Retrieves all descriptive flexfields associated with a transfer authorization. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/transfer-authorizations/{authId}/flexfields ### Parameters #### Path Parameters - **authId** (string) - Required - The ID of the transfer authorization. ### Response #### Success Response (200) - **flexfields** (array) - A list of descriptive flexfields. #### Response Example ```json { "flexfields": [ { "flexfieldId": "flexfield_def456", "context": "DEFAULT", "attribute1": "AuthValue1" } ] } ``` ## Update a Descriptive Flexfield for a Transfer Authorization ### Description Updates an existing descriptive flexfield for a transfer authorization. ### Method PUT ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/transfer-authorizations/{authId}/flexfields/{flexfieldId} ### Parameters #### Path Parameters - **authId** (string) - Required - The ID of the transfer authorization. - **flexfieldId** (string) - Required - The ID of the descriptive flexfield to update. #### Request Body - **flexfieldData** (object) - Required - The updated data for the descriptive flexfield. ### Request Example ```json { "flexfieldData": { "attribute1": "UpdatedAuthValue1" } } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### Intercompany Transaction Source Documents Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Manage intercompany transaction source documents, including creation, retrieval, and updates. ```APIDOC ## Create a Transfer Authorization ### Description Creates a new transfer authorization for an intercompany transaction. ### Method POST ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/intercompany-transactions/source-documents/transfer-authorizations ### Parameters #### Request Body - **authorizationDetails** (object) - Required - Details for the transfer authorization. ### Request Example ```json { "authorizationDetails": { "sourceBU": "BU1", "targetBU": "BU2", "amount": 5000.00 } } ``` ### Response #### Success Response (201) - **authorizationId** (string) - The ID of the newly created transfer authorization. #### Response Example ```json { "authorizationId": "auth_777" } ``` ## Get All Intercompany Transaction Source Documents ### Description Retrieves all intercompany transaction source documents. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/intercompany-transactions/source-documents ### Response #### Success Response (200) - **sourceDocuments** (array) - A list of intercompany transaction source documents. #### Response Example ```json { "sourceDocuments": [ { "documentId": "doc_101", "type": "Transfer Authorization", "status": "Approved" } ] } ``` ## Get an Intercompany Transaction Source Document ### Description Retrieves a specific intercompany transaction source document. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/intercompany-transactions/source-documents/{documentId} ### Parameters #### Path Parameters - **documentId** (string) - Required - The ID of the source document. ### Response #### Success Response (200) - **documentDetails** (object) - Details of the source document. #### Response Example ```json { "documentDetails": { "documentId": "doc_101", "type": "Transfer Authorization", "status": "Approved" } } ``` ## Update an Intercompany Transaction Source Document ### Description Updates an existing intercompany transaction source document. ### Method PUT ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/intercompany-transactions/source-documents/{documentId} ### Parameters #### Path Parameters - **documentId** (string) - Required - The ID of the source document to update. #### Request Body - **updateData** (object) - Required - The data to update. ### Request Example ```json { "updateData": { "status": "Completed" } } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### Ledgers API Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Endpoints for retrieving ledger information. ```APIDOC ## GET /api/ledgers ### Description Retrieves all ledgers. ### Method GET ### Endpoint /api/ledgers ### Response #### Success Response (200) - **ledgerId** (string) - The ID of the ledger. - **name** (string) - The name of the ledger. #### Response Example ```json [ { "ledgerId": "ledger-001", "name": "Main Ledger" } ] ``` ## GET /api/ledgers/{ledgerId} ### Description Retrieves a specific ledger. ### Method GET ### Endpoint /api/ledgers/{ledgerId} ### Parameters #### Path Parameters - **ledgerId** (string) - Required - The ID of the ledger. ### Response #### Success Response (200) - **ledgerId** (string) - The ID of the ledger. - **name** (string) - The name of the ledger. #### Response Example ```json { "ledgerId": "ledger-001", "name": "Main Ledger" } ``` ``` -------------------------------- ### Descriptive Flexfields for Intercompany Transactions Source: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/op-jointventureoperationalstates-operationalstateid-get.html Manage descriptive flexfields associated with intercompany transactions. ```APIDOC ## Create a Descriptive Flexfield for an Intercompany Transaction ### Description Creates a new descriptive flexfield for an intercompany transaction. ### Method POST ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/intercompany-transactions/{transactionId}/flexfields ### Parameters #### Path Parameters - **transactionId** (string) - Required - The ID of the intercompany transaction. #### Request Body - **flexfieldData** (object) - Required - The data for the descriptive flexfield. ### Request Example ```json { "flexfieldData": { "context": "INTERCOMPANY", "attribute1": "ICValue1" } } ``` ### Response #### Success Response (201) - **flexfieldId** (string) - The ID of the newly created descriptive flexfield. #### Response Example ```json { "flexfieldId": "flexfield_ghi789" } ``` ## Get a Descriptive Flexfield for an Intercompany Transaction ### Description Retrieves a specific descriptive flexfield for an intercompany transaction. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/intercompany-transactions/{transactionId}/flexfields/{flexfieldId} ### Parameters #### Path Parameters - **transactionId** (string) - Required - The ID of the intercompany transaction. - **flexfieldId** (string) - Required - The ID of the descriptive flexfield. ### Response #### Success Response (200) - **flexfieldData** (object) - The data of the descriptive flexfield. #### Response Example ```json { "flexfieldData": { "context": "INTERCOMPANY", "attribute1": "ICValue1" } } ``` ## Get All Descriptive Flexfields for an Intercompany Transaction ### Description Retrieves all descriptive flexfields associated with an intercompany transaction. ### Method GET ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/intercompany-transactions/{transactionId}/flexfields ### Parameters #### Path Parameters - **transactionId** (string) - Required - The ID of the intercompany transaction. ### Response #### Success Response (200) - **flexfields** (array) - A list of descriptive flexfields. #### Response Example ```json { "flexfields": [ { "flexfieldId": "flexfield_ghi789", "context": "INTERCOMPANY", "attribute1": "ICValue1" } ] } ``` ## Update a Descriptive Flexfield for an Intercompany Transaction ### Description Updates an existing descriptive flexfield for an intercompany transaction. ### Method PUT ### Endpoint /websites/oracle_en_cloud_saas_financials_26a/intercompany-transactions/{transactionId}/flexfields/{flexfieldId} ### Parameters #### Path Parameters - **transactionId** (string) - Required - The ID of the intercompany transaction. - **flexfieldId** (string) - Required - The ID of the descriptive flexfield to update. #### Request Body - **flexfieldData** (object) - Required - The updated data for the descriptive flexfield. ### Request Example ```json { "flexfieldData": { "attribute1": "UpdatedICValue1" } } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the operation. #### Response Example ```json { "status": "success" } ``` ```
