OperationId:getReminders
" }, { "info": { "name": "Generate reminders", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/accountReminders", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to generate a reminder statement which includes payment due, current account balance, and etc. of account receivable account holder.OperationId:postReminders
" }, { "info": { "name": "Get given profile's account receivable detail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/accounts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "balance", "value": "", "type": "query", "description": "Search By Balance. Search will be done for 'All', 'Open Balance' or 'Zero Balance' Accounts." }, { "name": "batchStatement", "value": "", "type": "query", "description": "Search criteria for batch processing" }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Property where the Accounts exist." }, { "name": "profileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "type", "value": "", "type": "query", "description": "Search by Account Type." }, { "name": "accountNo", "value": "", "type": "query", "description": "Account Number ." }, { "name": "accountName", "value": "", "type": "query", "description": "Wild Card Search by Account Name. Search will be done for any Accounts whose name starts with this value." }, { "name": "accountId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "accountIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "accountType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "includeStatementHistoryIndicator", "value": "", "type": "query", "description": "Return statement history indicator in result. This flag included for performance reason to populate history flag only for Statements Mode." }, { "name": "includeReminderHistoryIndicator", "value": "", "type": "query", "description": "Return reminder history indicator in result. This flag included for performance reason to populate history flag only for Statements Mode." }, { "name": "superSearch", "value": "", "type": "query", "description": "Free form text field for searching all reservation fields" }, { "name": "searchHotelIds", "value": "", "type": "query", "description": "Hotel code." }, { "name": "attributeName", "value": "", "type": "query" }, { "name": "orderType", "value": "", "type": "query" }, { "name": "minimumBalance", "value": "", "type": "query", "description": "Search AR Accounts with a minimum balance filter." } ] }, "docs": "Use this API to search for AR Accounts for a given OPERA Profile id. API returns contain a list of AR Accounts and their AR information.OperationId:getAccounts
The maximum allowable limit for this API is 20.
" }, { "info": { "name": "Get history of reminder letters for a given account receivable", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/accounts/:accountId/remindersHistory", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "profileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "accountIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "accountType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "accountNo", "value": "", "type": "query", "description": "Account Number for the AR Account." }, { "name": "accountName", "value": "", "type": "query", "description": "Account Name for the AR Account." }, { "name": "dateSent", "value": "", "type": "query", "description": "History Date filter." }, { "name": "reportFileNameWildCard", "value": "", "type": "query", "description": "Report Name wild card." } ] }, "docs": "Use this API to get history of reminder letters prepared for AR account.OperationId:getRemindersHistory
" }, { "info": { "name": "Get given profile's account receivable statements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/accounts/:accountId/statements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "profileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "accountNo", "value": "", "type": "query", "description": "Account Number for the AR Account." }, { "name": "accountName", "value": "", "type": "query", "description": "Account Name for the AR Account." }, { "name": "canBeModified", "value": "", "type": "query", "description": "Flag to indicate if postings or adjustments can be made to the invoice." }, { "name": "closeDate", "value": "", "type": "query", "description": "Close date of the invoice." }, { "name": "fiscalBillNo", "value": "", "type": "query", "description": "The Fiscal Bill number of this posting" }, { "name": "folioDate", "value": "", "type": "query", "description": "Date of Folio Generation." }, { "name": "folioNo", "value": "", "type": "query", "description": "Folio Number." }, { "name": "folioStatus", "value": "", "type": "query", "description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status." }, { "name": "folioTypeName", "value": "", "type": "query", "description": "The name of the Folio Type used for the Folio Number sequence." }, { "name": "internalFolioWindowID", "value": "", "type": "query", "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference." }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios" }, { "name": "invoiceType", "value": "", "type": "query" }, { "name": "postingDate", "value": "", "type": "query", "description": "Posting date of the invoice." }, { "name": "revenueDate", "value": "", "type": "query", "description": "Revenue date ID of the invoice." }, { "name": "statementNo", "value": "", "type": "query", "description": "Statementno of the invoice." }, { "name": "status", "value": "", "type": "query", "description": "Status of the invoice." }, { "name": "transferDate", "value": "", "type": "query", "description": "Transfer date of the invoice." }, { "name": "invoiceTransactionCode", "value": "", "type": "query", "description": "Transaction code of the invoice." }, { "name": "transactionDate", "value": "", "type": "query", "description": "Transaction Date of the invoice." }, { "name": "transactionNo", "value": "", "type": "query", "description": "Unique Transaction Identifier of the Invoice." }, { "name": "invoiceHotelIds", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "reservationId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "guestProfileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "guestProfileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "guestProfileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "age", "value": "", "type": "query", "description": "The Aging age of the invoice" }, { "name": "guestName", "value": "", "type": "query", "description": "Name of the Guest who consumed these transactions." }, { "name": "originalAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "originalAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "paymentsAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "paymentsCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "balanceAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "balanceCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "reference", "value": "", "type": "query", "description": "User-defined posting reference." }, { "name": "remark", "value": "", "type": "query", "description": "User-defined posting remark." }, { "name": "adjusted", "value": "", "type": "query" }, { "name": "parentInvoiceNo", "value": "", "type": "query" }, { "name": "compressed", "value": "", "type": "query" }, { "name": "compressedDate", "value": "", "type": "query" }, { "name": "transferredOut", "value": "", "type": "query" }, { "name": "transferredIn", "value": "", "type": "query" }, { "name": "marketDescription", "value": "", "type": "query" }, { "name": "marketHotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "marketCode", "value": "", "type": "query" }, { "name": "marketGroup", "value": "", "type": "query" }, { "name": "roomClassDescription", "value": "", "type": "query" }, { "name": "roomClassHotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "roomClassCode", "value": "", "type": "query" }, { "name": "sourceDescription", "value": "", "type": "query" }, { "name": "sourceHotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "sourceCode", "value": "", "type": "query" }, { "name": "sourceGroup", "value": "", "type": "query" }, { "name": "cashierId", "value": "", "type": "query", "description": "Cashier Id of the Cashier." }, { "name": "cashierName", "value": "", "type": "query", "description": "Cashier Name." }, { "name": "transactionHotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "printTrxReceipt", "value": "", "type": "query", "description": "Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code." }, { "name": "accountInvoiceTransactionCode", "value": "", "type": "query", "description": "Unique identifier for the Transaction code." }, { "name": "transactionDescription", "value": "", "type": "query", "description": "Transaction codes info." }, { "name": "transactionGroup", "value": "", "type": "query", "description": "Category of the transaction code." }, { "name": "transactionSubGroup", "value": "", "type": "query", "description": "Sub category of the transaction code." }, { "name": "universalProductCode", "value": "", "type": "query", "description": "Unique Universal product code of the transaction code." }, { "name": "routingInstructionsId", "value": "", "type": "query", "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer." }, { "name": "articleCode", "value": "", "type": "query", "description": "Unique code of the article." }, { "name": "articleHotelIds", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether the article is inactive or not." }, { "name": "orderSequence", "value": "", "type": "query", "description": "Display Order sequence." }, { "name": "articleDescription", "value": "", "type": "query", "description": "Description of the article." }, { "name": "transactionCode", "value": "", "type": "query", "description": "Transaction code to which the article belongs." }, { "name": "articleAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "articleCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "availableForPostIt", "value": "", "type": "query", "description": "Indicates whether the article is available for post it." }, { "name": "color", "value": "", "type": "query", "description": "Color configuration type. This color configuration provides a visual category of entities." }, { "name": "articleUniversalProductCode", "value": "", "type": "query", "description": "Unique Universal product code of the article." }, { "name": "attachCreditCardToProfile", "value": "", "type": "query", "description": "Attach the credit card to profile." }, { "name": "cardHolderName", "value": "", "type": "query" }, { "name": "cardNumber", "value": "", "type": "query" }, { "name": "cardNumberLast4Digits", "value": "", "type": "query" }, { "name": "cardNumberMasked", "value": "", "type": "query" }, { "name": "cardOrToken", "value": "", "type": "query", "description": "Simple type for indicating if credit card number is tokenized." }, { "name": "cardType", "value": "", "type": "query", "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method." }, { "name": "expirationDate", "value": "", "type": "query", "description": "Expiration date of the credit card" }, { "name": "expirationDateExpired", "value": "", "type": "query" }, { "name": "expirationDateMasked", "value": "", "type": "query", "description": "Masked Expiration date of the credit card" }, { "name": "processing", "value": "", "type": "query" }, { "name": "swiped", "value": "", "type": "query" }, { "name": "userDefinedCardType", "value": "", "type": "query", "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided" }, { "name": "invoicePaymentCardId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "invoicePaymentCardIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "invoicePaymentCardIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "currentAuthorizedAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currentAuthorizedAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "approvalAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "approvalAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "type", "value": "", "type": "query", "description": "Defines the type of Linked profiles for a block." }, { "name": "addresseeProfileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "addresseeProfileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "addresseeProfileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "name", "value": "", "type": "query", "description": "Name for the profile attached to the block." }, { "name": "city", "value": "", "type": "query", "description": "City for the profile attached to the block." }, { "name": "phone", "value": "", "type": "query", "description": "Phone for the profile attached to the block." }, { "name": "allowPartialTransferYn", "value": "", "type": "query", "description": "Flag to check partial Transfer Allowed." }, { "name": "printed", "value": "", "type": "query", "description": "Flag to check Invoice Statement is Printed." }, { "name": "printedDate", "value": "", "type": "query", "description": "Invoice Statement Printed Date." }, { "name": "storedFolioId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "storedFolioIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "storedFolioType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "storedFolioName", "value": "", "type": "query", "description": "Name of the Stored Folio." }, { "name": "storedDebitFolioId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "storedDebitFolioIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "storedDebitFolioType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "storedDebitFolioName", "value": "", "type": "query", "description": "Name of the Stored Debit Folio." }, { "name": "balanceForwardDate", "value": "", "type": "query", "description": "The date specified in this field determines the balance forward date and balance forward total that is printed on the statement. (A balance forward shows the net amount for all invoices and payments (debits and credits) prior to the balance forward date as a single total, rather than itemizing them individually on the statement.)" }, { "name": "inclFolios", "value": "", "type": "query", "description": "Flag to indicate if the associated Folios for the Invoices are to be included along with the the Statement." }, { "name": "inclPrinted", "value": "", "type": "query", "description": "Flag to indicate if previously Printed Invoices are to be included in the Statement. This is based on the Functionality for AR PRINTED INVOICES." }, { "name": "inclZero", "value": "", "type": "query", "description": "Flag to indicate if Zero Balances Invoices are to be included in the Statement." }, { "name": "filterEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "filterStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "statementText", "value": "", "type": "query", "description": "Text which will be printed on the Invoice." } ] }, "docs": "Use this API to prepare statement for an AR account holders. It is typically prepared for billing purposes.This API is deprecated. Please use getARStatements instead
OperationId:getStatements
" }, { "info": { "name": "Get AR transactions.", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/arTransactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelIds", "value": "", "type": "query", "description": "Property where the Accounts exist." }, { "name": "accounts", "value": "", "type": "query", "description": "Account number of this transaction." }, { "name": "endDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "startDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "fromAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "fromCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "toAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "toCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "guestName", "value": "", "type": "query", "description": "Display Name for the guest." }, { "name": "invoices", "value": "", "type": "query", "description": "invoice Number ." }, { "name": "folios", "value": "", "type": "query", "description": "folio Number ." }, { "name": "fiscalBillNo", "value": "", "type": "query", "description": "Fiscal bill number of this transaction." }, { "name": "accountName", "value": "", "type": "query", "description": "Account number of this transaction." }, { "name": "addresseName", "value": "", "type": "query", "description": "Addressee Name filter. Works with the Addressee Functionality." } ] }, "docs": "Use this API to get list of transaction data for a given account receivable account number and list of hotelsOperationId:getARTransactions
This API allows a time span of 30 days.
" }, { "info": { "name": "Search AR transactions.", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/arTransactions/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to get list of transaction data for a given account receivable account number and list of hotelsOperationId:searchARTransactions
This API allows a time span of 30 days.
" }, { "info": { "name": "Create an account receivable account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to create a new account receivable type account for given OPERA profile id. Prior creating account, need to use getProfile to find OPERA profile's id.OperationId:postAccount
" }, { "info": { "name": "Get list of hold invoices for account receivable", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/accounts/invoicesOnHold", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "profileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "accountIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "accountType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "accountNo", "value": "", "type": "query", "description": "Account Number for the AR Account." }, { "name": "accountName", "value": "", "type": "query", "description": "Account Name for the AR Account." }, { "name": "endDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "startDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "folios", "value": "", "type": "query", "description": "Folio Number for the invoice." }, { "name": "invoices", "value": "", "type": "query", "description": "Invoice number for the invoice." }, { "name": "fiscalBillNo", "value": "", "type": "query", "description": "Fiscal Bill number for the invoice." }, { "name": "guestName", "value": "", "type": "query", "description": "Guest Name set for the invoice." } ] }, "docs": "Use this API to get list of account receivable invoices which are put on hold.OperationId:getInvoicesOnHold
This API allows a time span of 30 days.
" }, { "info": { "name": "Get list of hold invoices for account receivable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/invoicesOnHold/searches", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to get list of account receivable invoices which are put on hold.OperationId:searchInvoicesOnHold
This API allows a time span of 30 days.
" }, { "info": { "name": "Get account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "accountNo", "value": "", "type": "query", "description": "Account Number for the Account." }, { "name": "profileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Instructions to fetch AR Account details." } ] }, "docs": "Use this API to search for account receivable type account's detail for given account id.OperationId:getAccount
" }, { "info": { "name": "Update a account receivable account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to update existing account using account id and further detail. Use get account to get account detail prior updating.OperationId:putAccount
" }, { "info": { "name": "Delete Account ", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to delete account detail for given unique account id. Use get accounts to find account id.OperationId:deleteAccount
" }, { "info": { "name": "Add credits to AR invoices", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/applyCreditToInvoices", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to add credits to account receivable invoices.OperationId:postCreditToInvoices
" }, { "info": { "name": "Move credit card payment to account receivable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/arCreditCard/transfer", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to transfer credit card payment transactions to Accounts Receivable.OperationId:transferARCreditCardPayments
" }, { "info": { "name": "Add charges to account receivable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/charges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to post charges to account receivable account.OperationId:postChargesToAR
" }, { "info": { "name": "Create Account Comment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/comments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to add a note for a given account id. Use get accounts to find account id.OperationId:postAccountComment
" }, { "info": { "name": "Change Account Comment", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/comments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to update existing account note. Use get account to find noteidOperationId:putAccountComment
" }, { "info": { "name": "Delete Account Comment", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/comments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "id", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "value", "value": "", "type": "query", "description": "Property Value" }, { "name": "hotel", "value": "", "type": "query", "description": "If specified comment belongs to the Hotel, otherwise it is a global comment." } ] }, "docs": "Use this API to delete notes from a given account id. Use get account with an instruction to get note id.OperationId:deleteAccountComment
" }, { "info": { "name": "Combines Account receivable invoices", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/compressInvoices", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to combine two or more invoices into one invoiceOperationId:compressARInvoices
" }, { "info": { "name": "Copy account receivable account ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/copyAccount", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to create account receivable to multiple hotels by copying from source hotel.OperationId:copyARAccount
" }, { "info": { "name": "Create fixed charges ", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/fixedCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to create fixed charges for a given account id of account receivable. Use get accounts to find an account id.OperationId:postAccountFixedCharge
" }, { "info": { "name": "Update fixed charge detail ", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/fixedCharges/:fixedChargeId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fixedChargeId", "value": "", "type": "path", "description": "ID of the fixed charge" }, { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to update existing fixed charges for a given account receivable.OperationId:putAccountFixedCharge
" }, { "info": { "name": "Delete fixed charges ", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/fixedCharges/:fixedChargeId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "fixedChargeId", "value": "", "type": "path", "description": "ID of the fixed charge" }, { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to delete fixed charges for a given account receivable id. Use getaccounts to find an account id.OperationId:deleteAccountFixedCharge
" }, { "info": { "name": "Get list of account receivable folio printers", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/folioPrinters", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "balance", "value": "", "type": "query" }, { "name": "overrideCreditHoldCheck", "value": "", "type": "query" }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "profileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "accountNo", "value": "", "type": "query", "description": "Account Number for the AR Account." }, { "name": "accountName", "value": "", "type": "query", "description": "Account Name for the AR Account." }, { "name": "guestProfileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "guestProfileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "guestProfileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "folioWindowNo", "value": "", "type": "query" }, { "name": "chargeCashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "chargeTransactionCode", "value": "", "type": "query", "description": "Transaction Code to post." }, { "name": "articleCode", "value": "", "type": "query", "description": "Article ID." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "postingQuantity", "value": "", "type": "query", "description": "Quantity to post to the folio." }, { "name": "postingReference", "value": "", "type": "query", "description": "User-defined posting reference." }, { "name": "postingRemark", "value": "", "type": "query", "description": "User-defined posting remark." }, { "name": "checkNumber", "value": "", "type": "query", "description": "Indicates the Cheque number." }, { "name": "arrangementCode", "value": "", "type": "query", "description": "Corrected arrangement code from the package associated to this transaction." }, { "name": "applyRoutingInstructions", "value": "", "type": "query", "description": "Apply room routing when making this posting." }, { "name": "usePackageAllowance", "value": "", "type": "query", "description": "Use the applicable package allowance when making this posting." }, { "name": "autoPosting", "value": "", "type": "query", "description": "True indicates the Transaction Code is allowed to be posted automatically." }, { "name": "financialTransactionId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "financialTransactionIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "financialTransactionType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "reference", "value": "", "type": "query", "description": "User-defined invoice reference." }, { "name": "remark", "value": "", "type": "query", "description": "User-defined invoice remark." }, { "name": "folioType", "value": "", "type": "query", "description": "Folio Type to be assigned to generated folio. This is a country requirement." }, { "name": "generateFiscalFolio", "value": "", "type": "query", "description": "Fiscal folio flag to call fiscal folio web service after folio generation." }, { "name": "queueName", "value": "", "type": "query", "description": "Folio Queue name." } ] }, "docs": "Use this API to find account receivable folio printersOperationId:getARFolioPrinters
" }, { "info": { "name": "Create account receivable invoices", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/invoices", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to create a new invoice for an AR account.OperationId:postInvoice
" }, { "info": { "name": "Delete transactions for specific AR Invoice Transactions on current business day", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/invoices/:invoiceId/transactions", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "invoiceId", "value": "", "type": "path", "description": "Unique ID of the invoice" } ] }, "docs": "This operation deletes transactions for the specified AR invoice that occurred on the current business day. Only transactions posted on the current business date are eligible. Filtering by specific transaction numbers and providing a valid deletion reason code are required. The response includes processing status and any warnings or errors." }, { "info": { "name": "Generate a statement for a given account receivable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/statements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to generate statement for a given account receivable id. It includes the account balance as of the current business date, an aging summary that shows how long outstanding balances have been \"on the books\" for each aging level set up for given property.OperationId:postStatements
" }, { "info": { "name": "Add a trace to an account receivable account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/traces", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to add a trace for a given account id. Use getaccounts to find account id.OperationId:postAccountTrace
" }, { "info": { "name": "This API facilitates modification of account traces.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/traces", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "OperationId:putAccountTrace
" }, { "info": { "name": "This API facilitates deletion of account traces.", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/traces", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "traceID", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "traceOn", "value": "", "type": "query", "description": "Date of the trace." }, { "name": "traceText", "value": "", "type": "query", "description": "The information this trace contains." } ] }, "docs": "OperationId:deleteAccountTrace
" }, { "info": { "name": "Get account receivable invoice and payment details", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/transactions/:transactionId/invoicePaymentDetails", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "profileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "accountNo", "value": "", "type": "query", "description": "Account Number for the AR Account." }, { "name": "accountName", "value": "", "type": "query", "description": "Account Name for the AR Account." } ] }, "docs": "Use this API to get AR account's invoice and payment details including credit, debit, amount due date, etc.OperationId:getInvoicePaymentDetail
" }, { "info": { "name": "Reverse the compressing invoice process", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/accounts/:accountId/uncompressInvoices", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to reverse compressing account receivable invoices and break single combined invoice into individual invoices.OperationId:uncompressARInvoices
" }, { "info": { "name": "Get given AR account's aging detail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/agingCycles", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to get account receivable profile's aging summary including account name, summary, credit limit, total outstanding balance, etc. per aging bucket.OperationId:getARAgingCycles
" }, { "info": { "name": "Create process to charge on multiple account receivables", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/batchCharges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to create a batch process for simultaneously post a one-time charge to multiple account receivable accounts.OperationId:postBatchCharges
" }, { "info": { "name": "Move direct bills to account receivable", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/directBillsToAR", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to transfer direct bills to account receivable accountOperationId:transferDirectBillsToAr
" }, { "info": { "name": "Update invoice detail.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/invoices", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to update or transfer invoice detail such as amount, transaction code, etc.OperationId:putInvoiceDetails
" }, { "info": { "name": "Update invoice detail.", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/invoices/:invoiceId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "invoiceId", "value": "", "type": "path", "description": "Unique ID of the invoice" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to update or transfer invoice detail such as amount, transaction code, etc.This API is deprecated. Please use putInvoiceDetails instead
OperationId:putInvoice
" }, { "info": { "name": "Get account receivable invoice's payment history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/invoices/:invoiceId/transactions/:transactionId/accounts/:accountId/invoiceAppliedPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "invoiceId", "value": "", "type": "path", "description": "Unique ID of the invoice" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios" } ] }, "docs": "Use this API to get applied payment details for AR invoices.This API is deprecated. Please use getAppliedInvoicePayments instead
OperationId:getInvoiceAppliedPayments
" }, { "info": { "name": "Delete payments from invoice", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/hotels/:hotelId/invoices/:invoiceId/transactions/:transactionId/paymentsFromInvoice", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "invoiceId", "value": "", "type": "path", "description": "Unique ID of the invoice" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "trxNo", "value": "", "type": "query", "description": "Unique Transaction Identifier of the Payment." }, { "name": "accountId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "cashierID", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios" } ] }, "docs": "Delete payments from invoice.This API is deprecated. Please use removePaymentsFromInvoice instead
OperationId:deletePaymentsFromInvoice
" }, { "info": { "name": "Add charges to account receivable", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/accounts/:accountId/charges", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique ID of the profile" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to post charges to account receivable account.This API is deprecated. Please use postChargesToAR instead
OperationId:postARCharges
" }, { "info": { "name": "Add payment to an account receivable account for a list of reservations", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/accounts/:accountId/payments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique ID of the profile" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to make payment to AR accounts for a list of reservations.OperationId:postARPayments
" }, { "info": { "name": "Get given profile's account receivable statements history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/accounts/:accountId/statementsHistory", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique ID of the profile" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "accountNo", "value": "", "type": "query", "description": "Account Number for the AR Account." }, { "name": "accountName", "value": "", "type": "query", "description": "Account Name for the AR Account." }, { "name": "dateSent", "value": "", "type": "query", "description": "History Date filter." }, { "name": "reportFileNameWildCard", "value": "", "type": "query", "description": "Report Name wild card." } ] }, "docs": "Use this API to find the history of statements prepared for AR accounts.OperationId:getStatementsHistory
" }, { "info": { "name": "Reverse Payment", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/hotels/:hotelId/profiles/:profileId/accounts/:accountId/transactions/:transactionId/reversePayment", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "profileId", "value": "", "type": "path", "description": "Unique ID of the profile" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to reverse payment that occurred accidentally or via user error.OperationId:postReversePayment
" }, { "info": { "name": "Get account receivable invoice's payment history", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/transactions/:transactionId/accounts/:accountId/invoiceAppliedPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios" } ] }, "docs": "Use this API to get applied payment details for AR invoices.OperationId:getAppliedInvoicePayments
" }, { "info": { "name": "Get account receivable folios which are paid using credit cards", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/hotels/:hotelId/transactions/:transactionId/creditcard/payments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "transactionId", "value": "", "type": "path", "description": "Unique ID of the transaction" }, { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" }, { "name": "endDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "startDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." } ] }, "docs": "Use this API to get lists of folios for guests who checked out using a credit card payment transaction code that has an account receivable associated with it. It also lists payments made prior to check out if the payment was made using a credit card transaction code that has a an account receivable associated with it.OperationId:getARCreditCardPayments
The maximum allowable limit for this API is 50.
This API allows a time span of 30OperationId:removePaymentsFromInvoice
" }, { "info": { "name": "Unlink invoices from a statement", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/hotels/:hotelId/unlink/invoiceFromStatement", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "path", "description": "Unique ID of the hotel" } ] }, "docs": "Use this API to remove the invoice from the statement before that invoice can be included in a different statement.OperationId:unlinkInvoiceFromStatement
" }, { "info": { "name": "Get payment detail for account's invoices", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/invoicePayments/accounts/:accountId", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Unique ID of the account" }, { "name": "inclDetails", "value": "", "type": "query", "description": "Flag to indicate if Invoice Details are required." }, { "name": "inclZeroBalance", "value": "", "type": "query", "description": "Flag to indicate if Zero Balance Invoices are to be included." }, { "name": "limit", "value": "", "type": "query", "description": "Indicates maximum number of records a Web Service should return." }, { "name": "offset", "value": "", "type": "query", "description": "Index or initial index of the set(page) being requested. If the index goes out of the bounds of the total set count then no data will be returned." }, { "name": "hotelIds", "value": "", "type": "query", "description": "Property where the Accounts exist." }, { "name": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "guestDisplayName", "value": "", "type": "query", "description": "Display Name for the guest." }, { "name": "remark", "value": "", "type": "query", "description": "Filter for User-defined Invoice Supplement. The search is case-insensitive and supports % as wildcard character with right-side wildcard search by default. Examples: ABC or ABC% finds records that start with ABC, such as ABC, ABCDEF, and ABC123. %ABC or %ABC% finds records that contain ABC, such as ABC, ABC123, MYABC, and MYABC123." }, { "name": "reference", "value": "", "type": "query", "description": "Filter for User-defined Invoice Reference. The search is case-insensitive and supports % as wildcard character with right-side wildcard search by default. Examples: ABC or ABC% finds records that start with ABC, such as ABC, ABCDEF, and ABC123. %ABC or %ABC% finds records that contain ABC, such as ABC, ABC123, MYABC, and MYABC123." }, { "name": "invoiceNo", "value": "", "type": "query", "description": "invoice Number ." }, { "name": "addresseeName", "value": "", "type": "query", "description": "Addressee Name filter. Works with the Addressee Functionality." }, { "name": "reservationId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "printed", "value": "", "type": "query", "description": "Flag to check Invoice Statement is Printed." }, { "name": "unBilled", "value": "", "type": "query", "description": "Flag to check Invoice is billed" }, { "name": "folioNo", "value": "", "type": "query", "description": "folio Number ." }, { "name": "fiscalBillNo", "value": "", "type": "query", "description": "Fiscal bill number of this transaction." }, { "name": "statementNo", "value": "", "type": "query", "description": "The Statement number of this invoice." }, { "name": "fetchInstructions", "value": "", "type": "query", "description": "Type of AR Invoice information to fetch the invoices or payments data." }, { "name": "customNumber", "value": "", "type": "query", "description": "Custom number" }, { "name": "orderBy", "value": "", "type": "query", "description": "This represents which information the data will be ordered." }, { "name": "sortOrder", "value": "", "type": "query", "description": "This represents how the invoice payments will be ordered" } ] }, "docs": "Use this API to get payment data for account receivable invoices.OperationId:getInvoicesPayments
The maximum allowable limit for this API is 50.
" }, { "info": { "name": "Get account receivable invoice postings", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/invoicePostings", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "canBeModified", "value": "", "type": "query", "description": "Flag to indicate if postings or adjustments can be made to the invoice." }, { "name": "closeDate", "value": "", "type": "query", "description": "Close date of the invoice." }, { "name": "fiscalBillNo", "value": "", "type": "query", "description": "The Fiscal Bill number of this posting" }, { "name": "folioDate", "value": "", "type": "query", "description": "Date of Folio Generation." }, { "name": "folioNo", "value": "", "type": "query", "description": "Folio Number." }, { "name": "folioStatus", "value": "", "type": "query", "description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status." }, { "name": "folioTypeName", "value": "", "type": "query", "description": "The name of the Folio Type used for the Folio Number sequence." }, { "name": "internalFolioWindowID", "value": "", "type": "query", "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference." }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios" }, { "name": "invoiceType", "value": "", "type": "query" }, { "name": "postingDate", "value": "", "type": "query", "description": "Posting date of the invoice." }, { "name": "revenueDate", "value": "", "type": "query", "description": "Revenue date ID of the invoice." }, { "name": "statementNo", "value": "", "type": "query", "description": "Statementno of the invoice." }, { "name": "status", "value": "", "type": "query", "description": "Status of the invoice." }, { "name": "transferDate", "value": "", "type": "query", "description": "Transfer date of the invoice." }, { "name": "postingTransactionCode", "value": "", "type": "query", "description": "Transaction code of the invoice." }, { "name": "transactionDate", "value": "", "type": "query", "description": "Transaction Date of the invoice." }, { "name": "transactionNo", "value": "", "type": "query", "description": "Unique Transaction Identifier of the Invoice." }, { "name": "cashierId", "value": "", "type": "query", "description": "The Cashier ID of the Cashier who is currently processing the transaction(s)." }, { "name": "hotelId", "value": "", "type": "query", "description": "Property where the invoice exists." }, { "name": "reservationId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "guestProfileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "guestProfileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "guestProfileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "age", "value": "", "type": "query", "description": "The Aging age of the invoice" }, { "name": "guestName", "value": "", "type": "query", "description": "Name of the Guest who consumed these transactions." }, { "name": "originalAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "originalAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "paymentsAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "paymentsCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "balanceAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "balanceCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "reference", "value": "", "type": "query", "description": "User-defined posting reference." }, { "name": "remark", "value": "", "type": "query", "description": "User-defined posting remark." }, { "name": "adjusted", "value": "", "type": "query" }, { "name": "parentInvoiceNo", "value": "", "type": "query" }, { "name": "compressed", "value": "", "type": "query" }, { "name": "compressedDate", "value": "", "type": "query" }, { "name": "transferredOut", "value": "", "type": "query" }, { "name": "transferredIn", "value": "", "type": "query" }, { "name": "marketDescription", "value": "", "type": "query" }, { "name": "marketHotelId", "value": "", "type": "query" }, { "name": "marketCode", "value": "", "type": "query" }, { "name": "marketGroup", "value": "", "type": "query" }, { "name": "roomClassDescription", "value": "", "type": "query" }, { "name": "roomClassHotelId", "value": "", "type": "query" }, { "name": "roomClassCode", "value": "", "type": "query" }, { "name": "sourceDescription", "value": "", "type": "query" }, { "name": "sourceHotelId", "value": "", "type": "query" }, { "name": "sourceCode", "value": "", "type": "query" }, { "name": "sourceGroup", "value": "", "type": "query" }, { "name": "cashierInfoCashierId", "value": "", "type": "query", "description": "Cashier Id of the Cashier." }, { "name": "cashierName", "value": "", "type": "query", "description": "Cashier Name." }, { "name": "transactionHotelId", "value": "", "type": "query", "description": "Hotel context of the Transaction code." }, { "name": "printTrxReceipt", "value": "", "type": "query", "description": "Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code." }, { "name": "invoicePostingsTransactionCode", "value": "", "type": "query", "description": "Unique identifier for the Transaction code." }, { "name": "transactionDescription", "value": "", "type": "query", "description": "Transaction codes info." }, { "name": "transactionGroup", "value": "", "type": "query", "description": "Category of the transaction code." }, { "name": "transactionSubGroup", "value": "", "type": "query", "description": "Sub category of the transaction code." }, { "name": "universalProductCode", "value": "", "type": "query", "description": "Unique Universal product code of the transaction code." }, { "name": "routingInstructionsId", "value": "", "type": "query", "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer." }, { "name": "articleCode", "value": "", "type": "query", "description": "Unique code of the article." }, { "name": "articleHotelIds", "value": "", "type": "query", "description": "Hotel code to which the article belongs." }, { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether the article is inactive or not." }, { "name": "orderSequence", "value": "", "type": "query", "description": "Display Order sequence." }, { "name": "articleDescription", "value": "", "type": "query", "description": "Description of the article." }, { "name": "transactionCode", "value": "", "type": "query", "description": "Transaction code to which the article belongs." }, { "name": "articleAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "articleCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "availableForPostIt", "value": "", "type": "query", "description": "Indicates whether the article is available for post it." }, { "name": "color", "value": "", "type": "query", "description": "Color configuration type. This color configuration provides a visual category of entities." }, { "name": "articleUniversalProductCode", "value": "", "type": "query", "description": "Unique Universal product code of the article." }, { "name": "attachCreditCardToProfile", "value": "", "type": "query", "description": "Attach the credit card to profile." }, { "name": "cardHolderName", "value": "", "type": "query" }, { "name": "cardNumber", "value": "", "type": "query" }, { "name": "cardNumberLast4Digits", "value": "", "type": "query" }, { "name": "cardNumberMasked", "value": "", "type": "query" }, { "name": "cardOrToken", "value": "", "type": "query", "description": "Simple type for indicating if credit card number is tokenized." }, { "name": "cardType", "value": "", "type": "query", "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method." }, { "name": "expirationDate", "value": "", "type": "query", "description": "Expiration date of the credit card" }, { "name": "expirationDateExpired", "value": "", "type": "query" }, { "name": "expirationDateMasked", "value": "", "type": "query", "description": "Masked Expiration date of the credit card" }, { "name": "processing", "value": "", "type": "query" }, { "name": "swiped", "value": "", "type": "query" }, { "name": "userDefinedCardType", "value": "", "type": "query", "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided" }, { "name": "cardId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "PaymentCardIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "paymentCardIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "currentAuthorizedAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currentAuthorizedAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "approvalAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "approvalAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "addresseeType", "value": "", "type": "query", "description": "Defines the type of Linked profiles for a block." }, { "name": "addressProfileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "addressProfileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "addressProfileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "name", "value": "", "type": "query", "description": "Name for the profile attached to the block." }, { "name": "city", "value": "", "type": "query", "description": "City for the profile attached to the block." }, { "name": "phone", "value": "", "type": "query", "description": "Phone for the profile attached to the block." }, { "name": "allowPartialTransferYn", "value": "", "type": "query", "description": "Flag to check partial Transfer Allowed." }, { "name": "printed", "value": "", "type": "query", "description": "Flag to check Invoice Statement is Printed." }, { "name": "printedDate", "value": "", "type": "query", "description": "Invoice Statement Printed Date." }, { "name": "storedFolioId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "storedFolioIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "storedFolioType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "storedFolioName", "value": "", "type": "query", "description": "Name of the Stored Folio." }, { "name": "storedDebitFolioId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "storedDebitFolioIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "storedDebitFolioType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "storedDebitFolioName", "value": "", "type": "query", "description": "Name of the Stored Debit Folio." }, { "name": "accountId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "accountIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "accountType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "accountNo", "value": "", "type": "query", "description": "The Account Number for the Account." }, { "name": "profileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "additionalFilterCashierId", "value": "", "type": "query", "description": "Cashier Id of the Cashier." }, { "name": "additionalFilterTransactionCode", "value": "", "type": "query" }, { "name": "additionalFilterTransactionSubGroupCode", "value": "", "type": "query" }, { "name": "end", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "start", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "referenceWildCard", "value": "", "type": "query", "description": "Filters the results for reference." }, { "name": "supplementWildCard", "value": "", "type": "query", "description": "Filter the results for supplement." }, { "name": "checkNumberWildCard", "value": "", "type": "query", "description": "Lookup string which will try to match an existing Cheque number's." } ] }, "docs": "Use this API to get account receivable postings.OperationId:getInvoicePostings
This API allows a time span of 30 days.
" }, { "info": { "name": "Close account receivable invoices", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/invoices/close", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to close (\"freeze\") one or more selected invoices at any point after they have been created. When an invoice has been closed, no new postings to the invoice can be made, transaction reference or supplemental information can be edited, or adjustments to transaction codes can be made. However, payments can be posted to an invoice after it has been closed.OperationId:putInvoices
" }, { "info": { "name": "Change Account receivable invoice for an AR account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/invoicesAccount", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to update existing AR invoice for a given profile and/or a reservation.OperationId:putARInvoicesAccount
" }, { "info": { "name": "Add old balances from external accounting systems", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/oldBalances", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to add old balances from external accounting systems into OPERA Accounts Receivable.OperationId:postAROldBalances
" }, { "info": { "name": "Get given profile's aging detail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/aging", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Unique ID of the profile" }, { "name": "currency", "value": "", "type": "query", "description": "Currency of the aging amounts." }, { "name": "hotelIds", "value": "", "type": "query" } ] }, "docs": "Use this API to get profile's account receivable summary including fixed charges, account balance, statements, reminder history, etc.OperationId:getProfileAging
" }, { "info": { "name": "Get given profile's yearly account receivable detail", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/profiles/:profileId/yearViews", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "profileId", "value": "", "type": "path", "description": "Unique ID of the profile" }, { "name": "currency", "value": "", "type": "query", "description": "Currency of the Year View amounts." }, { "name": "hotelIds", "value": "", "type": "query" } ] }, "docs": "Use this API to get a month-by-month total of accrued debits, accrued credits, and a net total for the selected account data.OperationId:getProfileYearView
" }, { "info": { "name": "Reopen account receivable closed invoice", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/reopenInvoices", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to unfreeze or reopen invoice for account receivable.OperationId:reopenInvoices
" }, { "info": { "name": "Check account receivable service status", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/services/accountReceivables/status", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to check account receivable service status.OperationId:pingAccountsReceivableService
" }, { "info": { "name": "Get given profile's account receivable statements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/statements", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ], "params": [ { "name": "hotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "profileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "profileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "profileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "accountID", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "accountNo", "value": "", "type": "query", "description": "Account Number for the AR Account." }, { "name": "accountName", "value": "", "type": "query", "description": "Account Name for the AR Account." }, { "name": "canBeModified", "value": "", "type": "query", "description": "Flag to indicate if postings or adjustments can be made to the invoice." }, { "name": "closeDate", "value": "", "type": "query", "description": "Close date of the invoice." }, { "name": "fiscalBillNo", "value": "", "type": "query", "description": "The Fiscal Bill number of this posting" }, { "name": "folioDate", "value": "", "type": "query", "description": "Date of Folio Generation." }, { "name": "folioNo", "value": "", "type": "query", "description": "Folio Number." }, { "name": "folioStatus", "value": "", "type": "query", "description": "The Folio Status Example: DEPOSIT folio, VOID folio or the default OK folio status." }, { "name": "folioTypeName", "value": "", "type": "query", "description": "The name of the Folio Type used for the Folio Number sequence." }, { "name": "internalFolioWindowID", "value": "", "type": "query", "description": "Internal window ID which is unique to the reservation. This ID can only be used for reference." }, { "name": "invoiceNo", "value": "", "type": "query", "description": "Invoice No after the folio is generated. Same invoice number may be referred in multiple folios" }, { "name": "invoiceType", "value": "", "type": "query" }, { "name": "postingDate", "value": "", "type": "query", "description": "Posting date of the invoice." }, { "name": "revenueDate", "value": "", "type": "query", "description": "Revenue date ID of the invoice." }, { "name": "statementNo", "value": "", "type": "query", "description": "Statementno of the invoice." }, { "name": "status", "value": "", "type": "query", "description": "Status of the invoice." }, { "name": "transferDate", "value": "", "type": "query", "description": "Transfer date of the invoice." }, { "name": "invoiceTransactionCode", "value": "", "type": "query", "description": "Transaction code of the invoice." }, { "name": "transactionDate", "value": "", "type": "query", "description": "Transaction Date of the invoice." }, { "name": "transactionNo", "value": "", "type": "query", "description": "Unique Transaction Identifier of the Invoice." }, { "name": "invoiceHotelIds", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "reservationId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "reservationIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "reservationType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "guestProfileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "guestProfileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "guestProfileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "age", "value": "", "type": "query", "description": "The Aging age of the invoice" }, { "name": "guestName", "value": "", "type": "query", "description": "Name of the Guest who consumed these transactions." }, { "name": "originalAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "originalAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "amount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "paymentsAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "paymentsCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "balanceAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "balanceCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "reference", "value": "", "type": "query", "description": "User-defined posting reference." }, { "name": "remark", "value": "", "type": "query", "description": "User-defined posting remark." }, { "name": "adjusted", "value": "", "type": "query" }, { "name": "parentInvoiceNo", "value": "", "type": "query" }, { "name": "compressed", "value": "", "type": "query" }, { "name": "compressedDate", "value": "", "type": "query" }, { "name": "transferredOut", "value": "", "type": "query" }, { "name": "transferredIn", "value": "", "type": "query" }, { "name": "marketDescription", "value": "", "type": "query" }, { "name": "marketHotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "marketCode", "value": "", "type": "query" }, { "name": "marketGroup", "value": "", "type": "query" }, { "name": "roomClassDescription", "value": "", "type": "query" }, { "name": "roomClassHotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "roomClassCode", "value": "", "type": "query" }, { "name": "sourceDescription", "value": "", "type": "query" }, { "name": "sourceHotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "sourceCode", "value": "", "type": "query" }, { "name": "sourceGroup", "value": "", "type": "query" }, { "name": "cashierId", "value": "", "type": "query", "description": "Cashier Id of the Cashier." }, { "name": "cashierName", "value": "", "type": "query", "description": "Cashier Name." }, { "name": "transactionHotelId", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "printTrxReceipt", "value": "", "type": "query", "description": "Print receipt flag that tells whether the transaction receipt is to be printed or not. This is based on the transaction code." }, { "name": "accountInvoiceTransactionCode", "value": "", "type": "query", "description": "Unique identifier for the Transaction code." }, { "name": "transactionDescription", "value": "", "type": "query", "description": "Transaction codes info." }, { "name": "transactionGroup", "value": "", "type": "query", "description": "Category of the transaction code." }, { "name": "transactionSubGroup", "value": "", "type": "query", "description": "Sub category of the transaction code." }, { "name": "universalProductCode", "value": "", "type": "query", "description": "Unique Universal product code of the transaction code." }, { "name": "routingInstructionsId", "value": "", "type": "query", "description": "This is the Routing Instruction Id attached with Reservation. It is only used for internal purpose. It should not be used by external vendor or consumer." }, { "name": "articleCode", "value": "", "type": "query", "description": "Unique code of the article." }, { "name": "articleHotelIds", "value": "", "type": "query", "description": "Property where the AR Account exists. This is required." }, { "name": "inactive", "value": "", "type": "query", "description": "Indicates whether the article is inactive or not." }, { "name": "orderSequence", "value": "", "type": "query", "description": "Display Order sequence." }, { "name": "articleDescription", "value": "", "type": "query", "description": "Description of the article." }, { "name": "transactionCode", "value": "", "type": "query", "description": "Transaction code to which the article belongs." }, { "name": "articleAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "articleCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "availableForPostIt", "value": "", "type": "query", "description": "Indicates whether the article is available for post it." }, { "name": "color", "value": "", "type": "query", "description": "Color configuration type. This color configuration provides a visual category of entities." }, { "name": "articleUniversalProductCode", "value": "", "type": "query", "description": "Unique Universal product code of the article." }, { "name": "attachCreditCardToProfile", "value": "", "type": "query", "description": "Attach the credit card to profile." }, { "name": "cardHolderName", "value": "", "type": "query" }, { "name": "cardNumber", "value": "", "type": "query" }, { "name": "cardNumberLast4Digits", "value": "", "type": "query" }, { "name": "cardNumberMasked", "value": "", "type": "query" }, { "name": "cardOrToken", "value": "", "type": "query", "description": "Simple type for indicating if credit card number is tokenized." }, { "name": "cardType", "value": "", "type": "query", "description": "This is required for Credit Card Payment Methods. This indicates the type of Credit Card associated with this payment method." }, { "name": "expirationDate", "value": "", "type": "query", "description": "Expiration date of the credit card" }, { "name": "expirationDateExpired", "value": "", "type": "query" }, { "name": "expirationDateMasked", "value": "", "type": "query", "description": "Masked Expiration date of the credit card" }, { "name": "processing", "value": "", "type": "query" }, { "name": "swiped", "value": "", "type": "query" }, { "name": "userDefinedCardType", "value": "", "type": "query", "description": "Indicates the user defined credit card type if credit card type from a defined list is not provided" }, { "name": "invoicePaymentCardId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "invoicePaymentCardIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "invoicePaymentCardIdType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "currentAuthorizedAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "currentAuthorizedAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "approvalAmount", "value": "", "type": "query", "description": "A monetary amount." }, { "name": "approvalAmountCurrencyCode", "value": "", "type": "query", "description": "Provides a currency code to reflect the currency in which an amount may be expressed." }, { "name": "type", "value": "", "type": "query", "description": "Defines the type of Linked profiles for a block." }, { "name": "addresseeProfileId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "addresseeProfileIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "addresseeProfileType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "name", "value": "", "type": "query", "description": "Name for the profile attached to the block." }, { "name": "city", "value": "", "type": "query", "description": "City for the profile attached to the block." }, { "name": "phone", "value": "", "type": "query", "description": "Phone for the profile attached to the block." }, { "name": "allowPartialTransferYn", "value": "", "type": "query", "description": "Flag to check partial Transfer Allowed." }, { "name": "printed", "value": "", "type": "query", "description": "Flag to check Invoice Statement is Printed." }, { "name": "printedDate", "value": "", "type": "query", "description": "Invoice Statement Printed Date." }, { "name": "storedFolioId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "storedFolioIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "storedFolioType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "storedFolioName", "value": "", "type": "query", "description": "Name of the Stored Folio." }, { "name": "storedDebitFolioId", "value": "", "type": "query", "description": "A unique identifying value assigned by the creating system. The ID attribute may be used to reference a primary-key value within a database or in a particular implementation." }, { "name": "storedDebitFolioIdContext", "value": "", "type": "query", "description": "Used to identify the source of the identifier (e.g., IATA, ABTA)." }, { "name": "storedDebitFolioType", "value": "", "type": "query", "description": "A reference to the type of object defined by the UniqueID element." }, { "name": "storedDebitFolioName", "value": "", "type": "query", "description": "Name of the Stored Debit Folio." }, { "name": "balanceForwardDate", "value": "", "type": "query", "description": "The date specified in this field determines the balance forward date and balance forward total that is printed on the statement. (A balance forward shows the net amount for all invoices and payments (debits and credits) prior to the balance forward date as a single total, rather than itemizing them individually on the statement.)" }, { "name": "inclFolios", "value": "", "type": "query", "description": "Flag to indicate if the associated Folios for the Invoices are to be included along with the the Statement." }, { "name": "inclPrinted", "value": "", "type": "query", "description": "Flag to indicate if previously Printed Invoices are to be included in the Statement. This is based on the Functionality for AR PRINTED INVOICES." }, { "name": "inclZero", "value": "", "type": "query", "description": "Flag to indicate if Zero Balances Invoices are to be included in the Statement." }, { "name": "filterEndDate", "value": "", "type": "query", "description": "The ending value of the date range." }, { "name": "filterStartDate", "value": "", "type": "query", "description": "The starting value of the date range." }, { "name": "statementText", "value": "", "type": "query", "description": "Text which will be printed on the Invoice." } ] }, "docs": "Use this API to prepare statement for an AR account holders. It is typically prepared for billing purposes.OperationId:getARStatements
" }, { "info": { "name": "Move an invoice or a payment to another AR account", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/transferInvoicesAndPayments", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to move all or a portion of an invoice or a payment from one AR account to another AR accountOperationId:transferInvoicesAndPayments
" }, { "info": { "name": "Transfer postings", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/transferPostings", "headers": [ { "name": "authorization", "value": "" }, { "name": "externalData", "value": "" }, { "name": "x-app-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-originating-application", "value": "" }, { "name": "x-hotelid", "value": "" }, { "name": "x-externalsystem", "value": "" }, { "name": "Accept-Language", "value": "" } ] }, "docs": "Use this API to transfer postings from one account receivable invoice to another account receivable invoice.OperationId:transferPostings
" } ] } ], "bundled": true }