Oracle Hospitality Cruise Property Management REST API 23.3.0

Retrieve configured sub department record.

get

/spms/v2/ships/{shipId}/configurations/financialSubDepartments/credit/{subDepartmentCode}

This is to retrieve the configured sub department codes.

Request

Supported Media Types

application/json

Path Parameters

shipId(required): number

ship Id
subDepartmentCode(required): string

Sub Department Code

Response

Supported Media Types

application/json

200 Response

Root Schema : Configured Sub Department

Type: object

Title: Configured Sub Department

Configured Sub Department Record

Show Source

creditCardOtherDetails: object Credit Card Other Details

Title: Credit Card Other Details

Credit Card Other Details. Note: only appear if the sub dept code is configured with payment type = CC Credit Card
departmentGrouping: object Department Grouping

Title: Department Grouping

Department Grouping
departmentRouting: boolean

Title: Department for Routing

Add a column for credit department for routing purposes * `true` - Checked * `false` - Unchecked

Example: true
departmentSecurityLevel: object Department Security Level

Title: Department Security Level

Department Security Level
departmentType: string

Title: Department Type

Default Value: Credit

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Department type. Always equal to Credit

Example: Credit
glSystemOrigin: object GL System Origin

Title: GL System Origin

GL System Origin
isActive: boolean

Activation status of the sub department: * `true` - Sub Department is active * `false` - Sub Department is inactive

Example: true
lastModifiedDate: string

Title: Last Modified Date

Last Modified Date

Example: 2022-09-21 17:00:00
mainDepartmentCode: string

Title: Main Department Code

Maximum Length: 10

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Main Department Code

Example: 1001
mainDepartmentDescription: string

Title: Main Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Main Department Description

Example: Food and Beverage
microsCabinChargeOnly: object Micros Cabin Charge Only

Title: Micros Cabin Charge Only

Micros Cabin Charge Only
nonRefundableCredit: object Non-Refundable Credit

Title: Non-Refundable Credit

Non-Refundable Credit
paymentType: string

Title: Payment Type

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Payment Type

Example: CC Credit Card
paymentTypeDetails: object Payment Type Details

Title: Payment Type Details

Payment Type Details
payrollPayoutTagSignature: string

Title: Tag Signature for Payroll Payout

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Tag Signature Capture required during payroll payout * Yes * No * Not Specified

Example: Yes
posPaymentTypeSubsystem: object Payment Type in POS Subsystem

Title: Payment Type in POS Subsystem

Payment Type in POS Subsystem
subDepartmentCode: string

Title: Sub Department Code

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Code

Example: 9041
subDepartmentDescription: string

Title: Sub Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Description

Example: Visa Card
subDepartmentOtherDescription: string

Title: Sub Department Other Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Other Description

Example: Kad Visa

{
    "title":"Configured Sub Department",
    "description":"Configured Sub Department Record",
    "type":"object",
    "properties":{
        "mainDepartmentCode":{
            "$ref":"#/definitions/mainDepartmentCode"
        },
        "mainDepartmentDescription":{
            "$ref":"#/definitions/mainDepartmentDescription"
        },
        "paymentType":{
            "$ref":"#/definitions/paymentType"
        },
        "subDepartmentCode":{
            "$ref":"#/definitions/subDepartmentCode"
        },
        "departmentType":{
            "$ref":"#/definitions/departmentTypeCR"
        },
        "subDepartmentDescription":{
            "$ref":"#/definitions/subDepartmentDescription"
        },
        "subDepartmentOtherDescription":{
            "$ref":"#/definitions/subDepartmentOtherDescription"
        },
        "departmentGrouping":{
            "$ref":"#/definitions/departmentGrouping"
        },
        "payrollPayoutTagSignature":{
            "$ref":"#/definitions/payrollPayoutTagSignature"
        },
        "departmentSecurityLevel":{
            "$ref":"#/definitions/departmentSecurityLevel"
        },
        "nonRefundableCredit":{
            "$ref":"#/definitions/nonRefundableCredit"
        },
        "glSystemOrigin":{
            "$ref":"#/definitions/glSystemOrigin"
        },
        "lastModifiedDate":{
            "$ref":"#/definitions/lastModifiedDate"
        },
        "isActive":{
            "$ref":"#/definitions/subDepartmentIsActive"
        },
        "paymentTypeDetails":{
            "$ref":"#/definitions/paymentTypeDetails"
        },
        "posPaymentTypeSubsystem":{
            "$ref":"#/definitions/posPaymentTypeSubsystem"
        },
        "microsCabinChargeOnly":{
            "$ref":"#/definitions/microsCabinChargeOnly"
        },
        "creditCardOtherDetails":{
            "$ref":"#/definitions/creditCardOtherDetails"
        },
        "departmentRouting":{
            "$ref":"#/definitions/departmentRouting"
        }
    }
}

