Jump to

• Request
• Response
• Examples

Get the service charge collection

get

/api/v1/serviceCharges/collection

{basePath}/serviceCharges/collection?orgShortName=tfoinc&locRef=fdmnh144&rvcRef=42

The service charge collection is a list of service charges that can be used when interacting with the checks endpoint. The API returns a collection of service charges that can be used at the specified revenue center.

Request

Supported Media Types

• application/json

Query Parameters

• locRef(required): string
  The location identifier.
• orgShortName(required): string
  The organization identifier.
• rvcRef(required): integer
  The revenue center identifier.

Header Parameters

• If-Modified-Since: string
  Standard http caching header (http caching link).
• If-None-Match: string
  Standard http caching header (http caching link).

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of service charges

Headers

• ETag: string
  The current entity-tag for the selected representation. See RFC 7232 Section 2.3
• Last-Modified: string
  A timestamp indicating the date and time at which the origin server believes the selected representation was last modified. See RFC 7232 Section 2.2

Body ()

Root Schema : ServiceChargeCollection

Type: object

Definition of a service chargeount that can be applied to a transaction.

Show Source

• items: array items
• OrgLocRvcProperties: object OrgLocRvcProperties
  A collection of properties for orgShortName, locRef and rvcRef

{
    "description":"Definition of a service chargeount that can be applied to a transaction.\n",
    "type":"object",
    "properties":{
        "OrgLocRvcProperties":{
            "$ref":"#/definitions/OrgLocRvcProperties"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ServiceChargeItem"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ServiceChargeItem
  Definition of a service charge that can be applied to a transaction.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ServiceChargeItem"
    }
}

Nested Schema : OrgLocRvcProperties

Type: object

A collection of properties for orgShortName, locRef and rvcRef

Show Source

• locRef(required): string
  Location identifier

  Example: store66
• orgShortName(required): string
  Organization identifier

  Example: mymeal
• rvcRef(required): integer
  Revenue Center identifier

  Example: 2

{
    "description":"A collection of properties for orgShortName, locRef and rvcRef\n",
    "type":"object",
    "required":[
        "orgShortName",
        "locRef",
        "rvcRef"
    ],
    "properties":{
        "orgShortName":{
            "description":"Organization identifier",
            "type":"string",
            "example":"mymeal"
        },
        "locRef":{
            "description":"Location identifier",
            "type":"string",
            "example":"store66"
        },
        "rvcRef":{
            "description":"Revenue Center identifier",
            "type":"integer",
            "example":"2"
        }
    }
}

Nested Schema : ServiceChargeItem

Type: object

Definition of a service charge that can be applied to a transaction.

Show Source

• ConsumerContentProperties: object ConsumerContentProperties
  A collection of consumer based content
• extensions: object ExtensionData
  Additional Properties Allowed: additionalProperties

  Container for extension data
• name: string
  Service Charge Name
• serviceChargeId(required): integer
  Service Charge Identifier
• type(required): string
  Allowed Values: [ "amount", "percentage" ]

  Service Charge Type

  Example: amount
• value: number
  The amount or percentage of the service charge. If value is not present or is zero, then the value must be provided when the service charge is added to a check.

  Example: 5

{
    "description":"Definition of a service charge that can be applied to a transaction.\n",
    "type":"object",
    "required":[
        "serviceChargeId",
        "type"
    ],
    "properties":{
        "serviceChargeId":{
            "description":"Service Charge Identifier",
            "type":"integer"
        },
        "name":{
            "description":"Service Charge Name",
            "type":"string"
        },
        "type":{
            "description":"Service Charge Type",
            "type":"string",
            "enum":[
                "amount",
                "percentage"
            ],
            "example":"amount"
        },
        "value":{
            "description":"The amount or percentage of the service charge. If value is not present or is zero, then the value must be provided when the service charge is added to a check.\n",
            "type":"number",
            "example":"5"
        },
        "ConsumerContentProperties":{
            "$ref":"#/definitions/ConsumerContentProperties"
        },
        "extensions":{
            "$ref":"#/definitions/ExtensionData"
        }
    }
}

Nested Schema : ConsumerContentProperties

Type: object

A collection of consumer based content

Show Source

• consumerDescription: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• consumerName: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`
• images: array images
  Array of images.

{
    "description":"A collection of consumer based content\n",
    "type":"object",
    "properties":{
        "consumerName":{
            "$ref":"#/definitions/TranslatedString"
        },
        "consumerDescription":{
            "$ref":"#/definitions/TranslatedString"
        },
        "images":{
            "description":"Array of images.\n",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ImageLink"
            }
        }
    }
}

Nested Schema : ExtensionData

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "description":"Container for extension data",
    "additionalProperties":{
        "type":"object"
    }
}

Container for extension data

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\nExample:n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\"}`\n",
    "type":"object",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages Example:n`{ "en-US": "coffee", "de-DE": "kaffee"}`

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee"
}

