The Export API is an interface aimed for a Juniper client (or a company that will be working in their behalf) to be capable of automatically retrieving and/or updating internal information from the Juniper system. This may be used in order to synchronize data from and/or to an ERP system.
In order to understand the integration process of this API, we've prepared flow charts that outline and simplify all of the steps that need to be taken on the two main processes that may be implemented:
From which, at the same time, it Is divided into four differentiated steps:
Important note:
Before we dwell into each one of these steps in detail, it is first very important to understand that they represent a brief overview of all of the features that may be implemented in order to perform an integration between the Juniper and a ERP system. Given the case, it may not be neccesary for you to implement all of them which will ultimately be up to you and/or your Juniper client.
For example, you may wish to strictly implement Supplier accountability or you may wish to use this API strictly for the retrieval of booking information through the use of the getBookings request.
Do not hesitate to contact with your Juniper client if you had any kind of doubt in this regard.
We will proceed to describe each one of these:
Before taking any accountable action, it is important to synchronize both systems so that all of the client / supplier information will be properly set up on both ends (on the Juniper system and on the ERP system).
For this end, we recommend you to create this information on the Juniper system and simply export the same to the ERP system, through the use of the following transactions:
But, if you wish to perform the same otherwise (create and manage this information on the ERP and upload the same to the Juniper system), you can do so through the use of the following transactions:
Having already synchronized all of the client and supplier information between both systems (the Juniper and the ERP system), the next step here would be to perform the booking reconciliation (in order to retrieve both the cost and sales price of these bookings, which we will use on our latter step).
You will be able to do so by using the two following transactions:
Which will allow you to retrieve all of the detailed booking information of the system, kindly refer to the following workflow which outlines how should this process be implemented:
Having already retrieved all of the cost and sales prices of these bookings, you will be able to reconcile the same on:
Important note:
It is important to note that all of the transactions found within Invoice Transactions require for the accounting module to be available on the Juniper system reason for which, if this were not the case, it will not be possible for you to implement and use any of these transactions (on which case, your integration process should rather focus on the getBookings request).
Additionally, it is also important to note that this API may not have all of the information that your legislation may request, review the specs and/or contact with your Juniper client for further information in this regard.
Having already retrieved all of the booking and invoice information, you will be able to retrieve their related payments through the following transactions:
Following the Getting Started section found on the home page, we would like to add an example of the Export test environment endpoint for your reference.
On which, it is important to note that this API has multiple transaction groups and that each pertaining group will be found under their own asmx, kindly refer to the following example:
https://juniper-uat.bookingengine.es/wsExportacion/wsCustomers.asmx
Important note:
Being juniper-uat.bookingengine.es the endpoint of the test environment and the part that you would have to replace if you wished to connect to a different environment. This is very important to keep in mind for when you connect to the live environment and/or if you plan on connecting with multiple Juniper clients.
And to examples of each one of the available transaction groups:
Through this web service, you may obtain a list of all customers in the system, given several filters. In addition, you will be able to create new customers in the system as well as to modify all existing customers.
The available methods are the following:
This method returns a complete list of all customers configured in the system. The request parameters of this method are:
The XML returned through this method is the following:
<wsResult xmlns = "">
<Customers>
<Customer Id = "222" Type = "1" SeesCommission = "False" CategoryLeader = "False" GroupLeader = "False" CreationDate = "23/12/2019 13:08:54" ActivationDate = "16/02/2020 13:43:21" Active = "True"
AgencyRefRequired = "False" IATA = "" AgencyExternalRefRequired = "False" PaymentType = "T" Market = "8" TravelAssociation="False" CreateBookings="True" ExternalSiteBookingAccess="True">
<General>
<Name><![CDATA[Test]]></Name>
<RegistrationName><![CDATA[]]></RegistrationName>
<ClientRefNumber><![CDATA[]]></ClientRefNumber>
<Category Id = "119"><![CDATA[Agencies]]></Category>
<AgencyGroup Id = "39"><![CDATA[Worldwide_others]]></AgencyGroup>
<Channel Id = "UAE "><![CDATA[Web AED]]></Channel>
<LastModified>26/04/2013 16:33:02</LastModified>
<CustomerManager Id = "123"><![CDATA[customerManager]]></CustomerManager>
<AccountManager Id = "162"><![CDATA[accountManager]]></AccountManager>
<Integrator><![CDATA[Test XML]]></Integrator>
<Currencies>
<Currency Code = "EUR">Euros</Currency>
<Currency Code = "GBP">Pounds £</Currency>
</Currencies>
<BranchOffice HeadOfficeId = "117">True</BranchOffice>
<BlockBookings>False</BlockBookings>
<DaysMargin value="2">
<Channels>
<Channel Id="" value="0"/>
<Channel Id="Dbg " value="1"/>
</Channels>
</DaysMargin>
<DateFormat>dd/MM/yyyy</DateFormat>
</General>
<Contact>
<ContactName><![CDATA[]]></ContactName>
<CompanyName><![CDATA[]]></CompanyName>
<Remarks><![CDATA[]]></Remarks>
<Phone1><![CDATA[]]></Phone1>
<Phone2><![CDATA[]]></Phone2>
<Mobile><![CDATA[]]></Mobile>
<Fax><![CDATA[]]></Fax>
<Email><![CDATA[monica.loayza@ejuniper.com]]></Email>
<Address><![CDATA[]]></Address>
<Country><![CDATA[]]></Country>
<City ZIP = ""><![CDATA[]]></City>
<State><![CDATA[]]></State>
</Contact>
<InvoicingDetails TaxId = "" TradeCode = "" PaymentTerms = "">
<ContactName><![CDATA[]]></ContactName>
<CreditCard1><![CDATA[]]></CreditCard1>
<CreditCard2><![CDATA[]]></CreditCard2>
<InvoiceContact><![CDATA[]]></InvoiceContact>
<AccountRefNumber><![CDATA[WS22/05/202012:11:17]]></AccountRefNumber>
<CompanyName><![CDATA[]]></CompanyName>
<Phone1><![CDATA[]]></Phone1>
<Phone2><![CDATA[]]></Phone2>
<Fax><![CDATA[]]></Fax>
<Mobile><![CDATA[]]></Mobile>
<Email><![CDATA[]]></Email>
<Address><![CDATA[]]></Address>
<AddressNumber><![CDATA[]]></AddressNumber>
<AddressBuilding><![CDATA[]]></AddressBuilding>
<Country><![CDATA[]]></Country>
<City ZIP = ""><![CDATA[]]></City>
<State><![CDATA[]]></State>
<District><![CDATA[]]></District>
<Town><![CDATA[]]></Town>
<BankAccountsAllowed>
<BankAccount Id = "1">Bank USD Account</BankAccount>
<BankAccount Id = "2">Citibank</BankAccount>
</BankAccountsAllowed>
</InvoicingDetails>
<Annotations>
<FictionalWebMarkup Active="False" Editable="False" BranchOffice="False" AllowsPriceIncrease="False" AllowsPriceDecrease="False">
<Percentage></Percentage>
<MaximumIncrementPercentage></MaximumIncrementPercentage>
</FictionalWebMarkup>
</Annotations>
<Agents>
<Agent Id = "30" Active = "True" Commission = "" CommissionPercentage = "">
<Name><![CDATA[Esther]]></Name>
<AccountRefNumber><![CDATA[]]></AccountRefNumber>
<Email><![CDATA[esther.roig@ejuniper.com]]></Email>
</Agent>
<Agent Id = "35" Active = "True" Commission = "" CommissionPercentage = "">
<Name><![CDATA[Monica]]></Name>
<AccountRefNumber><![CDATA[]]></AccountRefNumber>
<Email><![CDATA[monica.loayza@ejuniper.com]]></Email>
</Agent>
</Agents>
<RepAgencies>
<RepAgency Id = "43">Test Agency</RepAgency>
<RepAgency Id = "45">Test Agency 2</RepAgency>
</RepAgencies>
</Customer>
</Customers>
</wsResult>
Details of the nodes and attributes:
Node / Attribute (@) | Type | Description |
---|---|---|
Customer | - | Item Customer. |
./Customer/@Id | Numeric | Customer Id. |
./Customer/@Type | Numeric | It indicates the customer type. |
./Customer/@SeesCommissionto | Boolean | Bit to indicate if the communications to the agencies should include the commission. |
./Customer/@CategoryLeader | Boolean | Indicates if it is the category leader. |
./Customer/@GroupLeader | Boolean | Indicates if it is the group leader. |
./Customer/@CreationDate | DateTime | Set up date of the customer in the system. |
./Customer/@ActivationDate | DateTime | Activation dateof the customer in the system. |
./Customer/@Active | Boolean | Bit that indicates if the customer is active. |
./Customer/@AgencyRefRequired | Boolean | Indictes if the customer has to insert an internal reference when making a booking. |
./Customer/@IATA | String(50) | IATA Code. |
./Customer/@AgencyExternalRefRequired | Boolean | Indicates if the customer ha to insert the external customer reference code when making a booking. |
./Customer/@PaymentType | Numeric | Payment type. Possible values: • C: Credit • T: POS • B: Pre-payment |
./Customer/@Market | Numeric | Customer has an associated market. |
./Customer/@TravelAssociation | Boolean | Customer is a travel association. |
./Customer/@CreateBookings | Boolean | Customer can create new bookings. |
./Customer/@ExternalSiteBookingAccess | Boolean | Customer has access to external booking site. |
./Customer/General | - | Item General. |
./General/Name | String(100) | Name of the customer. |
./General/RegistrationName | String(150) | Tax registration name. |
./General/ClientRefNumber | String(50) | External reference code. |
./General/Category | String(50) | Customer category. |
./Category/@Id | Numeric | Category Id. |
./General/AgencyGroup | String(100) | Agency group name. |
./AgencyGroup/@Id | Numeric | Agency group id. |
./General/CustomerGroup | String | Customer group name. |
./CustomerGroup/@Id | Numeric | Customer group id. |
./General/LastModified | DateTime | Modification date of the customer. |
./General/CustomerManager | String(200) | Customer Manager name. |
./CustomerManager/@Id | Numeric | Customer Manager Id. |
./General/AccountManager | String(100) | Account Manager name. |
./AccountManager/@Id | Numeric | Account Manager Id. |
./General/DefaultCountry | String(100) | Default country name. |
./DefaultCountry/@Id | Numeric | Default country id. |
./General/Integrator | String(150) | Integrator name. |
./General/ActivationDate | DateTime | Activation date. |
./General/Name | String(100) | Name of the customer. |
./General/RegistrationName | String(150) | Tax registration name. |
./General/ClientRefNumber | String(50) | External reference code. |
./General/Category | String(50) | Customer category. |
./General/Currencies | - | List of currency codes that are available for the customer. If no currency is configured on the client, this node will return all of the available client group currencies. |
./Currencies/@Code | String(3) | Currency code. Format ISO 4217. |
./Currencies/Currency | String(100) | Currency name. |
./General/BranchOffice | Boolean | Indicates if the customer is a branch office. |
./BranchOffice/@HeadOfficeId | Numeric | If it is a branch office, indicates the id of the head office. |
./General/Login | String(100) | Customer login username. |
./General/BlockBookings | Boolean | Indicates if the bookings blocked. |
./General/DaysMargin | - | |
./DaysMargin/@value | Numeric | Days of Margin |
./DaysMargin/Channels | - | |
./Channels/Channel | - | |
./Channel/@Id | String (10) | Channel id |
./Channel/@value | Numeric | Days of margin for the channel |
./General/DateFormat | String (10) | Indicates the date format |
./Customer/Contact | - | Item Contact. |
./Contact/ContactName | String(50) | Contact person. |
./Contact/CompanyName | String(150) | Company name. |
./Contact/Remarks | String(1000) | Customer remarks. |
./Contact/Phone1 | String(50) | Telephone 1. |
./Contact/Phone2 | String(50) | Telephone 2. |
./Contact/Mobile | String(50) | Mobile. |
./Contact/Fax | DateTime | Fax. |
./Contact/Email | String(50) | Email address. |
./Contact/Address | String(75) | Address. |
./Contact/Country | String(50) | Country. |
./Contact/City | String(50) | City. |
./City/@ZIP | String(20) | Postal code / ZIP Code. |
./Contact/State | String(50) | State. |
./Contact/District | String(50) | District. |
./Contact/Town | String(50) | Town. |
./Customer/InvoicingDetails | - | Invoicind Details Item. |
./InvoicingDetails/TaxID | String(25) | Tax Registration number related to the customer. |
./InvoicingDetails/TradeCode | String(50) | BAL Code in cas there was any turist based enterprise registered n the fiscal address. |
./InvoicingDetails/PaymentTerms | Numeric | Number of working days to perform the payment. |
./InvoicingDetails/ContactName | String(50) | Contact person. |
./InvoicingDetails/CreditCard1 | String(500) | Credit card details 1. |
./InvoicingDetails/CreditCard2 | String(500) | Credit card details 2. |
./InvoicingDetails/InvoiceContact | String(50) | Invoicing contact person. |
./InvoicingDetails/AccountRefNumber | String(100) | External reference code. |
./InvoicingDetails/CompanyName | String(100) | CompanyName. |
./InvoicingDetails/Phone1 | String(50) | Telephone 1. |
./InvoicingDetails/Phone2 | String(50) | Telephone 2. |
./InvoicingDetails/Mobile | String(50) | Mobile. |
./InvoicingDetails/Fax | DateTime | Fax. |
./InvoicingDetails/Email | String(50) | Email address. |
./InvoicingDetails/Address | String(75) | Address. |
./InvoicingDetails/AddressNumber | String(75) | Address number. |
./InvoicingDetails/AddressBuilding | String(75) | Address building. |
./InvoicingDetails/Country | String(50) | Country. |
./InvoicingDetails/City | String(50) | City. |
./City/@ZIP | String(20) | Postal code / ZIP code. |
./InvoicingDetails/State | String(50) | State. |
./InvoicingDetails/District | String(50) | District. |
./InvoicingDetails/Town | String(50) | Town. |
./InvoicingDetails/CreditLimit | Numeric | Customer booking credit limit. |
./CreditLimit/@Available | Numeric | Customer booking available credit. Only available on single customers request on which the AmountBaseCurrency option is specified. |
./CreditLimit/@CurrencyCode | String(3) | Customer booking credit limit currency code. |
./InvoicingDetails/BillingLimit | Numeric | Customer billing limit. |
./BillingLimit/@Available | Numeric | Customer billing available credit. Only available on single customers request on which the AmountBaseCurrency option is specified. |
./BillingLimit/@CurrencyCode | String(3) | Customer billing limit currency code. |
./InvoicingDetails/TotalAmounts | - | Total amounts related to the customer. Only available on single customers request on which the AmountBaseCurrency option is specified. |
./TotalAmounts/Invoiced | Numeric | Total invoiced amount. |
./Invoiced/@CurrencyCode | String(3) | Total invoiced amount currency code. |
./TotalAmounts/Booked | Numeric | Total booked amount. |
./Booked/@CurrencyCode | String(3) | Total booked amount currency code. |
./TotalAmounts/Paid | Numeric | Total paid amount. |
./Paid/@CurrencyCode | String(3) | Total paid amount currency code. |
./InvoicingDetails/BankAccountsAllowed | - | - |
./BankAccountsAllowed/BankAccount | String(31) | Selected bank account. |
./BankAccount/ID (BankAccount) | Numeric. | Selected bank account ID. |
./Customer/Annotations | - | List of Annotations. |
./Annotations/FictionalWebMarkup | - | Indicates if the customer a fictional markup on web. |
./FictionalWebMarkup/@Active | Boolean | Indicates if the markup is active. |
./FictionalWebMarkup/@Editable | Boolean | Indicates if the markup is editable. |
./FictionalWebMarkup/@BranchOffice | Boolean | |
./FictionalWebMarkup/@AllowsPriceIncrease | Boolean | Indicates if allows price increase |
./FictionalWebMarkup/@AllowsPriceDecrease | Boolean | Indicates if allows price decrease |
./FictionalWebMarkup/Percentage | - | |
./FictionalWebMarkup/MaximumIncrementPercentage | - | |
./Customer/Agents | - | List of agents. |
./Agents/Agent | - | Item Agent. |
./Agent/@Id | Numeric | Agent ID. |
./Agent/@Active | Boolean | Bit that indicates if the agent is active. |
./Agent/@Commission | Numeric | Agent commission. |
./Agent/@CommissionPercentage | Numeric | Agent commission percentage. |
./Agent/@AgentAdministrator | Boolean | Indicates if the agent is an administrator. |
./Agent/@ConfirmBookings | Boolean | Indicates if the agent can confirm bookings. |
./Agent/@CancelBookings | Boolean | Indicates if the agent can cancel bookings. |
./Agent/Name | String(50) | Agent name. |
./Agent/AccountRefNumber | String(100) | Agent external reference. |
./Agent/Email | String(50) | Agent email. |
./Agent/Login | String(50) | Agent login. |
./Agent/Loyalty | - | Agent loyalty information. |
./Loyalty/@TotalValue | Numeric | Total loyalty points. |
./Agent/Reference | String(50) | Loyalty external reference. |
./Agent/Concepts | - | Loyalty concept list. |
./Concepts/Concept | - | Specific concept. |
./Concept/@Code | Numeric | Concept identifier. |
./Concept/@PaymentCode | Numeric | Related payment identifier. |
./Concept/@Date | Date | Concept Date. Format: dd/MM/yyyy HH:mm:ss. |
./Concept/Description | String(50) | Loyalty concept description. |
./Concept/Value | Decimal | Loyalty concept value. |
./Customer/RepAgencies | - | List of possible client / agencies to which the guide may refer to. Only for guide type clients. Not that, if empty on a guide type client, this cient will be able to refer any of the other clients from the system. |
./RepAgencies/@Id | Numeric | Internal indentificator of the agency. |
./RepAgencies/RepAgency | String(100) | Agency name. |
./Customer/Loyalty | - | Customer loyalty information. |
./Loyalty/@TotalValue | Numeric | Total loyalty points. |
./Customer/Reference | String(50) | Loyalty external reference. |
./Customer/Concepts | - | Loyalty concept list. |
./Concepts/Concept | - | Specific concept. |
./Concept/@Code | Numeric | Concept identifier. |
./Concept/@PaymentCode | Numeric | Related payment identifier. |
./Concept/@Date | Date | Concept Date. Format: dd/MM/yyyy HH:mm:ss. |
./Concept/Description | String(50) | Loyalty concept description. |
./Concept/Value | Decimal | Loyalty concept value. |
This method returns the final customers that have been created in the system.
The request parameters of this method are:
The XML returned through this method is the following:
<soap:Envelope xmlns:soap = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
<soap:Body>
<getFinalCustomerListResponse xmlns = "http://juniper.es/">
<getFinalCustomerListResult>
<wsResult xmlns = "">
<FinalCustomers>
<FinalCustomer>
<General>
<Id>19</Id>
<Title>Mr.</Title>
<Name>Test</Name>
<Surname>Final Customer</Surname>
<DocumentType/>
<DocumentNumber>49682569A</DocumentNumber>
<UnsubscribeDate/>
<EMail>noreply@ejuniper.com</EMail>
<PostalCode/>
<Address/>
<AddressNumber/>
<AddressBuilding/>
<City/>
<Province/>
<Country/>
<ContactPerson/>
<Telephone/>
<CellPhone/>
<Fax/>
<Remarks/>
<CompanyName/>
<BusinessName/>
<Active>Y</Active>
<AcceptToSendOffers>Y</AcceptToSendOffers>
<CreateDate>09/04/2021 9:54:21</CreateDate>
</General>
<InvoiceData>
<DocumentType/>
<DocumentNumber/>
<CIF/>
<VAT/>
<CountryOfBirth/>
<Address/>
<City/>
<Province/>
<PostalCode/>
<Country/>
<Telephone/>
<CellPhone/>
<Fax/>
<EMail/>
</InvoiceData>
<InformativeData>
<DateOfBirth>18/04/1978 0:00:00</DateOfBirth>
<SocialMediaContact/>
<AuthorizationForInformativeEmailReception>N</AuthorizationForInformativeEmailReception>
<FrequentTraveller>N</FrequentTraveller>
<Company/>
<Number/>
<TravelPreferences/>
<MonthsTravelPreferences/>
</InformativeData>
<Loyalty TotalValue = "0">
<Reference/>
</Loyalty>
</FinalCustomer>
</FinalCustomers>
</wsResult>
</getFinalCustomerListResult>
</getFinalCustomerListResponse>
</soap:Body>
</soap:Envelope>
Details of the nodes and attributes:
Node / Attribute (@) | Type | Description |
---|---|---|
Id | Numeric | Identificator. |
Tittle | String(50) | Client tittle. |
Name | String(50) | Client name. |
Surname | String(50) | Client surname. |
DocumentType | String(50) | Client document type. |
DocumentNumber | String(50) | Client document number. |
UnsubscribeDate | DateTime | Client unsubscribe date. |
String(50) | Client email. | |
PostalCode | String(50) | Client postal code. |
Address | String(50) | Client address. |
City | String(50) | Client city. |
Province | String(50) | Client province. |
Country | String(50) | Client country. |
ContactPerson | String(50) | Client contact person. |
Telephone | String(50) | Client telephone. |
Cellphone | String(50) | Client cellphone. |
Fax | String(50) | Client fax. |
Remarks | String(50) | Client remarks. |
CompanyName | String(50) | Client company name. |
BusinessName | String(50) | Client business name. |
Active | String(1) | Is the client active? (Y) / (N). |
AcceptToSendOffers | String(1) | The client accepts offers to be sent? (Y) / (N). |
CreateDate | DateTime | Client creation date. |
ModifyDate | DateTime | Client modification date. |
Node / Attribute (@) | Type | Description |
---|---|---|
DocumentType | String(50) | Invoice document type. |
DocumentNumber | String(50) | Invoice document number. |
VAT | String(50) | Invoice VAT. |
CIF | String(50) | Invoice identification code fiscal. |
CountryOfBirth | String(50) | Invoice country of birth. |
Address | DateTime | Invoice address. |
City | String(50) | Invoice city. |
Province | String(50) | Invoice province. |
PostalCode | String(50) | Invoice postal code. |
Country | String(50) | Invoice country. |
Telephone | String(50) | Invoice telephone. |
CellPhone | String(50) | Invoice cellphone. |
Fax | String(50) | Invoice fax. |
String(50) | Invoice email. |
Node / Attribute (@) | Type | Description |
---|---|---|
DateOfBirth | Date | Client date of birth. |
SocialMediaContact | String(50) | Client social media contact. |
AuthorizationForInformativeEmailReception | String(1) | Does the client accept informative emails? (Y) / (N). |
FrequentTraveller | String(1) | Is the client a frequent traveller? (Y) / (N). |
Company | String(50) | Company name that the client frequently uses. |
Number | String(50) | Client number of the mentioned company. |
TravelPreferences | TravelPreferences | Preference list. - Cities. - Cruises. - Coast. - International destinations. |
MonthsTravelPreferences | MonthsTravelPreference | Monthly preferences. |
Node / Attribute (@) | Type | Description |
---|---|---|
@TotalValue | Decimal | Total Loyalty Points. |
Reference | String(50) | Loyalty External Reference. |
Concepts | - | - |
./Concepts/Concept | - | - |
./Concepts/@Code | Numeric | Concept identifier |
./Concepts/@PaymentCode | Numeric | Related payment identifier. |
./Concepts/@Date | Date | Concept Date. Format: dd/MM/yyyy HH:mm:ss. |
./Concepts/Description | String(50) | Loyalty Concept Description. |
./Concepts/Value | Decimal | Loyalty Concept Value. |
This method allows you to create a new customer in the system. The request parameters of this method are the following:
User: Intranet user
Password: Intranet user password
Xml: String with XML format. The format is the same as the one returned in the method getCustomerList, and is detailed below.
Details of the nodes and attributes:
Node / Attribute (@) | Type | Description |
---|---|---|
Customer | - | Item Customer |
./Customer/@Type | Numeric | It indicates the customer type. |
./Customer/@CategoryLeader | Boolean | Indicates if it is the category leader. |
./Customer/@GroupLeader | Boolean | Indicates if it is the group leader. |
./Customer/@CreationDate | DateTime | Set up date of the customer in the system. |
./Customer/@ActivationDate | DateTime | Activation date of the customer in the system. |
./Customer/@Active | Boolean | Bit that indicates if the customer is active. |
./Customer/@IATA | String(50) | IATA Code |
./Customer/@PaymentType | Numeric | Payment type. Possible values: - C. Credit - T. POS - B. Pre-payment |
./Customer/@TravelAssociation | Boolean | Customer is a travel association. |
./Customer/@CreateBookings | Boolean | Customer can create new bookings. |
./Customer/@ExternalSiteBookingAccess | Boolean | Customer has access to external booking site. |
./Customer/General | - | Item General |
./General/Name | String(100) | Name of the customer |
./General/RegistrationName | String(150) | Tax registration name |
./General/ClientRefNumber | String(50) | External reference code |
./General/Login | String(75) | Login of the customer |
./General/Password | String(100) | Password of the customer. Only if it’s allowed. |
./General/Category | - | Customer category |
./Category/@Id | Numeric | Category Id |
./General/AgencyGroup | - | Agency group |
./AgencyGroup/@Id | Numeric | Agency Group Id |
./General/DefaultCountry | - | Default country |
./DefaultCountry/@Id | Numeric | Default country Id |
./General/Channel | - | Agency sales channel |
./Channel/@Id | String (4) | Agency Channel Id |
./General/AccountManager | - | Account manager name |
./AccountManager/@Id | Numeric | Account manager id |
./General/BranchOffice | - | Indicates if the customer is a branch office |
./BranchOffice/@HeadOfficeId | Numeric | Central office id |
./General/CustomerManager | - | Customer manager name |
./CustomerManager/@Id | Numeric | Customer manager id |
./General/Currencies | - | List of currency codes that are available for the customer. |
./Currencies/Currency | - | Currency name |
./Currency/@Code | String(3) | Currency code. Format ISO 4217 |
./General/BlockBookings | Boolean | Indicates if the bookings blocked. |
./General/DaysMargin | - | |
./DaysMargin/@value | Numeric | Days of Margin |
./DaysMargin/Channels | - | |
./Channels/Channel | - | |
./Channel/@Id | String (10) | Channel id |
./Channel/@value | Numeric | Days of margin for the channel |
./General/DateFormat | String (10) | Indicates the date format |
./Customer/Contact | - | Item Contact |
./Contact/ContactName | String(50) | Contact person |
./Contact/CompanyName | String(150) | Company Name |
./Contact/Remarks | String(1000) | Customer remarks |
./Contact/Phone1 | String(50) | Telephone 1 |
./Contact/Phone2 | String(50) | Telephone 2 |
./Contact/Mobile | String(50) | Mobile |
./Contact/Fax | String(50) | Fax |
./Contact/Email | String(50) | |
./Contact/Address | String(75) | Address |
./Contact/Country | String(50) | Country |
./Contact/City | String(50) | City |
./City/@ZIP | String(20) | Postal code /zip code |
./Contact/State | String(50) | State |
./Contact/District | String(50) | District |
./Contact/Town | String(50) | Town |
./Customer/InvoicingDetails | - | IInvoicing Details Item |
./InvoicingDetails/@TaxID | String(25) | Tax Registration No. related to the customer. |
./InvoicingDetails/@TradeCode | String(50) | BAL Code in case there was any tourist based enterprise registered in the fiscal address. |
./InvoicingDetails/CreditCard1 | String(500) | Credit card details 1 |
./InvoicingDetails/CreditCard2 | String(500) | Credit card details 2 |
./InvoicingDetails/InvoiceContact | String(50) | Invoicing contact person |
./InvoicingDetails/AccountRefNumber | String(100) | Name of the customer |
./InvoicingDetails/CompanyName | String(150) | Company Name |
./InvoicingDetails/Remarks | String(1000) | Customer remarks |
./InvoicingDetails/Phone1 | String(50) | Telephone 1 |
./InvoicingDetails/Phone2 | String(50) | Telephone 2 |
./InvoicingDetails/Mobile | String(50) | Mobile |
./InvoicingDetails/Fax | String(50) | Fax |
./InvoicingDetails/Email | String(50) | |
./InvoicingDetails/Address | String(75) | Address |
./InvoicingDetails/Country | String(50) | Country |
./InvoicingDetails/City | String(50) | City |
./City/@ZIP | String(20) | Postal code /zip code |
./InvoicingDetails/State | String(50) | State |
./InvoicingDetails/BillingLimit | Numeric | Billing limit |
./InvoicingDetails/CreditLimit | Numeric | Credit limit |
./CreditLimit/@CurrencyCode | String(3) | Currency |
./InvoicingDetails/BankAccountsAllowed | String(100) | List of allowed bank accounts. |
./BankAccountsAllowed/BankAccount | String(100) | Bank account. |
./BankAccount/@Id | String(3) | Bank account id. |
./Customer/Annotations | - | List of Annotations. |
./Annotations/FictionalWebMarkup | - | Indicates if the customer a fictional markup on web. |
./FictionalWebMarkup/@Active | Boolean | Indicates if the markup is active. |
./FictionalWebMarkup/@Editable | Boolean | Indicates if the markup is editable. |
./FictionalWebMarkup/@BranchOffice | Boolean | |
./FictionalWebMarkup/@AllowsPriceIncrease | Boolean | Indicates if allows price increase |
./FictionalWebMarkup/@AllowsPriceDecrease | Boolean | Indicates if allows price decrease |
./FictionalWebMarkup/Percentage | - | |
./FictionalWebMarkup/MaximumIncrementPercentage | - | |
./Customer/Agents | - | List of Agents |
./Agents/Agent | - | List of Agents |
./Agent/@Id | Numeric | Agent ID |
./Agent/@Active | Boolean | Bit that indicates if the agent is active. |
./Agent/@Commission | Numeric | Agent commission |
./Agent/@CommissionPercentage | Numeric | Agent commission percentage |
./Agent/@AgentAdministrator | Boolean | Agent administrator |
./Agent/@ConfirmBookings | Boolean | Confirm bookings allowed |
./Agent/@CancelBookings | Boolean | Cancel bookings allowed |
./Agent/Name | String(50) | Agent name |
./Agent/AccountRefNumber | String(100) | Name of the customer |
./Agent/Email | String(50) | Name of the customer |
./Agent/Login | String(50) | Name of the customer |
The errors that this method may return are the following:
Code | Error description |
---|---|
EGEN | General error. |
ECATLEA | Incorrect category leader. |
EATV | Incorrect activation date. |
EAGEGRP | Incorrect agency group. |
EPAY | Incorrect payment type. |
ENAME | Incorrect user name. |
ECANAL | Incorrect sales channel. |
ECON | Incorrect "Contact" node. |
Incorrect Mail. | |
WMAIL | Non-valid Mail. |
ETYPE | Incorrect User type. |
EAGEREF | Incorrect Agency Reference. |
LOGINEXISTS | Login exists. |
WRONGLOGIN | Incorrect login value. |
WRONGPASSWORD | Wrong password. |
PASSWORDNOTALLOWED | Setting password not allowed. |
This method allows you to modify an existing customer in the system. The request parameters of this method are the following:
User: Intranet user
Password: Intranet user password
Xml: String with XML format. The format is the same as the one returned by the method getCustomerList, and is detailed below.
Details of the nodes and attributes:
Node / Attribute (@) | Type | Description |
---|---|---|
Customer | - | Item Customer |
./Customer/@Id | Numeric | Customer Id. |
./Customer/@Type | Numeric | It indicates the customer type. |
./Customer/@CategoryLeader | Boolean | Indicates if it is the category leader. |
./Customer/@GroupLeader | Boolean | Indicates if it is the group leader. |
./Customer/@CreationDate | DateTime | Set up date of the customer in the system. |
./Customer/@ActivationDate | DateTime | Activation date of the customer in the system. |
./Customer/@Active | Boolean | Bit that indicates if the customer is active. |
./Customer/@IATA | String(50) | IATA Code |
./Customer/@PaymentType | Numeric | Payment type. Possible values: - C. Credit - T. POS - B. Pre-payment |
./Customer/@TravelAssociation | Boolean | Customer is a travel association. |
./Customer/@CreateBookings | Boolean | Customer can create new bookings. |
./Customer/@ExternalSiteBookingAccess | Boolean | Customer has access to external booking site. |
./Customer/General | - | Item General |
./General/Name | String(100) | Name of the customer |
./General/RegistrationName | String(150) | Tax registration name |
./General/ClientRefNumber | String(50) | External reference code |
./General/Login | String(75) | Login of the customer |
./General/Password | String(100) | Password of the customer. Only if it’s allowed. |
./General/Category | - | Customer category |
./Category/@Id | Numeric | Category Id |
./General/AgencyGroup | - | Agency group |
./AgencyGroup/@Id | Numeric | Agency Group Id |
./General/DefaultCountry | - | Default country |
./DefaultCountry/@Id | Numeric | Default country Id |
./General/Channel | - | Agency sales channel |
./Channel/@Id | String (4) | Agency Channel Id |
./General/AccountManager | - | Account manager name |
./AccountManager/@Id | Numeric | Account manager id |
./General/BranchOffice | - | Indicates if the customer is a branch office |
./BranchOffice/@HeadOfficeId | Numeric | Central office id |
./General/CustomerManager | - | Customer manager name |
./CustomerManager/@Id | Numeric | Customer manager id |
./General/Currencies | - | List of currency codes that are available for the customer. |
./Currencies/Currency | - | Currency name |
./Currency/@Code | String(3) | Currency code. Format ISO 4217 |
./General/BlockBookings | Boolean | Indicates if the bookings blocked. |
./General/DaysMargin | - | |
./DaysMargin/@value | Numeric | Days of Margin |
./DaysMargin/Channels | - | |
./Channels/Channel | - | |
./Channel/@Id | String (10) | Channel id |
./Channel/@value | Numeric | Days of margin for the channel |
./General/DateFormat | String (10) | Indicates the date format |
./Customer/Contact | - | Item Contact |
./Contact/ContactName | String(50) | Contact person |
./Contact/CompanyName | String(150) | Company Name |
./Contact/Remarks | String(1000) | Customer remarks |
./Contact/Phone1 | String(50) | Telephone 1 |
./Contact/Phone2 | String(50) | Telephone 2 |
./Contact/Mobile | String(50) | Mobile |
./Contact/Fax | String(50) | Fax |
./Contact/Email | String(50) | |
./Contact/Address | String(75) | Address |
./Contact/Country | String(50) | Country |
./Contact/City | String(50) | City |
./City/@ZIP | String(20) | Postal code /zip code |
./Contact/State | String(50) | State |
./Contact/District | String(50) | District |
./Contact/Town | String(50) | Town |
./Customer/InvoicingDetails | - | IInvoicing Details Item |
./InvoicingDetails/@TaxID | String(25) | Tax Registration No. related to the customer. |
./InvoicingDetails/@TradeCode | String(50) | BAL Code in case there was any tourist based enterprise registered in the fiscal address. |
./InvoicingDetails/CreditCard1 | String(500) | Credit card details 1 |
./InvoicingDetails/CreditCard2 | String(500) | Credit card details 2 |
./InvoicingDetails/InvoiceContact | String(50) | Invoicing contact person |
./InvoicingDetails/AccountRefNumber | String(100) | Name of the customer |
./InvoicingDetails/CompanyName | String(150) | Company Name |
./InvoicingDetails/Remarks | String(1000) | Customer remarks |
./InvoicingDetails/Phone1 | String(50) | Telephone 1 |
./InvoicingDetails/Phone2 | String(50) | Telephone 2 |
./InvoicingDetails/Mobile | String(50) | Mobile |
./InvoicingDetails/Fax | String(50) | Fax |
./InvoicingDetails/Email | String(50) | |
./InvoicingDetails/Address | String(75) | Address |
./InvoicingDetails/Country | String(50) | Country |
./InvoicingDetails/City | String(50) | City |
./City/@ZIP | String(20) | Postal code /zip code |
./InvoicingDetails/State | String(50) | State |
./InvoicingDetails/BillingLimit | Numeric | Billing limit |
./InvoicingDetails/CreditLimit | Numeric | Credit limit |
./CreditLimit/@CurrencyCode | String(3) | Currency |
./InvoicingDetails/BankAccountsAllowed | String(100) | List of allowed bank accounts. |
./BankAccountsAllowed/BankAccount | String(100) | Bank account. |
./BankAccount/@Id | String(3) | Bank account id. |
./Customer/Annotations | - | List of Annotations. |
./Annotations/FictionalWebMarkup | - | Indicates if the customer a fictional markup on web. |
./FictionalWebMarkup/@Active | Boolean | Indicates if the markup is active. |
./FictionalWebMarkup/@Editable | Boolean | Indicates if the markup is editable. |
./FictionalWebMarkup/@BranchOffice | Boolean | |
./FictionalWebMarkup/@AllowsPriceIncrease | Boolean | Indicates if allows price increase |
./FictionalWebMarkup/@AllowsPriceDecrease | Boolean | Indicates if allows price decrease |
./FictionalWebMarkup/Percentage | - | |
./FictionalWebMarkup/MaximumIncrementPercentage | - | |
./Customer/Agents | - | List of Agents |
./Agents/Agent | - | List of Agents |
./Agent/@Id | Numeric | Agent ID |
./Agent/@Active | Boolean | Bit that indicates if the agent is active. |
./Agent/@Commission | Numeric | Agent commission |
./Agent/@CommissionPercentage | Numeric | Agent commission percentage |
./Agent/@AgentAdministrator | Boolean | Agent administrator |
./Agent/@ConfirmBookings | Boolean | Confirm bookings allowed |
./Agent/@CancelBookings | Boolean | Cancel bookings allowed |
./Agent/Name | String(50) | Agent name |
./Agent/AccountRefNumber | String(100) | Name of the customer |
./Agent/Email | String(50) | Name of the customer |
./Agent/Login | String(50) | Name of the customer |
The errors that this method may return are the following:
Code | Error description |
---|---|
EGEN | General error. |
ECATLEA | Incorrect category leader. |
EATV | Incorrect activation date. |
EAGEGRP | Incorrect agency group. |
EPAY | Incorrect payment type. |
ENAME | Incorrect user name. |
ECANAL | Incorrect sales channel. |
ECON | Incorrect "Contact" node. |
Incorrect Mail. | |
WMAIL | Non-valid Mail. |
ETYPE | Incorrect User type. |
EAGEREF | Incorrect Agency Reference. |
LOGINEXISTS | Login exists |
WRONGLOGIN | Incorrect login value |
WRONGPASSWORD | Wrong password |
PASSWORDNOTALLOWED | Setting password not allowed |
Through this web service, you may obtain a list of all suppliers in your system when searching and filtering among the available options.
This method returns a complete list of suppliers created by the system. The request parameters for this method are the following:
The XML returned by this method is the following:
<wsResult xmlns = "">
<Suppliers>
<Supplier Id = "11" TaxId = "" Currency = "EUR" PaymentType = "A" DaysToPay = "0" RateType = "0" Commission = "0" BloackPayments = "0" ReferenceNumber = "1046945" BlockPayments = "0" LastExportationDate = "" CommissionIncludesTax = "" CommissionTax = "0" SupplierType = "" DirectPaymentType = "0" EuropeanEconomicUnico = "False" LocksPayments = "False" DeactivateVouchers = "False" Priority = "">
<Name><![CDATA[TEST]]></Name>
<Remarks><![CDATA[]]></Remarks>
<AccountRefNumber><![CDATA[]]></AccountRefNumber>
<RegistrationName><![CDATA[]]></RegistrationName>
<ContactPerson><![CDATA[]]></ContactPerson>
<Phone1><![CDATA[]]></Phone1>
<Phone2><![CDATA[]]></Phone2>
<AdministratorPhone><![CDATA[]]></AdministratorPhone>
<Fax><![CDATA[]]></Fax>
<Email><![CDATA[]]></Email>
<AlternativeEmail><![CDATA[]]></AlternativeEmail>
<Address><![CDATA[]]></Address>
<City ZIP = ""><![CDATA[]]></City>
<State><![CDATA[]]></State>
<District><![CDATA[]]></District>
<Town><![CDATA[]]></Town>
<Country ISO2 = ""><![CDATA[]]></Country>
<SupplierGroup Id = ""><![CDATA[]]></SupplierGroup>
<BankAccount Format = "FREE">
<BankName><![CDATA[]]></BankName>
<BankAccountNumber><![CDATA[]]></BankAccountNumber>
</BankAccount>
<CoMarketings>
<Comarketing ProductType = "Alojamiento" ModuleType = "AGO" Percentage = "10,00"/>
<Comarketing ProductType = "Excursion" ModuleType = "E061" Percentage = "50,00"/>
</CoMarketings>
<CommissionAccount><![CDATA[]]></CommissionAccount>
<IBAN><![CDATA[]]></IBAN>
<SWIFT><![CDATA[]]></SWIFT>
<DefaultSupplierReference><![CDATA[]]></DefaultSupplierReference>
<SalesVolumeCommission IdCli = ""><![CDATA[]]></SalesVolumeCommission>
<MailingInformation>
<Address><![CDATA[]]></Address>
<City><![CDATA[]]></City>
<ZIP><![CDATA[]]></ZIP>
<State><![CDATA[]]></State>
<Country><![CDATA[]]></Country>
</MailingInformation>
<Notifications Language = "">
<NotifyOnRequestBookings AllowOnRequestBookingRetrieval = ""><![CDATA[]]></NotifyOnRequestBookings>
<NotifyAllotmentConfirmation><![CDATA[]]></NotifyAllotmentConfirmation>
<NotifyOKStatus><![CDATA[]]></NotifyOKStatus>
<NotifyConfirmationWithoutAllotment><![CDATA[]]></NotifyConfirmationWithoutAllotment>
<NotifyCancellationWithAllotment><![CDATA[]]></NotifyCancellationWithAllotment>
<NotifyCancellationWithoutAllotment><![CDATA[]]></NotifyCancellationWithoutAllotment>
<NotifyBookingModification><![CDATA[]]></NotifyBookingModification>
<NotifyOnRequestCancellation><![CDATA[]]></NotifyOnRequestCancellation>
<AttachSUCCCardAsPdf><![CDATA[]]></AttachSUCCCardAsPdf>
<AttachMessageAsPdf AlsoInTheMail = "False"><![CDATA[]]></AttachMessageAsPdf>
<FictitiousChangeBySupplier><![CDATA[]]></FictitiousChangeBySupplier>
<GrossPayment><![CDATA[]]></GrossPayment>
</Notifications>
<GroupHandling Shows = "False" NeedsAssignment = "False"/>
<SUCCCard Active = "True" ValidityRule = "" DaysToPay = "" VirtualCardSupplierAccount = ""/>
</Supplier>
</Suppliers>
</wsResult>
Node and attribute details:
Node / Attribute (@) | Type | Description |
---|---|---|
Supplier | - | Item Supplier. |
./Supplier/@Id | Numeric | Supplier identifier. |
./Supplier/@TaxId | String(50) | Supplier Tax Registration Number. |
./Supplier/@Currency | String(50) | Currency in which the supplier manages theis bookings. |
./Supplier/@PaymentType | String(1) | Supplier payment type. Possible values: • P: Pre-payment • D: Direct Bill • X: Pre-purchase • T: Bank Transfer • N: Promissory Note • E: Deposit • W: Wright Express (Virtual Card) • A: AMEX (Virtual Card) • V: eNet (Virtual Card) |
./Supplier/@DaysToPay | Numeric | Days to pay if the payment is Prepaid. |
./Supplier/@RateType | Numeric | Rate type. Two values: • 0: Net • 1: Commissionable |
./Supplier/@Commission | Numeric | Commission offered by the supplier. |
./Supplier/@ReferenceNumber | String(100) | Supplier's external code. |
./Supplier/@BlockPayments | Boolean | Bit that indicates if payments are blocked for this supplier. |
./Supplier/@LastExportationDate | String(100) | Last exportation date. It is important to mention that this is a string fiel whose format will depend on the exportation process that was last sent. |
./Supplier/@CommissionIncludesTax | Boolean | Bit that indicates if the commission includes Tax. |
./Supplier/@CommissionTax | Decimal | Tax commission amount. |
./Supplier/@SupplierType | Numeric | Supplier type internal code. |
./Supplier/@SupplierTypeCode | String(10) | Supplier type export code. |
./Supplier/@DirectPaymentType | Numeric | Allows to select the supplier’s direct type of pay. |
./Supplier/@EuropeanEconomicUnico | Boolean | Bit that indicates if the provider is intra-community. |
./Supplier/@LocksPayments | Boolean | Bit that indicates if the payments will be locked. |
./Supplier/@DeactivateVouchers | String(150) | Bit that indicates if the vouchers will be deactivated. |
./Supplier/@Priority | Numeric | Indicates the priority in the allotment. |
./Supplier/Name | String(150) | Supplier name. |
./Supplier/Remarks | String(4000) | Supplier remarks. |
./Supplier/AccountRefNumber | String(50) | Supplier account reference number |
./Supplier/RegistrationName | String(50) | Tax registration name. |
./Supplier/ContactPerson | String(50) | Supplier contact person. |
./Supplier/Phone1 | String(50) | Telephone number 1. |
./Supplier/Phone2 | String(50) | Telephone number 2. |
./Supplier/Fax | String(50) | Fax. |
./Supplier/Email | String(100) | Email. |
./Supplier/Address | String(150) | Address. |
./Supplier/City | String(50) | City. |
./City/@ZIP | String(20) | Postal code / ZIP code. |
./Supplier/State | String(50) | State. |
./Supplier/District | String(50) | District. |
./Supplier/Town | String(50) | Town. |
./Supplier/Country | String(50) | Country name. On the addSupplier and modifySupplier requests it will expect the country ISO2 code. |
./Country/@ISO2 | String(2) | Country ISO 3166-1 Alpha-2 code. For example: ES. |
./Supplier/CustomCurrency | Numeric | Custom currency exchange rate. |
./CustomCurrency/@Code | String(3) | Custom currency code. |
./Supplier/BankAccount | - | Bank account item. |
./BankAccount/@Format | Numeric | Bank accoun format. |
./BankAccount/BankName | Sring(50) | Bank account name. |
./BankAccount/BankAccountNumber | String(50) | Bank account number. It is required when creating and/or modifying a supplier. It allows for the following formats: • A string of 17 characters with a separator ("-") on the 9th position, for example: 00000000-00000000 • A string of 23 characters with a separator ("-") on the 5th position, for example: 0000-00000000000000000 |
./Supplier/CoMarketings | - | List of comarketing percentage discount. |
./CoMarketings/CoMarketing | - | One comarketing percentage discount. |
./CoMarketing/ProductType | String(50) | Product type which apply percentge discount. |
./CoMarketing/ModuleType | String(4) | Module which apply percentge discount. |
./CoMarketing/Percentage | Numeric | Percentge discount amount. |
./Supplier/CommisionAccount | String(20) | Commission Account |
./Supplier/Category | - | - |
./Category/@Id | Numeric | Id supplier's category |
./Supplier/IBAN | String(34) | IBAN code of the supplier’s account |
./Supplier/SWIFT | String(50) | SWIFT code of the supplier’s account |
./Supplier/DefaultSupplierReference | String(50) | Default value for an external locator when the booking line being created doesn´t indicate any |
./Supplier/SalesVolumeCommission | - | - |
./SalesVolumeCommission/@Id | Numeric | Customer Identification |
./Supplier/MailingInformation | - | - |
./MailingInformation/Address | String(75) | Supplier’s Correspondence Address |
./MailingInformation/City | String(50) | Supplier’s Correspondence City |
./MailingInformation/ZIP | String(15) | Supplier’s Correspondence ZIP Code |
./MailingInformation/State | String(50) | Supplier’s Correspondence State |
./MailingInformation/Country | String(50) | Supplier’s Correspondence Country |
./MailingInformation/AccountingContact | - | - |
./AccountingContact/@ManagerId | Numeric | In charge manager of the supplier |
./AccountingContact/Name | String | Name of the manager |
./AccountingContact/Email | String | Email of the manager |
./Supplier/Notifications | - | - |
./Notifications/@Language | String(2) | ISO 639-1 Language Code |
./Notifications/NotifyOnRequestBookings | - | Bit that indicates if there will be a Request notification |
./NotifyOnRequestBookings/@AllowOnRequestBookingRetrieval | Boolean | Bit that indicates if it is allowed to download the RQ Booking on the extranet webservice |
./Notifications/NotifyAllotmentConfirmation | Boolean | Bit to confirm the notification. |
./Notifications/NotifyOKStatus | Boolean | Bit that notifies when it’s passed to paid status. |
./Notifications/NotifyConfirmationWithoutAllotment | Boolean | Notifies confirmation without allotment. |
./Notifications/NotifyCancellationWithAllotment | Boolean | Notifies cancellation with allotment. |
./Notifications/NotifyCancellationWithoutAllotment | Boolean | Notifies cancellation without allotment. |
./Notifications/NotifyBookingModification | Boolean | Notifies a booking modification. |
./Notifications/NotifyOnRequestCancellation | Boolean | Notifies a cancellation request. |
./Notifications/AttachSUCCCardAsPdf | Boolean | Indicates that the SUCC Card should attach as pdf in the automatic message |
./Notifications/AttachMessageAsPdf | Boolean | Indicates if on the mails it’s attached the message in pdf format by default |
./AttachMessageAsPdf/@AlsoInTheMail | Boolean | Notify if it’s attached the PDF on the mail. |
./Notifications/FictitiousChangeBySupplier | Boolean | Boolean Bit that indicates if it’s going to be used the currency of the supplier. |
./Notifications/GrossPayment | Boolean | Indicates the type of payment, 0 in net, 1 in gross. |
./Supplier/GroupHandling | - | - |
./GroupHandling/@Shows | Boolean | Bit that indicates if it’s needed to show operative to the supplier. |
./GroupHandling/@NeedsAssignment | Boolean | Bit that indicates if needs assignation to the supplier. |
./Supplier/SUCCCard | - | - |
./SUCCCard/@Active | Boolean | Parameter stored with the key ‘desactivarTarjetaNuevoProveedor’ that indicates the check on the use of virtual card when the suppliers are created. |
./SUCCCard/@ValidityRule | Numeric | Indicates the type of date for the card activation. |
./SUCCCard/@DaysToPay | Numeric | Establishes the number of days to increase depending of the type of date for the card activation |
./SUCCCard/@VirtualCardSupplierAccount | Numeric | Identifier of the account |
./Supplier/ForceCredit | - | Force credit configuration |
./ForceCredit/@Active | Boolean | Indicates if the force credit configuration is active on the supplier. |
./ForceCredit/Customers | - | List of applicable customers. If empty, the force credit configuration will apply to all of the customers. |
./Customers/Customer | - | Specific customer. Multiple customer nodes may be specified |
./Customer/@Id | Mumeric | Customer id. |
This method allows you to create a new supplier in the system. The request parameters of this method are the following:
The errors that the method may return are the following:
Code | Error description |
---|---|
Incorrect email data. | |
WMAIL | Incorrect email format. |
ECOUNT | Non-valid card. |
EFCOUNT | Incorrect bank account format. |
EISO2 | Country ISO2 is mandatory. |
This method allows you to modify an already existing supplier in the system. The request parameters of this method are as listed below:
The errors that this method may return are the following:
Code | Error description |
---|---|
Incorrect email data. | |
WMAIL | Incorrect email format. |
ECOUNT | Non-valid card. |
EFCOUNT | Incorrect bank account format. |
EISO2 | Country ISO2 is mandatory. |
Through this web service we may obtain a list of customer invoices, supplier invoices, receipts, payments and bank accounts in the system by filtering various options.
Important note:
Keep in mind that this transaction will not supply you with invoices if the Juniper system does not, first of all, generate them. Contact with your Juniper client and/or with your project manager if you would like for additional information in this regard.
This method returns sales invoices issued in the system. The request parameters of this method are the following:
The XML response for this method is as follows:
<wsResult>
<Invoices>
<Invoice InvoiceNumber = "1151" IdInvoice = "15276" InvoiceDate = "2013-11-08T00:00:00" CAE = "" FECCAE = "" AfipInvoiceNumber = "" InvoiceCreationDate = "2013-11-08T10:03:34" DueDate = "2013-11-
18T00:00:00" TotalInvoiceAmount = "13228.80" VATExcludedAmount = "0.00" Currency = "USD" TotalPaid = "12481.78" OutStandingAmount = "747.02" CreditInvoice = "no" InvoiceSeries = "2013X" Market = "29" TotalPax = "1" TotalAdults = "1" TotalChildrens = "0" RefundAt = "" RefundSeries = "" ManualInvoice = "no" InvoiceCurrencyFactor = "1.00" ShowInvoiceCurrencyFactor = "1.00">
<Customer Id = "286" FinalCustomerId = "5" AgencyGroupId = "64" AgencyGroupName = "Grupo Dam">
<CustomerName><![CDATA[Damitours]]></CustomerName>
<DocumentNumber><![CDATA[B9665589697]]></DocumentNumber>
<Address><![CDATA[Av. Asima, SN ]]></Address>
<Telefono><![CDATA[555333555]]></Telefono>
</Customer>
<AccountRefNumber><![CDATA[]]></AccountRefNumber>
<InvoiceRemarks><![CDATA[]]></InvoiceRemarks>
<PassengerList>
<Passenger>
<paxid>559598</paxid>
<name><![CDATA[]]></name>
<surname><![CDATA[]]></surname>
</Passenger>
<Passenger>
<paxid>559599</paxid>
<name><![CDATA[]]></name>
<surname><![CDATA[]]></surname>
</Passenger>
</PassengerList>
<Lines>
<Line BookingCode = "JAIEMQ" AgencyReference = "" LineDate = "2013-11-08T10:03:37" BookingDate = "2013-04-02T12:49:06" IdBookingLine = "46731" CustomerReference = "" PaxNumber = "2" BeginTravelDate = "2014-05-07T00:00:00" EndTravelDate = "2014-05-09T00:00:00" ProductType = "A" ProductGroup = "80" Market = "29" ProductGroupName = "" TicketNumber = "" NetLineAmount = "2142.86" BaseLineAmount = "2142.86" Taxes = "0.00" HandlingFee = "0.00" CustomerCommission = "0.00" PercentCommissionTaxes = "0.00" CommissionTaxes = "0.00" PercentCommissionTaxesB = "0.00" CommissionTaxesB = "0.00" TotalLineAmount = "2142.86" VATExcludedAmount = "0.00" ServicesExternalCostCode = "" ServicesExternalSaleCode = "" ExchangeRate = "1.00" MarkUpAmount = "0" MarkUpPercent = "">
<Service ProductId = "43"><![CDATA[ZenGarden]]></Service>
<Details><![CDATA[ZenGarden details]]></Details>
<Costs>
<Cost SupplierId = "48" Currency = "USD" CostAmount = "1500.00" TaxCostAmount = "0.00" TotalAmount = "1500.00" SupplierCom = "150.00" ExchangeRate = "1">
<SupplierName><![CDATA[PalmPro]]></SupplierName>
<ArticleOfCost><![CDATA[ZenGarden]]></ArticleOfCost>
</Cost>
</Costs>
</Line>
</Lines>
<RelatedInvoices>
<RelatedInvoice Id = "202" Series = "B2008" Date = "2013-11-08T10:03:37" Price = "78.00"/>
<RelatedInvoice Id = "12" Series = "BK2008" Date = "2015-11-08T12:03:37" Price = "-78.00"/>
</RelatedInvoices>
<taxes>
<tax value = "78.00" fixed = "yes" exempt = "no" base = "1000.00" exemptbase = "0.00" name = "Juniper" total = "78.00" taxcode="0"></tax>
<tax value = "10.00" fixed = "yes" exempt = "no" base = "1294.00" exemptbase = "0.00" name = "tasa fija desde rva" total = "10.00" taxcode="0"></tax>
<tax value = "7.00" fixed = "yes" exempt = "no" base = "1294.00" exemptbase = "0.00" name = "tasa 7 x pax includ" total = "7.00" taxcode="0"></tax>
<tax value = "12.00" fixed = "yes" exempt = "no" base = "1294.00" exemptbase = "0.00" name = "fija de 12 x pax" total = "12.00" taxcode="0"></tax>
<tax value = "5.00" fixed = "yes" exempt = "no" base = "1294.00" exemptbase = "0.00" name = "tasa fija 5 desde rva" total = "5.00" taxcode="0"></tax>
<tax value = "9.00" fixed = "yes" exempt = "no" base = "1294.00" exemptbase = "0.00" name = "tasa9fix x 2pax" total = "9.00" taxcode="0"></tax>
</taxes>
</Invoice>
</Invoices>
</wsResult>
Node / Attribute (@) | Type | Descripti |
---|---|---|
Invoice | - | Invoice item. |
./Invoice/@InvoiceNumber | Numeric | Invoice number. |
./Invoice/@IdInvoice | Numeric | Internal invoice ID. |
./Invoice/@InvoiceType | String | Invoice type of the AFIP integration (only Argentina*). |
./Invoice/@InvoiceDate | DateTime | Invoice date. |
./Invoice/@CAE | String | Field: ExpCode of the AFIP integration (only Argentina*). |
./Invoice/@FECCAE | String | Field: ecc_camporespuesta_1 of the AFIP integration (only Argentina *). |
./Invoice/@AfipInvoiceNumber | String | Field: ecc_camporespuesta_4 of the AFIP integration (only Argentina *). |
./Invoice/@InvoiceCreationDate | DateTime | invoice set up date. |
./Invoice/@DueDate | DateTime | Invoice due date. |
./Invoice/@TotalInvoiceAmount | Numeric | Total invoice amount. |
./Invoice/@VATExcludedAmount | Numeric | VAT excluded amount. |
./Invoice/@Currency | String(5) | Invoice currency. |
./Invoice/@TotalPaid | Numeric | Total paid for the invoice. |
./Invoice/@OutStandingAmount | Numeric | Difference of amount between the invoice amount and the paid amount. |
./Invoice/@CreditInvoice | Boolean | It indicates if it is credit note. |
./Invoice/@InvoiceSeries | String(50) | Invoice series. |
./Invoice/@Market | Numeric | Market identifier to which the agency belongs. |
./Invoice/@TotalPax | Numeric | Invoiced booking total passengers. |
./Invoice/@TotalAdults | Numeric | Invoiced booking total number of adults. |
./Invoice/@TotalChildren | Numeric | Invoiced booking total number of children. |
./Invoice/@RefundSeries | String(50) | Invoice serie. |
./Invoice/@ManualInvoice | Boolean | Bit that indicates if an invoice is a manual invoice. |
./Invoice/@InvoiceCurrencyFactor | Numeric | Exchange rate in the invoice currency. |
./Invoice/@ShowInvoiceCurrencyFactor | Numeric | Exchange rate in the display of the invoice. |
./Invoice/@TotalCustomerCommission | Numeric | Customer commission. |
./Invoice/@TotalCommissionTaxes | Numeris | Commission taxes. |
./Invoice/@TotalNetAmount | Numeric | Net Line Amount. |
./Invoice/@TotalBaseAmount | Numeric | Base Line Amount. |
./Invoice/@TotalHandlingFee | Numeric | HandlingFee. |
./Invoice/Customer | - | Customer item. |
./Customer/@Id | Numeric | Agency identifier. |
./Customer/@FinalCustomerId | Numeric | Final customer identifier. |
./Customer/@AgencyGroupID | Numeric | Agency group identifier. |
./Customer/@AgencyGroupName | String(100) | Agency group name. |
./Customer/CustomerName | String(255) | Agency name. |
./Customer/DocumentNumber | String(50) | Agency CIF number. |
./Customer/Address | String(255) | Address. |
./Customer/Telephone | String(50) | Telephone number (first option). |
./Invoice/Holder | - | Holder item. |
./Holder/NameHolder | String(200) | Company name. |
./Holder/DocumentHolder | String(50) | Biling document number. |
./Holder/AddressHolder | String(500) | Biling address. |
./Holder/AddressNumberHolder | String(10) | Biling number (address). |
./Holder/AddressBuildingHolder | String(20) | Biling building (address). |
./Holder/AddressDistrictHolder | String(50) | Biling district. |
./Holder/PostCodeHolder | String(20) | Biling zipcode. |
./Holder/CityHolder | String(50) | Biling city. |
./Holder/StateHolder | String(50) | Province of biling. |
./Holder/CountryHolder | String(50) | Biling country. |
./Holder/TelephoneHolder | String(50) | Biling phone. |
./Holder/MailHolder | String(75) | Biling email. |
./Invoice/AccoutRefNumber | String(100) | Reference number. |
./Invoice/InvoiceRemarks | String(800) | Invoice remarks. |
./Invoice/PassengerList | - | PassengerList item. |
./PassengerList/Passenger | - | Passenger item. |
./Passenger/Paid | Numeric | Booking passenger identifier. |
./Passenger/Name | String(250) | Passenger name. |
./Passenger/Surname | String(200) | Passenfer surname. |
./Invoice/Lines | - | List of lines. |
./Lines/Line | - | Line item. |
./Line/@BookingCode | String(7) | Booking code. |
./Line/@AgencyReference | String(50) | Agency reference. |
./Line/@LineDate | DateTime | Invoice element set up date. |
./Line/@BookingDate | DateTime | Booking set up date. |
./Line/@IdBookingLine | Numeric | Booking element identifier. |
./Line/@CustomerReference | String(50) | Booking customer reference. |
./Line/@PaxNumber | Numeric. | PAX number. |
./Line/@BeginTravelDate | DateTime | Travel start date. |
./Line/@EndTravelDate | DateTime | Travel end date. |
./Line/@ProductType | String(15) | Product type. |
./Line/@ProductGroup | Numeric | Product group identifier. |
./Line/@Market | Numeric | Market identifier associated with the product group of the invoided service. |
./Line/@ProductGroupName | String(100) | Product group name. |
./Line/@TicketNumber | String(50) | Service ticket number (destination services). |
./Line/@NetLineAmount | Numeric | Net line amount |
./Line/@BaseLineAmount | Numeric | Base amount of the invoie element. |
./Line/@Taxes | Numeric | Sales tax amount. |
./Line/@HandlingFee | Numeric | Handling Fee applied yo the invoice element. |
./Line/@CustomerCommission | Numeric | Commission amount. |
./Line/@PercentCommissionTaxes | Numeric | Tax commission amount. |
./Line/@CommissionTaxes | Numeric | - |
./Line/@PercentCommissionTaxesB | Numeric | - |
./Line/@CommissionTaxesB | Numeric | - |
./Line/@TotalLineAmount | Numeric | Total invoice element amount. |
./Line/@ServicesExternalCostCode | String(100) | Service cost contract external code. |
./Line/@ServicesExternalSaleCode | String(100) | Service sales contract external code. |
./Line/@ExchangeRate | Numeric | Exchange rate of the invoicing line. |
./Line/@VATExcludedAmount | Numeric | VAT excluded amount. |
./Line/@ExternalCode | String | External code (Id_Cex). |
./Line/@ExternalCostCode | String | Cost contract external code. |
./Line/@MarkUpAmount | Numeric | Markup amount. |
./Line/@MarkUpPercent | Numeric | Markup percentage. |
./Line/Service | String | Service name/description. |
./Service/@ProductId | Numeric | Service identifier. |
./Line/Details | String | Additional details of the service. |
./Lines/Costs | - | - |
./Costs/Cost | - | - |
./Cost/SupplierId | Numeric | Identifier's supplier. |
./Cost/Currency | String(3) | Cost currency. |
./Cost/CostAmount | Numeric | Cost Amount. |
./Cost/TotalAmount | Numeric | Total amount. |
./Cost/SupplierCom | Numeric | Supplier commission. |
./Cost/ExchangeRate | Numeric | Cost exchange rate. |
./Cost/SupplierName | String(50) | Supplier name. |
./Cost/ArticleOfCost | String(50) | Invoice element description. |
./Invoice/RelatedInvoices | - | List of related invoices. |
./RelatedInvoices/RelatedInvoice | - | Related invoice. |
./RelatedInvoice/@Id | Numeric | Identifier related invoice. |
./RelatedInvoice/@Series | String(50) | Serie of related invoice. |
./RelatedInvoice/@Date | DateTime | Date of related invoice. |
./RelatedInvoice/@Price | Numeric | Price of related invoice. |
./Invoice/Taxes | - | List of taxes. |
./Taxes/Tax | - | Tax item. |
./Tax/@value | Numeric | Sales tax value. |
./Tax/@fixed | Boolean | Bit that indicates whether the tax is fixed or not. |
./Tax/@exempt | Numeric | Tax exempt amount. |
./Tax/@exemptBase | Numeric | Base tax exempt amount. |
./Tax/@base | Numeric | Tax base amount. |
./Tax/@name | String(50) | Tax name. |
./Tax/@total | Numeric | Total tax amount. |
./Tax/@taxcode | Numeric | Internal numeric ID of tax code |
This method returns a list of purchase invoices received and inserted in the system. The request parameters of this method are the following:
The XML returned by this method is as follows:
<wsResult>
<Invoices>
<Invoice InvoiceNumber = "ref001" InvoiceReference = "7729/760" InvoiceDate = "2020-05-07T00:00:00" InvoiceRegistrationDate = "2020-05-07T00:00:00" DueDate = "2014-05-08T00:00:00" TotalInvoiceAmount = "200.00" VATExcludedAmount = "0.00" Currency = "USD" TotalPaid = "200.00" OutStandingAmount = "0.00" InvoiceSeries = "ATVI" Market = "13" InvoiceFileNumber = "760">
<Supplier Id = "7729">
<SupplierName>Provedor Xavi test</SupplierName>
<SupplierCodExport>Provedo</SupplierCodExport>
</Supplier>
<AccountRefNumber></AccountRefNumber>
<Lines>
<Line BookingCode = "OVNLIF" LineDate = "2020-02-18T15:37:24" BookingDate = "2020-02-18T15:37:24" IdBookingLine = "57396" PaxNumber = "2" BeginTravelDate = "2020-02-22T10:00:00" EndTravelDate = "2020-02-22T10:00:00" ProductType = "V2" ProductGroup = "104" ProductGroupName = "coretest" ProductId = "-1" AgencyGroupId = "82" AgencyGroupNametId = "Grupo agencia Xavi" InvoiceSeries = "ATVI" InvoiceFileNumber = "760" Market = "13" TicketNumber = "0" VATExcludedAmount = "0.00">
<Service>IBZ-LON-IBZ</Service>
<Cost TotalAmount = "200.00" DeviationOverForecastedCost = "0.00" Deviation = "0.00"></Cost>
<CoMarketings>
<Comarketing ProductType = "Alojamiento" ModuleType = "AGO" Percentage = "10,00"/>
<Comarketing ProductType = "Excursion" ModuleType = "E061" Percentage = "50,00"/>
</CoMarketings>
</Line>
</Lines>
<taxes>
<tax value = "20.11" fixed = "yes" exempt = "no" base = "481.00" exemptbase = "0.00" name = "Tasas Others" total = "20.11" esComi = "no" IdBookingLine = "194675" taxcode = "0"/>
<tax value = "20.11" fixed = "yes" exempt = "no" base = "481.00" exemptbase = "0.00" name = "Tasas Others" total = "20.11" esComi = "no" IdBookingLine = "194675" taxcode = "0"/>
<tax value = "20.11" fixed = "yes" exempt = "no" base = "481.00" exemptbase = "0.00" name = "Tasas Others" total = "20.11" esComi = "no" IdBookingLine = "194675" taxcode = "0"/>
</taxes>
</Invoice>
</Invoices>
</wsResult>
Attribute and node details:
Node / Attribute (@) | Type | Description |
---|---|---|
Invoice | - | Invoice item. |
./Invoice/@InvoiceNumber | Numeric | Invoice number. |
./Invoice/@IdInvoice | Numeric | Internal invoice ID. |
./Invoice/@InvoiceReference | String | Invoice reference. |
./Invoice/@InvoiceDate | DateTime | Invoice date. |
./Invoice/@InvoiceRegistrationDate | DateTime | Invoice set up date. |
./Invoice/@DueDate | DateTime | Invoice due date. |
./Invoice/@CreationDate | DateTime | Invoice creation date. |
./Invoice/@UserAmount | Numeric | Amount. |
./Invoice/@UserTaxes | Numeric | Taxes. |
./Invoice/@UserPercentTaxes | Numeric | Percent of taxes. |
./Invoice/@Commission | Numeric | Commission. |
./Invoice/@TaxCommission | Numeric | Tax commission. |
./Invoice/@InvoiceCurrency | String | Currency. |
./Invoice/@InvoiceExchangeFactor | Numeric | Exchange factor. |
./Invoice/@TotalInvoiceAmount | Numeric | Total invoice amount. |
./Invoice/@VATExcludedAmount | Numeric | VAT excluded amount. |
./Invoice/@Currency | String(5) | Invoice currency. |
./Invoice/@TotalPaid | Numeric | Invoice paid amount. |
./Invoice/@OutStandingAmount | Numeric | Difference of amount between the booking amount and the paid amount. |
./Invoice/@InvoiceSeries | String(50) | Invoicing series. |
./Invoice/@Market | Numeric | Market ID. |
./Invoice/@InvoiceFileNumber | Numeric | Invoice file number. |
./Invoice/@PurchasingComanyId | Numeric | Purchasing company identifier. It requires the multicompany module. |
./Invoice/@PurchasingCompanyName | String | Purchasing company name. It requires the multicompany module. |
./Invoice/@PurchasingCompanyCod | String | Purchasing company code. It requires the multicompany module. |
./Invoice/Supplier | - | - |
./Supplier/@Id | Numeric | Supplier identifier. |
./Supplier/SupplierName | String(150) | Supplier name. |
./Supplier/SupplierID | String(50) | Supplier CIF code. |
./Invoice/AccountRefNumber | String(31) | Account reference number. |
./Invoice/Lines | - | List of booking lines of the invoice. |
./Lines/Line | - | Booking line. |
./Line/@BookingCode | String(7) | Invoicing service booking code. |
./Line/@LineDate | DateTime | Invoice element set up date. |
./Line/@BookingDate | DateTime | Booking set up date. |
./Line/@IdBookingLine | Numeric | Invoiced booking element identifier. |
./Line/@PaxNumber | Numeric | Pax. Number. |
./Line/@BeginTravelDate | DateTime | Travel start date. |
./Line/@EndTravelDate | DateTime | Travel end date. |
./Line/@ProductType | String(15) | Product type. |
./Line/@ProductGroup | Numeric | Product group identifier. |
./Line/@ProductGroupName | String(50) | Product group name. |
./Line/@ProductId | Numeric | Product group identifier. |
./Line/@AgencyGroupId | Numeric | Agency group identifier. |
./Line/@AgencyGroupNameId | String(100) | Agency group name. |
./Line/@InvoiceSeries | String(25) | Purchase invoice series. |
./Line/@InvoiceFileNumber | Numeric | Internal invoice number. |
./Line/@Market | Numeric | Market identifier. |
./Line/@UserAmount | Numeric | Market identifier. |
./Line/@UserTaxes | Numeric | Taxes. |
./Line/@UserPercentTaxes | Numeric | Percent of taxes. |
./Line/@Commssion | Numeric | Commission. |
./Line/@TaxCommission | Numeric | Tax commission. |
./Line/@VATExcludedAmount | Numeric | VAT excluded amount. |
./Line/@InvoiceCurrency | String | Currency. |
./Line/@InvoiceExchangeFactor | Numeric | Echange factor. |
./Line/@TicketNumber | String(50) | Service ticket number. (In case of Destinations serices) |
./Line/Service | String(150) | Service decription. |
./Line/Cost | - | Cost of the booking line. |
./Cost/@TotalAmount | Numeric | Element's total amount. |
./Cost/@DeviationOverForecastCost | Numeric | Deviation over the cost forecast. |
./Cost/@Deviation | Numeric | Deviation over the total cost. |
./Line/@Comarketings | - | List of comarketing percentage discount. |
./Comarketings/Comarketing | - | One comarketing percentage discount. |
./Comarketing/@ProductType | String(50) | Product type which apply percentage discount. |
./Comarketing/@ModuleType | String(4) | Module which apply percentage discount. |
./Comarketing/@Percentage | Numeric | Percentage discount amount. |
./Invoice/taxes | - | List of taxes. |
./taxes/tax | - | Tax Item. |
./tax/@value | Numeric | Sales tax value. |
./tax/@fixed | Boolean | Bit that indicates whether the tax is fixed or not. |
./tax/@Exempt | Numeric | Tax exempt amount |
./tax/@exemptbase | Numeric | Base tax exempt amount |
./tax/@base | Numeric | Tax base amount |
./tax/@name | String(50) | Tax name |
./tax/@total | Numeric | Total tax amount |
./tax/@taxcode | Numeric | Sales tax value. |
./Invoice/OperationRate | Internal numeric ID of tax code |
This method returns a list of receipts performed by the customers.
<soapenv:Envelope xmlns:soapenv = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:jun = "http://juniper.es/">
<soapenv:Header/>
<soapenv:Body>
<jun:GetCustomerPayments>
<jun:user>username</jun:user>
<jun:password>password</jun:password>
<jun:CreationDateFrom>20210602</jun:CreationDateFrom>
<jun:CreationDateTo>20210603</jun:CreationDateTo>
<jun:ExportMode>C</jun:ExportMode>
</jun:GetCustomerPayments>
</soapenv:Body>
</soapenv:Envelope>
Node / Attribute (@) | Opt | Type | Description |
---|---|---|---|
user | N | String | Intranet username |
password | N | String | Intranet user password |
CreationDateFrom | Y | Date | Creation date “from”, Format: yyyyMMdd |
CreationDateTo | Y | Date | Creation date “to”, Format: yyyyMMdd |
CreationTimeFrom | Y | Time | Creation time “from”, Format: HH:mm:ss |
CreationTimeTo | Y | Time | Creation time “to”, Format: HH:mm:ss |
Customerid | Numeric | Client/agency identificator | |
PaymentId | Y | Numeric | Payment identificator |
CustomerType | Y | Numeric | Customer type. Possible values: - 0. Corporate - 1. Agency - 2. End customer - 4. Tourist guide |
TypeOfPayment | Y | Numeric | Receipt type. The allowed receipt types are: - 1. Receipts performed on invoices / bookings - 2. Credit on account. - 3. Refunds |
ExportMode | Y | String | Exporting mode. There are 2 possible values: - C: Checking mode. This mode does not mark the customer as “exported”. - E: Exporting mode. This mode marks the customer as “exported” which means that the next time we export through this method will not export customers marked as “Exported”. |
channel | Y | String | Sales channel. It exports all the bookings, which sales channel is the one specified. |
invoiceId | Y | Numeric | Invoice identifier |
FinalCustomerid | Y | Numeric | Final customer identifier |
<soap:Envelope xmlns:soap = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetCustomerPaymentsResponse xmlns = "http://juniper.es/">
<GetCustomerPaymentsResult>
<wsResult xmlns = "">
<Payments>
<Payment Id = "1014" CustomerId = "789" FinalCustomerId = "" Series = "" ReceiptNumber = "" AgencyGroupId = "35" AgencyGroupName = "Integradores" Market = "8" Type = "0" Reference = "Ref. 123456" PaymentCreationDate = "2020-09-06T00:00:00" BankCharges = "0.00" PaymentType = "RES" PaymenAmount = "254.02" OutStandingAmount = "0.00" CommissionPercentage = "0" CommissionAmount = "0" VATPercentage = "0" VATAmount = "0" tcNumber = "" tcAccountNumber = "" tcPointsAmount = "" tcRatio = "" Currency = "USD" AmountAppliedToInvoices = "0.00" AmountAppliedToBookings = "254.02" BankAccountId = "7" BankAccountName = "Bank Of Bali" BankAccountCurrency = "USD">
<Concept>S1SS4D</Concept>
<formofpayment Id = "CRC" idCL = "" type = "Credit Card">
<descpayment>4111111111111111</descpayment>
<cardType>3</cardType>
<cardNumber>4111111111111111</cardNumber>
<cvv>123</cvv>
<expiration>09/20</expiration>
<cashbox>0</cashbox>
<holderName/>
<holderSurname/>
<cardIssuingBank>Bank</cardIssuingBank>
<cardDateIssue/>
<documentType/>
<documentNumber/>
<cupon/>
<details/>
<batchNumber/>
<authorizationCode/>
<operationCode/>
<brandcard>Master Card</brandcard>
<tpv_operation/>
<typecreditcard>MASTER</typecreditcard>
<IPAdress>95.39.36.90</IPAdress>
</formofpayment>
<Invoices>
<Invoice InvoiceId = "0" InvoiceNumber = "0" InvoiceSerie = "" TotalPaid = "0" customerCurrency = "USD"/>
</Invoices>
<Bookings>
<Booking BookingId = "57328" TotalPaid = "254.02" CustomerCurrency = "USD" TotalPaidServiceCurrency = "254.02" ServiceCurrency = "USD" ConversionFactor = "1" ConversionFactorApplication = "1" BookingCode = "S1SS4D" BookingLineId = "64646" PaymentLineId = "592"/>
</Bookings>
<OperationRate>1</OperationRate>
</Payment>
</Payments>
</wsResult>
</GetCustomerPaymentsResult>
</GetCustomerPaymentsResponse>
</soap:Body>
</soap:Envelope>
Node / Attribute (@) | Type | Description |
---|---|---|
Payments | ||
Payments/Payment | - | Payments container \ Payment item |
./Payment/@Id | Numeric | Unique receipt identifier |
./Payment/@CustomerId | Numeric | Customer identifier |
./Payment/@FinalCustomerId | Numeric | Final Customer identifier |
./Payment/@Series | Numeric | Series associated with the receipt |
./Payment/@ReceiptNumber | Numeric | Receipt No. associated with the series |
./Payment/@AgencyGroupId | Numeric | Product group identifier |
./Payment/@AgencyGroupName | String(100) | Product group name |
./Payment/@Market | Numeric | Market identifier |
./Payment/@Type | Numeric | NOT IMPLEMENTED |
./Payment/@Reference | String(250) | Customer internal reference |
./Payment/@PaymentCreationDate | DateTime | Receipt set up date |
./Payment/@BankCharges | Numeric | Bank cost |
./Payment/@PaymentType | String | Payment Type. Possible values: • RES: Booking • FAC: Invoice • CUE: Account • DEV: Return • GTD: Guarantee • DEP: Deposit • TSP: Transfer • EBO: Early booking |
./Payment/@PaymentAmount | Numeric | Receipt amount |
./Payment/@OutStandingAmount | Numeric | Outstanding amount |
./Payment/@CommissionPercentage | Numeric | Percentage of the commission applied to the receipt |
./Payment/@CommissionAmount | Numeric | Commission amount |
./Payment/@VATPercentage | Numeric | VAT percentage over the commission |
./Payment/@VATAmount | Numeric | VAT amount over the commission |
./Payment/@tcNumber | Numeric | TravelClub payment number |
./Payment/@tcAccountNumber | Numeric | TravelClub account number |
./Payment/@tcPointsAmount | Numeric | TravelClub points |
./Payment/@tcRatio | Numeric | TravelClub ratio |
./Payment/@Currency | String(5) | Receipt currency |
./Payment/@AmountAppliedToInvoices | Numeric | Receipt amount applied to invoices |
./Payment/@AmountAppliedToBookings | Numeric | Receipt amount applied to bookings |
./Payment/@BankAccountId | Numeric | Bank Identifier where the receipt has been made. |
./Payment/@BankAccountName | String(31) | Bank account name |
./Payment/@BankAccountCurrency | String(3) | Bank account currency |
./Payment/@SaleCompanyId | Numeric | Sales company identificator. Requires the multicompany module. |
./Payment/@SaleCompanyName | String | Sales company name. Requires the multicompany module. |
./Payment/@SaleCompanyCod | String(150) | Sales company code. Requires the multicompany module. |
./Payment/Concept | String(150) | Receipt description |
./Concept/formOfPayment | - | Form of payment description |
./formOfPayment/@Id | String(3) | Receipt type Identifier. Possible values: • CSH: Cash • CHK: Check • BKT: Bank Transfers • CRC: Credit card • MAO: Mail Order • JOU: Journal • DCB: Debit direct payment • UAT: UATP • DSU: Debit from Salary • TOP: CC Processed by Supplier • VIN: Internal Sale • VAS: Voucher • MEP: Mercado Pago • PER: Argentinian - Tax perception • PAG: Promissory Note |
./formOfPayment/@idCL | String | Client receipt type identifier |
./formOfPayment/@type | String(25) | Description of the receipt type (see previous item). |
./formOfPayment/descpayment | String(200) | Description of the payment type (payments transfer No….) |
./formOfPayment/cardType | String | Credit card type. Payment methods that use it (CRC, UAT, TOP). If your system is configured to not save credit card information, this field will be unavailable. |
./formOfPayment/cardNumber | String | Credit card No. Payment methods that use it (CRC, UAT, TOP). If your system is configured to not save credit card information, it will instead supply you with the credit card obscured and the format will depend on the credit card itself, for example: ************8888 |
./formOfPayment/cvv | Numeric | Card security code. Payment methods that use it. (CRC, UAT, TOP) |
./formOfPayment/expiration | String | Credit card expiry date. Payment methods that use it. (CRC, UAT, TOP) |
./formOfPayment/cashbox | String | Obsolete field. Payment methods that use it. (CRC, UAT) |
./formOfPayment/holderName | String | Credit card holder name. Payment methods that use it. (CRC, UAT) |
./formOfPayment/holderSurname | String | Credit card holder last names. Payment methods that use it. (CRC, UAT) |
./formOfPayment/cardIssuingBank | String | Bank that issues the credit card. Payment methods that use it. (CRC, UAT) |
./formOfPayment/cardDateIssue | Date | Credit card Issue date. Payment methods that use it. (CRC, UAT) |
./formOfPayment/documentType | String | Credit card holder type of document. Payment methods that use it. (CRC, UAT) |
./formOfPayment/documentNumber | String | Document No. that identifies the credit card holder. Payment methods that use it.(CRC, UAT) |
./formOfPayment/cupon | String | Receipt coupon. Payment methods that use it. (CRC, UAT) |
./formOfPayment/details | String | Receipt remarks. Payment methods that use it. (CRC, UAT, DSU, TOP, VIN, VAS, MEP) |
./formOfPayment/batchNumber | String | Receipt batch. Payment methods that use it. (CRC, UAT) |
./formOfPayment/employeeName | String | Employee name. Payment methods that use it.(DSU, VIN) |
./formOfPayment/fees | Byte | Quotes. Payment methods that use it (DSU) |
./formOfPayment/operatorName | String | Operator name. Payment methods that use it (TOP) |
./formOfPayment/department | String | Department. Payment methods that use it (VIN) |
./formOfPayment/voucherNumber | String | Voucher No. Payment methods that use it (VAS) |
./formOfPayment/voucherNameSurname | String | Voucher name and surnames. Payment methods that use it. (VAS) |
./formOfPayment/office | String | Branch office No. Payment methods that use it. (VAS) |
./formOfPayment/voucherDate | Date | voucherDate Date Voucher date. Payment methods that use it (VAS) |
./formOfPayment/detailsVoucher | String | Description for the voucher receipt type. Payment methods that use it (VAS) |
./formOfPayment/validationNumber | String | Validation code. Payment methods that use it (MEP) |
./formOfPayment/descPago | String | Payment method description. Payment methods that use it. (PER) |
./formOfPayment/base | Double | Base price. Payment methods that use it. (PER) |
./formOfPayment/tipoPercepcion | Byte | Perception type. Payment methods that use it. (PER) |
./formOfPayment/codigoCertificacion | String | Certified code. Payment methods that use it. (PER) |
./formOfPayment/amount | Decimal | Receipt amount. Payment method that use it. (PAG) |
./formOfPayment/dueDate | Date | Due date. Payment methods that use it. (PAG) |
./formOfPayment/authorizationCode | String | Authorization code. Payment methods that use (CRC, UAT and TOP) |
./formOfPayment/operationCode | String | Operation code. Payment methods that use (CRC, UAT and TOP) |
./formOfPayment/brandcard | String | Type of Card. Payment methods that use (CRC, UAT and TOP) |
./formOfPayment/tpv_operation | String | Bank operation code. Payment methods that use (CRC, UAT and TOP) |
./formOfPayment/typecreditcard | String(20) | Description of the credit card if the payment type is performed with credit card. |
./formOfPayment/IPAdress | String | IP from which the payment was performed. |
./Payment/Invoices | - | Invoices directly related to the booking lines involved on the payment. |
./Invoices/Invoice | - | Invoice Item |
./Invoice/@InvoiceId | Numeric | Invoice Identifier to which the receipt applied. |
./Invoice/@InvoiceNumber | Numeric | Invoice No. |
./Invoice/@InvoiceSerie | String | Invoicing series. |
./Invoice/@TotalPaid | Numeric | Amount applied to this invoice. |
./Invoice/@PaymentCreationDate | Date | Payment creation date |
./Invoice/@PaymentAplicationDate | Date | Payment application date |
./Invoice/@CustomerCurrency | String(5) | Invoice currency |
./Invoice/@TotalPaidServiceCurrency | Numeric | Service total paid amount |
./Invoice/@ServiceCurrency | String(5) | Service currency |
./Invoice/@ConversionFactor | Numeric | Exchange rate |
./Invoice/@ConversionFactorApplication | Numeric | Conversion factor between the amount of the account and the booking |
./Invoice/@Date | Date | Date of receipt |
./Invoice/@Detail | String(200) | Description of booking element |
./Invoice/@Number | String(50) | Invoice Number |
./Invoice/@BookingId | Numeric | Booking code |
./Invoice/@InvoiceLineId | Numeric | Invoice code |
./Invoice/@BookingCode | Numeric | Booking code |
./Invoice/@BookingLineId | Numeric | Booking element code |
./Invoice/@PaymentLineId | Numeric | Receipt code |
./Payment/Bookings | - | Bookings - List of Bookings |
./Bookings/Booking | - | Booking Item |
./Booking/@BookingId | Numeric | Booking identificator |
./Booking/@TotalPaid | Numeric | Booking amount |
./Booking/@CustomerCurrency | String | Booking amount currency |
./Booking/@TotalPaidServiceCurrency | Numeric | Booking line amount |
./Booking/@ServiceCurrency | String | Booking line amount currency |
./Booking/@ConversionFactor | Numeric | Exchange rate between the booking and the booking line currency |
./Booking/@ConversionFactorApplication | Numeric | Applied exchange rate |
./Booking/@BookingCode | String | Booking code |
./Booking/@BookingLineId | Numeric | Booking element identifier |
./Booking/@PaymentLineId | Numeric | Receipt code |
./Payment/OperationRate | Numeric | Operation rate |
This method returns a list of alternative receipts performed by the customers.
<soapenv:Envelope xmlns:soapenv = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:jun = "http://juniper.es/">
<soapenv:Header/>
<soapenv:Body>
<jun:GetFictitiousPayments>
<jun:user>username</jun:user>
<jun:password>password</jun:password>
<jun:PaymentDateFrom>20140321</jun:PaymentDateFrom>
<jun:PaymentDateTo>20140321</jun:PaymentDateTo>
<jun:BookingCode>TXHMRR</jun:BookingCode>
</jun:GetFictitiousPayments>
</soapenv:Body>
</soapenv:Envelope>
Node / Attribute (@) | Opt | Type | Description |
---|---|---|---|
user | N | String | Intranet username |
password | N | String | Intranet user password |
PaymentDateFrom | Y | Date | Payment date from, Format: yyyyMMdd |
PaymentDateTo | Y | Date | Payment date to, Format: yyyyMMdd |
BookingCode | Y | String | Code or locator that identifies a booking |
<soap:Envelope xmlns:soap = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetFictitiousPaymentsResponse xmlns = "http://juniper.es/">
<GetFictitiousPaymentsResult>
<wsResult xmlns = "">
<FictitiousPayments>
<FictitiousPayment Id="287745">
<Agency>Juniper (Integrador)</Agency>
<BookingCode>TXHMRR</BookingCode>
<BookingDate>2020-08-13T11:16:32</BookingDate>
<StartTravelDate>2020-09-10T00:00:00</StartTravelDate>
<EndTravelDate>2020-09-13T00:00:00</EndTravelDate>
<Amount>1500,00</Amount>
<Currency>USD</Currency>
<FormPayment>CSH</FormPayment>
<PaymentDate>2019-03-21T00:00:00</PaymentDate>
<formPaymentAlternate>
<Id>1</Id>
<Name>Cash TEST</Name>
<Fields>
<Field Name = "Test_Field" Value = "Test_Value"/>
</Fields>
</formPaymentAlternate>
</FictitiousPayment>
</FictitiousPayments>
</wsResult>
</GetFictitiousPaymentsResult>
</GetFictitiousPaymentsResponse>
</soap:Body>
</soap:Envelope>
Node / Attribute (@) | Type | Description |
---|---|---|
FictitiousPayments | - | Alternative payments container |
./FictitiousPayments/FictitiousPayment | - | Alternative payment container |
./FictitiousPayment/@Id | Numeric | Fictitious payment internal id |
./FictitiousPayment/Agency | String | Agency name |
./FictitiousPayment/BookingCode | String | Code or locator that identifies a booking |
./FictitiousPayment/BookingDate | DateTime | Date on which the booking was created |
./FictitiousPayment/StartTravelDate | DateTime | Date on which the booking starts |
./FictitiousPayment/EndTravelDate | DateTime | Date on which the booking ends |
./FictitiousPayment/Amount | Numeric | Amount of the alternative payment |
./FictitiousPayment/Currency | String | Currency of the alternative payment |
./FictitiousPaymentFormPayment | String | Receipt type. Possible values: - CSH. Cash - CRC. Credit card - CHK. Check - BKT. Bank transfer - MAO. Mail order - JOU. Journal - DCB. Debit direct payment - UAT. UATP - CRE. Credit |
./FictitiousPayment/PaymentDate | DateTime | Date on which the payment has been performed |
./FictitiousPayment/formPaymentAlternate | - | Alternative payment container |
./formPaymentAlternate/Id | Numeric | Alternative payment id |
./formPaymentAlternate/Name | String | Alternative payment name |
./formPaymentAlternate/Fields | - | Fields container |
./Fields/Field | - | Field |
./Field/@Name | String | Additional field name |
./Field/@Value | String | Additional field value |
This method returns a list of payments made to suppliers. The request parameters of this method are the following:
The XML returned by this method is as follows:
<wsResult>
<Payments>
<Payment Id="925" SupplierId="1" AgencyGroupId="27"
AgencyGroupName="Grupo Agencia Cliente Final" Market="1"
Type="1" PaymentCreationDate="2019-12-25T00:00:00"
PaymenAmount="1758.83" Currency="EUR"
AmountAppliedToInvoices="50.00" AmountAppliedToBookings="0.00"
BankAccountId="8">
<Concept>PAGO 25/02</Concept>
<formofpayment Id="" type="">
<descpayment></descpayment>
<typecreditcard></typecreditcard>
</formofpayment>
<Invoices>
<Invoice InvoiceId="jjjjj" InvoiceSerie="ATVI" TotalInvoiceAmount="50,00" TotalPaid="50.00" Currency="EUR"
TotalInvoiceCost="50.00" CostCurrency="EUR" OutStandingAmount="0.00" IdBookingLine="0"></Invoice>
</Invoices>
<Bookings>
<Booking BookingId="0" TotalInvoiceAmount="0" TotalPaid="0" Currency="USD" TotalInvoiceCost="0" CostCurrency="USD" OutStandingAmount="0" IdBookingLine="0"></Booking>
</Bookings>
</Payment>
</Payments>
</wsResult>
Attribute and Node details:
Node / Attribute (@) | Type | Description |
---|---|---|
Payment | - | Payment Item |
./Payment/@Id | Numeric | Unique payment identifier |
./Payment/@SupplierId | Numeric | Supplier identifier |
./Payment/@AgencyGroupId | Numeric | Product group identifier |
./Payment/@AgencyGroupName | String(100) | Product group name |
./Payment/@Market | Numeric | Market identifier |
./Payment/@Type | Numeric | Payment type. Possible values: • 1: Payment bookings/invoices • 3: Payment on account • 5: Guanrantee payment • 6: Deposit • 7: Refund |
./Payment/@PaymentCreationDate | DateTime | Date in which the payment was created as such |
./Payment/@PaymentAmount | Numeric | Payment amount |
./Payment/@Currency | String(5) | Payment currency |
./Payment/@AmountAppliedToInvoices | Numeric | Payment amount applied to invoices |
./Payment/@AmountAppliedToBookings | Numeric | Payment amount applied to bookings |
./Payment/@BankAccountId | Numeric | Bank identifier where the payment took place |
./Payment/@ConversionFactor | Numeric | Conversion factor |
./Payment/@AccountCurrency | String(3) | Account currenty |
./Payment/Concept | String(250) | Payment description |
./Payment/formOfPayment | - | Form of payment description |
./formOfPayment/@Id | String(3) | Receipt type Identifier. Possible values: • CSH: Cash • CHK: Check • BKT: Bank Transfers • CRC: Credit card • MAO: Mail Order |
./formOfPayment/@Type | String(25) | Description of the receipt type (see previous item). |
./formOfPayment/Descpayment | String(200) | Description of the payment type (payments transfer No, check, credit card No., Mail order, cash….) |
./formOfPayment/TypeCreditCard | String(20) | Description of the credit card if the payment type is performed with credit card. |
./Payment/Invoices | - | List of invoices |
./Invoices/Invoice | - | Item Invoice |
./Invoice/@InvoiceId | Numeric | Invoice Identifier to which the receipt applied. |
./Invoice/@TotalPaid | Numeric | Amount applied to this invoice. |
./Invoice/@CustomerCurrency | String(5) | Invoice currency |
./Invoice/InvoiceSerie | String(25) | Purchase Invoice series |
./Invoice/TotalInvoiceAmount | Numeric | Total purchase invoice amount |
./Invoice/TotalInvoiceCost | Numeric | Total purchase invoice cost |
./Invoice/CostCurrency | Numeric | Cost currency |
./Invoice/OperationRate | Numeric | Exchange rate of the operation in Export currency |
./Invoice/OutStandingAmount | Numeric | Outstanding amount |
./Invoice/IdBookingLine | Numeric | Booking line identificatory |
./Payment/Bookings | - | List of Bookings |
./Bookings/Booking | - | Item Booking |
./Booking/BookingId | Numeric | Booking Identifier to which the receipt has applied. |
./Booking/TotalPaid | Numeric | Amount applied to this booking |
./Booking/TotalInvoiceAmount | Numeric | Total invoice amount |
./Booking/CostCurrency | String(3) | Cost Currency |
./Booking/OperationRate | Numeric | Exchange rate of the operation in Export currency |
./Booking/Currency | String(3) | Booking currency |
./Booking/TotalInvoiceCost | Numeric | Total invoice cost |
./Booking/OutStandingAmount | Numeric | Outstanding amount |
./Booking/IdBookingLine | Numeric | Booking line identificatory |
./Payment/OperationRate | Numeric | Exchange rate of the operation |
This method returns the list of bank accounts that exist in the system. The request parameters of this method are the following:
The XML returned by this method is as follows:
<wsResult>
<BankAccs>
<BankAcc Id = "1" AccType = "N" default = "False">
<Name><![CDATA[Test Account]]></Name>
<AccountRefNumber><![CDATA[52900]]></AccountRefNumber>
<Remarks><![CDATA[]]></Remarks>
</BankAcc>
<BankAcc Id = "2" AccType = "N" default = "False">
<Name><![CDATA[Citibank]]></Name>
<AccountRefNumber><![CDATA[572000000000]]></AccountRefNumber>
<Remarks><![CDATA[]]></Remarks>
</BankAcc>
<BankAcc Id = "4" AccType = "N" default = "True">
<Name><![CDATA[NBK Bank]]></Name>
<AccountRefNumber><![CDATA[000000000001]]></AccountRefNumber>
<Remarks>
<![CDATA[SWIFT: NBOKKWKW
'Actt #: 801008210101
'Branch: Head Office]]>
</Remarks>
</BankAcc>
<BankAcc Id = "5" AccType = "N" default = "False">
<Name><![CDATA[CASH ON HAND]]></Name>
<AccountRefNumber><![CDATA[10-1-1/00000]]></AccountRefNumber>
<Remarks><![CDATA[]]></Remarks>
</BankAcc>
</BankAccs>
</wsResult>
Attribute and node details:
Node / Attribute (@) | Type | Description |
---|---|---|
BankAccs | - | Bank Account list |
BankAccs/BankAccs | - | Bank Account Item |
./BankAccs/@Id | Numeric | Bank account identifier |
./BankAccs/@AccType | String(1) | Bank account type. N: Bank, T:Credit Card, C:Credit |
./BankAccs/@Default | Boolean | It indicates whether it is the account by default or not. |
./BankAccs/@Name | String(30) | Bank account name |
./BankAccs/@AccountRefNumber | String(20) | Bank account number |
./BankAccs/@Remarks | String(1000) | Bank account remarks |
Through this web service, you may obtain a list of all bookings created in the system given certain filters.
This transaction allows for the retrieval of booking codes along with very basic information. In conjunction with the getBookings request, these two requests will allow you to retrieve all of the information of the bookings from your system.
Important note:
Given that this transaction offers a much better performance in comparison to the getBookings request, if you plan on periodially sending this request in order to retrieve all of the available bookings that have been created and/or modified on your system, we recommend for you to achieve this through the use of this transaction and later retrieve the detailed information of each available booking through the help of the getBookings request.
This would not only help you improve transfer times (as you could strictly request for those bookings and get a smaller response) but help improve data transfer (as, depending on your filters and on how often you sent this request, you would avoid getting the same reservation that did not get modified multiple times).
<soapenv:Envelope xmlns:soapenv = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:jun = "http://juniper.es/">
<soapenv:Header/>
<soapenv:Body>
<jun:getBookingList>
<jun:user>username</jun:user>
<jun:password>password</jun:password>
<jun:LastModifiedDateFrom>20180820</jun:LastModifiedDateFrom>
<jun:LastModifiedDateTo>20180820</jun:LastModifiedDateTo>
</jun:getBookingList>
</soapenv:Body>
</soapenv:Envelope>
Node / Attribute (@) | Opt | Type | Description |
---|---|---|---|
user | N | String | Intranet username |
password | N | String | Intranet user password |
BookingDateFrom | Y | Date | Booking set up date “From”, Format: yyyyMMdd |
BookingDateTo | Y | Date | Booking set up date “To”, Format: yyyyMMdd |
BookingTimeFrom | Y | Time | Booking creation hour “from”, Format: HH:mm:ss |
BookingTimeTo | Y | Time | Booking creation hour “to”, Format: HH:mm:ss |
BeginTravelDate | Y | Date | Booking travel start date. It agrees on the initial date of the first service booked, Format: yyyyMMdd |
EndTravelDate | Y | Date | Booking travel end date. It agrees on the final date of the last service booked, Format: yyyyMMdd |
LastModifiedDateFrom | Y | Date | Booking last modification date “From”. It searches all the bookings which modification date is later than the specified date, Format: yyyyMMdd |
LastModifiedDateTo | Y | Date | Booking last modification date “To”. It searches all the bookings which modification date is previous than the specified date. , Format: yyyyMMdd |
LastModifiedTimeFrom | Y | Time | Initial modification last hour. Search all bookings which modification hour is the same or higher than the specified hour, Format: HH:mm:ss |
LastModifiedTimeTo | Y | Time | Final modification last hour. Search all bookings which modification hour is the same or lower than the specified hour, Format: HH:mm:ss |
Status | Y | String | Booking status. Possible values: • OK: Confirmed and paid • RQ: On request • Con: Confirmed • Can: Cancelled • CaC: Cancelled by client • Ini: Initialization • Quo: Quote • Tar: Credit card |
id | Y | Integer | Internal code that identifies the agency/client. |
channel | Y | String | Sales channel. It exports all the bookings, which sales channel is the one specified. |
ModuleType | Y | String | Filters the exported bookings to only include those that match the specified module type/s. It is possible to request multiple module types at the same time by separating them by commas. These module types will depend on the available product types from your system (for example: 'Alojamiento'), contact with your project manager if you would like for a list of all of the available module types of your system. |
BeginTravelDateFrom | Y | Date | Begin travel date “From”. It searches all the bookings which Start date is same or later than the specified date, Format: yyyyMMdd |
BeginTravelDateTo | Y | Date | Begin travel date “To”. It searches all the bookings which Start date is same or earlier than the specified date, Format: yyyyMMdd |
EndTravelDateFrom | Y | Date | End travel date “From”. It searches all the bookings which End date is same or later than the specified date, Format: yyyyMMdd |
EndTravelDateTo | Y | Date | End travel date “To”. It searches all the bookings which Start date is same or earlier than the specified date, Format: yyyyMMdd |
NonRefundable | Y | Boolean | Optional filter that, if included, filters the results for refundable (False) or non refundable bookings (True). |
PackageBookings | Y | String | Package bookings. Possible values: • All: All bookings are returned • Include: Only package bookings are returned • Exclude: Package bookings are excluded |
BlockedBookings | Y | String | Blocked bookings. Possible values: • All: All bookings are returned • Include: Only blocked bookings are returned • Exclude: Blocked bookings are excluded |
<soap:Envelope xmlns:soap = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
<soap:Body>
<getBookingListResponse xmlns = "http://juniper.es/">
<getBookingListResult>
<wsResult xmlns = "">
<BookingList>
<Booking Id = "50611" Status = "Can" BookingCode = "HY9SB9" BookingDate = "2018-07-01T14:56:17" LastModifiedDate = "2020-08-20T00:01:05" AgencyRef = "0375D44H" TimeZone="02:00"/>
<Booking Id = "51672" Status = "Can" BookingCode = "MQH7RV" BookingDate = "2018-07-11T10:23:24" LastModifiedDate = "2020-08-20T00:01:03" AgencyRef = "F514CD9H" TimeZone="02:00"/>
<Booking Id = "52576" Status = "Can" BookingCode = "ZRZ18N" BookingDate = "2018-07-18T11:23:33" LastModifiedDate = "2020-08-20T00:01:04" AgencyRef = "52A4620H" TimeZone="02:00"/>
<Booking Id = "53692" Status = "Can" BookingCode = "MN5Z54" BookingDate = "2018-07-26T12:15:54" LastModifiedDate = "2020-08-20T00:01:04" AgencyRef = "23BF93DH" TimeZone="02:00"/>
<Booking Id = "55559" Status = "CaC" BookingCode = "35YN4L" BookingDate = "2018-08-17T10:29:21" LastModifiedDate = "2020-08-20T12:29:26" AgencyRef = "MyReference" TimeZone="02:00"/>
<Booking Id = "55640" Status = "OK" BookingCode = "11N331" BookingDate = "2018-08-20T06:21:29" LastModifiedDate = "2020-08-20T11:29:35" AgencyRef = "" TimeZone="02:00"/>
<Booking Id = "55641" Status = "OK" BookingCode = "CMVHDM" BookingDate = "2018-08-20T07:42:13" LastModifiedDate = "2020-08-20T07:42:18" AgencyRef = "T3BR-H1755" TimeZone="02:00"/>
</BookingList>
</wsResult>
</getBookingListResult>
</getBookingListResponse>
</soap:Body>
</soap:Envelope>
Node / Attribute (@) | Type | Description |
---|---|---|
BookingList | - | Bookings container |
./BookingList/Booking | - | Booking container |
./Booking/@Id | Numeric | Unique booking identifier |
./Booking/@Status | String(3) | Booking status. Possible values: • OK: Confirmed and paid • RQ: On request • Con: Confirmed • Can: Cancelled • CaC: Cancelled by client • Ini: Initialization • Quo: Quote • Tar: Credit card |
./Booking/@BookingDate | DateTime | Booking set up date |
./Booking/@BookingCode | String(7) | Booking code |
./Booking/@LastModifiedDate | DateTime | Last modified date |
./Booking/@AgencyRef | String | Agency reference No. |
./Booking/@TimeZone | String | TimeZone of the system and on which the dates of the booking are being supplied. |
This request will let you retrieve all of the detailed information of your reservations.
If you plan on sending this request periodically in order to retrieve all of the reservations that are being created and/or modified on your booking engine, please refer to the getBookingList request first, as this one can be quite costly (performance-wise) for the system, and even impair the performance of the system if abused.
Following the above annotation, for the proper use of this request, you should implement a booking retrieval process that would periodically:
Note that if the search filters are excessive (too many reservations would be being requested), you will get the following error on its response:
<wsResult xmlns="">High number of results. Narrow down your search filters</wsResult>
<soapenv:Envelope xmlns:soapenv = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:jun = "http://juniper.es/">
<soapenv:Header/>
<soapenv:Body>
<jun:getBookings>
<jun:user>username</jun:user>
<jun:password>password</jun:password>
<jun:ExportMode>C</jun:ExportMode>
<jun:IdBooking>55640</jun:IdBooking>
</jun:getBookings>
</soapenv:Body>
</soapenv:Envelope>
Node / Attribute (@) | Opt | Type | Description |
---|---|---|---|
user | N | String | Intranet username |
password | N | String | Intranet user password |
BookingDateFrom | Y | Date | Booking set up date “From”, Format: yyyyMMdd |
BookingDateTo | Y | Date | Booking set up date “To”, Format: yyyyMMdd |
BookingTimeFrom | Y | Time | Booking creation hour “from”, Format: HH:mm:ss |
BookingTimeTo | Y | Time | Booking creation hour “to”, Format: HH:mm:ss |
BeginTravelDate | Y | Date | Booking travel start date. It agrees on the initial date of the first service booked, Format: yyyyMMdd |
EndTravelDate | Y | Date | Booking travel end date. It agrees on the final date of the last service booked, Format: yyyyMMdd |
LastModifiedDateFrom | Y | Date | Booking last modification date “From”. It searches all the bookings which modification date is later than the specified date, Format: yyyyMMdd |
LastModifiedDateTo | Y | Date | Booking last modification date “To”. It searches all the bookings which modification date is previous than the specified date. , Format: yyyyMMdd |
LastModifiedTimeFrom | Y | Time | Initial modification last hour. Search all bookings which modification hour is the same or higher than the specified hour, Format: HH:mm:ss |
LastModifiedTimeTo | Y | Time | Final modification last hour. Search all bookings which modification hour is the same or lower than the specified hour, Format: HH:mm:ss |
BookingCode | Y | String | Code that identifies the booking (for example: 1QP1S2). |
Status | Y | String | Booking status. Possible values: • OK: Confirmed and paid • RQ: On request • Con: Confirmed • Can: Cancelled • CaC: Cancelled by client • Ini: Initialization • Quo: Quote • Tar: Credit card |
id | Y | Integer | Internal code that identifies the agency/client. |
ExportMode | Y | String | Exporting mode. There are 2 possible values: - C: Checking mode. This mode does not mark the customer as “exported”. - E: Exporting mode. This mode marks the customer as “exported” which means that the next time we export through this method will not export customers marked as “Exported”. |
channel | Y | String | Sales channel. It exports all the bookings, which sales channel is the one specified. |
ModuleType | Y | String | Filters the exported bookings to only include those that match the specified module type/s. It is possible to request multiple module types at the same time by separating them by commas. These module types will depend on the available product types from your system (for example: 'Alojamiento'), contact with your project manager if you would like for a list of all of the available module types of your system. |
IdBooking | Y | Integer | Internal code that identifies the booking (for example: 779). It is the primary key that identifies this booking in the table of bookings of the system. It is usually for internal use. |
AgencyRef | Y | String | Filter that lets you search for bookings that match with the requested agency reference (it will only return bookings that exactly match). |
BeginTravelDateFrom | Y | Date | Begin travel date “From”. It searches all the bookings which Start date is same or later than the specified date, Format: yyyyMMdd |
BeginTravelDateTo | Y | Date | Begin travel date “To”. It searches all the bookings which Start date is same or earlier than the specified date, Format: yyyyMMdd |
EndTravelDateFrom | Y | Date | End travel date “From”. It searches all the bookings which End date is same or later than the specified date, Format: yyyyMMdd |
EndTravelDateTo | Y | Date | End travel date “To”. It searches all the bookings which Start date is same or earlier than the specified date, Format: yyyyMMdd |
PackageBookings | Y | String | Package bookings. Possible values: • All: All bookings are returned • Include: Only package bookings are returned • Exclude: Package bookings are excluded |
BlockedBookings | Y | String | Blocked bookings. Possible values: • All: All bookings are returned • Include: Only blocked bookings are returned • Exclude: Blocked bookings are excluded |
<soap:Envelope xmlns:soap = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
<soap:Body>
<getBookingsResponse xmlns = "http://juniper.es/">
<getBookingsResult>
<wsResult xmlns = "">
<Bookings>
<Booking Id = "55640" Status = "OK" CancelDate = "" tcNumber = "" tcAccountNumber = "" tcPointsAmount = "" BookingLabel = "" InvoiceFinalCustomer = "False" BookingDate = "2018-08-20T06:21:29" TimeLimit = "" BookingCode = "11N331" Channel = "Xml3" LastModifiedDate = "2018-08-20T11:29:35" AgencyRef = "" FinalCustomerId = "" timeZone = "02:00">
<Customer Id = "846">
<codcli/>
<Name>Test XML Paco</Name>
<Phone1/>
<Phone2/>
<Mobile/>
<Fax/>
<Email>paco@noreply.com</Email>
<Address/>
<AddressNumber/>
<AddressBuilding/>
<BranchOffice>False</BranchOffice>
<Country/>
<CIF/>
<City ZIP = ""/>
<ClientAccount>WS24/05/2019 6:13:07</ClientAccount>
</Customer>
<Agent id = "253">
<Name>XML Agent</Name>
<Email>paco@noreply.com</Email>
<EmailAgent>paco@noreply.com</EmailAgent>
<TaxID/>
</Agent>
<SellingPrice>96.46</SellingPrice>
<Description>Armadams Hotel - Demo (20/11/2018 - 21/11/2018)</Description>
<Cost>91.64</Cost>
<Commission>0.00</Commission>
<OutStandingAmount>0.00</OutStandingAmount>
<TPVTransaction>
<IdTransaction>4537SOPNZGEV</IdTransaction>
<PaymentType CreditCardType = "">C.Card</PaymentType>
</TPVTransaction>
<Invoiced>N</Invoiced>
<Remarks/>
<InRemarks/>
<FinancialNotes/>
<Holder>
<NameHolder>Holder Name</NameHolder>
<LastName>Holder LastName</LastName>
<City ZIP = ""/>
<Country/>
<Address/>
<Phone1/>
<Phone2/>
<Phone3/>
<Fax/>
<Email/>
<Idioma>en</Idioma>
<TipoDocumento/>
<Dni/>
<Nacionalidad ISO2 = "TR">TURKEY</Nacionalidad>
</Holder>
<BookingAdmin Id = "">
<NameAdmin/>
</BookingAdmin>
<AccountManager Id = "">
<Name/>
</AccountManager>
<Lines>
<Line IdBookLine = "62986" Status = "OK" LineDate = "2018-08-20T06:21:29" LineCancelled = "False" LineCancelledDate = "" LineMarkup = "5.00" Externalreference = "162289899" ExternalClientBookingNo = "" DirectPayment = "False" PaymentAtDestination = "False" NumPackage = "" NonRefundable = "False" LineCancellationChargesDate = "2018-11-17T00:00:00">
<RelatedBookingLine id = ""/>
<ServiceName>Armadams Hotel - Demo</ServiceName>
<ProductType>TG8</ProductType>
<ProductTypeName>H2H - Tourico</ProductTypeName>
<ProductGroup>80</ProductGroup>
<ProductCodExport>7</ProductCodExport>
<ProductGroupAnalyticCode>8</ProductGroupAnalyticCode>
<DepartmentGroup>14</DepartmentGroup>
<DepartmentGroupAnalyticCode>34fsdf</DepartmentGroupAnalyticCode>
<Market>8</Market>
<AgencyGroupID>35</AgencyGroupID>
<AgencyGroupName>Integradores</AgencyGroupName>
<Integrator IntegratorId = "12" UniqueIntegratorId = "1250">
<Name>Cangooroo - T4W</Name>
</Integrator>
<ProductGroupName>Juniper</ProductGroupName>
<Productid>5918</Productid>
<Supplier Id = "60">
<SupplierName>Tourico</SupplierName>
<SupplierCodExport/>
</Supplier>
<SellingPrice>96.46</SellingPrice>
<Commission>0.00</Commission>
<PerCommission>0.00</PerCommission>
<CostCurrency>EUR</CostCurrency>
<SellCurrency>USD</SellCurrency>
<CostBaseLine>80.12</CostBaseLine>
<CostCancellationFees/>
<NetCostLine>80.12</NetCostLine>
<ComissionAmount>0.00</ComissionAmount>
<ComissionTaxPercent>0.00</ComissionTaxPercent>
<ComissionPercent>0.00</ComissionPercent>
<CommisionTaxAmount>0.00</CommisionTaxAmount>
<Profit>4.82</Profit>
<SerialERP>FCE</SerialERP>
<Remarks/>
<PromotionCode/>
<GuaranteeBreakdown>
<contract Type = "C">
<id/>
<CostGuaranteeAmount>0.00</CostGuaranteeAmount>
<CostAmountToBeInvoiced>80.12</CostAmountToBeInvoiced>
<Extras>80.12</Extras>
</contract>
<contract Type = "S">
<id/>
<SalesGuaranteeAmount>0.00</SalesGuaranteeAmount>
<SalesAmountToBeInvoiced>96.46</SalesAmountToBeInvoiced>
<Extras>96.46</Extras>
</contract>
</GuaranteeBreakdown>
<BasePriceCommission>96.46</BasePriceCommission>
<CustomerCommission>0.00</CustomerCommission>
<BasePriceWithOutTax>96.46</BasePriceWithOutTax>
<BasePrice>96.46</BasePrice>
<CancellationFees/>
<BaseChangeFactor>1.00</BaseChangeFactor>
<CostChangeFactor>1.14</CostChangeFactor>
<Zone Id = "49455">
<description>Son Armadams</description>
<state>Son Armadams</state>
<country>España</country>
</Zone>
<BeginTravelDate>2020-11-20T00:00:00</BeginTravelDate>
<EndTravelDate>2020-11-21T00:00:00</EndTravelDate>
<ExternalSupplierConfirmationNumber>162289899</ExternalSupplierConfirmationNumber>
<ProviderAccount>WS26/02/2020 19:48:43</ProviderAccount>
<PaxNumber>1</PaxNumber>
<NightsNumber>1</NightsNumber>
<FlightDetails/>
<Category>4Est</Category>
<isExtranet>N</isExtranet>
<VirtualCreditCardPayment>False</VirtualCreditCardPayment>
<roomlist>
<room>
<hotelcode>10328</hotelcode>
<namehotel>Armadams Hotel - Demo</namehotel>
<addressline>Marqués de la Cenia 34, 07014, Palma De Mallorca, Spain</addressline>
<JPCode>JP046113</JPCode>
<typeroom>577739</typeroom>
<typeroomname>Standard Flex</typeroomname>
<roomnumber>0</roomnumber>
<priceroom>0.00</priceroom>
<costroom>0.00</costroom>
<boardtype type = "">Room only</boardtype>
<paxes>
<pax>
<name>fdsa</name>
<lastname>asdf</lastname>
<CaducidadDocumento/>
<typepax>Adult</typepax>
</pax>
</paxes>
<contracts/>
</room>
</roomlist>
<HotelRemarks/>
<linebreakdown>
<earlybookings/>
<linebreak id = "0" bookingline = "0">
<servicedesc/>
<pricewithoutcomission>0</pricewithoutcomission>
<commission>0</commission>
<type/>
<name/>
</linebreak>
</linebreakdown>
<PaxConcepts>
<PaxConcept id = "0">
<Concepts>
<Concept Name = "Base" Type = "BAS" SalePrice = "96,4600" CostPrice = "80,1200" PaxType = "" PriceIncluded = "False" Complain = "False"/>
</Concepts>
</PaxConcept>
</PaxConcepts>
<CostTaxes>
<Tax Id = "0" PriceIncluded = "False" Fixed = "False">
<Name/>
<type/>
<totaltax>0</totaltax>
<totalcost>0</totalcost>
<apply>0</apply>
</Tax>
</CostTaxes>
<Paxes>
<Pax Id = "639095">
<Name>fdsa</Name>
<LastName>asdf</LastName>
<TipPax>0</TipPax>
<Age>30</Age>
<Born/>
<City ZIP = "0"/>
<Country/>
<TipoDocumento/>
<NumeroDocumento/>
<CaducidadDocumento/>
<Email/>
<ReferenceNumber/>
</Pax>
</Paxes>
<CancellationPolicy CurrencyCode = "USD">
<FirstDayCostCancellation Hour = "14:49">2018-06-13</FirstDayCostCancellation>
<Description><![CDATA[ No reembolsable ]]></Description>
<PolicyRules>
<Rule From = "0" DateFrom = "2020-10-25" DateFromHour = "00:00" Type = "R" FixedPrice = "0" PercentPrice = "100" Nights = "0" ApplicationTypeNights = "Average"/>
</PolicyRules>
</CancellationPolicy>
<CancellationPolicyCost CurrencyCode = "USD">
<FirstDayCostCancellation Hour = "00:00">2018-10-25</FirstDayCostCancellation>
<Description><![CDATA[ No reembolsable ]]></Description>
<PolicyRules>
<Rule From = "0" DateFrom = "2020-10-25" DateFromHour = "00:00" Type = "R" FixedPrice = "0" PercentPrice = "100" Nights = "0" ApplicationTypeNights = "Average"/>
</PolicyRules>
</CancellationPolicyCost>
</Line>
</Lines>
</Booking>
</Bookings>
</wsResult>
</getBookingsResult>
</getBookingsResponse>
</soap:Body>
</soap:Envelope>
Node / Attribute (@) | Type | Description |
---|---|---|
Bookings | - | Bookings container. |
./Bookings/Booking | - | Booking container. |
./Booking/@Id | Numeric | Unique booking identifier. |
./Booking/@Status | String(3) | Booking status. Possible values: • OK: Confirmed and paid • RQ: On request • Con: Confirmed • Can: Cancelled • CaC: Cancelled by client • Ini: Initialization • Quo: Quote • Tar: Credit card |
./Booking/@CancelDate | DateTime | In case the booking is cancelled this is the cancellation date. |
./Booking/@tcNumber | String | Partner number. |
./Booking/@tcAccountNumber | String | Partner account number. |
./Booking/@tcPointsAmount | Numeric | Partner points number. |
./Booking/@BookingLabel | String | Booking label. |
./Booking/@InvoiceFinalCustomer | Boolean | Show holder info on invoice. |
./Booking/@BookingDate | DateTime | Booking set up date. |
./Booking/@TimeLimit | DateTime | Booking expiry date. |
./Booking/@BookingCode | String(7) | Booking code. |
./Booking/@Channel | String(4) | Bookin sales channel. |
./Booking/@LastModifiedDate | Date | Las modified date. |
./Booking/@AgencyRef | String | Agency reference number. |
./Booking/@FinalCustomerId | String | Booking final customer idenfifier. |
./Booking/@timeZone | String | TimeZone of the system and on which the dates of the booking are being supplied. |
./Booking/Customer | - | Customer information. |
./Customer/@Id | Numeric | Unique customer identifier. |
./Customer/CodCli | String | - |
./Customer/Name | String(100) | Customer name. |
./Customer/Phone1 | String(50) | Telephone number 1. |
./Customer/Phone2 | String(50) | Telephone number 2. |
./Customer/Mobile | String(50) | Mobile number. |
./Customer/Fax | String(50) | Fax number. |
./Customer/Email | String(100) | Customer email. |
./Customer/Address | String(75) | Address. |
./Customer/AddressNumber | String(75) | Address number. |
./Customer/AddressBuilding | String(75) | Address building. |
./Customer/BranchOffice | Boolean | Indicates if it is a branch office. |
./BranchOffice/@HeadOfficeId | Numeric | If it is a branch office, indicates the id of the central office. |
./BranchOffice/@OwnInvoice | Boolean | If it is a branch office, indicates if it performs invoices directly (otherwise, it will be performed at the head office). |
./Customer/Country | String(50) | Country. |
./Customer/CIF | String(50) | Tax registration number related to the customer. |
./Customer/City | String(50) | City. |
./City/ZIP | String(50) | Postal code / ZIP code. |
./Customer/ClientAccount | String(100) | Reference number. |
./Customer/InvoicingDetails | - | invoicing information. |
./InvoicingDetails/CompanyName | String(50) | Company name. |
./InvoicingDetails/Address | String(100) | Address. |
./InvoicingDetails/TaxID | String820 | Tax registration number. |
./InvoicingDetails/Email | String(75) | Email. |
./Booking/RepAgency | String(100) | Referred agency. Only for bookings made by guide type clients. |
./RepAgency/@Id | Numeric | Internal identificatory of the referred agency. |
./Booking/Agent | - | Agent information. |
./Agent/@id | Numeric | Agent internal id. |
./Agent/Name | String(100) | Agent name. |
./Agent/Email | String(100) | Agent email. |
./Agent/TaxID | String(100) | Agent CIF/CPF |
./Booking/SellingPrice | Numeric | Booking price. |
./Booking/Description | String(250) | Booking description. |
./Booking/Cost | Numeric | Booking cost. |
./Booking/Commission | Numeric | Booking commission. |
./Booking/OutStandingAmount | Numeric | Charge pending amount. |
./Booking/TPVTransaction | - | POS Transaction information. |
./TPVTransaction/IdTransaction | String(12) | Transaction code. |
./TPVTransaction/PaymentType | String(150) | Payment type. Possible values: • Credit Card • Pre-Payment • Credit |
./PaymentType/@CreditCardType | String(150) | Credit Card type. (Payment type). |
./Booking/Invoiced | String(1) | Invoiced. |
./Booking/Remarks | String(1000) | Booking remarks. |
./Booking/InRemarks | String(1000) | Booking internal remarks. |
./Booking/FinancialNotes | String(1000) | Accounting notes. |
./Booking/Holder | - | Holder information. |
./Holder/NameHolder | String(50) | Booking holder name. |
./Holder/LastName | String(50) | Booking holder last name. |
./Holder/City | String(50) | City. |
./City/@ZIP | String(10) | Postal code / ZIP code. |
./Holder/Country | String(50) | Country, this is a free-text field that is usually completed by the holder itself. |
./Country/@Id | Numeric | Country id, optional field that refers to the internal destination id of the country. |
./Holder/State | String(50) | State. |
./State/@Id | Numeric | State id. |
./Holder/Address | String(75) | Address. |
./Holder/Phone1 | String(50) | Telephone 1. |
./Holder/Phone2 | String(50) | Telephone 2. |
./Holder/Phone3 | String(50) | Mobile phone. |
./Holder/Fax | String(50) | Fax. |
./Holder/Email | String(75) | Email. |
./Holder/Idioma | String(2) | Language. |
./Holder/TipoDocumento | String(75) | Type of document. |
./Holder/Dni | String(200) | Number of document. |
./Holder/Nacionalidad | String(75) | Nationality. |
./Nacionalidad/@ISO2 | String(2) | Nationality code. This code follows the ISO 3166-1 alpha-2 standard. |
./Booking/BookingAdmin | - | - |
./BookingAdmin/@Id | Numeric | Intranet user ID. |
./BookingAdmin/NameAdmin | String(100) | Intranet user name. |
./Booking/AccountManager | - | - |
./AccountManager/@Id | Numeric | Account manager id. |
./AccountManager/Name | String(100) | Account manager name. |
./Booking/Lines | - | List of booking lines available within a booking. |
./Lines/Line | - | Specific booking line. |
./Line/@IdBookLine | Numeric | Unique booking line identifier. |
./Line/@Status | String(2) | Booking line status. Possible values: • OK: Confirmed. • RQ: On request, pending supplier confirmation. • AV: Available, but not confirmed (you may treat this status in the same way as the RQ one). • CA: Canceled. • SO: Sold out (may be treated in the same way as the CA one). • RP: Replaced by another booking (may be treated in the same way as the CA one). |
./Line/@LineDate | DateTime | Booking line creation date. |
./Line/@LineCancelled | Boolean | Specifies whether a booking element has been cancelled or not. |
./Line/@LineCancelledDate | DateTime | Booking line cancellation Date. |
./Line/@LineMarkup | Numeric | Booking line total markup (percentage). |
./Line/@ExternalReference | String(50) | Booking line external reference. |
./Line/@ExternalClientBookingNo | String(100) | Booking line customer external reference. |
./Line/@DirectPayment | Boolean | Direct payment. |
./Line/@PaymentAtDestination | Boolean | Payment at destination. |
./Line/@NumPackage | Numeric Package invoice number. | |
./Line/@NonRefundable | Boolean | Indicates if it is a non refundable line. |
./Line/@LineCancellationChargesDate | DateTime | Date on which the booking line incurs into cancellation charges. This is optional information that may be unavailable. |
./Line/@Blocked | Boolean | Identifies if the line has been blocked by the Juniper client. Blocked booking lines will not be possible to be rebooked. |
./Line/SupplierLocator | String | Identifies the supplier-locator that has been assigned to the booking line during the rebook process. |
./Line/RelatedBookingLine | - | Related booking line identifier. |
./RelatedBookingLine/@id | Numeric | Booking line id. |
./Line/ServiceName | String(250) | Booking element description. |
./Line/ProductType | String(3) | Product type. |
./Line/ProductTypeName | String(100) | Product type name. |
./Line/ProductTypeBreakdown | String(4) | Product type breakdown code. This information is useful on those product types that have multiple product types available within them (like, for example, the JuniperWS connection, as the ProductType node will let you know that it is a JuniperWS connection while this node will let you know the specific client to which the booking belongs. |
./Line/ProductTypeBreakdownName | String(100) | Product type breakdown name. |
./Line/GDSRef | String(50) | GDS Flight reference. |
./Line/ProductGroup | Numeric | Product group identifier. |
./Line/ProductCodExport | String | Product group export code. |
./Line/ProductGroupAnalyticCode | String(50) | Analytic code of the product group. |
./Line/DepartmentGroup | Numeric | Id of the department. |
./Line/DepartmentGroupAnalyticCode | String(10) | Analytic code of the department. |
./Line/Market | Numeric | Market identifier. |
./Line/AgencyGroupID | Numeric | Agency group identifier. |
./Line/AgencyGroupName | String(50) | Agency group name. |
./Line/Integrator | - | Integrator that partake in the reservation. |
./Integrator/@IntegratorId | Numeric | Internal identifier of the integrator. |
./Integrator/@UniqueIntegratorId | Numeric | Unique identifier of the integrator, if available. |
./Integrator/Name | String(50) | Integrator name. |
./Line/ProductGroupName | String(50) | Product group name. |
./Line/ProductId | Numeric | Product identifier. |
./Line/SaleCompany | - | Sale company information. Only availabñe on a specific configuration. |
./SaleCompany/@Id | Numeric | Sale company identifier. |
./SaleCompany/@CodExt | String | Sale company external code. |
./SaleCompany/Name | String | Sale company name. |
./SaleCompany/Country | String | Sale company country name. |
./Country/@ISO | String(2) | Country ISO2 code. |
./Line/PurchasingCompany | - | Purchasing company information. Only available on a specific configuration. |
./PurchasingCompany/@Id | Numeric | Sale company identifier. |
./PurchasingCompany/@CodExt | String | Sale company external code. |
./PurchasingCompany/@CodExt | String | Sale company external code. |
./PurchasingCompany/Country | String | Sale company country name. |
./PurchasingCompany/@ISO | String(2) | Country ISO2 code. |
./Line/EMDReference | String(50) | EMD reference code. |
./Line/Supplier | - | Supplier information. |
./Supplier/@Id | Numeric | Booking element supplier identifier. |
./Supplier/SupplierName | String(250) | Suplier name. |
./Supplier/SupplierCodExport | String | Suplier export code. |
./Line/SellingPrice | Numeric | Booking element price. |
./Line/Commission | Numeric | Booking element commission amount. |
./Line/PerCommission | Numeric | Commission percentage. |
./Line/CostCurrency | String(3) | Cost currency. |
./Line/SellCurrency | String(3) | Sales currency. |
./Line/CostBaseLine | Numeric | Cost base price. |
./Line/TaxCostNotIncluded | Numeric | Tax cost not included price. |
./Line/CostCancellationFees | Numeric | Cost cancellation fees. |
./Line/NetCostLine | Numeric | Cost net price. |
./Line/ComissionAmount | Numeric | Commission amount. |
./Line/ComissionTaxPercent | Numeric | Tax commission percentage. |
./Line/ComissionPercent | Numeric | Commission percentage. |
./Line/CommisionTaxAmount | Numeric | Tax commission amount. |
./Line/IndirectCommissionPercent | Numeric | Percentage of indirect comission applied. |
./Line/IndirectCommissionFix | Numeric | Fixed amount of indirect comission applied. |
./Line/IndirectCommissionAmount | Numeric | Total amount of indirect comission applied. |
./Line/IndirectCommissionSettled | Numeric | Settled amount of indirect comission applied. |
./Line/Profit | Numeric | Booking line profit. |
./Line/ProfitTaxtNotIncluded | Numeric | Booking line profit without taxes included. |
./Line/SerialERP | String(3) | Accouting number. |
./Line/Remarks | String(8000) | Booking element remarks. |
./Line/PromotionCode | String | Promotional code that applies to this booking line. |
./Line/GuaranteeBreakdown | - | Guarantee breakdown. |
./GuaranteeBreakdown/contract | - | Contract information. |
./contract/@Type | Enum | Indicates if it is a cost or sales contract. If unavailable, it will stand for the cost contract. Possible values • C • S |
./contract/id | Numeric | Id contract. |
./contract/CostGuaranteeAmount | Numeric | Guarantee cost amount. |
./contract/CostAmountToBeInvoiced | Numeric | Invoice amount. |
./contract/Extras | Numeric | Extras. |
./Line/BasePriceCommission | Numeric | Commissionable price. |
./Line/CustomerCommission | Numeric | Individual customer commission. |
./Line/BasePriceWithOutTax | Numeric | Base price without taxes. |
./Line/BasePrice | Numeric | Base price. |
./Line/TaxPriceNotIncluded | Numeric | Tax not included price. |
./Line/CancellationFees | Numeric | Cancellation charges. |
./Line/BaseChangeFactor | Numeric | Exchange factor in between the base currency (the main currency of the sales channel) and the actual sales currency of the reservation (for those cases on which a different sales currency is forced). |
./Line/CostChangeFactor | Numeric | Exchange factor in between the sales currency and the cost currency. |
./Line/RepCommission | - | Commission of the referred agency. Only forr bookings made by guide type clients. |
./RepCommission/@Percent | Numeric | Commission percent. |
./RepCommission/@Amount | Numeric | Commission amount. |
./Line/DiscountPercent | Numeric | Percentage of discount applied. |
./Line/Zone | - | - |
./Zone/@Id | Numeric | Area identifier. |
./Zone/Description | String(50) | Area name. |
./Zone/Country | Stirng(50) | Country which the area belongs to. |
./Zone/State | String | State. |
./Line/BeginTravelDate | DateTime | Travel start date. |
./Line/EndTravelDate | DateTime | Travel end date. |
./Line/ExternalSupplierConfirmationNumber | - | - |
./Line/ProviderAccount | String(25) | Supplier bank account. |
./Line/PaxNumber | Numeric | PAX number. |
./Line/NightsNumber | Numeric | Number of nights |
./Line/FlightDetails | - | FlightDetails item |
./FlightDetails/Outbound | - | Outbound item |
./Outbound/@Airport | String(250) | Arrival and departure airport. |
./Outbound/@Date | Date | Flight date |
./Outbound/@Flight | String(250) | Flight No. |
./FlightDetails/Return | - | Return item |
./Return/@Airport | String(250) | Arrival and departure airport. |
./Return/@Date | Date | Flight date |
./Return/@Flight | String(250) | Flight No. |
./Line/RentaCarInfo | - | RentaCar information. Available only on rentacar products. |
./RentaCarInfo/PickUpDate | DateTime | PickUp date of the rentacar. |
./RentaCarInfo/DropOffDate | DateTime | DropOff date of the rentacar. |
./Line/RentaCarOffices | - | RentACar offices |
./RentaCarOffices/OfficeInformations | - | List Office information |
./OfficeInformations/OfficeInformation | - | List Office information |
./OfficeInformation/Name | String (100) | Office name |
./OfficeInformation/Address | String (100) | Office address |
./OfficeInformation/Area | String (100) | Office Area |
./OfficeInformation/Telephone | String(100) | Office telephone No. |
./OfficeInformation/Type | String(100) | Office type |
./OfficeInformation/Class | String(100) | Office class |
./OfficeInformation/Pickup | Boolean | Inficates if it is a pick-up office or not. |
./OfficeInformation/Remarks | String(100) | Office Remarks Office Remarks |
./RentaCarOffices/OfficeInformationUsers | - | List Office information users |
./OfficeInformationUsers/OfficeInformation | - | Office information user |
./OfficeInformation/Name | String(500) | Name of item |
./OfficeInformation/Value | String(500) | Value of item |
./RentaCarOffices/OfficeInformationSupplements | - | List Office information supplements |
./OfficeInformationSupplements/OfficeInformationSupplement | - | Office information supplement |
./OfficeInformationSupplement/Name | String (100) | Name of supplement |
./OfficeInformationSupplement/Quantity | Numeric | Quantity of supplement |
./OfficeInformationSupplement/Price | Numeric | Price of supplement |
./OfficeInformationSupplement/Currency | String | Currency of supplement |
./OfficeInformationSupplement/Paid | Boolean | Paid of supplement |
./Line/Category | String(20) | Category name. Available on hotel products. |
./Line/isExtranet | String(1) | Is an extranet reservation. Available on hotel products. |
./Line/VirtualCreditCardPayment | Boolean | Reservation has a virtual credit card payment. Available on hotel products. |
./Line/roomlist | - | Room list information. Available on hotel proudcts. |
./roomlist/room | - | Specific room information |
./room/hotelcode | String | Hotel code. If the hotel is from an external supplier, the code will refer to the same. |
./room/namehotel | String | Hotel name. |
./room/addressline | String | Hotel address. |
./room/JPCode | String | Juniper hotel code. |
./room/idHotel | Numeric | Hotel internal code. Only for directly contracted hotels. |
./room/JRCode | String | Juniper room code. Optional information that may not be available. |
./room/confirmationreference | String | Property reference, also known as the hotel confirmation number (may be referred as "HCN" or "HotelConfirmationNumber"). |
./room/typeroom | Numeric | Room type |
./room/typeroomname | String(50) | Room type name |
./room/roomnumber | Numeric | Room number (as in to represent the order between rooms: 1 -> 2 -> 3, etc...). If unavailable, all rooms will have 0 in this value. |
./room/priceroom | Numeric | Room price |
./room/costroom | Numeric | Room cost |
./room/boardtype | Strign(50) | Board type |
./boardtype/@type | Strign(2) | Board type generic code. |
./room/paxes | - | PAX list |
./paxes/pax | - | PAX Item |
./pax/name | String(50) | Passenger name |
./pax/lastname | String(50) | Passenger last name |
./pax/CaducidadDocumento | String(50) | Passenger passport expiry date. |
./pax/typepax | String(50) | Passenger type |
./room/contracts | - | List of contracts |
./contracts/contract | - | Contract item |
./contract/@id | Numeric | Contract identifier |
./contract/@issalescontract | Boolean | Inficates if it is a sales contract or not. |
./contract/@type | String | Contract type. Possible values: • FIT • PRO • GTD • RCK |
./contract/name | String | Contract name |
./contract/days | - | List of days |
./days/day | Numeric | Day item |
./contract/channelmanagers | - | List of channel managers that have access to this contract, if any. |
./channelmanagers/channelmanager | String | Channel manager name. |
./channelmanager/@id | Numeric | Internal id of the channel manager of the Juniper client system. |
./channelmanager/@uniqueintegratorid | Numeric | Internal id of the channel manager on all of Juniper (this value may be unavailable if the relationship has not been configured). |
./Line/HotelInfo | - | Hotel related information. |
./HotelInfo/AdditionalElements | - | Additional elements of the hotel reservation. |
./AdditionalElements/Supplements | - | List of supplements. |
./Supplements/Supplement | - | Specific supplement. |
./Supplement/@Currency | String | Currency code. |
./Supplement/@Amount | Numeric | Amount value. |
./Supplement/Name | String | Supplement name. |
./Supplement/Description | String | Supplement description. |
./AdditionalElements/Offers | - | List of offers. |
./Offers/Offer | - | Specific offer. |
./Offer/@Currency | String | Currency code. |
./Offer/@Amount | Numeric | Amount value. |
./Offer/Name | String | Supplement name. |
./Offer/Description | String | Supplement description. |
./Line/HotelRemarks | String | Comments from the hotel and/or supplier. Available on hotel products. |
./Line/ServiceInfo | - | Information related to the service of the booking. |
./ServiceInfo/Service | - | Service item. |
./Service/@Id | Numeric | Service internal identifier. |
./Service/@Direction | String | Service direction, for InOut transfers. Possible values: • IN • OUT |
./Service/ServiceName | String(300) | Service name |
./Service/ServiceType | - | Service type |
./ServiceType/@Id | String | Service type id. Possible values: • Ticket • Transfer |
./Service/ServiceOptions | - | Service options |
./ServiceOptions/ServiceOption | String(300) | Service option name |
./ServiceOption/@Id | Numeric | Service option identifier |
./Service/Origin | - | Service origin information. |
./Origin/@Code | Numeric | Service origin zone code. |
./Origin/@Type | String(3) | Service origin zone type. |
./Origin/MeetingPointInfo | - | Service origin meeting point information. |
./MeetingPointInfo/@Code | Numeric | Meeting point internal code. |
./MeetingPointInfo/@MeetingTime | DateTime | Meeting time. |
./MeetingPointInfo/Name | String | Meeting point name. |
./MeetingPointInfo/Geolocation | - | Meeting point geolocation. |
./Geolocation/@Latitude | - | Meeting point latitude. |
./Geolocation/@Longitude | - | Meeting point longitude. |
./Service/Destination | - | Service destination information. |
./Destination/@Code | Numeric | Service destination zone code. |
./Destination/@Type | String(3) | Service destination zone type. |
./Destination/MeetingPointInfo | - | Service destination meeting point information. |
./MeetingPointInfo/@Code | Numeric | Meeting point internal code. |
./MeetingPointInfo/@MeetingTime | DateTime | Meeting time. |
./MeetingPointInfo/Name | String | Meeting point name. |
./MeetingPointInfo/Geolocation | - | Meeting point geolocation. |
./Geolocation/@Latitude | - | Meeting point latitude. |
./Geolocation/@Longitude | - | Meeting point longitude. |
./Line/linebreakdown | - | Element breakdown Item |
./linebreakdown/linebreak | - | Line brekdown |
./linebreak/@id | Numeric | Service Identifier |
./linebreak/@bookingline | Numeric | Booking element identifier |
./linebreak/servicedesc | String(250) | Service description |
./linebreak/pricewithoutcomission | Numeric | Price without commission |
./linebreak/commission | Numeric | Commission amount |
./linebreak/type | Numeric | Service type |
./linebreak/name | String(50) | Service name |
./linebreakdown/earlybookings | - | Early booking information. BLANK/NOT IMPLEMENTED |
./Line/PaxConcepts | - | List of concepts grouped by passenger |
./PaxConcepts/PaxConcept | - | Passenger concept |
./PaxConcept/@id | Integer | Id of the passenger concept |
./PaxConcept/Concepts | - | List of concepts |
./Concepts/Concept | - | Specific concept |
./Concept/@Name | String | Name of the concept |
./Concept/@Type | String | Type of the concept. Possible values: • BAS: Base • SUP: Supplement • OFE: Offer • HFE: Handling fee • TAS: Tax • PRO: Promotion • DTO: Discount • UNK: Unknown |
./Concept/@SalePrice | Decimal | Sales price of the concept |
./Concept/@CostPrice | Decimal | Cost price of the concept |
./Concept/@PaxType | String | Passenger type of the concept |
./Concept/@PriceIncluded | Boolean | PriceIncluded of the concept |
./Concept/@Complain | Boolean | Concept is complain |
./Line/FlightInfo | - | FlightInfo container |
./FlightInfo/FightNumber | String(100) | Flight numbers |
./FlightInfo/FightInssued | String(1) | Issued ticket |
./FlightInfo/FightClass | String(50) | Flight class |
./FlightInfo/FightRessidentDiscount | String(1) | Resident discount |
./FlightInfo/FightCodeOperateCompany | String(50) | Company that operates the flight |
./FlightInfo/FightJourney | String(50) | Origin and destination separately since the flights currently arrive as in Route mode. |
./FlightInfo/FareBasis | String(90) | Rate codes of all the flight legs. |
./FlightInfo/FlightSegments | - | FlightSegments container |
./FlightSegments/FlightSegment | - | FlightSegment container |
./FlightSegment/Origin | String(3) | Origin of the flight leg |
./FlightSegment/Destination | String(3) | Destination of the flight leg |
./FlightSegment/Departure | DateTime | Date and hour of the departure flight leg |
./FlightSegment/Arrival | DateTime | Date and hour of the arrival flight leg. |
./FlightSegment/FlightNum | String(50) | Company and flight leg number. |
./FlightSegment/FlightCabin | String(2) | Cabin of the seat. |
./Line/detailsCrew | DetailsCrew container | |
./detailsCrew/CabineNumber | String(100) | Cabin number |
./detailsCrew/Class | String(100) | Cabin category |
./detailsCrew/Deck | String(100) | Cockpit |
./detailsCrew/TimeDining | String(100) | Meal on board |
./detailsCrew/SpecialServices | String(100) | Special services |
./Line/CostTaxes | - | List of tax |
./CostTaxes/Tax | - | Tax Item |
./Tax/@Id | Numeric | Tax identifier |
./Tax/@PriceIncluded | Boolean | It indicates whether the taxes are included in the price or not. |
./Tax/@Fixed | Boolean | It indicates whether a tax is a fixed value or not. |
./Tax/name | String(50) | Tax name |
./Tax/type | String(3) | Tax type |
./Tax/total | Numeric | Sales tax amount (if it is fixed, it is the same amount and if it is a percentage, it corresponds to the percentage. |
./Tax/totalcost | Numeric | Cost tax amount |
./Tax/Total sale | Numeric | Total tax amount |
./Tax/Totaltax | Numeric | Node that appear if there is no tax (subject to be discarded) |
./Tax/apply | Numeric | Tax value (percentage or fixed) |
./Line/Paxes | - | List of passengers of the booking line. |
./Paxes/Pax | - | Specific passenger. |
./Pax/@Id | Numeric | Passenger identifier. |
./Pax/Name | String(50) | Passenger name |
./Pax/LastName | String(50) | Passenger last name |
./Pax/GivenName | String | Passenger given name. |
./Pax/MiddleName | String(50) | Passenger middle name. |
./Pax/TipPax | Numeric | Passenger type. 3 values: 0 – Adult, 1 – Child, 2 – Baby |
./Pax/Age | Numeric | Passenger’s age |
./Pax/Born | DateTime | Birth date |
./Pax/City | String(50) | City |
./City/@ZIP | String(10) | Postal code /Zip code |
./Pax/Country | String(50) | Country |
./Pax/TipoDocumento | String | Identification document |
./Pax/NumeroDocumento | Numeric | Document No. |
./Pax/CaducidadDocumento | String(50) | Passenger passport expiry date. |
./Pax/Email | String | Passenger email. |
./Pax/FlightETicket | String(20) | E-Ticket Number |
./Pax/FlightLargeFamily | String(1) | Large family discount |
./Pax/ExpirateDateDoc | String(50) | Passport expiry date |
./Pax/ReferenceNumber | String | Passport reference number. |
./Pax/Loyalty | - | Passenger loyalty information |
./Loyalty/@Reference | String | Passenger loyalty reference |
./Line/DirectPayment | - | Direct payment information. |
./DirectPayment/DPCustomer | String | Direct payment customer. |
./DirectPayment/DPTotal | Numeric | Direct payment total amount. |
./DirectPayment/DPTotalCurrency | String(3) | Direct payment total amount currency. |
./DirectPayment/DPProfit | Numeric | Direct payment profit amount. |
./DirectPayment/DPProfitTax | Numeric | Direct payment profit amount tax. |
./DirectPayment/DPProfitTaxPercent | Numeric | Direct payment profit amount tax percent. |
./DirectPayment/DPProfitCurrency | String(3) | Direct payment profit currency. |
./Line/PaymentAtDestination | - | Payment at destination information. |
./PaymentAtDestination/Total | Numeric | Payment at destination amount. |
./PaymentAtDestination/Currency | String(3) | Payment at destination currency. |
./Line/CreditCard | - | Credit card information. |
./CreditCard/Name | String | Credit card holder name. |
./CreditCard/Surname | String | Credit card holder surname. |
./CreditCard/Number | String | Credit card number. |
./CreditCard/Cvc | String | Credit card verification code. |
./CreditCard/ExpiryDate | String | Credit card expiry date. Format MM/YY |
./CreditCard/CardCode | String | Credit card type code. |
./Line/VirtualCard | - | Virtual credit card. |
./VirtualCard/Number | String | Credit Card Number |
./VirtualCard/Cvc | String | Credit Card CVC code |
./VirtualCard/ExpiryDate | String | Credit Card expiration date |
./VirtualCard/Reference | String | Credit Card supplier reference |
./Line/CancellationPolicy | - | Sales cancellation policy. Not available by default (requires for a permission; contact with Juniper is unavailable), and will only be supplied on requests whose total number of reservations does not exceeds 10 of them. |
./CancellationPolicy/FirstDayCostCancellation | Date | First day cost cancellation date |
./FirstDayCostCancellation/@Hour | Time | First day cost cancellation hour |
./FirstDayCostCancellation/Description | String | Policy description |
./FirstDayCostCancellation/PolicyRules | - | Policy rules |
./PolicyRules/Rule | - | |
./Rule/@From | Numeric | Days from start booking date |
./Rule/@To | Numeric | Days to start booking date |
./Rule/@DateFrom | Date | Date from start booking date |
./Rule/@DateFromHour | Time | Time from start booking date |
./Rule/@DateTo | Date | Date to start booking date |
./Rule/@DateToHour | Time | Time to start booking date |
./Rule/@Type | String(1) | Rule type |
./Rule/@FixedPrice | Decimal | Fixed price |
./Rule/@PercentPrice | Decimal | Percent price |
./Rule/@FirstNightPrice | Decimal | First night price |
./Rule/@MostExpensiveNight | Decimal | Most expensive night price |
./Rule/@Nights | Numeric | Number of Stay lenght fromNights |
./Rule/@StayLengthFrom | Numeric | Stay lenght from |
./Rule/@StayLengthTo | Numeric | Stay length to |
./Rule/@ApplicationTypeNights | String | Rule application type |
./Line/CancellationPolicyCost | - | Cost cancellation policy. Not available by default (requires for a permission; contact with Juniper is unavailable), and will only be supplied on requests whose total number of reservations does not exceeds 10 of them. |
./CancellationPolicyCost/FirstDayCostCancellation | Date | First day cost cancellation date |
./FirstDayCostCancellation/@Hour | Time | First day cost cancellation hour |
./CancellationPolicyCost/Description | String | Policy description |
./CancellationPolicyCost/PolicyRules | - | Policy rules |
./PolicyRules/Rule | - | |
./Rule/@From | Numeric | Days from start booking date |
./Rule/@To | Numeric | Days to start booking date |
./Rule/@DateFrom | Date | Date from start booking date |
./Rule/@DateFromHour | Time | Time from start booking date |
./Rule/@DateTo | Date | Date to start booking date |
./Rule/@DateToHour | Time | Time to start booking date |
./Rule/@Type | String(1) | Rule type |
./Rule/@FixedPrice | Decimal | Fixed price |
./Rule/@PercentPrice | Decimal | Percent price |
./Rule/@FirstNightPrice | Decimal | First night price |
./Rule/@MostExpensiveNight | Decimal | Most expensive night price |
./Rule/@Nights | Numeric | Number of Nights |
./Rule/@StayLengthFrom | Numeric | Stay lenght from |
./Rule/@StayLengthTo | Numeric | Stay length to |
./Rule/@ApplicationTypeNights | String | Rule application type |
./Line/Loyalty | - | Booking loyalty information. |
./Loyalty/@TotalValue | Numeric | Total loyalty points. |
./Loyalty/Reference | String(50) | Loyalty external reference. |
./Loyalty/Concepts | - | Loyalty concept list. |
./Concepts/Concept | - | Specific concept. |
./Concept/@Code | Numeric | Concept identifier. |
./Concept/@PaymentCode | Numeric | Related payment identifier. |
./Concept/@Date | Date | Concept Date. Format: dd/MM/yyyy HH:mm:ss. |
./Concept/Description | String(50) | Loyalty concept description. |
./Concept/Value | Decimal | Loyalty concept value. |
This method allows for documents to be uploaded to a booking.
The request parameters of this method are the following:
<soapenv:Envelope xmlns:soapenv = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:jun = "http://juniper.es/">
<soapenv:Header/>
<soapenv:Body>
<jun:setBookingDocuments>
<jun:user>user</jun:user>
<jun:password>password</jun:password>
<jun:bookingCode>123456</jun:bookingCode>
<jun:urlFile>THE_URL_TO_THE_FILE</jun:urlFile>
<jun:fileType>pdf</jun:fileType>
<jun:descriptionFile>Test pdf upload</jun:descriptionFile>
</jun:setBookingDocuments>
</soapenv:Body>
</soapenv:Envelope>
Node / Attribute (@) | Opt | Type | Description |
---|---|---|---|
user | N | String | Username. |
password | N | String | Password. |
bookingCode | N | Numeric | Booking id (numeric id that represents the reservation, not to confuse it with the locator). |
lineBookingCode | Y | Numeric | Booking line id. |
urlFile | N | String | Url of the file to attach. |
fileType | N | String | File type. |
descriptionFile | N | String | Note/description to add to the attached file. |
The XML returned by this method is the following:
<soap:Envelope xmlns:soap = "http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd = "http://www.w3.org/2001/XMLSchema">
<soap:Body>
<setBookingDocumentsResponse xmlns = "http://juniper.es/">
<setBookingDocumentsResult>
<WsResult xmlns = "">
<BookingsDocument>
<BookingId>123456</BookingId>
<BookingLineId p3:nil = "true" xmlns:p3 = "http://www.w3.org/2001/XMLSchema-instance"/>
<StatusOperation>OK</StatusOperation>
<Note/>
</BookingsDocument>
</WsResult>
</setBookingDocumentsResult>
</setBookingDocumentsResponse>
</soap:Body>
</soap:Envelope>
Node / Attribute (@) | Type | Description |
---|---|---|
BookingId | Numeric | Unique identifier of the booking |
BookingLineId | Numeric | Unique identifier of the booking element |
StatusOperation | String(2) | Action status |
Note | String | Should an error occur, a message will appear |
Through this web service, we will obtain all product groups.
This method returns a list of all product groups. The request parameters of this method are the following:
The XML returned by this method is the following:
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<getProductGroupsResponse xmlns="http://juniper.es/">
<getProductGroupsResult>
<wsResult xmlns="">
<GroupProducts>
<GroupProduct>
<Code>79</Code>
<Name>Grupo producto defecto</Name>
<CommissionDefault>0</CommissionDefault>
<TaxesCommission>0</TaxesCommission>
<ExportSalesCode/>
<ExportPurchaseCode/>
<ExportSalesCodeSpecialRegimen/>
<ExportPurchaseCodeSpecialRegimen/>
<ExportSalesCommissionCode/>
<ExportSalesCommissionIVACode/>
<AlternateExternalCode/>
<AnalyticCode/>
<Observations/>
<CodeDepartment/>
<Department/>
</GroupProduct>
<GroupProduct>
<Code>80</Code>
<Name>Juniper</Name>
<CommissionDefault>0</CommissionDefault>
<TaxesCommission>0</TaxesCommission>
<ExportSalesCode>1</ExportSalesCode>
<ExportPurchaseCode>2</ExportPurchaseCode>
<ExportSalesCodeSpecialRegimen>3</ExportSalesCodeSpecialRegimen>
<ExportPurchaseCodeSpecialRegimen>4</ExportPurchaseCodeSpecialRegimen>
<ExportSalesCommissionCode>5</ExportSalesCommissionCode>
<ExportSalesCommissionIVACode>6</ExportSalesCommissionIVACode>
<AlternateExternalCode>7</AlternateExternalCode>
<AnalyticCode>8</AnalyticCode>
<Observations/>
<CodeDepartment>14</CodeDepartment>
<Department>Juniper</Department>
</GroupProduct>
</GroupProducts>
</wsResult>
</getProductGroupsResult>
</getProductGroupsResponse>
</soap:Body>
</soap:Envelope>
Attribute and node detail:
Node | Type | Description |
---|---|---|
Code | Numeric | Product group unique identifier |
Name | String | Product group name |
CommissionDefault | Numeric | Commission by default |
TaxesCommission | Numeric | Commission VAT by default |
ExportSalesCode | String | Export sales code |
ExportPurchaseCode | String | Purchase export code |
ExportSalesCodeSpecialRegimen | String | Special tax Export Sales code |
ExportPurchaseCodeSpecialRegimen | String | Special tax Export Purchase code |
ExportPurchaseCommissionCode | String | Commission Export Purchase code |
ExportPurchaseVATCommissionCode | String | Commission Export VAT codeString |
AlternateExternalCode | String | Export code |
AnalyticCode | String | Analytic code |
Observations | String | Remarks |
CodeDepartment | Numeric | Department code |
Department | String | Department name |
Through this web service, we will obtain the necessary generic data for different purposes.
This method returns a list of data related with the catalog requested. The request parameters of this method are the following:
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:jun="http://juniper.es/">
<soapenv:Header/>
<soapenv:Body>
<jun:getCatalogueData>
<jun:user>username</jun:user>
<jun:password>password</jun:password>
<jun:catalogueDataRequest>CHANNELS</jun:catalogueDataRequest>
</jun:getCatalogueData>
</soapenv:Body>
</soapenv:Envelope>
Node / Attribute (@) | Opt | Type | Description |
---|---|---|---|
user | N | String | Intranet username |
password | N | String | Intranet user password |
catalogueDataRequest | N | String | Catalog of data to be supplied. Possible values: • ACCOUNTMANAGERS • AGENCYGROUPS • BANKACCOUNTS • CHANNELS • CUSTOMERCATEGORIES • CLIENTMANAGERS • COUNTRIES • CURRENCIES |
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<getCatalogueDataResponse xmlns="http://juniper.es/">
<getCatalogueDataResult>
<wsResult xmlns="">
<CatalogueItems>
<CatalogueItem Id="Web ">
<ItemContentList>
<ItemContent>
<Name>Juniper Demo</Name>
</ItemContent>
</ItemContentList>
</CatalogueItem>
<CatalogueItem Id="Xml ">
<ItemContentList>
<ItemContent>
<Name>WebService</Name>
</ItemContent>
</ItemContentList>
</CatalogueItem>
</CatalogueItems>
</wsResult>
</getCatalogueDataResult>
</getCatalogueDataResponse>
</soap:Body>
</soap:Envelope>
Node / Attribute (@) | Type | Description |
---|---|---|
CatalogueItems | - | Catalogue item list |
./CatalogueItems/CatalogueItem | - | Catalogue item |
./CatalogueItem/@Id | String | Id of the requested item |
./CatalogueItem/ItemContentList | - | Item content list |
./ItemContentList/Name | String | Name/value of the requested item |
In this section you will be able to find a descripition of the certification tests and the additional information that we will ask you in order to verify the correct development of your integration.
Please consider that you will only need to certify the modules that you will be integrating. Kindly notify us which will be these and refer to the below:
On this section you will be able to find all of the tests and queries that we will request you regardless of the modules from the Export API that you will be implementing, allow us to start with the same:
Take into account that, once you export information from the Juniper system along a E
ExportMode, additional changes to whichever registry are not available to download again. This is for registries that may require an update (customers, suppliers) and the best way to update them would be to send a modify request while updating the registry on your side.
On this section you will be able to find all of the tests and queries related to the customer module, this certification must be overtaken if you implemented the use of any of the transactions found within Customer Transactions, we will proceed to detail the same:
On this section you will be able to find all of the tests and queries related to the supplier module, this certification must be overtaken if you implemented the use of any of the transactions found within Supplier Transactions, we will proceed to detail the same:
On this section you will be able to find all of the tests and queries related to the invoice module, this certification must be overtaken if you implemented the use of any of the transactions found within Invoice Transactions, we will proceed to detail the same:
On this section you will be able to find all of the tests and queries related to the booking module, this certification must be overtaken if you implemented the use of any of the transactions found within Booking Transactions, we will proceed to detail the same: