Jump to

• Request
• Response

Create a cash drawer

post

/fscmRestApi/resources/11.13.18.05/publicSectorCashDrawers

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

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The identifier for the agency that receives incoming customer payments.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  Maximum Length: 3

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

  Maximum Length: 100

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

  Maximum Length: 30

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

  Maximum Length: 3

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

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

  Maximum Length: 64

  The user who last updated the cash drawer.
• links(optional): array Items
  Title: Items

  Link Relations
• MultipleSessionFlag(optional): string
  Title: Cash Reconciliation

  Maximum Length: 3

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

  The amount of the acceptable cash shortage.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the agency that receives incoming customer payments."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the cash drawer was created.",
            "title":"Creation Date"
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code of coins and bills in the cash drawer.",
            "title":"Currency"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the cash drawer.",
            "title":"Description"
        },
        "DrawerId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the cash drawer.",
            "title":"Cash Drawer ID"
        },
        "EnabledFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the cash drawer is available to be used.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the cash drawer  was updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the cash drawer.",
            "title":"Last Updated By"
        },
        "MultipleSessionFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the cash drawer can be used in more than one session.",
            "title":"Cash Reconciliation"
        },
        "ToleranceAmount":{
            "format":"float",
            "type":"number",
            "description":"The amount of the acceptable cash shortage.",
            "title":"Tolerance Amount"
        },
        "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 : publicSectorCashDrawers-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  The identifier for the agency that receives incoming customer payments.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  Maximum Length: 3

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

  Maximum Length: 100

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

  Maximum Length: 30

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

  Maximum Length: 3

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

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

  Maximum Length: 64

  The user who last updated the cash drawer.
• links(optional): array Items
  Title: Items

  Link Relations
• MultipleSessionFlag(optional): string
  Title: Cash Reconciliation

  Maximum Length: 3

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

  The amount of the acceptable cash shortage.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the agency that receives incoming customer payments."
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the agency.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the cash drawer was created.",
            "title":"Creation Date"
        },
        "CurrencyCode":{
            "maxLength":3,
            "type":"string",
            "description":"The currency code of coins and bills in the cash drawer.",
            "title":"Currency"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the cash drawer.",
            "title":"Description"
        },
        "DrawerId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the cash drawer.",
            "title":"Cash Drawer ID"
        },
        "EnabledFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the cash drawer is available to be used.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last date and time that the cash drawer  was updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the cash drawer.",
            "title":"Last Updated By"
        },
        "MultipleSessionFlag":{
            "maxLength":3,
            "type":"string",
            "description":"Indicates whether the cash drawer can be used in more than one session.",
            "title":"Cash Reconciliation"
        },
        "ToleranceAmount":{
            "format":"float",
            "type":"number",
            "description":"The amount of the acceptable cash shortage.",
            "title":"Tolerance Amount"
        },
        "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