Jump to

• Request
• Response

Create a cash drawer

post

/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers

Request

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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The identifier for the agency that receives incoming customer payments.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 3

  The currency code of coins and bills in the cash drawer.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the cash drawer.
• DrawerId: string
  Title: Cash Drawer ID

  Maximum Length: 30

  The unique identifier for the cash drawer.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 3

  Indicates whether the cash drawer is available to be used.
• MultipleSessionFlag: string
  Title: Cash Reconciliation

  Maximum Length: 3

  Indicates whether the cash drawer can be used in more than one session.
• ToleranceAmount: number
  Title: Tolerance Amount

  The amount of the acceptable cash shortage.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"The currency code of coins and bills in the cash drawer.",
            "nullable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the cash drawer.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the agency that receives incoming customer payments.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            }
        },
        "DrawerId":{
            "title":"Cash Drawer ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the cash drawer.",
            "nullable":false
        },
        "ToleranceAmount":{
            "title":"Tolerance Amount",
            "type":"number",
            "description":"The amount of the acceptable cash shortage.",
            "nullable":false
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the cash drawer is available to be used.",
            "nullable":false
        },
        "MultipleSessionFlag":{
            "title":"Cash Reconciliation",
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the cash drawer can be used in more than one session.",
            "nullable":false
        }
    }
}

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 : publicSectorCashDrawers-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The identifier for the agency that receives incoming customer payments.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the agency.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time that the cash drawer was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 3

  The currency code of coins and bills in the cash drawer.
• Description: string
  Title: Description

  Maximum Length: 100

  The description of the cash drawer.
• DrawerId: string
  Title: Cash Drawer ID

  Maximum Length: 30

  The unique identifier for the cash drawer.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 3

  Indicates whether the cash drawer is available to be used.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The last date and time that the cash drawer was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the cash drawer.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MultipleSessionFlag: string
  Title: Cash Reconciliation

  Maximum Length: 3

  Indicates whether the cash drawer can be used in more than one session.
• ToleranceAmount: number
  Title: Tolerance Amount

  The amount of the acceptable cash shortage.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the cash drawer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":3,
            "type":"string",
            "description":"The currency code of coins and bills in the cash drawer.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time that the cash drawer was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the cash drawer.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the agency that receives incoming customer payments.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "DrawerId":{
            "title":"Cash Drawer ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the cash drawer.",
            "nullable":false,
            "x-queryable":true
        },
        "ToleranceAmount":{
            "title":"Tolerance Amount",
            "type":"number",
            "description":"The amount of the acceptable cash shortage.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the cash drawer is available to be used.",
            "nullable":false,
            "x-queryable":true
        },
        "MultipleSessionFlag":{
            "title":"Cash Reconciliation",
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the cash drawer can be used in more than one session.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The last date and time that the cash drawer  was updated.",
            "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."
        }
    }
}

Back to Top