Jump to

• Request
• Response

Create settlement methods

post

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

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.

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

• 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.
• 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.
• 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.
• 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.
• 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
            }
        },
        "SalesPerson":{
            "type":"string",
            "description":"Name of the salesperson.",
            "nullable":true
        },
        "SalesPersonNumber":{
            "type":"string",
            "description":"Value that indicates salesperson's number.",
            "nullable":true
        },
        "TransactionAccountingDate":{
            "type":"string",
            "description":"Value that specifies the claim accounting date if it's present.",
            "format":"date",
            "nullable":true
        },
        "WriteOffReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the reason for the write-off.",
            "nullable":true
        },
        "CreditMemoReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the credit memo reason.",
            "nullable":true
        },
        "CreditMemoReason":{
            "type":"string",
            "description":"Reason for the credit memo.",
            "nullable":true
        },
        "ClaimAmountIncludesTax":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates if the claim amount includes tax.",
            "nullable":true
        },
        "ReceivablesActivityForWriteOff":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the receivables activity for receipt write-off.",
            "nullable":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-post-request"
            }
        },
        "CreditMemoTransactionTypeSequenceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NettingAmount":{
            "type":"number",
            "description":"Amount of the open transaction that's used for settlement.",
            "nullable":true
        },
        "SalesPersonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the salesperson.",
            "nullable":true
        },
        "ChargebackReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the chargeback reason.",
            "nullable":true
        },
        "ClaimAmountIncludesTaxCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that indicates if the claim amount includes tax.",
            "nullable":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
        },
        "SettlementComments":{
            "maxLength":2000,
            "type":"string",
            "description":"Comments that provide additional information about the settlement.",
            "nullable":true
        },
        "ChargebackTransactionTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transaction type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InvoiceTransactionType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true
        },
        "OverrideTransactionDate":{
            "type":"string",
            "description":"Date that's used to create the credit memo if it's present.",
            "format":"date",
            "nullable":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
        },
        "ReceivablesActivityForWriteOffId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receivables activity for receipt write-off.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OpenTransactionNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the credit memo, deduction, or overpayment.",
            "nullable":true
        },
        "CreditMemoTransactionType":{
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true
        },
        "ChargebackReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for the chargeback.",
            "nullable":true
        },
        "WriteOffReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for the write-off.",
            "nullable":true
        },
        "ChargebackTransactionType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true
        },
        "OpenTransactionId":{
            "type":"integer",
            "description":"Value that identifies the credit memo, deduction, or overpayment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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-post-request

{
    "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-post-request"
    }
}

Nested Schema : channelCustomerClaims-settlementMethods-settlementDocuments-item-post-request

Type: object

Show Source

• InstrumentDate: string (date)
  Date when the settlement instrument was created.
• InstrumentId: integer (int64)
  Value that uniquely identifies the settlement instrument.
• InstrumentNumber: string
  Maximum Length: 30

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

  Abbreviation that identifies the type of the instrument.

{
    "type":"object",
    "properties":{
        "InstrumentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number of the instrument created upon settlement.",
            "nullable":true
        },
        "InstrumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the settlement instrument.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InstrumentDate":{
            "type":"string",
            "description":"Date when the settlement instrument was created.",
            "format":"date",
            "nullable":true
        },
        "InstrumentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of the instrument.",
            "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(required):
  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(required):
  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.
• 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-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
        },
        "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"
            }
        },
        "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-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
        },
        "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
        },
        "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
        },
        "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
  Read Only: true

  Amount settled via the instrument.
• InstrumentDate: string (date)
  Date when the settlement instrument was created.
• InstrumentId: integer (int64)
  Value that uniquely identifies the settlement instrument.
• InstrumentNumber: string
  Maximum Length: 30

  Number of the instrument created upon settlement.
• InstrumentTax: number
  Read Only: true

  Tax amount for the instrument.
• InstrumentType: string
  Read Only: true

  Name of the instrument created upon settlement.
• InstrumentTypeCode: string
  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.
• 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.

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "InstrumentAmount":{
            "type":"number",
            "description":"Amount settled via the instrument.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrumentType":{
            "type":"string",
            "description":"Name of the instrument created upon settlement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InstrumentNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Number 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
        },
        "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,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InstrumentTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of the instrument.",
            "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,
            "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
        },
        "InstrumentTax":{
            "type":"number",
            "description":"Tax amount for the instrument.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        }
    }
}

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