Invoice resource provides information about issued invoices.
Resource | Description |
---|---|
POST /v1/Invoice/Preview | Get a preview of a final invoice for a reservation |
POST /v1/Invoices/Filter | Search for invoices by issue date |
Name | Type | Description |
---|---|---|
id | int | Unique identifier of invoice |
issueDate | date (yyyy-MM-dd) | The date when invoice was issued |
createDate | date (yyyy-MM-ddTHH:mm:sszzz) | Actual date that invoice was created |
Type | int | Integer type value of invoice |
Number | string (30) | The unique number of invoice. |
Counter | object | Contains information about counter: unique identifier - id (int) and title (string(50)) |
Customer | object | Contains information about customer: id (int) - the unique number of customer, FirstName (string (50)) - customer's first name, LastName (string (50)) - customer's last name, TaxId (string(50)) - customer's unique tax number. TaxIdAdditional (string(50)) - customer's additional tax number City (string(50)) - customer's city ZipCode (string(20)) - customer's zipcode Address1 (string(255)) - customer's address Address2 (string(255)) - additional customer's address Country (string(50)) - customer's country Occupation (string(50)) - customer's occupation |
Payments | object | Contains information about payment: id (int) - the unique number of payment, date(yyyy-mm-dd) - date of payment, paymentmethodId - the unique number of payment method (more information about payment method), currencycode (string) - currency of payments, reservatioId - the unique number of reservation |
extraTaxesByPercentage | array | |
taxesByPercentage | array | Information about included taxes |
totalNetValue | decimal (##.##) | ... |
totalExtraTaxes | decimal (##.##) | ... |
totalTaxes | decimal (##.##) | ... |
totalGrossValue | decimal (##.##) | ... |
invoiceLines | array | Array of invoiceLine |
Name | Type | Description |
---|---|---|
amount | decimal (##.##) | Amount of tax |
isIncluded | int | 0 - not included, 1 - included |
percentage | decimal (##.##) | Percentage amount of tax |
title | string (50) | Title of tax |
breakdown | object | title(string) - can be (accommodationpercent, netsubtotal, boardpercent) amount (decimal) |
Value | Description |
---|---|
1 | Invoice |
2 | Receipt |
3 | Payment receipt |
4 | Credit invoice |
5 | Tax receipt |
Value | Description |
---|---|
1 | Accommondation |
2 | Board/Food |
3 | Discounts |
4 | Taxes |
5 | Cancellation fees |
6 | Payment |
7 | Extra charges |
8 | Negative values existing invoices |
Get a preview of a final invoice for a reservation.
Request parameters
Name | Value |
---|---|
reservationId | Reservation Id |
Response
The invoice preview for supplied reservation.
Example Request
<?xml version="1.0" ?> <Invoices> <reservationId>54</reservationId> </Invoices>
{ "reservationId":"54" }
Example Response
<?xml version="1.0"?> <Invoice id="0"> <Type>1</Type> <InvoiceLines id="-1"> <ItemType>1</ItemType> <Quantity>3</Quantity> <NetUnitPrice>100.00</NetUnitPrice> <GrossUnitPrice>115.00</GrossUnitPrice> <GrossSubtotal>345.00</GrossSubtotal> <NetSubtotal>300.00</NetSubtotal> <TaxesByPercentages> <TaxesByPercentage dateFrom="2017-12-31" dateTo="2050-12-30"> <Percentage>2</Percentage> <Amount>6.00</Amount> <Title>MRDT</Title> <TaxType>CanadianMRDTTax</TaxType> <IsIncluded>0</IsIncluded> </TaxesByPercentage> <TaxesByPercentage dateFrom="2017-12-31" dateTo="2050-12-30"> <Percentage>8</Percentage> <Amount>24.00</Amount> <Title>PST</Title> <TaxType>CanadianProvincialSalesTax</TaxType> <IsIncluded>0</IsIncluded> </TaxesByPercentage> <TaxesByPercentage dateFrom="2017-12-31" dateTo="2050-12-30"> <Percentage>5</Percentage> <Amount>15.00</Amount> <Title>GST</Title> <TaxType>CanadianGeneralSalesTax</TaxType> <IsIncluded>0</IsIncluded> </TaxesByPercentage> </TaxesByPercentages> <BookingAgencyReferenceCode /> <NumAdults>2</NumAdults> <NumChildren>0</NumChildren> <Description>Overnight (Room 07)</Description> <ReservationId>54</ReservationId> </InvoiceLines> <InvoiceLines id="-1"> <ItemType>6</ItemType> <Quantity>3</Quantity> <NetUnitPrice>75.0000</NetUnitPrice> <GrossUnitPrice>86.25</GrossUnitPrice> <GrossSubtotal>258.750</GrossSubtotal> <NetSubtotal>225.000</NetSubtotal> <TaxesByPercentages> <TaxesByPercentage dateFrom="2017-12-31" dateTo="2050-12-30"> <Percentage>2</Percentage> <Amount>4.50</Amount> <Title>MRDT</Title> <TaxType>CanadianMRDTTax</TaxType> <IsIncluded>0</IsIncluded> </TaxesByPercentage> <TaxesByPercentage dateFrom="2017-12-31" dateTo="2050-12-30"> <Percentage>8</Percentage> <Amount>18.00</Amount> <Title>PST</Title> <TaxType>CanadianProvincialSalesTax</TaxType> <IsIncluded>0</IsIncluded> </TaxesByPercentage> <TaxesByPercentage dateFrom="2017-12-31" dateTo="2050-12-30"> <Percentage>5</Percentage> <Amount>11.25</Amount> <Title>GST</Title> <TaxType>CanadianGeneralSalesTax</TaxType> <IsIncluded>0</IsIncluded> </TaxesByPercentage> </TaxesByPercentages> <BookingAgencyReferenceCode /> <NumAdults>0</NumAdults> <NumChildren>0</NumChildren> <Description>Extra beds (Room 07)</Description> <ReservationId>54</ReservationId> </InvoiceLines> <InvoiceLines id="-1"> <ItemType>7</ItemType> <Quantity>3.00</Quantity> <NetUnitPrice>4.00</NetUnitPrice> <GrossUnitPrice>4.48</GrossUnitPrice> <GrossSubtotal>13.440</GrossSubtotal> <NetSubtotal>12.000</NetSubtotal> <TaxesByPercentages> <TaxesByPercentage dateFrom="2017-12-31" dateTo="2050-12-30"> <Percentage>7</Percentage> <Amount>0.84</Amount> <Title>PST</Title> <TaxType>CanadianProvincialSalesTax</TaxType> <IsIncluded>0</IsIncluded> </TaxesByPercentage> <TaxesByPercentage dateFrom="2017-12-31" dateTo="2050-12-30"> <Percentage>5</Percentage> <Amount>0.60</Amount> <Title>GST</Title> <TaxType>CanadianGeneralSalesTax</TaxType> <IsIncluded>0</IsIncluded> </TaxesByPercentage> </TaxesByPercentages> <BookingAgencyReferenceCode>5</BookingAgencyReferenceCode> <NumAdults>0</NumAdults> <NumChildren>0</NumChildren> <Description>Car parking</Description> <ReservationId>54</ReservationId> </InvoiceLines> <InvoiceLines id="-1"> <ItemType>7</ItemType> <Quantity>6.00</Quantity> <NetUnitPrice>6.00</NetUnitPrice> <GrossUnitPrice>6.3</GrossUnitPrice> <GrossSubtotal>37.800</GrossSubtotal> <NetSubtotal>36.000</NetSubtotal> <TaxesByPercentages> <TaxesByPercentage dateFrom="2017-12-31" dateTo="2050-12-30"> <Percentage>5</Percentage> <Amount>1.80</Amount> <Title>GST</Title> <TaxType>CanadianGeneralSalesTax</TaxType> <IsIncluded>0</IsIncluded> </TaxesByPercentage> </TaxesByPercentages> <BookingAgencyReferenceCode>34</BookingAgencyReferenceCode> <NumAdults>0</NumAdults> <NumChildren>0</NumChildren> <Description>Daily pastry + coffee</Description> <ReservationId>54</ReservationId> </InvoiceLines> <IssueDate>0001-01-01</IssueDate> <CurrencyCode>CAD</CurrencyCode> <Number>H17/2562</Number> <Customer id="6"> <LastName>Doe</LastName> <FirstName>John</FirstName> <TaxId /> <TaxIdAdditional>AV9916563</TaxIdAdditional> <City>AV9916563</City> <ZipCode>AV9916563</ZipCode> <Address1>AV9916563</Address1> <Address2>AV9916563</Address2> <Country>AV9916563</Country> <Occupation>AV9916563</Occupation> <Categories /> </Customer> <TotalNetValue>573.000</TotalNetValue> <TotalExtraTaxes>0</TotalExtraTaxes> <TotalTaxes>81.99</TotalTaxes> <TotalGrossValue>654.99</TotalGrossValue> <TotalGrossValueBeforeExtraTaxes>654.99</TotalGrossValueBeforeExtraTaxes> <LanguageCode>en</LanguageCode> </Invoice>
{ "id": 0, "type": 1, "number": null, "invoiceLines": [ { "id": -1, "itemType": 1, "quantity": 3, "netUnitPrice": 100, "grossUnitPrice": 115, "grossSubtotal": 345, "netSubtotal": 300, "taxesByPercentage": [ { "percentage": 2, "amount": 6, "title": "MRDT", "taxType": "CanadianMRDTTax", "isIncluded": 0, "dateFrom": "2017-12-31", "dateTo": "2050-12-30" }, { "percentage": 8, "amount": 24, "title": "PST", "taxType": "CanadianProvincialSalesTax", "isIncluded": 0, "dateFrom": "2017-12-31", "dateTo": "2050-12-30" }, { "percentage": 5, "amount": 15, "title": "GST", "taxType": "CanadianGeneralSalesTax", "isIncluded": 0, "dateFrom": "2017-12-31", "dateTo": "2050-12-30" } ], "bookingAgencyReferenceCode": "", "numAdults": 2, "numChildren": 0, "description": "Overnight (Room 07)", "reservationId": 54 }, { "id": -1, "itemType": 6, "quantity": 3, "netUnitPrice": 75, "grossUnitPrice": 86.25, "grossSubtotal": 258.75, "netSubtotal": 225, "taxesByPercentage": [ { "percentage": 2, "amount": 4.5, "title": "MRDT", "taxType": "CanadianMRDTTax", "isIncluded": 0, "dateFrom": "2017-12-31", "dateTo": "2050-12-30" }, { "percentage": 8, "amount": 18, "title": "PST", "taxType": "CanadianProvincialSalesTax", "isIncluded": 0, "dateFrom": "2017-12-31", "dateTo": "2050-12-30" }, { "percentage": 5, "amount": 11.25, "title": "GST", "taxType": "CanadianGeneralSalesTax", "isIncluded": 0, "dateFrom": "2017-12-31", "dateTo": "2050-12-30" } ], "bookingAgencyReferenceCode": "", "numAdults": 0, "numChildren": 0, "description": "Extra beds (Room 07)", "reservationId": 54 }, { "id": -1, "itemType": 7, "quantity": 3, "netUnitPrice": 4, "grossUnitPrice": 4.48, "grossSubtotal": 13.44, "netSubtotal": 12, "taxesByPercentage": [ { "percentage": 7, "amount": 0.84, "title": "PST", "taxType": "CanadianProvincialSalesTax", "isIncluded": 0, "dateFrom": "2017-12-31", "dateTo": "2050-12-30" }, { "percentage": 5, "amount": 0.6, "title": "GST", "taxType": "CanadianGeneralSalesTax", "isIncluded": 0, "dateFrom": "2017-12-31", "dateTo": "2050-12-30" } ], "bookingAgencyReferenceCode": "5", "numAdults": 0, "numChildren": 0, "description": "Car parking", "reservationId": 54 }, { "id": -1, "number": "H17/2562", "itemType": 7, "quantity": 6, "netUnitPrice": 6, "grossUnitPrice": 6.3, "grossSubtotal": 37.8, "netSubtotal": 36, "taxesByPercentage": [ { "percentage": 5, "amount": 1.8, "title": "GST", "taxType": "CanadianGeneralSalesTax", "isIncluded": 0, "dateFrom": "2017-12-31", "dateTo": "2050-12-30" } ], "bookingAgencyReferenceCode": "34", "numAdults": 0, "numChildren": 0, "description": "Daily pastry + coffee", "reservationId": 54 } ], "issueDate": "0001-01-01", "currencyCode": "CAD", "customer": { "id": 6, "lastName": "Doe", "firstName": "John", "taxId": "", "taxIdAdditional":"", "city":"Athens", "zipCode":"56447", "Address1": "Inglaterra 30", "Address2": "C/ Henan Cortes 63", "Country": "Spain", "Occupation": "Sales Manager" "categories": [] }, "extraTaxBreakdown": null, "taxBreakdown": null, "totalNetValue": 573, "totalExtraTaxes": 0, "totalTaxes": 81.99, "totalGrossValue": 654.99, "totalGrossValueBeforeExtraTaxes": 654.99, "languageCode": "en", "notes": null }
Search for invoices by issue date.
Request parameters
Name | Value |
---|---|
dateFrom | Starting date |
dateTo | Ending date |
Response
The invoices that fill all of the criteria/filters.
Example Request
<?xml version="1.0" ?> <Invoices> <dateFrom>2017-12-11</dateFrom> <dateTo>2017-12-11</dateTo> </Invoices>
{ "dateFrom":"2017-12-11", "dateTo":"2017-12-11" }
Example Response
<?xml version="1.0"?> <Invoices> <Invoice id="1361"> <IssueDate>2017-12-11</IssueDate> <CreateDate>2017-12-11T11:22:48+01:00</CreateDate> <Number>2562</Number> <Type>1</Type> <Counter id="1">Contador Botanico</Counter> <Customer id="3669"> <LastName>Chiodi</LastName> <FirstName>Tiziana</FirstName> <TaxId>AV9916563</TaxId> <TaxIdAdditional>AV9916563</TaxIdAdditional> <City>AV9916563</City> <ZipCode>AV9916563</ZipCode> <Address1>AV9916563</Address1> <Address2>AV9916563</Address2> <Country>AV9916563</Country> <Occupation>AV9916563</Occupation> <Categories /> </Customer> <Payments> <Payment id="1548"> <Date>2017-12-13</Date> <PaymentMethodId>3</PaymentMethodId> <Amount>71.10</Amount> <CurrencyCode>EUR</CurrencyCode> <ReservationId>3426</ReservationId> </Payment> <Payment id="1681"> <Date>2018-04-03</Date> <PaymentMethodId>1</PaymentMethodId> <Amount>33.00</Amount> <CurrencyCode>EUR</CurrencyCode> <ReservationId>3426</ReservationId> </Payment> </Payments> <TaxesByPercentages> <TaxesByPercentage> <Percentage>10.0</Percentage> <Amount>2.27</Amount> <Title>IVA</Title> <IsIncluded>0</IsIncluded> </TaxesByPercentage> </TaxesByPercentages> <InvoiceLines> <InvoiceLine id="2391"> <ItemType>1</ItemType> <Quantity>13.00</Quantity> <NetUnitPrice>60.95</NetUnitPrice> <GrossUnitPrice>67.50</GrossUnitPrice> <GrossSubtotal>877.50</GrossSubtotal> <NetSubtotal>792.29</NetSubtotal> <TaxesByPercentages> <TaxesByPercentage> <Percentage>9.0</Percentage> <Amount>60.92</Amount> <Title>VAT</Title> <IsIncluded>0</IsIncluded> <Breakdowns> <Breakdown> <Title>netsubtotal</Title> <Amount>676.84</Amount> </Breakdown> <Breakdown> <Title>accommodationpercent</Title> <Amount>85.00</Amount> </Breakdown> </Breakdowns> </TaxesByPercentage> </TaxesByPercentages> <BookingAgencyReferenceCode>DE34760737</BookingAgencyReferenceCode> <NumAdults>2</NumAdults> <NumChildren>0</NumChildren> <Description>Overnight+Included board HB (Room 219)</Description> <ReservationId>1768</ReservationId> </InvoiceLine> </InvoiceLines> <TotalNetValue>22.73</TotalNetValue> <TotalExtraTaxes>0.00</TotalExtraTaxes> <TotalTaxes>2.27</TotalTaxes> <TotalGrossValue>25.00</TotalGrossValue> </Invoice> <Invoice id="1362"> <IssueDate>2017-12-11</IssueDate> <CreateDate>2017-12-11T15:10:07+01:00</CreateDate> <Number>2563</Number> <Type>1</Type> <Counter id="1">Contador Botanico</Counter> <Customer id="4173"> <LastName>Ruiz</LastName> <FirstName>Macarena</FirstName> <TaxId /> <TaxIdAdditional>AV9916563</TaxIdAdditional> <City>AV9916563</City> <ZipCode>AV9916563</ZipCode> <Address1>AV9916563</Address1> <Address2>AV9916563</Address2> <Country>AV9916563</Country> <Occupation>AV9916563</Occupation> <Categories /> </Customer> <Payments/> <TaxesByPercentages> <TaxesByPercentage> <Percentage>10.0</Percentage> <Amount>7.20</Amount> <Title>IVA</Title> <IsIncluded>0</IsIncluded> </TaxesByPercentage> </TaxesByPercentages> <InvoiceLines> <InvoiceLine id="2228"> <ItemType>1</ItemType> <Quantity>1.00</Quantity> <NetUnitPrice>72.00</NetUnitPrice> <GrossUnitPrice>79.20</GrossUnitPrice> <GrossSubtotal>79.20</GrossSubtotal> <NetSubtotal>72.00</NetSubtotal> <TaxesByPercentages> <TaxesByPercentage> <Percentage>10.0</Percentage> <Amount>7.20</Amount> <Title>IVA</Title> <IsIncluded>0</IsIncluded> </TaxesByPercentage> </TaxesByPercentages> <BookingAgencyReferenceCode>1111111111</BookingAgencyReferenceCode> <NumAdults>2</NumAdults> <NumChildren>0</NumChildren> <Description>Noche (Habitación 101 Delux)</Description> </InvoiceLine> </InvoiceLines> <TotalNetValue>72.00</TotalNetValue> <TotalExtraTaxes>0.00</TotalExtraTaxes> <TotalTaxes>7.20</TotalTaxes> <TotalGrossValue>79.20</TotalGrossValue> </Invoice> </Invoices>
[ { "invoiceId":1361, "issueDate":"2017-12-11", "createDate":"2017-12-11T11:22:48+01:00", "number": "H17/2562", "type":1, "counter":{ "id":1, "title":"Contador Botanico" }, "customer":{ "id":3669, "lastName":"Chiodi", "firstName":"Tiziana", "taxId":"AV9916563", "taxIdAdditional":"AV9916563", "city":"Athens", "zipCode":"56447", "Address1": "Inglaterra 30", "Address2": "C/ Henan Cortes 63", "Country": "Spain", "Occupation": "Sales Manager" "categories":[ ] }, "payments":[ { "id":1431, "paymentDateString":"2017-10-16", "paymentDate":"2017-10-16T09:04:19", "paymentMethodId":3, "amount":647.68, "currencyCode":"EUR", "reservationId":4555 }, { "id":2047, "paymentDateString":"2017-12-10", "paymentDate":"2017-12-10T18:10:44", "paymentMethodId":3, "amount":25.00, "currencyCode":"EUR", "reservationId":4555 } ], "taxesByPercentage":[ { "percentage":10.0, "amount":2.27, "title":"IVA", "isIncluded":0 } ], "invoiceLines":[ { "id":2227, "itemType":7, "quantity":1.00, "netUnitPrice":22.73, "grossUnitPrice":25.00, "grossSubtotal":25.00, "netSubtotal":22.73, "taxesByPercentage":[ { "percentage":9.0, "amount":60.92, "title":"VAT", "isIncluded":0, "breakdown":[ { "title":"netsubtotal", "amount":676.84 }, { "title":"accommodationpercent", "amount":85.00 } ] } ], "bookingAgencyReferenceCode":"10", "numAdults":0, "numChildren":0, "description":"Transfer Hotel-Aeropuerto" } ], "totalNetValue":22.73, "totalExtraTaxes":0.00, "totalTaxes":2.27, "totalGrossValue":25.00 }, { "invoiceId":1362, "issueDate":"2017-12-11", "createDate":"2017-12-11T15:10:07+01:00", "number": "H17/2563", "type":1, "counter":{ "id":1, "title":"Contador Botanico" }, "customer":{ "id":4173, "lastName":"Ruiz", "firstName":"Macarena", "taxId":"", "taxIdAdditional":"", "city":"", "zipCode":"", "Address1": "Inglaterra 30", "Address2": "C/ Henan Cortes 63", "Country": "Spain", "Occupation": "Sales Manager" "categories":[ ] }, "payments":[ ], "taxesByPercentage":[ { "percentage":10.0, "amount":7.20, "title":"IVA", "isIncluded":0 } ], "invoiceLines":[ { "id":2228, "itemType":1, "quantity":1.00, "netUnitPrice":72.00, "grossUnitPrice":79.20, "grossSubtotal":79.20, "netSubtotal":72.00, "taxesByPercentage":[ { "percentage":10.0, "amount":7.20, "title":"IVA", "isIncluded":0 } ], "bookingAgencyReferenceCode":"1111111111", "numAdults":2, "numChildren":0, "description":"Noche (Habitación 101 Delux)" } ], "totalNetValue":72.00, "totalExtraTaxes":0.00, "totalTaxes":7.20, "totalGrossValue":79.20 } ]