AbaNumbers

Banks

APIDescription
GET api/abanumbers

GET: api/abanumbers Get All Aba numbers

GET api/abanumbers/{abaId}/bankcodes

Get bankCodes by abaId

POST api/abanumbers

Insert new ABANumber

PUT api/abanumbers/migrate

Migrates aba number to another bank

PUT api/abanumbers

Update an ABANumber

DELETE api/abanumbers/{id}

Delete an ABANumber

PUT api/abanumbers/delete

Delete an ABANumbers

AccountingPeriodCode

AccountingPeriodCodeController

APIDescription
GET api/accountperiodcode

GET: api/accountingperiodcodes

AccountType

AccountTypeController

APIDescription
GET api/accounttypes/{id}

GET: api/accounttypes/{id} Get the item information by the Id

GET api/accounttypes

GET: api/accounttypes

POST api/accounttypes

Insert a new AccountType

PUT api/accounttypes

Update a AccountType. Returns Conflict (409) if the object is being referenced and updateReferences is set to false.

DELETE api/accounttypes/{accountTypeId}?updateReferences={updateReferences}

Delete an AccountType. Returns Conflict (409) if the object is being referenced and updateReferences is set to false.

AccountUse

AccountUseController

APIDescription
GET api/accountUses/{id}

GET: api/accountuses/{id} Get the item information by the Id

GET api/accountUses

GET: api/accountuses

POST api/accountUses

Insert a new AccountUse

PUT api/accountUses

Update an AccountUse. Returns Conflict (409) if the object is being referenced and updateReferences is set to false.

DELETE api/accountUses/{accountUseId}?updateReferences={updateReferences}

Delete an AccountUse. Returns Conflict (409) if the object is being referenced and updateReferences is set to false.

AdjustedCodeType

ChargeCodeTypeController

APIDescription
GET api/adjustedcodetypes

GET: api/AdjustedCodeTypes

PUT api/adjustedcodetypes/update

GET: api/AdjustedCodeTypes

GET api/adjustedcodetypesaudittrails

No documentation available.

GET api/adjustedcodetypesnotes

Get AdjustedCodeTypes Notes

POST api/adjustedcodetypesnotes

Create user note

ArReceiptType

ArReceiptTypeController

APIDescription
GET api/arreceipttypes

GET: api/arreceipttypes Get the list of item

GET api/arreceipttypes/{id}

GET: api/arreceipttypes/{id} Get the item information by the Id

ATB

ATB Controller

APIDescription
GET api/atb/getByBankId?bankId={bankId}

Get ATB by Bank Id

GET api/atb

Get all automated transactional banks

Audience

Controller to expose endpoints to Audience

APIDescription
GET api/audiences

No documentation available.

BAIFiles

APIDescription
GET api/baifiles/importresults?executionId={executionId}

No documentation available.

BaiTransactions

APIDescription
GET api/bai/{bankRecId}/unmatched/{transactionType}

Get all unmatched bai details

POST api/bai/{bankRecId}/manualMatchedBaiToCamAcct

Manual match one transaction to multiple bai details

POST api/bai/{bankRecId}/manualMatchedCamAcctToBai

Manual match one bai detail to multiple transactions

POST api/bai/unreconcileBaiManualMatch

Un match bai details

BaiTransactionsOld

APIDescription
GET api/bai/checks/unmatched?bankReconciliationId={bankReconciliationId}

No documentation available.

GET api/bai/checks/matched/bookadjustments?bankReconciliationId={bankReconciliationId}

No documentation available.

GET api/bai/checks/matched/jecashlines?bankReconciliationId={bankReconciliationId}

No documentation available.

GET api/bai/deposits/unmatched?bankReconciliationId={bankReconciliationId}

No documentation available.

GET api/bai/deposits/matched/bookadjustments?bankReconciliationId={bankReconciliationId}

No documentation available.

GET api/bai/deposits/matched/journalentries?bankReconciliationId={bankReconciliationId}

No documentation available.

POST api/bai/{baiTransactionId}/match

No documentation available.

POST api/bai/checks/{checkId}/match

No documentation available.

POST api/bai/deposits/{depositId}/match

No documentation available.

POST api/bai/nsf/{reversalId}/match

No documentation available.

POST api/bai/debitmemo/{debitMemoId}/match

No documentation available.

POST api/bai/checks/unmatch

No documentation available.

POST api/bai/deposits/unmatch

No documentation available.

POST api/bai/debitmemo/unmatch

No documentation available.

POST api/bai/jecashline/{jeCashLineId}/match

No documentation available.

POST api/bai/jecashline/unmatch

No documentation available.

BalanceSheetSchedule

BalanceSheetScheduleController

APIDescription
GET api/balancesheetschedules/{id}

GET: api/balancesheetschedules/{id} Get the item information by the Id

GET api/balancesheetschedules/type/{typeId}/entity/{entityId}

GET: api/balancesheetschedules/type/{typeId}/entity/{entityId}

GET api/balancesheetschedules/{id}/detail?pageNumber={pageNumber}&pageSize={pageSize}&sortBy={sortBy}&isSortingAscending={isSortingAscending}

GET api/balancesheetschedules/{id}/summary

POST api/balancesheetschedules/balance-sheet/export

exports to csv

BalanceSheetScheduleType

BalanceSheetScheduleTypeController

APIDescription
GET api/balancesheetscheduletypes/{id}

GET: api/balancesheetscheduletypes/{id} Get the item information by the Id

GET api/balancesheetscheduletypes

GET: api/balancesheetscheduletypes

BankCodeAuthorizedSigner

BankCodesAuthorizedSignerController

APIDescription
GET api/bankCodes/{bankCodeId}/authorizedSigners

No documentation available.

POST api/bankCodes/{bankCodeId}/authorizedSigners

Insert an authorized signer

PUT api/bankcodesauthorizedsigners/delete

Delete an authorized signer

BankCodes

Bank Codes

APIDescription
GET api/bankcodes/{bankCodeId}?navigationLinkId={navigationLinkId}

GET: api/BankCodes/{bankCodeId}

GET api/bankcodes

GET: api/BankCodes/

POST api/bankcodes

Route for creating bank code

PUT api/bankcodes/{id}

Route for updating bank code.

GET api/bankcodes/{id}/audittrails

Get audittrail by bankcode id

GET api/bankcodes/{id}/notes

Get bankcode notes

POST api/bankcodes/{id}/notes

Insert bankcode user note

GET api/bankcodes/{bankCodeId}/payments/summary?asOfDate={asOfDate}

load summary data for the bankCode

GET api/entities/{entityId}/bankcodes/invoices?asOfDate={asOfDate}&activesOnly={activesOnly}&transactionalBanksOnly={transactionalBanksOnly}&transactionalAccountsOnly={transactionalAccountsOnly}

POST api/bankcodes/password/verification

Password verification

BankCodesUsability

APIDescription
GET api/superentities/{superEntityId}/bankcodeusabilities

Get bank code usabilities by super entity id

BankReconciliation

APIDescription
DELETE api/bankrec/{bankRecId}

No documentation available.

GET api/bankrec/{bankCodeId}/searchPrevCurrStatements?bankAccountNumber={bankAccountNumber}

No documentation available.

GET api/bankrec/bankCode/{bankCodeId}/reconciliations/completed?bankAccountNumber={bankAccountNumber}

Obtain the list of completed bankreconciliation

PUT api/bankrec/{bankRecId}/statementendingbalance/{endingBalance}

Set EndingBalance by bank reconciliarion Id

GET api/bankrec/{bankRecId}/withdrawals?transactionStatus={transactionStatus}

Get AP Withdrawal transactions by bank reconciliarion Id

GET api/bankrec/{bankRecId}/Summary/ReconciledWithdrawals

Get Total Amount Withdrawal Reconciled by bank reconciliarion Id

GET api/bankrec/{bankRecId}/deposits?transactionStatus={transactionStatus}

Get AR Deposit transactions by bank reconciliarion Id

GET api/bankrec/{bankRecId}/bankrectransactions?transactionStatus={transactionStatus}

Get all bank reconciliation transactions by Bank Reconciliation Id

POST api/bankrec/{bankRecId}/check/{checkId}/reconcile

Reconcile a Check by Bank Reconciliation Id

POST api/bankrec/createBankReconciliation

Create Bank Reconciliation

POST api/bankrec/{bankRecId}/ReconcileAllBaiAutomatch

Reconciled all AutoMatch

POST api/bankrec/check/{checkId}/unreconcile

Unreconcile a Check

POST api/bankrec/{bankRecId}/cashlines/{cashLineId}/reconcile

Reconcile a Journal Entry line Item

POST api/bankrec/cashlines/{cashLineId}/unreconcile

Unreconcile a Journal Entry line Item

POST api/bankrec/{bankRecId}/receipt/{receiptId}/reconcile

Reconcile a Receipt Deposit

POST api/bankrec/receipt/{receiptId}/unreconcile

Unreconcile a Receipt Deposit

POST api/bankrec/{bankRecId}/debitmemo/{debitMemoId}/reconcile

Reconcile a Debit Memo Deposit

POST api/bankrec/debitmemo/{debitMemoId}/unreconcile

Unreconcile a Debit Memo Deposit

POST api/bankrec/{bankRecId}/unreconcileall?type={type}

Unreconcile all filter by [DEPOSIT, WITHDRAWAL, ALL]

POST api/bankrec/{bankRecId}/reconcileall?type={type}

Reconcile all filter by [DEPOSIT, WITHDRAWAL, ALL]

POST api/bankrec/{bankRecId}/reconcile

Reconcile transactions based on the data provided as a result of the bank reconciliation filter

POST api/bankrec/{bankRecId}/unreconcile

Ureconcile transactions based on the data provided as a result of the bank reconciliation filter

GET api/bankrec/{bankRecId}/{entityId}/summary/accountbalance

Summary Account Balance of a Bank Rec

GET api/bankrec/{bankRecId}/summary/bookadjustment

Summary of Book Adjustment

GET api/bankrec/{bankRecId}/summary/depositInTransit

Summary amount deposit in transit of Book Adjustment

GET api/bankrec/{bankRecId}/summary/outstandingChecks

Summary amount outstanding checks

GET api/bankrec/{bankRecId}/summary/depositJEsInTransit

Summary amount deposit JEs in transit

GET api/bankrec/{bankRecId}/summary/withdrawalJEsInTransit

Summary amount withdrawal JEs in transit

GET api/bankrec/{bankRecId}/summary/bankadjustment

Summary of Bank Adjustment

PUT api/bankrec/{bankRecId}/bankadjustment

Update list of Bank Adjustments

PUT api/bankrec/{bankRecId}/bookadjustment

Update list of Book Adjustments

GET api/bankrec/{bankRecId}/bookadjustment

Get List of Book Adjustment(Not Marked For Reversal) given a bank Rec Id

GET api/bankrec/{bankRecId}/Summary/ReconciledDeposits

Get Total Amount Deposits Reconciled by bank reconciliarion Id

POST api/bankrec/{bankRecId}/finalize

Finalize the bank reconciliarion by bank reconciliarion Id

POST api/bankrec/reopen

Reopens the Bank Reconciliation by Bank Reconciliation Id and Bank Code id

GET api/bankrec/{bankRecId}/report?entityId={entityId}&includeReconciledItems={includeReconciledItems}

Execute bank reconciliation report

BankReconciliationAdjustments

APIDescription
GET api/bankreconciliations/adjustments/book/proposedjournalentries?bankRecId={bankRecId}

No documentation available.

GET api/bankreconciliations/adjustments/books/{bankReconciliationId}

No documentation available.

POST api/bankreconciliations/adjustments/book

No documentation available.

POST api/bankreconciliations/adjustments/books

No documentation available.

POST api/bankreconciliations/adjustments/books/update

No documentation available.

GET api/bankreconciliations/adjustments/bank/totaladjustmentsamount?bankRecId={bankRecId}

No documentation available.

POST api/bankreconciliations/adjustments/bank

No documentation available.

GET api/bankreconciliations/adjustments/banks/{bankReconciliationId}

No documentation available.

POST api/bankreconciliations/adjustments/banks/update

No documentation available.

BankReconciliationAudit

BankStatementFileNewController

APIDescription
GET api/bank-codes/{bankCodeId}/bank-reconciliations-audit-trails

GetBankCodeAuditTrail

BankReconciliationNotification

Bank Reconcilliation notification controller

APIDescription
POST api/bankrec/{bankRecId}/notifications/super-entity/{superEntityId}/email/review

Send email to reviewers

BankReconciliationsOld

APIDescription
GET api/bankreconciliations/{bankRecId}

No documentation available.

GET api/bankreconciliations/{bankRecByBankCodeAndDate}?bankCodeId={bankCodeId}&date={date}

No documentation available.

DELETE api/bankreconciliations/{bankRecId}

No documentation available.

GET api/bankreconciliations/searchPrevCurrStatements?bankCodeId={bankCodeId}&bankAccountNumber={bankAccountNumber}

No documentation available.

GET api/bankreconciliations/searchBankReconciliations?bankCodeId={bankCodeId}&bankAccountNumber={bankAccountNumber}&bankReconciliationStatus={bankReconciliationStatus}

No documentation available.

GET api/bankreconciliations/baiAccountBalance?bankCodeId={bankCodeId}&bankAccountNumber={bankAccountNumber}&endDate={endDate}

No documentation available.

GET api/bankreconciliations/latscompleted?bankCodeId={bankCodeId}

No documentation available.

GET api/bankreconciliations/{bankRecId}/summary

No documentation available.

GET api/bankreconciliations/{bankRecId}/transactions/quantity-summary

No documentation available.

GET api/bankreconciliations/{bankRecId}/finalize/summary

No documentation available.

GET api/bankreconciliations/{bankRecId}/deposits/summary

No documentation available.

GET api/bankreconciliations/{bankRecId}/withdrawals/summary

No documentation available.

POST api/bankreconciliations

No documentation available.

POST api/bankreconciliations/reopen

No documentation available.

POST api/bankreconciliations/{bankRecId}/finalize

No documentation available.

POST api/bankreconciliations/{bankRecId}/updateEndingBalance?newEndingBalance={newEndingBalance}

No documentation available.

