Jump to

• Request
• Response
• Examples

Create customer claims

post

/fscmRestApi/resources/11.13.18.05/channelCustomerClaims

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

• Amount: number
  Amount claimed in the claim currency.
• associations: array Associations
  Title: Associations

  The Associations resource manages accrual associations of a claim.
• attachments: array Attachments
  Title: Attachments

  The Attachments resource is used to view, create, and update attachments.
• BillToAccountId: integer (int64)
  Value that uniquely identifies the bill-to customer account.
• BillToAccountNumber: string
  Number of the bill-to customer account.
• BillToContact: string
  Name of the bill-to customer account's contact.
• BillToContactId: integer (int64)
  Value that uniquely represents the bill-to customer account's contact.
• BillToSite: string
  Name of the bill-to customer account site.
• BillToSiteId: integer (int64)
  Value that uniquely identifies the bill-to customer account site.
• Broker: string
  Maximum Length: 255

  Name of the broker.
• BrokerId: integer (int64)
  Value that uniquely identifies the broker.
• BusinessUnit: string
  Name of the business unit.
• BusinessUnitId(required): integer (int64)
  Value that uniquely identifies the business unit.
• ClaimDate(required): string (date)
  Date when a claim is created.
• ClaimNumber: string
  Number that indicates the customer claim.
• ClaimOwner: string
  Name of the person who owns the channel claim.
• ClaimOwnerId: integer (int64)
  Value that uniquely identifies the person who owns the channel claim.
• ClaimOwnerPersonNumber: string
  Maximum Length: 255

  Number that uniquely identifies the person who owns the channel claim.
• ClaimReason: string
  Reason for creating the claim.
• ClaimReasonId: integer (int64)
  Value that uniquely identifies the reason to create the claim.
• ClaimSalesperson: string
  Maximum Length: 255

  Name of the salesperson associated with the claim.
• ClaimSalespersonId: integer (int64)
  Value that indicates the claim salesperson's number.
• ClaimSalespersonNumber: integer
  Value that uniquely identifies the claim's salesperson.
• ClaimType: string
  The type of claim.
• ClaimTypeId: integer (int64)
  Value that uniquely identifies the type of claim.
• CommentsForApprovers: string
  Maximum Length: 4000

  Comments submitted to provide additional information to approvers.
• ConversionDate: string (date)
  Date when the amount is converted.
• ConversionRate: number
  Value that indicates the conversion rate defined in the general ledger.
• ConversionRateType: string
  Maximum Length: 30

  Name of the conversion type defined in the general ledger.
• Currency: string
  Name of the currency used for the channel claim.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency used for the channel claim.
• CustomerReason: string
  Maximum Length: 150

  Reason provided by the customer to create the claim.
• CustomerReference: string
  Maximum Length: 50

  Number that identifies the reference details passed by the customer.
• CustomerReferenceDate: string (date)
  Date of the customer reference document.
• DFF: array Descriptive Flexfields for Channel Customer Claims
  Title: Descriptive Flexfields for Channel Customer Claims

  The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim.
• notes: array Notes
  Title: Notes

  The Notes resource captures comments, information, or instructions for a claim.
• receiptDFF: array Descriptive Flexfields of Receipt Application Line
  Title: Descriptive Flexfields of Receipt Application Line

  The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment.
• settlementLines: array Settlement Lines
  Title: Settlement Lines

  The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables.
• settlementMethods: array Settlement Methods
  Title: Settlement Methods

  The Settlement Methods resource manages the settlement method that's used to settle a claim.
• SettlementType: string
  Maximum Length: 255

  Name of the settlement type.
• SettlementTypeCode: string
  Maximum Length: 255

  Abbreviation that identifies the settlement type selected to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_CUST_CLAIM_RESOL_TYPE.
• ShipToCustomer: string
  Name of the ship-to customer.
• ShipToCustomerId: integer (int64)
  Value that uniquely identifies the ship-to customer.
• ShipToCustomerSite: string
  Name of the ship-to customer site.
• ShipToCustomerSiteId: integer (int64)
  Value that uniquely identifies the ship-to customer site.
• SourceClaimNumber: string
  Maximum Length: 240

  Number that indicates the caim number in the source system.
• SourceClaimSystem: string
  Maximum Length: 240

  Value that indicates the source sytem from where the claim is interefaced.
• Status: string
  Status of the channel claim.
• StatusId: integer (int64)
  Value that uniquely identifies the status of the channel claim.

{
    "required":[
        "BusinessUnitId",
        "ClaimDate"
    ],
    "type":"object",
    "properties":{
        "ClaimSalesperson":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the salesperson associated with the claim.",
            "nullable":true
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Notes resource captures comments, information, or instructions for a claim.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-notes-item-post-request"
            }
        },
        "CustomerReferenceDate":{
            "type":"string",
            "description":"Date of the customer reference document.",
            "format":"date",
            "nullable":true
        },
        "DFF":{
            "title":"Descriptive Flexfields for Channel Customer Claims",
            "type":"array",
            "description":"The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-DFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "SettlementType":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the settlement type.",
            "nullable":true
        },
        "BillToAccountNumber":{
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true
        },
        "ClaimType":{
            "type":"string",
            "description":"The type of claim.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            }
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the channel claim.",
            "nullable":true
        },
        "ClaimReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reason to create the claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            }
        },
        "Currency":{
            "type":"string",
            "description":"Name of the currency used for the channel claim.",
            "nullable":true
        },
        "SourceClaimSystem":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the source sytem from where the claim is interefaced.",
            "nullable":true
        },
        "ClaimDate":{
            "type":"string",
            "description":"Date when a claim is created.",
            "format":"date",
            "nullable":false
        },
        "BillToContact":{
            "type":"string",
            "description":"Name of the bill-to customer account's contact.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            }
        },
        "ClaimOwner":{
            "type":"string",
            "description":"Name of the person who owns the channel claim.",
            "nullable":true
        },
        "ClaimSalespersonNumber":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim's salesperson.",
            "nullable":true
        },
        "Status":{
            "type":"string",
            "description":"Status of the channel claim.",
            "nullable":true
        },
        "ClaimOwnerPersonNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the person who owns the channel claim.",
            "nullable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillToSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CustomerReference":{
            "maxLength":"50",
            "type":"string",
            "description":"Number that identifies the reference details passed by the customer.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            }
        },
        "BusinessUnit":{
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the channel claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SettlementTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the settlement type selected to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_CUST_CLAIM_RESOL_TYPE.",
            "nullable":true
        },
        "ShipToCustomer":{
            "type":"string",
            "description":"Name of the ship-to customer.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            }
        },
        "ShipToCustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ShipToCustomer",
                    "ShipToCustomerId",
                    "Status",
                    "StatusId"
                ]
            }
        },
        "CustomerReason":{
            "maxLength":"150",
            "type":"string",
            "description":"Reason provided by the customer to create the claim.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            }
        },
        "ConversionDate":{
            "type":"string",
            "description":"Date when the amount is converted.",
            "format":"date",
            "nullable":true
        },
        "associations":{
            "title":"Associations",
            "type":"array",
            "description":"The Associations resource manages accrual associations of a claim.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-associations-item-post-request"
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-attachments-item-post-request"
            }
        },
        "settlementLines":{
            "title":"Settlement Lines",
            "type":"array",
            "description":"The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-settlementLines-item-post-request"
            }
        },
        "ConversionRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the conversion type defined in the general ledger.",
            "nullable":true
        },
        "ShipToCustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            }
        },
        "ClaimReason":{
            "type":"string",
            "description":"Reason for creating the claim.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            }
        },
        "BillToSite":{
            "type":"string",
            "description":"Name of the bill-to customer account site.",
            "nullable":true
        },
        "ClaimSalespersonId":{
            "type":"integer",
            "description":"Value that indicates the claim salesperson's number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "settlementMethods":{
            "title":"Settlement Methods",
            "type":"array",
            "description":"The Settlement Methods resource manages the settlement method that's used to settle a claim.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-settlementMethods-item-post-request"
            }
        },
        "ClaimNumber":{
            "type":"string",
            "description":"Number that indicates the customer claim.",
            "nullable":true
        },
        "Broker":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the broker.",
            "nullable":true
        },
        "BrokerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the broker.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "receiptDFF":{
            "title":"Descriptive Flexfields of Receipt Application Line",
            "type":"array",
            "description":"The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-receiptDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "Amount":{
            "type":"number",
            "description":"Amount claimed in the claim currency.",
            "nullable":true
        },
        "ClaimTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            }
        },
        "ClaimOwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the channel claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillToContactId":{
            "type":"integer",
            "description":"Value that uniquely represents the bill-to customer account's contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            }
        },
        "SourceClaimNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"Number that indicates the caim number in the source system.",
            "nullable":true
        },
        "ConversionRate":{
            "type":"number",
            "description":"Value that indicates the conversion rate defined in the general ledger.",
            "nullable":true
        },
        "BillToAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ShipToCustomerSite":{
            "type":"string",
            "description":"Name of the ship-to customer site.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ShipToCustomer",
                    "ShipToCustomerId",
                    "Status",
                    "StatusId"
                ]
            }
        },
        "CommentsForApprovers":{
            "maxLength":"4000",
            "type":"string",
            "description":"Comments submitted to provide additional information to approvers.",
            "nullable":true
        }
    }
}