Nested Schema : Credit Card Other Details

Type: object

Title: Credit Card Other Details

Credit Card Other Details. Note: only appear if the sub dept code is configured with payment type = CC Credit Card

Show Source

creditCardDisclaimerNote: string

Title: Credit Card Disclaimer

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Credit card disclaimer note for signature capture

Example: <Overwrite and Input Credit Card Disclaimer Note Here>
paymentDepartmentType: string

Title: Payment Department Type

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Identify whether the department is used for: * Both Debit and Credit Card * Only Credit Card * Only Debit Card

Example: Both Debit and Credit Card

{
    "title":"Credit Card Other Details",
    "description":"Credit Card Other Details. Note: only appear if the sub dept code is configured with payment type = CC Credit Card",
    "type":"object",
    "properties":{
        "creditCardDisclaimerNote":{
            "$ref":"#/definitions/creditCardDisclaimerNote"
        },
        "paymentDepartmentType":{
            "$ref":"#/definitions/paymentDepartmentType"
        }
    }
}

Nested Schema : Department Grouping

Type: object

Title: Department Grouping

Department Grouping

Show Source

departmentGroupingCode: string

Title: Department Grouping Code

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Department Grouping Code

Example: PYT01
departmentGroupingDescription: string

Title: Department Grouping Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Department Grouping Description

Example: Payment Group 1

{
    "title":"Department Grouping",
    "description":"Department Grouping",
    "type":"object",
    "properties":{
        "departmentGroupingCode":{
            "$ref":"#/definitions/departmentGroupingCode"
        },
        "departmentGroupingDescription":{
            "$ref":"#/definitions/departmentGroupingDescription"
        }
    }
}

Nested Schema : Department Security Level

Type: object

Title: Department Security Level

Department Security Level

Show Source

securityLevel: string

Title: Security Level

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Security Level

Example: Credit Department Level 1

{
    "title":"Department Security Level",
    "description":"Department Security Level",
    "type":"object",
    "properties":{
        "securityLevel":{
            "$ref":"#/definitions/securityLevel"
        }
    }
}

Nested Schema : GL System Origin

Type: object

Title: GL System Origin

GL System Origin

Show Source

glControlAccount: string

Title: General Ledger Control Account

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Control Account

Example: abc1234
glDepartment: string

Title: General Ledger Department

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Department

Example: abc1234
glMaterial: string

Title: General Ledger Material

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Material

Example: abc1234
glMpmissue: string

Title: General Ledger Mpmissue

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Mpmissue

Example: abc1234
glOrigin: string

Title: General Ledger Origin

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Origin

Example: abc1234
glSpare: string

Title: General Ledger Spare

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Spare

Example: abc1234
glSubAccount: string

Title: General Ledger Sub Account

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Sub Account

Example: abc1234
glVoyage: string

Title: General Ledger Voyage

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

General Ledger Voyage

Example: abc1234

{
    "title":"GL System Origin",
    "description":"GL System Origin",
    "type":"object",
    "properties":{
        "glOrigin":{
            "$ref":"#/definitions/glOrigin"
        },
        "glDepartment":{
            "$ref":"#/definitions/glDepartment"
        },
        "glControlAccount":{
            "$ref":"#/definitions/glControlAccount"
        },
        "glSubAccount":{
            "$ref":"#/definitions/glSubAccount"
        },
        "glMaterial":{
            "$ref":"#/definitions/glMaterial"
        },
        "glMpmissue":{
            "$ref":"#/definitions/glMpmissue"
        },
        "glVoyage":{
            "$ref":"#/definitions/glVoyage"
        },
        "glSpare":{
            "$ref":"#/definitions/glSpare"
        }
    }
}

Nested Schema : Micros Cabin Charge Only

Type: object

Title: Micros Cabin Charge Only

Micros Cabin Charge Only

Show Source

allowCrewCabinPost: boolean

Title: Allow Posting to Crew Cabin

MICROS Cabin Charge only allowed for Crew * `true` - Allowed * `false` - Disallowed

Example: true
allowGiftCardPost: boolean

Title: Allow Posting to Gift Card

MICROS Cabin Charge only allowed for Gift Card * `true` - Allowed * `false` - Disallowed

Example: true
allowGuestCabinPost: boolean

Title: Allow Posting to Guest Cabin

MICROS Cabin Charge only allowed for Passenger * `true` - Allowed * `false` - Disallowed

Example: true

