Jump to

• Request
• Response

Get all cash drawer reconciliation views

get

/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawReconcilViews

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds a cash drawer reconciliation view with the specified primary key criteria.
    Finder Variables:
    • SessionId; string; The unique identifier for the cashier session.
  • simpleSearchFinder: Finds a cash drawer reconciliation view with the specified drawer ID or session status.
    Finder Variables:
    • value; string; The unique identifier for the cash drawer or the status of the cash drawer session.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AgencyId; integer; The identifier for the agency that receives incoming customer payments.
  • BegBalanceAmount; number; The cash amount that is available in the cash drawer at the beginning of the cashier session.
  • CashierId; string; The unique identifier for the cashier.
  • Comments; string; Remarks or additional information for the cash drawer session.
  • CurrencyCode; string; The currency code of coins and bills in the cash drawer.
  • Discrepancy; number; The amount of discrepancy, which is the total of the beginning balance and cash expected amounts, minus the actual cash amount.
  • DrawerId; string; The unique identifier for the cash drawer.
  • EndBalanceAmount; number; The cash amount that is available in the cash drawer at the closing of the cashier session.
  • EndDatetime; string; The close date and time of the cashier session.
  • ReconcileDate; string; The date of the cashier session reconciliation.
  • ReconcileId; integer; The unique identifier for the cashier session reconciliation.
  • ReconcileStatus; string; The status of the reconciliation, which is Reconciled or Unreconciled.
  • SessionId; string; The unique identifier for the cashier session.
  • SessionStatus; string; The status of the cashier session, which can be opened, suspended or closed.
  • StartDatetime; string; The begin date and time of the cashier session.
  • TotalActual; number; The total recorded payment amount collected for the cash drawer session.
  • TotalRecord; number; The total actual payment amount collected for the cash drawer session.
  • UserName; string; The user name of the employee who acts as the cashier of the cashier session.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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:
  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.

Body ()

Root Schema : publicSectorCashDrawReconcilViews

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorCashDrawReconcilViews-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"LOV",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorCashDrawReconcilViews-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorCashDrawReconcilViews-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 : publicSectorCashDrawReconcilViews-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Read Only: true

  The identifier for the agency that receives incoming customer payments.
• BegBalanceAmount: number
  Read Only: true

  The cash amount that is available in the cash drawer at the beginning of the cashier session.
• CashierId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier for the cashier.
• Comments: string
  Read Only: true

  Maximum Length: 240

  Remarks or additional information for the cash drawer session.
• CurrencyCode: string
  Read Only: true

  Maximum Length: 3

  The currency code of coins and bills in the cash drawer.
• Discrepancy: number
  Title: Discrepancy Amount

  Read Only: true

  The amount of discrepancy, which is the total of the beginning balance and cash expected amounts, minus the actual cash amount.
• DrawerId: string
  Read Only: true

  Maximum Length: 30

  The unique identifier for the cash drawer.
• EndBalanceAmount: number
  Read Only: true

  The cash amount that is available in the cash drawer at the closing of the cashier session.
• EndDatetime: string (date-time)
  Read Only: true

  The close date and time of the cashier session.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReconcileDate: string (date)
  Read Only: true

  The date of the cashier session reconciliation.
• ReconcileId: integer (int64)
  Read Only: true

  The unique identifier for the cashier session reconciliation.
• ReconcileStatus: string
  Read Only: true

  Maximum Length: 15

  The status of the reconciliation, which is Reconciled or Unreconciled.
• SessionId: string
  Read Only: true

  Maximum Length: 50

  The unique identifier for the cashier session.
• SessionStatus: string
  Read Only: true

  Maximum Length: 10

  The status of the cashier session, which can be opened, suspended or closed.
• StartDatetime: string (date-time)
  Read Only: true

  The begin date and time of the cashier session.
• TotalActual: number
  Read Only: true

  The total recorded payment amount collected for the cash drawer session.
• TotalRecord: number
  Read Only: true

  The total actual payment amount collected for the cash drawer session.
• UserName: string
  Read Only: true

  Maximum Length: 100

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

{
    "type":"object",
    "properties":{
        "ReconcileDate":{
            "type":"string",
            "description":"The date of the cashier session reconciliation.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDatetime":{
            "type":"string",
            "description":"The begin date and time of the cashier session.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReconcileId":{
            "type":"integer",
            "description":"The unique identifier for the cashier session reconciliation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserName":{
            "maxLength":"100",
            "type":"string",
            "description":"The user name of the employee who acts as the cashier of the cashier session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Discrepancy":{
            "title":"Discrepancy Amount",
            "type":"number",
            "description":"The amount of discrepancy, which is the total of the beginning balance and cash expected amounts, minus the actual cash amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDatetime":{
            "type":"string",
            "description":"The close date and time of the cashier session.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the agency that receives incoming customer payments.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "Comments":{
            "maxLength":"240",
            "type":"string",
            "description":"Remarks or additional information for the cash drawer session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CashierId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the cashier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndBalanceAmount":{
            "type":"number",
            "description":"The cash amount that is available in the cash drawer at the closing of the cashier session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BegBalanceAmount":{
            "type":"number",
            "description":"The cash amount that is available in the cash drawer at the beginning of the cashier session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The currency code of coins and bills in the cash drawer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DrawerId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the cash drawer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalRecord":{
            "type":"number",
            "description":"The total actual payment amount collected for the cash drawer session.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SessionStatus":{
            "maxLength":"10",
            "type":"string",
            "description":"The status of the cashier session, which can be opened, suspended or closed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SessionId":{
            "maxLength":"50",
            "type":"string",
            "description":"The unique identifier for the cashier session.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReconcileStatus":{
            "maxLength":"15",
            "type":"string",
            "description":"The status of the reconciliation, which is Reconciled or Unreconciled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalActual":{
            "type":"number",
            "description":"The total recorded payment amount collected for the cash drawer session.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top