Jump to

• Request
• Response

Get one settlement method

get

/fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementMethods/{SettlementMethodId}

Request

Path Parameters

• ClaimId(required): integer(int64)
  Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.
• SettlementMethodId(required): integer(int64)
  Value that uniquely identifies the settlement method.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 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 : channelCustomerClaims-settlementMethods-item-response

Type: object

Show Source

• ChargebackReason: string
  Maximum Length: 255

  Reason for the chargeback.
• ChargebackReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the chargeback reason.
• ChargebackTransactionType: string
  Maximum Length: 255

  Name of the transaction type.
• ChargebackTransactionTypeId: integer (int64)
  Value that uniquely identifies the transaction type.
• ClaimAmountIncludesTax: string
  Maximum Length: 255

  Value that indicates if the claim amount includes tax.
• ClaimAmountIncludesTaxCode: string
  Maximum Length: 255

  Abbreviation that indicates if the claim amount includes tax.
• ClaimId: integer (int64)
  Read Only: true

  Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• CreditMemoReason: string
  Reason for the credit memo.
• CreditMemoReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the credit memo reason.
• CreditMemoTransactionType: string
  Name of the transaction type.
• CreditMemoTransactionTypeSequenceId: integer (int64)
  Value that uniquely identifies the transaction type.
• InvoiceTransactionType: string
  Maximum Length: 255

  Name of the transaction type.
• InvoiceTransactionTypeId: integer (int64)
  Value that uniquely identifies the transaction type.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumSettlementLineNumber: number
  Read Only: true

  Value that indicates the maximum line number of settlement lines.
• NettingAmount: number
  Amount of the open transaction that's used for settlement.
• OpenTransactionId: integer (int64)
  Value that identifies the credit memo, deduction, or overpayment.
• OpenTransactionNumber: string
  Maximum Length: 30

  Number that identifies the credit memo, deduction, or overpayment.
• OverrideTransactionDate: string (date)
  Date that's used to create the credit memo if it's present.
• ReceivablesActivityForWriteOff: string
  Maximum Length: 255

  Name of the receivables activity for receipt write-off.
• ReceivablesActivityForWriteOffId: integer (int64)
  Value that uniquely identifies the receivables activity for receipt write-off.
• SalesPerson: string
  Name of the salesperson.
• SalesPersonId: integer
  Value that uniquely identifies the salesperson.
• SalesPersonNumber: string
  Value that indicates salesperson's number.
• SettlementComments: string
  Maximum Length: 2000

  Comments that provide additional information about the settlement.
• settlementDocuments: array Settlement Documents
  Title: Settlement Documents

  The Settlement Documents resource manages the artifacts for each settlement method used to confirm the settlement of a claim.
• SettlementLinesTotalAmount: number
  Read Only: true

  Total of credit memo or invoice lines.
• SettlementMethod: string
  Method of payment used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD.
• SettlementMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the payment methods used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD.
• SettlementMethodId: integer (int64)
  Read Only: true

  Value that uniquely identifies the settlement method.
• Supplier: string
  Maximum Length: 255

  Name of the supplier.
• SupplierId: integer (int64)
  Value that uniquely identifies the supplier.
• SupplierNumber: string
  Maximum Length: 255

  Number that identifies the supplier.
• SupplierSite: string
  Maximum Length: 255

  Name of the supplier site.
• SupplierSiteAddress: string
  Read Only: true

  Maximum Length: 255

  Address of the supplier site.
• SupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site.
• TransactionAccountingDate: string (date)
  Value that specifies the claim accounting date if it's present.
• WriteOffReason: string
  Maximum Length: 255

  Reason for the write-off.
• WriteOffReasonCode: string
  Maximum Length: 30

  Abbreviation that identifies the reason for the write-off.