{
    "title":"Micros Cabin Charge Only",
    "description":"Micros Cabin Charge Only",
    "type":"object",
    "properties":{
        "allowGuestCabinPost":{
            "$ref":"#/definitions/allowGuestCabinPost"
        },
        "allowCrewCabinPost":{
            "$ref":"#/definitions/allowCrewCabinPost"
        },
        "allowGiftCardPost":{
            "$ref":"#/definitions/allowGiftCardPost"
        }
    }
}

Nested Schema : Non-Refundable Credit

Type: object

Title: Non-Refundable Credit

Non-Refundable Credit

Show Source

applyCount: integer

Title: Apply Count

Pattern: ^[0-9]*$

Apply Count

Example: 1
applyValue: integer

Title: Apply Value

Pattern: ^[0-9]*$

Apply Value

Example: 1
collectorDepartment: object Collector Department

Title: Collector Department

Collector Department. Note: only credit department code will be displayed
eligibleDepartments: array eligibleDepartments

Eligible Departments
redirectionAccount: object Redirection Account

Title: Redirection Account

Redirection Account
resetCountPeriod: string

Title: Reset Count Period

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Reset Count Period

Example: Day

{
    "title":"Non-Refundable Credit",
    "description":"Non-Refundable Credit",
    "type":"object",
    "properties":{
        "eligibleDepartments":{
            "$ref":"#/definitions/eligibleDepartments"
        },
        "collectorDepartment":{
            "$ref":"#/definitions/collectorDepartment"
        },
        "resetCountPeriod":{
            "$ref":"#/definitions/resetCountPeriod"
        },
        "redirectionAccount":{
            "$ref":"#/definitions/redirectionAccount"
        },
        "applyCount":{
            "$ref":"#/definitions/applyCount"
        },
        "applyValue":{
            "$ref":"#/definitions/applyValue"
        }
    }
}

Nested Schema : Payment Type Details

Type: object

Title: Payment Type Details

Payment Type Details

Show Source

autoBalance: boolean

Title: Auto Balance

Auto Balance option for cash & credit card posting via Interface: * `true` - Checked * `false` - Unchecked

Example: true
commissionDepartment: object Commission Department

Title: Commission Department

Commission Department (Note: only debit department code is displayed)
commissionRate: integer

Title: Commission Rate

Pattern: ^[0-9]*$

Payment Charge Commission

Example: 5
commissionValue: boolean

Title: Commission Value

Payment Charge Commission is: * `true` - by Fix Value * `false` - by Percentage

Example: true
creditCardDigits: string

Title: Credit Card Digits

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Credit Card definition digits pattern set of first digits defining card separated with comma

Example: -40-,-41-,-42-,-43-,-44-,-45-,-46-,-47-,-48-,-49-
creditCardId: string

Title: Credit Card ID

Maximum Length: 2

Pattern: ^[-zA-Z]{2}$

Credit Card ID (VI-Visa, MC-Master,AX-Amex,...)

Example: AX
creditCardInternalId: string

Title: Credit Card Internal ID

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Credit card internal ID in stratus (interface) related columns (V-Visa, A-Amex, M-Master,...)

Example: V Visa
creditCardMerchantNumber: string

Title: Credit Card Merchant Number

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Credit Card Merchant Number

Example: 9593091390
creditCardMinLength: integer

Title: Credit Card Minimum Length

Pattern: ^[0-9]*$

Credit Card Minimum Length

Example: 1
crewFloorLimit: integer

Title: Crew Floor Limit

Pattern: ^[0-9]*$

Credit Limit for Crew

Example: 10000
crewMinAuthValue: integer

Title: Crew Minimum Authorized Value

Pattern: ^[0-9]*$

Minimum balance value that can be sent to credit card authorization system for crew

Example: 100
dailyLimit: integer

Title: Daily Limit

Pattern: ^[0-9]*$

Maximum daily spending limit in Casino ( where 0=No Limit)

Example: 10000
debitCardNoCommissionCharge: boolean

Title: Debit Card No Commission Charge

Commission Charge will be charged to: * `true` - Exclude debit card * `false` - All cards

Example: true
floorLimit: integer

Title: Floor Limit

Pattern: ^[0-9]*$

Payment limit maximum payment accepted

Example: 10000
foreignCurrencyCode: string

Title: Foreign Currency Code

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

International currency description (when defining Foreign Currency)

Example: EUR
minAuthValue: integer

Title: Minimum Authorized Value

Pattern: ^[0-9]*$

Minimum balance value that can be sent to credit card authorization system

Example: 1
paymentAllowForSpecifiedCard: integer

Title: Payment Allowed For Specified Card

