Oracle Hospitality Cruise Property Management REST API 23.2.2

Create new financial posting entry

post

/spms/v2/ships/{shipId}/financials/folios

Request

Supported Media Types

application/json

Path Parameters

shipId(required): number(12345678)

Ship ID

Required to create posting

Root Schema : CreatePostingRequest

Match All

Show Source

object CreatePosting

Title: CreatePosting

{
    "allOf":[
        {
            "$ref":"#/definitions/CreatePosting"
        }
    ]
}

Nested Schema : CreatePosting

Type: object

Title: CreatePosting

Show Source

itemDetails: object ItemDetails

Title: ItemDetails
postingComment: string

Maximum Length: 40

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

posting comment

Example: comment 1
postingType(required): string

Posting type. POSTING- for generic type

Example: POSTING

{
    "title":"CreatePosting",
    "type":"object",
    "properties":{
        "postingType":{
            "type":"string",
            "description":"Posting type. POSTING- for generic type",
            "example":"POSTING"
        },
        "postingComment":{
            "type":"string",
            "description":"posting comment",
            "maxLength":"40",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=<>|^'\":;@`]*$",
            "example":"comment 1"
        },
        "itemDetails":{
            "type":"object",
            "$ref":"#/definitions/ItemDetails"
        }
    },
    "required":[
        "postingType"
    ]
}

Nested Schema : ItemDetails

Type: object

Title: ItemDetails

Show Source

buyerId(required): integer

Buyer Id

Example: 3118243
checkServer1: string

Maximum Length: 12

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

Check server #1

Example: server 1
checkServer2: string

Maximum Length: 12

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

Check server #2

Example: server 2
isSkipCreditLimitCheck: boolean

Skip credit limit checking

Example: false
items: array items
numberOfGuest: integer

Number of guest

Example: 2
posCheckNumber: string

Maximum Length: 20

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

Posting check number

Example: A123

{
    "title":"ItemDetails",
    "type":"object",
    "properties":{
        "posCheckNumber":{
            "type":"string",
            "description":"Posting check number",
            "maxLength":"20",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=<>|^'\":;@`]*$",
            "example":"A123"
        },
        "numberOfGuest":{
            "type":"integer",
            "description":"Number of guest",
            "example":"2"
        },
        "isSkipCreditLimitCheck":{
            "type":"boolean",
            "description":"Skip credit limit checking",
            "example":false
        },
        "checkServer1":{
            "type":"string",
            "description":"Check server #1",
            "maxLength":"12",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=<>|^'\":;@`]*$",
            "example":"server 1"
        },
        "checkServer2":{
            "type":"string",
            "description":"Check server #2",
            "maxLength":"12",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=<>|^'\":;@`]*$",
            "example":"server 2"
        },
        "buyerId":{
            "type":"integer",
            "description":"Buyer Id",
            "example":"3118243"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Items"
            },
            "example":[
                {
                    "subDepartmentCode":"1001",
                    "totalAmount":"100",
                    "invoiceWindowNumber":"1",
                    "isPostToPreviousCruise":false
                },
                {
                    "subDepartmentCode":"1002",
                    "totalAmount":"20",
                    "invoiceWindowNumber":"2",
                    "isPostToPreviousCruise":false
                }
            ]
        }
    },
    "required":[
        "buyerId"
    ]
}

Nested Schema : items

Type: array

Show Source

Array of: object Items

Title: Items

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Items"
    },
    "example":[
        {
            "subDepartmentCode":"1001",
            "totalAmount":"100",
            "invoiceWindowNumber":"1",
            "isPostToPreviousCruise":false
        },
        {
            "subDepartmentCode":"1002",
            "totalAmount":"20",
            "invoiceWindowNumber":"2",
            "isPostToPreviousCruise":false
        }
    ]
}

Example:

[
    {
        "subDepartmentCode":"1001",
        "totalAmount":"100",
        "invoiceWindowNumber":"1",
        "isPostToPreviousCruise":false
    },
    {
        "subDepartmentCode":"1002",
        "totalAmount":"20",
        "invoiceWindowNumber":"2",
        "isPostToPreviousCruise":false
    }
]

Nested Schema : Items

Type: object

Title: Items

Show Source

invoiceWindowNumber: number

invoice window number, null or empty or 1 - Invoice window number 1, 2 - Invoice window number 2, 3 - Invoice window number 3, 4 - Invoice window number 4

Example: 1
isPostToPreviousCruise: boolean

Post to previous cruise

Example: false
subDepartmentCode(required): string

Maximum Length: 10

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

Sub department code

Example: 1001
totalAmount(required): number

total amount

Example: 100

{
    "title":"Items",
    "type":"object",
    "properties":{
        "subDepartmentCode":{
            "type":"string",
            "description":"Sub department code",
            "maxLength":"10",
            "pattern":"^[a-zA-ZÀ-ÖØ-öø-࿰-9 _,?/.\\-+*n~!@#$%&{}[]()=<>|^'\":;@`]*$",
            "example":"1001"
        },
        "totalAmount":{
            "type":"number",
            "description":"total amount",
            "example":"100"
        },
        "invoiceWindowNumber":{
            "type":"number",
            "description":"invoice window number, null or empty or 1 - Invoice window number 1, 2 - Invoice window number 2, 3 - Invoice window number 3, 4 - Invoice window number 4",
            "example":"1"
        },
        "isPostToPreviousCruise":{
            "type":"boolean",
            "description":"Post to previous cruise",
            "example":false
        }
    },
    "required":[
        "subDepartmentCode",
        "totalAmount"
    ]
}

Response

Supported Media Types

application/json

201 Response

Created

Root Schema : CreatePostingResponse

Type: object

Show Source

opiStatus:

Responded error message from OPI ClearText field for not success transaction. If null means transaction succesfully

Example: Issuer or switch inoperative(01)

{
    "properties":{
        "opiStatus":{
            "description":"Responded error message from OPI ClearText field for not success transaction. If null means transaction succesfully",
            "example":"Issuer or switch inoperative(01)"
        }
    }
}

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/FinancialPostingErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Bad Request",
        "detail":"Department ID 1 is not found"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Bad Request",
    "detail":"Department ID 1 is not found"
}

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/FinancialPostingErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
        "title":"Unauthorised",
        "detail":"Valid token is required to access this resource"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2",
    "title":"Unauthorised",
    "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/FinancialPostingErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
        "title":"Forbidden",
        "detail":"Access to this resource was forbidden"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4",
    "title":"Forbidden",
    "detail":"Access to this resource was 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"
        }
    }
}

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/FinancialPostingErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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/FinancialPostingErrorResponse"
        }
    ],
    "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"
        }
    }
}

415 Response

Unsupported Media Type

Root Schema : schema

Match All

Show Source

object Error Response

Title: Error Response

Error Response returned when encountered error

{
    "allOf":[
        {
            "$ref":"#/definitions/FinancialPostingErrorResponse"
        }
    ],
    "example":{
        "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
        "title":"Invalid content",
        "detail":"Content type Not supported"
    }
}

Example:

{
    "type":"HTTP://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16",
    "title":"Invalid content",
    "detail":"Content type Not supported"
}

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/FinancialPostingErrorResponse"
        }
    ],
    "example":{
        "type":"https://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":"https://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/FinancialPostingErrorResponse"
        }
    ],
    "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"
        }
    }
}