Jump to

• Request
• Response

Create settlement lines

post

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

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : channelCustomerClaims-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 : 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