Jump to

• Request
• Response
• Examples

Update a joint venture partner contribution

patch

/fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}

Request

Path Parameters

• contributionId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• agreementDefaultCharge: number
  Title: Agreement Default Charge

  The amount charged to the partner when the partner contribution is closed.
• agreementDefaultChargeAccount: string
  Title: Agreement Default Charge Account

  Maximum Length: 255

  The account used to record the agreement default charge when closing a partner contribution.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• cancelDate: string (date)
  Title: Cancel Date

  The date the partner contribution is canceled.
• closeDate: string (date)
  Title: Close Date

  The date the partner contribution is closed.
• closeType: string
  Title: Close Type

  The type of transaction created to close the partner contribution.
• contributionAmount: number
  Title: Contribution Amount

  The amount of the partner contribution.
• contributionDescription: string
  Title: Description

  Maximum Length: 240

  The description of the partner contribution.
• contributionDFF: array contributionDFF
• contributionReferences: array Partner Contribution References
  Title: Partner Contribution References

  The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.
• contributionStatus: string
  Title: Status

  The status of the joint venture partner contribution.
• jointVenturePartnerContributionAccount: string
  Title: Joint Venture Partner Contribution Account

  Maximum Length: 255

  The combination of segment values for a joint venture partner contribution account.
• jointVentureShortName: string
  Title: Joint Venture

  The unique name of the joint venture.
• stakeholderShortName: string
  Title: Stakeholder

  The unique name of the joint venture stakeholder.
• startDate: string (date)
  Title: Start Date

  The date when joint venture distribution records can be applied to the partner contribution.
• structureInstanceNumber: integer (int64)
  Title: Structure Instance Number

  The chart of accounts instance number associated with the joint venture's business unit.
• transactionDate: string (date)
  Title: Transaction Date

  The date on the transaction that was created to open or close the partner contribution.
• transactionNumber: string
  Title: Transaction Number

  The unique number of the transaction created to fund or close the partner contribution.
• transactionReason: string
  Title: Transaction Reason

  The reason for canceling the partner contribution.
• transactionType: string
  Title: Transaction Type

  The type of transaction used to open the partner contribution.

{
    "type":"object",
    "properties":{
        "cancelDate":{
            "title":"Cancel Date",
            "type":"string",
            "description":"The date the partner contribution is canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/jointVentureContributions-attachments-item-patch-request"
            }
        },
        "jointVenturePartnerContributionAccount":{
            "title":"Joint Venture Partner Contribution Account",
            "maxLength":255,
            "type":"string",
            "description":"The combination of segment values for a joint venture partner contribution account.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.jointVenture.invoicing.model.view.ContributionVO#Account",
                "FND_ACFF_ResourceName":"jointVentureContributions",
                "ojStructureInstanceNumber":"structureInstanceNumber"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "jointVentureShortName":{
            "title":"Joint Venture",
            "type":"string",
            "description":"The unique name of the joint venture.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "structureInstanceNumber":{
            "title":"Structure Instance Number",
            "type":"integer",
            "description":"The chart of accounts instance number associated with the joint venture's business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_StructureID":"Account",
                "precision":18
            }
        },
        "contributionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureContributions-contributionDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "transactionNumber":{
            "title":"Transaction Number",
            "type":"string",
            "description":"The unique number of the transaction created to fund or close the partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "contributionReferences":{
            "title":"Partner Contribution References",
            "type":"array",
            "description":"The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.",
            "items":{
                "$ref":"#/components/schemas/jointVentureContributions-contributionReferences-item-patch-request"
            }
        },
        "agreementDefaultCharge":{
            "title":"Agreement Default Charge",
            "type":"number",
            "description":"The amount charged to the partner when the partner contribution is closed.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "contributionDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "transactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date on the transaction that was created to open or close the partner contribution.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "closeType":{
            "title":"Close Type",
            "type":"string",
            "description":"The type of transaction created to close the partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeClsTyp"
                ]
            }
        },
        "contributionStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the joint venture partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeContSt"
                ]
            }
        },
        "transactionReason":{
            "title":"Transaction Reason",
            "type":"string",
            "description":"The reason for canceling the partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "sortable":false
            }
        },
        "closeDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date the partner contribution is closed.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "transactionType":{
            "title":"Transaction Type",
            "type":"string",
            "description":"The type of transaction used to open the partner contribution.",
            "nullable":true,
            "x-queryable":false
        },
        "stakeholderShortName":{
            "title":"Stakeholder",
            "type":"string",
            "description":"The unique name of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "agreementDefaultChargeAccount":{
            "title":"Agreement Default Charge Account",
            "maxLength":255,
            "type":"string",
            "description":"The account used to record the agreement default charge when closing a partner contribution.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.jointVenture.invoicing.model.view.ContributionVO#agreementAccount",
                "FND_ACFF_ResourceName":"jointVentureContributions",
                "ojStructureInstanceNumber":"structureInstanceNumber",
                "dependencies":[
                    "agreementDefaultSin",
                    "coaInstanceNumber"
                ]
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "contributionAmount":{
            "title":"Contribution Amount",
            "type":"number",
            "description":"The amount of the partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "startDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when joint venture distribution records can be applied to the partner contribution.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/jointVentureContributions-attachments-item-patch-request"
    }
}