{
    "type":"object",
    "properties":{
        "InvoiceTransactionTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumSettlementLineNumber":{
            "type":"number",
            "description":"Value that indicates the maximum line number of settlement lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel claim. The value is a primary key that the application generates when it creates the claim.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SalesPerson":{
            "type":"string",
            "description":"Name of the salesperson.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesPersonNumber":{
            "type":"string",
            "description":"Value that indicates salesperson's number.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionAccountingDate":{
            "type":"string",
            "description":"Value that specifies the claim accounting date if it's present.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "WriteOffReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the reason for the write-off.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the credit memo reason.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SettlementMethodCode",
                    "SettlementMethodId"
                ]
            },
            "x-queryable":true
        },
        "CreditMemoReason":{
            "type":"string",
            "description":"Reason for the credit memo.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimAmountIncludesTax":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates if the claim amount includes tax.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceivablesActivityForWriteOff":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the receivables activity for receipt write-off.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "settlementDocuments":{
            "title":"Settlement Documents",
            "type":"array",
            "description":"The Settlement Documents resource manages the artifacts for each settlement method used to confirm the settlement of a claim.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-settlementMethods-settlementDocuments-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Supplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoTransactionTypeSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "NettingAmount":{
            "type":"number",
            "description":"Amount of the open transaction that's used for settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "SalesPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the salesperson.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargebackReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the chargeback reason.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimAmountIncludesTaxCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that indicates if the claim amount includes tax.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "SettlementMethodCode",
                    "SettlementMethodId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SettlementMethod":{
            "type":"string",
            "description":"Method of payment used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SettlementComments":{
            "maxLength":"2000",
            "type":"string",
            "description":"Comments that provide additional information about the settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargebackTransactionTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InvoiceTransactionType":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementLinesTotalAmount":{
            "type":"number",
            "description":"Total of credit memo or invoice lines.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OverrideTransactionDate":{
            "type":"string",
            "description":"Date that's used to create the credit memo if it's present.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the payment methods used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSiteAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"Address of the supplier site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReceivablesActivityForWriteOffId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receivables activity for receipt write-off.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SettlementMethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the settlement method.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OpenTransactionNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the credit memo, deduction, or overpayment.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditMemoTransactionType":{
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargebackReason":{
            "maxLength":"255",
            "type":"string",
            "description":"Reason for the chargeback.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplierSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "WriteOffReason":{
            "maxLength":"255",
            "type":"string",
            "description":"Reason for the write-off.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargebackTransactionType":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OpenTransactionId":{
            "type":"integer",
            "description":"Value that identifies the credit memo, deduction, or overpayment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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 : Settlement Documents

Type: array

Title: Settlement Documents

The Settlement Documents resource manages the artifacts for each settlement method used to confirm the settlement of a claim.

Show Source

• Array of: object channelCustomerClaims-settlementMethods-settlementDocuments-item-response

{
    "title":"Settlement Documents",
    "type":"array",
    "description":"The Settlement Documents resource manages the artifacts for each settlement method used to confirm the settlement of a claim.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-settlementMethods-settlementDocuments-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 : channelCustomerClaims-settlementMethods-settlementDocuments-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• Details: string
  Read Only: true

  Maximum Length: 255

  Details of the settlement method selected.
• InstrumentAmount: number
  Amount settled via the instrument.
• InstrumentBillToAccountId: integer (int64)
  Read Only: true

  Value that uniquely identifies the bill-to customer account for which the instrument was created.
• InstrumentBillToAccountNumber: string
  Read Only: true

  Maximum Length: 255

  Number of the bill-to customer account for which the instrument was created.
• InstrumentBillToCustomer: string
  Read Only: true

  Maximum Length: 255

  Name of the bill-to customer for which the instrument was created.
• InstrumentBillToSite: string
  Read Only: true

  Maximum Length: 255

  Name of the bill-to customer account site for which the instrument was created.
• InstrumentBillToSiteId: integer (int64)
  Read Only: true

  Value that uniquely identifies the bill-to customer account site for which the instrument was created.
• InstrumentDate: string (date)
  Date when the settlement instrument was created.
• InstrumentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the settlement instrument.
• InstrumentNumber: string
  Maximum Length: 30

  Number of the instrument created upon settlement.
• InstrumentStatus: string
  Maximum Length: 30

  Status of the instrument.
• InstrumentSupplier: string
  Maximum Length: 255

  Name of the supplier for which the instrument was created.
• InstrumentSupplierId: integer (int64)
  Value that uniquely identifies the supplier for which the instrument was created.
• InstrumentSupplierNumber: string
  Maximum Length: 255

  Number of the supplier for which the instrument was created.
• InstrumentSupplierSite: string
  Maximum Length: 255

  Site name of the supplier for which the instrument was created.
• InstrumentSupplierSiteAddress: string
  Read Only: true

  Maximum Length: 255

  Site address of the supplier for which the instrument was created.
• InstrumentSupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site for which the instrument was created.
• InstrumentTax: number
  Tax amount for the instrument.
• InstrumentType: string
  Name of the instrument created upon settlement.
• InstrumentTypeCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of the instrument.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalAmount: number
  Read Only: true

  Value that indicates the original claim amount.
• payments: array Payments
  Title: Payments

  A sum of money paid, for example, by check or credit memo to settle a claim, which can be viewed and updated.
• SettlementDocumentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the settlement document.
• SettlementMethod: string
  Read Only: true

  Method of payment used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD.
• SettlementMethodCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the payment methods used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD.
• SettlementmethodId: integer (int64)
  Read Only: true

  Value that uniquely identifies the settlement method.
• ThirdPartyInstrumentPayeeName: string
  Maximum Length: 360

  Name of the third party payee for which the instrument was created.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrumentSupplierSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Site name of the supplier for which the instrument was created.",
            "nullable":true,
            "x-queryable":true
        },
        "InstrumentAmount":{
            "type":"number",
            "description":"Amount settled via the instrument.",
            "nullable":true,
            "x-queryable":true
        },
        "ThirdPartyInstrumentPayeeName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the third party payee for which the instrument was created.",
            "nullable":true,
            "x-queryable":true
        },
        "payments":{
            "title":"Payments",
            "type":"array",
            "description":"A sum of money paid, for example, by check or credit memo to settle a claim, which can be viewed and updated.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-settlementMethods-settlementDocuments-payments-item-response"
            }
        },
        "InstrumentType":{
            "type":"string",
            "description":"Name of the instrument created upon settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the settlement document.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InstrumentSupplierSiteAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"Site address of the supplier for which the instrument was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrumentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of the instrument.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrumentBillToAccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the bill-to customer account for which the instrument was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrumentBillToSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account site for which the instrument was created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InstrumentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the instrument.",
            "nullable":true,
            "x-queryable":true
        },
        "InstrumentSupplierNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the supplier for which the instrument was created.",
            "nullable":true,
            "x-queryable":true
        },
        "InstrumentTax":{
            "type":"number",
            "description":"Tax amount for the instrument.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InstrumentBillToAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account for which the instrument was created.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InstrumentBillToSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the bill-to customer account site for which the instrument was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SettlementMethod":{
            "type":"string",
            "description":"Method of payment used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrumentSupplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier for which the instrument was created.",
            "nullable":true,
            "x-queryable":true
        },
        "InstrumentNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number of the instrument created upon settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "InstrumentSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier for which the instrument was created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OriginalAmount":{
            "type":"number",
            "description":"Value that indicates the original claim amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the settlement instrument.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "InstrumentBillToCustomer":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the bill-to customer for which the instrument was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SettlementMethodCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the payment methods used to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_SETTLEMENT_METHOD.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Details":{
            "maxLength":"255",
            "type":"string",
            "description":"Details of the settlement method selected.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrumentDate":{
            "type":"string",
            "description":"Date when the settlement instrument was created.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementmethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the settlement method.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrumentSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site for which the instrument was created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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 : Payments

Type: array

Title: Payments

A sum of money paid, for example, by check or credit memo to settle a claim, which can be viewed and updated.

Show Source

• Array of: object channelCustomerClaims-settlementMethods-settlementDocuments-payments-item-response

{
    "title":"Payments",
    "type":"array",
    "description":"A sum of money paid, for example, by check or credit memo to settle a claim, which can be viewed and updated.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-settlementMethods-settlementDocuments-payments-item-response"
    }
}

Nested Schema : channelCustomerClaims-settlementMethods-settlementDocuments-payments-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the record.
• LastUpdateDate: string (date-time)
  Read Only: true

  User who most recently updated the record.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date and time when the user most recently updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PayeeParty: string
  Maximum Length: 255

  Party who received the payment.
• PayeePartyId: integer (int64)
  Value that uniquely identifies the party that received the payment.
• PayeePartySite: string
  Maximum Length: 255

  Party site that received the payment.
• PayeePartySiteId: integer (int64)
  Value that uniquely identifies the party site that received the payment.
• PayeeSupplier: string
  Maximum Length: 255

  Supplier who received the payment.
• PayeeSupplierId: integer (int64)
  Value that uniquely identifies the supplier who received the payment.
• PayeeSupplierNumber: string
  Maximum Length: 255

  Number of the supplier who received the payment.
• PayeeSupplierSite: string
  Maximum Length: 255

  Supplier site that received the payment.
• PayeeSupplierSiteAddress: string
  Read Only: true

  Maximum Length: 255

  Site address of the supplier for which the payment was created.
• PayeeSupplierSiteId: integer (int64)
  Value that uniquely identifies the supplier site that received the payment.
• PaymentAmount: number
  Amount of the payment.
• PaymentDate: string (date)
  Date when the payment was created.
• PaymentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the payment.
• PaymentMethod: string
  Maximum Length: 30

  Name of the payment created on settlement.
• PaymentNumber: string
  Maximum Length: 30

  Number of the payment created on settlement.
• PaymentStatus: string
  Maximum Length: 30

  Status of the payment.
• SettlementDocumentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the settlement document.
• ThirdPartyPayeeName: string
  Maximum Length: 360

  Name of the third party payee for which the payment was created.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentDate":{
            "type":"string",
            "description":"Date when the payment was created.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PayeeSupplierSiteAddress":{
            "maxLength":"255",
            "type":"string",
            "description":"Site address of the supplier for which the payment was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PaymentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the payment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ThirdPartyPayeeName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the third party payee for which the payment was created.",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementDocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the settlement document.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentAmount":{
            "type":"number",
            "description":"Amount of the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeeParty":{
            "maxLength":"255",
            "type":"string",
            "description":"Party who received the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeeSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayeePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayeePartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party site that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayeeSupplierNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the supplier who received the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeePartySite":{
            "maxLength":"255",
            "type":"string",
            "description":"Party site that received the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the payment created on settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PayeeSupplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Supplier who received the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayeeSupplierSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Supplier site that received the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number of the payment created on settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the payment.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayeeSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "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

settlementDocuments

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementMethods/{SettlementMethodId}/child/settlementDocuments

Parameters:

• ClaimId: $request.path.ClaimId
• SettlementMethodId: $request.path.SettlementMethodId

The Settlement Documents resource manages the artifacts for each settlement method used to confirm the settlement of a claim.

Back to Top