Nested Schema : Associations

Type: array

Title: Associations

The Associations resource manages accrual associations of a claim.

Show Source

• Array of: object schema

{
    "title":"Associations",
    "type":"array",
    "description":"The Associations resource manages accrual associations of a claim.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-associations-item-post-request"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object schema

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-attachments-item-post-request"
    }
}

Nested Schema : Descriptive Flexfields for Channel Customer Claims

Type: array

Title: Descriptive Flexfields for Channel Customer Claims

The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim.

Show Source

• Array of: object channelCustomerClaims-DFF-item-post-request

{
    "title":"Descriptive Flexfields for Channel Customer Claims",
    "type":"array",
    "description":"The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-DFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Notes

Type: array

Title: Notes

The Notes resource captures comments, information, or instructions for a claim.

Show Source

• Array of: object schema

{
    "title":"Notes",
    "type":"array",
    "description":"The Notes resource captures comments, information, or instructions for a claim.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-notes-item-post-request"
    }
}

Nested Schema : Descriptive Flexfields of Receipt Application Line

Type: array

Title: Descriptive Flexfields of Receipt Application Line

The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment.

Show Source

• Array of: object channelCustomerClaims-receiptDFF-item-post-request

{
    "title":"Descriptive Flexfields of Receipt Application Line",
    "type":"array",
    "description":"The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-receiptDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Settlement Lines

Type: array

Title: Settlement Lines

The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables.

Show Source

• Array of: object schema

{
    "title":"Settlement Lines",
    "type":"array",
    "description":"The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-settlementLines-item-post-request"
    }
}

Nested Schema : Settlement Methods

Type: array

Title: Settlement Methods

The Settlement Methods resource manages the settlement method that's used to settle a claim.

Show Source

• Array of: object schema

{
    "title":"Settlement Methods",
    "type":"array",
    "description":"The Settlement Methods resource manages the settlement method that's used to settle a claim.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-settlementMethods-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AccrueToAccountId: integer (int64)
  Value that uniquely identifies the customer account.
• AccrueToAccountNumber: string
  Maximum Length: 255

  Bill to account number used for the association.
• AccrueToCustomer: string
  Maximum Length: 255

  Name of the bill to customer used for the association.
• AssociatedAmountInClaimCurrency: number
  Association amount in claim currency.
• AssociationId: integer (int64)
  Value that uniquely identifies the claim association.
• InvoiceNumber: string
  Maximum Length: 50

  Number that indicates the invoice.
• Item: string
  Maximum Length: 255

  Name of the item used for the association.
• ItemId: integer (int64)
  Value that uniquely identifies the item.
• Program: string
  Maximum Length: 255

  Name of the program used for the association.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer program.
• PromotionCode: string
  Maximum Length: 255

  Name of the promotion code used for the association.
• SearchAccrualsBeforeDate: string (date)
  Search parameter for finding accruals before a specified date.
• SearchAssociationType: string
  Maximum Length: 255

  Search parameter for the association type for accruals.
• SearchAssociationTypeCode: string
  Maximum Length: 30

  Search parameter for the association type code for accruals.
• SearchCalendarYear: string
  Maximum Length: 30

  Search parameter for the calendar year for accruals.
• SearchExcludeZeroBalancesFlag: boolean
  Maximum Length: 1

  Search parameter for excluding zero-balance accruals.
• SearchInvoiceNumber: string
  Maximum Length: 50

  Search parameter for accruals based on an invoice number.
• SearchItem: string
  Maximum Length: 255

  Item number search parameter for accruals.
• SearchItemId: integer (int64)
  Item ID search parameter for accruals.
• SearchMatchingLevel: string
  Maximum Length: 255

  Matching level search parameter for accruals.
• SearchMatchingLevelCode: string
  Maximum Length: 30

  Matching level code search parameter for accruals.
• SearchProgram: string
  Maximum Length: 255

  Program name search parameter for accruals.
• SearchProgramId: integer (int64)
  Program ID search parameter for accruals.
• SearchProgramType: string
  Maximum Length: 255

  Program type search parameter for accruals.
• SearchProgramTypeId: integer (int64)
  Program type ID search parameter for accruals.
• SearchPromotionCode: string
  Maximum Length: 255

  Promotion code search parameter for accruals.
• SearchRelatedCustomerAccountId: integer (int64)
  Search parameter for the related customer account ID for accruals.
• SearchRelatedCustomerAccountNumber: string
  Maximum Length: 255

  Search parameter for the related customer account number for accruals.
• SearchShowActiveProgramsFlag: boolean
  Maximum Length: 1

  Search parameters for displaying active program accruals.

{
    "type":"object",
    "properties":{
        "AssociatedAmountInClaimCurrency":{
            "type":"number",
            "description":"Association amount in claim currency.",
            "nullable":true
        },
        "SearchPromotionCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Promotion code search parameter for accruals.",
            "nullable":true
        },
        "SearchMatchingLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Matching level code search parameter for accruals.",
            "nullable":true
        },
        "SearchProgramId":{
            "type":"integer",
            "description":"Program ID search parameter for accruals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SearchShowActiveProgramsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Search parameters for displaying active program accruals.",
            "nullable":true
        },
        "SearchAssociationType":{
            "maxLength":"255",
            "type":"string",
            "description":"Search parameter for the association type for accruals.",
            "nullable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SearchItem":{
            "maxLength":"255",
            "type":"string",
            "description":"Item number search parameter for accruals.",
            "nullable":true
        },
        "SearchRelatedCustomerAccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Search parameter for the related customer account number for accruals.",
            "nullable":true
        },
        "SearchCalendarYear":{
            "maxLength":"30",
            "type":"string",
            "description":"Search parameter for the calendar year for accruals.",
            "nullable":true
        },
        "SearchInvoiceNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"Search parameter for accruals based on an invoice number.",
            "nullable":true
        },
        "SearchExcludeZeroBalancesFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Search parameter for excluding zero-balance accruals.",
            "nullable":true
        },
        "Item":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item used for the association.",
            "nullable":true
        },
        "SearchItemId":{
            "type":"integer",
            "description":"Item ID search parameter for accruals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SearchMatchingLevel":{
            "maxLength":"255",
            "type":"string",
            "description":"Matching level search parameter for accruals.",
            "nullable":true
        },
        "InvoiceNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"Number that indicates the invoice.",
            "nullable":true
        },
        "SearchAccrualsBeforeDate":{
            "type":"string",
            "description":"Search parameter for finding accruals before a specified date.",
            "format":"date",
            "nullable":true
        },
        "AccrueToAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AccrueToAccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Bill to account number used for the association.",
            "nullable":true
        },
        "Program":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the program used for the association.",
            "nullable":true
        },
        "SearchAssociationTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Search parameter for the association type code for accruals.",
            "nullable":true
        },
        "PromotionCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the promotion code used for the association.",
            "nullable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SearchProgramTypeId":{
            "type":"integer",
            "description":"Program type ID search parameter for accruals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SearchProgramType":{
            "maxLength":"255",
            "type":"string",
            "description":"Program type search parameter for accruals.",
            "nullable":true
        },
        "SearchRelatedCustomerAccountId":{
            "type":"integer",
            "description":"Search parameter for the related customer account ID for accruals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AccrueToCustomer":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the bill to customer used for the association.",
            "nullable":true
        },
        "SearchProgram":{
            "maxLength":"255",
            "type":"string",
            "description":"Program name search parameter for accruals.",
            "nullable":true
        },
        "AssociationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Code indicating the type of data in the attachment. For example, FILE, WEB_PAGE, or TEXT.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Code indicating the type of error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL of the attachment.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Code indicating the type of data in the attachment. For example, FILE, WEB_PAGE, or TEXT.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Code indicating the type of error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : channelCustomerClaims-DFF-item-post-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for the channel customer claim.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for the channel customer claim.
• ClaimId: integer (int64)
  Value that uniquely identifies the channel customer claim.

{
    "type":"object",
    "properties":{
        "ClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel customer claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for the channel customer claim.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for the channel customer claim.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  Relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  Corporate currency code for extensibility.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  Party ID of the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  Type of currency conversion rate for extensibility.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  Currency code for extensibility.
• NoteNumber: string
  Maximum Length: 30

  Alternate unique identifier of the note. A user key that is system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  Title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  Column which stores the note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  Note type code for categorization of the note.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  Unique identifier of the parent source object associated with the note.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  Source object code for the source object as defined in the OBJECTS metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  Unique identifier of the parent source object associated to the note.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"Party ID of the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Note type code for categorization of the note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of currency conversion rate for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"Relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"Currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Alternate unique identifier of the note. A user key that is system generated or from an external system.",
            "nullable":true
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"Unique identifier of the parent source object associated to the note.",
            "nullable":false
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"Source object code for the source object as defined in the OBJECTS metadata.",
            "nullable":false
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"Unique identifier of the parent source object associated with the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"Column which stores the note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"Title of the note entered by the user.",
            "nullable":true
        }
    }
}

