Create a pay group
post
/fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/nettingPayGroups
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:
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
NettingPayGroupId: integer
(int64)
The unique identifier of the pay group.
-
PayGroup: string
Maximum Length:
255
The pay group associated with the netting agreement.
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-nettingPayGroups-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NettingPayGroupId: integer
(int64)
The unique identifier of the pay group.
-
PayGroup: string
Maximum Length:
255
The pay group associated with the netting agreement.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to add a pay group to an agreement by submitting a POST request on the REST resource using cURL.
Note:
Before you can add a new pay group, you must select either the Only Include or Only Exclude option for the pay groups. You must also select at least one pay group already associated with the netting agreement.curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingPayGroups
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "PayGroup" : "PG1" }
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": "Netting Reseller Group", "AllowDiscountFlag": false, "NetCurrencyRule": "Use single currency", "NetCurrencyCode": "USD", "PaymentCurrencyCode": "GBP", "LetterEnabledFlag": false, "LetterBurstingEnabledFlag": null, "Language": null, "SiteAddress": "5, boulevard Charlesde Gaulle 92715 COLOMBES CEDEX FRANCE", "LetterToEmailAddress": null, "LetterFromEmailAddress": null, "LetterFromName": null, "LetterReplyToEmailAddress": null, "IncludedPayGroupsCode": "I", "IncludedTrxTypesCode": "A", "nettingPayGroups": [ { "NettingPayGroupId": 300100542034026, "PayGroup": "PG1", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingPayGroups/300100542034026", "name": "nettingPayGroups", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingPayGroups/300100542034026", "name": "nettingPayGroups", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568", "name": "nettingAgreements", "kind": "item" } ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568", "name": "nettingAgreements", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578" } }, { "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" } ] }