GET api/bankreconciliations/report?includeSummary={includeSummary}&includeOutstandingInSummary={includeOutstandingInSummary}&includeReconciledWithdrawals={includeReconciledWithdrawals}&includeOutstandingWithdrawals={includeOutstandingWithdrawals}&includeReconciledDeposits={includeReconciledDeposits}&includeOutstandingDeposits={includeOutstandingDeposits}&includeJournalEntries={includeJournalEntries}&includeReconciledCreditJournalEntryLines={includeReconciledCreditJournalEntryLines}&includeUnreconciledCreditJournalEntryLines={includeUnreconciledCreditJournalEntryLines}&includeReconciledDebitJournalEntryLines={includeReconciledDebitJournalEntryLines}&includeUnreconciledDebitJournalEntryLines={includeUnreconciledDebitJournalEntryLines}&bankReconciliationId={bankReconciliationId}&entityNumber={entityNumber}

No documentation available.

POST api/bankreconciliations/{bankRecId}/defaultreconciliation

No documentation available.

Banks

Banks

APIDescription
GET api/banks?abaNumber={abaNumber}&countryCode={countryCode}&active={active}&hasBankStatementFolder={hasBankStatementFolder}

GET: api/banks

GET api/banks/{id}

Get Bank By IDbanks

GET api/banks/{id}/details

Get Bank Details By ID

GET api/banks/{id}/audittrails

Get audittrail by bank id

POST api/banks

Insert a new Bank

PUT api/banks/{id}

Update a Bank

GET api/banks/{id}/notes

Get bank notes

POST api/banks/{id}/notes

Insert bank user note

BankStatementFile

BankStatementFileNewController

APIDescription
GET api/bankstatementfile/{statementId}/DataFile

Get data file of a BankStatementFile

GET api/bankstatementfile/bankreconciliation/{bankReconciliationId}/unmatchedfiles

GET: api/GetUnmatched Get the list of BankStatementFile available to do the manual match The files returned are the unmatched for a specific bank and the ones that are in the unknown folder

POST api/bankstatementfile/{statementFileId}/unmatch

Unmatch bank statement file

POST api/bankstatementfile/{statementFileId}/match/{bankReconciliationId}

Match bank statement file to a Bank Reconciliation

POST api/bankstatementfile/uploadAndMatch/{bankReconciliationId}

Upload and Match bank statement file to a Bank Reconciliation

BankStatementFileOld

BankStatementFileController

APIDescription
GET api/bankstatementfile/{id}

GET: api/bankstatementfiles/{id} Get the item information by the Id

GET api/bankstatementfile

GET: api/bankstatementfiles

POST api/bankstatementfile

Insert a new BankStatementFile

POST api/bankstatementfile/match

Performs bank statement file matching

POST api/bankstatementfile/unmatch?statementFileId={statementFileId}

Unmatch bank statement file

GET api/bankstatementfile/GetBankStatementFile?bankCodeId={bankCodeId}&currentDate={currentDate}

GET: api/GetBankStatementFile Get a BankStatementFile information

GET api/bankstatementfile/GetUnmatchedByBank?bankCodeId={bankCodeId}

No documentation available.

GET api/bankstatementfile/GetUnmatched

No documentation available.

GET api/bankstatementfile/{statementId}/StatementPdf

Download a byte array with the BankStatementFile pdfs information

DELETE api/bankstatementfile/delete?statementFileId={statementFileId}

Delete Unmatched bank statement file

POST api/bankstatementfile/upload?BankFolderId={BankFolderId}&BatchId={BatchId}

Uploads bank statement files

PUT api/bankstatementfile/updatebankrec?statementFileId={statementFileId}&bankRecId={bankRecId}

Update bank reconciliation id in bank statement file

BankStatementFolder

BankStatementFolderController

APIDescription
GET api/bankstatementfolder

GET: api/bankstatementfolder

Batches

Batch Controller

APIDescription
POST api/batches/charge-credit-inquiry

Returns charge and credit batches

POST api/batches/cash-inquiry

Returns cash batches

POST api/batches/debit-memo-inquiry

Returns debit memos

POST api/batches/debit-memo-inquiry/export

exports to csv

POST api/batches/charge-credit-inquiry/export

exports to csv

POST api/batches/cash-inquiry/export

exports to csv

BatchStatus

Batch Status

APIDescription
GET api/batchstatuses

GET: Batch Status

BillingTransactions

APIDescription
POST api/billingtransactionsbatch

Creates charges/credits from billing transaction records (billing transaction records comes from connect) List of transactions in view model can't be null or empty.

BillMethod

BillMethodController

APIDescription
GET api/billmethods/{id}

GET: api/billmethods/{id} Get the item information by the Id

GET api/billmethods

GET: api/billmethods

BoardApproval

BoardApprovalController

APIDescription
GET api/boardapproval

GET: api/boardapproval Get All BoardApprovals

GET api/boardapproval/{id}

GET: api/boardapproval/{id} Get BoardApproval by ID

Budget

Budget

APIDescription
GET api/budget/budgetlines?entityId={entityId}&year={year}&chartOfAccountId={chartOfAccountId}

GET: api/Budget

GET api/budget/funds?year={year}&entityId={entityId}

GET: api/Budget

GET api/budget/getByEntityYear?year={year}&entityId={entityId}&saveAll={saveAll}

No documentation available.

Builder

BuilderController

APIDescription
GET api/buildings/{buildingId}/builders

GET: api/buildings/{buildingId}/builders Get builders by building Id

POST api/buildings/{buildingId}/builders

Insert a new builder

PUT api/buildings/{buildingId}/builders/{builderId}

Update a builder

DELETE api/buildings/{buildingId}/builders/{builderId}

Delete a builder

GET api/buildings/{buildingId}/buildingbuildersaudittrails

Get audittrail by building Id

Building

Building Controller

APIDescription
GET api/entities/{entityId}/buildings

Get All Buildings by EntityId

GET api/buildings/selector?entityId={entityId}&active={active}&buildingTypes[0]={buildingTypes[0]}&buildingTypes[1]={buildingTypes[1]}

Get buildings for the building selector Returns minimum information

GET api/buildings/{buildingId}

Get Building By Id

GET api/buildings/{buildingId}/details

Get Building Details By Id

PUT api/buildings/{buildingId}

Updating a Building

PUT api/buildings/{buildingId}/copychanges

Updating a Building and copy changes to buildings

POST api/buildings

Create new building

POST api/buildings/{buildingId}/clone

Clone building

GET api/buildings/{id}/audittrails

Get audittrail by building id

POST api/buildings/{id}/notes

Insert buildling user note

GET api/buildings/{id}/notes

Get building notes

GET api/buildings/{buildingId}/buildingunittypesnotes

Get building unit types notes

POST api/buildings/{buildingId}/buildingunittypesnotes

Insert building unit types user note

GET api/buildings/{buildingId}/buildingbuildersnotes

Get building builders notes

POST api/buildings/{buildingId}/buildingbuildersnotes

Insert building builders user note

GET api/buildings/{buildingId}/buildingspacesnotes

Get building space notes

POST api/buildings/{buildingId}/buildingspacesnotes

Insert building space user note

BuildingAudit

Building Tickler Audit Controller

APIDescription
GET api/buildings/{buildingId}/buildingNotesaudittrails

Get Building Ticklers Audit Trails ordered by date descending

BuildingNote

APIDescription
GET api/buildingnotes/{buildingId}/buildingnotes

Returns building notes

POST api/buildingnotes/{buildingId}/Createbuildingnote

Create building note

GET api/buildingnotes/{buildingId}/buildingnotes/{buildingNoteId}

Get building note by id

PUT api/buildingnotes/{buildingNoteId}

Update a Building Note

DELETE api/buildingnotes/{buildingNoteId}

Delete a Building Note

BuildingNoteType

APIDescription
GET api/buildingnotetypes/GetbuildingNoteTypes

Get building note types

POST api/buildingnotetypes

Create buildingnotetype

PUT api/buildingnotetypes

Save buildingnotetype

BuildingRecurringTransaction

APIDescription
GET api/buildings/{buildingId}/recurringTransactions?type={type}

Returns a collection of recurring transactions (recurring charges or credits) for a building.

GET api/buildings/{buildingId}/recurringTransactionListItems?operationalStatus={operationalStatus}

Returns a collection of recurring transactions (recurring charges or credits) for the RecurringCharges.aspx's Charges and Credits tables.

GET api/buildings/{buildingId}/recurringTransactionsWidgets?year={year}&month={month}

Return a collection for recurring transactions widgets for entity and building

GET api/buildings/{buildingId}/recurringTransactionListItems/export?operationalStatus={operationalStatus}

get csv of recurring charges for a building by id

GET api/buildings/{buildingId}/entityRecurringTransactionListItems/export?operationalStatus={operationalStatus}

get a csv file with the recurring charges of all buildings of the requested entity

GET api/buildings/{buildingId}/entityRecurringTransactionSummaryListItems/export?year={year}

No documentation available.

GET api/buildings/{buildingId}/buildingRecurringTransactionSummaryListItems/export?year={year}

No documentation available.

BuildingSpaceType

BuildingSpaceTypeController

APIDescription
GET api/buildingspacetypes/{id}

GET: api/buildingspacetypes/{id} Get the item information by the Id

GET api/buildingspacetypes

GET: api/buildingspacetypes

POST api/buildingspacetypes

Insert a new BuildingSpaceType

PUT api/buildingspacetypes/{spaceTypeId}

Update a BuildingSpaceType

BuildingTicklers

Building Tickler Controller

APIDescription
GET api/buildings/{buildingId}/ticklers

Returns building ticklers

GET api/buildings/{buildingId}/ticklers/{ticklerId}

Returns building tickler

POST api/buildings/{buildingId}/ticklers

Create building tickler

DELETE api/buildings/{buildingId}/ticklers/{ticklerId}

Delete a Building Tickler

PUT api/buildings/{buildingId}/ticklers/{ticklerId}

Update a Building Tickler

BuildingType

Building Type Controller

APIDescription
GET api/buildingtypes

Get all Building Types

BuildingVendorChargeback

BuildingVendorChargebackController

APIDescription
GET api/buildings/{buildingId}/vendorchargebacks

Get all vendor chargeback by buildingId

POST api/buildings/{buildingId}/vendorchargebacks

Create building vendor chargeback

DELETE api/buildingvendorchargebacks/{chargebackId}

Delete building vendor chargeback

ChargeCodeAdjustedCode

Charge Code Adjusted Code

APIDescription
GET api/chargeCodes/{id}/chargeCodeAdjustedCode?displayMode={displayMode}

Get Adjusted Codes by charge code id

GET api/chargeCodeAdjustedCodes/searchbychargecodedisplaycodes?chargeCodeDisplayCodes[0]={chargeCodeDisplayCodes[0]}&chargeCodeDisplayCodes[1]={chargeCodeDisplayCodes[1]}

Get Adjusted Codes

GET api/chargeCodes/{id}/AdjustedCodeByChargeCodeIdAndAdjustedCodeType?adjustedCodeTypes[0]={adjustedCodeTypes[0]}&adjustedCodeTypes[1]={adjustedCodeTypes[1]}

Get Adjusted Codes by Charge Code id and Adjusted Code type

ChargeCodeExternalAccess

ChargeCodeExternalAccessController

APIDescription
POST api/chargecodeexternalaccess

Creates a charge code external access record

DELETE api/chargecodeexternalaccess/{id}?application={application}

Deletes a chargecodeexternal access record

ChargeCodePayoffOrder

ChargeCodePayoffOrderController

APIDescription
GET api/chargecodepayofforders/{id}

GET: api/chargecodepayofforders/{id} Get the item information by the Id

GET api/chargecodepayofforders

GET: api/chargecodepayofforders

GET api/buildings/{buildingId}/cashpayofforder

Get cash payoff by building ID

PUT api/buildings/{buildingId}/cashpayofforder

Updating building's cash payoff order

ChargeCodes

Charge Code Controller

APIDescription
GET api/chargeCodes/getChargeCodesForEntity?entityId={entityId}

Get all Charge Codes assigned to an Entity Ordered by Display Code alphabetically

GET api/chargeCodes?isAutoAssignedOnly={isAutoAssignedOnly}

Get all charge codes

POST api/chargeCodes/inquiry

Get all charge codes

PUT api/superentities/{entityId}/chargecodes

Update charge codes assigned to the entity

PUT api/autoassignedchargecodes

Assign global charge codes

GET api/chargeCodes/getChargeCodesForChartOfAccount?glAccountId={glAccountId}&superEntityId={superEntityId}

Get all Charge Codes for chart of accounts

GET api/chargeCodes/{chargeCodeId}/getChargeCodeDetailsById

Get charge codes by charge code Id

GET api/chargeCodes/selector

Get charge codes and types

POST api/chargeCodes/export

exports to csv

POST api/chargeCodes

Create Charge Code

GET api/chargeCodes/{id}/audittrails

Get audittrail by ChargeCodeId

GET api/chargeCodes/{id}/notes

Get ChargeCode Notes

POST api/chargeCodes/{id}/notes

Insert ChargeCode user note

PUT api/chargeCodes/{chargeCodeId}

Update Charge Code

GET api/chargeCodes/{chargeCodeId}/entityLinkExport

Get Entities linked to the charge code

ChargeCodesUsability

Charge Codes Usability Controller

APIDescription
GET api/superentities/{superEntityId}/chargecodesusabilities

Returns charge codes assigned to the super entity along with information whether these codes are used in any of the following: - As base charge code for any of the buildings assigned to super entity - Recurring Charges - Late Fees - Chargebacks

ChargeCodeType

ChargeCodeTypeController

APIDescription
GET api/chargecodetypes/{id}

GET: api/chargecodetypes/{id} Get the item information by the Id

GET api/chargecodetypes/details

GET: api/chargecodetypes/details

GET api/chargecodetypes?includeChargeCodes={includeChargeCodes}&isCreditsFromConnectEnabled={isCreditsFromConnectEnabled}

GET: api/chargecodetypes

Charges

Banks

APIDescription
POST api/charges/preview

Preview resident charges

POST api/charges/import

Import resident charges

GET api/charges/template?templateName={templateName}

Template for resident charges

GET api/charges/exporterror?fileName={fileName}

Download report file

ChartOfAccountAuditTrails

APIDescription
GET api/superEntities/{superEntityId}/chartOfAccountsaudittrails

