v1

latestOpenAPI 3.0.32026-07-2632131.4 MB

Reservations

Create new Invoice item

For creating new invoice item use the <a href="https://open-api-docs.guesty.com/reference/invoiceitemscontroller_createinvoiceitem">new API</a>

post/reservations/{id}/invoiceItems

Path parameters

idstring required

Reservation ID

Request body

titlestring required

Title of the invoice item

amountnumber required

Price to be charged for the invoice item

normalTypestring required

Invoice item's type identifier

descriptionstring

Description of the invoice item

secondIdentifierstring required

An additional optional identifier

Example request

{
  "title": "Accommodation fare",
  "amount": 98.52,
  "normalType": "AFE",
  "description": "Management fee description",
  "secondIdentifier": "MANAGEMENT"
}

Response

Invoice created

flagboolean

accountingEnabledboolean

isBMAppliedboolean

pulledByDailySyncboolean

manuallyCreatedboolean

_idstring

Unique Id

statusstring

checkInstring

checkOutstring

nightsCountnumber

guestsCountnumber

listingIdstring

Unique Id

checkInDateLocalizedstring

checkOutDateLocalizedstring

accountIdstring

Unique Id

guestIdstring

Unique Id

sourcestring

secondarySourcestring

Reservation website name. Should be present in case 'source' is one of ['BE-API', 'Booking Engine', 'website']. If absent, it means we failed to extract the secondary source information.

confirmationCodestring

isReturningGuestboolean

confirmedAtstring

importedAtstring

createdAtstring

lastUpdatedAtstring

__vnumber

conversationIdstring

Unique Id

idstring

Unique Id

isMidStayboolean

lastStayListingIdstring

Unique Id

Example response

{
  "integration": {
    "_id": "563e0b6a08a2710e00057b82"
  },
  "atTimeOfConfirmation": {
    "channelCommission": {
      "_id": "563e0b6a08a2710e00057b82"
    },
    "taxes": [
      {
        "_id": "563e0b6a08a2710e00057b82"
      }
    ]
  },
  "_id": "563e0b6a08a2710e00057b82",
  "checkIn": "2021-08-17T07:00:00.000Z",
  "checkOut": "2021-08-17T07:00:00.000Z",
  "money": {
    "invoiceItems": [
      {
        "_id": "563e0b6a08a2710e00057b82"
      }
    ],
    "payments": [
      {
        "authenticationRequiredData": {
          "lastAuthMsgSentDate": "2021-08-16T08:38:20.280Z"
        },
        "createdAt": "2021-08-16T08:38:20.280Z",
        "attempts": [
          {
            "createdAt": "2021-08-16T08:38:20.280Z",
            "_id": "563e0b6a08a2710e00057b82",
            "payload": {
              "payment_intent": {
                "id": "563e0b6a08a2710e00057b82",
                "charges": {
                  "data": [
                    {
                      "metadata": {
                        "accountId": "563e0b6a08a2710e00057b82",
                        "reservationId": "563e0b6a08a2710e00057b82",
                        "listingId": "563e0b6a08a2710e00057b82"
                      }
                    }
                  ]
                },
                "metadata": {
                  "accountId": "563e0b6a08a2710e00057b82",
                  "reservationId": "563e0b6a08a2710e00057b82",
                  "listingId": "563e0b6a08a2710e00057b82"
                }
              }
            }
          }
        ],
        "_id": "563e0b6a08a2710e00057b82",
        "shouldBePaidAt": "2021-08-16T08:38:20.280Z",
        "paymentMethodId": "563e0b6a08a2710e00057b82",
        "guestId": "563e0b6a08a2710e00057b82"
      }
    ]
  },
  "listingId": "563e0b6a08a2710e00057b82",
  "accountId": "563e0b6a08a2710e00057b82",
  "guestId": "563e0b6a08a2710e00057b82",
  "mtl": {
    "_id": "563e0b6a08a2710e00057b82"
  },
  "confirmedAt": "2021-08-17T07:00:00.000Z",
  "importedAt": "2021-08-17T07:00:00.000Z",
  "additionalFeesAtCreation": [
    {
      "_id": "563e0b6a08a2710e00057b82",
      "accountId": "563e0b6a08a2710e00057b82"
    }
  ],
  "createdAt": "2021-08-17T07:00:00.000Z",
  "lastUpdatedAt": "2021-08-17T07:00:00.000Z",
  "conversationId": "563e0b6a08a2710e00057b82",
  "id": "563e0b6a08a2710e00057b82",
  "lastStayListingId": "563e0b6a08a2710e00057b82",
  "stay": {
    "id": "563e0b6a08a2710e00057b82",
    "unitTypeId": "563e0b6a08a2710e00057b82",
    "unitId": "563e0b6a08a2710e00057b82"
  }
}