Jump to

• Request
• Response

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: number
  ship Id
• subDepartmentCode: string
  Sub Department Code

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Configured Sub Department

Type: object

Title: Configured Sub Department

Configured Sub Department Record

Show Source

• creditCardOtherDetails(optional): 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(optional): object Department Grouping
  Title: Department Grouping

  Department Grouping
• departmentRouting(optional): boolean
  Title: Department for Routing

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

  Example: true
• departmentSecurityLevel(optional): object Department Security Level
  Title: Department Security Level

  Department Security Level
• departmentType(optional): string
  Title: Department Type

  Default Value: Debit

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

  Department type. Always equal to Debit

  Example: Debit
• glSystemOrigin(optional): object GL System Origin
  Title: GL System Origin

  GL System Origin
• isActive(optional): boolean
  Activation status of the user group: * `true` - User group is active * `false` - User group is inactive

  Example: true
• lastModifiedDate(optional): string
  Last modified date

  Example: 2022-09-21 17:00:00
• mainDepartmentCode(optional): string
  Maximum Length: 10

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

  Main Department Code

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

  Main Department Description

  Example: Food and Beverage
• microsCabinChargeOnly(optional): object Micros Cabin Charge Only
  Title: Micros Cabin Charge Only

  Micros Cabin Charge Only
• nonRefundableCredit(optional): object Non-Refundable Credit
  Title: Non-Refundable Credit

  Non-Refundable Credit
• paymentType(optional): string
  Title: Payment Type

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

  Payment Type

  Example: CC Credit Card
• paymentTypeDetails(optional): object Payment Type Details
  Title: Payment Type Details

  Payment Type Details
• payrollPayoutTagSignature(optional): string
  Tag Signature Capture required during payroll payout * Yes * No * Not Specified

  Example: Yes
• posPaymentTypeSubsystem(optional): object Payment Type in POS Subsystem
  Title: Payment Type in POS Subsystem

  Payment Type in POS Subsystem
• subDepartmentCode(optional): string
  Maximum Length: 10

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

  Sub Department Code

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

  Sub Department Description

  Example: Sports Bar - Food
• subDepartmentOtherDescription(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Sub department other description

  Example: Tiket Perlayaran

{
    "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/departmentType"
        },
        "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/isActive"
        },
        "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(optional): string
  Title: Credit Card Disclaimer

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

  Credit card disclaimer note for signature capture

  Example: <Overwrite and Input Credit Card Disclaimer Note Here>
• paymentDepartmentType(optional): string
  Title: Payment Department Type

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

  Department grouping code

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

  Department grouping description

  Example: Group One

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

  Security Level

  Example: Debit 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(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  GL control account

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

  GL department

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

  GL material

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

  GL mpmissue

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

  GL origin

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

  GL spare

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

  GL sub account

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

  GL 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(optional): boolean
  Title: Allow Posting to Crew Cabin

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

  Example: true
• allowGiftCardPost(optional): boolean
  Title: Allow Posting to Gift Card

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

  Example: true
• allowGuestCabinPost(optional): 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(optional): integer
  Pattern: ^[0-9]*$

  Apply count

  Example: 1
• applyValue(optional): integer
  Pattern: ^[0-9]*$

  Apply value

  Example: 1
• eligibleDepartments(optional): array eligibleDepartments
  Eligible Departments
• redirectionAccount(optional): object redirectionAccount
  Redirection Account
• resetCountPeriod(optional): string
  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-9 _,?/.\-+*n~!@#$%&{}[]()=<>|^'":;@`]*$

  Reset count period

  Example: Day

{
    "title":"Non-Refundable Credit",
    "description":"Non-Refundable Credit",
    "type":"object",
    "properties":{
        "eligibleDepartments":{
            "$ref":"#/definitions/eligibleDepartments"
        },
        "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(optional): boolean
  Title: Auto Balance

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

  Example: true
• commissionDepartment(optional): object Commission Department
  Title: Commission Department

  Commission Department (Note: only debit department code is displayed)
• commissionRate(optional): integer
  Title: Commission Rate

  Pattern: ^[0-9]*$

  Payment Charge Commission

  Example: 5
• commissionValue(optional): boolean
  Title: Commission Value

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

  Example: true
• creditCardDigits(optional): string
  Title: Credit Card Digits

  Pattern: ^[a-zA-ZÀ-ÖØ-öø-ÿ0-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(optional): string
  Title: Credit Card ID

  Maximum Length: 2

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

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

  Example: AX
• creditCardInternalId(optional): string
  Title: Credit Card Internal ID

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

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

  Example: V Visa
• creditCardMerchantNumber(optional): string
  Title: Credit Card Merchant Number

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

  Credit Card Merchant Number

  Example: 9593091390
• creditCardMinLength(optional): integer
  Title: Credit Card Minimum Length

  Pattern: ^[0-9]*$

  Credit Card Minimum Length

  Example: 1
• crewFloorLimit(optional): integer
  Title: Crew Floor Limit

  Pattern: ^[0-9]*$

  Credit Limit for Crew

  Example: 10000
• crewMinAuthValue(optional): 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(optional): integer
  Title: Daily Limit

  Pattern: ^[0-9]*$

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

  Example: 10000
• debitCardNoCommissionCharge(optional): boolean
  Title: Debit Card No Commission Charge

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

  Example: true
• floorLimit(optional): integer
  Title: Floor Limit

  Pattern: ^[0-9]*$

  Payment limit maximum payment accepted

  Example: 10000
• foreignCurrencyCode(optional): string
  Title: Foreign Currency Code

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

  International currency description (when defining Foreign Currency)

  Example: EUR
• minAuthValue(optional): integer
  Title: Minimum Authorized Value

  Pattern: ^[0-9]*$

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

  Example: 1
• paymentAllowForSpecifiedCard(optional): 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(optional): string
  Title: External Department ID

  Pattern: ^[0-9]*$

  External Department ID

  Example: 9040
• externalItemizerId(optional): string
  Title: External Itemizer ID

  Maximum Length: 3

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

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

  Example: 001
• incentivesPayoutGroup(optional): string
  Title: Incentives Payout Group

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

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

  Example: Cash - Micros 50% (50%)
• posTenderTypeNumber(optional): integer
  Title: POS Tender Type Number

  Pattern: ^[0-9]*$

  POS Tender Type number in POS sub system

  Example: 10
• systemAccountNumber(optional): integer
  Pattern: ^[0-9]*$

  System account number

  Example: 20312

{
    "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 : 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 : redirectionAccount

Type: object

Redirection Account

Show Source

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

  System account description

  Example: Prepaid Wedding Package
• systemAccountNumber(optional): integer
  Pattern: ^[0-9]*$

  System account number

  Example: 20312

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

Nested Schema : items

Type: object

Show Source

• mainDepartmentCode(optional): string
  Maximum Length: 10

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

  Main Department Code

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

  Main Department Description

  Example: Food and Beverage
• subDepartments(optional): 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(optional): string
  Maximum Length: 10

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

  Sub Department Code

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

  Sub Department Description

  Example: Sports Bar - Food

{
    "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(optional): string
  Maximum Length: 10

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

  Sub Department Code

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

  Sub Department Description

  Example: Sports Bar - Food

{
    "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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): 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

Body ()

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(optional): string
• title(optional): string
• type(optional): string

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

Back to Top