Get All Accounts for a given super entity

ChartOfAccounts

Chart of Accounts

APIDescription
GET api/superEntities/{superEntityId}/chartOfAccounts

Get All Accounts for a given super entity

GET api/superEntities/{superEntityId}/glAccounts?pageSize={pageSize}&pageNum={pageNum}&orderBy={orderBy}&toAccountNumber={toAccountNumber}&fromAccountNumber={fromAccountNumber}&accountNumber={accountNumber}&description={description}&is1099={is1099}&budgetCheck={budgetCheck}&activesOnly={activesOnly}&isBalance={isBalance}&glAccountTypeIds[0]={glAccountTypeIds[0]}&glAccountTypeIds[1]={glAccountTypeIds[1]}&glAccountTypeCategoryIds[0]={glAccountTypeCategoryIds[0]}&glAccountTypeCategoryIds[1]={glAccountTypeCategoryIds[1]}&glAccountTypeSubCategoryIds[0]={glAccountTypeSubCategoryIds[0]}&glAccountTypeSubCategoryIds[1]={glAccountTypeSubCategoryIds[1]}

Get Super Entity Chart of Accounts

GET api/chartOfAccounts/{id}

GET: api/chartOfAccounts/{Id} GET ChartOfAccount By ID

GET api/chartOfAccounts/{id}/subAccount

No documentation available.

PUT api/chartOfAccounts/{entityId}

Update Chart of accounts

GET api/superEntities/{superEntityId}/chartOfAccounts/export?entityNumber={entityNumber}&fromAccountNumber={fromAccountNumber}&toAccountNumber={toAccountNumber}&accountNumber={accountNumber}&description={description}&is1099={is1099}&budgetCheck={budgetCheck}&activesOnly={activesOnly}&isBalance={isBalance}&glAccountTypeIds[0]={glAccountTypeIds[0]}&glAccountTypeIds[1]={glAccountTypeIds[1]}&glAccountTypeCategoryIds[0]={glAccountTypeCategoryIds[0]}&glAccountTypeCategoryIds[1]={glAccountTypeCategoryIds[1]}&glAccountTypeSubCategoryIds[0]={glAccountTypeSubCategoryIds[0]}&glAccountTypeSubCategoryIds[1]={glAccountTypeSubCategoryIds[1]}

Export Super Entity Chart of Accounts as Zip

POST api/superEntities/{superEntityId}/chartOfAccounts/export/avid-sync

Export Chart Of Accounts for Avid Sync

GET api/Entities/{entityId}/chartOfAccounts/{chartofaccountId}

Check for InactiveChart of account

Checks

Checks

APIDescription
GET api/checks/unmatched?bankReconciliationId={bankReconciliationId}

GET api/checks/umatched

GET api/checks/matched?bankReconciliationId={bankReconciliationId}

GET api/checks/matched

GET api/checks/reconciled?bankReconciliationId={bankReconciliationId}

No documentation available.

POST api/checks/{checkId}/unreconcile

No documentation available.

POST api/checks/{checkId}/reconcile?bankReconciliationId={bankReconciliationId}

No documentation available.

POST api/checks/unreconcileAll?bankReconciliationId={bankReconciliationId}

No documentation available.

POST api/checks/reconcileAll?bankReconciliationId={bankReconciliationId}

No documentation available.

POST api/checks/search

Search checks based on query parameters, this route is POST because of the length restriction on the GET verb

POST api/checks/inquiry/export

Get the inquiry result on a csv file in byte Array format

GET api/checks/search/file?startDate={startDate}&endDate={endDate}&pageNumber={pageNumber}&pageSize={pageSize}&sortField={sortField}&desc={desc}

Search checks files based on query parameters

GET api/checks/avidxchange

Get the list of checks pending export to Avid.

POST api/checks/avidexport

Generate the file to export to Avid.

PUT api/checks/void

Void checks by ids

GET api/checks/void-summary?id[0]={id[0]}&id[1]={id[1]}

Get void checks and invoices summary

POST api/checks/Manual

Generate ManualCheck.

GET api/checkfilesnotes

Get notes

POST api/checkfilesnotes

Create user note

GET api/checks/Download?fileName={fileName}

Download a byte array with the Attachment information

CheckSignature

CheckSignatureController

APIDescription
GET api/bankcodes/{id}/checksignatures

GET: api/bankcodes/{id}/checksignatures Get the item information by the Id

GET api/checksignatures/allchecksignatures?loadOnlyActive={loadOnlyActive}

Get all check signatures

GET api/checksignatures/{checkSignatureId}

Get check signatures by Id

GET api/checksignatures/{checkSignatureId}/Valid?name={name}

Get if name check signatures is valid

DELETE api/checksignatures/{checkSignatureId}

Delete check signatures by Id

POST api/checksignatures/upload

Save check signature

PUT api/checksignatures/upload

Update check signature

CollectionsAction

CollectionsActionController

APIDescription
GET api/collectionsactioncategories/{categoryId}/actions

GET: api/collectionsactioncategories/{categoryId}/actions Get Actions by category id

GET api/profiletypes/{profileTypeId}/actions?categoryId={categoryId}

Get actions filtered by ProfileTypeId and CategoryId

CollectionsActionAttribute

CollectionsActionAttributeController

APIDescription
GET api/collectionsactions/{actionId}/attributes

GET: api/collectionsactions/{actionId}/attributes Get attributes associated with an action

GET api/collectionsactionstagelinks/{actionStageLinkId}/attributes

GET: api/collectionsactionstagelinks/{actionStageLinkId}/attributes Get attributes associated with an action

GET api/buildings/{buildingId}/collectionsactions/{actionId}/attributes

GET: api/buildings/{buildingId}/collectionsactions/{actionId}/attributes Get attributes associated with an action filtered by building

GET api/collectionsbuildingactionstagelinks/{buildingActionStageLinkId}/attributes

GET: api/collectionsbuildingactionstagelinks/{buildingActionStageLinkId}/attributes Get attributes associated with an action filtered by building stage

GET api/collectionsactionattributes/{actionAttributeId}?args[0]={args[0]}&args[1]={args[1]}

Get action attributes by action attribute id If it's a child attribute, the attribute value(parent) will narrow down the payload and return only relevant records

POST api/collectionsactionattributes

Insert a new CollectionsActionAttribute

CollectionsActionCategory

CollectionsActionCategoryController

APIDescription
GET api/collectionsactioncategories

GET: api/collectionsactioncategorys

CollectionsActionStageLinkController

APIDescription
GET api/collectionsactionstagelinks/{id}

GET: api/collectionsactionstagelinks/{id} Get the item information by the Id

GET api/collectionsstages/{stageId}/actions

GET: ~/api/collectionsstages/{stageId}/actions} Get the item information by the Stage Id

POST api/collectionsactionstagelinks

Insert a new CollectionsActionStageLink

PUT api/collectionsactionstagelinks

Update a CollectionsActionStageLink

DELETE api/collectionsactionstagelinks/{id}

Delete a CollectionsActionStageLink

CollectionsAgency

APIDescription
POST api/collections/agencies

Create new collections agency

PUT api/collections/agencies

No documentation available.

GET api/collections/agencies/{agencyId}

Get all Collections Agents

POST api/collections/agencies/duplicates

Check for duplications before insert CollectionsAgent

CollectionsAgent

Collections Agents Controller

APIDescription
GET api/collections/agents

Get all Collections Agents

GET api/collections/agents/{agentId}

Get agent by id

POST api/collections/agents

Insert CollectionsAgent

PUT api/collections/agents

Insert CollectionsAgent

CollectionsAgentBuildingLinkController

APIDescription
GET api/buildings/{buildingId}/collectionsagentbuildinglinks?active={active}

Gets all agents that are currently assigned to the building

GET api/collectionsagentbuildinglinks/{collectionAgentId}/linkedProperties

Returns all the properties which are currently linked to the collections agent

PUT api/collectionsagentbuildinglinks

Update a CollectionsAgentBuildingLink

DELETE api/collectionsagentbuildinglinks/{id}

Delete a CollectionsAgentBuildingLink

POST api/collectionsagentbuildinglinks

Create agent building links

CollectionsApproval

CollectionsActionController

APIDescription
GET api/collectionsapproval/entities?from={from}&to={to}&approvalStatuses[0]={approvalStatuses[0]}&approvalStatuses[1]={approvalStatuses[1]}&residentIds[0]={residentIds[0]}&residentIds[1]={residentIds[1]}&buildingStageIds[0]={buildingStageIds[0]}&buildingStageIds[1]={buildingStageIds[1]}

GET api/collectionsapproval/residents?from={from}&to={to}&runFor={runFor}&entityId={entityId}

POST api/collectionsapproval/residents/pdfexport

No documentation available.

PUT api/collectionsapproval/save

GET api/collectionsapproval/entityApprovalHistoryLog?from={from}&to={to}

Get Entity Approval History Logs

CollectionsAttributeDataTypeDescriptor

CollectionsAttributeDataTypeDescriptorController

APIDescription
GET api/collectionsattributedatatypedescriptors/{id}

GET: api/collectionsattributedatatypedescriptors/{id} Get the item information by the Id

GET api/collectionsattributedatatypedescriptors

GET: api/collectionsattributedatatypedescriptors

CollectionsBuildingActionStageLinkController

APIDescription
GET api/collectionsbuildingactionstagelinks/{id}

GET: api/collectionsbuildingactionstagelinks/{id} Get the item information by the Id

GET api/collectionsbuildingstages/{buildingStageId}/actions

No documentation available.

POST api/collectionsbuildingactionstagelinks

Insert a new CollectionsBuildingActionStageLink

PUT api/collectionsbuildingactionstagelinks/{id}

Update a CollectionsBuildingActionStageLink

DELETE api/collectionsbuildingactionstagelinks/{id}

Delete a CollectionsBuildingActionStageLink

CollectionsBuildingPolicy

CollectionsBuildingPolicyController

APIDescription
GET api/collectionsbuildingpolicies/{id}

GET: api/collectionsbuildingpolicies/{id} Get the item information by the Id

GET api/collectionsbuildingpolicies

GET: api/collectionsbuildingpolicies

GET api/collectionsbuildingpolicies/{id}/detail

Get detailed building policy

POST api/collectionsbuildingpolicies

Insert a new CollectionsBuildingPolicy

PUT api/collectionsbuildingpolicies

Update a CollectionsBuildingPolicy

GET api/buildings/{buildingId}/collectionsbuildingpolicies

GET: /api/buildings/{buildingid}/collectionsbuildingpolicies

GET api/buildings/{buildingId}/collectionsbuildingpolicies/current

GET: api/buildings/{buildingId}/collectionsbuildingpolicies/current Get the item information by the Id

GET api/buildings/{buildingId}/collectionsbuildingpolicies/{policyId}/validate

POST: /api/buildings/{buildingid}/collectionsbuildingpolicies/{policyId}/validate

POST api/collectionsbuildingpolicies/{id}/copy

Copy building policy to a set of buildings

POST api/collectionsbuildingpolicies/fullinfo

Gets building policies with profiles and stages

CollectionsBuildingPolicyProfile

CollectionsBuildingPolicyProfileController

APIDescription
GET api/collectionsbuildingpolicyprofiles/{id}

GET: api/collectionsbuildingpolicyprofiles/{id} Get the item information by the Id

GET api/collectionsbuildingpolicyprofiles

GET: api/collectionsbuildingpolicyprofiles

PUT api/collectionsbuildingpolicyprofiles

Update a CollectionsBuildingPolicyProfile

CollectionsBuildingPolicyProfileNote

CollectionsBuildingPolicyProfileNoteController

APIDescription
GET api/collectionsbuildingpolicyprofilenotes/{id}

GET: api/collectionsbuildingpolicyprofilenotes/{id} Get the item information by the Id

GET api/collectionsbuildingpolicyprofilenotes

GET: api/collectionsbuildingpolicyprofilenotes

POST api/collectionsbuildingpolicyprofilenotes

Insert a new CollectionsBuildingPolicyProfileNote

PUT api/collectionsbuildingpolicyprofilenotes

Update a CollectionsBuildingPolicyProfileNote

CollectionsBuildingStage

CollectionsBuildingStageController

APIDescription
GET api/collectionsbuildingstages/{id}

GET: api/collectionsbuildingstages/{id} Get the item information by the Id

POST api/collectionsbuildingstages

Insert a new CollectionsBuildingStage

PUT api/collectionsbuildingstages/{id}

Update a CollectionsBuildingStage

PUT api/collectionsbuildingstages/reorder

Update stage number/order

POST api/collectionsbuildingstages/orderpreview

GET: api/collectionsbuildingstages

DELETE api/collectionsbuildingstages/{buildingStageId}

delete a building stage

CollectionsBuildingStageActionAttributeLinkController

APIDescription
GET api/collectionsbuildingstageactionattributelinks/{id}

GET: api/collectionsbuildingstageactionattributelinks/{id} Get the item information by the Id

GET api/collectionsbuildingstageactionattributelinks

GET: api/collectionsbuildingstageactionattributelinks

POST api/collectionsbuildingstageactionattributelinks

Insert a new CollectionsBuildingStageActionAttributeLink

PUT api/collectionsbuildingstageactionattributelinks

Update a CollectionsBuildingStageActionAttributeLink

CollectionsBuildingStageNote

CollectionsBuildingStageNoteController

APIDescription
GET api/collectionsbuildingstagenotes/{id}

GET: api/collectionsbuildingstagenotes/{id} Get the item information by the Id

GET api/collectionsbuildingstagenotes

GET: api/collectionsbuildingstagenotes

POST api/collectionsbuildingstagenotes

Insert a new CollectionsBuildingStageNote

PUT api/collectionsbuildingstagenotes

Update a CollectionsBuildingStageNote

CollectionsPolicy

CollectionsPolicyController

APIDescription
GET api/collectionspolicies/{id}

GET: api/collectionspolicys/{id} Get the item information by the Id

GET api/collectionspolicies

Get all policies

GET api/collectionspolicies/filter?active={active}

Get policies based on the filter. For now the only filter is "active".

GET api/collectionspolicies/{id}/detail

Get Global Policy with actions and attributes

POST api/collectionspolicies

Insert a new CollectionsPolicy

PUT api/collectionspolicies

Update a CollectionsPolicy

DELETE api/collectionspolicies/{id}

