Jump to

• Request
• Response

Create a cash drawer session

post

/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawerSessions

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorCashDrawerSessions-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier for the agency that receives incoming customer payments.
• BegBalanceAmount(optional): number
  The cash amount that is available in the cash drawer at the beginning of the cashier session.
• BnpCashDrawerSessionTimeView(optional): array Cash Drawer Sessions Time Lines
  Title: Cash Drawer Sessions Time Lines

  The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.
• CashierId(optional): string
  Maximum Length: 50

  The unique identifier for the cashier.
• CurrencyCode(optional): string
  Maximum Length: 3

  The currency code of coins and bills in the cash drawer.
• DrawerId(optional): string
  Maximum Length: 30

  The unique identifier for the cash drawer.
• EndBalanceAmount(optional): number
  The cash amount that is available in the cash drawer at the closing of the cashier session.
• EndDatetime(optional): string(date-time)
  The end date and time for the cashier session.
• links(optional): array Items
  Title: Items

  Link Relations
• SessionId(optional): string
  Maximum Length: 50

  The unique identifier for the cashier session.
• SessionStatus(optional): string
  Maximum Length: 10

  The status of the cashier session, which can be opened, suspended, or closed.
• StartDatetime(optional): string(date-time)
  The start date and time for the cashier session.
• UserName(optional): string
  Maximum Length: 100

  The user name of the employee who acts as the cashier of the cashier session.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the agency that receives incoming customer payments."
        },
        "BegBalanceAmount":{
            "type":"number",
            "description":"The cash amount that is available in the cash drawer at the beginning of the cashier session."
        },
        "BnpCashDrawerSessionTimeView":{
            "items":{
                "$ref":"#/definitions/publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item"
            },
            "type":"array",
            "description":"The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.",
            "title":"Cash Drawer Sessions Time Lines"
        },
        "CashierId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier."
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code of coins and bills in the cash drawer."
        },
        "DrawerId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the cash drawer."
        },
        "EndBalanceAmount":{
            "type":"number",
            "description":"The cash amount that is available in the cash drawer at the closing of the cashier session."
        },
        "EndDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The end date and time for the cashier session."
        },
        "SessionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier session."
        },
        "SessionStatus":{
            "maxLength":10,
            "type":"string",
            "description":"The status of the cashier session, which can be opened, suspended, or closed."
        },
        "StartDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The start date and time for the cashier session."
        },
        "UserName":{
            "maxLength":100,
            "type":"string",
            "description":"The user name of the employee who acts as the cashier of the cashier session."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Cash Drawer Sessions Time Lines

Type: array

Title: Cash Drawer Sessions Time Lines

The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.

Show Source

• Array of: object publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item"
    },
    "type":"array",
    "description":"The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.",
    "title":"Cash Drawer Sessions Time Lines"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier for the agency that receives incoming customer payments.
• EndDatetime(optional): string(date-time)
  The end date and time for the cashier session line.
• LineNumber(optional): integer(int64)
  The unique identifier for the cashier session line number.
• links(optional): array Items
  Title: Items

  Link Relations
• SessionId(optional): string
  Maximum Length: 50

  The unique identifier for the cashier session.
• StartDatetime(optional): string(date-time)
  The start date and time for the cashier session line.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the agency that receives incoming customer payments."
        },
        "EndDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The end date and time for the cashier session line."
        },
        "LineNumber":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the cashier session line number."
        },
        "SessionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier session."
        },
        "StartDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The start date and time for the cashier session line."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCashDrawerSessions-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier for the agency that receives incoming customer payments.
• BegBalanceAmount(optional): number
  The cash amount that is available in the cash drawer at the beginning of the cashier session.
• BnpCashDrawerSessionTimeView(optional): array Cash Drawer Sessions Time Lines
  Title: Cash Drawer Sessions Time Lines

  The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.
• CashierId(optional): string
  Maximum Length: 50

  The unique identifier for the cashier.
• CurrencyCode(optional): string
  Maximum Length: 3

  The currency code of coins and bills in the cash drawer.
• DrawerId(optional): string
  Maximum Length: 30

  The unique identifier for the cash drawer.
• EndBalanceAmount(optional): number
  The cash amount that is available in the cash drawer at the closing of the cashier session.
• EndDatetime(optional): string(date-time)
  The end date and time for the cashier session.
• links(optional): array Items
  Title: Items

  Link Relations
• SessionId(optional): string
  Maximum Length: 50

  The unique identifier for the cashier session.
• SessionStatus(optional): string
  Maximum Length: 10

  The status of the cashier session, which can be opened, suspended, or closed.
• StartDatetime(optional): string(date-time)
  The start date and time for the cashier session.
• UserName(optional): string
  Maximum Length: 100

  The user name of the employee who acts as the cashier of the cashier session.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the agency that receives incoming customer payments."
        },
        "BegBalanceAmount":{
            "type":"number",
            "description":"The cash amount that is available in the cash drawer at the beginning of the cashier session."
        },
        "BnpCashDrawerSessionTimeView":{
            "items":{
                "$ref":"#/definitions/publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item"
            },
            "type":"array",
            "description":"The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.",
            "title":"Cash Drawer Sessions Time Lines"
        },
        "CashierId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier."
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code of coins and bills in the cash drawer."
        },
        "DrawerId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the cash drawer."
        },
        "EndBalanceAmount":{
            "type":"number",
            "description":"The cash amount that is available in the cash drawer at the closing of the cashier session."
        },
        "EndDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The end date and time for the cashier session."
        },
        "SessionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier session."
        },
        "SessionStatus":{
            "maxLength":10,
            "type":"string",
            "description":"The status of the cashier session, which can be opened, suspended, or closed."
        },
        "StartDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The start date and time for the cashier session."
        },
        "UserName":{
            "maxLength":100,
            "type":"string",
            "description":"The user name of the employee who acts as the cashier of the cashier session."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Cash Drawer Sessions Time Lines

Type: array

Title: Cash Drawer Sessions Time Lines

The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.

Show Source

• Array of: object publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item"
    },
    "type":"array",
    "description":"The cash drawer sessions resource is used to open, suspend, or close cash drawer sessions. A cash drawer session is the instance that allows a cashier to collect money from a customer and deposit that money in a cash drawer device.",
    "title":"Cash Drawer Sessions Time Lines"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorCashDrawerSessions-BnpCashDrawerSessionTimeView-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier for the agency that receives incoming customer payments.
• EndDatetime(optional): string(date-time)
  The end date and time for the cashier session line.
• LineNumber(optional): integer(int64)
  The unique identifier for the cashier session line number.
• links(optional): array Items
  Title: Items

  Link Relations
• SessionId(optional): string
  Maximum Length: 50

  The unique identifier for the cashier session.
• StartDatetime(optional): string(date-time)
  The start date and time for the cashier session line.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the agency that receives incoming customer payments."
        },
        "EndDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The end date and time for the cashier session line."
        },
        "LineNumber":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the cashier session line number."
        },
        "SessionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier session."
        },
        "StartDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The start date and time for the cashier session line."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top