GET hotels/{hotelId}/cityledger/agedbalance?key={key}&date={date}

Gets the Aged Balance Report raw data

Request Information

URI Parameters

NameDescriptionTypeAdditional information
hotelId

Hotel-Id => checked against the calling applications permissions

string

Required

key

API - Key identifying the caller

string

Required

date

The report will be generated as of the date provided (Format YYYY-MM-DD)

date

Required

Body Parameters

None.

Response Information

Resource Description

List of invoices, including its transactions, and account credits.

AgedBalance
NameDescriptionTypeAdditional information
CityAccounts

A list of City Accounts

Collection of CityAccount

None.

Response Formats

application/json, text/json

Sample:
{
  "CityAccounts": [
    {
      "AccountName": "sample string 1",
      "AccountNumber": 2,
      "AccountCreditLimit": 3.0,
      "Invoices": [
        {
          "InvoiceId": 1,
          "AccountTransfers": [
            {
              "TransferDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 2.0,
              "GuestName": "sample string 3",
              "ReservationId": 4,
              "FolioNumber": 5
            },
            {
              "TransferDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 2.0,
              "GuestName": "sample string 3",
              "ReservationId": 4,
              "FolioNumber": 5
            }
          ],
          "AccountPayments": [
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            },
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            }
          ],
          "AccountCharges": [
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            },
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            }
          ]
        },
        {
          "InvoiceId": 1,
          "AccountTransfers": [
            {
              "TransferDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 2.0,
              "GuestName": "sample string 3",
              "ReservationId": 4,
              "FolioNumber": 5
            },
            {
              "TransferDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 2.0,
              "GuestName": "sample string 3",
              "ReservationId": 4,
              "FolioNumber": 5
            }
          ],
          "AccountPayments": [
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            },
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            }
          ],
          "AccountCharges": [
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            },
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            }
          ]
        }
      ],
      "AccountCredits": [
        {
          "Description": "sample string 1",
          "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
          "TransactionAmount": 3.0
        },
        {
          "Description": "sample string 1",
          "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
          "TransactionAmount": 3.0
        }
      ]
    },
    {
      "AccountName": "sample string 1",
      "AccountNumber": 2,
      "AccountCreditLimit": 3.0,
      "Invoices": [
        {
          "InvoiceId": 1,
          "AccountTransfers": [
            {
              "TransferDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 2.0,
              "GuestName": "sample string 3",
              "ReservationId": 4,
              "FolioNumber": 5
            },
            {
              "TransferDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 2.0,
              "GuestName": "sample string 3",
              "ReservationId": 4,
              "FolioNumber": 5
            }
          ],
          "AccountPayments": [
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            },
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            }
          ],
          "AccountCharges": [
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            },
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            }
          ]
        },
        {
          "InvoiceId": 1,
          "AccountTransfers": [
            {
              "TransferDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 2.0,
              "GuestName": "sample string 3",
              "ReservationId": 4,
              "FolioNumber": 5
            },
            {
              "TransferDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 2.0,
              "GuestName": "sample string 3",
              "ReservationId": 4,
              "FolioNumber": 5
            }
          ],
          "AccountPayments": [
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            },
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            }
          ],
          "AccountCharges": [
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            },
            {
              "InvoiceName": "sample string 1",
              "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
              "TransactionAmount": 3.0
            }
          ]
        }
      ],
      "AccountCredits": [
        {
          "Description": "sample string 1",
          "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
          "TransactionAmount": 3.0
        },
        {
          "Description": "sample string 1",
          "TransactionDate": "2022-10-05T15:26:42.097828-07:00",
          "TransactionAmount": 3.0
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<AgedBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models.CityLedger">
  <CityAccounts>
    <CityAccount>
      <AccountCreditLimit>3</AccountCreditLimit>
      <AccountCredits>
        <AccountCredit>
          <Description>sample string 1</Description>
          <TransactionAmount>3</TransactionAmount>
          <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
        </AccountCredit>
        <AccountCredit>
          <Description>sample string 1</Description>
          <TransactionAmount>3</TransactionAmount>
          <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
        </AccountCredit>
      </AccountCredits>
      <AccountName>sample string 1</AccountName>
      <AccountNumber>2</AccountNumber>
      <Invoices>
        <Invoice>
          <AccountCharges>
            <AccountCharge>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountCharge>
            <AccountCharge>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountCharge>
          </AccountCharges>
          <AccountPayments>
            <AccountPayment>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountPayment>
            <AccountPayment>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountPayment>
          </AccountPayments>
          <AccountTransfers>
            <AccountTransfer>
              <FolioNumber>5</FolioNumber>
              <GuestName>sample string 3</GuestName>
              <ReservationId>4</ReservationId>
              <TransactionAmount>2</TransactionAmount>
              <TransferDate>2022-10-05T15:26:42.097828-07:00</TransferDate>
            </AccountTransfer>
            <AccountTransfer>
              <FolioNumber>5</FolioNumber>
              <GuestName>sample string 3</GuestName>
              <ReservationId>4</ReservationId>
              <TransactionAmount>2</TransactionAmount>
              <TransferDate>2022-10-05T15:26:42.097828-07:00</TransferDate>
            </AccountTransfer>
          </AccountTransfers>
          <InvoiceId>1</InvoiceId>
        </Invoice>
        <Invoice>
          <AccountCharges>
            <AccountCharge>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountCharge>
            <AccountCharge>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountCharge>
          </AccountCharges>
          <AccountPayments>
            <AccountPayment>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountPayment>
            <AccountPayment>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountPayment>
          </AccountPayments>
          <AccountTransfers>
            <AccountTransfer>
              <FolioNumber>5</FolioNumber>
              <GuestName>sample string 3</GuestName>
              <ReservationId>4</ReservationId>
              <TransactionAmount>2</TransactionAmount>
              <TransferDate>2022-10-05T15:26:42.097828-07:00</TransferDate>
            </AccountTransfer>
            <AccountTransfer>
              <FolioNumber>5</FolioNumber>
              <GuestName>sample string 3</GuestName>
              <ReservationId>4</ReservationId>
              <TransactionAmount>2</TransactionAmount>
              <TransferDate>2022-10-05T15:26:42.097828-07:00</TransferDate>
            </AccountTransfer>
          </AccountTransfers>
          <InvoiceId>1</InvoiceId>
        </Invoice>
      </Invoices>
    </CityAccount>
    <CityAccount>
      <AccountCreditLimit>3</AccountCreditLimit>
      <AccountCredits>
        <AccountCredit>
          <Description>sample string 1</Description>
          <TransactionAmount>3</TransactionAmount>
          <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
        </AccountCredit>
        <AccountCredit>
          <Description>sample string 1</Description>
          <TransactionAmount>3</TransactionAmount>
          <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
        </AccountCredit>
      </AccountCredits>
      <AccountName>sample string 1</AccountName>
      <AccountNumber>2</AccountNumber>
      <Invoices>
        <Invoice>
          <AccountCharges>
            <AccountCharge>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountCharge>
            <AccountCharge>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountCharge>
          </AccountCharges>
          <AccountPayments>
            <AccountPayment>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountPayment>
            <AccountPayment>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountPayment>
          </AccountPayments>
          <AccountTransfers>
            <AccountTransfer>
              <FolioNumber>5</FolioNumber>
              <GuestName>sample string 3</GuestName>
              <ReservationId>4</ReservationId>
              <TransactionAmount>2</TransactionAmount>
              <TransferDate>2022-10-05T15:26:42.097828-07:00</TransferDate>
            </AccountTransfer>
            <AccountTransfer>
              <FolioNumber>5</FolioNumber>
              <GuestName>sample string 3</GuestName>
              <ReservationId>4</ReservationId>
              <TransactionAmount>2</TransactionAmount>
              <TransferDate>2022-10-05T15:26:42.097828-07:00</TransferDate>
            </AccountTransfer>
          </AccountTransfers>
          <InvoiceId>1</InvoiceId>
        </Invoice>
        <Invoice>
          <AccountCharges>
            <AccountCharge>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountCharge>
            <AccountCharge>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountCharge>
          </AccountCharges>
          <AccountPayments>
            <AccountPayment>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountPayment>
            <AccountPayment>
              <InvoiceName>sample string 1</InvoiceName>
              <TransactionAmount>3</TransactionAmount>
              <TransactionDate>2022-10-05T15:26:42.097828-07:00</TransactionDate>
            </AccountPayment>
          </AccountPayments>
          <AccountTransfers>
            <AccountTransfer>
              <FolioNumber>5</FolioNumber>
              <GuestName>sample string 3</GuestName>
              <ReservationId>4</ReservationId>
              <TransactionAmount>2</TransactionAmount>
              <TransferDate>2022-10-05T15:26:42.097828-07:00</TransferDate>
            </AccountTransfer>
            <AccountTransfer>
              <FolioNumber>5</FolioNumber>
              <GuestName>sample string 3</GuestName>
              <ReservationId>4</ReservationId>
              <TransactionAmount>2</TransactionAmount>
              <TransferDate>2022-10-05T15:26:42.097828-07:00</TransferDate>
            </AccountTransfer>
          </AccountTransfers>
          <InvoiceId>1</InvoiceId>
        </Invoice>
      </Invoices>
    </CityAccount>
  </CityAccounts>
</AgedBalance>