Jump to

• Request
• Response
• Examples

Create a netting agreement

post

/fscmRestApi/resources/11.13.18.05/nettingAgreements

Request

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AgreementEndDate: string (date)
  The end date of the netting agreement.
• AgreementId: integer (int64)
  The unique identifier of the netting agreement.
• AgreementName(required): string
  Maximum Length: 250

  The name of the netting agreement.
• AgreementStartDate(required): 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.
• 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.

{
    "required":[
        "AgreementName",
        "AgreementStartDate"
    ],
    "type":"object",
    "properties":{
        "nettingSupplierTradingPartners":{
            "title":"Supplier Trading Partners",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/nettingAgreements-nettingSupplierTradingPartners-item-post-request"
            }
        },
        "AllowDiscountFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether discounts are allowed during netting process.",
            "nullable":false,
            "default":false
        },
        "LetterEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether netting letters are created for the netting agreement.",
            "nullable":true,
            "default":true
        },
        "nettingPayablesInvoiceTypes":{
            "title":"Payables Invoice Types",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/nettingAgreements-nettingPayablesInvoiceTypes-item-post-request"
            }
        },
        "IncludedTrxTypesCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether transaction types should be included or excluded for the netting agreement.",
            "nullable":true,
            "default":"A"
        },
        "NetOrderRule":{
            "maxLength":255,
            "type":"string",
            "description":"The order rule of the netting agreement.",
            "nullable":true
        },
        "NetCurrencyCode":{
            "maxLength":12,
            "type":"string",
            "description":"The invoice or transaction currency code.",
            "nullable":true
        },
        "AgreementName":{
            "maxLength":250,
            "type":"string",
            "description":"The name of the netting agreement.",
            "nullable":false
        },
        "AgreementEndDate":{
            "type":"string",
            "description":"The end date of the netting agreement.",
            "format":"date",
            "nullable":true
        },
        "Language":{
            "maxLength":255,
            "type":"string",
            "description":"The language for the netting letters.",
            "nullable":true
        },
        "LetterBurstingEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether bursting is used to automatically deliver netting letters by email.",
            "nullable":true
        },
        "LegalEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the legal entity associated with the netting agreements.",
            "nullable":true
        },
        "nettingCustomerTradingPartners":{
            "title":"Customer Trading Partners",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/nettingAgreements-nettingCustomerTradingPartners-item-post-request"
            }
        },
        "LetterReplyToEmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The reply-to email of the netting letters.",
            "nullable":true
        },
        "NettingGroup":{
            "maxLength":255,
            "type":"string",
            "description":"The netting group assigned to the netting agreement.",
            "nullable":true
        },
        "LetterToEmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The email of the recipient of the netting letters.",
            "nullable":true
        },
        "LetterCustomerSiteNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The site number of the customer trading partner which is used to derive the address location for netting letters.",
            "nullable":true
        },
        "LetterSupplierSiteCode":{
            "maxLength":255,
            "type":"string",
            "description":"The site code of the supplier trading partner which is used to derive the address location for netting letters.",
            "nullable":true
        },
        "AgreementId":{
            "type":"integer",
            "description":"The unique identifier of the netting agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "LetterFromEmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The email of the sender of the netting letters.",
            "nullable":true
        },
        "IncludedPayGroupsCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether pay groups should be included or excluded for the netting agreement.",
            "nullable":true,
            "default":"A"
        },
        "NetCurrencyRule":{
            "maxLength":255,
            "type":"string",
            "description":"The currency rule of the netting agreement.",
            "nullable":true
        },
        "nettingPayGroups":{
            "title":"Pay Groups",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/nettingAgreements-nettingPayGroups-item-post-request"
            }
        },
        "nettingReceivablesTransactionTypes":{
            "title":"Receivables Transaction Types",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/nettingAgreements-nettingReceivablesTransactionTypes-item-post-request"
            }
        },
        "NetBalanceRule":{
            "maxLength":255,
            "type":"string",
            "description":"The balancing rule of the netting agreement.",
            "nullable":true
        },
        "PartnerReference":{
            "maxLength":80,
            "type":"string",
            "description":"The trading partner reference text.",
            "nullable":true
        },
        "BankAccountName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the netting bank account.",
            "nullable":true
        },
        "PaymentCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The settlement currency code.",
            "nullable":true
        },
        "AgreementStartDate":{
            "type":"string",
            "description":"The start date of the netting agreement.",
            "format":"date",
            "nullable":false
        },
        "LetterFromName":{
            "maxLength":150,
            "type":"string",
            "description":"The display name of the sender of the netting letters.",
            "nullable":true
        }
    }
}

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

