Tyler new world Web API Help Page

Introduction

This Web API exposes specific functionality offered by Tyler new world ERP Suite of Applications to third party vendors.

Department

Represents new world ERP Org Structure.

API	Description
GET api/suite/v1/department	Returns Department objects.

EquifaxAuthorize

Represents new world ERP Equifax system info controller.

API	Description
GET api/hr/v1/equifax/servicepre/IAuthorizeService/GetSystemInfo	Returns system info.

Employee

Represents new world ERP Employee.

API	Description
GET api/hr/v1/employee	Returns Employee objects.

AccountById

Represents new world ERP Utility Management Account.

API	Description
GET api/um/v1/accountByID/{utilityAccountID}	Returns Account object for requested utility account ID.

StatementHistory

Represents new world ERP Utility Management Account Statement History.

API	Description
GET api/um/v1/statementhistory/{accountNumber}/{startDate}	Returns collection of PaymentHistory object for requested account number.

WorkOrderCreatedDate

Represents new world ERP Utility Management Work Order.

API	Description
GET api/um/v1/workorder/createddate/{startDateTime}	Returns list of work orders created on or after given date.

AssetsMobile

API	Description
GET api/tyler/v1/assetsmobile/Get_Assets	No documentation available.

TylerCashiering

API	Description
GET api/tyler/tylercashiering/standardapi/v2/Test	No documentation available.
POST api/tyler/tylercashiering/standardapi/v2/ProvidePaymentTypes	No documentation available.
POST api/tyler/tylercashiering/standardapi/v2/ProvideSearchGroups	No documentation available.
POST api/tyler/tylercashiering/standardapi/v2/SearchForCustomers	No documentation available.
POST api/tyler/tylercashiering/standardapi/v2/SearchForItems	No documentation available.
POST api/tyler/tylercashiering/standardapi/v2/Validate	No documentation available.
POST api/tyler/tylercashiering/standardapi/v2/ProcessTransaction	No documentation available.
POST api/tyler/tylercashiering/standardapi/v2/ProcessVoidTransaction	No documentation available.
POST api/tyler/tylercashiering/standardapi/v2/CloseBatch	No documentation available.

Home

API	Description
GET api/Revision	No documentation available.
GET api/About	No documentation available.

Insite

API	Description
GET api/esuite/v1/insite/Accounts/{accountNumber}/Customers/{customerNumber}/Bill/{billId}	No documentation available.

TylerPayment