Delete a policy

CollectionsStage

CollectionsStageController

APIDescription
GET api/collectionsstages/{id}

GET: api/collectionsstages/{id} Get the item information by the Id

POST api/collectionsstages/orderpreview

POST: api/collectionsstages/orderpreview

POST api/collectionsstages

Insert a new CollectionsStage

PUT api/collectionsstages

Update a CollectionsStage

PUT api/collectionsstages/reorder

Update stage number/order

DELETE api/collectionsstages/{stageId}

delete a collection stage

ComplianceStatus

ComplianceStatusController

APIDescription
GET api/compliancestatus/{id}

GET: api/compliancestatus/{id} Get the compliance status information by the Id

GET api/compliancestatus

GET: api/compliancestatus Get all compliance status information

POST api/compliancestatus

No documentation available.

PUT api/compliancestatus/{id}

No documentation available.

ComplianceType

ComplianceTypeController

APIDescription
GET api/compliancetypes/{id}

GET: api/compliancetypes/{id} Get the compliance type information by the Id

GET api/compliancetypes

GET: api/compliancetypes Get all compliance type information

ConfigVariable

APIDescription
GET api/systemconfigs

No documentation available.

GET api/systemconfigs/{configName}

No documentation available.

GET api/systemconfigs/marketCountry

No documentation available.

CorporateBilling

CorporateBillingController

APIDescription
GET api/corporatebillings

GET: api/corporatebillings

Country

Country Controller

APIDescription
GET api/country/all

Get all countries

CreditChargeLinkController

APIDescription
POST api/batch/{batchId}/charge

No documentation available.

CreditHistoryCode

CreditHistoryCodeController

APIDescription
GET api/credithistorycodes/{id}/includedbycode

Get a list of credit history codes associated with the credit history code

GET api/credithistorycodes/{id}/excludedbycode

GET: api/credithistorycodes/{id} Get the item information by the Id

GET api/credithistorycodes?onlyActive={onlyActive}

GET: api/credithistorycodes

CreditHistoryCodeApplicationMapping

APIDescription
GET api/credithistorycodeapplicationmapping/{applicationTypeName}

Get credit history codes by application name

Credits

Credit Controller

APIDescription
POST api/credits/RunPrepaids

POST: api/credits/runPrepaids Runs Application of Prepaids Process.

POST api/credits/preview

Preview resident credits

POST api/credits/import

Import resident credits

GET api/credits/template?templateName={templateName}

Template for resident credits

GET api/credits/prepaid/refunds?residentId={residentId}&startDate={startDate}&endDate={endDate}&includePrepayments={includePrepayments}

Get all avaliable prepayment items for refund, a prepayment will be consider either an open credit or a receipt line item

POST api/credits/prepaid/refunds

Post the payments for the credits and prepayments

DebitMemo

Debit Memo

APIDescription
POST api/debitmemo/report

POST: api/debitmemo/report

POST api/debitmemo/getInvoiceLinkByBatchIds

GET api/debitmemo/getInvoiceLinkByBatchIds

POST api/debitmemo/search

GET api/debitmemo/getInvoiceLinkByBatchIds/search

GET api/debitmemo/getInvoicesLinkedToDebitMemo?debitMemoId={debitMemoId}

GET api/debitmemo/getInvoicesLinkedToDebitMemo

GET api/debitmemo/getDebitMemoBatchHistory?debitMemoBatchId={debitMemoBatchId}

GET api/debitmemo/getDebitMemoBatchHistory

POST api/debitmemo/voidDebitMemoBatch

POST api/debitmemo/voidDebitMemoBatch

POST api/debitmemo/{debitMemoBatchId}/reconcile?bankReconciliationId={bankReconciliationId}

No documentation available.

POST api/debitmemo/{debitMemoBatchId}/unreconcile

No documentation available.

PUT api/debitmemo/bulk/void

Void debit memo in bulk

POST api/DebitMemo

POST: api/debitmemo

DeliverySetting

Controller to expose endpoints to DeliverySettings

APIDescription
GET api/deliverysettings

No documentation available.

Delta

APIDescription
POST api/deltas

No documentation available.

Deposits

APIDescription
GET api/deposits/unmatched?bankReconciliationId={bankReconciliationId}&includeReversals={includeReversals}

No documentation available.

GET api/deposits/matched?bankReconciliationId={bankReconciliationId}&includeNsf={includeNsf}

No documentation available.

GET api/deposits/reconciled?bankReconciliationId={bankReconciliationId}&includeReversals={includeReversals}

No documentation available.

POST api/deposits/{receiptId}/unreconcile

No documentation available.

POST api/deposits/{receiptId}/reconcile?bankReconciliationId={bankReconciliationId}

No documentation available.

POST api/deposits/unreconcileAll?bankReconciliationId={bankReconciliationId}&includeReversals={includeReversals}

No documentation available.

POST api/deposits/reconcileAll?bankReconciliationId={bankReconciliationId}&includeReversals={includeReversals}

No documentation available.

GET api/deposits/unmatched/nsf?bankReconciliationId={bankReconciliationId}

No documentation available.

GET api/deposits/matched/nsf?bankReconciliationId={bankReconciliationId}

No documentation available.

GET api/deposits/reconciled/nsf?bankReconciliationId={bankReconciliationId}

No documentation available.

POST api/deposits/reconcileAll/nsf?bankReconciliationId={bankReconciliationId}

No documentation available.

POST api/deposits/unreconcileAll/nsf?bankReconciliationId={bankReconciliationId}

No documentation available.

POST api/deposits/postbatch

No documentation available.

DistributionLists

APIDescription
GET api/distributionlistservicetypes/{serviceTypeId}/subscriberemails

Gets subscriber emails by distribution list service type id

DownloadFileType

DownloadFileTypeController

APIDescription
GET api/downloadfiletypes/{id}?userId={userId}

GET: api/downloadfiletypes/{id} Get the item information by the Id

GET api/downloadfiletypes

GET: api/downloadfiletypes

DownloadFileTypeGroup

DownloadFileTypeGroupController

APIDescription
GET api/downloadfiletypegroups/{id}

GET: api/downloadfiletypegroups/{id} Get the item information by the Id

GET api/downloadfiletypegroups

GET: api/downloadfiletypegroups

EFileType

Entities and Parameters for 1098

APIDescription
GET api/efiletypes/{name}

Get File Type by Name

GET api/efiletypes

Get all E File Types

EngineExecution

APIDescription
GET api/EngineExecution?dateFrom={dateFrom}&dateTo={dateTo}&status={status}

No documentation available.

Entities

Entities

APIDescription
GET api/entities/{entityNumber}

GET api/entities

GET api/entities/search?entityNumber={entityNumber}&entityName={entityName}&includeInactive={includeInactive}&page={page}&pagesize={pagesize}

GET api/entities/search

GET api/entities?subsOnly={subsOnly}&activeOnly={activeOnly}&buildingType={buildingType}

Get all the Active Entities that are NOT shadow entity

POST api/entities/all-unassigned

No documentation available.

POST api/entities/unassigned

Get All Entities excluding by Ids.

GET api/entities/detail/{entityId}?buildingType={buildingType}

Get entity detail information. which includes the buildings the charge codes

GET api/entities/{entityId}/1098EntityDetails?buildingType={buildingType}

Get entity detail information. which includes the buildings the charge codes

GET api/entities/getTiers?entityNumber={entityNumber}

Get Tiers

GET api/entities/{entityId}/ChargeCodeTotal?chargeCodeId={chargeCodeId}&year={year}&coOpOnly={coOpOnly}&unitsWithSharesOnly={unitsWithSharesOnly}

Returns total paid for entity to a specific charge code.

GET api/entities/{entityId}/totals

Returns total Real Estate Tax and total Mortgage Interest by entity Id.

GET api/entities/all?activeOnly={activeOnly}

Returns all active entities

GET api/entities/selector?active={active}&isShadow={isShadow}&includeInFinancials={includeInFinancials}

Entity Selector that returns minimum information

GET api/entities/searchShadowOrConsolidated?active={active}&isShadow={isShadow}&isConsolidated={isConsolidated}&filterByLinkedEntities={filterByLinkedEntities}&managementCompanyIds[0]={managementCompanyIds[0]}&managementCompanyIds[1]={managementCompanyIds[1]}

Entity selector that allows searching for active or inactive AND both shadow or consolidated entities

GET api/entities/getAllBySuper?superEntityId={superEntityId}

Get Gl Entities by super entity id

GET api/entities/{entityId}/information

Returns entity information

PUT api/entities/{id}/PayablesReceivables?isCopyToTiersRequired={isCopyToTiersRequired}

Update Entity information

PUT api/entities/{id}/PeriodClose?isCopyToTiersRequired={isCopyToTiersRequired}

Update Entity information

PUT api/entities/{id}/information?isCopyToTiersRequired={isCopyToTiersRequired}

Update Entity

PUT api/entities/{entityId}/makeEntityConsolidated

Make an Entity consolidated

PUT api/entities/{entityId}/unconsolidatedEntity

Make an Entity unconsolidated

POST api/entities/createDraftEntity

Create an Entity

POST api/entities/{id}/addSubEntities

Add Sub Entity

POST api/entities/{id}/clone

Clone Entity

DELETE api/entities/{id}

Delete Entity

GET api/entities/{id}/audittrails

Get audittrail by building id

POST api/entities/{id}/notes

Insert buildling user note

GET api/entities/{id}/notes

Get building notes

GET api/entities/{id}/hasActiveBuilding?checkConsolidatedEntity={checkConsolidatedEntity}

Check if the entity has active building

GET api/entities/{id}/fiscalYearDateRange?year={year}

Return the Fiscal Year Dates Range for the entity with Id and year in parameters

GET api/entities/{entityId}/hasTransactions

Check if the entity has transactions

GET api/entities/{entityId}/export-residents

Export Resident Units

EntityBankCodes

Entity Bank Codes

APIDescription
GET api/bankcodes/getListByEntityNumber?entityNumber={entityNumber}&includeInactive={includeInactive}&excludeAbaNumber={excludeAbaNumber}

GET: api/BankCodes/getListByEntityNumber

GET api/entities/{entityId}/bankcodes?activesOnly={activesOnly}&transactionalBanksOnly={transactionalBanksOnly}&transactionalAccountsOnly={transactionalAccountsOnly}

No documentation available.

GET api/superentities/{superEntityId}/bankcodes?activesOnly={activesOnly}&transactionalBanksOnly={transactionalBanksOnly}&transactionalAccountsOnly={transactionalAccountsOnly}

No documentation available.

PUT api/superentities/{superEntityId}/transactionalbankcodes

Updating transactional bank and bank codes assigned to super entity

GET api/bankcodes/RecStatus/getListByEntityNumber?entityNumber={entityNumber}&includeInactive={includeInactive}

GET: api/BankCodes/RecStatus/getListByEntityNumber

EntityBudgets

Entity Budget

APIDescription
GET api/entities/{entityId}/budgets/ach-holdbacks

GET: ach-holdbacks

EntityGLAccount

Entities

APIDescription
GET api/entities/{entityId}/glAccounts?activeOnly={activeOnly}

Get gl accounts linked to entity

EntityManagementTeam

Entity management team

APIDescription
GET api/entities/{superEntityId}/association-manager

GET connect property details

EntityNote

Entity Notes

APIDescription
GET api/entitynotes/{id}/audittrails

Get audittrail by entity id

PUT api/entitynotes/{id}

Update note

POST api/entitynotes/entity/{id}/entitynotes

Insert Entity note

GET api/entitynotes/{id}

Get note by Id

GET api/entitynotes/entity/{id}/entitynotes?includeSuperNotes={includeSuperNotes}

Get all entity notes

EntityRecurringTransaction

APIDescription
GET api/entities/{entityId}/recurringTransactionsWidgets?year={year}&month={month}

Return a collection for recurring transactions widgets for entity and building

GET api/entities/{entityId}/recurringTransactions/chargeCodes/{chargeCodeId}/hasMultipleApplyToTypes

Calculates if there's more than 1 ApplyTo type for the charge code in this entity.

GET api/entities/{entityId}/recurringTransactions/chargeCodes/{chargeCodeId}/groupbydates

List of recurring transactions group by Charge Code, StartDate and EndDate

POST api/entities/{entityId}/recurringTransactions/globalAdjustment?retroChargesPostDate={retroChargesPostDate}&retroChargesDescription={retroChargesDescription}

Performs a global adjustment.

GET api/entities/{entityId}/recurringTransactions/preview/globalAdjustment?ChargeCodeId={ChargeCodeId}&AdjustmentOption={AdjustmentOption}&Action={Action}&StartDate={StartDate}&Value={Value}&UserId={UserId}&Type={Type}&RetroGLPostDate={RetroGLPostDate}

Preview for global adjustments

POST api/entities/{entityId}/recurringTransactions/chargeEndDate/globalAdjustment

Update End Date

GET api/entities/{entityId}/recurringTransactions/import/preview?FileName={FileName}&UserId={UserId}&GLPostDate={GLPostDate}&TransactionType={TransactionType}&RetroGLPostDate={RetroGLPostDate}

Get Preview on the Transaction Import

GET api/entities/{entityId}/recurringTransactions/import/preview/groupIncrease?FileName={FileName}&UserId={UserId}&GLPostDate={GLPostDate}&TransactionType={TransactionType}&RetroGLPostDate={RetroGLPostDate}

Get Preview on the Group Increase Import.

POST api/entities/{entityId}/recurringTransactions/import?retroDescription={retroDescription}

Import new recurring charges or credits.

POST api/entities/{entityId}/recurringTransactions/import/groupIncrease?retroDescription={retroDescription}

Import recurring charges group increases.

GET api/entities/{entityId}/recurringTransactions/import/export/charge?FileName={FileName}&UserId={UserId}&GLPostDate={GLPostDate}&TransactionType={TransactionType}&RetroGLPostDate={RetroGLPostDate}

Export to excel the charges previously previewed

GET api/entities/{entityId}/recurringTransactions/import/export/credit?FileName={FileName}&UserId={UserId}&GLPostDate={GLPostDate}&TransactionType={TransactionType}&RetroGLPostDate={RetroGLPostDate}

Export to excel the credits previously previewed