Nested Schema : images

Type: array

Array of images.

Show Source

• Array of: object ImageLink
  Represents a link to an image

{
    "description":"Array of images.\n",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ImageLink"
    }
}

Nested Schema : ImageLink

Type: object

Represents a link to an image

Show Source

• altText: string
  Alt text for the image

  Example: pizza
• description: string
  Description text for the image
• index: string
  Unique identifier for the image
• isCloudImage: boolean
• size: string
  Image size
• url(required): string
  URL for the image.

  Example: https://oracleObjectStore.com/images/coffee822815.jpg

{
    "description":"Represents a link to an image",
    "type":"object",
    "required":[
        "url",
        "tags"
    ],
    "properties":{
        "index":{
            "description":"Unique identifier for the image",
            "type":"string"
        },
        "url":{
            "description":"URL for the image.\n",
            "type":"string",
            "example":"https://oracleObjectStore.com/images/coffee822815.jpg"
        },
        "altText":{
            "description":"Alt text for the image",
            "type":"string",
            "example":"pizza"
        },
        "description":{
            "description":"Description text for the image",
            "type":"string"
        },
        "isCloudImage":{
            "type":"boolean"
        },
        "size":{
            "description":"Image size",
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: object

304 Response

304 Not Modified

400 Response

400 Bad Request

Body ()

Root Schema : ConfigurationApiProblemDetails

Type: object

Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). The content type for this response is `application/problem+json`

Show Source

• details: string
  A human-readable explanation specific to this occurrence of the problem.

  Example: The OrgShortName value is required.
• instance: string
  A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

  Example: required_value_missing
• title: string
  A short, human-readable summary of the problem type.

  Example: Required value not specified.
• type: string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: error:validation

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807).\n\nThe content type for this response is `application/problem+json`\n",
    "type":"object",
    "example":{
        "type":"error:validation",
        "title":"Required value not specified.",
        "details":"The OrgShortName value is required.",
        "instance":"required_value_missing"
    },
    "properties":{
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".\n",
            "type":"string",
            "example":"error:validation"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.\n",
            "type":"string",
            "example":"Required value not specified.\n"
        },
        "details":{
            "description":"A human-readable explanation specific to this occurrence of the problem.\n",
            "type":"string",
            "example":"The OrgShortName value is required.\n"
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.\n",
            "type":"string",
            "example":"required_value_missing"
        }
    }
}

Example:

{
    "type":"error:validation",
    "title":"Required value not specified.",
    "details":"The OrgShortName value is required.",
    "instance":"required_value_missing"
}

404 Response

404 Requested resource not found

Back to Top

Examples

Example Request Body

Not applicable for this endpoint.

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "orgShortName": "mymeal",
  "locRef": "store66",
  "rvcRef": 2,
  "items": [
    {
      "serviceChargeId": 0,
      "name": "string",
      "type": "amount",
      "value": 5,
      "consumerName": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "consumerDescription": {
        "en-US": "Coffee",
        "de-DE": "Kaffee",
        "ar-AR": "قهوة"
      },
      "images": [
        {
          "index": "string",
          "url": "https://oracleObjectStore.com/images/coffee822815.jpg",
          "altText": "pizza",
          "description": "string",
          "isCloudImage": true,
          "size": "string"
        }
      ],
      "extensions": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ]
}

Back to Top