Pattern: ^(012)$

Payment Allowed For Specified Card: * `0` - No * `1` - Reward Card * `2` - Gift Card

Example: 1

{
    "title":"Payment Type Details",
    "description":"Payment Type Details",
    "type":"object",
    "properties":{
        "creditCardDigits":{
            "$ref":"#/definitions/creditCardDigits"
        },
        "creditCardId":{
            "$ref":"#/definitions/creditCardId"
        },
        "creditCardInternalId":{
            "$ref":"#/definitions/creditCardInternalId"
        },
        "creditCardMerchantNumber":{
            "$ref":"#/definitions/creditCardMerchantNumber"
        },
        "creditCardMinLength":{
            "$ref":"#/definitions/creditCardMinLength"
        },
        "foreignCurrencyCode":{
            "$ref":"#/definitions/foreignCurrencyCode"
        },
        "floorLimit":{
            "$ref":"#/definitions/floorLimit"
        },
        "crewFloorLimit":{
            "$ref":"#/definitions/crewFloorLimit"
        },
        "minAuthValue":{
            "$ref":"#/definitions/minAuthValue"
        },
        "crewMinAuthValue":{
            "$ref":"#/definitions/crewMinAuthValue"
        },
        "commissionDepartment":{
            "$ref":"#/definitions/commissionDepartment"
        },
        "commissionRate":{
            "$ref":"#/definitions/commissionRate"
        },
        "dailyLimit":{
            "$ref":"#/definitions/dailyLimit"
        },
        "debitCardNoCommissionCharge":{
            "$ref":"#/definitions/debitCardNoCommissionCharge"
        },
        "commissionValue":{
            "$ref":"#/definitions/commissionValue"
        },
        "paymentAllowForSpecifiedCard":{
            "$ref":"#/definitions/paymentAllowForSpecifiedCard"
        },
        "autoBalance":{
            "$ref":"#/definitions/autoBalance"
        }
    }
}

Nested Schema : Payment Type in POS Subsystem

Type: object

Title: Payment Type in POS Subsystem

Payment Type in POS Subsystem

Show Source

externalDepartmentId: string

Title: External Department ID

Pattern: ^[0-9]*$

External Department ID

Example: 9040
externalItemizerId: string

Title: External Itemizer ID

Maximum Length: 3

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]{3}$

POS sales itemizer number (Debit department) / External itemizer ID (Credit department)

Example: 001
incentivesPayoutGroup: string

Title: Incentives Payout Group

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Incentives Payout Group (Note: this field will be combination of Incentive name and percentage)

Example: Cash - Micros 50% (50%)
posTenderTypeNumber: integer

Title: POS Tender Type Number

Pattern: ^[0-9]*$

POS Tender Type number in POS sub system

Example: 10
systemAccountNumber: integer

Title: System Account Number

Pattern: ^[0-9]*$

System Account Number

Example: 20310

{
    "title":"Payment Type in POS Subsystem",
    "description":"Payment Type in POS Subsystem",
    "type":"object",
    "properties":{
        "posTenderTypeNumber":{
            "$ref":"#/definitions/posTenderTypeNumber"
        },
        "systemAccountNumber":{
            "$ref":"#/definitions/systemAccountNumber"
        },
        "incentivesPayoutGroup":{
            "$ref":"#/definitions/incentivesPayoutGroup"
        },
        "externalDepartmentId":{
            "$ref":"#/definitions/externalDepartmentId"
        },
        "externalItemizerId":{
            "$ref":"#/definitions/externalItemizerId"
        }
    }
}

Nested Schema : Collector Department

Type: object

Title: Collector Department

Collector Department. Note: only credit department code will be displayed

Show Source

subDepartmentCode: string

Title: Sub Department Code

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Code

Example: 9041
subDepartmentDescription: string

Title: Sub Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Description

Example: Visa Card

{
    "title":"Collector Department",
    "description":"Collector Department. Note: only credit department code will be displayed",
    "type":"object",
    "properties":{
        "subDepartmentCode":{
            "$ref":"#/definitions/subDepartmentCode"
        },
        "subDepartmentDescription":{
            "$ref":"#/definitions/subDepartmentDescription"
        }
    }
}

Nested Schema : eligibleDepartments

Type: array

Eligible Departments

Show Source

Array of: object items

{
    "description":"Eligible Departments",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "mainDepartmentCode":{
                "$ref":"#/definitions/mainDepartmentCode"
            },
            "mainDepartmentDescription":{
                "$ref":"#/definitions/mainDepartmentDescription"
            },
            "subDepartments":{
                "$ref":"#/definitions/subDepartments"
            }
        }
    }
}

