Update a netting agreement
patch
/fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}
Request
Path Parameters
-
nettingAgreementsUniqID(required): string
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
-
Metadata-Context: string
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: string
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
Root Schema : schema
Type:
Show Source
object-
AgreementEndDate: string
(date)
The end date of the netting agreement.
-
AgreementStartDate: string
(date)
The start date of the netting agreement.
-
AllowDiscountFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether discounts are allowed during netting process. -
BankAccountName: string
Maximum Length:
255The name of the netting bank account. -
IncludedPayGroupsCode: string
Maximum Length:
30Default Value:AIndicates whether pay groups should be included or excluded for the netting agreement. -
IncludedTrxTypesCode: string
Maximum Length:
30Default Value:AIndicates whether transaction types should be included or excluded for the netting agreement. -
Language: string
Maximum Length:
255The language for the netting letters. -
LetterBurstingEnabledFlag: boolean
Maximum Length:
1Indicates whether bursting is used to automatically deliver netting letters by email. -
LetterCustomerSiteNumber: string
Maximum Length:
255The site number of the customer trading partner which is used to derive the address location for netting letters. -
LetterEnabledFlag: boolean
Maximum Length:
1Default Value:trueIndicates whether netting letters are created for the netting agreement. -
LetterFromEmailAddress: string
Maximum Length:
240The email of the sender of the netting letters. -
LetterFromName: string
Maximum Length:
150The display name of the sender of the netting letters. -
LetterReplyToEmailAddress: string
Maximum Length:
240The reply-to email of the netting letters. -
LetterSupplierSiteCode: string
Maximum Length:
255The site code of the supplier trading partner which is used to derive the address location for netting letters. -
LetterToEmailAddress: string
Maximum Length:
240The email of the recipient of the netting letters. -
NetBalanceRule: string
Maximum Length:
255The balancing rule of the netting agreement. -
NetCurrencyCode: string
Maximum Length:
12The invoice or transaction currency code. -
NetCurrencyRule: string
Maximum Length:
255The currency rule of the netting agreement. -
NetOrderRule: string
Maximum Length:
255The order rule of the netting agreement. -
nettingCustomerTradingPartners: array
Customer Trading Partners
Title:
Customer Trading PartnersThe 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. -
NettingGroup: string
Maximum Length:
255The netting group assigned to the netting agreement. -
nettingPayablesInvoiceTypes: array
Payables Invoice Types
Title:
Payables Invoice TypesThe 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. -
nettingPayGroups: array
Pay Groups
Title:
Pay GroupsThe 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. -
nettingReceivablesTransactionTypes: array
Receivables Transaction Types
Title:
Receivables Transaction TypesThe 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. -
nettingSupplierTradingPartners: array
Supplier Trading Partners
Title:
Supplier Trading PartnersThe 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. -
PartnerReference: string
Maximum Length:
80The trading partner reference text. -
PaymentCurrencyCode: string
Maximum Length:
15The settlement currency code.
Nested Schema : Customer Trading Partners
Type:
arrayTitle:
Customer Trading PartnersThe 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:
arrayTitle:
Payables Invoice TypesThe 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:
arrayTitle:
Pay GroupsThe 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:
arrayTitle:
Receivables Transaction TypesThe 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:
arrayTitle:
Supplier Trading PartnersThe 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:
Show Source
object-
CustomerAccountNumber: string
Maximum Length:
255The account number of the customer trading partner. -
CustomerName: string
Maximum Length:
255The name of the customer trading partner. -
CustomerPriority: integer
(int64)
Indicates the priority of the customer trading partner in the netting agreement.
-
CustomerSite: string
Maximum Length:
255The site of the customer trading partner. -
NettingCustomerId: integer
(int64)
The unique identifier of the customer trading partner.
Nested Schema : schema
Type:
Show Source
object-
NettingInvTypeId: integer
(int64)
The unique identifier of the payables invoice type.
-
PayablesInvoiceType: string
Maximum Length:
255The payables invoice type.
Nested Schema : schema
Type:
Show Source
object-
NettingPayGroupId: integer
(int64)
The unique identifier of the pay group.
-
PayGroup: string
Maximum Length:
255The pay group associated with the netting agreement.
Nested Schema : nettingAgreements-nettingReceivablesTransactionTypes-item-patch-request
Type:
Show Source
object-
NetTrxTypeId: integer
(int64)
The unique identifier of the netting customer transaction type.
-
TrxType: string
Maximum Length:
255The customer transaction type.
Nested Schema : schema
Type:
Show Source
object-
NettingSupplierId: integer
(int64)
The unique identifier of the supplier trading partner.
-
SupplierName: string
Maximum Length:
255The name of the supplier trading partner. -
SupplierNumber: string
Maximum Length:
255The number of the supplier trading partner. -
SupplierPriority: integer
(int64)
Indicates the priority of the supplier trading partner in the netting agreement.
-
SupplierSite: string
Maximum Length:
255The site of the supplier trading partner.
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.
Root Schema : nettingAgreements-item-response
Type:
Show Source
object-
AgreementEndDate: string
(date)
The end date of the netting agreement.
-
AgreementId: integer
(int64)
The unique identifier of the netting agreement.
-
AgreementName: string
Maximum Length:
250The name of the netting agreement. -
AgreementStartDate: string
(date)
The start date of the netting agreement.
-
AllowDiscountFlag: boolean
Maximum Length:
1Default Value:falseIndicates whether discounts are allowed during netting process. -
BankAccountName: string
Maximum Length:
255The name of the netting bank account. -
IncludedPayGroupsCode: string
Maximum Length:
30Default Value:AIndicates whether pay groups should be included or excluded for the netting agreement. -
IncludedTrxTypesCode: string
Maximum Length:
30Default Value:AIndicates whether transaction types should be included or excluded for the netting agreement. -
Language: string
Maximum Length:
255The language for the netting letters. -
LegalEntityName: string
Maximum Length:
255The name of the legal entity associated with the netting agreements. -
LetterBurstingEnabledFlag: boolean
Maximum Length:
1Indicates whether bursting is used to automatically deliver netting letters by email. -
LetterCustomerSiteNumber: string
Maximum Length:
255The site number of the customer trading partner which is used to derive the address location for netting letters. -
LetterEnabledFlag: boolean
Maximum Length:
1Default Value:trueIndicates whether netting letters are created for the netting agreement. -
LetterFromEmailAddress: string
Maximum Length:
240The email of the sender of the netting letters. -
LetterFromName: string
Maximum Length:
150The display name of the sender of the netting letters. -
LetterReplyToEmailAddress: string
Maximum Length:
240The reply-to email of the netting letters. -
LetterSupplierSiteCode: string
Maximum Length:
255The site code of the supplier trading partner which is used to derive the address location for netting letters. -
LetterToEmailAddress: string
Maximum Length:
240The email of the recipient of the netting letters. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NetBalanceRule: string
Maximum Length:
255The balancing rule of the netting agreement. -
NetCurrencyCode: string
Maximum Length:
12The invoice or transaction currency code. -
NetCurrencyRule: string
Maximum Length:
255The currency rule of the netting agreement. -
NetOrderRule: string
Maximum Length:
255The order rule of the netting agreement. -
nettingCustomerTradingPartners: array
Customer Trading Partners
Title:
Customer Trading PartnersThe 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. -
NettingGroup: string
Maximum Length:
255The netting group assigned to the netting agreement. -
nettingPayablesInvoiceTypes: array
Payables Invoice Types
Title:
Payables Invoice TypesThe 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. -
nettingPayGroups: array
Pay Groups
Title:
Pay GroupsThe 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. -
nettingReceivablesTransactionTypes: array
Receivables Transaction Types
Title:
Receivables Transaction TypesThe 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. -
nettingSupplierTradingPartners: array
Supplier Trading Partners
Title:
Supplier Trading PartnersThe 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. -
PartnerReference: string
Maximum Length:
80The trading partner reference text. -
PaymentCurrencyCode: string
Maximum Length:
15The settlement currency code.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Customer Trading Partners
Type:
arrayTitle:
Customer Trading PartnersThe 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:
arrayTitle:
Payables Invoice TypesThe 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:
arrayTitle:
Pay GroupsThe 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:
arrayTitle:
Receivables Transaction TypesThe 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:
arrayTitle:
Supplier Trading PartnersThe 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 : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : nettingAgreements-nettingCustomerTradingPartners-item-response
Type:
Show Source
object-
CustomerAccountNumber: string
Maximum Length:
255The account number of the customer trading partner. -
CustomerName: string
Maximum Length:
255The name of the customer trading partner. -
CustomerPriority: integer
(int64)
Indicates the priority of the customer trading partner in the netting agreement.
-
CustomerSite: string
Maximum Length:
255The site of the customer trading partner. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NettingCustomerId: integer
(int64)
The unique identifier of the customer trading partner.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : nettingAgreements-nettingPayablesInvoiceTypes-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NettingInvTypeId: integer
(int64)
The unique identifier of the payables invoice type.
-
PayablesInvoiceType: string
Maximum Length:
255The payables invoice type.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : nettingAgreements-nettingPayGroups-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NettingPayGroupId: integer
(int64)
The unique identifier of the pay group.
-
PayGroup: string
Maximum Length:
255The pay group associated with the netting agreement.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : nettingAgreements-nettingReceivablesTransactionTypes-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NetTrxTypeId: integer
(int64)
The unique identifier of the netting customer transaction type.
-
TrxType: string
Maximum Length:
255The customer transaction type.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : nettingAgreements-nettingSupplierTradingPartners-item-response
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NettingSupplierId: integer
(int64)
The unique identifier of the supplier trading partner.
-
SupplierName: string
Maximum Length:
255The name of the supplier trading partner. -
SupplierNumber: string
Maximum Length:
255The number of the supplier trading partner. -
SupplierPriority: integer
(int64)
Indicates the priority of the supplier trading partner in the netting agreement.
-
SupplierSite: string
Maximum Length:
255The site of the supplier trading partner.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- nettingCustomerTradingPartners
-
Parameters:
- nettingAgreementsUniqID:
$request.path.nettingAgreementsUniqID
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. - nettingAgreementsUniqID:
- nettingPayGroups
-
Parameters:
- nettingAgreementsUniqID:
$request.path.nettingAgreementsUniqID
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. - nettingAgreementsUniqID:
- nettingPayablesInvoiceTypes
-
Parameters:
- nettingAgreementsUniqID:
$request.path.nettingAgreementsUniqID
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. - nettingAgreementsUniqID:
- nettingReceivablesTransactionTypes
-
Parameters:
- nettingAgreementsUniqID:
$request.path.nettingAgreementsUniqID
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. - nettingAgreementsUniqID:
- nettingSupplierTradingPartners
-
Parameters:
- nettingAgreementsUniqID:
$request.path.nettingAgreementsUniqID
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. - nettingAgreementsUniqID:
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"
}
]
}