• Array of: object nettingAgreements-nettingCustomerTradingPartners-item-post-request

{
    "title":"Customer Trading Partners",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/nettingAgreements-nettingCustomerTradingPartners-item-post-request"
    }
}

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

• Array of: object nettingAgreements-nettingPayablesInvoiceTypes-item-post-request

{
    "title":"Payables Invoice Types",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/nettingAgreements-nettingPayablesInvoiceTypes-item-post-request"
    }
}

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

• Array of: object nettingAgreements-nettingPayGroups-item-post-request

{
    "title":"Pay Groups",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/nettingAgreements-nettingPayGroups-item-post-request"
    }
}

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

• Array of: object nettingAgreements-nettingReceivablesTransactionTypes-item-post-request

{
    "title":"Receivables Transaction Types",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/nettingAgreements-nettingReceivablesTransactionTypes-item-post-request"
    }
}

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

• Array of: object nettingAgreements-nettingSupplierTradingPartners-item-post-request

{
    "title":"Supplier Trading Partners",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/nettingAgreements-nettingSupplierTradingPartners-item-post-request"
    }
}

Nested Schema : nettingAgreements-nettingCustomerTradingPartners-item-post-request

Type: object

Show Source

• 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.
• NettingCustomerId: integer (int64)
  The unique identifier of the customer trading partner.

{
    "type":"object",
    "properties":{
        "CustomerSite":{
            "maxLength":255,
            "type":"string",
            "description":"The site of the customer trading partner.",
            "nullable":true
        },
        "CustomerPriority":{
            "type":"integer",
            "description":"Indicates the priority of the customer trading partner in the netting agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the customer trading partner.",
            "nullable":true
        },
        "CustomerAccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The account number of the customer trading partner.",
            "nullable":true
        },
        "NettingCustomerId":{
            "type":"integer",
            "description":"The unique identifier of the customer trading partner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Nested Schema : nettingAgreements-nettingPayablesInvoiceTypes-item-post-request

Type: object

Show Source

• NettingInvTypeId: integer (int64)
  The unique identifier of the payables invoice type.
• PayablesInvoiceType: string
  Maximum Length: 255

  The payables invoice type.

{
    "type":"object",
    "properties":{
        "NettingInvTypeId":{
            "type":"integer",
            "description":"The unique identifier of the payables invoice type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PayablesInvoiceType":{
            "maxLength":255,
            "type":"string",
            "description":"The payables invoice type.",
            "nullable":true
        }
    }
}

Nested Schema : nettingAgreements-nettingPayGroups-item-post-request

Type: object

Show Source

• NettingPayGroupId: integer (int64)
  The unique identifier of the pay group.
• PayGroup: string
  Maximum Length: 255

  The pay group associated with the netting agreement.

{
    "type":"object",
    "properties":{
        "NettingPayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PayGroup":{
            "maxLength":255,
            "type":"string",
            "description":"The pay group associated with the netting agreement.",
            "nullable":true
        }
    }
}

Nested Schema : nettingAgreements-nettingReceivablesTransactionTypes-item-post-request

Type: object

Show Source

• NetTrxTypeId: integer (int64)
  The unique identifier of the netting customer transaction type.
• TrxType: string
  Maximum Length: 255

  The customer transaction type.

{
    "type":"object",
    "properties":{
        "TrxType":{
            "maxLength":255,
            "type":"string",
            "description":"The customer transaction type.",
            "nullable":true
        },
        "NetTrxTypeId":{
            "type":"integer",
            "description":"The unique identifier of the netting customer transaction type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Nested Schema : nettingAgreements-nettingSupplierTradingPartners-item-post-request

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "SupplierPriority":{
            "type":"integer",
            "description":"Indicates the priority of the supplier trading partner in the netting agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "NettingSupplierId":{
            "type":"integer",
            "description":"The unique identifier of the supplier trading partner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "SupplierNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The number of the supplier trading partner.",
            "nullable":true
        },
        "SupplierName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the supplier trading partner.",
            "nullable":true
        },
        "SupplierSite":{
            "maxLength":255,
            "type":"string",
            "description":"The site of the supplier trading partner.",
            "nullable":true
        }
    }
}

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 : nettingAgreements-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "nettingSupplierTradingPartners":{
            "title":"Supplier Trading Partners",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/nettingAgreements-nettingSupplierTradingPartners-item-response"
            }
        },
        "AllowDiscountFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether discounts are allowed during netting process.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "LetterEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether netting letters are created for the netting agreement.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "nettingPayablesInvoiceTypes":{
            "title":"Payables Invoice Types",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/nettingAgreements-nettingPayablesInvoiceTypes-item-response"
            }
        },
        "IncludedTrxTypesCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether transaction types should be included or excluded for the netting agreement.",
            "nullable":true,
            "default":"A",
            "x-queryable":true
        },
        "NetOrderRule":{
            "maxLength":255,
            "type":"string",
            "description":"The order rule of the netting agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "NetCurrencyCode":{
            "maxLength":12,
            "type":"string",
            "description":"The invoice or transaction currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "AgreementName":{
            "maxLength":250,
            "type":"string",
            "description":"The name of the netting agreement.",
            "nullable":false,
            "x-queryable":true
        },
        "AgreementEndDate":{
            "type":"string",
            "description":"The end date of the netting agreement.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":255,
            "type":"string",
            "description":"The language for the netting letters.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterBurstingEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether bursting is used to automatically deliver netting letters by email.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the legal entity associated with the netting agreements.",
            "nullable":true,
            "x-queryable":true
        },
        "nettingCustomerTradingPartners":{
            "title":"Customer Trading Partners",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/nettingAgreements-nettingCustomerTradingPartners-item-response"
            }
        },
        "LetterReplyToEmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The reply-to email of the netting letters.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NettingGroup":{
            "maxLength":255,
            "type":"string",
            "description":"The netting group assigned to the netting agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterToEmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The email of the recipient of the netting letters.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterCustomerSiteNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The site number of the customer trading partner which is used to derive the address location for netting letters.",
            "nullable":true,
            "x-queryable":true
        },
        "LetterSupplierSiteCode":{
            "maxLength":255,
            "type":"string",
            "description":"The site code of the supplier trading partner which is used to derive the address location for netting letters.",
            "nullable":true,
            "x-queryable":true
        },
        "AgreementId":{
            "type":"integer",
            "description":"The unique identifier of the netting agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LetterFromEmailAddress":{
            "maxLength":240,
            "type":"string",
            "description":"The email of the sender of the netting letters.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedPayGroupsCode":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether pay groups should be included or excluded for the netting agreement.",
            "nullable":true,
            "default":"A",
            "x-queryable":true
        },
        "NetCurrencyRule":{
            "maxLength":255,
            "type":"string",
            "description":"The currency rule of the netting agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "nettingPayGroups":{
            "title":"Pay Groups",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/nettingAgreements-nettingPayGroups-item-response"
            }
        },
        "nettingReceivablesTransactionTypes":{
            "title":"Receivables Transaction Types",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/nettingAgreements-nettingReceivablesTransactionTypes-item-response"
            }
        },
        "NetBalanceRule":{
            "maxLength":255,
            "type":"string",
            "description":"The balancing rule of the netting agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerReference":{
            "maxLength":80,
            "type":"string",
            "description":"The trading partner reference text.",
            "nullable":true,
            "x-queryable":true
        },
        "BankAccountName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the netting bank account.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The settlement currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "AgreementStartDate":{
            "type":"string",
            "description":"The start date of the netting agreement.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "LetterFromName":{
            "maxLength":150,
            "type":"string",
            "description":"The display name of the sender of the netting letters.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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 : 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

• Array of: object nettingAgreements-nettingCustomerTradingPartners-item-response

{
    "title":"Customer Trading Partners",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/nettingAgreements-nettingCustomerTradingPartners-item-response"
    }
}

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

