GUEST API OpenAPI3

GUEST API v1

Go to Swagger UI

Our GUEST API is organized around REST. It is documented according the OpenAPI Specification (OAS), based initially on the Swagger Specification and it is available in the link above

It accepts JSON-encoded and query parameters request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

We recommend to use the Swagger Editor as a starting point. Also note that there is new alpha version of the Swagger Editor with improved capabilities. It allows to import the GUEST API specification from a URL or a file. To do so, paste the JSON file from the link above.

It will load the GUEST API specification and you will be able to generate the client code in the language of your choice. Currently the supported languages are: csharp, csharp-dotnet2, dart, dynamic-html, go, html, html2, java, javascript, jaxrs-cxf-client, kotlin-client, openapi, openapi-yaml, php, python, r, ruby, scala, swift3, swift4, swift5, typescript-angular, typescript-axios, typescript-fetch.

To generate the client code, click on Generate Client and select the language of your choice. It will download a zip file with the generated code. Unzip it and follow the instructions in the README file. It will explain how to install the dependencies and how to use the generated code that includes all the classes and methods to call the GUEST API.

Important note: The code generated by the Swagger Editor is not production ready. It is just a starting point, you will need to adapt it to your needs. ISystems is not responsible for the code generated by the Swagger Editor nor is responsible for the code you write based on the code generated by the Swagger Editor.

Email: ISystems Web: ISystems

Auth

Our GUEST API manages authentication via login/password and authorization via JWT with refresh tokens.

First, you need to log in with your credentials and receive an AccessToken (aka JWT) and a RefreshToken. Once you have the AccessToken, you need to include it in the header of your API calls, as shown in the provided examples, to interact with our API.

The AccessToken has a short valid lifetime, and this is where the RefreshToken comes into play. The RefreshToken has a longer lifetime. When you encounter a 401 Unauthorized response, it means that your AccessToken has expired.

To obtain a new valid AccessToken without having to log in again, you can send the expired AccessToken along with the RefreshToken you received during the login process to the Refresh endpoint. This will allow you to obtain a new pair of valid AccessToken and RefreshToken to continue interacting with the API.

We recommend implementing a simple workflow in your code to handle the situation when you receive a 401 response with a prior working AccessToken. In this case, you can trigger a refresh by sending the expired AccessToken and the associated RefreshToken to the Refresh endpoint to obtain a new pair of tokens.

Caution

The refresh tokens are single-use, meaning that once you use a refresh token to obtain a new AccessToken, that refresh token becomes invalid.

LogIn

shell

