Jump to

• Request
• Response
• Examples

Get one claim type

get

/fscmRestApi/resources/11.13.18.05/channelClaimTypes/{ClaimTypeId}

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(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 : channelClaimTypes-item-response

Type: object

Show Source

• businessUnitLevelMappings: array Business-Unit Level Mappings
  Title: Business-Unit Level Mappings

  The Business-Unit Level Mappings resource manages the business unit level mappings for a claim type within a reference data set.
• BuySideFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the claim type will be enabled for the buy-side flows. If false, then the claim type will not be enabled for the buy-side flows. This attribute does not have a default value.
• ChargebackTransactionType: string
  Maximum Length: 255

  Name that identifies the transaction type for a receivables chargeback. This transaction type is passed to receivables when deductions using this claim type are settled by chargeback.
• ChargebackTransactionTypeSequenceId: integer (int64)
  Value that identifies the transaction type for a receivables chargeback. This transaction type is passed to receivables when deductions using this claim type are settled by chargeback.
• ClaimType: string
  Maximum Length: 120

  Name of the channel claim type.
• ClaimTypeCode: string
  Maximum Length: 30

  Abbreviation that identifies the channel claim type.
• ClaimTypeId: integer (int64)
  Read Only: true

  Value that uniquely identifies the channel claim type. It is a primary key that the application generates when it creates the claim type.
• 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.
• CreditMemoTransactionType: string
  Name that identifies the transaction type for a receivables credit memo. This transaction type is passed to receivables when claims or deductions using this claim type are settled by a credit memo.
• CreditMemoTransactionTypeSequenceId: integer (int64)
  Value that identifies the transaction type for a receivables credit memo. This transaction type is passed to receivables when claims or deductions using this claim type are settled by a credit memo.
• Description: string
  Maximum Length: 1000

  Description of the channel claim type.
• EndDate: string (date)
  Date when the channel claim type becomes inactive.
• InvoiceTransactionType: string
  Maximum Length: 255

  Name that identifies the transaction type for a receivables Invoice. This transaction type is passed to receivables when claims or overpayments using this claim type are settled by an invoice.
• InvoiceTransactionTypeSequenceId: integer (int64)
  Value that identifies the transaction type for a receivables Invoice. This transaction type is passed to receivables when claims or overpayments using this claim type are settled by an invoice.
• 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.
• SellSideFlag: boolean
  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then the claim type will be enabled for the sell-side flows. If false, then the claim type will not be enabled for the sell-side flows. This attribute does not have a default value.
• SetCode: string
  Abbreviation that identifies the reference data set to which channel claim type is assigned to.
• SetId: integer (int64)
  Value that uniquely identifies the reference data set to which channel claim type is assigned to.
• SetName: string
  Name of the reference data set to which channel claim type is assigned to.
• StartDate: string (date)
  Date when the channel claim type becomes active.

{
    "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":false
        },
        "InvoiceTransactionTypeSequenceId":{
            "type":"integer",
            "description":"Value that identifies the transaction type for a receivables Invoice. This transaction type is passed to receivables when claims or overpayments using this claim type are settled by an invoice.",
            "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":false
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"Description of the channel claim type.",
            "nullable":true,
            "x-queryable":false
        },
        "SellSideFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the claim type will be enabled for the sell-side flows. If false, then the claim type will not be enabled for the sell-side flows. This attribute does not have a default value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "InvoiceTransactionType":{
            "maxLength":255,
            "type":"string",
            "description":"Name that identifies the transaction type for a receivables Invoice. This transaction type is passed to receivables when claims or overpayments using this claim type are settled by an invoice.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel claim type. It is a primary key that the application generates when it creates the claim type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClaimTypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the channel claim type.",
            "nullable":false,
            "x-queryable":true
        },
        "SetName":{
            "type":"string",
            "description":"Name of the reference data set to which channel claim type is assigned to.",
            "nullable":true,
            "x-queryable":true
        },
        "BuySideFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the claim type will be enabled for the buy-side flows. If false, then the claim type will not be enabled for the buy-side flows. This attribute does not have a default value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Date when the channel claim type becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "SetCode":{
            "type":"string",
            "description":"Abbreviation that identifies the reference data set to which channel claim type is assigned to.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimType":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the channel claim type.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the channel claim type becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CreditMemoTransactionType":{
            "type":"string",
            "description":"Name that identifies the transaction type for a receivables credit memo. This transaction type is passed to receivables when claims or deductions using this claim type are settled by a credit memo.",
            "nullable":true,
            "x-queryable":true
        },
        "ChargebackTransactionTypeSequenceId":{
            "type":"integer",
            "description":"Value that identifies the transaction type for a receivables chargeback. This transaction type is passed to receivables when deductions using this claim type are settled by chargeback.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "businessUnitLevelMappings":{
            "title":"Business-Unit Level Mappings",
            "type":"array",
            "description":"The Business-Unit Level Mappings resource manages the business unit level mappings for a claim type within a reference data set.",
            "items":{
                "$ref":"#/components/schemas/channelClaimTypes-businessUnitLevelMappings-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChargebackTransactionType":{
            "maxLength":255,
            "type":"string",
            "description":"Name that identifies the transaction type for a receivables chargeback. This transaction type is passed to receivables when deductions using this claim type are settled by chargeback.",
            "nullable":true,
            "x-queryable":true
        },
        "SetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reference data set to which channel claim type is assigned to.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditMemoTransactionTypeSequenceId":{
            "type":"integer",
            "description":"Value that identifies the transaction type for a receivables credit memo. This transaction type is passed to receivables when claims or deductions using this claim type are settled by a credit memo.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User who most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Business-Unit Level Mappings

Type: array

Title: Business-Unit Level Mappings

The Business-Unit Level Mappings resource manages the business unit level mappings for a claim type within a reference data set.

Show Source

• Array of: object channelClaimTypes-businessUnitLevelMappings-item-response

{
    "title":"Business-Unit Level Mappings",
    "type":"array",
    "description":"The Business-Unit Level Mappings resource manages the business unit level mappings for a claim type within a reference data set.",
    "items":{
        "$ref":"#/components/schemas/channelClaimTypes-businessUnitLevelMappings-item-response"
    }
}

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 : channelClaimTypes-businessUnitLevelMappings-item-response

Type: object

Show Source

• BUMappingCode: string
  Maximum Length: 240

  Abbreviation that identifies the business-unit level mapping.
• BusinessUnit: string
  Maximum Length: 255

  Name of the business unit.
• BusinessUnitId: integer (int64)
  Value that uniquely identifies the business unit.
• BusinessUnitLevelMappingId: integer (int64)
  Value that uniquely identifies the business-unit level mapping.
• ClaimTypeId: integer (int64)
  Value that uniquely identifies the claim type.
• 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

  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.
• ReceivablesActivityForReceiptWriteOffIdInDeduction: integer (int64)
  Value that identifies the receivables activity for a write-off. This receivable activity is passed to receivables when non-invoice deductions using this claim type are settled by a write-off.
• ReceivablesActivityForReceiptWriteOffInDeduction: string
  Maximum Length: 255

  Name that identifies the receivables activity for a write-off. This receivable activity is passed to receivables when non-invoice deductions using this claim type are settled by a write-off.
• ReceivablesActivityForWriteOffAdjustmentIdInInvDeduction: integer (int64)
  Value that identifies the receivables activity for a write-off adjustment. This receivable activity is passed to receivables when invoice deductions using this claim type are settled by a write-off.
• ReceivablesActivityForWriteOffAdjustmentInInvDeduction: string
  Maximum Length: 255

  Name that identifies the receivables activity for a write-off adjustment. This receivable activity is passed to receivables when invoice deductions using this claim type are settled by a write-off.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivablesActivityForReceiptWriteOffInDeduction":{
            "maxLength":255,
            "type":"string",
            "description":"Name that identifies the receivables activity for a write-off. This receivable activity is passed to receivables when non-invoice deductions using this claim type are settled by a write-off.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReceivablesActivityForWriteOffAdjustmentInInvDeduction":{
            "maxLength":255,
            "type":"string",
            "description":"Name that identifies the receivables activity for a write-off adjustment. This receivable activity is passed to receivables when invoice deductions using this claim type are settled by a write-off.",
            "nullable":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
        },
        "ClaimTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the claim type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceivablesActivityForWriteOffAdjustmentIdInInvDeduction":{
            "type":"integer",
            "description":"Value that identifies the receivables activity for a write-off adjustment. This receivable activity is passed to receivables when invoice deductions using this claim type are settled by a write-off.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReceivablesActivityForReceiptWriteOffIdInDeduction":{
            "type":"integer",
            "description":"Value that identifies the receivables activity for a write-off. This receivable activity is passed to receivables when non-invoice deductions using this claim type are settled by a write-off.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BUMappingCode":{
            "maxLength":240,
            "type":"string",
            "description":"Abbreviation that identifies the business-unit level mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "BusinessUnitLevelMappingId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business-unit level mapping.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessUnit":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

Links

businessUnitLevelMappings

Operation: /fscmRestApi/resources/11.13.18.05/channelClaimTypes/{ClaimTypeId}/child/businessUnitLevelMappings

Parameters:

• ClaimTypeId: $request.path.ClaimTypeId

The Business-Unit Level Mappings resource manages the business unit level mappings for a claim type within a reference data set.

Back to Top

Examples

This example describes how to get one claim type.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/channelClaimTypes/ClaimTypeId"

For example, the following command gets one claim type:

curl -u username:password "https://servername/fscmRestApi/resources/version/channelClaimTypes/300100185728700"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"ClaimTypeId": 300100185728700,
	"ClaimType": "Vendor Claim",
	"Description": "Vendor Claim",
	"SetId": 204,
	"SetName": "Vision Operations Set",
	"SetCode": "Vision Operations 204",
	"StartDate": null,
	"EndDate": null,
	"CreatedBy": "channel_user",
	"CreationDate": "2020-06-02T10:53:30+00:00",
	"LastUpdateDate": "2020-06-02T10:53:30.112+00:00",
	"LastUpdatedBy": "channel_user",
	"ClaimTypeCode": "VENDOR_CLAIM",
	"CreditMemoTransactionTypeSequenceId": null,
	"CreditMemoTransactionType": null,
	"InvoiceTransactionTypeSequenceId": null,
	"InvoiceTransactionType": null,
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/channelClaimTypes/300100185728700",
		"name": "channelClaimTypes",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/channelClaimTypes/300100185728700",
		"name": "channelClaimTypes",
		"kind": "item"
	}
	]
}

Back to Top