GET api/entities/{entityId}/recurringTransactions/import/export/groupIncrease?FileName={FileName}&UserId={UserId}&GLPostDate={GLPostDate}&TransactionType={TransactionType}&RetroGLPostDate={RetroGLPostDate}

Export to excel the group increase transactions previously previewed

EntityVendor

EntityVendor

APIDescription
GET api/entities/{entityId}/vendors?activeOnly={activeOnly}

No documentation available.

PUT api/entities/{entityId}/vendors

Assign vendorIds to entityId

PUT api/entities/{entityId}/vendors/all

Assign all vendors in the criteria to entityId

FeatureFlags

Controller to expose endpoints to manage feature flags

APIDescription
GET api/featureflags/{name}

Get flag with given name

FeeSchedule

FeeScheduleController

APIDescription
GET api/feeschedules

GET: api/feeschedules

Fund

FundController

APIDescription
GET api/superentities/{superEntityId}/funds?dateFrom={dateFrom}&dateTo={dateTo}

Get funds related to a super entity

GET api/funds/{fundId}

Get fund details information

POST api/superentities/{superEntityId}/funds

Create funds

PUT api/funds/{fundId}

Update fund

DELETE api/funds/{fundId}

No documentation available.

POST api/superentities/{superEntityId}/fundconflicts

Returns list of conflicted funds when creating a new fund.

POST api/funds/{fundId}/fundconflicts

Returns list of conflicted funds when updating an existing fund.

GET api/funds/{fundId}/audittrails

Returns List of Audit Trails for Fund

GET api/funds/{fundId}/notes

Returns Fund notes

POST api/funds/{id}/notes

Insert Fund user note

GET api/superEntity/{superEntityId}/chargecodefunds?chcids[0]={chcids[0]}&chcids[1]={chcids[1]}&date={date}

Get the fund related to the charge codes in the list passed as parameter

GET api/superEntity/{superEntityId}/bankcodefunds?bcids[0]={bcids[0]}&bcids[1]={bcids[1]}&date={date}

Get the fund related to the bank codes in the list passed as parameter

GET api/superEntity/{superEntityId}/securitydepositfunds?sdIds[0]={sdIds[0]}&sdIds[1]={sdIds[1]}&date={date}

Get the fund related to the security deposit type ids in the list passed as parameter

POST api/funds/journalentryinfoforchargecodes

Get journal entry fund information for the given transaction date, super entities, and charge codes

POST api/funds/journalentryinfoforbankcodes

Get journal entry fund information for the given transaction date, super entities, and bank codes

FundSuperEntityActivation

FundAccountingActivationController

APIDescription
POST api/superentities/{superEntityId}/fundaccounting

Return FundAccoutning information related to super entity id and transaction date

GET api/superentities/{superEntityId}/fundactivation

Returns latest activation

POST api/superentities/{superEntityId}/fundactivation

Activate fund accounting for a super entity

PUT api/superentities/{superEntityId}/fundactivation

Update fund accounting activation for a super entity

GET api/fundsuperentityactivations/{superEntityActivationId}/audittrails

Returns List of Audit Trails for FundSuperEntityActivation

GET api/fundsuperentityactivations/{superEntityActivationId}/notes

Returns FundSuperEntityActivation notes

POST api/fundsuperentityactivations/{id}/notes

Insert FundSuperEntityActivation user note

FundType

TypeController

APIDescription
GET api/fundtypes

Get all fund types

GeneralLedgerReport

BankStatementFolderController

APIDescription
GET api/generalledger/report?entityId={entityId}&dateFrom={dateFrom}&dateTo={dateTo}&accountFromId={accountFromId}&accountToId={accountToId}&subAccountFromId={subAccountFromId}&subAccountToId={subAccountToId}&isUnpostedEntriesIncluded={isUnpostedEntriesIncluded}&isTiersIncluded={isTiersIncluded}&managementCompanies[0]={managementCompanies[0]}&managementCompanies[1]={managementCompanies[1]}&fundIds[0]={fundIds[0]}&fundIds[1]={fundIds[1]}

GET: api/generalledger

GLAccountAudit

GL Accounts Audit Controller

APIDescription
GET api/glaccounts/{id}/audittrails

Get audittrail by GL Account Id

POST api/glaccounts/{id}/notes

Insert user note

GET api/glaccounts/{id}/notes

Get Audit Notes

GlAccountEntities

GL Account Entities

APIDescription
GET api/glaccounts/{glAccountId}/entities/export

Glentities exports to csv

GET api/glaccounts/{glAccountId}/entities

Get all Entities by GL Acount Id.

GET api/glaccounts/{glAccountId}/chartofaccounts

Get all assigned chart of accounts to entities with management company by GL Acount Id.

PUT api/glaccounts/{glAccountId}/entities

Update GlAccount Assign Entities

PUT api/glaccounts/{glAccountId}/entities/assigned?description={description}&glAccountCategoryId={glAccountCategoryId}&glAccountSubcategoryId={glAccountSubcategoryId}

Update description, category, subcategory, for GlAccount Assigned Entities

GlAccountReportTypes

GL Account Report Types

APIDescription
GET api/glaccounts/report-types

Get Gl Account Report Types

GLAccounts

GL Accounts

APIDescription
POST api/glaccounts/search?pageSize={pageSize}&pageNum={pageNum}&orderBy={orderBy}&toAccountNumber={toAccountNumber}&fromAccountNumber={fromAccountNumber}&accountNumber={accountNumber}&description={description}&is1099={is1099}&budgetCheck={budgetCheck}&activesOnly={activesOnly}&isBalance={isBalance}&glAccountTypeIds[0]={glAccountTypeIds[0]}&glAccountTypeIds[1]={glAccountTypeIds[1]}&glAccountTypeCategoryIds[0]={glAccountTypeCategoryIds[0]}&glAccountTypeCategoryIds[1]={glAccountTypeCategoryIds[1]}&glAccountTypeSubCategoryIds[0]={glAccountTypeSubCategoryIds[0]}&glAccountTypeSubCategoryIds[1]={glAccountTypeSubCategoryIds[1]}

GET Gl Accounts

GET api/glaccounts/search?entityNumber={entityNumber}&glAccount={glAccount}

GET api/glaccount/search

GET api/glaccounts/exists?glAccountNumber={glAccountNumber}

Check GL Acount exist or not.

GET api/glaccounts/export?fromAccountNumber={fromAccountNumber}&toAccountNumber={toAccountNumber}&accountNumber={accountNumber}&description={description}&is1099={is1099}&budgetCheck={budgetCheck}&activesOnly={activesOnly}&isBalance={isBalance}&glAccountTypeIds[0]={glAccountTypeIds[0]}&glAccountTypeIds[1]={glAccountTypeIds[1]}&glAccountTypeCategoryIds[0]={glAccountTypeCategoryIds[0]}&glAccountTypeCategoryIds[1]={glAccountTypeCategoryIds[1]}&glAccountTypeSubCategoryIds[0]={glAccountTypeSubCategoryIds[0]}&glAccountTypeSubCategoryIds[1]={glAccountTypeSubCategoryIds[1]}

GlAccounts exports to zip

GET api/glaccounts/{glAccountId}

Get GL Acount Details.

PUT api/glaccounts/{glAccountId}

Update GlAccount

POST api/GLAccounts

Insert a new GL Account.

GlAccountTypeCategory

GL Account Type Categories

APIDescription
GET api/glaccounts/types/{typeId}/categories

Get glAccount type categories by type <param name="typeId"></param>

GET api/glaccounts/types/categories

Get all glAccount type categories

GlAccountTypes

GL Account Types

APIDescription
GET api/glaccounts/types?reportType={reportType}

Get all glAccount types

GlAccountTypeSubCategory

GL Account Type Categories

APIDescription
GET api/glaccounts/typeSubCategories?typeId={typeId}&categoryId={categoryId}

Get all glAccount type sub categories

GlobalDocumentFile

GlobalDocumentsFileController

APIDescription
POST api/globalDocumentFiles/uploadGlobalDocumentFile?GlobalDocumentId={GlobalDocumentId}&Name={Name}&Description={Description}&FileName={FileName}&Path={Path}&EffectiveDate={EffectiveDate}&ExpirationDate={ExpirationDate}&CreatedOn={CreatedOn}&CreatedBy={CreatedBy}

Inserts a new global document file

PUT api/globalDocumentFiles

Updating a Global Document File

GlobalDocuments

GlobalDocumentsController

APIDescription
GET api/globalDocuments

Get All global documents

GET api/globalDocuments/GetRSMGlobalDocumentReports?isEditReport={isEditReport}

Get All global documents

GET api/globalDocuments/globalDocumentItems

Get global documents with fileitems

POST api/globalDocuments

Inserts a new global document

PUT api/globalDocuments

Updates global documents

GET api/globaldocumentsaudittrails

Get Audit Trails

GlobalSettingType

GlobalConfigurationTypeController

APIDescription
GET api/globalsettings

GET: api/globalconfigurationtypes

PUT api/globalsettings

Update a GlobalConfigurationType

GET api/globalsettingsnotes

Get notes

POST api/globalsettingsnotes

Create user note

GLSubAccountAudit

GL SubAccount Audit Controller

APIDescription
GET api/glaccounts/{id}/subaccountsaudittrails

Get audittrail by GL Account Id

GLSubAccounts

GL Sub Accounts

APIDescription
POST api/glsubaccounts/search

POST api/glsubaccounts/search

GET api/glaccounts/{glAccountId}/glsubaccounts?subAccountName={subAccountName}

Get all subaccounts for a glAccount

Holiday

HolidayController

APIDescription
GET api/holidays/byyear?year={year}

GET: api/holidays by year

POST api/holidays

Insert Holiday

POST api/holidays/link

Links a non linked holiday

POST api/holidays/Unlink

Unlinks a linked holiday

DELETE api/holidays?id={id}

Deletes a holiday and Unlink the linked holiday

InsuranceType

InsuranceTypeController

APIDescription
GET api/insurancetypes/{id}

GET: api/insurancetypes/{id} Get the insurance type information by the Id

GET api/insurancetypes

GET: api/insurancetypes

InvoiceAttachments

Exposes the Invoices operations

APIDescription
GET api/invoices/{id}/attachments

Download a byte array with all pdfs merge information

POST api/invoices/{id}/allattachments

No documentation available.

POST api/invoices/{id}/attachments

POST add invoice attachments

DELETE api/invoices/{id}/attachments

Remove all attachments assigned to invoice

POST api/invoices/{id}/replaceattachment

Replace existing attachment(s)

InvoiceLineItems

Exposes the Invoices operations

APIDescription
PUT api/invoices/{id}/lineitems

Update invoice line items information

Invoices

Exposes the Invoices operations

APIDescription
GET api/invoices/inquiry?pageSize={pageSize}&pageNum={pageNum}&managementCompanyIds[0]={managementCompanyIds[0]}&managementCompanyIds[1]={managementCompanyIds[1]}&entityId={entityId}&payeeName={payeeName}&invoiceId={invoiceId}&invoiceNumber={invoiceNumber}&invoiceAmountFrom={invoiceAmountFrom}&invoiceAmountTo={invoiceAmountTo}&statusIds[0]={statusIds[0]}&statusIds[1]={statusIds[1]}&typeIds[0]={typeIds[0]}&typeIds[1]={typeIds[1]}&paymentTypeIds[0]={paymentTypeIds[0]}&paymentTypeIds[1]={paymentTypeIds[1]}&invoiceStartDate={invoiceStartDate}&invoiceEndDate={invoiceEndDate}&startGlDate={startGlDate}&endGlDate={endGlDate}&orderBy={orderBy}&orderDesc={orderDesc}

Load invoices with payee information and filters

POST api/invoices/inquiry/export

Get the inquery result on a csv file in byte Array format

GET api/invoices/{id}/detail

Get Detail information for invoice using identifier

GET api/invoices/entity/{entityId}/payments?bankCodeId={bankCodeId}&checkDate={checkDate}

load the avaliable invoices for payments

POST api/invoices/nonRecurring

Post Non Recurring Invoice with Itemized Line Items and journal entries. Send request as form data with 2 keys: file (file to upload) and viewModelJsonFormControlName (json body).

PUT api/invoices/{id}

Update invoice information

POST api/invoices/{id}/proposedreclass

Get journal entry of proposed reclass

PUT api/invoices/{id}/void

Void invoice

GET api/invoices/{id}/gldate

Get most recent invoice GL date

POST api/invoices/payments/pending

Save a list of invoices for pending payment

InvoicesAudit

Exposes the Invoices operations

APIDescription
GET api/invoices/{id}/audittrails

Get audit trails for an invoice

GET api/invoices/{id}/notes

Get notes for an invoice

POST api/invoices/{id}/notes

Insert user note for an invoice

Irs1098

1098 Controller for processing, exporting, and printing all things 1098

APIDescription
GET api/irs1098/getBuildingResidents?total={total}&realEstateTaxes={realEstateTaxes}&mortgageInterest={mortgageInterest}&mortgageOriginationPrincipal={mortgageOriginationPrincipal}&year={year}&calculationMethod={calculationMethod}&chargeCodeId={chargeCodeId}&entityId={entityId}&originationDate={originationDate}

Return all the units and residents under the building Id. Calculates real estateTaxes and mortgage interest per resident.

GET api/irs1098/getCalculationMethods

Return all the calculation methods for 1098 processing

GET api/irs1098/export?originationDate={originationDate}&entityId={entityId}&year={year}&calculationMethod={calculationMethod}&chargeCode={chargeCode}&total={total}&taxes={taxes}&interest={interest}&principal={principal}&entityName={entityName}&totalTaxes={totalTaxes}&totalInterest={totalInterest}&totalPrincipal={totalPrincipal}&taxId={taxId}

Export Paramters and Resident information to csv

GET api/irs1098/searchprintedfiles?year={year}&entityId={entityId}&buildingId={buildingId}&unitId={unitId}&residentId={residentId}&batchNumber={batchNumber}&batchSize={batchSize}

Search for residents 1098 printed files

GET api/irs1098/downloadprintedfile?residentId={residentId}&documentId={documentId}

Get resident 1098 printed file

Irs1099Class

IRS classes controller

APIDescription
GET api/irs1099Classes?taxYear={taxYear}

Get all IRS classes by Tax Year

GET api/irs1099Classes/{id}

Get IRS class by id