# You can also use wget
curl -X POST /users/login?Username=string&Password=pa%24%24word \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/users/login', params={
  'Username': 'string',  'Password': 'pa$$word'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/users/login";


      await PostAsync(null, url);

    }

    /// Performs a POST Request
    public async Task PostAsync(undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /users/login

Username login to obtain a new authorization token

Parameters

Name	In	Type	Required	Description
Username	query	string	true	Username
Password	query	string(password)	true	Password

200 Response

{
  "accessToken": "string",
  "refreshToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Logged in correctly	TokenApi
400	Bad Request	Bad Request	None
401	Unauthorized	Login Failed: incorrect username or password	None
429	Too Many Requests	Too many requests, try again later	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Refresh

shell

# You can also use wget
curl -X POST /users/refresh \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/users/refresh', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/users/refresh";

      string json = @"{
  ""accessToken"": ""string"",
  ""refreshToken"": ""string""
}";
      TokenApi content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(TokenApi content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(TokenApi content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /users/refresh

Refreshes the access token from a user given the expired access token and a valid refresh token

Body parameter

{
  "accessToken": "string",
  "refreshToken": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	TokenApi	false	none

200 Response

{
  "accessToken": "string",
  "refreshToken": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	TokenApi
400	Bad Request	Bad Request	None
429	Too Many Requests	Too many requests, try again later	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetRoles

shell

# You can also use wget
curl -X GET /users/roles \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/users/roles', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/users/roles";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /users/roles

Returns a list with all the roles the user has

200 Response

[
  "string"
]

Responses

Status	Meaning	Description	Schema
200	OK	List of user permissions	Inline
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	User unauthorized	None
403	Forbidden	Forbidden	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

Response Schema

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetUserInformation

shell

# You can also use wget
curl -X GET /users/userinfo \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/users/userinfo', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/users/userinfo";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /users/userinfo

This endpoint will return token’s user information

200 Response

{
  "user_id": "string",
  "username": "string",
  "department_id": 0,
  "department_code": "string",
  "employee_id": 0,
  "employee_code": "string",
  "center_codes": [
    "string"
  ],
  "roles": [
    {
      "name": "string",
      "permissions": [
        "string"
      ]
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	User Info	UserInfoResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
429	Too Many Requests	Too many requests, try again later	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Availability

Endpoint related to managing the Availability of the rooms

GetAvailabilityList

shell

# You can also use wget
curl -X GET /availability?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/availability', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/availability";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /availability

This endpoint will return a list of availability roomtypes given the CenterCode and can be filtered. If no dates are provided DateFrom = Today, DateTo = DateFrom + 365 days

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center Code
DateFrom	query	string(date-time)	false	Start Date filter
DateUntil	query	string(date-time)	false	End Date filter
RoomTypesCode	query	array[string]	false	List of Room types codes to filter
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "center_id_fk": 0,
  "center": "string",
  "date": "2019-08-24T14:15:22Z",
  "roomTypeCenter_id_fk": 0,
  "roomType": "string",
  "allotmentAvailable": 0,
  "lockedRooms": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Availability list	AvailabilityResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetAvailableRoomsList

shell

# You can also use wget
curl -X GET /availability/rooms?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/availability/rooms', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/availability/rooms";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /availability/rooms

This endpoint will return a list of available rooms given the CenterCode and can be filtered. If no dates are provided DateFrom = Today, DateTo = Today + 365 days

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center Code
DateFrom	query	string(date-time)	false	Start Date filter
DateUntil	query	string(date-time)	false	End Date filter
IsLocked	query	boolean	false	Is room locked
IsOccupied	query	boolean	false	Is room occupied
RoomTypesCode	query	array[string]	false	List of Room types codes to filter

200 Response

{
  "center_id_fk": 0,
  "center": "string",
  "date": "2019-08-24T14:15:22Z",
  "roomTypeCenter_id_fk": 0,
  "roomType": "string",
  "allotmentAvailable": 0,
  "lockedRooms": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Room Availability list	AvailabilityResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Budgets

Endpoint related to managing the Budgets

GetCreditList

shell

# You can also use wget
curl -X GET /budgets/caccounts/getlist?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/budgets/caccounts/getlist', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/budgets/caccounts/getlist";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /budgets/caccounts/getlist

This endpoint will return a list of Credit accounts that can be filtered

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
Email	query	string	false	Email
ClientCode	query	string	false	Client code
StatusCodes	query	array[string]	false	List of Budget status identifier to filter
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "taxAddress": "string",
  "nif": "string",
  "nationality_id_fk": "string",
  "cardType": "string",
  "budgetLines": [
    {
      "budgetLine_id_pk": 0,
      "budgetHeader_id_fk": 0,
      "initialDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "saleService_id_fk": 0,
      "salesServiceName": "string",
      "observations": "string",
      "quantity": 0,
      "value": 0,
      "taxIncluded": true,
      "automaticCharge": true,
      "invStatus_id_fk": 0,
      "invoiceStatus": "string",
      "siL_id_fk": 0,
      "reservation_id_fk": 0
    }
  ],
  "customerRetainers": [
    {
      "customerRetainer_id_pk": 0,
      "retainerNumber": "string",
      "customer_id_fk": 0,
      "customerCode": "string",
      "date": "2019-08-24T14:15:22Z",
      "pM_id_fk": 0,
      "pmCode": "string",
      "amount": 0,
      "retainerStatus_id": 0,
      "retainerStatus": "string",
      "bank_id_fk": 0,
      "bankDescription": "string",
      "observations": "string",
      "invStatus_id_fk": 0,
      "invoiceStatus": "string",
      "budgetHeader_id_fk": 0,
      "percentageAmount": 0
    }
  ],
  "budgetHeader_id_pk": 0,
  "budgetType": "string",
  "center_id_fk": 0,
  "centerCode": "string",
  "groupCode": "string",
  "name": "string",
  "email": "string",
  "telephone": "string",
  "customer_id_fk": 0,
  "customerCode": "string",
  "budgetDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "lastUpdateUser": "string",
  "budgetStatus_id": 0,
  "budgetStatus": "string",
  "invStatus_id_fk": 0,
  "invStatus": "string",
  "comments": "string",
  "externalCode": "string",
  "futureProduction": true,
  "isPending": true,
  "totalAmount": 0,
  "totalInvoiced": 0,
  "totalRetainers": 0,
  "totalCollectedInvoice": 0,
  "pendingAmountRetainers": 0,
  "pendingAmount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Filtered Credit accounts	CreditAccResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetCredit

shell

# You can also use wget
curl -X GET /budgets/caccounts?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/budgets/caccounts', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/budgets/caccounts";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /budgets/caccounts

This endpoint will return a single Credit account with all its related info provided a identifier or reference

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center Code
Budget_id_pk	query	integer(int32)	false	Budget identifier
BudgetReference	query	string	false	Budget reference

200 Response

{
  "taxAddress": "string",
  "nif": "string",
  "nationality_id_fk": "string",
  "cardType": "string",
  "budgetLines": [
    {
      "budgetLine_id_pk": 0,
      "budgetHeader_id_fk": 0,
      "initialDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "saleService_id_fk": 0,
      "salesServiceName": "string",
      "observations": "string",
      "quantity": 0,
      "value": 0,
      "taxIncluded": true,
      "automaticCharge": true,
      "invStatus_id_fk": 0,
      "invoiceStatus": "string",
      "siL_id_fk": 0,
      "reservation_id_fk": 0
    }
  ],
  "customerRetainers": [
    {
      "customerRetainer_id_pk": 0,
      "retainerNumber": "string",
      "customer_id_fk": 0,
      "customerCode": "string",
      "date": "2019-08-24T14:15:22Z",
      "pM_id_fk": 0,
      "pmCode": "string",
      "amount": 0,
      "retainerStatus_id": 0,
      "retainerStatus": "string",
      "bank_id_fk": 0,
      "bankDescription": "string",
      "observations": "string",
      "invStatus_id_fk": 0,
      "invoiceStatus": "string",
      "budgetHeader_id_fk": 0,
      "percentageAmount": 0
    }
  ],
  "budgetHeader_id_pk": 0,
  "budgetType": "string",
  "center_id_fk": 0,
  "centerCode": "string",
  "groupCode": "string",
  "name": "string",
  "email": "string",
  "telephone": "string",
  "customer_id_fk": 0,
  "customerCode": "string",
  "budgetDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "lastUpdateUser": "string",
  "budgetStatus_id": 0,
  "budgetStatus": "string",
  "invStatus_id_fk": 0,
  "invStatus": "string",
  "comments": "string",
  "externalCode": "string",
  "futureProduction": true,
  "isPending": true,
  "totalAmount": 0,
  "totalInvoiced": 0,
  "totalRetainers": 0,
  "totalCollectedInvoice": 0,
  "pendingAmountRetainers": 0,
  "pendingAmount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Complete Credit account	CreditAccResponse
204	No Content	No credit account was found	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

NewCredit

shell

# You can also use wget
curl -X POST /budgets/caccounts?CenterCode=string&GroupCode=string&Name=string&CustomerCode=string&DueDate=2019-08-24T14%3A15%3A22Z \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/budgets/caccounts', params={
  'CenterCode': 'string',  'GroupCode': 'string',  'Name': 'string',  'CustomerCode': 'string',  'DueDate': '2019-08-24T14:15:22Z'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/budgets/caccounts";


      await PostAsync(null, url);

    }

    /// Performs a POST Request
    public async Task PostAsync(undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /budgets/caccounts

This endpoint will create a Credit account

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
GroupCode	query	string	true	Credit account code
Name	query	string	true	Credit account name
CustomerCode	query	string	true	Customer code
DueDate	query	string(date-time)	true	Due date
BudgetDate	query	string(date-time)	false	Credit account date
Email	query	string	false	Email
Telephone	query	string	false	Phone number
Comments	query	string	false	Comments
TaxAddress	query	string	false	Tax address
NIF	query	string	false	NIF
Nationality_id_fk	query	string	false	Nationality

200 Response

{
  "taxAddress": "string",
  "nif": "string",
  "nationality_id_fk": "string",
  "cardType": "string",
  "budgetLines": [
    {
      "budgetLine_id_pk": 0,
      "budgetHeader_id_fk": 0,
      "initialDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "saleService_id_fk": 0,
      "salesServiceName": "string",
      "observations": "string",
      "quantity": 0,
      "value": 0,
      "taxIncluded": true,
      "automaticCharge": true,
      "invStatus_id_fk": 0,
      "invoiceStatus": "string",
      "siL_id_fk": 0,
      "reservation_id_fk": 0
    }
  ],
  "customerRetainers": [
    {
      "customerRetainer_id_pk": 0,
      "retainerNumber": "string",
      "customer_id_fk": 0,
      "customerCode": "string",
      "date": "2019-08-24T14:15:22Z",
      "pM_id_fk": 0,
      "pmCode": "string",
      "amount": 0,
      "retainerStatus_id": 0,
      "retainerStatus": "string",
      "bank_id_fk": 0,
      "bankDescription": "string",
      "observations": "string",
      "invStatus_id_fk": 0,
      "invoiceStatus": "string",
      "budgetHeader_id_fk": 0,
      "percentageAmount": 0
    }
  ],
  "budgetHeader_id_pk": 0,
  "budgetType": "string",
  "center_id_fk": 0,
  "centerCode": "string",
  "groupCode": "string",
  "name": "string",
  "email": "string",
  "telephone": "string",
  "customer_id_fk": 0,
  "customerCode": "string",
  "budgetDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "lastUpdateUser": "string",
  "budgetStatus_id": 0,
  "budgetStatus": "string",
  "invStatus_id_fk": 0,
  "invStatus": "string",
  "comments": "string",
  "externalCode": "string",
  "futureProduction": true,
  "isPending": true,
  "totalAmount": 0,
  "totalInvoiced": 0,
  "totalRetainers": 0,
  "totalCollectedInvoice": 0,
  "pendingAmountRetainers": 0,
  "pendingAmount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Created credit account	CreditAccResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetQuotesList

shell

# You can also use wget
curl -X GET /budgets/quotes/getlist?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/budgets/quotes/getlist', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/budgets/quotes/getlist";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /budgets/quotes/getlist

This endpoint will return a list of Quotes that can be filtered

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
Email	query	string	false	Email
ClientCode	query	string	false	Client code
StatusCodes	query	array[string]	false	List of Budget status identifier to filter
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "isPending": true,
  "arrivalDate": "2019-08-24T14:15:22Z",
  "pendingInvoice": 0,
  "budgetHeader_id_pk": 0,
  "budgetType": "string",
  "center_id_fk": 0,
  "centerCode": "string",
  "groupCode": "string",
  "name": "string",
  "email": "string",
  "telephone": "string",
  "customer_id_fk": 0,
  "customerCode": "string",
  "budgetDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "lastUpdateUser": "string",
  "budgetStatus_id": 0,
  "budgetStatus": "string",
  "invStatus_id_fk": 0,
  "invStatus": "string",
  "totalAmount": 0,
  "totalInvoiced": 0,
  "totalRetainers": 0,
  "totalCollectedInvoice": 0,
  "pendingAmountRetainers": 0,
  "pendingAmount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Filtered Quotes	QuotesResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetQuote

shell

# You can also use wget
curl -X GET /budgets/quotes?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/budgets/quotes', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/budgets/quotes";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /budgets/quotes

This endpoint will return a single Quote account with all its related info provided a identifier or reference

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center Code
Budget_id_pk	query	integer(int32)	false	Budget identifier
BudgetReference	query	string	false	Budget reference

200 Response

{
  "arrivalDate": "2019-08-24T14:15:22Z",
  "pendingInvoice": 0,
  "budgetHeader_id_pk": 0,
  "budgetType": "string",
  "center_id_fk": 0,
  "centerCode": "string",
  "groupCode": "string",
  "name": "string",
  "email": "string",
  "telephone": "string",
  "customer_id_fk": 0,
  "customerCode": "string",
  "budgetDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "lastUpdateUser": "string",
  "budgetStatus_id": 0,
  "budgetStatus": "string",
  "invStatus_id_fk": 0,
  "invStatus": "string",
  "comments": "string",
  "externalCode": "string",
  "futureProduction": true,
  "isPending": true,
  "totalAmount": 0,
  "totalInvoiced": 0,
  "totalRetainers": 0,
  "totalCollectedInvoice": 0,
  "pendingAmountRetainers": 0,
  "pendingAmount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Complete Quote	QuoteResponse
204	No Content	No quote was found	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

NewQuote

shell

# You can also use wget
curl -X POST /budgets/quotes?CenterCode=string&GroupCode=string&Name=string&CustomerCode=string&DueDate=2019-08-24T14%3A15%3A22Z \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/budgets/quotes', params={
  'CenterCode': 'string',  'GroupCode': 'string',  'Name': 'string',  'CustomerCode': 'string',  'DueDate': '2019-08-24T14:15:22Z'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/budgets/quotes";


      await PostAsync(null, url);

    }

    /// Performs a POST Request
    public async Task PostAsync(undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /budgets/quotes

This endpoint will create a Quote

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
GroupCode	query	string	true	Quote code
Name	query	string	true	Quote name
CustomerCode	query	string	true	Customer code
DueDate	query	string(date-time)	true	Due date
BudgetDate	query	string(date-time)	false	Quote date
Email	query	string	false	Email
Telephone	query	string	false	Phone number
Comments	query	string	false	Comments

200 Response

{
  "arrivalDate": "2019-08-24T14:15:22Z",
  "pendingInvoice": 0,
  "budgetHeader_id_pk": 0,
  "budgetType": "string",
  "center_id_fk": 0,
  "centerCode": "string",
  "groupCode": "string",
  "name": "string",
  "email": "string",
  "telephone": "string",
  "customer_id_fk": 0,
  "customerCode": "string",
  "budgetDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "lastUpdateUser": "string",
  "budgetStatus_id": 0,
  "budgetStatus": "string",
  "invStatus_id_fk": 0,
  "invStatus": "string",
  "comments": "string",
  "externalCode": "string",
  "futureProduction": true,
  "isPending": true,
  "totalAmount": 0,
  "totalInvoiced": 0,
  "totalRetainers": 0,
  "totalCollectedInvoice": 0,
  "pendingAmountRetainers": 0,
  "pendingAmount": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Created Quote	QuoteResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Config

Endpoint related to get config lists

GetRoomTypes

shell

# You can also use wget
curl -X GET /config/roomtypes \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/roomtypes', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/roomtypes";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/roomtypes

This endpoint will return a list of all the RoomTypes

200 Response

{
  "code": "string",
  "roomType_id_pk": 0,
  "description": "string",
  "maximum_occupancy": 0,
  "minimum_occupancy": 0,
  "regular_occupancy": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of RoomTypes	RoomTypesResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetRoomTypesPerCenter

shell

# You can also use wget
curl -X GET /config/roomtypesxcenter \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/roomtypesxcenter', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/roomtypesxcenter";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/roomtypesxcenter

This endpoint will return a list of all the RoomTypesPerCenter

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	false	Center code

200 Response

{
  "roomTypeCenter_id_pk": 0,
  "centerCode": "string",
  "center_id_fk": 0,
  "roomTypeCode": "string",
  "roomType_id_fk": 0,
  "description": "string",
  "descriptionDetailed": "string",
  "real": true,
  "order": 0,
  "locked": true,
  "rooms": 0,
  "maximum_occupancy": 0,
  "minimum_occupancy": 0,
  "regular_occupancy": 0,
  "establishmentCategoryCode": "string",
  "establishmentCategory_id_fk": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of filtered RoomTypesPerCenter	RoomTypesCenterResponse
204	No Content	No Content	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetRooms

shell

# You can also use wget
curl -X GET /config/rooms?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/rooms', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/rooms";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/rooms

This endpoint will return a list of all the Rooms

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center Code
RoomTypesFilter	query	array[string]	false	RoomTypes code to filter
Real	query	boolean	false	Real filter // null = ALL, true = YES, false = NO
Virtual	query	boolean	false	Virtual filter // null = ALL, true = YES, false = NO
Cleaned	query	boolean	false	Cleaned filter // null = ALL, true = YES, false = NO
Locked	query	boolean	false	Locked filter // null = ALL, true = YES, false = NO
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "room_id_pk": 0,
  "centerCode": "string",
  "center_id_fk": 0,
  "roomTypeCode": "string",
  "roomTypeCenter_id_fk": 0,
  "roomType_id_fk": 0,
  "number": "string",
  "phone": 0,
  "floorCode": "string",
  "floor_id_fk": 0,
  "roomRangeCode": "string",
  "roomRange_id_fk": 0,
  "blockCode": "string",
  "block_id_fk": 0,
  "description": "string",
  "descriptionDetailed": "string",
  "real": true,
  "virtual": true,
  "cleaned": true,
  "locked": true
}

Responses

Status	Meaning	Description	Schema
200	OK	List of filtered Rooms	RoomsResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetBlocks

shell

# You can also use wget
curl -X GET /config/rooms/blocks \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/rooms/blocks', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/rooms/blocks";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/rooms/blocks

This endpoint will return a list of all the Room Blocks

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	false	Center code

200 Response

{
  "roomRange_id": 0,
  "description": "string",
  "center_id": 0,
  "centerCode": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of RoomBlocks	RoomRangeResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetFloors

shell

# You can also use wget
curl -X GET /config/rooms/floors \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/rooms/floors', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/rooms/floors";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/rooms/floors

This endpoint will return a list of all the Room Floors

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	false	Center code

200 Response

{
  "roomRange_id": 0,
  "description": "string",
  "center_id": 0,
  "centerCode": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of RoomFloors	RoomRangeResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetRanges

shell

# You can also use wget
curl -X GET /config/rooms/ranges \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/rooms/ranges', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/rooms/ranges";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/rooms/ranges

This endpoint will return a list of all the Room Ranges

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	false	Center code

200 Response

{
  "roomRange_id": 0,
  "description": "string",
  "center_id": 0,
  "centerCode": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of RoomRanges	RoomRangeResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetBoardTypes

shell

# You can also use wget
curl -X GET /config/boardtypes \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/boardtypes', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/boardtypes";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/boardtypes

This endpoint will return a list of all the BoardTypes

200 Response

{
  "boardType_id_pk": 0,
  "code": "string",
  "description": "string",
  "breakfast": true,
  "lunch": true,
  "dinner": true,
  "allInclusive": true
}

Responses

Status	Meaning	Description	Schema
200	OK	List of BoardTypes	BoardTypesResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetBoardTypesCenter

shell

# You can also use wget
curl -X GET /config/boardtypesxcenter \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/boardtypesxcenter', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/boardtypesxcenter";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/boardtypesxcenter

This endpoint will return a list of all the BoardTypesCenter

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	false	Center code

200 Response

{
  "boardTypeCenter_id_pk": 0,
  "centerCode": "string",
  "center_id_fk": 0,
  "boardTypeCode": "string",
  "boardType_id_fk": 0,
  "description": "string",
  "descriptionDetailed": "string",
  "defaultBoard": true
}

Responses

Status	Meaning	Description	Schema
200	OK	List of filtered BoardTypesCenter	BoardTypesCenterResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetCenters

shell

# You can also use wget
curl -X GET /config/centers \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/centers', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/centers";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/centers

This endpoint will return a list of all Centers the user has access to

200 Response

{
  "center_id": 0,
  "centerCode": "string",
  "centerName": "string",
  "currency": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of Centers	CentersResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetCenterZones

shell

# You can also use wget
curl -X GET /config/centers/zones \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/centers/zones', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/centers/zones";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/centers/zones

This endpoint will return a list of all Center zones

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	false	Center code

200 Response

{
  "centerZone_id": 0,
  "centerZone_code": "string",
  "center_id": 0,
  "centerCode": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of CenterZones	CenterZoneResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetCustomerTypes

shell

# You can also use wget
curl -X GET /config/customertypes \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/customertypes', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/customertypes";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/customertypes

This endpoint will return a list of all the CustomerTypes

200 Response

{
  "customerType_id": 0,
  "customerType": "string",
  "description": "string",
  "withoutChargeLodgment": true,
  "withoutChargeSupplies": true,
  "isDefault": true
}

Responses

Status	Meaning	Description	Schema
200	OK	List of CustomerType	CustomerTypeResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetDepartments

shell

# You can also use wget
curl -X GET /config/RRHH/departments \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/RRHH/departments', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/RRHH/departments";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/RRHH/departments

This endpoint will return a list of all the Departments configured by the user

200 Response

{
  "department_id": 0,
  "departmentName": "string",
  "isLocked": true,
  "type": 0,
  "centerDepartments": [
    {
      "centerCode": "string",
      "notifyLocked": true,
      "email": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	List of Departments	DepartmentsResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetContractTypes

shell

# You can also use wget
curl -X GET /config/RRHH/contracttypes \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/RRHH/contracttypes', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/RRHH/contracttypes";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/RRHH/contracttypes

This endpoint will return a list of all the Contract Types configured by the user

200 Response

{
  "contractType_id": 0,
  "code": "string",
  "description": "string",
  "isLocked": true
}

Responses

Status	Meaning	Description	Schema
200	OK	List of ContractTypes	RRHHContractTypeResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetPositions

shell

# You can also use wget
curl -X GET /config/RRHH/positions \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/RRHH/positions', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/RRHH/positions";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/RRHH/positions

This endpoint will return a list of all Contract Positions configured by the user

200 Response

{
  "position_id": 0,
  "description": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of Positions	RRHH_PositionsResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetIncidenceTypes

shell

# You can also use wget
curl -X GET /config/RRHH/incidencetypes \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/RRHH/incidencetypes', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/RRHH/incidencetypes";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/RRHH/incidencetypes

This endpoint will return a list of all Incidence Types configured by the user

200 Response

{
  "incicenceType_id": 0,
  "incicenceType_code": "string",
  "description": "string",
  "format": "string",
  "group_id": 0,
  "group_code": "string",
  "type": "string",
  "overtime": "string",
  "locked": true
}

Responses

Status	Meaning	Description	Schema
200	OK	List of Incidence Types	RRHH_IncidenceTypesResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetSalesServices

shell

# You can also use wget
curl -X GET /config/salesservices \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/salesservices', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/salesservices";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/salesservices

This endpoint will return the filtered list of SalesServices that can be filtered.

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	false	CenterCode
SaleServiceCode	query	string	false	Sales Service code
ServiceType_id	query	integer(int32)	false	Service type filter
Group_ids	query	array[integer]	false	SuppliesGroup identifiers to filter

200 Response

{
  "service_id": 0,
  "centerCode": "string",
  "name": "string",
  "description": "string",
  "externalCode": "string",
  "serviceType_id": 0,
  "serviceType_desc": "string",
  "salesServiceGroup_id": 0,
  "salesServiceGroup_name": "string",
  "vatPercent": 0,
  "price": 0,
  "dailyPrice": true,
  "department_code": "string",
  "salesServicesConditions": [
    {
      "salesServicesConditions_id": 0,
      "name": "string",
      "language": "string",
      "description": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	List of SalesServices	SalesServicesResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetSalesServicesGroups

shell

# You can also use wget
curl -X GET /config/salesservices/groups \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/salesservices/groups', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/salesservices/groups";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/salesservices/groups

This endpoint the filtered list of SalesServicesGroup

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	false	Center code

200 Response

{
  "salesServiceGroup_id": 0,
  "salesServiceGroup_name": "string",
  "centerCode": "string",
  "description": "string",
  "isOmit": true,
  "isLodgement": true,
  "isBoard": true,
  "isLocked": true
}

Responses

Status	Meaning	Description	Schema
200	OK	List of SalesServicesGroup	SalesServicesGroupResonse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetPaymentMethodList

shell

# You can also use wget
curl -X GET /config/paymentmethod \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/config/paymentmethod', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/config/paymentmethod";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /config/paymentmethod

This endpoint will return the filtered list of Payment Methods avaliable for the Retainers

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	false	Center code

200 Response

{
  "paymentMehod_id": 0,
  "center_id": 0,
  "centerCode": "string",
  "description": "string",
  "cashRegister": "string",
  "carryBalance": true,
  "pmType": "string",
  "ticketCopyNumber": 0,
  "onlyTPV": true,
  "code": "string",
  "externalCode": "string",
  "pmOrder": 0,
  "accCommission": "string",
  "transferPerMovment": true
}

Responses

Status	Meaning	Description	Schema
200	OK	List of Payment methods	PaymentMethodsResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

CRM

Endpoint related to managing the CRM

GetCardexList

shell

# You can also use wget
curl -X GET /CRM/cardex \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/CRM/cardex', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/CRM/cardex";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /CRM/cardex

This endpoint will return a list of Cardex ordered by timestamp that can filtered

Parameters

Name	In	Type	Required	Description
Nationality	query	string	false	Nationality ISO2
AuthReceiveAdvertising	query	boolean	false	Advertising authorization
AuthDataExchange	query	boolean	false	Data exchange authorization
AuthMessageAndPhone	query	boolean	false	Contact authorization
AuthLocalization	query	boolean	false	Localization authorization
Timestamp	query	string	false	Timestamp filter
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "cardex_id_pk": 0,
  "timestamp": "string",
  "nationality": "string",
  "documentType": "string",
  "documentNumber": "string",
  "dateExpDocument": "2019-08-24T14:15:22Z",
  "name": "string",
  "surname": "string",
  "surname2": "string",
  "sex": "string",
  "birthdate": "2019-08-24T14:15:22Z",
  "email": "string",
  "residenceCountry_id_fk": "string",
  "postalcode": "string",
  "province": "string",
  "population": "string",
  "telephone": "string",
  "telephone2": "string",
  "fax": "string",
  "address": "string",
  "unsuscribeDate": "2019-08-24T14:15:22Z",
  "unsuscribeReason": "string",
  "authReceiveAdvertising": true,
  "authDataExchange": true,
  "authMessageAndPhone": true,
  "authLocalization": true,
  "anniversaryDate": "2019-08-24T14:15:22Z",
  "language_id_fk": "string",
  "cardexSource_id_fk": 0,
  "state_id_fk": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Cardex list	CardexResponse
204	No Content	No Content	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

PostCardexList

shell

# You can also use wget
curl -X POST /CRM/cardex \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/CRM/cardex', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/CRM/cardex";

      string json = @"[
  {
    ""name"": ""string"",
    ""surname1"": ""string"",
    ""surname2"": ""string"",
    ""birthDate"": ""2019-08-24"",
    ""documentID"": ""string"",
    ""documentType"": ""string"",
    ""expeditionDateDocument"": ""2019-08-24"",
    ""address"": ""string"",
    ""postalCode"": ""string"",
    ""state"": ""string"",
    ""city"": ""string"",
    ""phone"": ""string"",
    ""country"": ""string"",
    ""nationality"": ""string"",
    ""sex"": ""s"",
    ""email"": ""user@example.com"",
    ""supportNumber"": null,
    ""language"": ""string"",
    ""anniversaryDate"": null,
    ""authDataExchange"": false,
    ""authReceiveAdvertising"": false,
    ""authMessageAndPhone"": false,
    ""authLocalization"": false,
    ""segment_code"": null,
    ""cardexSource_code"": null
  }
]";
      CardexPost content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(CardexPost content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(CardexPost content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /CRM/cardex

This endpoint will create a list of Cardex provided

Body parameter

[
  {
    "name": "string",
    "surname1": "string",
    "surname2": "string",
    "birthDate": "2019-08-24",
    "documentID": "string",
    "documentType": "string",
    "expeditionDateDocument": "2019-08-24",
    "address": "string",
    "postalCode": "string",
    "state": "string",
    "city": "string",
    "phone": "string",
    "country": "string",
    "nationality": "string",
    "sex": "s",
    "email": "user@example.com",
    "supportNumber": null,
    "language": "string",
    "anniversaryDate": null,
    "authDataExchange": false,
    "authReceiveAdvertising": false,
    "authMessageAndPhone": false,
    "authLocalization": false,
    "segment_code": null,
    "cardexSource_code": null
  }
]

Parameters

Name	In	Type	Required	Description
AppCustomerOverride	query	integer(int32)	false	AppCustomer override (Admin)
body	body	CardexPost	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Successful	None
204	No Content	No Content	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetSegmentList

shell

# You can also use wget
curl -X GET /CRM/segments \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/CRM/segments', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/CRM/segments";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /CRM/segments

This endpoint will return the list of CRM Segments

Parameters

Name	In	Type	Required	Description
AppCustomerOverride	query	integer(int32)	false	AppCustomer override (Admin)

200 Response

{
  "segment_id": 0,
  "segment_name": "string",
  "isDynamic": true,
  "scope": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Segment list	SegmentResponse
204	No Content	No Content	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetCardexSources

shell

# You can also use wget
curl -X GET /CRM/sources \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/CRM/sources', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/CRM/sources";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /CRM/sources

This endpoint will return the list of Cardex Sources

200 Response

{
  "cardexSource_id": 0,
  "externalCode": "string",
  "description": "string",
  "default": true
}

Responses

Status	Meaning	Description	Schema
200	OK	CardexSources list	CardexSourceResponse
204	No Content	No Content	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

UnsubCardex

shell

# You can also use wget
curl -X POST /CRM/unsubscribe?cardexEmail=user%40example.com \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/CRM/unsubscribe', params={
  'cardexEmail': 'user@example.com'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/CRM/unsubscribe";


      await PostAsync(null, url);

    }

    /// Performs a POST Request
    public async Task PostAsync(undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /CRM/unsubscribe

This endpoint will Unsubscribe a list of Cardex given a valid email

Parameters

Name	In	Type	Required	Description
cardexEmail	query	string(email)	true	Email list
AppCustomerOverride	query	integer(int32)	false	AppCustomer override (Admin)

200 Response

0

Responses

Status	Meaning	Description	Schema
200	OK	Amount of Cardex unsubscribed	integer
204	No Content	No Content	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Documents

Endpoint related to managing and retrieving Documents

GetDocumentTypes

shell

# You can also use wget
curl -X GET /documents/types \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/documents/types', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/documents/types";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /documents/types

This endpoint will return a list of all the DocumentTypes the user has access to

200 Response

{
  "documentType_id": 0,
  "description": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of DocumentTypes	DocumentTypesResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetDocuments

shell

# You can also use wget
curl -X GET /documents?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/documents', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/documents";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /documents

This endpoint will return a list of filtered documents given a CenterCode. Regarding the “Has” filters: null: All results, true: results with property != null, false: results with property == null. When providing a reference, only one “Has” property can be set to TRUE

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
Document_id	query	integer(int32)	false	Document identifier
Reference_id	query	integer(int32)	false	Reference identifier
DocumentTypes_ids	query	array[integer]	false	List of DocumentTypes identifiers to filter
HasTask	query	boolean	false	Associated to Task
HasCustomer	query	boolean	false	Associated to Customer
HasSIH	query	boolean	false	Associated to SIH
HasBudget	query	boolean	false	Associated to Budget
HasCollectionHeader	query	boolean	false	Associated to ColletionHeader
HasExpenseInvoice	query	boolean	false	Associated to ExpenseInvoice
HasNote	query	boolean	false	Associated to Note
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "document_id": 0,
  "date": "2019-08-24T14:15:22Z",
  "documentType_id": 0,
  "description": "string",
  "typeIO": true,
  "centerCode": "string",
  "fileName": "string",
  "accessUrl": "string",
  "customer_id": 0,
  "storE_Supplier_id": 0,
  "task_id": 0,
  "note_id": 0,
  "siH_id": 0,
  "budget_id": 0,
  "collectionHeader_id": 0,
  "expenseInvoice_id": 0,
  "parentType": 0,
  "parent_id": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of Documents	DocumentResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

DeleteDocuments

shell

# You can also use wget
curl -X DELETE /documents \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/documents', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }




    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/documents";

      await DeleteAsync(id, url);
    }

    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");

        //Return response
        await DeserializeObject(response);
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /documents

This endpoint will remove a document given the Document_id

Parameters

Name	In	Type	Required	Description
Document_id	query	integer(int32)	false	Document identifier

Responses

Status	Meaning	Description	Schema
200	OK	Document deleted successfully	None
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Occupancy

Endpoint related to managing the Occupancy of the rooms

GetOccupancyRoomsList

shell

# You can also use wget
curl -X GET /occupancy?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/occupancy', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/occupancy";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /occupancy

This endpoint will return a list of occupancy given the CenterCode and can be filtered. If no dates are provided DateFrom = Today, DateTo = Today + 365 days

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
DateFrom	query	string(date-time)	false	Start Date filter
DateUntil	query	string(date-time)	false	End Date filter
RoomTypesCode	query	array[string]	false	List of Room types codes to filter
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "center_id_fk": 0,
  "center": "string",
  "date": "2019-08-24T14:15:22Z",
  "roomTypeCenter_id_fk": 0,
  "roomType": "string",
  "occupancy": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Occupancy list	OccupancyRoomsResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Operations

Endpoint related to managing and retrieving information from Operations and Tasks

GetTaskTypes

shell

# You can also use wget
curl -X GET /operations/tasks/types \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/operations/tasks/types', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/operations/tasks/types";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /operations/tasks/types

This endpoint will return a list of TaskTypes given the CenterCode

Parameters

Name	In	Type	Required	Description
Department_code	query	array[string]	false	Department codes
ShowForecast	query	boolean	false	Is show forecast

200 Response

{
  "taskType_id": 0,
  "taskType_name": "string",
  "department_id": 0,
  "department_name": "string",
  "showForecast": true
}

Responses

Status	Meaning	Description	Schema
200	OK	List of TaskTypes	TaskTypeResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetTasks

shell

# You can also use wget
curl -X GET /operations/tasks \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/operations/tasks', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/operations/tasks";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /operations/tasks

This endpoint will return a list of Task the user has access to. TaskStatus = All by default

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	false	Center code
Task_id	query	integer(int32)	false	Task identifier
StartDateFrom	query	string(date-time)	false	From start date
StartDateTo	query	string(date-time)	false	To start date
EndingDateFrom	query	string(date-time)	false	From ending date
EndingDateTo	query	string(date-time)	false	To ending date
Departments	query	array[string]	false	List of department codes to filter
CreatedBy	query	string	false	Created by user
TaskStatus	query	integer(int32)	false	Task status
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "task_id": 0,
  "centerCode": "string",
  "taskNumber": 0,
  "status": 0,
  "blockPlanned": true,
  "priority": 0,
  "department_id": 0,
  "department_code": "string",
  "taskType_id": 0,
  "taskType_code": "string",
  "employeeInformed_id": 0,
  "employeeInformed": "string",
  "employeeRepair_id": 0,
  "employeeRepair": "string",
  "employeeNoticed_id": 0,
  "employeeNoticed": "string",
  "room_code": "string",
  "centerZone_code": "string",
  "asset_id": 0,
  "store_id": 0,
  "fixedAsset": "string",
  "lockedRoom": true,
  "dateCommunication": "2019-08-24T14:15:22Z",
  "dateStartingTask": "2019-08-24T14:15:22Z",
  "dateEndingTask": "2019-08-24T14:15:22Z",
  "insuranceNotified": true,
  "courtesyCall": 0,
  "observations": "string",
  "taskPlanning_id": 0,
  "taskPlanningDescription": "string",
  "creationUser": "string",
  "amountServices": 0,
  "amountProducts": 0,
  "documents": [
    {
      "document_id": 0,
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "fileName": "string",
      "accessUrl": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	List of Tasks	TasksResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

AddTask

shell

# You can also use wget
curl -X POST /operations/tasks \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/operations/tasks', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/operations/tasks";


      await PostAsync(null, url);

    }

    /// Performs a POST Request
    public async Task PostAsync(undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /operations/tasks

This endpoint will create a new Task

Body parameter

CenterCode: string
TaskType_id: 0
DateCommunication: 2019-08-24T14:15:22Z
DateStartingTask: 2019-08-24T14:15:22Z
DateEndingTask: 2019-08-24T14:15:22Z
Status: 0
Room_code: string
LockedRoom: true
CenterZone_code: string
Asset_id: 0
Store_id: 0
Priority: 0
LockPrevision: true
EmployeeInformed_id: 0
EmployeeRepair_id: 0
EmployeeNoticed_id: 0
CourtesyCall: 0
InsuranceNotified: true
Observations: string
Documents:
  - string

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» CenterCode	body	string	true	Center code
» TaskType_id	body	integer(int32)	true	TaskType identifier
» DateCommunication	body	string(date-time)	true	Communication date
» DateStartingTask	body	string(date-time)	true	Start date
» DateEndingTask	body	string(date-time)	false	End date
» Status	body	integer(int32)	false	Status
» Room_code	body	string	false	Room code
» LockedRoom	body	boolean	false	Is room locked
» CenterZone_code	body	string	false	CenterZone code
» Asset_id	body	integer(int32)	false	Asset identifier
» Store_id	body	integer(int32)	false	Store identifier
» Priority	body	integer(int32)	false	Priority (0-3)
» LockPrevision	body	boolean	false	Lock prevision
» EmployeeInformed_id	body	integer(int32)	false	Employee informed identifier
» EmployeeRepair_id	body	integer(int32)	false	Employee repair identifier
» EmployeeNoticed_id	body	integer(int32)	false	Employee noticed
» CourtesyCall	body	integer(int32)	false	Courtesy call code
» InsuranceNotified	body	boolean	false	Is insurance notified
» Observations	body	string	false	Observations
» Documents	body	[string]	false	Document list

200 Response

{
  "task_id": 0,
  "centerCode": "string",
  "taskNumber": 0,
  "status": 0,
  "blockPlanned": true,
  "priority": 0,
  "department_id": 0,
  "department_code": "string",
  "taskType_id": 0,
  "taskType_code": "string",
  "employeeInformed_id": 0,
  "employeeInformed": "string",
  "employeeRepair_id": 0,
  "employeeRepair": "string",
  "employeeNoticed_id": 0,
  "employeeNoticed": "string",
  "room_code": "string",
  "centerZone_code": "string",
  "asset_id": 0,
  "store_id": 0,
  "fixedAsset": "string",
  "lockedRoom": true,
  "dateCommunication": "2019-08-24T14:15:22Z",
  "dateStartingTask": "2019-08-24T14:15:22Z",
  "dateEndingTask": "2019-08-24T14:15:22Z",
  "insuranceNotified": true,
  "courtesyCall": 0,
  "observations": "string",
  "taskPlanning_id": 0,
  "taskPlanningDescription": "string",
  "creationUser": "string",
  "amountServices": 0,
  "amountProducts": 0,
  "documents": [
    {
      "document_id": 0,
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "fileName": "string",
      "accessUrl": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Task created	TasksResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

UpdateTask

shell

# You can also use wget
curl -X PATCH /operations/tasks/{task_id} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/operations/tasks/{task_id}', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PATCH /operations/tasks/{task_id}

This endpoint will update a task given a Task_id

Body parameter

CenterCode: string
TaskType_id: 0
DateCommunication: 2019-08-24T14:15:22Z
DateStartingTask: 2019-08-24T14:15:22Z
DateEndingTask: 2019-08-24T14:15:22Z
Status: 0
Room_code: string
LockedRoom: true
CenterZone_code: string
Asset_id: 0
Store_id: 0
Priority: 0
LockPrevision: true
EmployeeInformed_id: 0
EmployeeRepair_id: 0
EmployeeNoticed_id: 0
CourtesyCall: 0
InsuranceNotified: true
Observations: string
Documents:
  - string

Parameters

Name	In	Type	Required	Description
task_id	path	integer(int32)	true	Task identifier
body	body	object	false	none
» CenterCode	body	string	false	Center code
» TaskType_id	body	integer(int32)	false	TaskType identifier
» DateCommunication	body	string(date-time)	false	Communication date
» DateStartingTask	body	string(date-time)	false	Start date
» DateEndingTask	body	string(date-time)	false	End date
» Status	body	integer(int32)	false	Status
» Room_code	body	string	false	Room code
» LockedRoom	body	boolean	false	Is room locked
» CenterZone_code	body	string	false	CenterZone code
» Asset_id	body	integer(int32)	false	Asset identifier
» Store_id	body	integer(int32)	false	Store identifier
» Priority	body	integer(int32)	false	Priority (0-3)
» LockPrevision	body	boolean	false	Lock prevision
» EmployeeInformed_id	body	integer(int32)	false	Employee informed identifier
» EmployeeRepair_id	body	integer(int32)	false	Employee repair identifier
» EmployeeNoticed_id	body	integer(int32)	false	Employee noticed
» CourtesyCall	body	integer(int32)	false	Courtesy call code
» InsuranceNotified	body	boolean	false	Is insurance notified
» Observations	body	string	false	Observations
» Documents	body	[string]	false	Document list

200 Response

{
  "task_id": 0,
  "centerCode": "string",
  "taskNumber": 0,
  "status": 0,
  "blockPlanned": true,
  "priority": 0,
  "department_id": 0,
  "department_code": "string",
  "taskType_id": 0,
  "taskType_code": "string",
  "employeeInformed_id": 0,
  "employeeInformed": "string",
  "employeeRepair_id": 0,
  "employeeRepair": "string",
  "employeeNoticed_id": 0,
  "employeeNoticed": "string",
  "room_code": "string",
  "centerZone_code": "string",
  "asset_id": 0,
  "store_id": 0,
  "fixedAsset": "string",
  "lockedRoom": true,
  "dateCommunication": "2019-08-24T14:15:22Z",
  "dateStartingTask": "2019-08-24T14:15:22Z",
  "dateEndingTask": "2019-08-24T14:15:22Z",
  "insuranceNotified": true,
  "courtesyCall": 0,
  "observations": "string",
  "taskPlanning_id": 0,
  "taskPlanningDescription": "string",
  "creationUser": "string",
  "amountServices": 0,
  "amountProducts": 0,
  "documents": [
    {
      "document_id": 0,
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "fileName": "string",
      "accessUrl": "string"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Task modified sucessfully	TasksResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetFixedAssets

shell

# You can also use wget
curl -X GET /operations/assets?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/operations/assets', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/operations/assets";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /operations/assets

This endpoint will return a list of Fixed Assets given a CenterCode

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
Store_code	query	string	false	Store external code
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "product_id": 0,
  "productName": "string",
  "store_id": 0,
  "storeCode": "string",
  "storeName": "string",
  "description": "string",
  "reference": "string",
  "code": "string",
  "centerCode": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Fixed Assets List	FixedAssetResponse
204	No Content	No Fixed Assets were found	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

UpdateCleanStatus

shell

# You can also use wget
curl -X PATCH /operations/rooms/clean_status/{room_id}?IsClean=true \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/operations/rooms/clean_status/{room_id}', params={
  'IsClean': 'true'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PATCH /operations/rooms/clean_status/{room_id}

This endpoint is used to change the clean status of a given room

Parameters

Name	In	Type	Required	Description
room_id	path	integer(int32)	true	Room identifier
IsClean	query	boolean	true	Is the Room clean

Responses

Status	Meaning	Description	Schema
200	OK	Status updated sucessfully	None
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

PaxByRoom

Endpoint related to managing information from the occupants in a Reservation. They might be referred also as Pax, ReservationPax and PaxByRoom

GetPax

shell

# You can also use wget
curl -X GET /pxr?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/pxr', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/pxr";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /pxr

This endpoint will return the reservationPax info given a Hotel code and an identifier, RoomNumber or stayDate

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
room_number	query	string	false	Room number filter
pms_id	query	integer(int32)	false	Occupant Identifier
ReservationId	query	integer(int32)	false	Reservation Identifier
arrivalDate	query	string(date-time)	false	Arrival date
exitDate	query	string(date-time)	false	Exit date
email	query	string	false	Email filter
stayDate	query	string(date-time)	false	Date between ArrivalDate and ExitDate
ReservationStatus	query	array[string]	false	Reservation status filter

200 Response

{
  "pmS_id": 0,
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "sex": "string",
  "paxType": "string",
  "arrival": "2019-08-24T14:15:22Z",
  "exit": "2019-08-24T14:15:22Z",
  "birthDate": "2019-08-24T14:15:22Z",
  "nationality": "string",
  "birthCountry": "string",
  "countryResidence": "string",
  "documentID": "string",
  "email": "string",
  "address": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "phone": "string",
  "ad": 0,
  "jr": 0,
  "bb": 0,
  "ch": 0,
  "reservation_id": 0,
  "reservationStatus": "string",
  "rsvStatusCode": 0,
  "room_number": "string",
  "room_type": "string",
  "salesDate": "2019-08-24T14:15:22Z",
  "res_channel": "string",
  "res_agency": "string",
  "board_type": "string",
  "comments": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of filtered Pax	PaxbyRoomResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

UpdatePax

shell

# You can also use wget
curl -X PATCH /pxr?CenterCode=string&pms_id=0 \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/pxr', params={
  'CenterCode': 'string',  'pms_id': '0'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PATCH /pxr

This endpoint will update the ReservationPax email and marketing_consent attributes

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
pms_id	query	integer(int32)	true	Occupant Identifier
email	query	string(email)	false	New Email
marketing_consent	query	boolean	false	If the Pax accepts marketing emails

Responses

Status	Meaning	Description	Schema
200	OK	Pax updated successfully	None
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

AddPax

shell

# You can also use wget
curl -X POST /pxr \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/pxr', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/pxr";

      string json = @"{
  ""reservationId"": 0,
  ""occupants"": [
    {
      ""name"": ""string"",
      ""surname1"": ""string"",
      ""surname2"": ""string"",
      ""birthDate"": ""2019-08-24T14:15:22Z"",
      ""documentID"": ""string"",
      ""expeditionDateDocument"": ""2019-08-24T14:15:22Z"",
      ""address"": ""string"",
      ""postalCode"": ""string"",
      ""state"": ""string"",
      ""phone"": ""string"",
      ""country"": ""string"",
      ""nationality"": ""string"",
      ""paxType"": ""AD"",
      ""sex"": ""string"",
      ""email"": ""user@example.com"",
      ""repeaterClient"": false,
      ""primaryPax"": true,
      ""authDataExchange"": true,
      ""authReceiveAdvertising"": true,
      ""authMessageAndPhone"": true,
      ""authLocalization"": true
    }
  ]
}";
      PaxPost content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(PaxPost content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(PaxPost content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /pxr

This endpoint will add a Pax to a Reservation

Body parameter

{
  "reservationId": 0,
  "occupants": [
    {
      "name": "string",
      "surname1": "string",
      "surname2": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "documentID": "string",
      "expeditionDateDocument": "2019-08-24T14:15:22Z",
      "address": "string",
      "postalCode": "string",
      "state": "string",
      "phone": "string",
      "country": "string",
      "nationality": "string",
      "paxType": "AD",
      "sex": "string",
      "email": "user@example.com",
      "repeaterClient": false,
      "primaryPax": true,
      "authDataExchange": true,
      "authReceiveAdvertising": true,
      "authMessageAndPhone": true,
      "authLocalization": true
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	PaxPost	false	none

200 Response

{
  "pmS_id": 0,
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "sex": "string",
  "paxType": "string",
  "arrival": "2019-08-24T14:15:22Z",
  "exit": "2019-08-24T14:15:22Z",
  "birthDate": "2019-08-24T14:15:22Z",
  "nationality": "string",
  "birthCountry": "string",
  "countryResidence": "string",
  "documentID": "string",
  "email": "string",
  "address": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "phone": "string",
  "ad": 0,
  "jr": 0,
  "bb": 0,
  "ch": 0,
  "reservation_id": 0,
  "reservationStatus": "string",
  "rsvStatusCode": 0,
  "room_number": "string",
  "room_type": "string",
  "salesDate": "2019-08-24T14:15:22Z",
  "res_channel": "string",
  "res_agency": "string",
  "board_type": "string",
  "comments": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Pax added succesfully	PaxbyRoomResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

PutPax

shell

# You can also use wget
curl -X PUT /pxr \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/pxr', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }



    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/pxr";


      string json = @"{
  ""pmS_id"": 0,
  ""occupant"": {
    ""name"": ""string"",
    ""surname1"": ""string"",
    ""surname2"": ""string"",
    ""birthDate"": ""2019-08-24T14:15:22Z"",
    ""documentID"": ""string"",
    ""expeditionDateDocument"": ""2019-08-24T14:15:22Z"",
    ""address"": ""string"",
    ""postalCode"": ""string"",
    ""state"": ""string"",
    ""phone"": ""string"",
    ""country"": ""string"",
    ""nationality"": ""string"",
    ""paxType"": ""AD"",
    ""sex"": ""string"",
    ""email"": ""user@example.com"",
    ""repeaterClient"": false,
    ""primaryPax"": true,
    ""authDataExchange"": true,
    ""authReceiveAdvertising"": true,
    ""authMessageAndPhone"": true,
    ""authLocalization"": true
  }
}";
      PaxPut content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);


    }

    /// Performs a PUT Request
    public async Task PutAsync(int id, PaxPut content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);

        //Return response
        return await DeserializeObject(response);
    }


    /// Serialize an object to Json
    private StringContent SerializeObject(PaxPut content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /pxr

This endpoint will update a Pax given its identifier and a complete Pax data. Fields not provided will not retain previous data

Body parameter

{
  "pmS_id": 0,
  "occupant": {
    "name": "string",
    "surname1": "string",
    "surname2": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "documentID": "string",
    "expeditionDateDocument": "2019-08-24T14:15:22Z",
    "address": "string",
    "postalCode": "string",
    "state": "string",
    "phone": "string",
    "country": "string",
    "nationality": "string",
    "paxType": "AD",
    "sex": "string",
    "email": "user@example.com",
    "repeaterClient": false,
    "primaryPax": true,
    "authDataExchange": true,
    "authReceiveAdvertising": true,
    "authMessageAndPhone": true,
    "authLocalization": true
  }
}

Parameters

Name	In	Type	Required	Description
body	body	PaxPut	false	none

200 Response

{
  "pmS_id": 0,
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "sex": "string",
  "paxType": "string",
  "arrival": "2019-08-24T14:15:22Z",
  "exit": "2019-08-24T14:15:22Z",
  "birthDate": "2019-08-24T14:15:22Z",
  "nationality": "string",
  "birthCountry": "string",
  "countryResidence": "string",
  "documentID": "string",
  "email": "string",
  "address": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "phone": "string",
  "ad": 0,
  "jr": 0,
  "bb": 0,
  "ch": 0,
  "reservation_id": 0,
  "reservationStatus": "string",
  "rsvStatusCode": 0,
  "room_number": "string",
  "room_type": "string",
  "salesDate": "2019-08-24T14:15:22Z",
  "res_channel": "string",
  "res_agency": "string",
  "board_type": "string",
  "comments": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Pax modified succesfully	PaxbyRoomResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Prices

Endpoint related to managing the Prices from the reservations

GetPrice

shell

# You can also use wget
curl -X GET /prices?ReservationId=0 \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/prices', params={
  'ReservationId': '0'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/prices";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /prices

This endpoint will return the Prices info given a ReservationId. If Contract number is provided in the response, the price is from a contract.

Parameters

Name	In	Type	Required	Description
ReservationId	query	integer(int32)	true	Reservation Identifier
PriceType_id	query	string	false	Price Type identifier

200 Response

{
  "priceId": 0,
  "reservationId": 0,
  "contractId": 0,
  "contractNumber": "string",
  "dailyPrice": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "priceType_id": "string",
  "paxType": "string",
  "invStatus_id_fk": 0,
  "invoiceStatus": "string",
  "roomType": "string",
  "boardType": "string",
  "currency": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of prices	PricesResponse
204	No Content	No prices were found	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

AddPrice

shell

# You can also use wget
curl -X POST /prices \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/prices', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/prices";

      string json = @"{
  ""reservationId"": 0,
  ""pricesList"": [
    {
      ""date"": ""2019-08-24T14:15:22Z"",
      ""amount"": 0,
      ""currency"": ""string"",
      ""taxes"": 0
    }
  ]
}";
      PricePost content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(PricePost content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(PricePost content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /prices

This endpoint will add a ManualPrice to a Reservation given the ReservationId

Body parameter

{
  "reservationId": 0,
  "pricesList": [
    {
      "date": "2019-08-24T14:15:22Z",
      "amount": 0,
      "currency": "string",
      "taxes": 0
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	PricePost	false	none

200 Response

{
  "priceId": 0,
  "reservationId": 0,
  "contractId": 0,
  "contractNumber": "string",
  "dailyPrice": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "priceType_id": "string",
  "paxType": "string",
  "invStatus_id_fk": 0,
  "invoiceStatus": "string",
  "roomType": "string",
  "boardType": "string",
  "currency": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	ManualPrice added successfully	PricesResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Rates

Endpoint related to managing the Rates

GetRatesList

shell

# You can also use wget
curl -X GET /rates?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/rates', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/rates";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /rates

This endpoint will return a list of Rates given the CenterCode and can be filtered, returns at MAX 2000 objects

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Hotel code
DateFrom	query	string(date-time)	false	Start date filter
DateUntil	query	string(date-time)	false	Ent date filter
RoomTypesCode	query	array[string]	false	List of Room types codes to filter
BoardTypesCode	query	array[string]	false	List of Board types codes to filter
RateTypesCode	query	array[string]	false	List of Rate types codes to filter
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "rateId": 0,
  "center_id_fk": 0,
  "centerCode": "string",
  "date": "2019-08-24T14:15:22Z",
  "roomTypeCenter_id_fk": 0,
  "roomTypeCenterCode": "string",
  "boardTypeCenter_id_fk": 0,
  "boardTypeCenterCode": "string",
  "rateType_id_fk": 0,
  "rateTypeCode": "string",
  "description": "string",
  "roomRate": 0,
  "adRate": 0,
  "jrRate": 0,
  "chRate": 0,
  "bbRate": 0,
  "lastUpdate": "2019-08-24T14:15:22Z"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of filtered Rates	RatesResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetRateTypes

shell

# You can also use wget
curl -X GET /rates/ratetypes \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/rates/ratetypes', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/rates/ratetypes";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /rates/ratetypes

This endpoint will return a list of Ratetypes that can be filtered

Parameters

Name	In	Type	Required	Description
PricePer	query	array[string]	false	List of Price Type identifier to filter
PriceTypes	query	array[string]	false	List of Discount type to filter (b: base, p: percentage
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "rateType_id_pk": 0,
  "name": "string",
  "pricePer": "string",
  "discountType": "string",
  "associatedRateType_id_fk": 0,
  "associatedRateType": "string",
  "quantity": 0,
  "valueType": true,
  "valueTypeCode": "string",
  "position": 0,
  "description": "string",
  "locked": true,
  "lockRetainersReturn": true,
  "advertismentCheckIn": true,
  "advertismentCheckInText": "string",
  "paymentPercentage": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	List of filtered Rate types	RateTypesResponse
204	No Content	No Rate types were found with applied filters	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Reservations

Endpoint related to managing and retrieving information from Reservations

GetReservations

shell

# You can also use wget
curl -X GET /reservations?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/reservations', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/reservations";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /reservations

This endpoint will return a list of filtered Reservations given a CenterCode. You can specify a date ranges using the Arrival and Exit dates

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
ReservationId	query	integer(int32)	false	Reservation identifier
Reference	query	string	false	Reservation reference
Surname	query	string	false	Responsible surname filter
RoomNumber	query	string	false	Room number filter
ArrivalDateFrom	query	string(date-time)	false	Arrival date from
ArrivalDateTo	query	string(date-time)	false	Arrival date to
ExitDateFrom	query	string(date-time)	false	Exit date from
ExitDateTo	query	string(date-time)	false	Exit date to
ReservationStatus	query	array[string]	false	Reservation status filter
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "reservationId": 0,
  "reference": "string",
  "reservationNumber": 0,
  "year": 0,
  "arrivalDate": "2019-08-24T14:15:22Z",
  "exitDate": "2019-08-24T14:15:22Z",
  "rsvStatus_id": 0,
  "rsvStatus_code": "string",
  "responsible": "string",
  "paxHab": 0,
  "email": "string",
  "preferences": "string",
  "comments": "string",
  "roomNumber": "string",
  "fixedRoom": true,
  "centerCode": "string",
  "centerNumberPrefix": "string",
  "reservationType": "string",
  "desglose": 0,
  "roomTypeFra": "string",
  "roomTypeUse": "string",
  "boardTypeFra": "string",
  "boardTypeUse": "string",
  "ad": 0,
  "jr": 0,
  "ch": 0,
  "bb": 0,
  "preCheckIn": true,
  "salesChannel_id": 0,
  "salesChannel": "string",
  "campaign_id": 0,
  "campaign": "string",
  "crmSegment_id": 0,
  "crmSegment": "string",
  "triplet": {
    "clientComposition_id": 0,
    "ttoO_id": 0,
    "ttoO_code": "string",
    "agency_id": 0,
    "agency_code": "string",
    "customer_id": 0,
    "customer_code": "string"
  },
  "occupants": [
    {
      "reservationPaxId": 0,
      "position": 0,
      "name": "string",
      "surname1": "string",
      "surname2": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "documentType": "string",
      "documentID": "string",
      "expeditionDateDocument": "2019-08-24T14:15:22Z",
      "address": "string",
      "postalCode": "string",
      "state": "string",
      "country": "string",
      "nationality": "string",
      "language": "string",
      "paxType": "string",
      "sex": "string",
      "email": "string",
      "phone": "string",
      "primaryPax": true,
      "authDataExchange": true,
      "authReceiveAdvertising": true,
      "authMessageAndPhone": true,
      "authLocalization": true,
      "cardexId": 0
    }
  ],
  "observations": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Reservation list	ReservationResponse
204	No Content	No Reservations were found	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

CreateReservation

shell

# You can also use wget
curl -X POST /reservations \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/reservations', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/reservations";

      string json = @"{
  ""desglose"": 0,
  ""year"": 0,
  ""arrivalDate"": ""2019-08-24T14:15:22Z"",
  ""exitDate"": ""2019-08-24T14:15:22Z"",
  ""centerCode"": ""string"",
  ""salesDate"": ""2019-08-24T14:15:22Z"",
  ""localizer"": ""string"",
  ""crS_NotificationSended"": true,
  ""responsible"": ""string"",
  ""crM_SegmentCode"": ""string"",
  ""futureProduction"": true,
  ""campaignCode"": ""string"",
  ""sentToPushTech"": false,
  ""dayUse"": true,
  ""preCheckin"": false,
  ""sentToReviewPro"": false,
  ""triplet"": {
    ""tourOperator"": ""string"",
    ""agency"": ""string"",
    ""customer"": ""string""
  },
  ""roomList"": [
    {
      ""roomNumber"": ""string"",
      ""isFixed"": true,
      ""groupIdentifier"": ""string"",
      ""roomTypeFRA"": ""string"",
      ""roomTypeUSE"": ""string"",
      ""boardType"": ""string"",
      ""rateCode"": ""string"",
      ""desglose"": 0,
      ""ad"": 0,
      ""jr"": 0,
      ""ch"": 0,
      ""bb"": 0,
      ""commentList"": [
        ""string""
      ],
      ""preferencesList"": [
        ""string""
      ],
      ""paxes"": [
        {
          ""name"": ""string"",
          ""surname1"": ""string"",
          ""surname2"": ""string"",
          ""birthDate"": ""2019-08-24T14:15:22Z"",
          ""documentID"": ""string"",
          ""expeditionDateDocument"": ""2019-08-24T14:15:22Z"",
          ""address"": ""string"",
          ""postalCode"": ""string"",
          ""state"": ""string"",
          ""phone"": ""string"",
          ""country"": ""string"",
          ""nationality"": ""string"",
          ""paxType"": ""AD"",
          ""sex"": ""string"",
          ""email"": ""user@example.com"",
          ""repeaterClient"": false,
          ""primaryPax"": true,
          ""authDataExchange"": true,
          ""authReceiveAdvertising"": true,
          ""authMessageAndPhone"": true,
          ""authLocalization"": true
        }
      ],
      ""prices"": [
        {
          ""date"": ""2019-08-24T14:15:22Z"",
          ""amount"": 0,
          ""currency"": ""string"",
          ""taxes"": 0
        }
      ],
      ""extras"": [
        {
          ""postMappingSaleServiceCode"": ""string"",
          ""startDate"": ""2019-08-24T14:15:22Z"",
          ""endDate"": ""2019-08-24T14:15:22Z"",
          ""description"": ""string"",
          ""quantity"": 0,
          ""value"": 0,
          ""chargeType"": ""string""
        }
      ]
    }
  ],
  ""retainersList"": [
    {
      ""code"": ""string"",
      ""retainerBreakDown"": 0,
      ""rAmount"": 0,
      ""paymentMethod"": ""string"",
      ""observations"": ""string"",
      ""retainerDateTime"": ""2019-08-24T14:15:22Z"",
      ""retainerType_id"": 0,
      ""retainerDate"": ""string"",
      ""formatDate"": ""string""
    }
  ]
}";
      ReservationsPost content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(ReservationsPost content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(ReservationsPost content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /reservations

This endpoint will Create a Reservation with all the attributes from the body. If multiple rooms are provided, a new reservation will be created for each room

Body parameter

{
  "desglose": 0,
  "year": 0,
  "arrivalDate": "2019-08-24T14:15:22Z",
  "exitDate": "2019-08-24T14:15:22Z",
  "centerCode": "string",
  "salesDate": "2019-08-24T14:15:22Z",
  "localizer": "string",
  "crS_NotificationSended": true,
  "responsible": "string",
  "crM_SegmentCode": "string",
  "futureProduction": true,
  "campaignCode": "string",
  "sentToPushTech": false,
  "dayUse": true,
  "preCheckin": false,
  "sentToReviewPro": false,
  "triplet": {
    "tourOperator": "string",
    "agency": "string",
    "customer": "string"
  },
  "roomList": [
    {
      "roomNumber": "string",
      "isFixed": true,
      "groupIdentifier": "string",
      "roomTypeFRA": "string",
      "roomTypeUSE": "string",
      "boardType": "string",
      "rateCode": "string",
      "desglose": 0,
      "ad": 0,
      "jr": 0,
      "ch": 0,
      "bb": 0,
      "commentList": [
        "string"
      ],
      "preferencesList": [
        "string"
      ],
      "paxes": [
        {
          "name": "string",
          "surname1": "string",
          "surname2": "string",
          "birthDate": "2019-08-24T14:15:22Z",
          "documentID": "string",
          "expeditionDateDocument": "2019-08-24T14:15:22Z",
          "address": "string",
          "postalCode": "string",
          "state": "string",
          "phone": "string",
          "country": "string",
          "nationality": "string",
          "paxType": "AD",
          "sex": "string",
          "email": "user@example.com",
          "repeaterClient": false,
          "primaryPax": true,
          "authDataExchange": true,
          "authReceiveAdvertising": true,
          "authMessageAndPhone": true,
          "authLocalization": true
        }
      ],
      "prices": [
        {
          "date": "2019-08-24T14:15:22Z",
          "amount": 0,
          "currency": "string",
          "taxes": 0
        }
      ],
      "extras": [
        {
          "postMappingSaleServiceCode": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "endDate": "2019-08-24T14:15:22Z",
          "description": "string",
          "quantity": 0,
          "value": 0,
          "chargeType": "string"
        }
      ]
    }
  ],
  "retainersList": [
    {
      "code": "string",
      "retainerBreakDown": 0,
      "rAmount": 0,
      "paymentMethod": "string",
      "observations": "string",
      "retainerDateTime": "2019-08-24T14:15:22Z",
      "retainerType_id": 0,
      "retainerDate": "string",
      "formatDate": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	ReservationsPost	false	none

200 Response

{
  "reservationId": 0,
  "reference": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Reservation created successfully	ReservationPostResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

UpdateReservation

shell

# You can also use wget
curl -X PATCH /reservations/{reservationId} \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/reservations/{reservationId}', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PATCH /reservations/{reservationId}

This endpoint will update the Reservation observations and Preferences given a ReservationId. Does not override previous comment values. The Reservation must not have a room assigned and The ReservationStatus must be New or Confirmed

Parameters

Name	In	Type	Required	Description
reservationId	path	integer(int32)	true	Reservation Identifier
newBoardTypeUse	query	string	false	New BoardType use code
newRoomTypeUse	query	string	false	New RoomType use code
observations	query	array[string]	false	List of new observations
Preferences	query	array[string]	false	List of new preferences
PreCheckin	query	boolean	false	Pre-CheckIn

200 Response

{
  "reservationId": 0,
  "reference": "string",
  "reservationNumber": 0,
  "year": 0,
  "arrivalDate": "2019-08-24T14:15:22Z",
  "exitDate": "2019-08-24T14:15:22Z",
  "rsvStatus_id": 0,
  "rsvStatus_code": "string",
  "responsible": "string",
  "paxHab": 0,
  "email": "string",
  "preferences": "string",
  "comments": "string",
  "roomNumber": "string",
  "fixedRoom": true,
  "centerCode": "string",
  "centerNumberPrefix": "string",
  "reservationType": "string",
  "desglose": 0,
  "roomTypeFra": "string",
  "roomTypeUse": "string",
  "boardTypeFra": "string",
  "boardTypeUse": "string",
  "ad": 0,
  "jr": 0,
  "ch": 0,
  "bb": 0,
  "preCheckIn": true,
  "salesChannel_id": 0,
  "salesChannel": "string",
  "campaign_id": 0,
  "campaign": "string",
  "crmSegment_id": 0,
  "crmSegment": "string",
  "triplet": {
    "clientComposition_id": 0,
    "ttoO_id": 0,
    "ttoO_code": "string",
    "agency_id": 0,
    "agency_code": "string",
    "customer_id": 0,
    "customer_code": "string"
  },
  "occupants": [
    {
      "reservationPaxId": 0,
      "position": 0,
      "name": "string",
      "surname1": "string",
      "surname2": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "documentType": "string",
      "documentID": "string",
      "expeditionDateDocument": "2019-08-24T14:15:22Z",
      "address": "string",
      "postalCode": "string",
      "state": "string",
      "country": "string",
      "nationality": "string",
      "language": "string",
      "paxType": "string",
      "sex": "string",
      "email": "string",
      "phone": "string",
      "primaryPax": true,
      "authDataExchange": true,
      "authReceiveAdvertising": true,
      "authMessageAndPhone": true,
      "authLocalization": true,
      "cardexId": 0
    }
  ],
  "observations": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Reservation updated successfully	ReservationResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

CancelReservation

shell

# You can also use wget
curl -X DELETE /reservations/{reservationId} \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/reservations/{reservationId}', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }




    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/reservations/{reservationId}";

      await DeleteAsync(id, url);
    }

    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");

        //Return response
        await DeserializeObject(response);
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /reservations/{reservationId}

This endpoint will Cancel a Reservation given a ReservationId

Parameters

Name	In	Type	Required	Description
reservationId	path	integer(int32)	true	Reservation Identifier
cancellationDate	query	string(date-time)	false	Cancellation date

200 Response

{
  "reservationId": 0,
  "reference": "string",
  "reservationNumber": 0,
  "year": 0,
  "arrivalDate": "2019-08-24T14:15:22Z",
  "exitDate": "2019-08-24T14:15:22Z",
  "rsvStatus_id": 0,
  "rsvStatus_code": "string",
  "responsible": "string",
  "paxHab": 0,
  "email": "string",
  "preferences": "string",
  "comments": "string",
  "roomNumber": "string",
  "fixedRoom": true,
  "centerCode": "string",
  "centerNumberPrefix": "string",
  "reservationType": "string",
  "desglose": 0,
  "roomTypeFra": "string",
  "roomTypeUse": "string",
  "boardTypeFra": "string",
  "boardTypeUse": "string",
  "ad": 0,
  "jr": 0,
  "ch": 0,
  "bb": 0,
  "preCheckIn": true,
  "salesChannel_id": 0,
  "salesChannel": "string",
  "campaign_id": 0,
  "campaign": "string",
  "crmSegment_id": 0,
  "crmSegment": "string",
  "triplet": {
    "clientComposition_id": 0,
    "ttoO_id": 0,
    "ttoO_code": "string",
    "agency_id": 0,
    "agency_code": "string",
    "customer_id": 0,
    "customer_code": "string"
  },
  "occupants": [
    {
      "reservationPaxId": 0,
      "position": 0,
      "name": "string",
      "surname1": "string",
      "surname2": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "documentType": "string",
      "documentID": "string",
      "expeditionDateDocument": "2019-08-24T14:15:22Z",
      "address": "string",
      "postalCode": "string",
      "state": "string",
      "country": "string",
      "nationality": "string",
      "language": "string",
      "paxType": "string",
      "sex": "string",
      "email": "string",
      "phone": "string",
      "primaryPax": true,
      "authDataExchange": true,
      "authReceiveAdvertising": true,
      "authMessageAndPhone": true,
      "authLocalization": true,
      "cardexId": 0
    }
  ],
  "observations": [
    "string"
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Reservation canceled successfully	ReservationResponse
204	No Content	No Content	None
400	Bad Request	Reservation could not be cancelled, see response error	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetTTOOAgency

shell

# You can also use wget
curl -X GET /ttoo_agency \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/ttoo_agency', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/ttoo_agency";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /ttoo_agency

This endpoint will return a list of all the Tour operators and Agencies

200 Response

{
  "documentType_id": 0,
  "description": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	List of DocumentTypes	DocumentTypesResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Retainers

Endpoint related to managing the Retainers from the Reservations. The Retainers are, in essence, the bill of the stay and a Reservation can have multiple retainers.

GetRetainersList

shell

# You can also use wget
curl -X GET /retainers \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/retainers', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/retainers";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /retainers

This endpoint will return the Retainers info given a ReservationId, or RetainerNumber

Parameters

Name	In	Type	Required	Description
ReservationId	query	integer(int32)	false	Reservation identifier
RetainerNumber	query	string	false	Retainer number
RetainerDate	query	string(date-time)	false	Retainer Date

200 Response

{
  "reservationId": 0,
  "reservationReference": "string",
  "retainerId": 0,
  "retainerNumber": "string",
  "retainerType_id": 0,
  "retainerType": "string",
  "amount": 0,
  "date": "2019-08-24T14:15:22Z",
  "retainerStatus_id": 0,
  "retainerStatus": "string",
  "observations": "string",
  "paymentMethod": "string",
  "cashRegister": true,
  "invStatus_id_fk": 0,
  "invoiceStatus": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Retainers list	RetainersResponse
204	No Content	No retainers were found	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

AddRetainer

shell

# You can also use wget
curl -X POST /retainers \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/retainers', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/retainers";

      string json = @"{
  ""reservationId"": 0,
  ""retainerCRX"": {
    ""code"": ""string"",
    ""retainerBreakDown"": 0,
    ""rAmount"": 0,
    ""paymentMethod"": ""string"",
    ""observations"": ""string"",
    ""retainerDateTime"": ""2019-08-24T14:15:22Z"",
    ""retainerType_id"": 0,
    ""retainerDate"": ""string"",
    ""formatDate"": ""string""
  }
}";
      RetainersPost content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(RetainersPost content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(RetainersPost content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /retainers

This endpoint will add a Retainer to a Reservation given the ReservationId

Body parameter

{
  "reservationId": 0,
  "retainerCRX": {
    "code": "string",
    "retainerBreakDown": 0,
    "rAmount": 0,
    "paymentMethod": "string",
    "observations": "string",
    "retainerDateTime": "2019-08-24T14:15:22Z",
    "retainerType_id": 0,
    "retainerDate": "string",
    "formatDate": "string"
  }
}

Parameters

Name	In	Type	Required	Description
body	body	RetainersPost	false	none

200 Response

{
  "reservationId": 0,
  "reservationReference": "string",
  "retainerId": 0,
  "retainerNumber": "string",
  "retainerType_id": 0,
  "retainerType": "string",
  "amount": 0,
  "date": "2019-08-24T14:15:22Z",
  "retainerStatus_id": 0,
  "retainerStatus": "string",
  "observations": "string",
  "paymentMethod": "string",
  "cashRegister": true,
  "invStatus_id_fk": 0,
  "invoiceStatus": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Reservation retainers list	RetainersResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

RRHH

Endpoint related to RRHH and Employees information

AddEmployee

shell

# You can also use wget
curl -X POST /RRHH/employees \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/RRHH/employees', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/RRHH/employees";


      await PostAsync(null, url);

    }

    /// Performs a POST Request
    public async Task PostAsync(undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /RRHH/employees

This endpoint will create an Employee given the information provided. If the Employee already exists, only the Contracts are added in case they don’t overlap with existing ones

Body parameter

AppCustomer_id: 0
EmployeeCode: string
HiringType: string
Name: string
Surname1: string
Surname2: string
Document: string
SSNumber: string
DossierCode: string
BirthDate: 2019-08-24T14:15:22Z
Gender: s
BankAccount: string
Address: string
PostalCode: string
City: string
Country: string
Phone: string
Mobile: string
Email: user@example.com
EmergencyPhone: string
EmployeeImage: string
Contracts:
  - centerCode: string
    department_id: 0
    contractType_id: 0
    dailyWorkHours: 0
    weeklyWorkDays: 0
    initialDate: 2019-08-24T14:15:22Z
    position_id: 0
    vacationDays: 0
    seniorityDate: 2019-08-24T14:15:22Z
    endDate: 2019-08-24T14:15:22Z
    endDateVacation: 2019-08-24T14:15:22Z
    wageLevel: 0

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» AppCustomer_id	body	integer(int32)	true	AppCustomer identifier
» EmployeeCode	body	string	true	Employee code
» HiringType	body	string	true	Hiring type
» Name	body	string	true	Name
» Surname1	body	string	true	Surname 1
» Surname2	body	string	false	Surname 2
» Document	body	string	false	Employee document
» SSNumber	body	string	false	Social security number
» DossierCode	body	string	false	Dossier code
» BirthDate	body	string(date-time)	false	Birth date
» Gender	body	string	false	Gender F/M
» BankAccount	body	string	false	Bank Account
» Address	body	string	false	Address
» PostalCode	body	string	false	Postal code
» City	body	string	false	City
» Country	body	string	false	Country ISO3
» Phone	body	string	false	Phone
» Mobile	body	string	false	Mobile
» Email	body	string(email)	false	Email
» EmergencyPhone	body	string	false	Emergency phone
» EmployeeImage	body	string(binary)	false	Employee image
» Contracts	body	[RRHH_ContractPost]	false	List of contracts
»» centerCode	body	string	true	Center code
»» department_id	body	integer(int32)	true	Department identifier
»» contractType_id	body	integer(int32)	true	Contract Type identifier
»» dailyWorkHours	body	number(double)	true	Daily work hours
»» weeklyWorkDays	body	integer(int32)	true	Weekly work hours
»» initialDate	body	string(date-time)	true	Initial date
»» position_id	body	integer(int32)¦null	false	Position identifier
»» vacationDays	body	number(double)¦null	false	Annual vacation days
»» seniorityDate	body	string(date-time)¦null	false	Seniority date
»» endDate	body	string(date-time)¦null	false	End date
»» endDateVacation	body	string(date-time)¦null	false	End date with vacations
»» wageLevel	body	integer(int32)¦null	false	Wage level

200 Response

{
  "employee_id": 0,
  "employeeCode": "string",
  "hiringType": "string",
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "document": "string",
  "ssNumber": "string",
  "dossierCode": "string",
  "birthDate": "2019-08-24T14:15:22Z",
  "gender": "string",
  "bankAccount": "string",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "country": "string",
  "phone": "string",
  "mobile": "string",
  "email": "string",
  "emergencyPhone": "string",
  "contracts": [
    {
      "contract_id_pk": 0,
      "centerCode": "string",
      "department_id": 0,
      "department": "string",
      "initialDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "endDateVacation": "2019-08-24T14:15:22Z",
      "contractType": "string",
      "contractType_id": 0,
      "dailyWorkHours": 0,
      "weeklyWorkDays": 0,
      "finishContractReason": "string",
      "position": "string",
      "wageLevel": 0,
      "extension": true,
      "seniorityDate": "2019-08-24T14:15:22Z",
      "onLeave": true,
      "guarenteedPeriod": 0,
      "testContratEndDate": "2019-08-24T14:15:22Z",
      "annualVacation": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Created Employee	EmployeeResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetEmployees

shell

# You can also use wget
curl -X GET /RRHH/employees \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/RRHH/employees', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/RRHH/employees";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /RRHH/employees

This endpoint will return a list of Employees with their Contracts

Parameters

Name	In	Type	Required	Description
Employee_code	query	string	false	Employee code
Employee_id	query	integer(int32)	false	Employee identifier
ActiveDate	query	string(date-time)	false	Active date // None by default
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "employee_id": 0,
  "employeeCode": "string",
  "hiringType": "string",
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "document": "string",
  "ssNumber": "string",
  "dossierCode": "string",
  "birthDate": "2019-08-24T14:15:22Z",
  "gender": "string",
  "bankAccount": "string",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "country": "string",
  "phone": "string",
  "mobile": "string",
  "email": "string",
  "emergencyPhone": "string",
  "contracts": [
    {
      "contract_id_pk": 0,
      "centerCode": "string",
      "department_id": 0,
      "department": "string",
      "initialDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "endDateVacation": "2019-08-24T14:15:22Z",
      "contractType": "string",
      "contractType_id": 0,
      "dailyWorkHours": 0,
      "weeklyWorkDays": 0,
      "finishContractReason": "string",
      "position": "string",
      "wageLevel": 0,
      "extension": true,
      "seniorityDate": "2019-08-24T14:15:22Z",
      "onLeave": true,
      "guarenteedPeriod": 0,
      "testContratEndDate": "2019-08-24T14:15:22Z",
      "annualVacation": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	List of Employees	EmployeeResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

UpdateEmployee

shell

# You can also use wget
curl -X PATCH /RRHH/employees/{employeeId} \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/RRHH/employees/{employeeId}', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }





    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PATCH /RRHH/employees/{employeeId}

This endpoint will modify an Employee given it’s unique identifier. Only provided values will be updated

Body parameter

EmployeeCode: string
HiringType: string
Name: string
Surname1: string
Surname2: string
Document: string
SSNumber: string
DossierCode: string
BirthDate: 2019-08-24T14:15:22Z
Gender: s
BankAccount: string
Address: string
PostalCode: string
City: string
Country: string
Phone: string
Mobile: string
Email: user@example.com
EmergencyPhone: string
EmployeeImage: string

Parameters

Name	In	Type	Required	Description
employeeId	path	integer(int32)	true	Employee identifier
body	body	object	false	none
» EmployeeCode	body	string	false	Employee code
» HiringType	body	string	false	Hiring type
» Name	body	string	false	Name
» Surname1	body	string	false	Surname 1
» Surname2	body	string	false	Surname 2
» Document	body	string	false	Employee document
» SSNumber	body	string	false	Social security number
» DossierCode	body	string	false	Dossier code
» BirthDate	body	string(date-time)	false	Birth date
» Gender	body	string	false	Gender F/M
» BankAccount	body	string	false	Bank Account
» Address	body	string	false	Address
» PostalCode	body	string	false	Postal code
» City	body	string	false	City
» Country	body	string	false	Country ISO3
» Phone	body	string	false	Phone
» Mobile	body	string	false	Mobile
» Email	body	string(email)	false	Email
» EmergencyPhone	body	string	false	Emergency phone
» EmployeeImage	body	string(binary)	false	Employee image

200 Response

{
  "employee_id": 0,
  "employeeCode": "string",
  "hiringType": "string",
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "document": "string",
  "ssNumber": "string",
  "dossierCode": "string",
  "birthDate": "2019-08-24T14:15:22Z",
  "gender": "string",
  "bankAccount": "string",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "country": "string",
  "phone": "string",
  "mobile": "string",
  "email": "string",
  "emergencyPhone": "string",
  "contracts": [
    {
      "contract_id_pk": 0,
      "centerCode": "string",
      "department_id": 0,
      "department": "string",
      "initialDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "endDateVacation": "2019-08-24T14:15:22Z",
      "contractType": "string",
      "contractType_id": 0,
      "dailyWorkHours": 0,
      "weeklyWorkDays": 0,
      "finishContractReason": "string",
      "position": "string",
      "wageLevel": 0,
      "extension": true,
      "seniorityDate": "2019-08-24T14:15:22Z",
      "onLeave": true,
      "guarenteedPeriod": 0,
      "testContratEndDate": "2019-08-24T14:15:22Z",
      "annualVacation": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Modified Employee	EmployeeResponse
204	No Content	Could not find the Employee	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

AddIncidence

shell

# You can also use wget
curl -X POST /RRHH/incidences \
  -H 'Content-Type: multipart/form-data' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/RRHH/incidences', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/RRHH/incidences";


      await PostAsync(null, url);

    }

    /// Performs a POST Request
    public async Task PostAsync(undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /RRHH/incidences

This endpoint will add an incidence to an Employee given the Employee code and department or a Contract identifier. CAUTION: Content-Type: multipart/form-data

Body parameter

CenterCode: string
Contract_id: 0
Employee_code: string
Department_id: 0
StartDate: 2019-08-24T14:15:22Z
EndDate: 2019-08-24T14:15:22Z
Quantity: 0
IncidenceType_id: 0
Group_id: 0
Description: string
IncidenceFile: string

Parameters

Name	In	Type	Required	Description
body	body	object	false	none
» CenterCode	body	string	true	Center code
» Contract_id	body	integer(int32)	false	Contract identifier
» Employee_code	body	string	false	Employee code
» Department_id	body	integer(int32)	false	Department identifier
» StartDate	body	string(date-time)	true	Start date
» EndDate	body	string(date-time)	true	End date
» Quantity	body	number(double)	true	Quantity
» IncidenceType_id	body	integer(int32)	true	IncidenceType identifier
» Group_id	body	integer(int32)	false	Group identifier
» Description	body	string	false	Description
» IncidenceFile	body	string(binary)	false	Inicidence file

200 Response

{
  "employee_id": 0,
  "employeeCode": "string",
  "hiringType": "string",
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "document": "string",
  "ssNumber": "string",
  "dossierCode": "string",
  "birthDate": "2019-08-24T14:15:22Z",
  "gender": "string",
  "bankAccount": "string",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "country": "string",
  "phone": "string",
  "mobile": "string",
  "email": "string",
  "emergencyPhone": "string",
  "contracts": [
    {
      "contract_id_pk": 0,
      "centerCode": "string",
      "department_id": 0,
      "department": "string",
      "initialDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "endDateVacation": "2019-08-24T14:15:22Z",
      "contractType": "string",
      "contractType_id": 0,
      "dailyWorkHours": 0,
      "weeklyWorkDays": 0,
      "finishContractReason": "string",
      "position": "string",
      "wageLevel": 0,
      "extension": true,
      "seniorityDate": "2019-08-24T14:15:22Z",
      "onLeave": true,
      "guarenteedPeriod": 0,
      "testContratEndDate": "2019-08-24T14:15:22Z",
      "annualVacation": 0
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Employee with it’s contracts	EmployeeResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

AddSchedule

shell

# You can also use wget
curl -X POST /RRHH/schedules \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/RRHH/schedules', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/RRHH/schedules";

      string json = @"{
  ""schedules"": [
    {
      ""centerCode"": ""string"",
      ""employeeCode"": ""string"",
      ""dateTime"": ""2019-08-24T14:15:22Z"",
      ""department"": ""string"",
      ""type"": 0
    }
  ]
}";
      SchedulePost content = JsonConvert.DeserializeObject(json);
      await PostAsync(content, url);


    }

    /// Performs a POST Request
    public async Task PostAsync(SchedulePost content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(SchedulePost content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /RRHH/schedules

This endpoint will add or modify an employee schedule given the Employee code and department

Body parameter

{
  "schedules": [
    {
      "centerCode": "string",
      "employeeCode": "string",
      "dateTime": "2019-08-24T14:15:22Z",
      "department": "string",
      "type": 0
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	SchedulePost	false	none

Responses

Status	Meaning	Description	Schema
200	OK	Successfully imported	None
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

ModifyContract

shell

# You can also use wget
curl -X PUT /RRHH/contracts/{contract_id} \
  -H 'Content-Type: application/json' \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/RRHH/contracts/{contract_id}', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }



    /// Make a dummy request
    public async Task MakePutRequest()
    {
      int id = 1;
      string url = "/RRHH/contracts/{contract_id}";


      string json = @"{
  ""centerCode"": ""string"",
  ""department_id"": 0,
  ""contractType_id"": 0,
  ""dailyWorkHours"": 0,
  ""weeklyWorkDays"": 0,
  ""initialDate"": ""2019-08-24T14:15:22Z"",
  ""position_id"": 0,
  ""vacationDays"": 0,
  ""seniorityDate"": ""2019-08-24T14:15:22Z"",
  ""endDate"": ""2019-08-24T14:15:22Z"",
  ""endDateVacation"": ""2019-08-24T14:15:22Z"",
  ""wageLevel"": 0
}";
      RRHH_ContractPost content = JsonConvert.DeserializeObject(json);
      var result = await PutAsync(id, content, url);


    }

    /// Performs a PUT Request
    public async Task PutAsync(int id, RRHH_ContractPost content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute PUT request
        HttpResponseMessage response = await Client.PutAsync(url + $"/{id}", jsonContent);

        //Return response
        return await DeserializeObject(response);
    }


    /// Serialize an object to Json
    private StringContent SerializeObject(RRHH_ContractPost content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

PUT /RRHH/contracts/{contract_id}

This endpoint will modify an existing contract provided a contract_id. If null values are provided on non-required fields, prior values will be kept.

Body parameter

{
  "centerCode": "string",
  "department_id": 0,
  "contractType_id": 0,
  "dailyWorkHours": 0,
  "weeklyWorkDays": 0,
  "initialDate": "2019-08-24T14:15:22Z",
  "position_id": 0,
  "vacationDays": 0,
  "seniorityDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "endDateVacation": "2019-08-24T14:15:22Z",
  "wageLevel": 0
}

Parameters

Name	In	Type	Required	Description
contract_id	path	integer(int32)	true	Employee contract identifier
body	body	RRHH_ContractPost	true	none

200 Response

[
  {
    "employee_id": 0,
    "employeeCode": "string",
    "hiringType": "string",
    "name": "string",
    "surname1": "string",
    "surname2": "string",
    "document": "string",
    "ssNumber": "string",
    "dossierCode": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "gender": "string",
    "bankAccount": "string",
    "address": "string",
    "postalCode": "string",
    "city": "string",
    "country": "string",
    "phone": "string",
    "mobile": "string",
    "email": "string",
    "emergencyPhone": "string",
    "contracts": [
      {
        "contract_id_pk": 0,
        "centerCode": "string",
        "department_id": 0,
        "department": "string",
        "initialDate": "2019-08-24T14:15:22Z",
        "endDate": "2019-08-24T14:15:22Z",
        "endDateVacation": "2019-08-24T14:15:22Z",
        "contractType": "string",
        "contractType_id": 0,
        "dailyWorkHours": 0,
        "weeklyWorkDays": 0,
        "finishContractReason": "string",
        "position": "string",
        "wageLevel": 0,
        "extension": true,
        "seniorityDate": "2019-08-24T14:15:22Z",
        "onLeave": true,
        "guarenteedPeriod": 0,
        "testContratEndDate": "2019-08-24T14:15:22Z",
        "annualVacation": 0
      }
    ]
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	Employee with it’s contracts	Inline
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[EmployeeResponse]	false	none	none
» employee_id	integer(int32)	false	none	Employee identifier
» employeeCode	string¦null	false	none	Employee code
» hiringType	string¦null	false	none	Hiring type
» name	string¦null	false	none	Name
» surname1	string¦null	false	none	Surname 1
» surname2	string¦null	false	none	Surname 2
» document	string¦null	false	none	Employee document
» ssNumber	string¦null	false	none	Social security number
» dossierCode	string¦null	false	none	Dossier code
» birthDate	string(date-time)¦null	false	none	Birth date
» gender	string¦null	false	none	Gender F/M
» bankAccount	string¦null	false	none	Bank Account
» address	string¦null	false	none	Address
» postalCode	string¦null	false	none	Postal code
» city	string¦null	false	none	City
» country	string¦null	false	none	Country ISO3
» phone	string¦null	false	none	Phone
» mobile	string¦null	false	none	Mobile
» email	string¦null	false	none	Email
» emergencyPhone	string¦null	false	none	Emergency phone
» contracts	[RRHH_ContractResponse]¦null	false	none	List of contracts
»» contract_id_pk	integer(int32)	false	none	Contract identifier
»» centerCode	string¦null	false	none	Center code
»» department_id	integer(int32)¦null	false	none	Department identifier
»» department	string¦null	false	none	Department
»» initialDate	string(date-time)¦null	false	none	Initial date
»» endDate	string(date-time)¦null	false	none	End date
»» endDateVacation	string(date-time)¦null	false	none	End date with vacations
»» contractType	string¦null	false	none	Contract Type
»» contractType_id	integer(int32)¦null	false	none	Contract Type identifier
»» dailyWorkHours	number(double)¦null	false	none	Daily work hours
»» weeklyWorkDays	integer(int32)¦null	false	none	Weekly work hours
»» finishContractReason	string¦null	false	none	Finish contract reason
»» position	string¦null	false	none	Position
»» wageLevel	integer(int32)¦null	false	none	Wage level
»» extension	boolean	false	none	is Extension
»» seniorityDate	string(date-time)¦null	false	none	Seniority date
»» onLeave	boolean	false	none	is OnLeave
»» guarenteedPeriod	integer(int32)¦null	false	none	GuarantedPeriod
»» testContratEndDate	string(date-time)¦null	false	none	Test contract end date
»» annualVacation	number(double)¦null	false	none	Annual vacation days

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Stats

Endpoint related to managing the statistics of Centers

GetStatsByCenter

shell

# You can also use wget
curl -X GET /stats/statsbycenter/${centercode}?dateFrom=2019-08-24&dateUntil=2019-08-24 \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/stats/statsbycenter/${centercode}', params={
  'dateFrom': '2019-08-24',  'dateUntil': '2019-08-24'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/stats/statsbycenter/${centercode}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /stats/statsbycenter/${centercode}

This endpoint will return a list of stats by day based on the Benchmarking Alliance standard. Both dateFrom and dateUntil are included

Parameters

Name	In	Type	Required	Description
centercode	path	string	true	Center code
dateFrom	query	string(date)	true	Date from
dateUntil	query	string(date)	true	Date until

200 Response

{
  "date": "2019-08-24T14:15:22Z",
  "roomsAvaliable": 0,
  "roomsSold": 0,
  "roomsOutOfOrder": 0,
  "centerGuests": 0,
  "roomRevenue": 0,
  "totalRevenue": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Stats by center list	StatsByCenterResponse
204	No Content	No stats were found	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Stays

Endpoint related to managing the stays

GetStaysXPaxList

shell

# You can also use wget
curl -X GET /stays/staysxpax?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/stays/staysxpax', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/stays/staysxpax";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /stays/staysxpax

This endpoint will return a list of stays x pax given the CenterCode and can be filtered. If no dates are provided DateFrom = Today, DateTo = Today + 365 days

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center Code
DateFrom	query	string(date-time)	false	Start Date filter
DateUntil	query	string(date-time)	false	End Date filter
Real	query	boolean	false	Real filter // null = ALL, true = YES, false = NO
CustomerTypes	query	array[string]	false	CustomerType filter
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "center_id_fk": 0,
  "center": "string",
  "date": "2019-08-24T14:15:22Z",
  "ad": 0,
  "jr": 0,
  "ch": 0,
  "bb": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	Stays x pax list	StaysXPaxResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Supplies

Endpoint related to managing the Supplies from the reservations

GetSuppliesList

shell

# You can also use wget
curl -X GET /supplies/list?CenterCode=string \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/supplies/list', params={
  'CenterCode': 'string'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/supplies/list";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /supplies/list

This endpoint will return a list of ReservationSupplies given a Center code

Parameters

Name	In	Type	Required	Description
CenterCode	query	string	true	Center code
SalesServiceCode	query	string	false	SalesService code
InvStatus_id	query	integer(int32)	false	Invoice status identifier
StartDateFrom	query	string(date-time)	false	From start date
StartDateTo	query	string(date-time)	false	To start date
EndingDateFrom	query	string(date-time)	false	From ending date
EndingDateTo	query	string(date-time)	false	To ending date
PageNumber	query	integer(int32)	false	Page Number
PageSize	query	integer(int32)	false	Page Size

200 Response

{
  "supplyId": 0,
  "reservationId": 0,
  "salesService": "string",
  "salesServiceCode": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string",
  "quantity": 0,
  "value": 0,
  "invStatus_id_fk": 0,
  "invoiceStatus": "string",
  "taxIncluded": true,
  "chargeType": "string",
  "priceCalculated": true,
  "comments": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Supplies List	SuppliesResponse
204	No Content	No ReservationSupplies were found	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

GetSupplies

shell

# You can also use wget
curl -X GET /supplies/{ReservationId} \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/supplies/{ReservationId}', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }

    /// Make a dummy request
    public async Task MakeGetRequest()
    {
      string url = "/supplies/{ReservationId}";
      var result = await GetAsync(url);
    }

    /// Performs a GET Request
    public async Task GetAsync(string url)
    {
        //Start the request
        HttpResponseMessage response = await Client.GetAsync(url);

        //Validate result
        response.EnsureSuccessStatusCode();

    }




    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

GET /supplies/{ReservationId}

This endpoint will return a list of Room Supplies given a reservation identifier

Parameters

Name	In	Type	Required	Description
ReservationId	path	integer(int32)	true	Reservation Identifier

200 Response

{
  "supplyId": 0,
  "reservationId": 0,
  "salesService": "string",
  "salesServiceCode": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string",
  "quantity": 0,
  "value": 0,
  "invStatus_id_fk": 0,
  "invoiceStatus": "string",
  "taxIncluded": true,
  "chargeType": "string",
  "priceCalculated": true,
  "comments": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	Supplies List	SuppliesResponse
204	No Content	No Supplies were found for the reservation	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

AddSupply

shell

# You can also use wget
curl -X POST /supplies?ReservationId=0&ServiceCode=string&StartDate=2019-08-24T14%3A15%3A22Z&EndDate=2019-08-24T14%3A15%3A22Z&Quantity=0&Value=0 \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/supplies', params={
  'ReservationId': '0',  'ServiceCode': 'string',  'StartDate': '2019-08-24T14:15:22Z',  'EndDate': '2019-08-24T14:15:22Z',  'Quantity': '0',  'Value': '0'
}, headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }


    /// Make a dummy request
    public async Task MakePostRequest()
    {
      string url = "/supplies";


      await PostAsync(null, url);

    }

    /// Performs a POST Request
    public async Task PostAsync(undefined content, string url)
    {
        //Serialize Object
        StringContent jsonContent = SerializeObject(content);

        //Execute POST request
        HttpResponseMessage response = await Client.PostAsync(url, jsonContent);
    }



    /// Serialize an object to Json
    private StringContent SerializeObject(undefined content)
    {
        //Serialize Object
        string jsonObject = JsonConvert.SerializeObject(content);

        //Create Json UTF8 String Content
        return new StringContent(jsonObject, Encoding.UTF8, "application/json");
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

POST /supplies

This endpoint will add a ReservationSupply to a Reservation

Parameters

Name	In	Type	Required	Description
ReservationId	query	integer(int32)	true	Reservation Identifier
ServiceCode	query	string	true	Service code / External code
StartDate	query	string(date-time)	true	Start Date
EndDate	query	string(date-time)	true	End Date
Quantity	query	integer(int32)	true	Quantity
Value	query	number(double)	true	Value
InvoiceStatus	query	string	false	Invoice status description
Description	query	string	false	Description
ChargeType	query	string	false	Charge Type
Comments	query	string	false	Comments

200 Response

{
  "supplyId": 0,
  "reservationId": 0,
  "salesService": "string",
  "salesServiceCode": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string",
  "quantity": 0,
  "value": 0,
  "invStatus_id_fk": 0,
  "invoiceStatus": "string",
  "taxIncluded": true,
  "chargeType": "string",
  "priceCalculated": true,
  "comments": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	ReservationSupply added successfully	SuppliesResponse
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

To perform this operation, you must be authenticated by means of one of the following methods: bearer

DeleteSupply

shell

# You can also use wget
curl -X DELETE /supplies/{SupplyId} \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

python

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/supplies/{SupplyId}', headers = headers)

print(r.json())

csharp

using System;
using System.Collections.Generic;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

/// <<summary>>
/// Example of Http Client
/// <</summary>>
public class HttpExample
{
    private HttpClient Client { get; set; }

    /// <<summary>>
    /// Setup http client
    /// <</summary>>
    public HttpExample()
    {
      Client = new HttpClient();
    }




    /// Make a dummy request
    public async Task MakeDeleteRequest()
    {
      int id = 1;
      string url = "/supplies/{SupplyId}";

      await DeleteAsync(id, url);
    }

    /// Performs a DELETE Request
    public async Task DeleteAsync(int id, string url)
    {
        //Execute DELETE request
        HttpResponseMessage response = await Client.DeleteAsync(url + $"/{id}");

        //Return response
        await DeserializeObject(response);
    }

    /// Deserialize object from request response
    private async Task DeserializeObject(HttpResponseMessage response)
    {
        //Read body
        string responseBody = await response.Content.ReadAsStringAsync();

        //Deserialize Body to object
        var result = JsonConvert.DeserializeObject(responseBody);
    }
}

DELETE /supplies/{SupplyId}

This endpoint will remove a Reservation Supply from a Reservation given a ReservationSupply identifier

Parameters

Name	In	Type	Required	Description
SupplyId	path	integer(int32)	true	ReservationSupply identifier

200 Response

[
  {
    "supplyId": 0,
    "reservationId": 0,
    "salesService": "string",
    "salesServiceCode": "string",
    "startDate": "2019-08-24T14:15:22Z",
    "endDate": "2019-08-24T14:15:22Z",
    "description": "string",
    "quantity": 0,
    "value": 0,
    "invStatus_id_fk": 0,
    "invoiceStatus": "string",
    "taxIncluded": true,
    "chargeType": "string",
    "priceCalculated": true,
    "comments": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	ReservationSupply removed successfully	Inline
204	No Content	No Content	None
400	Bad Request	Bad Request	None
401	Unauthorized	No valid token was provided	None
403	Forbidden	User permission level insufficient	None
429	Too Many Requests	Too many requests, try again later	None
500	Internal Server Error	Internal Server Error	None

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[SuppliesResponse]	false	none	none
» supplyId	integer(int32)	false	none	Supply identifier
» reservationId	integer(int32)	false	none	Reservation identifier
» salesService	string¦null	false	none	SalesService description
» salesServiceCode	string¦null	false	none	SalesService code
» startDate	string(date-time)¦null	false	none	Start date
» endDate	string(date-time)¦null	false	none	End date
» description	string¦null	false	none	Description
» quantity	integer(int32)¦null	false	none	Quantity
» value	number(double)¦null	false	none	Value
» invStatus_id_fk	integer(int32)¦null	false	none	Invoice status identifier
» invoiceStatus	string¦null	false	none	Invoice status description
» taxIncluded	boolean¦null	false	none	Is VAT inclusive
» chargeType	string¦null	false	none	Charge Type
» priceCalculated	boolean	false	none	Is price calculated
» comments	string¦null	false	none	Comments

To perform this operation, you must be authenticated by means of one of the following methods: bearer

Schemas

AvailabilityResponse

{
  "center_id_fk": 0,
  "center": "string",
  "date": "2019-08-24T14:15:22Z",
  "roomTypeCenter_id_fk": 0,
  "roomType": "string",
  "allotmentAvailable": 0,
  "lockedRooms": 0
}

Properties

Name	Type	Required	Restrictions	Description
center_id_fk	integer(int32)	false	none	Center identifier
center	string¦null	false	none	Hotel Code
date	string(date-time)¦null	false	none	Date
roomTypeCenter_id_fk	integer(int32)	false	none	Room type identifier
roomType	string¦null	false	none	Room type code
allotmentAvailable	integer(int32)¦null	false	none	Amount available
lockedRooms	integer(int32)¦null	false	none	Amount of locked rooms

BoardTypesCenterResponse

{
  "boardTypeCenter_id_pk": 0,
  "centerCode": "string",
  "center_id_fk": 0,
  "boardTypeCode": "string",
  "boardType_id_fk": 0,
  "description": "string",
  "descriptionDetailed": "string",
  "defaultBoard": true
}

Properties

Name	Type	Required	Restrictions	Description
boardTypeCenter_id_pk	integer(int32)	false	none	BoardTypeCenter Identifier
centerCode	string¦null	false	none	Center Code
center_id_fk	integer(int32)	false	none	Center Identifier
boardTypeCode	string¦null	false	none	BoardType Code
boardType_id_fk	integer(int32)	false	none	BoardType Identifier
description	string¦null	false	none	Description
descriptionDetailed	string¦null	false	none	Description detailed
defaultBoard	boolean	false	none	Is default board

BoardTypesResponse

{
  "boardType_id_pk": 0,
  "code": "string",
  "description": "string",
  "breakfast": true,
  "lunch": true,
  "dinner": true,
  "allInclusive": true
}

Properties

Name	Type	Required	Restrictions	Description
boardType_id_pk	integer(int32)	false	none	BoardType Identifier
code	string¦null	false	none	BoardType code
description	string¦null	false	none	Description
breakfast	boolean	false	none	Breakfast
lunch	boolean	false	none	Lunch
dinner	boolean	false	none	Dinner
allInclusive	boolean	false	none	AllInclusive

BudgetLine

{
  "budgetLine_id_pk": 0,
  "budgetHeader_id_fk": 0,
  "initialDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "saleService_id_fk": 0,
  "salesServiceName": "string",
  "observations": "string",
  "quantity": 0,
  "value": 0,
  "taxIncluded": true,
  "automaticCharge": true,
  "invStatus_id_fk": 0,
  "invoiceStatus": "string",
  "siL_id_fk": 0,
  "reservation_id_fk": 0
}

Properties

Name	Type	Required	Restrictions	Description
budgetLine_id_pk	integer(int32)	false	none	Budget line identifier
budgetHeader_id_fk	integer(int32)¦null	false	none	Budget header identifier
initialDate	string(date-time)¦null	false	none	Initial date
endDate	string(date-time)¦null	false	none	End date
saleService_id_fk	integer(int32)¦null	false	none	Sales service identifier
salesServiceName	string¦null	false	none	Sales service name
observations	string¦null	false	none	Observations
quantity	number(double)¦null	false	none	Quantity
value	number(double)¦null	false	none	Value
taxIncluded	boolean¦null	false	none	Is tax included
automaticCharge	boolean¦null	false	none	Is automatic charge
invStatus_id_fk	integer(int32)¦null	false	none	Invoice status identifier
invoiceStatus	string¦null	false	none	Invoice status description
siL_id_fk	integer(int32)¦null	false	none	Sales invoice line identifier
reservation_id_fk	integer(int32)¦null	false	none	Reservation identifier

CardexPost

{
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "birthDate": "2019-08-24",
  "documentID": "string",
  "documentType": "string",
  "expeditionDateDocument": "2019-08-24",
  "address": "string",
  "postalCode": "string",
  "state": "string",
  "city": "string",
  "phone": "string",
  "country": "string",
  "nationality": "string",
  "sex": "s",
  "email": "user@example.com",
  "supportNumber": null,
  "language": "string",
  "anniversaryDate": null,
  "authDataExchange": false,
  "authReceiveAdvertising": false,
  "authMessageAndPhone": false,
  "authLocalization": false,
  "segment_code": null,
  "cardexSource_code": null
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	Name
surname1	string	true	none	Surname 1
surname2	string¦null	false	none	Surname 2
birthDate	string(date)¦null	false	none	Date of birth
documentID	string¦null	false	none	DocumentID
documentType	string¦null	false	none	Pax Document Type
expeditionDateDocument	string(date)¦null	false	none	Document date of expedition
address	string¦null	false	none	Address
postalCode	string¦null	false	none	Postal code
state	string¦null	false	none	State
city	string¦null	false	none	City
phone	string¦null	false	none	Phone number
country	string¦null	false	none	Country
nationality	string¦null	false	none	Nationality
sex	string¦null	false	none	Gender. Allowed values: [“Z”, “M”, “F”]
email	string(email)	true	none	Email
supportNumber	string¦null	false	none	Support number
language	string¦null	false	none	Language
anniversaryDate	string(date)¦null	false	none	Anniversary date
authDataExchange	boolean	true	none	Data exchange auth
authReceiveAdvertising	boolean	true	none	Advertising auth
authMessageAndPhone	boolean	true	none	Communication auth
authLocalization	boolean	true	none	Localization auth
segment_code	string¦null	false	none	Segment code
cardexSource_code	string¦null	false	none	Cardex source external code

CardexResponse

{
  "cardex_id_pk": 0,
  "timestamp": "string",
  "nationality": "string",
  "documentType": "string",
  "documentNumber": "string",
  "dateExpDocument": "2019-08-24T14:15:22Z",
  "name": "string",
  "surname": "string",
  "surname2": "string",
  "sex": "string",
  "birthdate": "2019-08-24T14:15:22Z",
  "email": "string",
  "residenceCountry_id_fk": "string",
  "postalcode": "string",
  "province": "string",
  "population": "string",
  "telephone": "string",
  "telephone2": "string",
  "fax": "string",
  "address": "string",
  "unsuscribeDate": "2019-08-24T14:15:22Z",
  "unsuscribeReason": "string",
  "authReceiveAdvertising": true,
  "authDataExchange": true,
  "authMessageAndPhone": true,
  "authLocalization": true,
  "anniversaryDate": "2019-08-24T14:15:22Z",
  "language_id_fk": "string",
  "cardexSource_id_fk": 0,
  "state_id_fk": 0
}

Properties

Name	Type	Required	Restrictions	Description
cardex_id_pk	integer(int32)	false	none	Cardex identifier
timestamp	string¦null	false	none	Timestamp
nationality	string¦null	false	none	Nationality
documentType	string¦null	false	none	Pax Document Type
documentNumber	string¦null	false	none	Document ID
dateExpDocument	string(date-time)¦null	false	none	Document expedition date
name	string¦null	false	none	Name
surname	string¦null	false	none	Surname
surname2	string¦null	false	none	Surname 2
sex	string¦null	false	none	Gender
birthdate	string(date-time)¦null	false	none	Date of birth
email	string¦null	false	none	Email
residenceCountry_id_fk	string¦null	false	none	Country of residence
postalcode	string¦null	false	none	Postal code
province	string¦null	false	none	Province
population	string¦null	false	none	Population
telephone	string¦null	false	none	Phone number
telephone2	string¦null	false	none	Phone number 2
fax	string¦null	false	none	Fax number
address	string¦null	false	none	Address
unsuscribeDate	string(date-time)¦null	false	none	Unsubscribe date
unsuscribeReason	string¦null	false	none	Unsubscribe reason
authReceiveAdvertising	boolean¦null	false	none	Advertising auth
authDataExchange	boolean¦null	false	none	Data exchange auth
authMessageAndPhone	boolean¦null	false	none	Communication auth
authLocalization	boolean¦null	false	none	Localization auth
anniversaryDate	string(date-time)¦null	false	none	Wedding aniversary date
language_id_fk	string¦null	false	none	Language
cardexSource_id_fk	integer(int32)¦null	false	none	Cardex source identifier
state_id_fk	integer(int32)¦null	false	none	State

CardexSourceResponse

{
  "cardexSource_id": 0,
  "externalCode": "string",
  "description": "string",
  "default": true
}

Properties

Name	Type	Required	Restrictions	Description
cardexSource_id	integer(int32)	false	none	CardexSource identifier
externalCode	string¦null	false	none	External code
description	string¦null	false	none	Description
default	boolean	false	none	Is default

CenterDepartmentsResponse

{
  "centerCode": "string",
  "notifyLocked": true,
  "email": "string"
}

Properties

Name	Type	Required	Restrictions	Description
centerCode	string¦null	false	none	Center code
notifyLocked	boolean	false	none	Notify locked room
email	string¦null	false	none	Email

CenterZoneResponse

{
  "centerZone_id": 0,
  "centerZone_code": "string",
  "center_id": 0,
  "centerCode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
centerZone_id	integer(int32)	false	none	CenterZone identifier
centerZone_code	string¦null	false	none	CenterZone code
center_id	integer(int32)¦null	false	none	Center identifier
centerCode	string¦null	false	none	Center code

CentersResponse

{
  "center_id": 0,
  "centerCode": "string",
  "centerName": "string",
  "currency": "string"
}

Properties

Name	Type	Required	Restrictions	Description
center_id	integer(int32)	false	none	Center identifer
centerCode	string¦null	false	none	Center code
centerName	string¦null	false	none	Center name
currency	string¦null	false	none	Currency

CreditAccResponse

{
  "taxAddress": "string",
  "nif": "string",
  "nationality_id_fk": "string",
  "cardType": "string",
  "budgetLines": [
    {
      "budgetLine_id_pk": 0,
      "budgetHeader_id_fk": 0,
      "initialDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "saleService_id_fk": 0,
      "salesServiceName": "string",
      "observations": "string",
      "quantity": 0,
      "value": 0,
      "taxIncluded": true,
      "automaticCharge": true,
      "invStatus_id_fk": 0,
      "invoiceStatus": "string",
      "siL_id_fk": 0,
      "reservation_id_fk": 0
    }
  ],
  "customerRetainers": [
    {
      "customerRetainer_id_pk": 0,
      "retainerNumber": "string",
      "customer_id_fk": 0,
      "customerCode": "string",
      "date": "2019-08-24T14:15:22Z",
      "pM_id_fk": 0,
      "pmCode": "string",
      "amount": 0,
      "retainerStatus_id": 0,
      "retainerStatus": "string",
      "bank_id_fk": 0,
      "bankDescription": "string",
      "observations": "string",
      "invStatus_id_fk": 0,
      "invoiceStatus": "string",
      "budgetHeader_id_fk": 0,
      "percentageAmount": 0
    }
  ],
  "budgetHeader_id_pk": 0,
  "budgetType": "string",
  "center_id_fk": 0,
  "centerCode": "string",
  "groupCode": "string",
  "name": "string",
  "email": "string",
  "telephone": "string",
  "customer_id_fk": 0,
  "customerCode": "string",
  "budgetDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "lastUpdateUser": "string",
  "budgetStatus_id": 0,
  "budgetStatus": "string",
  "invStatus_id_fk": 0,
  "invStatus": "string",
  "comments": "string",
  "externalCode": "string",
  "futureProduction": true,
  "isPending": true,
  "totalAmount": 0,
  "totalInvoiced": 0,
  "totalRetainers": 0,
  "totalCollectedInvoice": 0,
  "pendingAmountRetainers": 0,
  "pendingAmount": 0
}

Properties

Name	Type	Required	Restrictions	Description
taxAddress	string¦null	false	none	Tax address
nif	string¦null	false	none	NIF
nationality_id_fk	string¦null	false	none	Nationality
cardType	string¦null	false	none	Card type
budgetLines	[BudgetLine]¦null	false	none	List of Budget lines
customerRetainers	[CustRetainer]¦null	false	none	List of Customer retainers
budgetHeader_id_pk	integer(int32)	false	none	Budget identifier
budgetType	string¦null	false	none	Budget type
center_id_fk	integer(int32)¦null	false	none	Center identifier
centerCode	string¦null	false	none	Center code
groupCode	string¦null	false	none	Reference Code
name	string¦null	false	none	Date
email	string¦null	false	none	Email
telephone	string¦null	false	none	Phone
customer_id_fk	integer(int32)¦null	false	none	Customer identifier
customerCode	string¦null	false	none	Customer code
budgetDate	string(date-time)¦null	false	none	Budget date
lastUpdateDate	string(date-time)¦null	false	none	Last update date
dueDate	string(date-time)¦null	false	none	Due date
lastUpdateUser	string¦null	false	none	Last update user
budgetStatus_id	integer(int32)¦null	false	none	Budget status identifier
budgetStatus	string¦null	false	none	Budget status description
invStatus_id_fk	integer(int32)¦null	false	none	Invoice status identifier
invStatus	string¦null	false	none	Invoice status description
comments	string¦null	false	none	Comments
externalCode	string¦null	false	none	External code
futureProduction	boolean	false	none	Future production
isPending	boolean	false	read-only	Are billings pending
totalAmount	number(double)	false	none	Total amount
totalInvoiced	number(double)	false	none	Total invoiced
totalRetainers	number(double)	false	none	Anticipated
totalCollectedInvoice	number(double)	false	none	Total collected from invoice
pendingAmountRetainers	number(double)¦null	false	none	Pending amount from retainers
pendingAmount	number(double)¦null	false	read-only	Pending collection

CustRetainer

{
  "customerRetainer_id_pk": 0,
  "retainerNumber": "string",
  "customer_id_fk": 0,
  "customerCode": "string",
  "date": "2019-08-24T14:15:22Z",
  "pM_id_fk": 0,
  "pmCode": "string",
  "amount": 0,
  "retainerStatus_id": 0,
  "retainerStatus": "string",
  "bank_id_fk": 0,
  "bankDescription": "string",
  "observations": "string",
  "invStatus_id_fk": 0,
  "invoiceStatus": "string",
  "budgetHeader_id_fk": 0,
  "percentageAmount": 0
}

Properties

Name	Type	Required	Restrictions	Description
customerRetainer_id_pk	integer(int32)	false	none	Customer retainer identifier
retainerNumber	string¦null	false	none	Retainer number
customer_id_fk	integer(int32)	false	none	Customer identifier
customerCode	string¦null	false	none	Customer code
date	string(date-time)¦null	false	none	Retainer date
pM_id_fk	integer(int32)¦null	false	none	Payment method identifier
pmCode	string¦null	false	none	Payment method code
amount	number(double)¦null	false	none	Amount
retainerStatus_id	integer(int32)¦null	false	none	Retainer status identifier
retainerStatus	string¦null	false	none	Retainer status description
bank_id_fk	integer(int32)¦null	false	none	Bank identifier
bankDescription	string¦null	false	none	Bank description
observations	string¦null	false	none	Observations
invStatus_id_fk	integer(int32)¦null	false	none	Invoice status identifier
invoiceStatus	string¦null	false	none	Invoice status description
budgetHeader_id_fk	integer(int32)¦null	false	none	Date
percentageAmount	number(double)¦null	false	none	Percentage amount

CustomerTypeResponse

{
  "customerType_id": 0,
  "customerType": "string",
  "description": "string",
  "withoutChargeLodgment": true,
  "withoutChargeSupplies": true,
  "isDefault": true
}

Properties

Name	Type	Required	Restrictions	Description
customerType_id	integer(int32)	false	none	Customer Type identifier
customerType	string¦null	false	none	Customer Type name
description	string¦null	false	none	Description
withoutChargeLodgment	boolean	false	none	Is without charge lodgment
withoutChargeSupplies	boolean	false	none	Is without charge supplies
isDefault	boolean	false	none	Is default

DepartmentsResponse

{
  "department_id": 0,
  "departmentName": "string",
  "isLocked": true,
  "type": 0,
  "centerDepartments": [
    {
      "centerCode": "string",
      "notifyLocked": true,
      "email": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
department_id	integer(int32)	false	none	Department identifier
departmentName	string¦null	false	none	Department name
isLocked	boolean	false	none	Is Department locked
type	integer(int32)¦null	false	none	Department type
centerDepartments	[CenterDepartmentsResponse]¦null	false	none	List of Center departments

DocumentResponse

{
  "document_id": 0,
  "date": "2019-08-24T14:15:22Z",
  "documentType_id": 0,
  "description": "string",
  "typeIO": true,
  "centerCode": "string",
  "fileName": "string",
  "accessUrl": "string",
  "customer_id": 0,
  "storE_Supplier_id": 0,
  "task_id": 0,
  "note_id": 0,
  "siH_id": 0,
  "budget_id": 0,
  "collectionHeader_id": 0,
  "expenseInvoice_id": 0,
  "parentType": 0,
  "parent_id": 0
}

Properties

Name	Type	Required	Restrictions	Description
document_id	integer(int32)	false	none	Document identifier
date	string(date-time)¦null	false	none	Date
documentType_id	integer(int32)¦null	false	none	DocumentType identifier
description	string¦null	false	none	Description
typeIO	boolean¦null	false	none	Is IO
centerCode	string¦null	false	none	Center code
fileName	string¦null	false	none	File name
accessUrl	string¦null	false	none	Access URL
customer_id	integer(int32)¦null	false	none	Customer identifier
storE_Supplier_id	integer(int32)¦null	false	none	Store Supplier identifier
task_id	integer(int32)¦null	false	none	Task identifier
note_id	integer(int32)¦null	false	none	Note identifier
siH_id	integer(int32)¦null	false	none	Sales Invoice Header identifier
budget_id	integer(int32)¦null	false	none	Budget identifier
collectionHeader_id	integer(int32)¦null	false	none	Collection Header identifier
expenseInvoice_id	integer(int32)¦null	false	none	Expense invoice identifier
parentType	integer(int32)¦null	false	none	Parent type
parent_id	integer(int32)¦null	false	none	Parent identifier

DocumentResponse_min

{
  "document_id": 0,
  "date": "2019-08-24T14:15:22Z",
  "description": "string",
  "fileName": "string",
  "accessUrl": "string"
}

Properties

Name	Type	Required	Restrictions	Description
document_id	integer(int32)	false	none	Document identifier
date	string(date-time)¦null	false	none	Date
description	string¦null	false	none	Description
fileName	string¦null	false	none	File name
accessUrl	string¦null	false	none	Access URL

DocumentTypesResponse

{
  "documentType_id": 0,
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
documentType_id	integer(int32)	false	none	DocumentType identifier
description	string¦null	false	none	Description

EmployeeResponse

{
  "employee_id": 0,
  "employeeCode": "string",
  "hiringType": "string",
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "document": "string",
  "ssNumber": "string",
  "dossierCode": "string",
  "birthDate": "2019-08-24T14:15:22Z",
  "gender": "string",
  "bankAccount": "string",
  "address": "string",
  "postalCode": "string",
  "city": "string",
  "country": "string",
  "phone": "string",
  "mobile": "string",
  "email": "string",
  "emergencyPhone": "string",
  "contracts": [
    {
      "contract_id_pk": 0,
      "centerCode": "string",
      "department_id": 0,
      "department": "string",
      "initialDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "endDateVacation": "2019-08-24T14:15:22Z",
      "contractType": "string",
      "contractType_id": 0,
      "dailyWorkHours": 0,
      "weeklyWorkDays": 0,
      "finishContractReason": "string",
      "position": "string",
      "wageLevel": 0,
      "extension": true,
      "seniorityDate": "2019-08-24T14:15:22Z",
      "onLeave": true,
      "guarenteedPeriod": 0,
      "testContratEndDate": "2019-08-24T14:15:22Z",
      "annualVacation": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
employee_id	integer(int32)	false	none	Employee identifier
employeeCode	string¦null	false	none	Employee code
hiringType	string¦null	false	none	Hiring type
name	string¦null	false	none	Name
surname1	string¦null	false	none	Surname 1
surname2	string¦null	false	none	Surname 2
document	string¦null	false	none	Employee document
ssNumber	string¦null	false	none	Social security number
dossierCode	string¦null	false	none	Dossier code
birthDate	string(date-time)¦null	false	none	Birth date
gender	string¦null	false	none	Gender F/M
bankAccount	string¦null	false	none	Bank Account
address	string¦null	false	none	Address
postalCode	string¦null	false	none	Postal code
city	string¦null	false	none	City
country	string¦null	false	none	Country ISO3
phone	string¦null	false	none	Phone
mobile	string¦null	false	none	Mobile
email	string¦null	false	none	Email
emergencyPhone	string¦null	false	none	Emergency phone
contracts	[RRHH_ContractResponse]¦null	false	none	List of contracts

Extra

{
  "postMappingSaleServiceCode": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string",
  "quantity": 0,
  "value": 0,
  "chargeType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
postMappingSaleServiceCode	string	true	none	Post Mapping Sale service code
startDate	string(date-time)	true	none	Start date
endDate	string(date-time)	true	none	End date
description	string	true	none	Description
quantity	integer(int32)	true	none	Quantity
value	number(double)	true	none	Value
chargeType	string	true	none	Charge Type

FixedAssetResponse

{
  "product_id": 0,
  "productName": "string",
  "store_id": 0,
  "storeCode": "string",
  "storeName": "string",
  "description": "string",
  "reference": "string",
  "code": "string",
  "centerCode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
product_id	integer(int32)	false	none	Product identifier
productName	string¦null	false	none	Product name
store_id	integer(int32)	false	none	Store identifier
storeCode	string¦null	false	none	Store code
storeName	string¦null	false	none	Store name
description	string¦null	false	none	Description
reference	string¦null	false	none	Reference
code	string¦null	false	none	Code
centerCode	string¦null	false	none	Center code

InfoRoles

{
  "name": "string",
  "permissions": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	Role name
permissions	[string]¦null	false	none	Role permissions

OccupancyRoomsResponse

{
  "center_id_fk": 0,
  "center": "string",
  "date": "2019-08-24T14:15:22Z",
  "roomTypeCenter_id_fk": 0,
  "roomType": "string",
  "occupancy": 0
}

Properties

Name	Type	Required	Restrictions	Description
center_id_fk	integer(int32)	false	none	Center identifier
center	string¦null	false	none	Hotel Code
date	string(date-time)¦null	false	none	Date
roomTypeCenter_id_fk	integer(int32)	false	none	Room type identifier
roomType	string¦null	false	none	Room type code
occupancy	integer(int32)¦null	false	none	Amount available

OccupantPost

{
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "birthDate": "2019-08-24T14:15:22Z",
  "documentID": "string",
  "expeditionDateDocument": "2019-08-24T14:15:22Z",
  "address": "string",
  "postalCode": "string",
  "state": "string",
  "phone": "string",
  "country": "string",
  "nationality": "string",
  "paxType": "AD",
  "sex": "string",
  "email": "user@example.com",
  "repeaterClient": false,
  "primaryPax": true,
  "authDataExchange": true,
  "authReceiveAdvertising": true,
  "authMessageAndPhone": true,
  "authLocalization": true
}

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	Name
surname1	string	true	none	Surname 1
surname2	string¦null	false	none	Surname 2
birthDate	string(date-time)	true	none	Date of birth
documentID	string	true	none	DocumentID
expeditionDateDocument	string(date-time)¦null	false	none	Document date of expedition
address	string¦null	false	none	Address
postalCode	string¦null	false	none	Postal code
state	string¦null	false	none	State
phone	string¦null	false	none	Phone number
country	string¦null	false	none	Country ISO2
nationality	string¦null	false	none	Nationality ISO2
paxType	string	true	none	Pax type
sex	string¦null	false	none	Gender
email	string(email)¦null	false	none	Email
repeaterClient	boolean	true	none	Is repeater client
primaryPax	boolean	true	none	Is primary pax
authDataExchange	boolean	true	none	Data exchange auth
authReceiveAdvertising	boolean	true	none	Advertising auth
authMessageAndPhone	boolean	true	none	Communication auth
authLocalization	boolean	true	none	Localization auth

OccupantResponse

{
  "reservationPaxId": 0,
  "position": 0,
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "birthDate": "2019-08-24T14:15:22Z",
  "documentType": "string",
  "documentID": "string",
  "expeditionDateDocument": "2019-08-24T14:15:22Z",
  "address": "string",
  "postalCode": "string",
  "state": "string",
  "country": "string",
  "nationality": "string",
  "language": "string",
  "paxType": "string",
  "sex": "string",
  "email": "string",
  "phone": "string",
  "primaryPax": true,
  "authDataExchange": true,
  "authReceiveAdvertising": true,
  "authMessageAndPhone": true,
  "authLocalization": true,
  "cardexId": 0
}

Properties

Name	Type	Required	Restrictions	Description
reservationPaxId	integer(int32)¦null	false	none	RerservationPax identifier
position	integer(int32)¦null	false	none	Position (deprecated)
name	string¦null	false	none	Name
surname1	string¦null	false	none	Surname 1
surname2	string¦null	false	none	Surname 2
birthDate	string(date-time)¦null	false	none	Birthday
documentType	string¦null	false	none	Document Type
documentID	string¦null	false	none	Document ID
expeditionDateDocument	string(date-time)¦null	false	none	Document expedition date
address	string¦null	false	none	Address
postalCode	string¦null	false	none	Postal code
state	string¦null	false	none	State
country	string¦null	false	none	Country
nationality	string¦null	false	none	Nationality
language	string¦null	false	none	Language (ISO2)
paxType	string¦null	false	none	Occupant type
sex	string¦null	false	none	Gender
email	string¦null	false	none	Email
phone	string¦null	false	none	Phone number
primaryPax	boolean¦null	false	none	Is primary pax
authDataExchange	boolean¦null	false	none	Data exchange auth
authReceiveAdvertising	boolean¦null	false	none	Advertising auth
authMessageAndPhone	boolean¦null	false	none	Communication auth
authLocalization	boolean¦null	false	none	Location auth
cardexId	integer(int32)¦null	false	none	Cardex identifier

PaxPost

{
  "reservationId": 0,
  "occupants": [
    {
      "name": "string",
      "surname1": "string",
      "surname2": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "documentID": "string",
      "expeditionDateDocument": "2019-08-24T14:15:22Z",
      "address": "string",
      "postalCode": "string",
      "state": "string",
      "phone": "string",
      "country": "string",
      "nationality": "string",
      "paxType": "AD",
      "sex": "string",
      "email": "user@example.com",
      "repeaterClient": false,
      "primaryPax": true,
      "authDataExchange": true,
      "authReceiveAdvertising": true,
      "authMessageAndPhone": true,
      "authLocalization": true
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
reservationId	integer(int32)	true	none	Reservation Identifier
occupants	[OccupantPost]	true	none	Occupants list

PaxPut

{
  "pmS_id": 0,
  "occupant": {
    "name": "string",
    "surname1": "string",
    "surname2": "string",
    "birthDate": "2019-08-24T14:15:22Z",
    "documentID": "string",
    "expeditionDateDocument": "2019-08-24T14:15:22Z",
    "address": "string",
    "postalCode": "string",
    "state": "string",
    "phone": "string",
    "country": "string",
    "nationality": "string",
    "paxType": "AD",
    "sex": "string",
    "email": "user@example.com",
    "repeaterClient": false,
    "primaryPax": true,
    "authDataExchange": true,
    "authReceiveAdvertising": true,
    "authMessageAndPhone": true,
    "authLocalization": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
pmS_id	integer(int32)	true	none	Occupant Identifier
occupant	OccupantPost	true	none	none

PaxbyRoomResponse

{
  "pmS_id": 0,
  "name": "string",
  "surname1": "string",
  "surname2": "string",
  "sex": "string",
  "paxType": "string",
  "arrival": "2019-08-24T14:15:22Z",
  "exit": "2019-08-24T14:15:22Z",
  "birthDate": "2019-08-24T14:15:22Z",
  "nationality": "string",
  "birthCountry": "string",
  "countryResidence": "string",
  "documentID": "string",
  "email": "string",
  "address": "string",
  "city": "string",
  "state": "string",
  "postalCode": "string",
  "phone": "string",
  "ad": 0,
  "jr": 0,
  "bb": 0,
  "ch": 0,
  "reservation_id": 0,
  "reservationStatus": "string",
  "rsvStatusCode": 0,
  "room_number": "string",
  "room_type": "string",
  "salesDate": "2019-08-24T14:15:22Z",
  "res_channel": "string",
  "res_agency": "string",
  "board_type": "string",
  "comments": "string"
}

Properties

Name	Type	Required	Restrictions	Description
pmS_id	integer(int32)¦null	false	none	Occupant Identifier
name	string¦null	false	none	Name
surname1	string¦null	false	none	Surname 1
surname2	string¦null	false	none	Surname 2
sex	string¦null	false	none	Gender
paxType	string¦null	false	none	Occupant Type
arrival	string(date-time)¦null	false	none	Arrival date
exit	string(date-time)¦null	false	none	Exit date
birthDate	string(date-time)¦null	false	none	Birthday
nationality	string¦null	false	none	Nationality
birthCountry	string¦null	false	none	Birth country
countryResidence	string¦null	false	none	Residence country
documentID	string¦null	false	none	Document Id
email	string¦null	false	none	Email
address	string¦null	false	none	Address
city	string¦null	false	none	City
state	string¦null	false	none	State
postalCode	string¦null	false	none	Postal Code
phone	string¦null	false	none	Phone number
ad	integer(int32)	false	none	Num Adult
jr	integer(int32)	false	none	Num Junior
bb	integer(int32)	false	none	Num Baby
ch	integer(int32)	false	none	Num Child
reservation_id	integer(int32)¦null	false	none	Reservation identifier
reservationStatus	string¦null	false	none	Reservation status code
rsvStatusCode	integer(int32)¦null	false	none	Reservation status identifier
room_number	string¦null	false	none	Room number
room_type	string¦null	false	none	RoomType code
salesDate	string(date-time)¦null	false	none	Sales Date
res_channel	string¦null	false	none	Reservation channel code
res_agency	string¦null	false	none	Reservation agency code
board_type	string¦null	false	none	BoardType code
comments	string¦null	false	none	Comments

PaymentMethodsResponse

{
  "paymentMehod_id": 0,
  "center_id": 0,
  "centerCode": "string",
  "description": "string",
  "cashRegister": "string",
  "carryBalance": true,
  "pmType": "string",
  "ticketCopyNumber": 0,
  "onlyTPV": true,
  "code": "string",
  "externalCode": "string",
  "pmOrder": 0,
  "accCommission": "string",
  "transferPerMovment": true
}

Properties

Name	Type	Required	Restrictions	Description
paymentMehod_id	integer(int32)	false	none	Payment Method identifier
center_id	integer(int32)¦null	false	none	Center identifier
centerCode	string¦null	false	none	Center code
description	string¦null	false	none	Description
cashRegister	string¦null	false	none	CashRegister name
carryBalance	boolean	false	none	Carry balance
pmType	string¦null	false	none	Payment Method type
ticketCopyNumber	integer(int32)¦null	false	none	Num of ticket copies
onlyTPV	boolean	false	none	Is OnlyTPV
code	string¦null	false	none	Code
externalCode	string¦null	false	none	ExternalCode (Related to Retainers)
pmOrder	integer(int32)¦null	false	none	Order
accCommission	string¦null	false	none	Comission Account
transferPerMovment	boolean	false	none	Is Transfer per movement

Price

{
  "date": "2019-08-24T14:15:22Z",
  "amount": 0,
  "currency": "string",
  "taxes": 0
}

Properties

Name	Type	Required	Restrictions	Description
date	string(date-time)	true	none	Price date
amount	number(double)	true	none	Amount
currency	string	true	none	Currency code. Ex: EUR
taxes	number(double)¦null	false	none	Tax percent --- COMPROBAR

PricePost

{
  "reservationId": 0,
  "pricesList": [
    {
      "date": "2019-08-24T14:15:22Z",
      "amount": 0,
      "currency": "string",
      "taxes": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
reservationId	integer(int32)	true	none	Reservation Identifier
pricesList	[Price]	true	none	List of Prices

PricesResponse

{
  "priceId": 0,
  "reservationId": 0,
  "contractId": 0,
  "contractNumber": "string",
  "dailyPrice": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "priceType_id": "string",
  "paxType": "string",
  "invStatus_id_fk": 0,
  "invoiceStatus": "string",
  "roomType": "string",
  "boardType": "string",
  "currency": "string"
}

Properties

Name	Type	Required	Restrictions	Description
priceId	integer(int32)	false	none	Price identifier
reservationId	integer(int32)	false	none	Reservation identifier
contractId	integer(int32)¦null	false	none	Contract identifier
contractNumber	string¦null	false	none	Contract number
dailyPrice	number(double)¦null	false	none	Daily price
startDate	string(date-time)	false	none	Start date
endDate	string(date-time)	false	none	End Date
priceType_id	string¦null	false	none	Price Type identifier
paxType	string¦null	false	none	Occupant Type
invStatus_id_fk	integer(int32)¦null	false	none	Invoice status identifier
invoiceStatus	string¦null	false	none	Invoice status description
roomType	string¦null	false	none	RoomType code
boardType	string¦null	false	none	BoardType code
currency	string¦null	false	none	Currency code

QuoteResponse

{
  "arrivalDate": "2019-08-24T14:15:22Z",
  "pendingInvoice": 0,
  "budgetHeader_id_pk": 0,
  "budgetType": "string",
  "center_id_fk": 0,
  "centerCode": "string",
  "groupCode": "string",
  "name": "string",
  "email": "string",
  "telephone": "string",
  "customer_id_fk": 0,
  "customerCode": "string",
  "budgetDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "lastUpdateUser": "string",
  "budgetStatus_id": 0,
  "budgetStatus": "string",
  "invStatus_id_fk": 0,
  "invStatus": "string",
  "comments": "string",
  "externalCode": "string",
  "futureProduction": true,
  "isPending": true,
  "totalAmount": 0,
  "totalInvoiced": 0,
  "totalRetainers": 0,
  "totalCollectedInvoice": 0,
  "pendingAmountRetainers": 0,
  "pendingAmount": 0
}

Properties

Name	Type	Required	Restrictions	Description
arrivalDate	string(date-time)¦null	false	none	Arrival date
pendingInvoice	number(double)	false	read-only	Pending invoice
budgetHeader_id_pk	integer(int32)	false	none	Budget identifier
budgetType	string¦null	false	none	Budget type
center_id_fk	integer(int32)¦null	false	none	Center identifier
centerCode	string¦null	false	none	Center code
groupCode	string¦null	false	none	Reference Code
name	string¦null	false	none	Date
email	string¦null	false	none	Email
telephone	string¦null	false	none	Phone
customer_id_fk	integer(int32)¦null	false	none	Customer identifier
customerCode	string¦null	false	none	Customer code
budgetDate	string(date-time)¦null	false	none	Budget date
lastUpdateDate	string(date-time)¦null	false	none	Last update date
dueDate	string(date-time)¦null	false	none	Due date
lastUpdateUser	string¦null	false	none	Last update user
budgetStatus_id	integer(int32)¦null	false	none	Budget status identifier
budgetStatus	string¦null	false	none	Budget status description
invStatus_id_fk	integer(int32)¦null	false	none	Invoice status identifier
invStatus	string¦null	false	none	Invoice status description
comments	string¦null	false	none	Comments
externalCode	string¦null	false	none	External code
futureProduction	boolean	false	none	Future production
isPending	boolean	false	read-only	Are billings pending
totalAmount	number(double)	false	none	Total amount
totalInvoiced	number(double)	false	none	Total invoiced
totalRetainers	number(double)	false	none	Anticipated
totalCollectedInvoice	number(double)	false	none	Total collected from invoice
pendingAmountRetainers	number(double)¦null	false	none	Pending amount from retainers
pendingAmount	number(double)¦null	false	read-only	Pending collection

QuotesResponse

{
  "isPending": true,
  "arrivalDate": "2019-08-24T14:15:22Z",
  "pendingInvoice": 0,
  "budgetHeader_id_pk": 0,
  "budgetType": "string",
  "center_id_fk": 0,
  "centerCode": "string",
  "groupCode": "string",
  "name": "string",
  "email": "string",
  "telephone": "string",
  "customer_id_fk": 0,
  "customerCode": "string",
  "budgetDate": "2019-08-24T14:15:22Z",
  "lastUpdateDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "lastUpdateUser": "string",
  "budgetStatus_id": 0,
  "budgetStatus": "string",
  "invStatus_id_fk": 0,
  "invStatus": "string",
  "totalAmount": 0,
  "totalInvoiced": 0,
  "totalRetainers": 0,
  "totalCollectedInvoice": 0,
  "pendingAmountRetainers": 0,
  "pendingAmount": 0
}

Properties

Name	Type	Required	Restrictions	Description
isPending	boolean	false	read-only	Are billings pending
arrivalDate	string(date-time)¦null	false	none	Arrival date
pendingInvoice	number(double)	false	read-only	Pending invoice
budgetHeader_id_pk	integer(int32)	false	none	Budget identifier
budgetType	string¦null	false	none	Budget type
center_id_fk	integer(int32)¦null	false	none	Center identifier
centerCode	string¦null	false	none	Center code
groupCode	string¦null	false	none	Budget reference
name	string¦null	false	none	Name
email	string¦null	false	none	Email
telephone	string¦null	false	none	Phone
customer_id_fk	integer(int32)¦null	false	none	Customer identifer
customerCode	string¦null	false	none	Customer code
budgetDate	string(date-time)¦null	false	none	Budget date
lastUpdateDate	string(date-time)¦null	false	none	Last update date
dueDate	string(date-time)¦null	false	none	Due date
lastUpdateUser	string¦null	false	none	Last update user
budgetStatus_id	integer(int32)¦null	false	none	Budget status identifier
budgetStatus	string¦null	false	none	Budget status description
invStatus_id_fk	integer(int32)¦null	false	none	Invoice status identifier
invStatus	string¦null	false	none	Invoice status description
totalAmount	number(double)	false	none	Total amount
totalInvoiced	number(double)	false	none	Total invoiced
totalRetainers	number(double)	false	none	Anticipated
totalCollectedInvoice	number(double)	false	none	Total collected from invoice
pendingAmountRetainers	number(double)	false	none	Pending amount from retainers
pendingAmount	number(double)	false	read-only	Pending collection

RRHHContractTypeResponse

{
  "contractType_id": 0,
  "code": "string",
  "description": "string",
  "isLocked": true
}

Properties

Name	Type	Required	Restrictions	Description
contractType_id	integer(int32)	false	none	ContractType identifier
code	string¦null	false	none	ContractType code
description	string¦null	false	none	ContractType description
isLocked	boolean	false	none	Is ContractType locked

RRHH_ContractPost

{
  "centerCode": "string",
  "department_id": 0,
  "contractType_id": 0,
  "dailyWorkHours": 0,
  "weeklyWorkDays": 0,
  "initialDate": "2019-08-24T14:15:22Z",
  "position_id": 0,
  "vacationDays": 0,
  "seniorityDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "endDateVacation": "2019-08-24T14:15:22Z",
  "wageLevel": 0
}

Properties

Name	Type	Required	Restrictions	Description
centerCode	string	true	none	Center code
department_id	integer(int32)	true	none	Department identifier
contractType_id	integer(int32)	true	none	Contract Type identifier
dailyWorkHours	number(double)	true	none	Daily work hours
weeklyWorkDays	integer(int32)	true	none	Weekly work hours
initialDate	string(date-time)	true	none	Initial date
position_id	integer(int32)¦null	false	none	Position identifier
vacationDays	number(double)¦null	false	none	Annual vacation days
seniorityDate	string(date-time)¦null	false	none	Seniority date
endDate	string(date-time)¦null	false	none	End date
endDateVacation	string(date-time)¦null	false	none	End date with vacations
wageLevel	integer(int32)¦null	false	none	Wage level

RRHH_ContractResponse

{
  "contract_id_pk": 0,
  "centerCode": "string",
  "department_id": 0,
  "department": "string",
  "initialDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "endDateVacation": "2019-08-24T14:15:22Z",
  "contractType": "string",
  "contractType_id": 0,
  "dailyWorkHours": 0,
  "weeklyWorkDays": 0,
  "finishContractReason": "string",
  "position": "string",
  "wageLevel": 0,
  "extension": true,
  "seniorityDate": "2019-08-24T14:15:22Z",
  "onLeave": true,
  "guarenteedPeriod": 0,
  "testContratEndDate": "2019-08-24T14:15:22Z",
  "annualVacation": 0
}

Properties

Name	Type	Required	Restrictions	Description
contract_id_pk	integer(int32)	false	none	Contract identifier
centerCode	string¦null	false	none	Center code
department_id	integer(int32)¦null	false	none	Department identifier
department	string¦null	false	none	Department
initialDate	string(date-time)¦null	false	none	Initial date
endDate	string(date-time)¦null	false	none	End date
endDateVacation	string(date-time)¦null	false	none	End date with vacations
contractType	string¦null	false	none	Contract Type
contractType_id	integer(int32)¦null	false	none	Contract Type identifier
dailyWorkHours	number(double)¦null	false	none	Daily work hours
weeklyWorkDays	integer(int32)¦null	false	none	Weekly work hours
finishContractReason	string¦null	false	none	Finish contract reason
position	string¦null	false	none	Position
wageLevel	integer(int32)¦null	false	none	Wage level
extension	boolean	false	none	is Extension
seniorityDate	string(date-time)¦null	false	none	Seniority date
onLeave	boolean	false	none	is OnLeave
guarenteedPeriod	integer(int32)¦null	false	none	GuarantedPeriod
testContratEndDate	string(date-time)¦null	false	none	Test contract end date
annualVacation	number(double)¦null	false	none	Annual vacation days

RRHH_IncidenceTypesResponse

{
  "incicenceType_id": 0,
  "incicenceType_code": "string",
  "description": "string",
  "format": "string",
  "group_id": 0,
  "group_code": "string",
  "type": "string",
  "overtime": "string",
  "locked": true
}

Properties

Name	Type	Required	Restrictions	Description
incicenceType_id	integer(int32)	false	none	Incidence type identifier
incicenceType_code	string¦null	false	none	Incidence type code
description	string¦null	false	none	Description
format	string¦null	false	none	Format
group_id	integer(int32)¦null	false	none	Group identifier
group_code	string¦null	false	none	Group code
type	string¦null	false	none	Type
overtime	string¦null	false	none	Overtime
locked	boolean	false	none	Is locked

RRHH_PositionsResponse

{
  "position_id": 0,
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
position_id	integer(int32)	false	none	Position identifier
description	string¦null	false	none	Position description

RateTypesResponse

{
  "rateType_id_pk": 0,
  "name": "string",
  "pricePer": "string",
  "discountType": "string",
  "associatedRateType_id_fk": 0,
  "associatedRateType": "string",
  "quantity": 0,
  "valueType": true,
  "valueTypeCode": "string",
  "position": 0,
  "description": "string",
  "locked": true,
  "lockRetainersReturn": true,
  "advertismentCheckIn": true,
  "advertismentCheckInText": "string",
  "paymentPercentage": 0
}

Properties

Name	Type	Required	Restrictions	Description
rateType_id_pk	integer(int32)	false	none	RateType identifier
name	string¦null	false	none	Name
pricePer	string¦null	false	none	Price per
discountType	string¦null	false	none	Discount type
associatedRateType_id_fk	integer(int32)¦null	false	none	Associated RateType identifier
associatedRateType	string¦null	false	none	Associated RateType code
quantity	number(double)¦null	false	none	Quantity
valueType	boolean¦null	false	none	Value type
valueTypeCode	string¦null	false	none	Value type code
position	integer(int32)¦null	false	none	Position
description	string¦null	false	none	Description
locked	boolean	false	none	Is locked
lockRetainersReturn	boolean	false	none	none
advertismentCheckIn	boolean	false	none	none
advertismentCheckInText	string¦null	false	none	none
paymentPercentage	number(double)¦null	false	none	Payment Percentage

RatesResponse

{
  "rateId": 0,
  "center_id_fk": 0,
  "centerCode": "string",
  "date": "2019-08-24T14:15:22Z",
  "roomTypeCenter_id_fk": 0,
  "roomTypeCenterCode": "string",
  "boardTypeCenter_id_fk": 0,
  "boardTypeCenterCode": "string",
  "rateType_id_fk": 0,
  "rateTypeCode": "string",
  "description": "string",
  "roomRate": 0,
  "adRate": 0,
  "jrRate": 0,
  "chRate": 0,
  "bbRate": 0,
  "lastUpdate": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
rateId	integer(int32)	false	none	Observations
center_id_fk	integer(int32)	false	none	Center identifier
centerCode	string¦null	false	none	Center code
date	string(date-time)¦null	false	none	Date
roomTypeCenter_id_fk	integer(int32)¦null	false	none	RoomTypeCenter identifier
roomTypeCenterCode	string¦null	false	none	RoomType code
boardTypeCenter_id_fk	integer(int32)¦null	false	none	BoardTypeCenter identifier
boardTypeCenterCode	string¦null	false	none	BoardType code
rateType_id_fk	integer(int32)¦null	false	none	RateType identifier
rateTypeCode	string¦null	false	none	RateType code
description	string¦null	false	none	Description
roomRate	number(double)	false	none	Room rate
adRate	number(double)	false	none	Adult rate
jrRate	number(double)	false	none	Junior rate
chRate	number(double)	false	none	Child rate
bbRate	number(double)	false	none	Baby rate
lastUpdate	string(date-time)¦null	false	none	Last update

ReqRooms

{
  "roomNumber": "string",
  "isFixed": true,
  "groupIdentifier": "string",
  "roomTypeFRA": "string",
  "roomTypeUSE": "string",
  "boardType": "string",
  "rateCode": "string",
  "desglose": 0,
  "ad": 0,
  "jr": 0,
  "ch": 0,
  "bb": 0,
  "commentList": [
    "string"
  ],
  "preferencesList": [
    "string"
  ],
  "paxes": [
    {
      "name": "string",
      "surname1": "string",
      "surname2": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "documentID": "string",
      "expeditionDateDocument": "2019-08-24T14:15:22Z",
      "address": "string",
      "postalCode": "string",
      "state": "string",
      "phone": "string",
      "country": "string",
      "nationality": "string",
      "paxType": "AD",
      "sex": "string",
      "email": "user@example.com",
      "repeaterClient": false,
      "primaryPax": true,
      "authDataExchange": true,
      "authReceiveAdvertising": true,
      "authMessageAndPhone": true,
      "authLocalization": true
    }
  ],
  "prices": [
    {
      "date": "2019-08-24T14:15:22Z",
      "amount": 0,
      "currency": "string",
      "taxes": 0
    }
  ],
  "extras": [
    {
      "postMappingSaleServiceCode": "string",
      "startDate": "2019-08-24T14:15:22Z",
      "endDate": "2019-08-24T14:15:22Z",
      "description": "string",
      "quantity": 0,
      "value": 0,
      "chargeType": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
roomNumber	string	true	none	Room number
isFixed	boolean¦null	false	none	Fix room
groupIdentifier	string¦null	false	none	Group identifier
roomTypeFRA	string	true	none	Room type bill code
roomTypeUSE	string¦null	false	none	Room type use code
boardType	string	true	none	Board type code
rateCode	string¦null	false	none	Rate code
desglose	integer(int32)¦null	false	none	Breakdown
ad	integer(int32)	true	none	Num Adult
jr	integer(int32)	true	none	Num Junior
ch	integer(int32)	true	none	Num Child
bb	integer(int32)	true	none	Num Baby
commentList	[string]¦null	false	none	Comments list
preferencesList	[string]¦null	false	none	Preferences list
paxes	[OccupantPost]	true	none	Pax list
prices	[Price]¦null	false	none	Prices list
extras	[Extra]¦null	false	none	Extrass list

ReservationPostResponse

{
  "reservationId": 0,
  "reference": "string"
}

Properties

Name	Type	Required	Restrictions	Description
reservationId	integer(int32)	false	none	Reservation identifier
reference	string¦null	false	none	Reservation reference

ReservationResponse

{
  "reservationId": 0,
  "reference": "string",
  "reservationNumber": 0,
  "year": 0,
  "arrivalDate": "2019-08-24T14:15:22Z",
  "exitDate": "2019-08-24T14:15:22Z",
  "rsvStatus_id": 0,
  "rsvStatus_code": "string",
  "responsible": "string",
  "paxHab": 0,
  "email": "string",
  "preferences": "string",
  "comments": "string",
  "roomNumber": "string",
  "fixedRoom": true,
  "centerCode": "string",
  "centerNumberPrefix": "string",
  "reservationType": "string",
  "desglose": 0,
  "roomTypeFra": "string",
  "roomTypeUse": "string",
  "boardTypeFra": "string",
  "boardTypeUse": "string",
  "ad": 0,
  "jr": 0,
  "ch": 0,
  "bb": 0,
  "preCheckIn": true,
  "salesChannel_id": 0,
  "salesChannel": "string",
  "campaign_id": 0,
  "campaign": "string",
  "crmSegment_id": 0,
  "crmSegment": "string",
  "triplet": {
    "clientComposition_id": 0,
    "ttoO_id": 0,
    "ttoO_code": "string",
    "agency_id": 0,
    "agency_code": "string",
    "customer_id": 0,
    "customer_code": "string"
  },
  "occupants": [
    {
      "reservationPaxId": 0,
      "position": 0,
      "name": "string",
      "surname1": "string",
      "surname2": "string",
      "birthDate": "2019-08-24T14:15:22Z",
      "documentType": "string",
      "documentID": "string",
      "expeditionDateDocument": "2019-08-24T14:15:22Z",
      "address": "string",
      "postalCode": "string",
      "state": "string",
      "country": "string",
      "nationality": "string",
      "language": "string",
      "paxType": "string",
      "sex": "string",
      "email": "string",
      "phone": "string",
      "primaryPax": true,
      "authDataExchange": true,
      "authReceiveAdvertising": true,
      "authMessageAndPhone": true,
      "authLocalization": true,
      "cardexId": 0
    }
  ],
  "observations": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
reservationId	integer(int32)¦null	false	none	Reservation indentifier
reference	string¦null	false	none	Reference
reservationNumber	integer(int32)	false	none	Reservation number
year	integer(int32)¦null	false	none	Year
arrivalDate	string(date-time)¦null	false	none	Arrival Date
exitDate	string(date-time)¦null	false	none	Exit date
rsvStatus_id	integer(int32)¦null	false	none	Reservation status identifier
rsvStatus_code	string¦null	false	none	Reservation status code
responsible	string¦null	false	none	Reservation responsible
paxHab	integer(int32)¦null	false	none	Num Occupants (deprecated)
email	string¦null	false	none	Email
preferences	string¦null	false	none	Preferences
comments	string¦null	false	none	Comments
roomNumber	string¦null	false	none	Room Number
fixedRoom	boolean	false	none	Is room fixed
centerCode	string¦null	false	none	Center code
centerNumberPrefix	string¦null	false	none	Center number prefix
reservationType	string¦null	false	none	ReservationType code
desglose	integer(int32)¦null	false	none	Breakdown
roomTypeFra	string¦null	false	none	RoomType bill code
roomTypeUse	string¦null	false	none	RoomType use code
boardTypeFra	string¦null	false	none	BoardType bill code
boardTypeUse	string¦null	false	none	BoardType use code
ad	integer(int32)¦null	false	none	Num Adult
jr	integer(int32)¦null	false	none	Num Junior
ch	integer(int32)¦null	false	none	Num Child
bb	integer(int32)¦null	false	none	Num Baby
preCheckIn	boolean	false	none	PreCheckin
salesChannel_id	integer(int32)¦null	false	none	Sales channel identifier
salesChannel	string¦null	false	none	Sales channel
campaign_id	integer(int32)¦null	false	none	Campaign identifier
campaign	string¦null	false	none	Campaign
crmSegment_id	integer(int32)¦null	false	none	CRM segment identifier
crmSegment	string¦null	false	none	CRM segment
triplet	TripletCodesResponse	false	none	none
occupants	[OccupantResponse]¦null	false	none	Occupants list
observations	[string]¦null	false	none	Observations list

ReservationsPost

{
  "desglose": 0,
  "year": 0,
  "arrivalDate": "2019-08-24T14:15:22Z",
  "exitDate": "2019-08-24T14:15:22Z",
  "centerCode": "string",
  "salesDate": "2019-08-24T14:15:22Z",
  "localizer": "string",
  "crS_NotificationSended": true,
  "responsible": "string",
  "crM_SegmentCode": "string",
  "futureProduction": true,
  "campaignCode": "string",
  "sentToPushTech": false,
  "dayUse": true,
  "preCheckin": false,
  "sentToReviewPro": false,
  "triplet": {
    "tourOperator": "string",
    "agency": "string",
    "customer": "string"
  },
  "roomList": [
    {
      "roomNumber": "string",
      "isFixed": true,
      "groupIdentifier": "string",
      "roomTypeFRA": "string",
      "roomTypeUSE": "string",
      "boardType": "string",
      "rateCode": "string",
      "desglose": 0,
      "ad": 0,
      "jr": 0,
      "ch": 0,
      "bb": 0,
      "commentList": [
        "string"
      ],
      "preferencesList": [
        "string"
      ],
      "paxes": [
        {
          "name": "string",
          "surname1": "string",
          "surname2": "string",
          "birthDate": "2019-08-24T14:15:22Z",
          "documentID": "string",
          "expeditionDateDocument": "2019-08-24T14:15:22Z",
          "address": "string",
          "postalCode": "string",
          "state": "string",
          "phone": "string",
          "country": "string",
          "nationality": "string",
          "paxType": "AD",
          "sex": "string",
          "email": "user@example.com",
          "repeaterClient": false,
          "primaryPax": true,
          "authDataExchange": true,
          "authReceiveAdvertising": true,
          "authMessageAndPhone": true,
          "authLocalization": true
        }
      ],
      "prices": [
        {
          "date": "2019-08-24T14:15:22Z",
          "amount": 0,
          "currency": "string",
          "taxes": 0
        }
      ],
      "extras": [
        {
          "postMappingSaleServiceCode": "string",
          "startDate": "2019-08-24T14:15:22Z",
          "endDate": "2019-08-24T14:15:22Z",
          "description": "string",
          "quantity": 0,
          "value": 0,
          "chargeType": "string"
        }
      ]
    }
  ],
  "retainersList": [
    {
      "code": "string",
      "retainerBreakDown": 0,
      "rAmount": 0,
      "paymentMethod": "string",
      "observations": "string",
      "retainerDateTime": "2019-08-24T14:15:22Z",
      "retainerType_id": 0,
      "retainerDate": "string",
      "formatDate": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
desglose	integer(int32)¦null	false	none	Breakdown
year	integer(int32)	true	none	Year
arrivalDate	string(date-time)	true	none	Arrival date
exitDate	string(date-time)	true	none	Exit date
centerCode	string	true	none	Cener code
salesDate	string(date-time)¦null	false	none	Sales date
localizer	string¦null	false	none	Localizer
crS_NotificationSended	boolean	true	none	CRS Notification Sended
responsible	string¦null	false	none	Adult responsible
crM_SegmentCode	string¦null	false	none	CRM segment code
futureProduction	boolean	true	none	Future production
campaignCode	string¦null	false	none	Campaign code
sentToPushTech	boolean	true	none	none
dayUse	boolean	true	none	Is day use
preCheckin	boolean	true	none	Pre Check In indicator
sentToReviewPro	boolean	true	none	none
triplet	TripletCodes	true	none	none
roomList	[ReqRooms]	true	none	Rooms list
retainersList	[RetainersCrx]¦null	false	none	Retainers list

ReservationsUpdateDTO

{
  "reservation_id": 0,
  "appCustomer_id": 0,
  "center_id": 0,
  "arrivalDate": "2019-08-24T14:15:22Z",
  "exitDate": "2019-08-24T14:15:22Z",
  "rsvStatus": 0,
  "rsvInvoiceStatus": 0,
  "roomTypeUse_id_fk": 0,
  "roomTypeFra_id_fk": 0,
  "boardTypeUse_id_fk": 0,
  "boardTypeFra_id_fk": 0,
  "roomId": 0,
  "reference": "string",
  "responsible": "string",
  "ad": 0,
  "jr": 0,
  "ch": 0,
  "bb": 0
}

Properties

Name	Type	Required	Restrictions	Description
reservation_id	integer(int32)	false	none	Reservation identifier
appCustomer_id	integer(int32)	false	none	AppCustomer identifier
center_id	integer(int32)¦null	false	none	Center identifier
arrivalDate	string(date-time)¦null	false	none	Arrival date
exitDate	string(date-time)¦null	false	none	Exit date
rsvStatus	integer(int32)¦null	false	none	Reservation status identifier
rsvInvoiceStatus	integer(int32)¦null	false	none	Reservation Invoice status identifier
roomTypeUse_id_fk	integer(int32)¦null	false	none	RoomType use identifier
roomTypeFra_id_fk	integer(int32)¦null	false	none	RoomType bill identifier
boardTypeUse_id_fk	integer(int32)¦null	false	none	BoardType use identifier
boardTypeFra_id_fk	integer(int32)¦null	false	none	BoardType bill identifier
roomId	integer(int32)¦null	false	none	Room identifer
reference	string¦null	false	none	Reference
responsible	string¦null	false	none	Reserevation responsible
ad	integer(int32)	false	none	Num Adult
jr	integer(int32)	false	none	Num Junior
ch	integer(int32)	false	none	Num Child
bb	integer(int32)	false	none	Num Baby

RetainersCrx

{
  "code": "string",
  "retainerBreakDown": 0,
  "rAmount": 0,
  "paymentMethod": "string",
  "observations": "string",
  "retainerDateTime": "2019-08-24T14:15:22Z",
  "retainerType_id": 0,
  "retainerDate": "string",
  "formatDate": "string"
}

Properties

Name	Type	Required	Restrictions	Description
code	string¦null	false	none	Retainer code
retainerBreakDown	integer(int32)	true	none	Retainer BreakDown key
rAmount	number(double)	true	none	Amount
paymentMethod	string	true	none	Payment Method code
observations	string¦null	false	none	Observations
retainerDateTime	string(date-time)¦null	false	none	Retainer Date (DateTime type)
retainerType_id	integer(int32)¦null	false	none	Retainer Type identifier
retainerDate	string¦null	false	none	Retainer Date (String type)
formatDate	string¦null	false	none	Date format (For string type, usually not needed)

RetainersPost

{
  "reservationId": 0,
  "retainerCRX": {
    "code": "string",
    "retainerBreakDown": 0,
    "rAmount": 0,
    "paymentMethod": "string",
    "observations": "string",
    "retainerDateTime": "2019-08-24T14:15:22Z",
    "retainerType_id": 0,
    "retainerDate": "string",
    "formatDate": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
reservationId	integer(int32)	true	none	Reservation identifier
retainerCRX	RetainersCrx	true	none	none

RetainersResponse

{
  "reservationId": 0,
  "reservationReference": "string",
  "retainerId": 0,
  "retainerNumber": "string",
  "retainerType_id": 0,
  "retainerType": "string",
  "amount": 0,
  "date": "2019-08-24T14:15:22Z",
  "retainerStatus_id": 0,
  "retainerStatus": "string",
  "observations": "string",
  "paymentMethod": "string",
  "cashRegister": true,
  "invStatus_id_fk": 0,
  "invoiceStatus": "string"
}

Properties

Name	Type	Required	Restrictions	Description
reservationId	integer(int32)¦null	false	none	Reservation identifier
reservationReference	string¦null	false	none	Reservation reference
retainerId	integer(int32)	false	none	Retainer identifier
retainerNumber	string¦null	false	none	Retainer number
retainerType_id	integer(int32)¦null	false	none	Retainer Type identifier
retainerType	string¦null	false	none	Retainer Type description
amount	number(double)¦null	false	none	Amount
date	string(date-time)¦null	false	none	Date
retainerStatus_id	integer(int32)¦null	false	none	Retainer status identifier
retainerStatus	string¦null	false	none	Retainer status description
observations	string¦null	false	none	Observations
paymentMethod	string¦null	false	none	Payment method
cashRegister	boolean¦null	false	none	Is cash register
invStatus_id_fk	integer(int32)¦null	false	none	Invoice status identifier
invoiceStatus	string¦null	false	none	Invoice status description

RoomRangeResponse

{
  "roomRange_id": 0,
  "description": "string",
  "center_id": 0,
  "centerCode": "string"
}

Properties

Name	Type	Required	Restrictions	Description
roomRange_id	integer(int32)	false	none	Room Range identifier
description	string¦null	false	none	Description
center_id	integer(int32)	false	none	Center identifier
centerCode	string¦null	false	none	Center code

RoomTypesCenterResponse

{
  "roomTypeCenter_id_pk": 0,
  "centerCode": "string",
  "center_id_fk": 0,
  "roomTypeCode": "string",
  "roomType_id_fk": 0,
  "description": "string",
  "descriptionDetailed": "string",
  "real": true,
  "order": 0,
  "locked": true,
  "rooms": 0,
  "maximum_occupancy": 0,
  "minimum_occupancy": 0,
  "regular_occupancy": 0,
  "establishmentCategoryCode": "string",
  "establishmentCategory_id_fk": 0
}

Properties

Name	Type	Required	Restrictions	Description
roomTypeCenter_id_pk	integer(int32)	false	none	RoomTypeCenter identifier
centerCode	string¦null	false	none	Center code
center_id_fk	integer(int32)	false	none	Center identifier
roomTypeCode	string¦null	false	none	RoomType code
roomType_id_fk	integer(int32)	false	none	RoomType identifier
description	string¦null	false	none	Description
descriptionDetailed	string¦null	false	none	DescriptionDetailed
real	boolean¦null	false	none	Is real
order	integer(int32)¦null	false	none	Order
locked	boolean	false	none	Is locked
rooms	integer(int32)	false	none	Num associated Rooms
maximum_occupancy	integer(int32)¦null	false	none	Max occupancy
minimum_occupancy	integer(int32)¦null	false	none	Min occupancy
regular_occupancy	integer(int32)¦null	false	none	Regular occupancy
establishmentCategoryCode	string¦null	false	none	Establishment code
establishmentCategory_id_fk	integer(int32)¦null	false	none	Establishment identifier

RoomTypesResponse

{
  "code": "string",
  "roomType_id_pk": 0,
  "description": "string",
  "maximum_occupancy": 0,
  "minimum_occupancy": 0,
  "regular_occupancy": 0
}

Properties

Name	Type	Required	Restrictions	Description
code	string¦null	false	none	RoomType code
roomType_id_pk	integer(int32)	false	none	RoomType identifier
description	string¦null	false	none	Description
maximum_occupancy	integer(int32)¦null	false	none	Max occupancy
minimum_occupancy	integer(int32)¦null	false	none	Min occupancy
regular_occupancy	integer(int32)¦null	false	none	Regular occupancy

RoomsResponse

{
  "room_id_pk": 0,
  "centerCode": "string",
  "center_id_fk": 0,
  "roomTypeCode": "string",
  "roomTypeCenter_id_fk": 0,
  "roomType_id_fk": 0,
  "number": "string",
  "phone": 0,
  "floorCode": "string",
  "floor_id_fk": 0,
  "roomRangeCode": "string",
  "roomRange_id_fk": 0,
  "blockCode": "string",
  "block_id_fk": 0,
  "description": "string",
  "descriptionDetailed": "string",
  "real": true,
  "virtual": true,
  "cleaned": true,
  "locked": true
}

Properties

Name	Type	Required	Restrictions	Description
room_id_pk	integer(int32)	false	none	Room identifier
centerCode	string¦null	false	none	Center code
center_id_fk	integer(int32)¦null	false	none	Center identifier
roomTypeCode	string¦null	false	none	RoomType code
roomTypeCenter_id_fk	integer(int32)¦null	false	none	RoomTypeCenter identifier
roomType_id_fk	integer(int32)¦null	false	none	RoomType identifier
number	string¦null	false	none	Room number
phone	integer(int32)¦null	false	none	Room phone
floorCode	string¦null	false	none	Floor code
floor_id_fk	integer(int32)¦null	false	none	Floor identifier
roomRangeCode	string¦null	false	none	RoomRange code
roomRange_id_fk	integer(int32)¦null	false	none	RoomRange identifier
blockCode	string¦null	false	none	Block code
block_id_fk	integer(int32)¦null	false	none	Block identifier
description	string¦null	false	none	Description
descriptionDetailed	string¦null	false	none	Description detailed
real	boolean¦null	false	none	Is real
virtual	boolean	false	none	Is virtual
cleaned	boolean	false	none	Is cleaned
locked	boolean	false	none	Is locked

SalesServicesConditions

{
  "salesServicesConditions_id": 0,
  "name": "string",
  "language": "string",
  "description": "string"
}

Properties

Name	Type	Required	Restrictions	Description
salesServicesConditions_id	integer(int32)	false	none	Sales service condition identifier
name	string¦null	false	none	Condition name
language	string¦null	false	none	Condition language
description	string¦null	false	none	Condition description

SalesServicesGroupResonse

{
  "salesServiceGroup_id": 0,
  "salesServiceGroup_name": "string",
  "centerCode": "string",
  "description": "string",
  "isOmit": true,
  "isLodgement": true,
  "isBoard": true,
  "isLocked": true
}

Properties

Name	Type	Required	Restrictions	Description
salesServiceGroup_id	integer(int32)	false	none	Sales service group identifier
salesServiceGroup_name	string¦null	false	none	Sales service group name
centerCode	string¦null	false	none	Center code
description	string¦null	false	none	Description
isOmit	boolean	false	none	Is omit
isLodgement	boolean	false	none	Is lodgement
isBoard	boolean	false	none	Is board
isLocked	boolean	false	none	Is locked

SalesServicesResponse

{
  "service_id": 0,
  "centerCode": "string",
  "name": "string",
  "description": "string",
  "externalCode": "string",
  "serviceType_id": 0,
  "serviceType_desc": "string",
  "salesServiceGroup_id": 0,
  "salesServiceGroup_name": "string",
  "vatPercent": 0,
  "price": 0,
  "dailyPrice": true,
  "department_code": "string",
  "salesServicesConditions": [
    {
      "salesServicesConditions_id": 0,
      "name": "string",
      "language": "string",
      "description": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
service_id	integer(int32)	false	none	Service identifier
centerCode	string¦null	false	none	Center code
name	string¦null	false	none	Service name
description	string¦null	false	none	Description
externalCode	string¦null	false	none	Service external code
serviceType_id	integer(int32)¦null	false	none	Service type identifier
serviceType_desc	string¦null	false	none	Service type code
salesServiceGroup_id	integer(int32)¦null	false	none	Sales service group identifier
salesServiceGroup_name	string¦null	false	none	Sales service group code
vatPercent	number(double)¦null	false	none	Taxes
price	number(double)¦null	false	none	Price
dailyPrice	boolean	false	none	Is daily price
department_code	string¦null	false	none	Department code
salesServicesConditions	[SalesServicesConditions]¦null	false	none	Conditions

Schedule

{
  "centerCode": "string",
  "employeeCode": "string",
  "dateTime": "2019-08-24T14:15:22Z",
  "department": "string",
  "type": 0
}

Properties

Name	Type	Required	Restrictions	Description
centerCode	string	true	none	none
employeeCode	string	true	none	none
dateTime	string(date-time)	true	none	none
department	string¦null	false	none	none
type	integer(int32)	false	none	none

SchedulePost

{
  "schedules": [
    {
      "centerCode": "string",
      "employeeCode": "string",
      "dateTime": "2019-08-24T14:15:22Z",
      "department": "string",
      "type": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
schedules	[Schedule]	true	none	none

SegmentResponse

{
  "segment_id": 0,
  "segment_name": "string",
  "isDynamic": true,
  "scope": 0
}

Properties

Name	Type	Required	Restrictions	Description
segment_id	integer(int32)	false	none	Segment identifier
segment_name	string¦null	false	none	Segment name
isDynamic	boolean	false	none	Is dynamic
scope	integer(int32)	false	none	Scope

StatsByCenterResponse

{
  "date": "2019-08-24T14:15:22Z",
  "roomsAvaliable": 0,
  "roomsSold": 0,
  "roomsOutOfOrder": 0,
  "centerGuests": 0,
  "roomRevenue": 0,
  "totalRevenue": 0
}

Properties

Name	Type	Required	Restrictions	Description
date	string(date-time)	false	none	Date
roomsAvaliable	integer(int32)	false	none	Rooms avaliable / Availability
roomsSold	integer(int32)	false	none	Rooms sold / Occupancy
roomsOutOfOrder	integer(int32)	false	none	Rooms out of order / Locked
centerGuests	integer(int32)	false	none	Center guests / Stays
roomRevenue	number(double)	false	none	Room revenue (no Tax)
totalRevenue	number(double)	false	none	Total revenue (no Tax)

StaysXPaxResponse

{
  "center_id_fk": 0,
  "center": "string",
  "date": "2019-08-24T14:15:22Z",
  "ad": 0,
  "jr": 0,
  "ch": 0,
  "bb": 0
}

Properties

Name	Type	Required	Restrictions	Description
center_id_fk	integer(int32)	false	none	Center identifier
center	string¦null	false	none	Hotel Code
date	string(date-time)¦null	false	none	Date
ad	integer(int32)¦null	false	none	Adults counter
jr	integer(int32)¦null	false	none	Junior counter
ch	integer(int32)¦null	false	none	Children counter
bb	integer(int32)¦null	false	none	Baby counter

SuppliesResponse

{
  "supplyId": 0,
  "reservationId": 0,
  "salesService": "string",
  "salesServiceCode": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "description": "string",
  "quantity": 0,
  "value": 0,
  "invStatus_id_fk": 0,
  "invoiceStatus": "string",
  "taxIncluded": true,
  "chargeType": "string",
  "priceCalculated": true,
  "comments": "string"
}

Properties

Name	Type	Required	Restrictions	Description
supplyId	integer(int32)	false	none	Supply identifier
reservationId	integer(int32)	false	none	Reservation identifier
salesService	string¦null	false	none	SalesService description
salesServiceCode	string¦null	false	none	SalesService code
startDate	string(date-time)¦null	false	none	Start date
endDate	string(date-time)¦null	false	none	End date
description	string¦null	false	none	Description
quantity	integer(int32)¦null	false	none	Quantity
value	number(double)¦null	false	none	Value
invStatus_id_fk	integer(int32)¦null	false	none	Invoice status identifier
invoiceStatus	string¦null	false	none	Invoice status description
taxIncluded	boolean¦null	false	none	Is VAT inclusive
chargeType	string¦null	false	none	Charge Type
priceCalculated	boolean	false	none	Is price calculated
comments	string¦null	false	none	Comments

TaskTypeResponse

{
  "taskType_id": 0,
  "taskType_name": "string",
  "department_id": 0,
  "department_name": "string",
  "showForecast": true
}

Properties

Name	Type	Required	Restrictions	Description
taskType_id	integer(int32)	false	none	TaskType identifier
taskType_name	string¦null	false	none	TaskType name
department_id	integer(int32)¦null	false	none	Department identifier
department_name	string¦null	false	none	Department name
showForecast	boolean	false	none	Is show forecast

TasksResponse

{
  "task_id": 0,
  "centerCode": "string",
  "taskNumber": 0,
  "status": 0,
  "blockPlanned": true,
  "priority": 0,
  "department_id": 0,
  "department_code": "string",
  "taskType_id": 0,
  "taskType_code": "string",
  "employeeInformed_id": 0,
  "employeeInformed": "string",
  "employeeRepair_id": 0,
  "employeeRepair": "string",
  "employeeNoticed_id": 0,
  "employeeNoticed": "string",
  "room_code": "string",
  "centerZone_code": "string",
  "asset_id": 0,
  "store_id": 0,
  "fixedAsset": "string",
  "lockedRoom": true,
  "dateCommunication": "2019-08-24T14:15:22Z",
  "dateStartingTask": "2019-08-24T14:15:22Z",
  "dateEndingTask": "2019-08-24T14:15:22Z",
  "insuranceNotified": true,
  "courtesyCall": 0,
  "observations": "string",
  "taskPlanning_id": 0,
  "taskPlanningDescription": "string",
  "creationUser": "string",
  "amountServices": 0,
  "amountProducts": 0,
  "documents": [
    {
      "document_id": 0,
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "fileName": "string",
      "accessUrl": "string"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
task_id	integer(int32)	false	none	Description
centerCode	string¦null	false	none	Center code
taskNumber	integer(int32)¦null	false	none	Task number
status	integer(int32)¦null	false	none	Status
blockPlanned	boolean	false	none	Is block planned
priority	integer(int32)¦null	false	none	Priority
department_id	integer(int32)¦null	false	none	Department identifier
department_code	string¦null	false	none	Department code
taskType_id	integer(int32)¦null	false	none	TaskType identifier
taskType_code	string¦null	false	none	TaskType code
employeeInformed_id	integer(int32)¦null	false	none	Employee informed identifier
employeeInformed	string¦null	false	none	Employee informed
employeeRepair_id	integer(int32)¦null	false	none	Employee repair identifier
employeeRepair	string¦null	false	none	Employee repair
employeeNoticed_id	integer(int32)¦null	false	none	Employee noticed
employeeNoticed	string¦null	false	none	Employee noticed
room_code	string¦null	false	none	Room code
centerZone_code	string¦null	false	none	CenterZone code
asset_id	integer(int32)¦null	false	none	Asset identifier
store_id	integer(int32)¦null	false	none	Store identifier
fixedAsset	string¦null	false	none	Fixes asset
lockedRoom	boolean	false	none	is LocedRoom
dateCommunication	string(date-time)¦null	false	none	Communication date
dateStartingTask	string(date-time)¦null	false	none	Start date
dateEndingTask	string(date-time)¦null	false	none	End date
insuranceNotified	boolean¦null	false	none	Is insurance notified
courtesyCall	integer(int32)¦null	false	none	Courtesy call code
observations	string¦null	false	none	Observations
taskPlanning_id	integer(int32)¦null	false	none	Task planning identifier
taskPlanningDescription	string¦null	false	none	Task planning description
creationUser	string¦null	false	none	Creation user
amountServices	number(double)	false	none	Observations
amountProducts	number(double)	false	none	Observations
documents	[DocumentResponse_min]¦null	false	none	List of associated documents

TasksUpdateDTO

{
  "task_id": 0,
  "taskNumber": 0,
  "appCustomer_id": 0,
  "center_id": 0,
  "startDate": "2019-08-24T14:15:22Z",
  "endDate": "2019-08-24T14:15:22Z",
  "taskStatus": 0,
  "priority": 0,
  "room_id": 0,
  "lockedRoom": true
}

Properties

Name	Type	Required	Restrictions	Description
task_id	integer(int32)	false	none	Task identifier
taskNumber	integer(int32)¦null	false	none	Task number
appCustomer_id	integer(int32)	false	none	AppCustomer identifier
center_id	integer(int32)¦null	false	none	Center identifier
startDate	string(date-time)¦null	false	none	Starting date
endDate	string(date-time)¦null	false	none	Ending date
taskStatus	integer(int32)¦null	false	none	Task status identifier
priority	integer(int32)¦null	false	none	Task priority
room_id	integer(int32)¦null	false	none	Room identifier
lockedRoom	boolean	false	none	Is Room locked

TokenApi

{
  "accessToken": "string",
  "refreshToken": "string"
}

Properties

Name	Type	Required	Restrictions	Description
accessToken	string¦null	false	none	Access Token
refreshToken	string¦null	false	none	Refresh Token

TripletCodes

{
  "tourOperator": "string",
  "agency": "string",
  "customer": "string"
}

Properties

Name	Type	Required	Restrictions	Description
tourOperator	string	true	none	PMS Tour operator code
agency	string	true	none	PMS Agency operator code
customer	string	true	none	PMS Customer operator code

TripletCodesResponse

{
  "clientComposition_id": 0,
  "ttoO_id": 0,
  "ttoO_code": "string",
  "agency_id": 0,
  "agency_code": "string",
  "customer_id": 0,
  "customer_code": "string"
}

Properties

Name	Type	Required	Restrictions	Description
clientComposition_id	integer(int32)¦null	false	none	Client composition identifier
ttoO_id	integer(int32)¦null	false	none	Tour operator identifier
ttoO_code	string¦null	false	none	Tour operator code
agency_id	integer(int32)¦null	false	none	Agency identifier
agency_code	string¦null	false	none	Agency code
customer_id	integer(int32)¦null	false	none	Customer identifier
customer_code	string¦null	false	none	Customer code

UserInfoResponse

{
  "user_id": "string",
  "username": "string",
  "department_id": 0,
  "department_code": "string",
  "employee_id": 0,
  "employee_code": "string",
  "center_codes": [
    "string"
  ],
  "roles": [
    {
      "name": "string",
      "permissions": [
        "string"
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
user_id	string¦null	false	none	User identifier
username	string¦null	false	none	Username
department_id	integer(int32)¦null	false	none	Department identifier
department_code	string¦null	false	none	Department code
employee_id	integer(int32)¦null	false	none	Employee identifier
employee_code	string¦null	false	none	Employee code
center_codes	[string]¦null	false	none	Centers the user has access to
roles	[InfoRoles]¦null	false	none	List of user roles