NOT FOR PUBLIC DISTRIBUTION: 2020-09-23

Jump to

• Request
• Response

Retrieve folio outstanding balance for a reservation

get

/spms/v1/folio/{reservationId}

This is to retrieve folio outstanding balance for a reservation

Request

Supported Media Types

• application/json

Path Parameters

• reservationId: integer

Back to Top

Response

Supported Media Types

• application/json

200 Response

Folio Outstanding Balance

Body ()

Root Schema : folioOutstandingBalance

Type: object

Folio Outstanding Balance

Show Source

• currency(optional): string
  Example: USD
• outstandingBalanceAmount(optional): number
  Example: 260.52
• reservationId(optional): integer
  Example: 222656
• totalSettlementAmount(optional): number
  Example: 25.3
• totalSpendingAmount(optional): number
  Example: 525.3

{
    "description":"Folio Outstanding Balance",
    "type":"object",
    "properties":{
        "reservationId":{
            "type":"integer",
            "example":222656
        },
        "currency":{
            "type":"string",
            "example":"USD"
        },
        "outstandingBalanceAmount":{
            "type":"number",
            "example":260.52
        },
        "totalSpendingAmount":{
            "type":"number",
            "example":525.3
        },
        "totalSettlementAmount":{
            "type":"number",
            "example":25.3
        }
    }
}

204 Response

Folio Outstanding Balance not available

400 Response

Bad Request

401 Response

You are not authorized to use this API

403 Response

You are forbidden to use this API

405 Response

This method is not available

500 Response

Error occured while processing this request

502 Response

Bad Gateway

503 Response

Service not available

Back to Top