IrsEntity1098Corrections

Corrections controller

APIDescription
GET api/entity1098corrections/{taxProfileId}/{year}

Get entities that need to be corrected

POST api/entity1098corrections

Export corrections for entities

IrsEntity1098Exports

1098 Exports

APIDescription
GET api/entity1098exports/{taxProfileId}/{year}

Get entities ready to export for the tax year

POST api/entity1098exports

Process entities that are sent for export

GET api/entity1098exports/{year}/completed

Retrieves all completed 1098 exports for the provided year

DELETE api/entity1098exports/{exportId}

Reverses an export.

GET api/entity1098exports/exportcompleted?fileName={fileName}

Download completed file

IrsEntity1098Parameters

Entities and Parameters for 1098

APIDescription
GET api/entities/{entityId}/entity1098parameters?year={year}

Get entity parameters by the entity id and year combination

POST api/entity1098parameters

Create an entity parameter

PUT api/entity1098parameters/{id}

Update an entity parameters

IrsEntity1099Exports

1099 Exports

APIDescription
GET api/irs1099exports/search?Year={Year}&TaxProfileId={TaxProfileId}

Get entities ready to export for the tax year

GET api/irs1099exports/correctionSearch?Year={Year}&TaxProfileId={TaxProfileId}

Get entities ready to correct for the tax year

POST api/irs1099exports/correction?year={year}&taxProfileId={taxProfileId}

Export Correction Filing.

POST api/irs1099exports

Export Regular Filing.

GET api/irs1099exports/{year}/completed

Retrieves all completed 1099 exports for the provided year

GET api/irs1099exports/completed/{exportId}

Retrieves completed 1099 exports for the provided year

DELETE api/irs1099exports/{exportId}

Reverses an export.

GET api/irs1099exports/exportcompleted?fileName={fileName}

Download completed file

IrsTaxProfile

Tax profile controller

APIDescription
GET api/taxprofile/{id}

Get Profile By Id

GET api/taxprofile

Get all Tax Profiles

PUT api/taxprofile/{id}

Update a Tax Profile

POST api/taxprofile

Insert/Create a Tax Profile

IrsVendor1099

1099 Exports

APIDescription
GET api/Irs1099s/{id}

Get vendor 1099.

GET api/Irs1099s/exist?glEntityId={glEntityId}&vendorId={vendorId}&taxYear={taxYear}

Get vendor 1099.

POST api/Irs1099s/process1099s

Generates Vendor 1099s

GET api/Irs1099s/search?glEntityId={glEntityId}&year={year}

Search IRS 1099 Vendors

GET api/Irs1099s/{id}/boxes

Get IRS 1099 boxes by vendor 1099

PUT api/Irs1099s/{id}/boxes

Update IRS 1099 boxes by vendor 1099

POST api/Irs1099s/Import1099K

Import IRS Vendors 1099-K

GET api/Irs1099s/downloadprintedfile?irs1099vendorId={irs1099vendorId}&documentId={documentId}

Get vendor 1099 printed file

GET api/Irs1099s/searchprintedfiles?year={year}&entityId={entityId}&irs1099VendorId={irs1099VendorId}&offset={offset}&limit={limit}&orderBy={orderBy}&orderDirection={orderDirection}

Search for vendor 1099 printed files

POST api/Irs1099s/ExportCorrectionsTest/{exportId}

To test Export vendor 1099 corrections

GET api/Irs1099s/exporterror?fileName={fileName}

Download report file

IrsVendor1099HistoryNote

1099 Vendor History Notes Controller

APIDescription
POST api/Irs1099HistoryNotes

Add Notes in History Table

GET api/Irs1099s/{vendor1099Id}/Irs1099HistoryNotes

Retrieve notes per vendor

JournalEntries

APIDescription
POST api/journalentries/inquiry

GET journal entries inquiry

GET api/journalentries/{journalEntryId}/canNavigate?sourceId={sourceId}

verifies on active navigation links base on journal entry id

POST api/journalentries/inquiry/export

exports to csv

POST api/journalentries/preview

Create journal entries but does not commit the data to the database

POST api/journalentries

Post Create journal entries with or without attachment. Send request as form data with 2 keys: file (file to upload) and viewModelJsonFormControlName (json body of JournalEntryCreateListViewModel).

PUT api/journalentries/{journalEntryId}/preview

Update journal entry but does not commit the data to the database

PUT api/journalentries/{journalEntryId}

Update journal entry with or without attachment

GET api/journalentries/{journalEntryId}/details

Get detailed journal entry

GET api/journalentries/accountbalance?chartOfAccoutnId={chartOfAccoutnId}&entityId={entityId}

Get Account Balance

GET api/journalentries/unpostedlines?chartOfAccoutnId={chartOfAccoutnId}&superEntityId={superEntityId}

Get unposted journal entries

POST api/journalentries/post

Post unposted journal entries for Tiered and No Tiered entities, creating intercompany accounts journal entries as well

POST api/journalentries/delete

Delete unposted Journal Entries

JournalEntriesImport

APIDescription
POST api/journalentries/importpreview

Upload, parse and validates journal entries import file.

POST api/journalentries/import

Create journal entries and move file to download folder.

GET api/journalentries/template?templateName={templateName}

Template for importing Journal Entries

JournalEntryAttachments

APIDescription
PUT api/journalentries/updateattachmentforje/{journalEntryId}

Update attachment from a journal entry

GET api/journalentries/{journalEntryAttachmentId}/Attachment

Download a byte array with the Attachment information

JournalEntryCashLines

APIDescription
GET api/journalentries/cashlines/unmatched?bankReconciliationId={bankReconciliationId}&journalEntryLineItemType={journalEntryLineItemType}

GET api/journalentries/cashlines/matched?bankReconciliationId={bankReconciliationId}&journalEntryLineItemType={journalEntryLineItemType}

GET api/journalentries/cashlines/reconciled?bankReconciliationId={bankReconciliationId}&journalEntryLineItemType={journalEntryLineItemType}

POST api/journalentries/cashlines/{cashLineId}/unreconcile

POST api/journalentries/cashlines/reconcileall?bankReconciliationId={bankReconciliationId}&journalEntryLineItemType={journalEntryLineItemType}

POST api/journalentries/cashlines/unreconcileall?bankReconciliationId={bankReconciliationId}&journalEntryLineItemType={journalEntryLineItemType}

JournalEntryType

JournalEntryTypeController

APIDescription
GET api/journalentrytypes

GET: api/journalentrytypes Get all types

GET api/journalentrytypes/{id}

GET: api/journalentrytypes/{id} Get the type information by the Id

GET api/journalentrytypes/{journalEntryTypeId}/canNavigate?sourceId={sourceId}

KlikPaymentType

KlikPaymentTypeController

APIDescription
GET api/klikpaymenttypes/{id}

GET: api/klikpaymenttypes/{id} Get the item information by the Id

GET api/klikpaymenttypes

GET: api/klikpaymenttypes

LeaseType

Addresses

APIDescription
GET api/lease-types

No documentation available.

LetterDeliveryMethod

LetterDeliveryMethodController

APIDescription
GET api/letterdeliverymethods/{id}

GET: api/letterdeliverymethods/{id} Get the item information by the Id

GET api/letterdeliverymethods

GET: api/letterdeliverymethods

LetterResidentLedgerHistory

Letter Resident Ledger History Controller

APIDescription
GET api/letterresidentledgerhistory

GET: api/letterresidentledgerhistory Get all letter resident ledger history

LockboxDepositSummary

Lockbox Deposit Summary

APIDescription
GET api/lockbox/depositsummary?entityCommunity={entityCommunity}&providerId={providerId}&paymentTypeId={paymentTypeId}&depositDateInit={depositDateInit}&depositDateEnd={depositDateEnd}

Provides results for the search of lockbox reconciliation items

GET api/lockbox/depositsummary/export?entityCommunity={entityCommunity}&providerId={providerId}&paymentTypeId={paymentTypeId}&depositDateInit={depositDateInit}&depositDateEnd={depositDateEnd}

CSV Export of the Summary report based on the seach parameters

LockboxFormats

Controller for obtaining Lockbox Provider Formats

APIDescription
GET api/lockboxproviders/{providerId}/lockboxformats

This method will get all formats linked to a particular provider

LockboxPaymentTypes

APIDescription
GET api/lockbox/paymenttypes/byproviderid?providerId={providerId}

No documentation available.

LockboxProviders

APIDescription
GET api/lockboxproviders

/api/lockboxproviders

GET api/lockboxproviders/Active

/api/lockboxproviders/active

ManagementCompany

Management Company table data

APIDescription
GET api/companies

Get all the management companies

GET api/companies/details

Get all the management companies

GET api/companies/{id}

Get management company by Id

Navigation Links Controller

APIDescription
GET api/navigationlinks?sourceName={sourceName}&categoryName={categoryName}&linkName={linkName}&isEnabled={isEnabled}

Preforms a search by the given paramters returning all matching navigation links

GET api/navigationlinks/{navigationLinkId}/canNavigate

Verifies if navigation link is active and return the permissions for it based on userid and navigationLinkId

GET api/navigationlinks/hierarchy

GET: api/navigationlinks/hierarchy Get navigation hierarchy

GET api/navigationlinks/{navigationLinkId}/pagecontrols

Gets page controls data for the provided navigation link id.

GET api/navigationlinks/{navigationLinkId}/{componentName}/pagecontrols

Gets user access by navigation link id and component name

GET api/navigationlinks/components/{componentName}

Gets user access by component name

Note

APIDescription
GET api/notes?referenceId={referenceId}&type={type}

GET: api/notes/ Get the notes related to specific object

POST api/notes

POST: api/notes Create notes

GET api/notes/{id}/{type}/notes

Get global document notes

PageControls

Page Controls Controller

APIDescription
GET api/users/{userId}/navigationlinks/{linkId}/pagecontrols/access

This method allows to retrieve the user access to the page controls of a link

ParkingSpace

ParkingSpaceController

APIDescription
GET api/spaces/{id}

Get space by ID

GET api/buildings/{buildingId}/spaces

Get all spaces that belong to specified building ID

GET api/buildings/{buildingId}/buildingspacesaudittrails

Get audittrail by building Id

POST api/buildings/{buildingId}/spaces

Insert a new Space

PUT api/buildings/{buildingId}/spaces/{spaceId}

Update Space by ID

DELETE api/buildings/{buildingId}/spaces/{spaceId}

Delete space by ID

Payees

APIDescription
GET api/invoices/{id}/payee

Get payee based on invoice id

GET api/entity/{id}/payees

Get payee based on entity id

POST api/payeeslist

Return list of payees based on list of payeeIDs

Payments

APIDescription
GET api/payments/autopaymentissuance?invoiceSelectionId={invoiceSelectionId}&vendorTypeId={vendorTypeId}&managementCompanyId={managementCompanyId}&specialHandlingId={specialHandlingId}&payeeId={payeeId}

Returns the info of payments ready to autopay

POST api/payments/preview

Preview bulk entities

POST api/payments/print

Print Bulk entities

POST api/payments/preview/single

preview checks for single entity

POST api/payments/print/single

print checks for single entity

GET api/payments/build/attachments?fileName={fileName}

download file from download section

PaymentType

Payment Type

APIDescription
GET api/paymenttypes

GET: api/paymenttypes

Provider

Controller to expose endpoints to Provider

APIDescription
GET api/provider/providerIdByName/{name}

GET: providerIdByName/{name}

RecurringInvoices

Recurring Invoices

APIDescription
POST api/recurringinvoices/runinvoices

POST api/recurringinvoices/runinvoices Look for eligible recurring invoices and process them

RecurringJournalEntry

RecurringJournalEntryController

APIDescription
POST api/recurringjournalentries/run

Insert a new RecurringJournalEntry

RecurringTransactions

Recurring Transactions (recurring charge or credit).

APIDescription
GET api/recurringTransactions/{id}

Returns a recurring transaction by its id.

GET api/recurringTransactions/group/{groupId}

Get list of recurring charges belonging to the same group id

POST api/recurringTransactions?retroChargesPostDate={retroChargesPostDate}&retroChargesDescription={retroChargesDescription}

Post, Create new recurring Transaction (recurring charge or credit)

POST api/recurringTransactions/group/increase?groupId={groupId}&amount={amount}&effectiveDate={effectiveDate}&userId={userId}&retroChargesPostDate={retroChargesPostDate}&retroChargesDescription={retroChargesDescription}

Performs a group increase on a charge.

POST api/recurringTransactions/group/creditIncrease

Performs a group increase on a credit.

DELETE api/recurringTransactions/group/delete?recurringChargeId={recurringChargeId}&userId={userId}

Deletes a recurring charge from a group. Will update the end date of previous charge with the end date of deleted recurring charge.

PUT api/recurringTransactions

Updates a Recurring Transaction.

GET api/recurringTransactions/preview/insert?BuildingId={BuildingId}&ChargeCodeId={ChargeCodeId}&UnitId={UnitId}&UnitType={UnitType}&ChargeCodeAdjustedCodeId={ChargeCodeAdjustedCodeId}&OverrideDueDay={OverrideDueDay}&StartDate={StartDate}&EndDate={EndDate}&Rate={Rate}&Amount={Amount}&Type={Type}&ApplyToId={ApplyToId}&CreatedBy={CreatedBy}&IsLinkedCredit={IsLinkedCredit}&LinkedCreditGroupId={LinkedCreditGroupId}&Id={Id}&RetroGLPostDate={RetroGLPostDate}

Preview before the user can submit to create recurring charge Goes through the same process as insert except nothing is created in the db yet

GET api/recurringTransactions/preview/update?Id={Id}&OverrideDueDay={OverrideDueDay}&StartDate={StartDate}&EndDate={EndDate}&Amount={Amount}&ModifiedBy={ModifiedBy}&AdjustedCodeId={AdjustedCodeId}&EffectiveDate={EffectiveDate}

Preview for updating recurring transaction

GET api/recurringTransactions/preview/group/increase?groupId={groupId}&amount={amount}&effectiveDate={effectiveDate}&userId={userId}

Get Preview for Group Increase