Nested Schema : channelCustomerClaims-receiptDFF-item-post-request

Type: object

Show Source

• __FLEX_Context_DisplayValue: string
  Title: Context Value

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Amount: number
  Value that indicates the amount on the claim line.
• Description: string
  Maximum Length: 240

  Description of the claim line.
• Item: string
  Name of the item in the inventory.
• ItemId: integer (int64)
  Value that uniquely identifies the item.
• LineNumber: number
  Number that indicates the claim line.
• LineType: string
  Name of the transaction line type.
• LineTypeCode: string
  Maximum Length: 20

  Abbreviation that identifies the transaction line type.
• MemoLine: string
  Name of the memo line.
• MemoLineId: integer (int64)
  Value that uniquely identifies the memo line.
• Quantity: number
  Value that indicates the quantity on the claim line.
• UnitOfMeasure: string
  Name of the unit of measure.
• UnitOfMeasureCode: string
  Maximum Length: 3

  Abbreviation for the unit of measure code.
• UnitPrice: number
  Value that indicates the unit price for the selected item.

{
    "type":"object",
    "properties":{
        "LineTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies the transaction line type.",
            "nullable":true
        },
        "UnitOfMeasureCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation for the unit of measure code.",
            "nullable":true
        },
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the claim line.",
            "nullable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true
        },
        "Amount":{
            "type":"number",
            "description":"Value that indicates the amount on the claim line.",
            "nullable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Value that indicates the quantity on the claim line.",
            "nullable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that indicates the claim line.",
            "nullable":false
        },
        "Item":{
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true
        },
        "UnitPrice":{
            "type":"number",
            "description":"Value that indicates the unit price for the selected item.",
            "nullable":true
        },
        "LineType":{
            "type":"string",
            "description":"Name of the transaction line type.",
            "nullable":true
        },
        "MemoLine":{
            "type":"string",
            "description":"Name of the memo line.",
            "nullable":true
        },
        "MemoLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the memo line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested 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.
• 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.
• 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"
            }
        },
        "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
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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"
            }
        },
        "Supplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier.",
            "nullable":true
        },
        "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
        },
        "SupplierNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that identifies the supplier.",
            "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
        },
        "SupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "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
        },
        "SupplierSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier site.",
            "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 schema

{
    "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 : schema

Type: object

Show Source

• InstrumentAmount: number
  Amount settled via the instrument.
• InstrumentDate: string (date)
  Date when the settlement instrument was created.
• 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.
• 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.
• 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.
• ThirdPartyInstrumentPayeeName: string
  Maximum Length: 360

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

{
    "type":"object",
    "properties":{
        "InstrumentSupplierSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Site name of the supplier for which the instrument was created.",
            "nullable":true
        },
        "InstrumentAmount":{
            "type":"number",
            "description":"Amount settled via the instrument.",
            "nullable":true
        },
        "ThirdPartyInstrumentPayeeName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the third party payee for which the instrument was created.",
            "nullable":true
        },
        "InstrumentSupplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the supplier for which the instrument was created.",
            "nullable":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-post-request"
            }
        },
        "InstrumentType":{
            "type":"string",
            "description":"Name of the instrument created upon settlement.",
            "nullable":true
        },
        "InstrumentNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number of the instrument created upon settlement.",
            "nullable":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"
            }
        },
        "InstrumentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the instrument.",
            "nullable":true
        },
        "InstrumentSupplierNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the supplier for which the instrument was created.",
            "nullable":true
        },
        "InstrumentDate":{
            "type":"string",
            "description":"Date when the settlement instrument was created.",
            "format":"date",
            "nullable":true
        },
        "InstrumentTax":{
            "type":"number",
            "description":"Tax amount for the instrument.",
            "nullable":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"
            }
        }
    }
}

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 schema

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

Nested Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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.
• ThirdPartyPayeeName: string
  Maximum Length: 360

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

{
    "type":"object",
    "properties":{
        "PaymentDate":{
            "type":"string",
            "description":"Date when the payment was created.",
            "format":"date",
            "nullable":true
        },
        "ThirdPartyPayeeName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the third party payee for which the payment was created.",
            "nullable":true
        },
        "PaymentAmount":{
            "type":"number",
            "description":"Amount of the payment.",
            "nullable":true
        },
        "PayeeParty":{
            "maxLength":"255",
            "type":"string",
            "description":"Party who received the payment.",
            "nullable":true
        },
        "PayeeSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PayeePartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PayeePartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the party site that received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PayeeSupplierNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number of the supplier who received the payment.",
            "nullable":true
        },
        "PayeePartySite":{
            "maxLength":"255",
            "type":"string",
            "description":"Party site that received the payment.",
            "nullable":true
        },
        "PaymentMethod":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the payment created on settlement.",
            "nullable":true
        },
        "PayeeSupplier":{
            "maxLength":"255",
            "type":"string",
            "description":"Supplier who received the payment.",
            "nullable":true
        },
        "PayeeSupplierSite":{
            "maxLength":"255",
            "type":"string",
            "description":"Supplier site that received the payment.",
            "nullable":true
        },
        "PaymentNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number of the payment created on settlement.",
            "nullable":true
        },
        "PaymentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the payment.",
            "nullable":true
        },
        "PayeeSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who received the payment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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

Type: object

Show Source

• AccountedAmount: number
  Read Only: true

  Amount claimed in the functional currency.
• AccountedAmountRemaining: number
  Read Only: true

  Amount remaining in the functional currency.
• AccountedResolvedAmount: number
  Read Only: true

  Value that indicates the resolved amount in the functional currency.
• AccountedSplitAmount: number
  Read Only: true

  Amount that's carried over to the child claim in the functional currency.