Nested Schema : Redirection Account

Type: object

Title: Redirection Account

Redirection Account

Show Source

systemAccountDescription: string

Title: System Account Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

System Account Description

Example: Wedding Dinner Package
systemAccountNumber: integer

Title: System Account Number

Pattern: ^[0-9]*$

System Account Number

Example: 20310

{
    "title":"Redirection Account",
    "description":"Redirection Account",
    "type":"object",
    "properties":{
        "systemAccountNumber":{
            "$ref":"#/definitions/systemAccountNumber"
        },
        "systemAccountDescription":{
            "$ref":"#/definitions/systemAccountDescription"
        }
    }
}

Nested Schema : items

Type: object

Show Source

mainDepartmentCode: string

Title: Main Department Code

Maximum Length: 10

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Main Department Code

Example: 1001
mainDepartmentDescription: string

Title: Main Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Main Department Description

Example: Food and Beverage
subDepartments: array subDepartments

Eligible Sub Departments

{
    "type":"object",
    "properties":{
        "mainDepartmentCode":{
            "$ref":"#/definitions/mainDepartmentCode"
        },
        "mainDepartmentDescription":{
            "$ref":"#/definitions/mainDepartmentDescription"
        },
        "subDepartments":{
            "$ref":"#/definitions/subDepartments"
        }
    }
}

Nested Schema : subDepartments

Type: array

Eligible Sub Departments

Show Source

Array of: object items

{
    "description":"Eligible Sub Departments",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "subDepartmentCode":{
                "$ref":"#/definitions/subDepartmentCode"
            },
            "subDepartmentDescription":{
                "$ref":"#/definitions/subDepartmentDescription"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

subDepartmentCode: string

Title: Sub Department Code

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Code

Example: 9041
subDepartmentDescription: string

Title: Sub Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Description

Example: Visa Card

{
    "type":"object",
    "properties":{
        "subDepartmentCode":{
            "$ref":"#/definitions/subDepartmentCode"
        },
        "subDepartmentDescription":{
            "$ref":"#/definitions/subDepartmentDescription"
        }
    }
}

Nested Schema : Commission Department

Type: object

Title: Commission Department

Commission Department (Note: only debit department code is displayed)

Show Source

subDepartmentCode: string

Title: Sub Department Code

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Code

Example: 9041
subDepartmentDescription: string

Title: Sub Department Description

Pattern: ^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

Sub Department Description

Example: Visa Card

{
    "title":"Commission Department",
    "description":"Commission Department (Note: only debit department code is displayed)",
    "type":"object",
    "properties":{
        "subDepartmentCode":{
            "$ref":"#/definitions/subDepartmentCode"
        },
        "subDepartmentDescription":{
            "$ref":"#/definitions/subDepartmentDescription"
        }
    }
}

400 Response

Bad Request

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentCreditCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
        "title":"Bad Request",
        "detail":"Limit must not be less than one!"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1",
    "title":"Bad Request",
    "detail":"Limit must not be less than one!"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentCreditCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorized",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorized",
    "detail":"Valid token is required to access this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

403 Response

Forbidden

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentCreditCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource is forbidden"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource is forbidden"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentCreditCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
        "title":"Not Found",
        "detail":"This resource path does not exist"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5",
    "title":"Not Found",
    "detail":"This resource path does not exist"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

405 Response

Method Not Allowed

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentCreditCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
        "title":"Method Not Supported",
        "detail":"HTTP method not supported for this resource"
    }
}

Example:

{
    "type":"http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6",
    "title":"Method Not Supported",
    "detail":"HTTP method not supported for this resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

406 Response

Not Acceptable

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentCreditCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
        "title":"Not Acceptable",
        "detail":"Request a Mime type that is supported for this Resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7",
    "title":"Not Acceptable",
    "detail":"Request a Mime type that is supported for this Resource"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentCreditCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
        "title":"Internal Server Error",
        "detail":"Issue fulfilling request. Please retry or contact support"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1",
    "title":"Internal Server Error",
    "detail":"Issue fulfilling request. Please retry or contact support"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/financialSubDepartmentCreditCodeSetupErrorResponse"
        }
    ],
    "example":{
        "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
        "title":"Service Unavailable",
        "detail":"Service Unavailable. Try again later"
    }
}

Example:

{
    "type":"https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4",
    "title":"Service Unavailable",
    "detail":"Service Unavailable. Try again later"
}

Nested Schema : Error Response

Type: object

Title: Error Response

Error Response returned when encountered error

Show Source

detail: string
title: string
type: string

{
    "title":"Error Response",
    "description":"Error Response returned when encountered error",
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        }
    }
}