Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Operation

Information of the operation

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.folio


Style
table {
width: 100%;
}
body.page-gadget {
padding-top: 20px;
}
.separator{
margin: 5px 0;
}



Div
style background-color: green; color: white; display: inline-block; padding: 5px; border-radius: 3px;

GET



Div
stylebackground-color: #0a2b1d; padding: 10px 1em; display: inline-block; color: white; border-radius: 3px;

https://{environment}.ulysescloud.com/public/api/{version}/con/chain/{chainId}/property/{propertyId}/folio/{folioId}



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
folioIdIntegertruepath parameter
Unique identificator of the folio.


Example request

Code Block
languagepowershell
themeDJango
GET https://publicapi-providers.ulysescloud.com:9797/public/api/v1/con/chain/1/property/1/folio/1



Response

PropertyTypeRequiredDescription
folioFolio
The Folio requested by its Id.

Entity

Insert excerpt
Folio
Folio
nopaneltrue


Example response

Code Block
themeDJango
{
  "id" : 11,
  "code" : "110",
  "serie" : 1,
  "name" : "Nancy Léana Morrison",
  "folioType" : {
    "id" : 1,
    "code" : "M",
    "name" : "Main"
  },
  "room" : {
    "id" : 10,
    "code" : "110",
    "name" : "110",
    "roomSpaceStatusType" : {
      "id" : 2,
      "code" : "DI",
      "name" : "Dirty"
    },
    "reservationRoomStay" : null
  },
  "reservationRoomStaySummary" : {
    "id" : 11,
    "reservationRoomStay" : null,
    "reservationRoomStayId" : 11,
    "reservation" : null,
    "reservationId" : 7,
    "pmsLocator" : "ALI00000007/11",
    "crsLocator" : null,
    "otaLocator" : null,
    "cmLocator" : null,
    "holder" : null,
    "arrival" : "2020-02-04",
    "departure" : "2020-02-07",
    "nights" : 3,
    "productAccommodation" : {
      "id" : 632,
      "name" : "Single"
    },
    "productAccommodationUpgrade" : null,
    "roomType" : null,
    "adult" : 1,
    "junior" : 0,
    "child" : 0,
    "infant" : 0,
    "extraBed" : 0,
    "extraCot" : 0,
    "board" : {
      "id" : 7,
      "code" : null,
      "name" : "HalfBoard",
      "serviceList" : [ {
        "id" : 61,
        "name" : "Breakfast"
      }, {
        "id" : 66,
        "name" : "Dinner"
      } ]
    },
    "guest" : "Nancy Léana Morrison",
    "allotment" : null,
    "rate" : {
      "id" : 2,
      "code" : "BAR",
      "name" : "Best Available Rate"
    },
    "offer" : {
      "id" : 2,
      "code" : "NR",
      "name" : "Non Refundable"
    },
    "promotion" : null,
    "accommodationAmount" : 467.700000,
    "boardAmount" : 156.000000,
    "serviceAmount" : 120.000000,
    "totalAmount" : 743.700000,
    "currency" : {
      "id" : 1,
      "code" : "EUR",
      "name" : "Euro"
    },
    "booker" : {
      "id" : 911,
      "name" : "Wordtune",
      "code" : null,
      "taxId" : "34233900",
      "iataId" : null,
      "companyEmailList" : [ {
        "id" : 911,
        "primary" : true,
        "emailAddressType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Personal"
        },
        "email" : "nmorrisonoz@ehow.com",
        "remark" : null
      } ],
      "companyAddressList" : [ {
        "id" : 911,
        "primary" : true,
        "communicationLocationType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Home"
        },
        "street" : "8 Glendale Place",
        "city" : "Sarasota",
        "stateProvName" : "Álava",
        "stateProvCode" : "ES-VI",
        "postalCode" : "34233",
        "countryCode" : "ES",
        "remark" : "Address Remark"
      } ],
      "companyPhoneList" : [ {
        "id" : 911,
        "primary" : true,
        "phoneLocationType" : {
          "id" : 6,
          "code" : "6",
          "name" : "Home"
        },
        "phoneTechType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Voice"
        },
        "countryAccessCode" : "+34",
        "areaCityCode" : "B",
        "phoneNumber" : "1-(941)176-0996",
        "extension" : "1",
        "remark" : "Phone Remark"
      } ],
      "companyTaxAddress" : {
        "id" : 901,
        "communicationLocationType" : null,
        "street" : "8 Glendale Place",
        "city" : "Sarasota",
        "stateProvName" : "Pontevedra",
        "stateProvCode" : "ES-PO",
        "postalCode" : "34233",
        "countryCode" : "ES",
        "remark" : "Address Remark"
      },
      "remark" : "Company Remarks"
    },
    "billTo" : {
      "id" : 836,
      "name" : "Dabtype",
      "code" : null,
      "taxId" : "40293825",
      "iataId" : null,
      "companyEmailList" : [ {
        "id" : 836,
        "primary" : true,
        "emailAddressType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Personal"
        },
        "email" : "jfoxmw@sfgate.com",
        "remark" : null
      } ],
      "companyAddressList" : [ {
        "id" : 836,
        "primary" : true,
        "communicationLocationType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Home"
        },
        "street" : "52865 Main Drive",
        "city" : "Louisville",
        "stateProvName" : "Kentucky",
        "stateProvCode" : null,
        "postalCode" : "40293",
        "countryCode" : "LA",
        "remark" : "Address Remark"
      } ],
      "companyPhoneList" : [ {
        "id" : 836,
        "primary" : true,
        "phoneLocationType" : {
          "id" : 6,
          "code" : "6",
          "name" : "Home"
        },
        "phoneTechType" : {
          "id" : 1,
          "code" : "1",
          "name" : "Voice"
        },
        "countryAccessCode" : "+34",
        "areaCityCode" : "B",
        "phoneNumber" : "1-(502)141-5836",
        "extension" : "1",
        "remark" : "Phone Remark"
      } ],
      "companyTaxAddress" : {
        "id" : 826,
        "communicationLocationType" : null,
        "street" : "52865 Main Drive",
        "city" : "Louisville",
        "stateProvName" : "Kentucky",
        "stateProvCode" : null,
        "postalCode" : "40293",
        "countryCode" : "ET",
        "remark" : "Address Remark"
      },
      "remark" : "Company Remarks"
    },
    "central" : null,
    "company" : null,
    "room" : {
      "id" : 10,
      "code" : "110",
      "name" : "110",
      "roomSpaceStatusType" : {
        "id" : 2,
        "code" : "DI",
        "name" : "Dirty"
      },
      "reservationRoomStay" : null
    },
    "paymentType" : {
      "id" : 1,
      "code" : "G",
      "name" : "Pay Guest"
    },
    "propertyPolicy" : {
      "id" : 7,
      "code" : "NR",
      "name" : "Non Refundable"
    },
    "propertySource" : {
      "id" : 9,
      "code" : "COM",
      "name" : "Company"
    },
    "propertyChannel" : {
      "id" : 7,
      "code" : "CRS",
      "name" : "CRS"
    },
    "propertySegment" : {
      "id" : 25,
      "code" : "CAGE",
      "name" : "Company Agent"
    },
    "reservationStatusType" : {
      "id" : 4,
      "code" : "IH",
      "name" : "InHouse"
    },
    "expiredDate" : null,
	"hasCredit": true,
	"creditAvailable": 80.000000
  }
}