Jump to

• Request
• Response

Get a cashier session

get

/fscmRestApi/resources/11.13.18.05/publicSectorCashierSessions/{SessionId}

Request

Path Parameters

• SessionId: string
  The unique identifier for the cashier session.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 : publicSectorCashierSessions-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The unique identifier for the agency that receives incoming customer payments.
• BegBalanceAmount(optional): number(float)
  Title: Opening Balance

  The cash amount that is available in the cash drawer at the beginning of the cashier session.
• CashierId(optional): string
  Title: Cashier ID

  Maximum Length: 50

  The unique identifier for the cashier.
• CurrencyCode(optional): string
  Title: Currency

  Maximum Length: 3

  The currency code of coins and bills in the cash drawer.
• DrawerId(optional): string
  Title: Cash Drawer ID

  Maximum Length: 30

  The unique identifier for the drawer.
• EndBalanceAmount(optional): number(float)
  Title: Closing Balance

  The cash amount that is available in the cash drawer at the closing of the cashier session.
• EndDatetime(optional): string(date-time)
  Title: End Time

  The close date and time for the cashier session.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the cashier session was last updated.
• LineNumber(optional): integer(int64)
  The number of a journal line. An accounting journal is a record of business transactions for an organization that is posted to a ledger and included in financial reports.
• links(optional): array Items
  Title: Items

  Link Relations
• SessionId(optional): string
  Title: Session ID

  Maximum Length: 50

  The unique identifier for the cashier session.
• SessionStatus(optional): string
  Title: Status

  Maximum Length: 10

  The status of the cashier session, which can be opened, suspended or closed.
• StartDatetime(optional): string(date-time)
  Title: Start Time

  The begin date and time for the cashier session.
• UserName(optional): string
  Title: Agency Employee

  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":{
            "format":"float",
            "type":"number",
            "description":"The cash amount that is available in the cash drawer at the beginning of the cashier session.",
            "title":"Opening Balance"
        },
        "CashierId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier.",
            "title":"Cashier ID"
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code of coins and bills in the cash drawer.",
            "title":"Currency"
        },
        "DrawerId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the drawer.",
            "title":"Cash Drawer ID"
        },
        "EndBalanceAmount":{
            "format":"float",
            "type":"number",
            "description":"The cash amount that is available in the cash drawer at the closing of the cashier session.",
            "title":"Closing Balance"
        },
        "EndDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The close date and time for the cashier session.",
            "title":"End Time"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the cashier session was last updated.",
            "title":"Last Updated Date"
        },
        "LineNumber":{
            "format":"int64",
            "type":"integer",
            "description":"The number of a journal line. An accounting journal is a record of business transactions for an organization that is posted to a ledger and included in financial reports."
        },
        "SessionId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for the cashier session.",
            "title":"Session ID"
        },
        "SessionStatus":{
            "maxLength":10,
            "type":"string",
            "description":"The status of the cashier session, which can be opened, suspended or closed.",
            "title":"Status"
        },
        "StartDatetime":{
            "format":"date-time",
            "type":"string",
            "description":"The begin date and time for the cashier session.",
            "title":"Start Time"
        },
        "UserName":{
            "maxLength":100,
            "type":"string",
            "description":"The user name of the employee who acts as the cashier of the cashier session.",
            "title":"Agency Employee"
        },
        "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