GET api/recurringTransactions/preview/export/excel/charges/add?BuildingId={BuildingId}&ChargeCodeId={ChargeCodeId}&UnitId={UnitId}&UnitType={UnitType}&ChargeCodeAdjustedCodeId={ChargeCodeAdjustedCodeId}&OverrideDueDay={OverrideDueDay}&StartDate={StartDate}&EndDate={EndDate}&Rate={Rate}&Amount={Amount}&Type={Type}&ApplyToId={ApplyToId}&CreatedBy={CreatedBy}&IsLinkedCredit={IsLinkedCredit}&LinkedCreditGroupId={LinkedCreditGroupId}&Id={Id}&RetroGLPostDate={RetroGLPostDate}

Export to Excel add Recurring Charges

GET api/recurringTransactions/preview/export/excel/charges/edit?Id={Id}&OverrideDueDay={OverrideDueDay}&StartDate={StartDate}&EndDate={EndDate}&Amount={Amount}&ModifiedBy={ModifiedBy}&AdjustedCodeId={AdjustedCodeId}&EffectiveDate={EffectiveDate}

Export to Excel edit Recurring Charges

GET api/recurringTransactions/preview/export/excel/globalAdjustment?entityId={entityId}&ChargeCodeId={ChargeCodeId}&AdjustmentOption={AdjustmentOption}&Action={Action}&StartDate={StartDate}&Value={Value}&UserId={UserId}&Type={Type}&RetroGLPostDate={RetroGLPostDate}

Generate Global Adjustment Export to Excel

GET api/recurringTransactions/preview/export/excel/groupincrease?groupId={groupId}&amount={amount}&effectiveDate={effectiveDate}&userId={userId}&retroGLPostDate={retroGLPostDate}

Generate Group Increase Export to Excel

RejectedInvoice

RejectedInvoiceController

APIDescription
GET api/rejectedinvoices/{id}

GET: api/rejectedinvoices/{id} Get the item information by the Id

GET api/rejectedinvoices

GET: api/rejectedinvoices

POST api/rejectedinvoices

Insert a new RejectedInvoice

PUT api/rejectedinvoices/{id}

Update a RejectedInvoice

ReservedFundBalance

Reserved Fund Controlelr

APIDescription
GET api/entities/{glEntityId}/reservedfund

Get reserved fund balance

Resident

APIDescription
GET api/units/{unitId}/residents?status[0]={status[0]}&status[1]={status[1]}

Get all residents inside a unit

GET api/residents/findbyaccount?entityNumber={entityNumber}&buildingNumber={buildingNumber}&unitNumber={unitNumber}&residentNumber={residentNumber}&residentStatus={residentStatus}

Get resident by account number. Exclusively used by Connect gRPC. In the future, Connect gRPC will call CamAcct Resident Profile gRPC instead of this longer trip.

GET api/residents/search?entityId={entityId}&formerAccountNumber={formerAccountNumber}&residentName={residentName}&address={address}&city={city}&state={state}&postalCode={postalCode}&country={country}&maximumSearchResults={maximumSearchResults}

Get resident by parameters

GET api/residents/{residentId}/profile

Get Resident Profile

POST api/residents/profile

Create Resident Profile

PUT api/residents/{residentId}/profile

Save Resident Profile

GET api/residents/{residentId}/audittrails

Get Audit Trails ordered by date descending

ResidentBilling

ResidentBillingController

APIDescription
GET api/residentbillings

GET: api/residentbillings

ResidentCreditHistory

Resident Credit History Controller

APIDescription
GET api/residents/creditHistory/importTemplate

Get resident credit history template

POST api/residents/creditHistory/import

POST: api/residentcredithistory/import Import resident credit history codes from csv file

GET api/residents/{residentId}/creditHistory?startDate={startDate}&endDate={endDate}

Get resident credit history. Exclusively used by Connect gRPC.

GET api/residents/{residentId}/creditHistory/current

No documentation available.

GET api/residents/{residentId}/creditHistory/all

Get Resident Credit History All

GET api/residents/{residentId}/creditHistory/all/export?orderBy={orderBy}&orderDesc={orderDesc}

Get credit history for selected resident as csv file

POST api/residents/{residentId}/creditHistory

Create Resident Credit History

DELETE api/residents/{residentId}/creditHistory/{creditHistoryId}

Delete resident credit history

GET api/residents/{residentId}/creditHistory/{creditHistoryId}

Get resident credit history detail

PUT api/residents/{residentId}/creditHistory/{creditHistoryId}

Save Resident Credit History

ResidentCreditHistoryAudit

Resident Credit History Controller

APIDescription
GET api/residents/{residentId}/credithistoryaudittrails

Get Audit Trails ordered by date descending

ResidentLedger

APIDescription
GET api/residents/{residentId}/ledger?pageSize={pageSize}&pageNum={pageNum}&orderBy={orderBy}&orderDesc={orderDesc}&startDate={startDate}&subAccountId={subAccountId}&type={type}&chargeCodesDisplayCodes[0]={chargeCodesDisplayCodes[0]}&chargeCodesDisplayCodes[1]={chargeCodesDisplayCodes[1]}&batchId={batchId}&transactionId={transactionId}&adjustedCodes[0]={adjustedCodes[0]}&adjustedCodes[1]={adjustedCodes[1]}

Get Resident Ledger

GET api/residents/{residentId}/ledger/export?startDate={startDate}&subAccountId={subAccountId}&type={type}&chargeCodesDisplayCodes[0]={chargeCodesDisplayCodes[0]}&chargeCodesDisplayCodes[1]={chargeCodesDisplayCodes[1]}&batchId={batchId}&adjustedCodes[0]={adjustedCodes[0]}&adjustedCodes[1]={adjustedCodes[1]}

No documentation available.

GET api/residents/{residentId}/ledger/balance?untilDate={untilDate}

get resident balance untill some date

GET api/residents/ledger/getJournalEntriesIds?batchId={batchId}&transactionType={transactionType}

No documentation available.

POST api/residents/ledgeritemsdetail

No documentation available.

ResidentNote

APIDescription
GET api/residents/{residentId}/notes

Get Audit Notes

POST api/residents/{residentId}/notes

Create Audit Note

POST api/residents/{residentId}/residentNotes

Create resident note

PUT api/residents/{residentId}/residentNotes/{residentNoteId}

Save resident note

GET api/residents/{residentId}/residentNotes

Get resident notes

GET api/residents/{residentId}/residentNotes/{residentNoteId}

Get resident note by id

DELETE api/residents/{residentId}/residentNotes/{residentNoteId}

Delete resident note

GET api/residents/{residentId}/residentNotesaudittrails

Get Resident Notes and Diaries (Ticklers) Audit Trails ordered by date descending

ResidentNoteType

ResidentNoteType

APIDescription
GET api/residents/noteTypes

GET: api/residents/noteTypes Get Resident Note Types

POST api/residents/noteTypes

Create resident note type

PUT api/residents/noteTypes/{code}

Save resident note type

ResidentReceipts

APIDescription
GET api/residents/{residentId}/receipts?receiptType={receiptType}&startDate={startDate}&endDate={endDate}&excludeRefundedLines={excludeRefundedLines}

Get Security Deposit payments by residentId and date. Use yyyy-mm-dd format for date param

GET api/residents/{residentId}/securityDeposits?pageSize={pageSize}&pageNum={pageNum}&orderBy={orderBy}&orderDesc={orderDesc}&startDate={startDate}&endDate={endDate}

Get Resident Security Deposits exclusively for Connect.

GET api/residents/{residentId}/receipts/securityDeposits?pageSize={pageSize}&pageNum={pageNum}&orderBy={orderBy}&orderDesc={orderDesc}&startDate={startDate}&endDate={endDate}

Get Resident Security Deposits

GET api/residents/{residentId}/receipts/securityDeposits/export?entityNumber={entityNumber}&buildingNumber={buildingNumber}&unitNumber={unitNumber}&residentName={residentName}

exports to csv

POST api/residents/{residentId}/receipts/securityDeposits/refund

Posting Ar Refunds

ResidentRecurringTransactions

APIDescription
GET api/residents/{residentId}/recurringTransactions?type={type}&startDate={startDate}

Get all recurring charges, past, present, and future, by resident when date is not passed in Pass in date if searching for charges by start date

GET api/residents/{residentId}/recurringTransactions/all?orderBy={orderBy}&orderDesc={orderDesc}&pageSize={pageSize}&pageNum={pageNum}

Get recurring charges for the resident selected

GET api/residents/{residentId}/recurringTransactions/all/export?orderBy={orderBy}&orderDesc={orderDesc}

Get recurring charges for the resident selected as a csv file

GET api/residents/{residentId}/recurringTransactions/detailedRecurringTransactions?startDate={startDate}&endDate={endDate}

Return resident detailed recurring transactions

ResidentRepresentatives

Resident Representative Controller

APIDescription
GET api/residents/{residentId}/representatives

Get representatives

ResidentSettings

APIDescription
GET api/residents/{residentId}/settings

Get Resident Settings

POST api/residents/settings/noLateFees

No documentation available.

PUT api/buildings/{buildingId}/units/{unitId}/residents/{residentId}/settings

Save Resident Settings

ResidentStage

APIDescription
GET api/ResidentStage?stageExecutionId={stageExecutionId}

No documentation available.

ResidentStageAction

APIDescription
GET api/ResidentStageAction?residentStageId={residentStageId}

No documentation available.

ResidentStageActionException

Controller to expose endpoints to manage resident action exceptions

APIDescription
GET api/actionexceptions?residentId={residentId}&actionId={actionId}

Get exceptions given the resident id

POST api/actionexceptions

No documentation available.

DELETE api/actionexceptions/delete?actionExceptionId={actionExceptionId}

Delete resident action exception

ResidentStatuses

APIDescription
GET api/resident-statuses

No documentation available.

ResidentSubaccount

ResidentSubaccountController

APIDescription
GET api/residentsubaccounts

GET: api/residentsubaccounts Get all items

ResidentTicklers

APIDescription
POST api/residents/{residentId}/ticklers

Create resident tickler

GET api/residents/{residentId}/ticklers?includeUnitTicklers={includeUnitTicklers}

Returns resident ticklers

GET api/tickler/{ticklerId}

Get Tickler

PUT api/tickler/{ticklerId}

Save tickler

DELETE api/tickler/{ticklerId}

Delete tickler

ReturnCode

ReturnCodeController

APIDescription
GET api/returncodes/{id}

GET: api/returncodes/{id} Get the return code information by the Id

GET api/returncodes?code={code}

GET: api/returncodes?code=CC Get the return code information by the Code

GET api/returncodes

GET: api/returncodes

POST api/returncodes

Insert a return code Code Name, CreatedBy and description are required

PUT api/returncodes

Update a return code ModifiedOn, ModifiedBy, Description and Details are the only values that can be modified

ReturnedCheckFeeAmount

ReturnedCheckFeeAmountController

APIDescription
GET api/returnedcheckfeeamounts/{id}

GET: api/returnedcheckfeeamounts/{id} Get the item information by the Id

GET api/returnedcheckfeeamounts

GET: api/returnedcheckfeeamounts

GET api/buildings/{buildingId}/returnedcheckfeeamounts

GET: api/returnedcheckfeeamounts/{id} Get the item information by the Id

POST api/returnedcheckfeeamounts

Insert a new ReturnedCheckFeeAmount

PUT api/returnedcheckfeeamounts/{id}

Update a ReturnedCheckFeeAmount

DELETE api/returnedcheckfeeamounts/{id}

Update a ReturnedCheckFeeAmount

Role

Roles

APIDescription
GET api/roles

GET: api/roles Get All roles

PUT api/roles/{roleId}

Update role

RSMPackage

Reporting Suite Manager Packages

APIDescription
POST api/rsmPackages/run?PackageId={PackageId}&Month={Month}&Year={Year}&UserId={UserId}&EntityId={EntityId}&IncludeSubEntities={IncludeSubEntities}&IncludeFund={IncludeFund}&IncludeExternalDocuments={IncludeExternalDocuments}

Run Package by Id, Entity Id, Month, and Year UserId required for history tracking

GET api/rsmPackages?isOnlyTemplates={isOnlyTemplates}

Get All Packages that are not marked as deleted

GET api/rsmPackages/packageReports

No documentation available.

GET api/rsmPackages/{id}

Get Package By Package ID

POST api/rsmPackages

Insert a new package Package Name, CreatedBy, CreatedBy and at least 1 report is required

PUT api/rsmPackages

Update a package ModifiedOn, ModifiedBy, and at least 1 report is required

DELETE api/rsmPackages?id={id}&userId={userId}

Delete a package Soft Deletion

GET api/rsmPackages/search?entityId={entityId}&packageName={packageName}&startTimeFrom={startTimeFrom}&startTimeTo={startTimeTo}&lastRunForFrom={lastRunForFrom}&lastRunForTo={lastRunForTo}&userId={userId}&showOnlyGlobal={showOnlyGlobal}&showOnlyCustom={showOnlyCustom}

Search for packages with list of optional parameters

GET api/rsmPackages/download?fileName={fileName}

Download report file

RSMPackageHistory

Reporting Suite Manager Status

APIDescription
GET api/rsmPackageHistory/search?entityId={entityId}&packageName={packageName}&startTimeFrom={startTimeFrom}&startTimeTo={startTimeTo}&lastRunForFrom={lastRunForFrom}&lastRunForTo={lastRunForTo}&statusIds[0]={statusIds[0]}&statusIds[1]={statusIds[1]}&userId={userId}

Search Package History Returns only user specific history if userid is provided

RSMPackageStatus

Reporting Suite Manager Package statuses

APIDescription
GET api/rsmPackageStatus

Get all the statuses in the table

RSMRecurringPackageProfiles

Recurring Package Profiles

APIDescription
GET api/recurringPackageProfiles?ids[0]={ids[0]}&ids[1]={ids[1]}

Get Recurrence Profiles by Ids.

GET api/recurringPackageProfiles/search?entityId={entityId}&packageName={packageName}

Search Recurrence Profiles by package Name and entity Id.

GET api/recurringPackageProfiles/runForOptions

Gets all valid Time Period options for recurring package profiles.

POST api/recurringPackageProfiles?userId={userId}

Creates a new RecurringPackageProfile in the database

PUT api/recurringPackageProfiles/{profileId}?userId={userId}

Updates a RecurringPackageProfile in the database

DELETE api/recurringPackageProfiles/{profileId}?userId={userId}

Deletes a RecurringPackageProfile from the database(Soft Delete)