API	Description
GET api/esuite/v1/tylerpayments/TestConnection	This method implements the response for the External system 'Test connection' button that 12233333 can be found in the PaymentIntegrationGatewayAdmin app (e.g. http://dev.localdev.tcpci.com/payments/paymentintegrationgatewayadmin/external-systems/29dc122c-d6df-4081-aef4-61fdd1b37173)
POST api/esuite/v1/tylerpayments/ProcessTransaction	The purpose of this method is for the integrating system to perform post-transaction processing activities if necessary and record receipts, and to indicate whether this processing is complete. Tyler Payment calls this method to notify the external system when a Payment has been authorized and a transaction recorded.
POST api/esuite/v1/tylerpayments/Validate	The purpose of this method is to verify whether a list of Payments are valid and can be paid, and to return a list of descriptive errors if necessary. Tyler Payments performs this validation prior to initiating a payment, and prior to authorizing it.
POST api/esuite/v1/tylerpayments/ProcessVoidTransaction	Processes the void of a single transaction. The transaction may contain more than one payment if multiple bills were paid at the same time.
POST api/esuite/v1/tylerpayments/CloseBatch	Closes a single batch.

WorkOrderNumber

Represents new world ERP Utility Management Work Order.

API	Description
GET api/um/v1/workorder/number/{workOrderNumber}	Return WorkOrder object for given work order number.

ConsumptionHistory

Represents new world ERP Utility Management Account Consumption History.

API	Description
GET api/um/v1/consumptionhistory/{accountNumber}/{startDate}	Returns collection of ConsumptionHistory object for requested account number.

Autopay

API	Description
POST api/esuite/v1/tylerpayments/AutopayRegistration	This sends a request to Tyler Payments to register for autopay Tyler Payments will return a redirecturi that NWERP can use to bring up the autopay registration page in tyler payments.
POST api/esuite/v1/tylerpayments/AutopayCancellation	This sends a request to Tyler Payments to unenroll in an autopay registration

Project

Represents new world ERP Project.

API	Description
GET api/suite/v1/project	Returns Project objects.

WorkOrder

API	Description
POST api/tyler/v1/eam/workorders/{workordernumber}/status	No documentation available.

ExecuTimePayCode

Represents new world ERP Hours Code. ExecuTime has their own controller because they want the accrual hours categories Code and Description to come through as Hours Codes. In their system these will be used as "Parent" hours codes for each "regular" hours codes that effect a balance.

API	Description
GET api/hr/v1/executimepaycode	Returns Hours Code objects.

Accrual

Represents new world ERP Employee Accrual.

API	Description
GET api/hr/v1/accrual	Returns Employee Accrual objects.

SystemCheck

API	Description
GET api/tyler/SystemCheck/v{version}/SystemCheck	No documentation available.
GET api/tyler/SystemCheck/v{version}/StandardLogging?fromDate={fromDate}&toDate={toDate}	No documentation available.
GET api/tyler/SystemCheck/v{version}/eSuiteAuthenticationLog?fromDate={fromDate}&toDate={toDate}	No documentation available.

NotifyScheduledPayment

API	Description
POST api/esuite/v1/tylerpayments/RegisterScheduledPayment	No documentation available.
POST api/esuite/v1/tylerpayments/RegisterCancelledScheduledPayment	No documentation available.
POST api/esuite/v1/tylerpayments/RegisterFailedScheduledPayment	No documentation available.

PayCode

Represents new world ERP Hours Code.

API	Description
GET api/hr/v1/paycode	Returns Hours Code objects.

Parcel

Represents new world ERP Parcel Information.

API	Description
GET api/cd/v1/parcel/GetTransferTypes	Returns Transfer types from Validation Set Entries for the GetTransferTypes method in the Parcel Import Tool.
GET api/cd/v1/parcel/GetParcelOwnerInfo?parcelNumber={parcelNumber}	Returns Parcel Owner Information for the AnalyzeChanges Method in The Parcel Import Tool.
POST api/cd/v1/parcel/AddCentralName	Returns Parcel Owner Change Information and Adds that to the CentralName table for the ProcessChanges Method in The Parcel Import Tool.
POST api/cd/v1/parcel/AddParcelOwnerHistory	Returns Parcel Owner History ID and Adds the parcelOwnerHistoryInfo to the ParcelOwnerHistory table for the ProcessChanges Method in The Parcel Import Tool.
POST api/cd/v1/parcel/AddParcelOwnerInfo	Adds a record to the ParcelOwnerInfo table for the ProcessChanges Method in The Parcel Import Tool.

GlAccount

Represents new world ERP Account.

API	Description
GET api/suite/v1/glaccount	Returns Account objects.

EnterprisePayment

API	Description
POST api/esuite/v1/tylerpayments/ProvidePaymentTypes	No documentation available.
POST api/esuite/v1/tylerpayments/SearchForCustomers	No documentation available.
POST api/esuite/v1/tylerpayments/ProvideSearchGroups	No documentation available.
POST api/esuite/v1/tylerpayments/SearchForItems	No documentation available.

Payment

Represents new world ERP Utility Management Account Payment.

API	Description
POST api/um/v1/payment/{accountNumber}	Creates a payment against specified account.

EventHooks

API	Description
GET api/v1/tyler/apautomation/eventhooks/ping	No documentation available.
GET api/v1/tyler/apautomation/eventhooks/authorizedPing	No documentation available.
POST api/v1/tyler/apautomation/eventhooks/paymentBatchProcessingStatusUpdate	No documentation available.
POST api/v1/tyler/apautomation/eventhooks/paymentRemittanceUpdate	No documentation available.

PayrollImport

Represents new world ERP Payroll Import.

API	Description
POST api/hr/v1/payrollImport	No documentation available.
PUT api/hr/v1/payrollImport	No documentation available.

Account

Represents new world ERP Utility Management Account.

API	Description
GET api/um/v1/account/{accountNumber}	Returns Account object for requested account number.
GET api/um/v1/account?addressNumber={addressNumber}&street={street}&city={city}&state={state}&zip={zip}&zip4={zip4}&apartment={apartment}	No documentation available.

JobClass

Represents new world ERP Position.

API	Description
GET api/hr/v1/jobClass	Returns Position objects.

PaymentHistory

Represents new world ERP Utility Management Account Payment History.

API	Description
GET api/um/v1/paymenthistory/{accountNumber}/{startDate}	Returns collection of PaymentHistory object for requested account number.

BillingItemWorkOrderComplete

API	Description
POST api/um/v1/workorder/billingitem/complete/{number}	No documentation available.

Equifax

Represents new world ERP Equifax.

API	Description
GET api/hr/v1/equifax/servicepre/IEquifaxService/GetAllEmployees	Returns Daily Cache objects.
POST api/hr/v1/equifax/servicepre/IEquifaxService/VerificationOfEmployment	Returns Equifax Employment objects.
POST api/hr/v1/equifax/servicepre/IEquifaxService/VerificationOfIncome	Returns Equifax Income objects.
POST api/hr/v1/equifax/servicepre/IEquifaxService/SocialServiceVerification	Returns Equifax Social Service objects.

BudgetBook

API	Description
GET api/suite/BudgetBook/v1/BudgetBook?fiscalYear={fiscalYear}	No documentation available.

Cypress

API	Description
POST api/tyler/Cypress/v1/AccountInfo	No documentation available.
POST api/tyler/Cypress/v1/AccountInfoOld	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/BillingAndContactInfo	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/BillHistory?historyStartDate={historyStartDate}&getLatestBill={getLatestBill}	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/ConsumptionHistory?historyStartDate={historyStartDate}&serviceCode={serviceCode}&serviceId={serviceId}	No documentation available.
POST api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/TransactionHistory?historyStartDate={historyStartDate}	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/AccountServices?customerNumber={customerNumber}	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/Bills/{billId}/Details	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{sAccountNumber}/Customers/{sCustomerNumber}/Bill/{iBillId}	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/AccountSearch?customerNumber={customerNumber}&mailingStreetAddress={mailingStreetAddress}&lastBillAmount={lastBillAmount}&parcelIdentifier={parcelIdentifier}&serviceStreetAddress={serviceStreetAddress}&nameFromBill={nameFromBill}&phoneNumber={phoneNumber}&lastBillNumber={lastBillNumber}	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Name/{lastName}/UserRegistration	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/ConsumptionChart?startDate={startDate}&endDate={endDate}	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/Receivables	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/AccountBalance	No documentation available.
GET api/tyler/Cypress/v1/Services/Types	No documentation available.
GET api/tyler/Cypress/v1/Transactions/Types	No documentation available.
GET api/tyler/Cypress/v1/Customers/Types	No documentation available.
GET api/tyler/Cypress/v1/Read/Types	No documentation available.
GET api/tyler/Cypress/v1/UnitOfMeasure/Types	No documentation available.
GET api/tyler/Cypress/v1/Accounts/Statuses	No documentation available.
GET api/tyler/Cypress/v1/Accounts/Types	No documentation available.
POST api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/PhoneNumbers	No documentation available.
PUT api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/PhoneNumbers	No documentation available.
POST api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/EmailAddresses	No documentation available.
PUT api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/BillingDeliveryMethods	No documentation available.
GET api/tyler/Cypress/v1/Services/Statuses	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/AccountOverview	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/PendingPayments	No documentation available.
GET api/tyler/Cypress/v1/Accounts/Alerts	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/AccountAlerts	No documentation available.
POST api/tyler/Cypress/v1/Accounts/AllAccountAlerts	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/FindAmpRecapItems?startDate={startDate}	No documentation available.
GET api/tyler/Cypress/v1/SystemCheck	No documentation available.
POST api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/StatementDeliverySettings	No documentation available.
GET api/tyler/Cypress/v1/FindAccountClassCodes	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/ServiceCode/{serviceCode}/Slot/{slot}/FindConsumptionItems?beginMonth={beginMonth}&beginYear={beginYear}&endMonth={endMonth}&endYear={endYear}	No documentation available.
GET api/tyler/Cypress/v1/Accounts/{accountNumber}/Customers/{customerNumber}/ServiceCode/{serviceCode}/Slot/{slot}/GetTSMChartInfo?startDate={startDate}&endDate={endDate}	No documentation available.
GET api/tyler/Cypress/v1/GetTSMClientMeters?postDataToTSM={postDataToTSM}&calculateBills={calculateBills}&maxBatchSizeForReadRequest={maxBatchSizeForReadRequest}	No documentation available.
GET api/tyler/Cypress/v1/FindServiceTypes	No documentation available.
GET api/tyler/Cypress/v1/MiuIdList/{miuIdsList}/FindContactInfos	No documentation available.
GET api/tyler/Cypress/v1/AccountList/{accountList}/FindContactInfos	No documentation available.
POST api/tyler/Cypress/v1/AccountNumber/{accountNumber}/CustomerNumber/{customerNumber}/GetTSMProjectedBill?projectionDate={projectionDate}	No documentation available.
POST api/tyler/Cypress/v1/AccountNumber/{accountNumber}/CustomerNumber/{customerNumber}/GetTSMEstimatedBill?projectionDate={projectionDate}	No documentation available.
POST api/tyler/Cypress/v1/ProcessTransaction	No documentation available.
POST api/tyler/Cypress/v1/AutopayManagement	No documentation available.
GET api/tyler/Cypress/v1/GetInsiteBillsForAllAccounts	No documentation available.

EmployeePositionCode

Represents new world ERP Employee Position.

API	Description
GET api/hr/v1/employeePositionCode	Returns Employee Position objects.

WorkOrderComplete

Represents new world ERP Utility Management Work Order.

API	Description
POST api/um/v1/workorder/complete/{workOrderNumber}	Completes a work order with WorkOrderResult object passed in Post request body.