• Array of: object nettingAgreements-nettingPayablesInvoiceTypes-item-response

{
    "title":"Payables Invoice Types",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/nettingAgreements-nettingPayablesInvoiceTypes-item-response"
    }
}

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

• Array of: object nettingAgreements-nettingPayGroups-item-response

{
    "title":"Pay Groups",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/nettingAgreements-nettingPayGroups-item-response"
    }
}

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

• Array of: object nettingAgreements-nettingReceivablesTransactionTypes-item-response

{
    "title":"Receivables Transaction Types",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/nettingAgreements-nettingReceivablesTransactionTypes-item-response"
    }
}

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

• Array of: object nettingAgreements-nettingSupplierTradingPartners-item-response

{
    "title":"Supplier Trading Partners",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/nettingAgreements-nettingSupplierTradingPartners-item-response"
    }
}

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."
        }
    }
}

Nested Schema : nettingAgreements-nettingCustomerTradingPartners-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CustomerSite":{
            "maxLength":255,
            "type":"string",
            "description":"The site of the customer trading partner.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerPriority":{
            "type":"integer",
            "description":"Indicates the priority of the customer trading partner in the netting agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the customer trading partner.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The account number of the customer trading partner.",
            "nullable":true,
            "x-queryable":true
        },
        "NettingCustomerId":{
            "type":"integer",
            "description":"The unique identifier of the customer trading partner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

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 : nettingAgreements-nettingPayablesInvoiceTypes-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "NettingInvTypeId":{
            "type":"integer",
            "description":"The unique identifier of the payables invoice type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PayablesInvoiceType":{
            "maxLength":255,
            "type":"string",
            "description":"The payables invoice type.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : nettingAgreements-nettingPayGroups-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "NettingPayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PayGroup":{
            "maxLength":255,
            "type":"string",
            "description":"The pay group associated with the netting agreement.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : nettingAgreements-nettingReceivablesTransactionTypes-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TrxType":{
            "maxLength":255,
            "type":"string",
            "description":"The customer transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "NetTrxTypeId":{
            "type":"integer",
            "description":"The unique identifier of the netting customer transaction type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

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 : nettingAgreements-nettingSupplierTradingPartners-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SupplierPriority":{
            "type":"integer",
            "description":"Indicates the priority of the supplier trading partner in the netting agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NettingSupplierId":{
            "type":"integer",
            "description":"The unique identifier of the supplier trading partner.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The number of the supplier trading partner.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the supplier trading partner.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":255,
            "type":"string",
            "description":"The site of the supplier trading partner.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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"
    }
}

Links

nettingCustomerTradingPartners

Operation: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/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.

nettingPayGroups

Operation: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/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.

nettingPayablesInvoiceTypes

Operation: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/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.

nettingReceivablesTransactionTypes

Operation: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/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.

nettingSupplierTradingPartners

Operation: /fscmRestApi/resources/11.13.18.05/nettingAgreements/{nettingAgreementsUniqID}/child/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.

Back to Top

Examples

The following example shows how to create a netting agreement by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements

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",
	"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,
	"IncludedPayGroupsCode": "A",
	"IncludedTrxTypesCode": "A",
	"nettingPayablesInvoiceTypes":[
		{"PayablesInvoiceType" : "Standard"}
		],
	"nettingCustomerTradingPartners": [ 
		{"CustomerPriority": 1,
		"CustomerName": "DE Int Customer",
		"CustomerAccountNumber": "CDRM_24119",
		"CustomerSite": "CDRM_188315"}
		],
	"nettingSupplierTradingPartners":[
		{"SupplierPriority": 1,
		"SupplierName": "DE Int Supplier",
		"SupplierNumber": "1407514811",
		"SupplierSite": "FR OFFICE"}
		]
}

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",
	"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",
	"nettingSupplierTradingPartners": [
	{
		"NettingSupplierId": 300100542029573,
		"SupplierPriority": 1,
		"SupplierName": "DE Int Supplier",
		"SupplierNumber": "1407514811",
		"SupplierSite": "FR OFFICE",
		"links": [
		{
		"rel": "self",
		"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingSupplierTradingPartners/300100542029573",
		"name": "nettingSupplierTradingPartners",
		"kind": "item",
		"properties": {
		"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
		},
		{
		"rel": "canonical",
		"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingSupplierTradingPartners/300100542029573",
		"name": "nettingSupplierTradingPartners",
		"kind": "item"
		},
		{
		"rel": "parent",
		"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568",
		"name": "nettingAgreements",
		"kind": "item"
		}
		]
	}
	],
	"nettingPayablesInvoiceTypes": [
	{
		"NettingInvTypeId": 300100542029571,
		"PayablesInvoiceType": "Standard",
		"links": [
		{
		"rel": "self",
		"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingPayablesInvoiceTypes/300100542029571",
		"name": "nettingPayablesInvoiceTypes",
		"kind": "item",
		"properties": {
		"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
		},
		{
		"rel": "canonical",
		"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingPayablesInvoiceTypes/300100542029571",
		"name": "nettingPayablesInvoiceTypes",
		"kind": "item"
		},
		{
		"rel": "parent",
		"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568",
		"name": "nettingAgreements",
		"kind": "item"
		}
		]
	}
	],
	"nettingCustomerTradingPartners": [
	{
		"NettingCustomerId": 300100542029572,
		"CustomerPriority": 1,
		"CustomerName": "DE Int Customer",
		"CustomerAccountNumber": "CDRM_24119",
		"CustomerSite": "CDRM_188315",
		"links": [
		{
		"rel": "self",
		"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingCustomerTradingPartners/300100542029572",
		"name": "nettingCustomerTradingPartners",
		"kind": "item",
		"properties": {
		"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
		},
		{
		"rel": "canonical",
		"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/nettingAgreements/300100542029568/child/nettingCustomerTradingPartners/300100542029572",
		"name": "nettingCustomerTradingPartners",
		"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": "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"
	}
	]
}

Back to Top