• AccountingDate: string (date)
  Read Only: true

  Date when the claim is accounted.
• Age: integer
  Read Only: true

  Number that identifies the age of the claim.
• Amount: number
  Amount claimed in the claim currency.
• AmountRemaining: number
  Read Only: true

  Amount remaining in the claim's currency.
• AppliedExistingTransactionsTotal: number
  Read Only: true

  Value that identifies the sum of the applied existing transactions amount.
• ApprovedBy: string
  Read Only: true

  User who approved the claim.
• ApprovedById: integer (int64)
  Read Only: true

  Value that uniquely identifies the user who approved the claim.
• ApprovedDate: string (date)
  Read Only: true

  Date when the user approved the claim.
• associations: array Associations
  Title: Associations

  The Associations resource manages accrual associations of a claim.
• attachments: array Attachments
  Title: Attachments

  The Attachments resource is used to view, create, and update attachments.
• BillToAccountId: integer (int64)
  Value that uniquely identifies the bill-to customer account.
• BillToAccountNumber: string
  Number of the bill-to customer account.
• BillToContact: string
  Name of the bill-to customer account's contact.
• BillToContactId: integer (int64)
  Value that uniquely represents the bill-to customer account's contact.
• BillToCustomer: string
  Read Only: true

  Name of the bill-to customer account.
• BillToSite: string
  Name of the bill-to customer account site.
• BillToSiteAddress: string
  Read Only: true

  Address of the bill-to customer account site.
• BillToSiteId: integer (int64)
  Value that uniquely identifies the bill-to customer account site.
• Broker: string
  Maximum Length: 255

  Name of the broker.
• BrokerId: integer (int64)
  Value that uniquely identifies the broker.
• BusinessUnit: string
  Name of the business unit.
• BusinessUnitId: integer (int64)
  Value that uniquely identifies the business unit.
• ChildClaim: string
  Read Only: true

  Number of the child claim created.
• ChildClaimId: integer
  Read Only: true

  Value that uniquely identifies the child claim.
• ClaimDate: string (date)
  Date when a claim is created.
• 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.
• ClaimNumber: string
  Number that indicates the customer claim.
• ClaimOwner: string
  Name of the person who owns the channel claim.
• ClaimOwnerId: integer (int64)
  Value that uniquely identifies the person who owns the channel claim.
• ClaimOwnerPersonNumber: string
  Maximum Length: 255

  Number that uniquely identifies the person who owns the channel claim.
• ClaimReason: string
  Reason for creating the claim.
• ClaimReasonId: integer (int64)
  Value that uniquely identifies the reason to create the claim.
• ClaimSalesperson: string
  Maximum Length: 255

  Name of the salesperson associated with the claim.
• ClaimSalespersonId: integer (int64)
  Value that indicates the claim salesperson's number.
• ClaimSalespersonNumber: integer
  Value that uniquely identifies the claim's salesperson.
• ClaimSource: string
  Read Only: true

  Name of the claim sources.
• ClaimSourceCode: string
  Read Only: true

  Abbreviation that identifies the claim sources.
• ClaimType: string
  The type of claim.
• ClaimTypeId: integer (int64)
  Value that uniquely identifies the type of claim.
• CommentsForApprovers: string
  Maximum Length: 4000

  Comments submitted to provide additional information to approvers.
• ConversionDate: string (date)
  Date when the amount is converted.
• ConversionRate: number
  Value that indicates the conversion rate defined in the general ledger.
• ConversionRateType: string
  Maximum Length: 30

  Name of the conversion type defined in the general ledger.
• 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.
• Currency: string
  Name of the currency used for the channel claim.
• CurrencyCode: string
  Maximum Length: 15

  Abbreviation that identifies the currency used for the channel claim.
• CustomerReason: string
  Maximum Length: 150

  Reason provided by the customer to create the claim.
• CustomerReference: string
  Maximum Length: 50

  Number that identifies the reference details passed by the customer.
• CustomerReferenceDate: string (date)
  Date of the customer reference document.
• DFF: array Descriptive Flexfields for Channel Customer Claims
  Title: Descriptive Flexfields for Channel Customer Claims

  The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim.
• EligibleForWriteOffFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then the deduction is under the threshold limit and can be written off. If false, then the deduction is not under the threshold limit. This attribute does not have a default value.
• FunctionalCurrency: string
  Read Only: true

  Value that indicates the functional currency.
• FunctionalCurrencyCode: string
  Read Only: true

  Abbreviation that identifies the functional currency.
• InvoiceAmount: number
  Read Only: true

  Amount of the invoice.
• InvoiceCurrency: string
  Read Only: true

  Maximum Length: 255

  Name of the receipt currency.
• InvoiceCurrencyCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the invoice currency.
• InvoiceDate: string (date)
  Read Only: true

  Date when the invoice is created.
• InvoiceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the invoice.
• InvoiceNumber: string
  Read Only: true

  Maximum Length: 30

  Invoice number.
• InvoiceSalesperson: string
  Read Only: true

  Maximum Length: 255

  Name of the salesperson associated with the invoice.
• 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.
• MassSettlementNumber: string
  Read Only: true

  Maximum Length: 30

  Number that identifies the mass settlement.
• notes: array Notes
  Title: Notes

  The Notes resource captures comments, information, or instructions for a claim.
• ParentClaim: string
  Read Only: true

  Number that identifies the parent claim.
• ParentClaimId: integer
  Read Only: true

  Value that uniquely identifies the parent claim.
• ReceiptAmount: number
  Read Only: true

  Amount of the receipt.
• ReceiptApplicationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the application line in the receipt.
• ReceiptCurrency: string
  Read Only: true

  Maximum Length: 255

  Name of the currency in the receipt.
• ReceiptCurrencyCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the receipt currency.
• ReceiptDate: string (date)
  Read Only: true

  Date when the receipt is created.
• receiptDFF: array Descriptive Flexfields of Receipt Application Line
  Title: Descriptive Flexfields of Receipt Application Line

  The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment.
• ReceiptId: integer (int64)
  Read Only: true

  Value that uniquely identifies the receipt.
• ReceiptNumber: string
  Read Only: true

  Maximum Length: 30

  Number of the receipt.
• ReceiptReference: string
  Read Only: true

  Maximum Length: 255

  Reference provided in the receipt.
• RejectedBy: string
  Read Only: true

  User who rejected the claim.
• RejectedById: integer (int64)
  Read Only: true

  Value that uniquely identifies the user who rejected the claim.
• RejectedDate: string (date)
  Read Only: true

  Date when the user rejected the claim.
• ResolvedAmount: number
  Read Only: true

  Value that indicates the resolved amount.
• ResolvedBy: string
  Read Only: true

  User who submitted the claim for approval.
• ResolvedDate: string (date)
  Read Only: true

  Date when the claim was resolved and submitted for approval.
• SettlementDate: string (date)
  Read Only: true

  Date when the claim moves to settled status.
• settlementLines: array Settlement Lines
  Title: Settlement Lines

  The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables.
• settlementMethods: array Settlement Methods
  Title: Settlement Methods

  The Settlement Methods resource manages the settlement method that's used to settle a claim.
• SettlementType: string
  Maximum Length: 255

  Name of the settlement type.
• SettlementTypeCode: string
  Maximum Length: 255

  Abbreviation that identifies the settlement type selected to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_CUST_CLAIM_RESOL_TYPE.
• ShipToCustomer: string
  Name of the ship-to customer.
• ShipToCustomerId: integer (int64)
  Value that uniquely identifies the ship-to customer.
• ShipToCustomerSite: string
  Name of the ship-to customer site.
• ShipToCustomerSiteAddress: string
  Read Only: true

  Address of the ship-to customer site.
• ShipToCustomerSiteId: integer (int64)
  Value that uniquely identifies the ship-to customer site.
• SourceClaimNumber: string
  Maximum Length: 240

  Number that indicates the caim number in the source system.
