Update a netting agreement

patch

/fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Netting Agreements resource and used to uniquely identify an instance of Netting Agreements. The client should not generate the hash key value. Instead, the client should query on the Netting Agreements collection resource in order to navigate to a specific instance of Netting Agreements to get the hash key.
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Customer Trading Partners
Type: array
Title: Customer Trading Partners
The customer trading partners resource is used to add, modify, or remove a customer trading partner from a netting agreement. A netting customer trading partner represents a customer that's part of the netting agreement.
Show Source
Nested Schema : Payables Invoice Types
Type: array
Title: Payables Invoice Types
The payables invoice types resource is used to add, modify, or remove invoice types from a netting agreement. An invoice type is used as a selection criteria to include or exclude payables invoices from the netting settlements created for a netting agreement.
Show Source
Nested Schema : Pay Groups
Type: array
Title: Pay Groups
The pay groups resource is used to add, modify, or remove an invoice pay group from a netting agreement. A pay group is used as a selection criteria to include or exclude payables invoices from the netting settlements created for a netting agreement.
Show Source
Nested Schema : Receivables Transaction Types
Type: array
Title: Receivables Transaction Types
The receivables transaction types resource is used to add, modify, or remove transaction types from a netting agreement. A transaction type is used as a selection criteria to include or exclude receivables transactions from the netting settlements created for a netting agreement.
Show Source
Nested Schema : Supplier Trading Partners
Type: array
Title: Supplier Trading Partners
The supplier trading partners resource is used to add, modify, or remove a supplier trading partner from a netting agreement. A netting supplier trading partner represents a supplier that's part of the netting agreement.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : nettingAgreements-nettingReceivablesTransactionTypes-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : nettingAgreements-item-response
Type: object
Show Source
Nested Schema : Customer Trading Partners
Type: array
Title: Customer Trading Partners
The customer trading partners resource is used to add, modify, or remove a customer trading partner from a netting agreement. A netting customer trading partner represents a customer that's part of the netting agreement.
Show Source
Nested Schema : Payables Invoice Types
Type: array
Title: Payables Invoice Types
The payables invoice types resource is used to add, modify, or remove invoice types from a netting agreement. An invoice type is used as a selection criteria to include or exclude payables invoices from the netting settlements created for a netting agreement.
Show Source
Nested Schema : Pay Groups
Type: array
Title: Pay Groups
The pay groups resource is used to add, modify, or remove an invoice pay group from a netting agreement. A pay group is used as a selection criteria to include or exclude payables invoices from the netting settlements created for a netting agreement.
Show Source
Nested Schema : Receivables Transaction Types
Type: array
Title: Receivables Transaction Types
The receivables transaction types resource is used to add, modify, or remove transaction types from a netting agreement. A transaction type is used as a selection criteria to include or exclude receivables transactions from the netting settlements created for a netting agreement.
Show Source
Nested Schema : Supplier Trading Partners
Type: array
Title: Supplier Trading Partners
The supplier trading partners resource is used to add, modify, or remove a supplier trading partner from a netting agreement. A netting supplier trading partner represents a supplier that's part of the netting agreement.
Show Source
Nested Schema : nettingAgreements-nettingCustomerTradingPartners-item-response
Type: object
Show Source
Nested Schema : nettingAgreements-nettingPayablesInvoiceTypes-item-response
Type: object
Show Source
Nested Schema : nettingAgreements-nettingPayGroups-item-response
Type: object
Show Source
Nested Schema : nettingAgreements-nettingReceivablesTransactionTypes-item-response
Type: object
Show Source
Nested Schema : nettingAgreements-nettingSupplierTradingPartners-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to update an an agreement 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/nettingAgreements/300100542029568

Example Request Payload

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

{
	"AgreementName": "DE NET AGREEMENT",
	"PartnerReference": "DE NET AGREEMENT_REST_API_UPD",
	"AgreementStartDate": "2000-01-02",
	"AgreementEndDate": "9999-01-02",
	"LegalEntityName": "eBTax_UK Oracle-2",
	"BankAccountName": "Netting UK Bank Account",
	"NetOrderRule": "Ascending amount",
	"NetBalanceRule": "Net when Payables is greater than Receivables",
	"NettingGroup": null,
	"AllowDiscountFlag": false,
	"NetCurrencyRule": "Use single currency",
	"NetCurrencyCode": "USD",
	"PaymentCurrencyCode": "GBP"
}

Example Response Body

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

{
    "AgreementId": 300100542029568,
    "AgreementName": "DE NET AGREEMENT",
    "PartnerReference": "DE NET AGREEMENT_REST_API_UPD",
    "AgreementStartDate": "2000-01-02",
    "AgreementEndDate": "9999-01-02",
    "LegalEntityName": "eBTax_UK Oracle-2",
    "BankAccountName": "Netting UK Bank Account",
    "NetOrderRule": "Ascending amount",
    "NetBalanceRule": "Net when Payables is greater than Receivables",
    "NettingGroup": null,
    "AllowDiscountFlag": false,
    "NetCurrencyRule": "Use single currency",
    "NetCurrencyCode": "USD",
    "PaymentCurrencyCode": "GBP",
    "LetterEnabledFlag": false,
    "LetterBurstingEnabledFlag": null,
    "Language": null,
    "SiteAddress": null,
    "LetterToEmailAddress": null,
    "LetterFromEmailAddress": null,
    "LetterFromName": null,
    "LetterReplyToEmailAddress": null,
    "IncludedPayGroupsCode": "A",
    "IncludedTrxTypesCode": "A",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568",
            "name": "nettingAgreements",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568",
            "name": "nettingAgreements",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingCustomerTradingPartners",
            "name": "nettingCustomerTradingPartners",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingPayGroups",
            "name": "nettingPayGroups",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingPayablesInvoiceTypes",
            "name": "nettingPayablesInvoiceTypes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingReceivablesTransactionTypes",
            "name": "nettingReceivablesTransactionTypes",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingSupplierTradingPartners",
            "name": "nettingSupplierTradingPartners",
            "kind": "collection"
        }
    ]
}
Back to Top