Jump to

• Request
• Response
• Examples

Update a receiver accounting preview for a transaction

patch

/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/{IntercompanyAgreementId}/child/transferAuthorizationGroups/{TransferAuthorizationGroupId}/child/transferAuthorizations/{TransferAuthorizationId}/child/transactions/{TrxId}/child/receiverDistributionLines/{DistId}

Request

Path Parameters

• DistId(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=
• IntercompanyAgreementId(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=
• TransferAuthorizationGroupId(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=
• TransferAuthorizationId(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=
• TrxId(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

• ConversionRateType: string
  Maximum Length: 30

  Currency conversion rate type to convert the settlement currency to the receiver ledger currency that's posted to transaction receiver general ledger.
• Description: string
  Maximum Length: 250

  A brief description of the receiver distribution line.
• ReceiverAccountDistribution: string
  Distribution account code combination of the receiver distribution line.

{
    "type":"object",
    "properties":{
        "ReceiverAccountDistribution":{
            "type":"string",
            "description":"Distribution account code combination of the receiver distribution line.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.commonModules.intercompanyTransactions.restModel.view.ReceiverMasterDistributionLineVO#ReceiverAccDistributionDetails",
                "FND_ACFF_ResourceName":"intercompanyAgreements",
                "ojStructureInstanceNumber":"ReceiverChartOfAccount"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            }
        },
        "Description":{
            "maxLength":"250",
            "type":"string",
            "description":"A brief description of the receiver distribution line.",
            "nullable":true
        },
        "ConversionRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"Currency conversion rate type to convert the settlement currency to the receiver ledger currency that's posted to transaction receiver general ledger.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : intercompanyAgreements-transferAuthorizationGroups-transferAuthorizations-transactions-receiverDistributionLines-item-response

Type: object

Show Source

• AccountedCr: number
  Read Only: true

  Credit amount calculated in the ledger currency.
• AccountedCurrency: string
  Read Only: true

  Maximum Length: 3

  Ledger currency of the transaction recipient.
• AccountedDr: number
  Read Only: true

  Debit amount calculated in the ledger currency.
• AmountCr: number
  Read Only: true

  Settlement credit amount.
• AmountDr: number
  Read Only: true

  Settlement debit amount.
• AmountType: string
  Read Only: true

  Maximum Length: 80

  The abbreviated name that uniquely identifies the amount type. For examples, Principal, Interest, and Expense. These values are used for reporting.
• ConversionRateType: string
  Maximum Length: 30

  Currency conversion rate type to convert the settlement currency to the receiver ledger currency that's posted to transaction receiver general ledger.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the record was created.
• CurrencyConversionDate: string (date)
  Read Only: true

  The date as of which a conversion rate is used to convert the settlement currency to the transaction receiver ledger currency.
• CurrencyConversionRate: number
  Read Only: true

  The conversion rate used to convert the settlement currency to the transaction receiver ledger currency.
• Description: string
  Maximum Length: 250

  A brief description of the receiver distribution line.
• DistId: integer (int64)
  The unique identifier of the intercompany transaction distribution line.
• DistNumber: integer
  The unique number assigned to identify a distribution line in the transaction.
• DistTypeCode: string
  Maximum Length: 1

  Default Value: L

  Indicates whether the distribution line is user created or clearing line. Valid values are L, R, and P.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the record was created.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LedgerName: string
  Read Only: true

  Maximum Length: 30

  Ledger name of the transaction receiver.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyTypeCode: string
  Maximum Length: 1

  Default Value: R

  Indicates whether the distribution is for a provider or receiver. Valid values are P and R.
• ReceiverAccountDistribution: string
  Distribution account code combination of the receiver distribution line.
• SettlementCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Currency in which an intercompany transaction is received by the receiver. This is derived from the transaction.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyConversionRate":{
            "type":"number",
            "description":"The conversion rate used to convert the settlement currency to the transaction receiver ledger currency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"250",
            "type":"string",
            "description":"A brief description of the receiver distribution line.",
            "nullable":true,
            "x-queryable":true
        },
        "AmountDr":{
            "type":"number",
            "description":"Settlement debit amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistNumber":{
            "type":"integer",
            "description":"The unique number assigned to identify a distribution line in the transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "AmountCr":{
            "type":"number",
            "description":"Settlement credit amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DistId":{
            "type":"integer",
            "description":"The unique identifier of the intercompany transaction distribution line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReceiverAccountDistribution":{
            "type":"string",
            "description":"Distribution account code combination of the receiver distribution line.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.commonModules.intercompanyTransactions.restModel.view.ReceiverMasterDistributionLineVO#ReceiverAccDistributionDetails",
                "FND_ACFF_ResourceName":"intercompanyAgreements",
                "ojStructureInstanceNumber":"ReceiverChartOfAccount"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "AccountedCr":{
            "type":"number",
            "description":"Credit amount calculated in the ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountedDr":{
            "type":"number",
            "description":"Debit amount calculated in the ledger currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyConversionDate":{
            "type":"string",
            "description":"The date as of which a conversion rate is used to convert the settlement currency to the transaction receiver ledger currency.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DistTypeCode":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the distribution line is user created or clearing line. Valid values are L, R, and P.",
            "nullable":false,
            "default":"L",
            "x-queryable":true
        },
        "ConversionRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"Currency conversion rate type to convert the settlement currency to the receiver ledger currency that's posted to transaction receiver general ledger.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SettlementCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Currency in which an intercompany transaction is received by the receiver. This is derived from the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AmountType":{
            "maxLength":"80",
            "type":"string",
            "description":"The abbreviated name that uniquely identifies the amount type. For examples, Principal, Interest, and Expense. These values are used for reporting.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyTypeCode":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the distribution is for a provider or receiver. Valid values are P and R.",
            "nullable":false,
            "default":"R",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LedgerName":{
            "maxLength":"30",
            "type":"string",
            "description":"Ledger name of the transaction receiver.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountedCurrency":{
            "maxLength":"3",
            "type":"string",
            "description":"Ledger currency of the transaction recipient.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

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

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

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

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

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

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

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

Nested Schema : properties

Type: object

Show Source

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

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

Back to Top

Examples

The following example shows how to update a receiver accounting preview for a transaction by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/300100581686169/child/transferAuthorizationGroups/300100581684224/child/transferAuthorizations/300100581684225/child/transactions/300100581684226/child/receiverDistributionLines/300100581684229

Example Request Body

The following example shows the contents of the request body in JSON format:

{
    "FileContents": "test"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "AccountedCr": null,
    "AccountedDr": "200.50",
    "AmountCr": null,
    "AmountDr": "401.00",
    "CreatedBy": "FIN_USER1",
    "CreationDate": "2024-02-01T08:55:34.202+00:00",
    "CurrencyConversionDate": "2024-01-01",
    "CurrencyConversionRate": "0.5",
    "Description": null,
    "DistId": "300100581684229",
    "DistNumber": 1,
    "DistTypeCode": "L",
    "SettlementCurrencyCode": "SGD",
    "LastUpdateDate": "2024-02-01T10:23:43+00:00",
    "LastUpdatedBy": "FIN_USER1",
    "PartyTypeCode": "R",
    "ReceiverAccountDistribution": "3111-000-0000-0000-12013-0000-0000-0000",
    "ConversionRateType": "Corporate",
    "AccountedCurrency": "USD",
    "LedgerName": "FusionOne US Primary Ledger",
    "AmountType": "Expense Amount",
    "@context": {
        "key": "300100581684229",
        "headers": {
            "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
        },
        "links": [
            {
                "rel": "self",
                "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/300100581686169/child/transferAuthorizationGroups/300100581684224/child/transferAuthorizations/300100581684225/child/transactions/300100581684226/child/receiverDistributionLines/300100581684229",
                "name": "receiverDistributionLines",
                "kind": "item"
            },
            ...
        ]
    }
}

Back to Top