Jump to

• Request
• Response
• Examples

Create settlement methods

post

/fscmRestApi/resources/11.13.18.05/channelClaimSources/{ClaimSourceMapId}/child/settlementMethods

Request

Path Parameters

• ClaimSourceMapId(required): integer(int64)
  Value that uniquely identifies the channel claim source mapping. It is a primary key that the application generates when it creates the claim source mapping.

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

• AccountingFor: string
  Name of the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods.
• AccountingForCode: string
  Maximum Length: 30

  Abbreviation that identifies the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods.
• DefaultFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then set the settlement method as the default settlement method for the claim source mapping. If false, then do not set the settlement method as the default settlement method for the claims source mapping. This attribute does not have a default value.
• EnabledFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the settlement method is enabled in the claim source mapping. If false, then the settlement method is not enabled. This attribute does not have a default value.
• SeededFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the settlement method is predefined. If false, then the settlement method is not predefined. This attribute does not have a default value.
• SettlementMethod: string
  Name of claim settlement method added to the claim source mapping.
• SettlementMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the settlement method added to the claim source mapping.

{
    "type":"object",
    "properties":{
        "SettlementMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the settlement method added to the claim source mapping.",
            "nullable":false
        },
        "SettlementMethod":{
            "type":"string",
            "description":"Name of claim settlement method added to the claim source mapping.",
            "nullable":false
        },
        "AccountingFor":{
            "type":"string",
            "description":"Name of the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods.",
            "nullable":true
        },
        "AccountingForCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods.",
            "nullable":true
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then set the settlement method as the default settlement method for the claim source mapping. If false, then do not set the settlement method as the default settlement method for the claims source mapping. This attribute does not have a default value.",
            "nullable":true,
            "default":false
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the settlement method is enabled in the claim source mapping. If false, then the settlement method is not enabled. This attribute does not have a default value.",
            "nullable":true,
            "default":false
        },
        "SeededFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the settlement method is predefined. If false, then the settlement method is not predefined. This attribute does not have a default value.",
            "nullable":true,
            "default":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : channelClaimSources-settlementMethods-item-response

Type: object

Show Source

• AccountingFor: string
  Name of the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods.
• AccountingForCode: string
  Maximum Length: 30

  Abbreviation that identifies the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods.
• ClaimSourceMapId: integer (int64)
  Read Only: true

  Value that uniquely identifies the channel claim source mapping.
• 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.
• DefaultFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then set the settlement method as the default settlement method for the claim source mapping. If false, then do not set the settlement method as the default settlement method for the claims source mapping. This attribute does not have a default value.
• EnabledFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the settlement method is enabled in the claim source mapping. If false, then the settlement method is not enabled. This attribute does not have a default value.
• 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.
• SeededFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the settlement method is predefined. If false, then the settlement method is not predefined. This attribute does not have a default value.
• SettlementMethod: string
  Name of claim settlement method added to the claim source mapping.
• SettlementMethodCode: string
  Maximum Length: 30

  Abbreviation that identifies the settlement method added to the claim source mapping.
• SourceSettlementMethodId: integer (int64)
  Read Only: true

  Value that uniquely identifies the settlement method added to a claim source mapping. It is a primary key that the application generates when it creates the settlement method.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ClaimSourceMapId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel claim source mapping.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SettlementMethod":{
            "type":"string",
            "description":"Name of claim settlement method added to the claim source mapping.",
            "nullable":false,
            "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":false
        },
        "SourceSettlementMethodId":{
            "type":"integer",
            "description":"Value that uniquely identifies the settlement method added to a claim source mapping. It is a primary key that the application generates when it creates the settlement method.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AccountingForCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods.",
            "nullable":true,
            "x-queryable":true
        },
        "SeededFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the settlement method is predefined. If false, then the settlement method is not predefined. This attribute does not have a default value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SettlementMethodCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the settlement method added to the claim source mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountingFor":{
            "type":"string",
            "description":"Name of the accounting application for the claim settlement method. Valid values are Receivables and Payables. A list of accepted values is defined in the lookup type ORA_CJM_CLAIM_ACCOUNTING_FOR. This value is not editable for predefined claim settlement methods.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then set the settlement method as the default settlement method for the claim source mapping. If false, then do not set the settlement method as the default settlement method for the claims source mapping. This attribute does not have a default value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the settlement method is enabled in the claim source mapping. If false, then the settlement method is not enabled. This attribute does not have a default value.",
            "nullable":true,
            "default":false,
            "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":false
        }
    }
}

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

Back to Top

Examples

This example describes how to create settlement methods.

Example cURL Command

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

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/channelClaimSources/300100181565229/child/settlementMethods"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{          
	"SettlementMethodCode": "AP_DEBIT",
	"SettlementMethod": "AP Debit",
	"AccountingForCode": "PAYABLES",
	"AccountingFor": "Payables",
	"EnabledFlag": true
}	

Example Response Body

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

{
	"SourceSettlementMethodId": 300100181565230,
	"SettlementMethodCode": "AP_DEBIT",
	"SettlementMethod": "AP Debit",
	"AccountingForCode": "PAYABLES",
	"AccountingFor": "Payables",
	"CreatedBy": "channel_user",
	"CreationDate": "2019-08-29T08:31:45+00:00",
	"DefaultFlag": true,
	"EnabledFlag": true,
	"LastUpdateDate": "2019-08-29T08:31:45.074+00:00",
	"LastUpdatedBy": "channel_user",
	"SeededFlag": null,
	"ClaimSourceMapId": 300100181565229,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/channelClaimSources/300100181565229/child/settlementMethods/300100181565230",
		"name": "settlementMethods",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/channelClaimSources/300100181565229/child/settlementMethods/300100181565230",
		"name": "settlementMethods",
		"kind": "item"
	},
	{
		"rel": "parent",
		"href": "https://servername/fscmRestApi/resources/version/channelClaimSources/300100181565229",
		"name": "channelClaimSources",
		"kind": "item"
	}
	]
}

Back to Top