Get all netting agreements
get
/fscmRestApi/resources/11.13.18.05/nettingAgreements
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the netting agreement that matches the primary key criteria specified.
Finder Variables- AgreementId; integer; The unique identifier of the netting agreement.
- findAgreement Finds the netting agreements that match the search criteria specified.
Finder Variables- ActiveAgreement; string; Indicates whether the agreements are active, inactive, or both.
- AgreementName; string; The name of the netting agreement.
- LegalEntityName; string; The name of the legal entity.
- PartnerReference; string; The trading partner reference text.
- PrimaryKey Finds the netting agreement that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgreementEndDate; string; The end date of the netting agreement.
- AgreementId; integer; The unique identifier of the netting agreement.
- AgreementName; string; The name of the netting agreement.
- AgreementStartDate; string; The start date of the netting agreement.
- AllowDiscountFlag; boolean; Indicates whether discounts are allowed during netting process.
- BankAccountName; string; The name of the netting bank account.
- IncludedPayGroupsCode; string; Indicates whether pay groups should be included or excluded for the netting agreement.
- IncludedTrxTypesCode; string; Indicates whether transaction types should be included or excluded for the netting agreement.
- Language; string; The language for the netting letters.
- LegalEntityName; string; The name of the legal entity associated with the netting agreements.
- LetterBurstingEnabledFlag; boolean; Indicates whether bursting is used to automatically deliver netting letters by email.
- LetterCustomerSiteNumber; string; The site number of the customer trading partner which is used to derive the address location for netting letters.
- LetterEnabledFlag; boolean; Indicates whether netting letters are created for the netting agreement.
- LetterFromEmailAddress; string; The email of the sender of the netting letters.
- LetterFromName; string; The display name of the sender of the netting letters.
- LetterReplyToEmailAddress; string; The reply-to email of the netting letters.
- LetterSupplierSiteCode; string; The site code of the supplier trading partner which is used to derive the address location for netting letters.
- LetterToEmailAddress; string; The email of the recipient of the netting letters.
- NetBalanceRule; string; The balancing rule of the netting agreement.
- NetCurrencyCode; string; The invoice or transaction currency code.
- NetCurrencyRule; string; The currency rule of the netting agreement.
- NetOrderRule; string; The order rule of the netting agreement.
- NettingGroup; string; The netting group assigned to the netting agreement.
- PartnerReference; string; The trading partner reference text.
- PaymentCurrencyCode; string; The settlement currency code.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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:
250
The name of the netting agreement. -
AgreementStartDate: string
(date)
The start date of the netting agreement.
-
AllowDiscountFlag: boolean
Maximum Length:
1
Default Value:false
Indicates whether discounts are allowed during netting process. -
BankAccountName: string
Maximum Length:
255
The name of the netting bank account. -
IncludedPayGroupsCode: string
Maximum Length:
30
Default Value:A
Indicates whether pay groups should be included or excluded for the netting agreement. -
IncludedTrxTypesCode: string
Maximum Length:
30
Default Value:A
Indicates whether transaction types should be included or excluded for the netting agreement. -
Language: string
Maximum Length:
255
The language for the netting letters. -
LegalEntityName: string
Maximum Length:
255
The name of the legal entity associated with the netting agreements. -
LetterBurstingEnabledFlag: boolean
Maximum Length:
1
Indicates whether bursting is used to automatically deliver netting letters by email. -
LetterCustomerSiteNumber: string
Maximum Length:
255
The site number of the customer trading partner which is used to derive the address location for netting letters. -
LetterEnabledFlag: boolean
Maximum Length:
1
Default Value:true
Indicates whether netting letters are created for the netting agreement. -
LetterFromEmailAddress: string
Maximum Length:
240
The email of the sender of the netting letters. -
LetterFromName: string
Maximum Length:
150
The display name of the sender of the netting letters. -
LetterReplyToEmailAddress: string
Maximum Length:
240
The reply-to email of the netting letters. -
LetterSupplierSiteCode: string
Maximum Length:
255
The site code of the supplier trading partner which is used to derive the address location for netting letters. -
LetterToEmailAddress: string
Maximum Length:
240
The email of the recipient of the netting letters. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetBalanceRule: string
Maximum Length:
255
The balancing rule of the netting agreement. -
NetCurrencyCode: string
Maximum Length:
12
The invoice or transaction currency code. -
NetCurrencyRule: string
Maximum Length:
255
The currency rule of the netting agreement. -
NetOrderRule: string
Maximum Length:
255
The order rule of the netting agreement. -
nettingCustomerTradingPartners: array
Customer Trading Partners
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. -
NettingGroup: string
Maximum Length:
255
The netting group assigned to the netting agreement. -
nettingPayablesInvoiceTypes: array
Payables Invoice Types
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. -
nettingPayGroups: array
Pay Groups
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. -
nettingReceivablesTransactionTypes: array
Receivables Transaction Types
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. -
nettingSupplierTradingPartners: array
Supplier Trading Partners
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. -
PartnerReference: string
Maximum Length:
80
The trading partner reference text. -
PaymentCurrencyCode: string
Maximum Length:
15
The settlement currency code.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : 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.
Nested Schema : nettingAgreements-nettingCustomerTradingPartners-item-response
Type:
Show Source
object
-
CustomerAccountNumber: string
Maximum Length:
255
The account number of the customer trading partner. -
CustomerName: string
Maximum Length:
255
The 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:
255
The site of the customer trading partner. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NettingCustomerId: integer
(int64)
The unique identifier of the customer trading partner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : nettingAgreements-nettingPayablesInvoiceTypes-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NettingInvTypeId: integer
(int64)
The unique identifier of the payables invoice type.
-
PayablesInvoiceType: string
Maximum Length:
255
The payables invoice type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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 : nettingAgreements-nettingReceivablesTransactionTypes-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NetTrxTypeId: integer
(int64)
The unique identifier of the netting customer transaction type.
-
TrxType: string
Maximum Length:
255
The customer transaction type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : nettingAgreements-nettingSupplierTradingPartners-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NettingSupplierId: integer
(int64)
The unique identifier of the supplier trading partner.
-
SupplierName: string
Maximum Length:
255
The name of the supplier trading partner. -
SupplierNumber: string
Maximum Length:
255
The 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:
255
The site of the supplier trading partner.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve all the netting agreements by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements?finder=findAgreement;AgreementName=DE NET AGREEMENT
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "AgreementId": 300100542029568, "AgreementName": "DE NET AGREEMENT", "PartnerReference": "DE NET AGREEMENT_REST_API", "AgreementStartDate": "2000-01-01", "AgreementEndDate": "9999-01-01", "LegalEntityName": "eBTax_UK Oracle-2", "BankAccountName": "Netting UK Bank Account", "NetOrderRule": "Due date from oldest to most recent", "NetBalanceRule": "Net always", "NettingGroup": "Netting Reseller Group", "AllowDiscountFlag": true, "NetCurrencyRule": "Use single currency", "NetCurrencyCode": "EUR", "PaymentCurrencyCode": "EUR", "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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "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" } ] }, ... ], "count": 10, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements", "name": "nettingAgreements", "kind": "collection" } ] }