• SourceClaimSystem: string
  Maximum Length: 240

  Value that indicates the source sytem from where the claim is interefaced.
• SourceMapId: integer (int64)
  Read Only: true

  Value that uniquely identifies the claim source map assigned to the claim.
• SplitAmount: number
  Read Only: true

  Amount that's carried over to the child claim.
• Status: string
  Status of the channel claim.
• StatusId: integer (int64)
  Value that uniquely identifies the status of the channel claim.
• SystemStatus: string
  Read Only: true

  System status of the channel claim.
• SystemStatusCode: string
  Read Only: true

  Abbreviation that identifies the system status of the claim.
• TotalAssociatedAmount: number
  Read Only: true

  Value that identifies the association amount total in claim currency.

{
    "type":"object",
    "properties":{
        "ShipToCustomerSiteAddress":{
            "type":"string",
            "description":"Address of the ship-to customer site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitAmount":{
            "type":"number",
            "description":"Amount that's carried over to the child claim.",
            "nullable":true,
            "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
        },
        "ResolvedDate":{
            "type":"string",
            "description":"Date when the claim was resolved and submitted for approval.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DFF":{
            "title":"Descriptive Flexfields for Channel Customer Claims",
            "type":"array",
            "description":"The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-DFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ClaimType":{
            "type":"string",
            "description":"The type of claim.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "ReceiptAmount":{
            "type":"number",
            "description":"Amount of the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibleForWriteOffFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the deduction is under the threshold limit and can be written off. If false, then the deduction is not under the threshold limit. This attribute does not have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the currency used for the channel claim.",
            "nullable":true,
            "x-queryable":true
        },
        "MassSettlementNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the mass settlement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Currency":{
            "type":"string",
            "description":"Name of the currency used for the channel claim.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToCustomer":{
            "type":"string",
            "description":"Name of the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Invoice number.",
            "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
        },
        "Status":{
            "type":"string",
            "description":"Status of the channel claim.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimOwnerPersonNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the person who owns the channel claim.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerReference":{
            "maxLength":"50",
            "type":"string",
            "description":"Number that identifies the reference details passed by the customer.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "SettlementDate":{
            "type":"string",
            "description":"Date when the claim moves to settled status.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ApprovedBy":{
            "type":"string",
            "description":"User who approved the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnit":{
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToCustomer":{
            "type":"string",
            "description":"Name of the ship-to customer.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "FunctionalCurrency":{
            "type":"string",
            "description":"Value that indicates the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToCustomerSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "ShipToCustomer",
                    "ShipToCustomerId",
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "ConversionDate":{
            "type":"string",
            "description":"Date when the amount is converted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "associations":{
            "title":"Associations",
            "type":"array",
            "description":"The Associations resource manages accrual associations of a claim.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-associations-item-response"
            }
        },
        "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":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The Attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-attachments-item-response"
            }
        },
        "ClaimSource":{
            "type":"string",
            "description":"Name of the claim sources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceMapId":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim source map assigned to the claim.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"22"
            },
            "x-queryable":true
        },
        "ShipToCustomerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "ClaimReason":{
            "type":"string",
            "description":"Reason for creating the claim.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "FunctionalCurrencyCode":{
            "type":"string",
            "description":"Abbreviation that identifies the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSalespersonId":{
            "type":"integer",
            "description":"Value that indicates the claim salesperson's number.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReceiptReference":{
            "maxLength":"255",
            "type":"string",
            "description":"Reference provided in the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "settlementMethods":{
            "title":"Settlement Methods",
            "type":"array",
            "description":"The Settlement Methods resource manages the settlement method that's used to settle a claim.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-settlementMethods-item-response"
            }
        },
        "InvoiceDate":{
            "type":"string",
            "description":"Date when the invoice is created.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimNumber":{
            "type":"string",
            "description":"Number that indicates the customer claim.",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Amount claimed in the claim currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "ClaimOwnerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the person who owns the channel claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceClaimNumber":{
            "maxLength":"240",
            "type":"string",
            "description":"Number that indicates the caim number in the source system.",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiptId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReceiptApplicationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the application line in the receipt.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ConversionRate":{
            "type":"number",
            "description":"Value that indicates the conversion rate defined in the general ledger.",
            "nullable":true,
            "x-queryable":true
        },
        "AccountedResolvedAmount":{
            "type":"number",
            "description":"Value that indicates the resolved amount in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RejectedById":{
            "type":"integer",
            "description":"Value that uniquely identifies the user who rejected the claim.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReceiptDate":{
            "type":"string",
            "description":"Date when the receipt is created.",
            "format":"date",
            "nullable":true,
            "readOnly":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
        },
        "CommentsForApprovers":{
            "maxLength":"4000",
            "type":"string",
            "description":"Comments submitted to provide additional information to approvers.",
            "nullable":true,
            "x-queryable":true
        },
        "RejectedDate":{
            "type":"string",
            "description":"Date when the user rejected the claim.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSalesperson":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the salesperson associated with the claim.",
            "nullable":true,
            "x-queryable":true
        },
        "notes":{
            "title":"Notes",
            "type":"array",
            "description":"The Notes resource captures comments, information, or instructions for a claim.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-notes-item-response"
            }
        },
        "CustomerReferenceDate":{
            "type":"string",
            "description":"Date of the customer reference document.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementType":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the settlement type.",
            "nullable":true,
            "x-queryable":true
        },
        "TotalAssociatedAmount":{
            "type":"number",
            "description":"Value that identifies the association amount total in claim currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RejectedBy":{
            "type":"string",
            "description":"User who rejected the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAccountNumber":{
            "type":"string",
            "description":"Number of the bill-to customer account.",
            "nullable":true,
            "x-queryable":true
        },
        "ResolvedAmount":{
            "type":"number",
            "description":"Value that indicates the resolved amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountedSplitAmount":{
            "type":"number",
            "description":"Amount that's carried over to the child claim in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSourceCode":{
            "type":"string",
            "description":"Abbreviation that identifies the claim sources.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimReasonId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reason to create the claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "SourceClaimSystem":{
            "maxLength":"240",
            "type":"string",
            "description":"Value that indicates the source sytem from where the claim is interefaced.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClaimDate":{
            "type":"string",
            "description":"Date when a claim is created.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "BillToContact":{
            "type":"string",
            "description":"Name of the bill-to customer account's contact.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "InvoiceCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the receipt currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number of the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimOwner":{
            "type":"string",
            "description":"Name of the person who owns the channel claim.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimSalespersonNumber":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim's salesperson.",
            "nullable":true,
            "x-queryable":true
        },
        "AmountRemaining":{
            "type":"number",
            "description":"Amount remaining in the claim's currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ApprovedDate":{
            "type":"string",
            "description":"Date when the user approved the claim.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceiptCurrencyCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the receipt currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatusCode":{
            "type":"string",
            "description":"Abbreviation that identifies the system status of the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChildClaim":{
            "type":"string",
            "description":"Number of the child claim created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AppliedExistingTransactionsTotal":{
            "type":"number",
            "description":"Value that identifies the sum of the applied existing transactions amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountedAmountRemaining":{
            "type":"number",
            "description":"Amount remaining in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BillToSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChildClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the child claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the status of the channel claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SettlementTypeCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the settlement type selected to settle the claim. A list of accepted values is defined in the lookup type ORA_CJM_CUST_CLAIM_RESOL_TYPE.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceSalesperson":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the salesperson associated with the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerReason":{
            "maxLength":"150",
            "type":"string",
            "description":"Reason provided by the customer to create the claim.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "InvoiceCurrencyCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the invoice currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "settlementLines":{
            "title":"Settlement Lines",
            "type":"array",
            "description":"The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-settlementLines-item-response"
            }
        },
        "ApprovedById":{
            "type":"integer",
            "description":"Value that uniquely identifies the user who approved the claim.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccountingDate":{
            "type":"string",
            "description":"Date when the claim is accounted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceAmount":{
            "type":"number",
            "description":"Amount of the invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountedAmount":{
            "type":"number",
            "description":"Amount claimed in the functional currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentClaim":{
            "type":"string",
            "description":"Number that identifies the parent claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the invoice.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConversionRateType":{
            "maxLength":"30",
            "type":"string",
            "description":"Name of the conversion type defined in the general ledger.",
            "nullable":true,
            "x-queryable":true
        },
        "BillToSite":{
            "type":"string",
            "description":"Name of the bill-to customer account site.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Age":{
            "type":"integer",
            "description":"Number that identifies the age of the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SystemStatus":{
            "type":"string",
            "description":"System status of the channel claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Broker":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the broker.",
            "nullable":true,
            "x-queryable":true
        },
        "BrokerId":{
            "type":"integer",
            "description":"Value that uniquely identifies the broker.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "receiptDFF":{
            "title":"Descriptive Flexfields of Receipt Application Line",
            "type":"array",
            "description":"The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment.",
            "items":{
                "$ref":"#/components/schemas/channelCustomerClaims-receiptDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ReceiptCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the currency in the receipt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToContactId":{
            "type":"integer",
            "description":"Value that uniquely represents the bill-to customer account's contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "ResolvedBy":{
            "type":"string",
            "description":"User who submitted the claim for approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToCustomerSite":{
            "type":"string",
            "description":"Name of the ship-to customer site.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ShipToCustomer",
                    "ShipToCustomerId",
                    "Status",
                    "StatusId"
                ]
            },
            "x-queryable":true
        },
        "BillToSiteAddress":{
            "type":"string",
            "description":"Address of the bill-to customer account site.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Associations

Type: array

Title: Associations

The Associations resource manages accrual associations of a claim.

Show Source

• Array of: object channelCustomerClaims-associations-item-response

{
    "title":"Associations",
    "type":"array",
    "description":"The Associations resource manages accrual associations of a claim.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-associations-item-response"
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The Attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object channelCustomerClaims-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The Attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-attachments-item-response"
    }
}

Nested Schema : Descriptive Flexfields for Channel Customer Claims

Type: array

Title: Descriptive Flexfields for Channel Customer Claims

The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim.

Show Source

• Array of: object channelCustomerClaims-DFF-item-response

{
    "title":"Descriptive Flexfields for Channel Customer Claims",
    "type":"array",
    "description":"The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-DFF-item-response"
    },
    "x-cardinality":"1"
}

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

Type: array

Title: Notes

The Notes resource captures comments, information, or instructions for a claim.

Show Source

• Array of: object channelCustomerClaims-notes-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The Notes resource captures comments, information, or instructions for a claim.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-notes-item-response"
    }
}

Nested Schema : Descriptive Flexfields of Receipt Application Line

Type: array

Title: Descriptive Flexfields of Receipt Application Line

The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment.

Show Source

• Array of: object channelCustomerClaims-receiptDFF-item-response

{
    "title":"Descriptive Flexfields of Receipt Application Line",
    "type":"array",
    "description":"The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-receiptDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Settlement Lines

Type: array

Title: Settlement Lines

The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables.

Show Source

• Array of: object channelCustomerClaims-settlementLines-item-response

{
    "title":"Settlement Lines",
    "type":"array",
    "description":"The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-settlementLines-item-response"
    }
}

Nested Schema : Settlement Methods

Type: array

Title: Settlement Methods

The Settlement Methods resource manages the settlement method that's used to settle a claim.

Show Source

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

{
    "title":"Settlement Methods",
    "type":"array",
    "description":"The Settlement Methods resource manages the settlement method that's used to settle a claim.",
    "items":{
        "$ref":"#/components/schemas/channelCustomerClaims-settlementMethods-item-response"
    }
}

Nested Schema : channelCustomerClaims-associations-item-response

Type: object

Show Source

• AccrueToAccountId: integer (int64)
  Value that uniquely identifies the customer account.
• AccrueToAccountNumber: string
  Maximum Length: 255

  Bill to account number used for the association.
• AccrueToCustomer: string
  Maximum Length: 255

  Name of the bill to customer used for the association.
• AssociatedAmountInClaimCurrency: number
  Association amount in claim currency.
• AssociatedAmountInFunctionalCurrency: number
  Read Only: true

  Association amount in functional currency.
• AssociatedAmountInTransactionCurrency: number
  Read Only: true

  Association amount in program currency.
• AssociationId: integer (int64)
  Value that uniquely identifies the claim association.
• ClaimId: integer (int64)
  Read Only: true

  Value that uniquely identifies 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.
• InvoiceNumber: string
  Maximum Length: 50

  Number that indicates the invoice.
• Item: string
  Maximum Length: 255

  Name of the item used for the association.
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the item used for the association.
• ItemId: integer (int64)
  Value that uniquely identifies the item.
• 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.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

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

  Name of the program used for the association.
• ProgramId: integer (int64)
  Value that uniquely identifies the customer program.
• ProgramType: string
  Read Only: true

  Maximum Length: 255

  Name of the program type used for the association.
• ProgramTypeId: integer (int64)
  Read Only: true

  Value that uniquely identifies the program type used for the association.
• PromotionCode: string
  Maximum Length: 255

  Name of the promotion code used for the association.
• SearchAccrualsBeforeDate: string (date)
  Search parameter for finding accruals before a specified date.
• SearchAssociationType: string
  Maximum Length: 255

  Search parameter for the association type for accruals.
• SearchAssociationTypeCode: string
  Maximum Length: 30

  Search parameter for the association type code for accruals.
• SearchCalendarYear: string
  Maximum Length: 30

  Search parameter for the calendar year for accruals.
• SearchExcludeZeroBalancesFlag: boolean
  Maximum Length: 1

  Search parameter for excluding zero-balance accruals.
• SearchInvoiceNumber: string
  Maximum Length: 50

  Search parameter for accruals based on an invoice number.
• SearchItem: string
  Maximum Length: 255

  Item number search parameter for accruals.
• SearchItemId: integer (int64)
  Item ID search parameter for accruals.
• SearchMatchingLevel: string
  Maximum Length: 255

  Matching level search parameter for accruals.
• SearchMatchingLevelCode: string
  Maximum Length: 30

  Matching level code search parameter for accruals.
• SearchProgram: string
  Maximum Length: 255

  Program name search parameter for accruals.
• SearchProgramId: integer (int64)
  Program ID search parameter for accruals.
• SearchProgramType: string
  Maximum Length: 255

  Program type search parameter for accruals.
• SearchProgramTypeId: integer (int64)
  Program type ID search parameter for accruals.
• SearchPromotionCode: string
  Maximum Length: 255

  Promotion code search parameter for accruals.
• SearchRelatedCustomerAccountId: integer (int64)
  Search parameter for the related customer account ID for accruals.
• SearchRelatedCustomerAccountNumber: string
  Maximum Length: 255

  Search parameter for the related customer account number for accruals.
• SearchShowActiveProgramsFlag: boolean
  Maximum Length: 1

  Search parameters for displaying active program accruals.
• TransactionCurrency: string
  Read Only: true

  Maximum Length: 255

  Transaction currency used for the association.
• TransactionCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  Abbreviation that identifies the transaction currency.

{
    "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
        },
        "AssociatedAmountInClaimCurrency":{
            "type":"number",
            "description":"Association amount in claim currency.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchPromotionCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Promotion code search parameter for accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SearchMatchingLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Matching level code search parameter for accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchProgramId":{
            "type":"integer",
            "description":"Program ID search parameter for accruals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SearchShowActiveProgramsFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Search parameters for displaying active program accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchAssociationType":{
            "maxLength":"255",
            "type":"string",
            "description":"Search parameter for the association type for accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":"255",
            "type":"string",
            "description":"Description of the item used for the association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionCurrency":{
            "maxLength":"255",
            "type":"string",
            "description":"Transaction currency used for the association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SearchItem":{
            "maxLength":"255",
            "type":"string",
            "description":"Item number search parameter for accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchRelatedCustomerAccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Search parameter for the related customer account number for accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchCalendarYear":{
            "maxLength":"30",
            "type":"string",
            "description":"Search parameter for the calendar year for accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchInvoiceNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"Search parameter for accruals based on an invoice number.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchExcludeZeroBalancesFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Search parameter for excluding zero-balance accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "Item":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the item used for the association.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchItemId":{
            "type":"integer",
            "description":"Item ID search parameter for accruals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SearchMatchingLevel":{
            "maxLength":"255",
            "type":"string",
            "description":"Matching level search parameter for accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProgramType":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the program type used for the association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceNumber":{
            "maxLength":"50",
            "type":"string",
            "description":"Number that indicates the invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "AssociatedAmountInTransactionCurrency":{
            "type":"number",
            "description":"Association amount in program currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SearchAccrualsBeforeDate":{
            "type":"string",
            "description":"Search parameter for finding accruals before a specified date.",
            "format":"date",
            "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
        },
        "AccrueToAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccrueToAccountNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Bill to account number used for the association.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Program":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the program used for the association.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchAssociationTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Search parameter for the association type code for accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "PromotionCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the promotion code used for the association.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the customer program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"Abbreviation that identifies the transaction currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SearchProgramTypeId":{
            "type":"integer",
            "description":"Program type ID search parameter for accruals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ProgramTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program type used for the association.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"255"
            },
            "x-queryable":true
        },
        "SearchProgramType":{
            "maxLength":"255",
            "type":"string",
            "description":"Program type search parameter for accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchRelatedCustomerAccountId":{
            "type":"integer",
            "description":"Search parameter for the related customer account ID for accruals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccrueToCustomer":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the bill to customer used for the association.",
            "nullable":true,
            "x-queryable":true
        },
        "SearchProgram":{
            "maxLength":"255",
            "type":"string",
            "description":"Program name search parameter for accruals.",
            "nullable":true,
            "x-queryable":true
        },
        "AssociationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssociatedAmountInFunctionalCurrency":{
            "type":"number",
            "description":"Association amount in functional currency.",
            "nullable":true,
            "readOnly":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
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":true,
            "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"
    }
}

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-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  Value that uniquely identifies the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  Name of the category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared. The default value is false.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  User who created the attachment.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  User name of the person who uploaded the image.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the attachment record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  Code indicating the type of data in the attachment. For example, FILE, WEB_PAGE, or TEXT.
• Description: string
  Title: Description

  Maximum Length: 255

  Description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  Unique identifier of the attached document.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  Folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  Current version number of the attachment.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  Code indicating the type of error, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  Error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  Date when the contents in the attachment expire.
• FileContents: string (byte)
  Title: File Contents

  Contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  File name of the attachment.
• FileUrl: string
  Title: File Url

  URL of the attachment.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  Base64-encoded image of the file displayed in .PNG format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  User who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  User name of the person who last updated the image.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  Title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  Content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  Length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  Name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  Text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  Login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the attachment record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"Description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"File name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"Base64-encoded image of the file displayed in .PNG format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"Unique identifier of the attached document.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"Value that uniquely identifies the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"User name of the person who uploaded the image.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"Length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"User who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"Error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"Login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"User who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Code indicating the type of data in the attachment. For example, FILE, WEB_PAGE, or TEXT.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"User name of the person who last updated the image.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"Name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"URL of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"Code indicating the type of error, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"Folder path of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"Text of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Descriptive flexfield context name for the channel customer claim.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Descriptive flexfield context display value for the channel customer claim.
• ClaimId: integer (int64)
  Value that uniquely identifies the channel customer claim.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel customer claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Descriptive flexfield context display value for the channel customer claim.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"Descriptive flexfield context name for the channel customer claim.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : channelCustomerClaims-notes-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  Relationship ID populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  Corporate currency code for extensibility.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  Party ID of the note creator.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  Type of currency conversion rate for extensibility.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  Currency code for extensibility.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the user has access to delete the note.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  Email address of the user who created the note.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  Address of the user who created the note.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  Phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the record
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  Login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  Unique identifier of the note. This is the primary key of the notes table.
• NoteNumber: string
  Maximum Length: 30

  Alternate unique identifier of the note. A user key that is system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  Title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  Column which stores the note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  Note type code for categorization of the note.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  Unique identifier of the parent source object associated with the note.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  Unique identifier of the party.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  Name of the party.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  Source object code for the source object as defined in the OBJECTS metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  Unique identifier of the parent source object associated to the note.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the user can update the note.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of currency conversion rate for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"Attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"Relationship ID populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"Currency code for extensibility.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user can update the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Alternate unique identifier of the note. A user key that is system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"Source object code for the source object as defined in the OBJECTS metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"Phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Corporate currency code for extensibility.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"Column which stores the note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"Title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the record",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"Unique identifier of the note. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"Party ID of the note creator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"Address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Note type code for categorization of the note.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"Email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"Unique identifier of the parent source object associated to the note.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"Unique identifier of the parent source object associated with the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"Login of the user who last updated the record.",
            "nullable":true,
            "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"
    }
}

Nested Schema : channelCustomerClaims-receiptDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Value

  Read Only: true

  Maximum Length: 30

  Context name for the receivable application descriptive flexfield.
• __FLEX_Context_DisplayValue: string
  Title: Context Value
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReceivableApplicationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the receipt application.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReceivableApplicationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the receipt application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Value",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Value",
            "maxLength":"30",
            "type":"string",
            "description":"Context name for the receivable application descriptive flexfield.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : channelCustomerClaims-settlementLines-item-response

Type: object

Show Source

• Amount: number
  Value that indicates the amount on the claim line.
• 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.
• Description: string
  Maximum Length: 240

  Description of the claim line.
• Item: string
  Name of the item in the inventory.
• ItemId: integer (int64)
  Value that uniquely identifies the item.
• 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.
• LineNumber: number
  Number that indicates the claim line.
• LineType: string
  Name of the transaction line type.
• LineTypeCode: string
  Maximum Length: 20

  Abbreviation that identifies the transaction line type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemoLine: string
  Name of the memo line.
• MemoLineId: integer (int64)
  Value that uniquely identifies the memo line.
• ProgramCode: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the program code associated with the settlement line.
• ProgramId: integer
  Read Only: true

  Value that uniquely identifies the program associated with the settlement line.
• ProgramName: string
  Read Only: true

  Maximum Length: 255

  Name of the program associated with the settlement line.
• Quantity: number
  Value that indicates the quantity on the claim line.
• SettlementLineId: integer (int64)
  Read Only: true

  Value that uniquely identifies the claim line created in the application.
• UnitOfMeasure: string
  Name of the unit of measure.
• UnitOfMeasureCode: string
  Maximum Length: 3

  Abbreviation for the unit of measure code.
• UnitPrice: number
  Value that indicates the unit price for the selected item.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that identifies the transaction line type.",
            "nullable":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
        },
        "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":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation for the unit of measure code.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the claim line.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "Amount":{
            "type":"number",
            "description":"Value that indicates the amount on the claim line.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Value that indicates the quantity on the claim line.",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramId":{
            "type":"integer",
            "description":"Value that uniquely identifies the program associated with the settlement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of  the program associated with the settlement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LineNumber":{
            "type":"number",
            "description":"Number that indicates the claim line.",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the program code associated with the settlement line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Item":{
            "type":"string",
            "description":"Name of the item in the inventory.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitPrice":{
            "type":"number",
            "description":"Value that indicates the unit price for the selected item.",
            "nullable":true,
            "x-queryable":true
        },
        "SettlementLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim line created in the application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LineType":{
            "type":"string",
            "description":"Name of the transaction line type.",
            "nullable":true,
            "x-queryable":true
        },
        "MemoLine":{
            "type":"string",
            "description":"Name of the memo line.",
            "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
        },
        "MemoLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the memo line.",
            "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 : 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-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-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 : 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

DFF

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/DFF

Parameters:

• ClaimId: $request.path.ClaimId

The Descriptive Flexfields for Channel Customer Claims resource manages additional details for a claim.

associations

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/associations

Parameters:

• ClaimId: $request.path.ClaimId

The Associations resource manages accrual associations of a claim.

attachments

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/attachments

Parameters:

• ClaimId: $request.path.ClaimId

The Attachments resource is used to view, create, and update attachments.

cancel

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/action/cancel

Parameters:

• ClaimId: $request.path.ClaimId

Action to cancel a manual claim.

notes

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/notes

Parameters:

• ClaimId: $request.path.ClaimId

The Notes resource captures comments, information, or instructions for a claim.

receiptDFF

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/receiptDFF

Parameters:

• ClaimId: $request.path.ClaimId

The Descriptive Flexfields of Receipt Application Line resource manages the receipt application line descriptive flexfields for deductions and overpayment.

reopenCustom

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/action/reopenCustom

Parameters:

• ClaimId: $request.path.ClaimId

Action to reopen a claim with custom settlement method.

settle

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/action/settle

Parameters:

• ClaimId: $request.path.ClaimId

Action to settle a claim.

settleCustom

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/action/settleCustom

Parameters:

• ClaimId: $request.path.ClaimId

Action to settle a claim with custom settlement method.

settlementLines

Operation: /fscmRestApi/resources/11.13.18.05/channelCustomerClaims/{ClaimId}/child/settlementLines

Parameters:

• ClaimId: $request.path.ClaimId

The Settlement Lines resource manages a set of transaction lines that's used to create settlement artifacts such as credit memos in Receivables.

settlementMethods

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

Parameters:

• ClaimId: $request.path.ClaimId

The Settlement Methods resource manages the settlement method that's used to settle a claim.

Back to Top

Examples

This example describes how to create customer claims.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password "server:port/fscmRestApi/resources/latest/channelCustomerClaims

Example Request Body

The following example includes the contents of the request body in JSON format.

"{
"BusinessUnitId": "204",
"Currency": "US Dollar",
"BillToAccountId": 1287,
"Amount": 1800,
"ClaimDate": "2021-04-10" ,
"BillToContact": "Stephen Etter",
"ShipToCustomer": "CDS GROUP INC",
"ClaimType": "Unknown",
"ClaimReason": "Shipping",
"CustomerReference": "",
"CustomerReason": "",
"Status": "OPEN",
"settlementMethods": [
{
"SettlementMethod": "Credit Memo - On Account",
"CreditMemoTransactionType": "Credit Memo",
"CreditMemoReason": "Billing",
"SalesPerson": "Adrian Jones"
}],
"settlementLines":[
{
"LineNumber":1,
"Item": "",
"Description": "Item",
"Quantity":1,
"UnitPrice":200,
"Amount": 200,
"UnitOfMeasureCode": "DZ"
}
]}"

Example Response Body

The following example includes the contents of the response body in JSON format:

"{
    "ClaimId": 300100550533655,
    "ClaimNumber": "CLM29007",
    "ClaimSource": "Manual Claim",
    "ClaimSourceCode": "CLAIM",
    "BusinessUnit": "Vision Operations",
    "BusinessUnitId": 204,
    "Amount": 1800,
    "AccountedAmount": 1800,
    "Currency": "US Dollar",
    "CurrencyCode": "USD",
    "FunctionalCurrency": "US Dollar",
    "FunctionalCurrencyCode": "USD",
    "BillToCustomer": "CDS, Inc",
    "BillToAccountNumber": "1140",
    "BillToAccountId": 1287,
    "BillToSite": "Pittsburgh (OPS)",
    "BillToSiteId": 1337,
    "BillToSiteAddress": "131 Commercial Drive Suite 200 Pittsburgh, PA 15122 United States",
    "BillToContact": "Stephen Etter",
    "BillToContactId": 6094,
    "ShipToCustomer": "CDS GROUP INC",
    "ShipToCustomerId": 800995,
    "ShipToCustomerSite": "244264",
    "ShipToCustomerSiteId": 372640,
    "ShipToCustomerSiteAddress": "404 S FIGUEROA ST",
    "ClaimDate": "2021-04-10",
    "Age": 60,
    "ClaimType": "Unknown",
    "ClaimTypeId": 300100205262731,
    "ClaimReason": "Shipping",
    "ClaimReasonId": 300100205165987,
    "CustomerReference": "",
    "CustomerReason": "",
    "Status": "OPEN",
    "StatusId": 100100144204818,
    "SystemStatus": "Open",
    "SystemStatusCode": "OPEN",
    "ClaimOwner": "channel_user",
    "ClaimOwnerId": 300100181693728,
    "ConversionRateType": "Corporate",
    "ConversionRate": 1,
    "ConversionDate": "2021-06-08",
    "ResolvedDate": null,
    "ResolvedBy": null,
    "ResolvedAmount": null,
    "AccountedResolvedAmount": null,
    "ApprovedDate": null,
    "SettlementDate": null,
    "AccountingDate": null,
    "ChildClaim": null,
    "ChildClaimId": null,
    "SplitAmount": null,
    "AccountedSplitAmount": null,
    "ParentClaim": null,
    "ParentClaimId": null,
    "CreatedBy": "channel_user",
    "CreationDate": "2021-06-08T05:49:34+00:00",
    "LastUpdatedBy": "channel_user",
    "LastUpdateDate": "2021-06-08T05:49:44.844+00:00",
    "settlementMethods": [
        {
            "SettlementMethodId": 300100550533656,
            "ClaimId": 300100550533655,
            "SettlementMethod": "Credit Memo - On Account",
            "SettlementMethodCode": "CM_ON_ACCOUNT",
            "CreditMemoTransactionType": "Credit Memo",
            "CreditMemoTransactionTypeSequenceId": 35,
            "CreditMemoReason": "Billing",
            "CreditMemoReasonCode": "OMBILLING",
            "OverrideTransactionDate": null,
            "TransactionAccountingDate": null,
            "SalesPerson": "Adrian Jones",
            "SalesPersonNumber": "999990000955418",
            "SalesPersonId": 100000008143336,
            "CreatedBy": "channel_user",
            "CreationDate": "2021-06-08T05:49:41.593+00:00",
            "LastUpdatedBy": "channel_user",
            "LastUpdateDate": "2021-06-08T05:49:44.860+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655/child/settlementMethods/300100550533656",
                    "name": "settlementMethods",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655/child/settlementMethods/300100550533656",
                    "name": "settlementMethods",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655",
                    "name": "channelCustomerClaims",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655/child/settlementMethods/300100550533656/child/settlementDocuments",
                    "name": "settlementDocuments",
                    "kind": "collection"
                }
            ]
        }
    ],
    "settlementLines": [
        {
            "SettlementLineId": 300100550533657,
            "ClaimId": 300100550533655,
            "LineNumber": 1,
            "ItemType": null,
            "ItemTypeCode": null,
            "Item": "",
            "ItemId": null,
            "Description": "Item",
            "MemoLine": null,
            "MemoLineId": null,
            "Quantity": 1,
            "UnitOfMeasure": null,
            "UnitOfMeasureCode": "DZ",
            "UnitPrice": 200,
            "Amount": 200,
            "CreatedBy": "channel_user",
            "CreationDate": "2021-06-08T05:49:44.602+00:00",
            "LastUpdatedBy": "channel_user",
            "LastUpdateDate": "2021-06-08T05:49:45.522+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655/child/settlementLines/300100550533657",
                    "name": "settlementLines",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655/child/settlementLines/300100550533657",
                    "name": "settlementLines",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655",
                    "name": "channelCustomerClaims",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655",
            "name": "channelCustomerClaims",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655",
            "name": "channelCustomerClaims",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655/child/settlementLines",
            "name": "settlementLines",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655/child/settlementMethods",
            "name": "settlementMethods",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655/action/cancel",
            "name": "cancel",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/channelCustomerClaims/300100550533655/action/settle",
            "name": "settle",
            "kind": "other"
        }
    ]
}"

Back to Top