Nested Schema : contributionDFF

Type: array

Show Source

• Array of: object jointVentureContributions-contributionDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureContributions-contributionDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Partner Contribution References

Type: array

Title: Partner Contribution References

The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.

Show Source

• Array of: object schema

{
    "title":"Partner Contribution References",
    "type":"array",
    "description":"The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.",
    "items":{
        "$ref":"#/components/schemas/jointVentureContributions-contributionReferences-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : jointVentureContributions-contributionDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• agreementDefaultCharge: number
  Title: Agreement Default Charge

  The amount charged to the partner when the partner contribution is closed.
• agreementDefaultChargeAccount: string
  Title: Agreement Default Charge Account

  Maximum Length: 255

  The account used to record the agreement default charge when closing a partner contribution.
• cancelDate: string (date)
  Title: Cancel Date

  The date the partner contribution is canceled.
• closeDate: string (date)
  Title: Close Date

  The date the partner contribution is closed.
• transactionDate: string (date)
  Title: Transaction Date

  The date on the transaction that was created to open or close the partner contribution.
• transactionId: integer (int64)
  Title: Transaction ID

  Default Value: 0

  The unique identifier of the transaction created to fund or close the partner contribution.
• transactionNumber: string
  Title: Transaction Number

  Maximum Length: 20

  The unique number of the transaction created to fund or close the partner contribution.
• transactionReason: string
  Title: Transaction Reason

  The reason for canceling the partner contribution.

{
    "type":"object",
    "properties":{
        "closeDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date the partner contribution is closed.",
            "format":"date",
            "nullable":true
        },
        "cancelDate":{
            "title":"Cancel Date",
            "type":"string",
            "description":"The date the partner contribution is canceled.",
            "format":"date",
            "nullable":true
        },
        "agreementDefaultChargeAccount":{
            "title":"Agreement Default Charge Account",
            "maxLength":255,
            "type":"string",
            "description":"The account used to record the agreement default charge when closing a partner contribution.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.jointVenture.invoicing.model.view.ContributionReferenceVO#agreementAccount",
                "FND_ACFF_ResourceName":"contributionReferences",
                "ojStructureInstanceNumber":"structureInstanceNumber",
                "dependencies":[
                    "coaInstanceNumberJV",
                    "structureInstanceNumber"
                ]
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "transactionNumber":{
            "title":"Transaction Number",
            "maxLength":20,
            "type":"string",
            "description":"The unique number of the transaction created to fund or close the partner contribution.",
            "nullable":false
        },
        "agreementDefaultCharge":{
            "title":"Agreement Default Charge",
            "type":"number",
            "description":"The amount charged to the partner when the partner contribution is closed.",
            "nullable":true
        },
        "transactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date on the transaction that was created to open or close the partner contribution.",
            "format":"date",
            "nullable":false
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier of the transaction created to fund or close the partner contribution.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "transactionReason":{
            "title":"Transaction Reason",
            "type":"string",
            "description":"The reason for canceling the partner contribution.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "transactionReasonLookupCode"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : jointVentureContributions-item-response

Type: object

Show Source

• agreementDefaultCharge: number
  Title: Agreement Default Charge

  The amount charged to the partner when the partner contribution is closed.
• agreementDefaultChargeAccount: string
  Title: Agreement Default Charge Account

  Maximum Length: 255

  The account used to record the agreement default charge when closing a partner contribution.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• automaticContributionFlag: boolean
  Title: Automatic Contribution

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the partner contribution is created manually or automatically.
• cancelDate: string (date)
  Title: Cancel Date

  The date the partner contribution is canceled.
• closeDate: string (date)
  Title: Close Date

  The date the partner contribution is closed.
• closeReason: string
  Title: Close Reason

  Read Only: true

  Maximum Length: 80

  The reason the partner contribution is closed.
• closeType: string
  Title: Close Type

  The type of transaction created to close the partner contribution.
• contributionAmount: number
  Title: Contribution Amount

  The amount of the partner contribution.
• contributionDescription: string
  Title: Description

  Maximum Length: 240

  The description of the partner contribution.
• contributionDFF: array contributionDFF
• contributionId: integer (int64)
  Title: Partner Contribution ID

  Read Only: true

  The unique identifier of the joint venture partner contribution.
• contributionOpenAmount: number
  Title: Open Amount

  Read Only: true

  The amount available to be drawn, transferred, or refunded from the partner contribution.
• contributionReferences: array Partner Contribution References
  Title: Partner Contribution References

  The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.
• contributionStatus: string
  Title: Status

  The status of the joint venture partner contribution.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the joint venture partner contribution.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the joint venture partner contribution was created.
• currencyCode: string
  Title: Currency

  Read Only: true

  The currency of the default primary ledger associated with the business unit assigned to the joint venture.
• foreignContributionAmount: number
  Title: Entered Contribution Amount

  Read Only: true

  The partner contribution amount in the preferred currency.
• grossContributionAmount: number
  Title: Gross Contribution Amount

  Read Only: true

  The gross partner contribution amount that's split among the stakeholders defined in the ownership definition or assigned to a direct billed stakeholder.
• jointVenturePartnerContributionAccount: string
  Title: Joint Venture Partner Contribution Account

  Maximum Length: 255

  The combination of segment values for a joint venture partner contribution account.
• jointVentureShortName: string
  Title: Joint Venture

  The unique name of the joint venture.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the joint venture partner contribution was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the joint venture partner contribution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ownershipPercentShortName: string
  Title: Ownership Definition

  Read Only: true

  Maximum Length: 30

  The name of the ownership definition.
• partnerAccount: string
  Title: Partner Account

  Read Only: true

  The combination of account segment values assigned to a partner's line in a transaction.
• preferredCurrencyCode: string
  Title: Preferred Currency

  Read Only: true

  Maximum Length: 15

  The currency code used in creating partner contributions and receivables invoices for stakeholders.
• refundAmount: number
  Title: Refund Amount

  Read Only: true

  The amount to return to the partner when the partner contribution is closed.
• stakeholderShortName: string
  Title: Stakeholder

  The unique name of the joint venture stakeholder.
• stakeholderWithCostCenterFlag: boolean
  Title: Stakeholder Associated with Cost Center

  Read Only: true

  Indicates whether the stakeholder is associated with a cost center.
• startDate: string (date)
  Title: Start Date

  The date when joint venture distribution records can be applied to the partner contribution.
• structureInstanceNumber: integer (int64)
  Title: Structure Instance Number

  The chart of accounts instance number associated with the joint venture's business unit.
• transactionCurrencyCode: string
  Title: Transaction Currency

  Read Only: true

  The currency code of the partner contribution transaction.
• transactionDate: string (date)
  Title: Transaction Date

  The date on the transaction that was created to open or close the partner contribution.
• transactionNumber: string
  Title: Transaction Number

  The unique number of the transaction created to fund or close the partner contribution.
• transactionReason: string
  Title: Transaction Reason

  The reason for canceling the partner contribution.
• transactionType: string
  Title: Transaction Type

  The type of transaction used to open the partner contribution.

{
    "type":"object",
    "properties":{
        "cancelDate":{
            "title":"Cancel Date",
            "type":"string",
            "description":"The date the partner contribution is canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ownershipPercentShortName":{
            "title":"Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The name of the ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/jointVentureContributions-attachments-item-response"
            }
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the joint venture partner contribution was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "contributionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureContributions-contributionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "contributionReferences":{
            "title":"Partner Contribution References",
            "type":"array",
            "description":"The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.",
            "items":{
                "$ref":"#/components/schemas/jointVentureContributions-contributionReferences-item-response"
            }
        },
        "agreementDefaultCharge":{
            "title":"Agreement Default Charge",
            "type":"number",
            "description":"The amount charged to the partner when the partner contribution is closed.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "contributionDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "partnerAccount":{
            "title":"Partner Account",
            "type":"string",
            "description":"The combination of account segment values assigned to a partner's line in a transaction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "transactionReason":{
            "title":"Transaction Reason",
            "type":"string",
            "description":"The reason for canceling the partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "sortable":false
            },
            "x-queryable":true
        },
        "stakeholderShortName":{
            "title":"Stakeholder",
            "type":"string",
            "description":"The unique name of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "automaticContributionFlag":{
            "title":"Automatic Contribution",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the partner contribution is created manually or automatically.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "transactionCurrencyCode":{
            "title":"Transaction Currency",
            "type":"string",
            "description":"The currency code of the partner contribution transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "closeReason":{
            "title":"Close Reason",
            "maxLength":80,
            "type":"string",
            "description":"The reason the partner contribution is closed.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "preferredCurrencyCode":{
            "title":"Preferred Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code used in creating partner contributions and receivables invoices for stakeholders.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "refundAmount":{
            "title":"Refund Amount",
            "type":"number",
            "description":"The amount to return to the partner when the partner contribution is closed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "contributionId":{
            "title":"Partner Contribution ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture partner contribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the joint venture partner contribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenturePartnerContributionAccount":{
            "title":"Joint Venture Partner Contribution Account",
            "maxLength":255,
            "type":"string",
            "description":"The combination of segment values for a joint venture partner contribution account.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.jointVenture.invoicing.model.view.ContributionVO#Account",
                "FND_ACFF_ResourceName":"jointVentureContributions",
                "ojStructureInstanceNumber":"structureInstanceNumber"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "jointVentureShortName":{
            "title":"Joint Venture",
            "type":"string",
            "description":"The unique name of the joint venture.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "structureInstanceNumber":{
            "title":"Structure Instance Number",
            "type":"integer",
            "description":"The chart of accounts instance number associated with the joint venture's business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_StructureID":"Account",
                "precision":18
            },
            "x-queryable":true
        },
        "transactionNumber":{
            "title":"Transaction Number",
            "type":"string",
            "description":"The unique number of the transaction created to fund or close the partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "stakeholderWithCostCenterFlag":{
            "title":"Stakeholder Associated with Cost Center",
            "type":"boolean",
            "description":"Indicates whether the stakeholder is associated with a cost center.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture partner contribution was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date on the transaction that was created to open or close the partner contribution.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "closeType":{
            "title":"Close Type",
            "type":"string",
            "description":"The type of transaction created to close the partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeClsTyp"
                ]
            },
            "x-queryable":true
        },
        "contributionStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the joint venture partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeContSt"
                ]
            },
            "x-queryable":true
        },
        "foreignContributionAmount":{
            "title":"Entered Contribution Amount",
            "type":"number",
            "description":"The partner contribution amount in the preferred currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "closeDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date the partner contribution is closed.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "transactionType":{
            "title":"Transaction Type",
            "type":"string",
            "description":"The type of transaction used to open the partner contribution.",
            "nullable":true,
            "x-queryable":false
        },
        "agreementDefaultChargeAccount":{
            "title":"Agreement Default Charge Account",
            "maxLength":255,
            "type":"string",
            "description":"The account used to record the agreement default charge when closing a partner contribution.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.jointVenture.invoicing.model.view.ContributionVO#agreementAccount",
                "FND_ACFF_ResourceName":"jointVentureContributions",
                "ojStructureInstanceNumber":"structureInstanceNumber",
                "dependencies":[
                    "agreementDefaultSin",
                    "coaInstanceNumber"
                ]
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "contributionAmount":{
            "title":"Contribution Amount",
            "type":"number",
            "description":"The amount of the partner contribution.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the joint venture partner contribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "grossContributionAmount":{
            "title":"Gross Contribution Amount",
            "type":"number",
            "description":"The gross partner contribution amount that's split among the stakeholders defined in the ownership definition or assigned to a direct billed stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "contributionOpenAmount":{
            "title":"Open Amount",
            "type":"number",
            "description":"The amount available to be drawn, transferred, or refunded from the partner contribution.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "currencyCode":{
            "title":"Currency",
            "type":"string",
            "description":"The currency of the default primary ledger associated with the business unit assigned to the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "startDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when joint venture distribution records can be applied to the partner contribution.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object jointVentureContributions-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/jointVentureContributions-attachments-item-response"
    }
}

Nested Schema : contributionDFF

Type: array

Show Source

• Array of: object jointVentureContributions-contributionDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureContributions-contributionDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Partner Contribution References

Type: array

Title: Partner Contribution References

The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.

Show Source

• Array of: object jointVentureContributions-contributionReferences-item-response

{
    "title":"Partner Contribution References",
    "type":"array",
    "description":"The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.",
    "items":{
        "$ref":"#/components/schemas/jointVentureContributions-contributionReferences-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : jointVentureContributions-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

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

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : jointVentureContributions-contributionDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• ContributionId: integer (int64)
  Title: Partner Contribution ID

  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ContributionId":{
            "title":"Partner Contribution ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : jointVentureContributions-contributionReferences-item-response

Type: object

Show Source

• agreementDefaultCharge: number
  Title: Agreement Default Charge

  The amount charged to the partner when the partner contribution is closed.
• agreementDefaultChargeAccount: string
  Title: Agreement Default Charge Account

  Maximum Length: 255

  The account used to record the agreement default charge when closing a partner contribution.
• cancelDate: string (date)
  Title: Cancel Date

  The date the partner contribution is canceled.
• closeDate: string (date)
  Title: Close Date

  The date the partner contribution is closed.
• contributionReferenceId: integer (int64)
  Title: Contribution Reference ID

  Read Only: true

  The unique identifier of the partner contribution transaction reference.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the transaction reference for the partner contribution was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the transaction reference for partner contribution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• priorContributionStatus: string
  Title: Prior Contribution Status

  Read Only: true

  Maximum Length: 80

  The status assigned to the partner contribution before it was canceled, closed, or transferred.
• refundAmount: number
  Title: Refund Amount

  The amount to return to the partner when the partner contribution is closed.
• status: string
  Title: Transaction Status

  Read Only: true

  Maximum Length: 80

  The status of the partner contribution transaction reference.
• structureInstanceNumber: integer (int64)
  Title: Structure Instance Number

  Read Only: true

  The chart of accounts instance number associated with the joint venture's business unit.
• transactionAmount: number
  Title: Transaction Amount

  The amount of the transaction reference for the partner contribution.
• transactionCurrencyCode: string
  Title: Transaction Currency

  Read Only: true

  Maximum Length: 15

  The currency code of the partner contribution transaction.
• transactionDate: string (date)
  Title: Transaction Date

  The date on the transaction that was created to open or close the partner contribution.
• transactionId: integer (int64)
  Title: Transaction ID

  Default Value: 0

  The unique identifier of the transaction created to fund or close the partner contribution.
• transactionNumber: string
  Title: Transaction Number

  Maximum Length: 20

  The unique number of the transaction created to fund or close the partner contribution.
• transactionReason: string
  Title: Transaction Reason

  The reason for canceling the partner contribution.
• transactionType: string
  Title: Transaction Type

  Read Only: true

  Maximum Length: 80

  The type of transaction associated with the partner contribution.

{
    "type":"object",
    "properties":{
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the transaction reference for partner contribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "cancelDate":{
            "title":"Cancel Date",
            "type":"string",
            "description":"The date the partner contribution is canceled.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the transaction reference for the partner contribution was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "structureInstanceNumber":{
            "title":"Structure Instance Number",
            "type":"integer",
            "description":"The chart of accounts instance number associated with the joint venture's business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_StructureID":"agreementAccount",
                "precision":18,
                "dependencies":[
                    "coaInstanceNumberJV"
                ]
            },
            "x-queryable":true
        },
        "transactionNumber":{
            "title":"Transaction Number",
            "maxLength":20,
            "type":"string",
            "description":"The unique number of the transaction created to fund or close the partner contribution.",
            "nullable":false,
            "x-queryable":true
        },
        "agreementDefaultCharge":{
            "title":"Agreement Default Charge",
            "type":"number",
            "description":"The amount charged to the partner when the partner contribution is closed.",
            "nullable":true,
            "x-queryable":true
        },
        "contributionReferenceId":{
            "title":"Contribution Reference ID",
            "type":"integer",
            "description":"The unique identifier of the partner contribution transaction reference.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "transactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date on the transaction that was created to open or close the partner contribution.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier of the transaction created to fund or close the partner contribution.",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "transactionReason":{
            "title":"Transaction Reason",
            "type":"string",
            "description":"The reason for canceling the partner contribution.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "transactionReasonLookupCode"
                ]
            },
            "x-queryable":true
        },
        "transactionType":{
            "title":"Transaction Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of transaction associated with the partner contribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "closeDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date the partner contribution is closed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "agreementDefaultChargeAccount":{
            "title":"Agreement Default Charge Account",
            "maxLength":255,
            "type":"string",
            "description":"The account used to record the agreement default charge when closing a partner contribution.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.jointVenture.invoicing.model.view.ContributionReferenceVO#agreementAccount",
                "FND_ACFF_ResourceName":"contributionReferences",
                "ojStructureInstanceNumber":"structureInstanceNumber",
                "dependencies":[
                    "coaInstanceNumberJV",
                    "structureInstanceNumber"
                ]
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "priorContributionStatus":{
            "title":"Prior Contribution Status",
            "maxLength":80,
            "type":"string",
            "description":"The status assigned to the partner contribution before it was canceled, closed, or transferred.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionAmount":{
            "title":"Transaction Amount",
            "type":"number",
            "description":"The amount of the transaction reference for the partner contribution.",
            "nullable":true,
            "x-queryable":true
        },
        "transactionCurrencyCode":{
            "title":"Transaction Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the partner contribution transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "status":{
            "title":"Transaction Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the partner contribution transaction reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "refundAmount":{
            "title":"Refund Amount",
            "type":"number",
            "description":"The amount to return to the partner when the partner contribution is closed.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

attachments

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/attachments

Parameters:

• contributionId: $request.path.contributionId

The attachments resource is used to view, create, and update attachments.

contributionDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionDFF

Parameters:

• contributionId: $request.path.contributionId

contributionReferences

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionReferences

Parameters:

• contributionId: $request.path.contributionId

The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.

Back to Top

Examples

The following example shows how to update a partner contribution by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H Content-Type application/vnd.oracle.adf.resourceitem+json" -X PATCH -d @JVCreate.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/latest/jointVentureContributions/{contributionId)

Request Body Example

The following shows an example of the request body in JSON format.

{
      "contributionAmount": 12500
}

Response Body Example

The following shows an example of the response body in JSON format.

{
  "contributionId": 300100208456391,
  "contributionDescription": "Contribution for GREENCORP",
  "jointVentureShortName": "URBANDEVPROJECTJV",
  "stakeholderShortName": "GREENCORP",
  "startDate": "2017-01-01",
  "contributionStatus": "Pending",
  "contributionAmount": 12500,
  "contributionOpenAmount": null,
  "transactionNumber": null,
  "transactionDate": null,
  "closeType": null,
  "closeDate": null,
  "closeReason": null,
  "agreementDefaultCharge": null,
  "refundAmount": null,
  "createdBy": "username",
  "creationDate": "2020-07-30T19:39:22+00:00",
  "lastUpdatedBy": "username",
  "lastUpdateDate": "2020-07-30T19:50:58+00:00",
  "currencyCode": "USD",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributions/300100208456391",
      "name": "jointVentureContributions",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributions/300100208456391",
      "name": "jointVentureContributions",
      "kind": "item"
    },
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributions/300100208456391/child/contributionDFF",
      "name": "contributionDFF",
      "kind": "collection"
    },
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributions/300100208456391/child/contributionReferences",
      "name": "contributionReferences",
      "kind": "collection"
    }
  ]
}

Back to Top