RSMReport

Reporting Suite Manager Reports

APIDescription
GET api/rsmReports?entityId={entityId}

Get All Reports for RSM where entity id are nulls Pass in EntityId to also get entity specific report

GET api/rsmReports/{id}

Get Report by ID

GET api/rsmReports/GetReportsByReportTypeId/{reportTypeID}/{reportStyleID}

Get Report by reportTypeID and reportStyleID

PUT api/rsmReports

Update Reports ModifiedOn, ModifiedBy, and at least 1 report is required

RSMReportStyle

Reporting Suite Manager Report Styles

APIDescription
GET api/rsmReportStyles

Get All Report Styles for RSM

GET api/rsmReportStyles/getById?id={id}

Get All StyleTypes for RSM

RSMReportType

Reporting Suite Manager Report Types

APIDescription
GET api/rsmReportTypes

Get All ReportTypes for RSM

GET api/rsmReportTypes?id={id}

Get All ReportTypes for RSM

RSMRunType

Reporting Suite Manager Run Types

APIDescription
GET api/rsmRunTypes

Get All RunTypes for RSM

SecurityDepositType

APIDescription
GET api/securitydeposittypes

Get all active security deposit types

Ssis

SSIS Controller

APIDescription
POST api/ssis/bai/import?filename={filename}

Run SSIS for BAI file

GET api/ssis/bai/getstatus?executionId={executionId}

Get status from BAI SSIS package

StageExecution

APIDescription
GET api/StageExecution?engineExecutionId={engineExecutionId}

No documentation available.

StatementApproval

StatementApprovalController

APIDescription
GET api/statementapprovals/{id}

Get Statement Approval by the Id

GET api/statementapprovals

Get all Statement Approvals

StatementFormat

BankStatementFolderController

APIDescription
GET api/statementformat?onlyDrilldownCapable={onlyDrilldownCapable}

GET: api/statementformat

GET api/statementformat/generate?entityId={entityId}&statementFormat={statementFormat}&periodEnding={periodEnding}&isTiersIncluded={isTiersIncluded}&isUnpostedEntriesIncluded={isUnpostedEntriesIncluded}&fundGroupIds[0]={fundGroupIds[0]}&fundGroupIds[1]={fundGroupIds[1]}&fundIds[0]={fundIds[0]}&fundIds[1]={fundIds[1]}

GET: api/statementformat

StatementNote

StatementNoteController

APIDescription
GET api/statementnotes/{id}

GET: api/statementnotes/{id} Get the item information by the Id

GET api/statementnotes

GET: api/statementnotes

States

States(Country states) Controller

APIDescription
GET api/states?country={country}

Get all states, or filter by country

SuperEntities

APIDescription
GET api/superentities/{superEntityId}

Get super entity by id

PUT api/superentities/{superEntityId}/atbs

Update automated transactional bank assigneed to super entity

GET api/superentities/groups

List of groups super entity

SuperEntityCheckSignature

APIDescription
PUT api/superentities/{superEntityId}/check/signature/password

Update Super Entity signature check password by super entity id

GET api/superentities/{superEntityId}/check/signature/password/requiredinfo

Check if a Sign Password assigned to super entity

Test

APIDescription
GET api/test/cauid

No documentation available.

GET api/test/exception

No documentation available.

GET api/test/srvexception

No documentation available.

GET api/test/repoexception

No documentation available.

GET api/test/baserepo

No documentation available.

GET api/test/notfound

No documentation available.

GET api/test/invalidopp

No documentation available.

GET api/test/badcredentials

No documentation available.

GET api/test/requesthelper

No documentation available.

PUT api/test/nocontent

No documentation available.

GET api/test/hey

GET api/test/ef

EF + SimpleDataAccess Test

GET api/test/camacctpublicapi

No documentation available.

POST api/test/signalr-resourceaction

No documentation available.

GET api/test/testlock

No documentation available.

TicklerType

Tickler

APIDescription
GET api/tickler/types

Get tickler types

GET api/TicklerType

Returns building notes

POST api/TicklerType

Create tickler type

PUT api/TicklerType

Save tickler type

TimePeriods

Time Periods

APIDescription
GET api/timePeriods

Gets all time periods.

TransitNumber

TransitNumberController

APIDescription
GET api/transitnumbers

GET: api/transitnumbers

POST api/transitnumbers

Insert a new TransitNumber

PUT api/transitnumbers

Update a TransitNumber

PUT api/transitnumbers/delete

No documentation available.

PUT api/transitnumbers/migrate

Migrates transit number to another bank

GET api/abanumbers/{abaId}/transitnumbers

Returns transit number for abaId

Unit

Unit Controller

APIDescription
GET api/units/{unitId}/profile

Unit Profile

POST api/units/profile

Create Unit Profile

PUT api/units/{unitId}/profile

Save Unit Profile

GET api/units/{unitId}/address

Get Unit Address

DELETE api/units/{unitId}/spaces/{spaceId}

Delete spaces related with unit

PUT api/units/{unitId}/addSpaces

Add new spaces to unit

GET api/buildings/{buildingId}/units

Get all units inside a building

GET api/units/search?unitIds[0]={unitIds[0]}&unitIds[1]={unitIds[1]}&buildingIds[0]={buildingIds[0]}&buildingIds[1]={buildingIds[1]}&addressIds[0]={addressIds[0]}&addressIds[1]={addressIds[1]}&unitTypeIds[0]={unitTypeIds[0]}&unitTypeIds[1]={unitTypeIds[1]}&unitNumber={unitNumber}

Search units table with a list of optional parameters

GET api/units/selector?buildingIds[0]={buildingIds[0]}&buildingIds[1]={buildingIds[1]}

Unit Search Selector specifically for the entity selector

POST api/units/deleteUnits

No documentation available.

UnitAudit

APIDescription
GET api/units/{unitId}/audittrails

Get Audit Trails ordered by date descending

GET api/units/{unitId}/notes

Get Audit Notes

POST api/units/{unitId}/notes

Create Audit Note

UnitOfMeasure

UnitOfMeasureController

APIDescription
GET api/unitsofmeasure/{id}

GET: api/unitofmeasures/{id} Get the item information by the Id

GET api/unitsofmeasure

GET: api/unitofmeasures

UnitTickler

APIDescription
POST api/units/{unitId}/ticklers

Create unit tickler

POST api/tickler

POST: api/debitmemo

UnitType

Unit Type

APIDescription
GET api/unitTypes/search?unitTypeId={unitTypeId}&buildingId={buildingId}

Search Unit Types by Id, Building Id, or return all if blank

GET api/buildings/{buildingId}/unittypes

Get unit types by buildilng

POST api/unitTypes

Insert new unit type

PUT api/unitTypes/{unitTypeId}

Update unit type

DELETE api/unitTypes/{unitTypeId}

Delete unit type

GET api/buildings/{buildingId}/buildingunittypesaudittrails

Get audittrail by building Id

UserAccess

Navigation Links Controller

APIDescription
GET api/userAccess

GET: get the current(authenticated) user access. Returns a user access object that contains the list of Sources-&gt;Categories-&gt;Links-&gt;Page Controls that the user has access to.

GET api/users/access/super-entity/{superEntityId}/bank-reconciliation

Get all Users by superEntityId that has access to Bank Reconciliation

Users

Users Controller

APIDescription
GET api/users

GET: api/users Get All users

GET api/users/ids?ids[0]={ids[0]}&ids[1]={ids[1]}

GET: gets the users details

GET api/users/search?userName={userName}

No documentation available.

GET api/users/identitySearch?firstName={firstName}&lastName={lastName}&email={email}

No documentation available.

POST api/users

No documentation available.

VendorAttachment

VendorAttachmentController

APIDescription
GET api/vendors/{vendorId}/attachments/{attachmentId}

Get the item information by the Id

GET api/vendors/{vendorId}/attachments

Get vendor attachments for specific vendor

DELETE api/vendors/{vendorId}/attachments/{attachmentId}

Delete an attachments for a specific vendor

POST api/vendors/{vendorId}/attachments

Insert vendor attachmente

VendorAudit

Vendor Audit Trails

APIDescription
GET api/vendors/{id}/audittrails

Get audittrail by vendor id

GET api/vendors/{id}/notes

Get notes

POST api/vendors/{id}/notes

Insert user note

VendorCompliance

VendorComplianceController

APIDescription
GET api/vendors/{vendorId}/compliances

GET: api/vendors/{vendorId}/compliances Get a Vendor Compliance by vendorId

POST api/vendors/{vendorId}/compliances

POST: api/vendors/{vendorId}/compliances Insert a new Vendor Compliance

PUT api/vendors/{vendorId}/compliances/{complianceId}

PUT: api/vendors/{vendorId}/compliances/{complianceId} Update a Vendor Compliance

DELETE api/vendors/{vendorId}/compliances/{complianceId}

DELETE: api/vendors/{vendorId}/compliances/{complianceId} Delete a Vendor Compliance

GET api/vendors/{vendorId}/compliancesaudittrails

Get audit trail by vendor id

GET api/vendors/{vendorId}/compliancesnotes

Get notes by vendor id

POST api/vendors/{vendorId}/compliancesnotes

Create vendor compliance user note

VendorEntity

VendorEntity

APIDescription
POST api/VendorEntity/StartBalance

Insert Vendor-Entity Beginning balances

GET api/VendorEntity/SearchStartBalance?vendorid={vendorid}&entityid={entityid}&startyear={startyear}&endyear={endyear}&startbalance={startbalance}&endbalance={endbalance}

Search begining balances by different parameters

VendorEntityLinkAudit

APIDescription
GET api/vendors/{vendorId}/entitiesaudittrails

Get Entities AudiTrail by Vendor

GET api/vendors/{vendorId}/entitiesnotes

Get Entitiy Notes by Vendor

POST api/vendors/{vendorId}/entitiesnotes

Insert user note

Vendor Entity Links Controller

APIDescription
POST api/VendorEntityLinks?irs1099Only={irs1099Only}&activeOnly={activeOnly}

Search Vendor Entity Links by super entity id.

GET api/vendors/{vendorId}/entities

No documentation available.

PUT api/vendors/{vendorId}/entities

Search Entities by vendor id.

VendorInvoices

APIDescription
GET api/vendors/{id}/invoices?invoicenumber={invoicenumber}&entityid={entityid}

Get invoice payee information by vendor and invoicenumber

Vendors

Vendor

APIDescription
GET api/v2/vendors/search

Search vendors based on query parameters

GET api/Vendors/search?actives={actives}&is1099={is1099}

Search active/inactive and optionally 1099 vendors

POST api/Vendors

Gets Vendors. Http verb is POST so that the ids can be passed in the body of the request. THIS METHOD SHOULD NATURALLY BE A GET BUT DUE TO URL LENGTH LIMITATIONS I'M MAKING IT POST SO THAT THE IDS CAN BE PASSED IN THE BODY OF THE REQUEST

GET api/Vendors/{vendorId}/details

Get Vendor Details By ID

PUT api/Vendors/{vendorId}

Update vendor

POST api/v2/vendors

Create vendor

POST api/vendors/{year}/ToProcess1099

Search Vendor by super entity with payments in the Tax Year to be included in 1099.

VendorService

VendorServicesController

APIDescription
GET api/vendorservices

GET: api/vendorservices

VendorsExport

APIDescription
POST api/vendors/export

exports to csv

VendorsImport

Vendors Import

APIDescription
POST api/vendors/import?validateWarnings={validateWarnings}

Vendor Import

POST api/vendors/import/update?validateWarnings={validateWarnings}

Vendor Update

POST api/vendors/import/entity/beginning-balances

Vendor import beginning balance

GET api/vendors/import/template/{templateName}

get vendors imports templates

POST api/vendors/import/saveOriginalFile

Save Original File

POST api/vendors/import/saveErrorFiles

Save Error File

POST api/vendors/import/entity/assign

Import Assign Entities file.

VendorType

VendorTypeController

APIDescription
GET api/vendortypes

GET: api/vendortypes

WelcomeLinkConfig

Controller to expose endpoints to manage welcome link

APIDescription
GET api/superentities/{superEntityId}/welcomelinkconfig

Get Welcomelink with given Super Entity Id

POST api/welcomelinkconfig/getWelcomeLinkConfig

Return welcome link configuration based on entity numbers provided

WLCorrespondence

Controller to expose endpoints to WlCorrespondence

APIDescription
GET api/wlcorrespondence

Get all WLCorrespondence

GET api/wlcorrespondence/{wlCorrespondenceId}

Get WLCorrespondence with given Id

GET api/companies/{managementCompanyId}/wlcorrespondence

No documentation available.

POST api/wlcorrespondence

Create WLcorrespondence

GET api/wlcorrespondence/downloadfiletypes

GET: api/wlcorrespondence/downloadfiletypes Get the valid downloadfiletypes for wlcorrespondense

PUT api/wlcorrespondence/{wlCorrespondenceId}

Update unit type

GET api/wlcorrespondence/{wlCorrespondenceId}/audittrails

Returns List of Audit Trails for Fund

GET api/wlcorrespondence/{wlCorrespondenceId}/notes

Returns wlCorrespondence notes

POST api/wlcorrespondence/{id}/notes

Insert wlCorrespondence user note

WorkflowStatus

WorkflowStatusController

APIDescription
GET api/workflowstatus/{id}

GET: api/workflowstatus/{id} Get the workflow status information by the Id

GET api/workflowstatus

GET: api/workflowstatus

POST api/workflowstatus

POST: api/workflowstatus Insert a new Workflow Status

PUT api/workflowstatus/{workflowStatusId}

PUT: api/workflowstatus/{workflowStatusId} Edit a Workflow Status

WriteOffChargeCodeType

WriteOffChargeCodeTypeController

APIDescription
GET api/writeOffChargeCodeTypes/{id}

GET: api/writeoffconfigurations/{id} Get the item information by the Id

GET api/writeOffChargeCodeTypes

GET: api/writeoffconfigurations

POST api/writeOffChargeCodeTypes

Insert a new WriteOffConfiguration

DELETE api/writeOffChargeCodeTypes?id={id}

Delete a writeoffChargeType by id

DELETE api/writeOffChargeCodeTypes/chargeCodeTypeId?id={id}

Delete a writeoffChargeType by chargeCodeTypeId