Versions Compared

Key

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

Operation

Information of the operationReturns a single invoice with the specified ID. Also adds the owner of the entity, the invoice due date and the receipts if they exist in the product list.

Rw ui textbox macro
typewarning

Only accessible with permission of pms.integration.invoice


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


.separator{
margin: 5px 0;
}



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

GET



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

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



Request

PropertyTypeRequiredType parameterDefault valueDescription
chainIdIntegertruepath parameter
Unique identificator of the chain.
propertyIdIntegertruepath parameter
Unique identificator of the property.
invoiceIdIntegertruepath parameter
Unique identificator of the invoice.
Example request
addRebate
code
Boolean
language
false
powershell
request parameter
themeDJangoGET
falseShow Rebate posts of this invoice..


Example request

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



Response

Insert excerpt
Invoice
Invoice
nopaneltrue

Example response

Code Block
themeDJango
{
  	"id": 1,
	"sequence": 21312,
	"invoiceSerie": "A15",
  	"invoiceNumber": 1100000,
  	"invoiceDate": "20202019-01-1521",
	"invoiceDueDate": null,
	"company": {
    null,
	"customer": {
		"id": 1728,
    		"name": "Tagfeed",Denise Naéva Schmidt"
	},
 	"codetravelAgent": null,
	"holderName": "Denise Naéva Schmidt",
	"taxId": null,
	"75310161address",: "75865 Emmet Crossing",
 	"iataIdcity": null"Saginaw",
    "companyEmailList	"stateProvName": [
      {
        "id": 172,
        "primary": true,
        "emailAddressType": {
          "Barcelona",
	"stateProvCode": "ES-B",
	"postalCode": "48604",
	"countryCode": "ES",
	"remark": null,
	"invoiceType": {
		"id": 16,
          		"code": "1FO",
		"name": "Factura Ordinaria",
		"description":       "name": "Personal"
        },
        "email": "rsnyder4g@quantcast.com",
        "remark": null
      }
    ],
    "companyAddressList": [
      {
        "id": 172,
        "primary": true,
        "communicationLocationType": {
          null,
		"active": true,
		"inactiveReason": null
	},
	"billingType": {
		"id": 1,
		"code": "RES",
		"name": "Reservation",
		"nameI18n": "Reservation",
		"colorCode": "#43A047"
	},
	"invoiceSource": null,
	"totalAmountAfterTax": 1330.000000,
	"totalAmountBeforeTax": 1211.000007,
	"totalAmountTax": 118.999993,
	"totalAmountTaxExempt": 0.000000,
	"totalAmountDiscount": 0.000000,
	"totalAmountCommission": 0.000000,
	"minimumTicketNumber": null,
    "maximumTicketNumber": null,
	"productList": [{
			"id": 1,
			"productionDate":          "code"2019-01-30",
			"postingDate": "12019-01-30",
			"product": {
				"id":        431,
				"name": "HomeCash"
        },
        "street": "09914 Lunder Point",
        "city": "Dallas",
        "stateProvName": "Texas",
        "stateProvCode": null,
        "postalCode": "75310",
        "countryCode": "HT",
        "remark": "Address Remark"
      }
    ],
    "companyPhoneList": [
      {
        "id": 172,
        "primary": true,
        "phoneLocationType": {
          "id": 6,
          "code": "6",
          "name": "Home"
        },
        "phoneTechType": {
          "id": 1,
          "code": "1",
          "name": "Voice"
        },
        "countryAccessCode": "+34",
        "areaCityCode": "B",
        "phoneNumber": "1-(214)166-4006",
        "extension": "1",
        "remark": "Phone Remark"
      }
    ],
    "companyTaxAddress": {
      "id": 162,
      "communicationLocationType": null,
      "street": "09914 Lunder Point",
      "city": "Dallas",
      "stateProvName": "Texas",
      "stateProvCode": null,
      "postalCode": "75310",
      "countryCode": "NZ",
      "remark": "Address Remark"
    },
    "remark": "Company Remarks",
  	"profileType": {
    			"code": "2",
   	 			"name": "Company",
    			"nameI18n": "Company",
    			"colorCode": "#00ACC1"
  	}
  },
  "customer": null,
  "travelAgent": null,
  "holderName": "Tagfeed",
  "taxId": "75310161",
  "address": "09914 Lunder Point",
  "city": "Dallas",
  "stateProvName": "Texas",
  "stateProvCode": null,
  "postalCode": "75310",
  "countryCode": "HT",
  "remark": null,
  "productList": [
    {
      "id": 1,
      "productionDate": "2020-01-14",
      "postingDate": "2020-01-14",
      "product": {
        "id": 632,
		"code":"S",
        "name": "Single",
        "productType": {
          "id": 1,
          "code": "ACC",
          "name": "Accommodation"
        }
      },
      "quantity": 1,
      "amountAfterTax": 102.200000,
      "amountBeforeTax": 92.909091,
      "amountDiscount": 0.000000,
      "amountTax": 9.290909,
      "amountCommission": 0.000000,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro"
      },
      "channel": {
        "id": 11,
        "code": "WEB",
        "name": "Booking Engine"
      },
      "source": {
        "id": 8,
        "code": "AGE",
        "name": "Agency"
      },
      "segment": {
        "id": 31,
        "code": "CREWS",
        "name": "Crews"
      },
      "invoiceProductTaxList": [
        {
          "id": 1,
          "tax": {
            "id": 45,
            "name": "Tax 10%"
          },
          "name": "Tax 10%",
          "amount": 0.000000,
          "percentageOfTax": 10.000000,
          "amountOfTax": 0.000000
        }
      ],
      "invoiceProductCommissionList": [],
      "invoiceProductDiscountList": []
    },
    {
      "id": 2,
      "productionDate": "2020-01-14",
      "postingDate": "2020-01-14",
      "product": {
        "id": 767,
		"code":"CTB",
        "name": "City Tax Barcelona",
        "productType": {
          "id": 6,
          "code": "FEE",
          "name": "Fee"
        }
      },
      "quantity": 1,
      "amountAfterTax": 3.000000,
      "amountBeforeTax": 3.000000,
      "amountDiscount": 0.000000,
      "amountTax": 0.000000,
      "amountCommission": 0.000000,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro"
      },
      "channel": {
        "id": 11,
        "code": "WEB",
        "name": "Booking Engine"
      },
      "source": {
        "id": 8,
        "code": "AGE",
        "name": "Agency"
      },
      "segment": {
        "id": 31,
        "code": "CREWS",
        "name": "Crews"
      },
      "invoiceProductTaxList": [],
      "invoiceProductCommissionList": [],
      "invoiceProductDiscountList": []
    },
    {
      "id": 3,
      "productionDate": "2020-01-15",
      "postingDate": "2020-01-15",
      "product": {
        "id": 61,
		"code":"BR",
        "name": "Breakfast",
        "productType": {
          "id": 2,
          "code": "SER",
          "name": "Service"
        }
      },
      "quantity": 1,
      "amountAfterTax": 22.000000,
      "amountBeforeTax": 20.000000,
      "amountDiscount": 0.000000,
      "amountTax": 2.000000,
      "amountCommission": 0.000000,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro"
      },
      "channel": {
        "id": 11,
        "code": "WEB",
        "name": "Booking Engine"
      },
      "source": {
        "id": 8,
        "code": "AGE",
        "name": "Agency"
      },
      "segment": {
        "id": 31,
        "code": "CREWS",
        "name": "Crews"
      },
      "invoiceProductTaxList": [
        {
          "id": 2,
          "tax": {
            "id": 45,
            "name": "Tax 10%"
          },
          "name": "Tax 10%",
          "amount": 0.000000,
          "percentageOfTax": 10.000000,
          "amountOfTax": 0.000000
        }
      ],
      "invoiceProductCommissionList": [],
      "invoiceProductDiscountList": []
    },
    {
      "id": 4,
      "productionDate": "2020-01-15",
      "postingDate": "2020-01-15",
      "product": {
        "id": 74,
		"code":"PK",
        "name": "Parking",
        "productType": {
          "id": 2,
          "code": "SER",
          "name": "Service"
        }
      },
      "quantity": 3,
      "amountAfterTax": 10.000000,
      "amountBeforeTax": 9.090909,
      "amountDiscount": 0.000000,
      "amountTax": 0.909091,
      "amountCommission": 0.000000,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro"
      },
      "channel": {
        "id": 11,
        "code": "WEB",
        "name": "Booking Engine"
      },
      "source": {
        "id": 8,
        "code": "AGE",
        "name": "Agency"
      },
      "segment": {
        "id": 31,
        "code": "CREWS",
        "name": "Crews"
      },
      "invoiceProductTaxList": [
        {
          "id": 3,
          "tax": {
            "id": 45,
            "name": "Tax 10%"
          },
          "name": "Tax 10%",
          "amount": 0.000000,
          "percentageOfTax": 10.000000,
          "amountOfTax": 0.000000
        }
      ],
      "invoiceProductCommissionList": [],
      "invoiceProductDiscountList": []
    },
    {
      "id": 5,
      "productionDate": "2020-01-15",
      "postingDate": "2020-01-15",
      "product": {
        "id": 74,
		"code":"PK",
        "name": "Parking",
        "productType": {
          "id": 2,
          "code": "SER",
          "name": "Service"
        }
      },
      "quantity": 2,
      "amountAfterTax": 10.000000,
      "amountBeforeTax": 9.090909,
      "amountDiscount": 0.000000,
      "amountTax": 0.909091,
      "amountCommission": 0.000000,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro"
      },
      "channel": {
        "id": 11,
        "code": "WEB",
        "name": "Booking Engine"
      },
      "source": {
        "id": 8,
        "code": "AGE",
        "name": "Agency"
      },
      "segment": {
        "id": 31,
        "code": "CREWS",
        "name": "Crews"
      },
      "invoiceProductTaxList": [
        {
          "id": 4,
          "tax": {
            "id": 45,
            "name": "Tax 10%"
          },
          "name": "Tax 10%",
          "amount": 0.000000,
          "percentageOfTax": 10.000000,
          "amountOfTax": 0.000000
        }
      ],
      "invoiceProductCommissionList": [],
      "invoiceProductDiscountList": []
    },
    {
      "id": 6,
      "productionDate": "2020-01-15",
      "postingDate": "2020-01-15",
      "product": {
        "id": 51,
		"code":"MC",
        "name": "MasterCard",
        "productType": {
          "id": 3,
          "code": "PAY",
          "name": "Payment"
        }
      },
      "quantity": 1,
      "amountAfterTax": 177.200000,
      "amountBeforeTax": 177.200000,
      "amountDiscount": 0.000000,
      "amountTax": 0.000000,
      "amountCommission": 0.000000,
      "currency": {
        "id": 1,
        "code": "EUR",
        "name": "Euro"
      },
      "channel": {
        "id": 11,
        "code": "WEB",
        "name": "Booking Engine"
      },
      "source": {
        "id": 8,
        "code": "AGE",
        "name": "Agency"
      },
      "segment": {
        "id": 31,
        "code": "CREWS",
        "name": "Crews"
      },
      "invoiceProductTaxList": [],
      "invoiceProductCommissionList": [],
      "invoiceProductDiscountList": []
    }
  ]			},
			"productType": {
				"code": "PAY",
				"name": "Payment"
			},
			"productName": "Cash",
			"quantity": 1,
			"amountAfterTax": 142,
			"amountBeforeTax": 142,
			"amountDiscount": 0,
			"amountTax": 0,
			"amountCommission": 0,
			"currency": {
				"code": "EUR",
				"name": "Euro"
			},
			"channel": null,
			"source": null,
			"segment": null,
			"invoiceProductTaxList": [],
			"invoiceProductCommissionList": [],
			"invoiceProductDiscountList": []
		},
		{
			"id": 2,
			"productionDate": "2019-01-30",
			"postingDate": "2019-01-30",
			"product": {
				"id": 530,
				"name": "Deposit 21"
			},
			"productType": {
				"code": "DEP",
				"name": "Deposit"
			},
			"productName": "Deposit 21",
			"quantity": 1,
			"amountAfterTax": 142,
			"amountBeforeTax": 142,
			"amountDiscount": 0,
			"amountTax": 0,
			"amountCommission": 0,
			"currency": {
				"code": "EUR",
				"name": "Euro"
			},
			"channel": null,
			"source": null,
			"segment": null,
			"invoiceProductTaxList": [],
			"invoiceProductCommissionList": [],
			"invoiceProductDiscountList": []
		}
	],
	"invoiceTaxSummaryList": null,
	"folioInvoiceOwner": {
		"reservation": null,
		"reservationRoomStay": null,
		"reservationGroup": null,
		"deposit": null,
		"customer": null,
		"company": {
			"id": 22,
			"name": "Tesipro MAD",
			"code": "TESMA",
			"taxId": "ABCDE",
			"companyEmailList": null,
			"companyAddressList": [{
				"id": 22,
				"primary": true,
				"communicationLocationType": {
					"id": 1,
					"code": "1",
					"name": "Home",
					"nameI18n": "Home"
				},
				"street": "9 Weeping Birch Crossing",
				"city": "Orange",
				"stateProvName": "Soria",
				"stateProvCode": "ES-SO",
				"postalCode": "92862",
				"countryCode": "ES",
				"remark": "Address Remark"
			}],
			"companyPhoneList": null,
			"companyTaxAddress": {
				"id": 3,
				"communicationLocationType": null,
				"street": "9 Weeping Birch Crossing",
				"city": "Orange",
				"stateProvName": "Cáceres",
				"stateProvCode": "ES-CC",
				"postalCode": "92862",
				"countryCode": "ES",
				"remark": "Address Remark"
			},
			"remark": "Company Remarks",
			"assignedUser": null,
			"profileType": null
		},
		"travelAgent": null

	}
}