AccrualReporting
| API | Description |
|---|---|
| GET V1/AccrualReporting.{ext}/AccrualCalenders |
No documentation available. |
| GET V1/AccrualReporting.{ext}/AccrualCalenderPeriods?calenderId={calenderId} |
No documentation available. |
| POST V1/AccrualReporting.{ext}/AccrualCalender |
No documentation available. |
| GET V1/AccrualReporting.{ext}/AccrualReport |
No documentation available. |
| GET V1/AccrualReporting.{ext}/GenerateAccrualReportForNotification |
No documentation available. |
| GET V1/AccrualReporting.{ext}/DownloadFile?fileName={fileName} |
No documentation available. |
| GET V1/AccrualReporting.{ext}/GetAccrualHistory |
No documentation available. |
| GET V1/AccrualReporting.{ext}/IsAccrualConfigured |
No documentation available. |
Alerts
AlertsAndMessages
| API | Description |
|---|---|
| GET V1/AlertsAndMessages.{ext}/GetAlertsAndMessages?isArchive={isArchive}&pageIndex={pageIndex}&pageSize={pageSize} |
This Api is used to Get Alert and Messages for Top Navigation |
| GET V1/AlertsAndMessages.{ext}/GetAlertsAndMessagesCount |
This Api is used to Get Alert and Messages Count for Top Navigation |
| GET V1/AlertsAndMessages.{ext}/getAllChatsByType?ChatType={ChatType}&ChatPage={ChatPage}&ChatTagvalue={ChatTagvalue}&isArchive={isArchive}&pageIndex={pageIndex}&pageSize={pageSize} |
No documentation available. |
| GET V1/AlertsAndMessages.{ext}/getChatConversationByID?chatTagTypeId={chatTagTypeId}&chatTagValue={chatTagValue}&chatType={chatType} |
No documentation available. |
| POST V1/AlertsAndMessages.{ext}/AddChats |
No documentation available. |
| POST V1/AlertsAndMessages.{ext}/DeleteChats?ChatId={ChatId} |
No documentation available. |
APIServices
Authentication
Benchmarking
This Benchmarking Controller provide APIs related to Energy Star Work flow.
This Controller includes the following functionalities: Virtual Site Mapping, Virtual Meter Mapping, Include Sites For Benchmarking
Manage Site Attributes, Site Attributes Bulk Upload (download/Upload), Approve Site Attributes, Submit Site Data to Energy Star,
Submit Energy Data to Energy Star, Update Site Energy, Include Multi Sites and Virtual Meter Gap/Overlap Report.
Bills
This feature provides a platform to view bills related to all the commodities. This is provided with various filters to narrow the resulting bills based on the user’s preferences. The end user can look at the Virtual Bill or Original Bill and the relative info respectively. The Virtual Bill or Original Bill is divided into multiple types: Bill Header Details, Payment Details, Service Utilitis and Charge Items.
BillService
BroadCast
BudgetAndForecasting
Budget And Forecasting Controller
CallsToAction
| API | Description |
|---|---|
| POST V1/Lite/CallsToAction.{ext}/CallsToAction?action={action} |
No documentation available. |
| GET V1/Lite/CallsToAction.{ext}/CallsToActionEntityType |
No documentation available. |
| GET V1/Lite/CallsToAction.{ext}/DeleteCallsToAction?callsToActionId={callsToActionId} |
No documentation available. |
| GET V1/Lite/CallsToAction.{ext}/CallsToActionDetails?callsToActionId={callsToActionId}&isWeb={isWeb} |
No documentation available. |
| POST V1/Lite/CallsToAction.{ext}/CallsToActions?action={action}&pageIndex={pageIndex}&pageSize={pageSize} |
No documentation available. |
| POST V1/Lite/CallsToAction.{ext}/CallsToActionOptions?action={action}&isWeb={isWeb} |
No documentation available. |
| GET V1/Lite/CallsToAction.{ext}/CallsToActionNotification |
No documentation available. |
CannedReports
CredentialManagement
CustomerSupport
DivisionalInfo
DivisionalInfo Allows us to Map the Different Sites into a single Division irrespective of the Site Group
EmergencyBillPayment
EmergencyBillPayments
Emergency Bill Payment API service enables to pay the bill payment where in cases when the payment not present in PU Inventory or .
It is present in PU Inventory, but no bill or Present in PU Inventory with bill
| API | Description |
|---|---|
| GET V1/EmergencyBillPayments.{ext}/AccountsAndBankOrgAC?productId={productId}&vendorName={vendorName} |
Gets Emergency Payment Account and Bank Org AC Details Mandatory Fields: productId and vendorName are mandatory fields |
| GET V1/EmergencyBillPayments.{ext}/PaymentMethodAndRemitCodes?productId={productId}&accountNbr={accountNbr} |
Gets Emergency Payments -> Payment Method and Remit Code Details Mandatory Fields: productId and accountNbr are mandatory fields |
| GET V1/EmergencyBillPayments.{ext}/PaymentCurrency?accountNbr={accountNbr} |
Get Payment Cuurency for Emergency Bill Payment Mandatory Fields: accountNbr is mandatory |
| GET V1/EmergencyBillPayments.{ext}/EmergencyPayments?reimbursementStatus={reimbursementStatus}&paymentMethod={paymentMethod} |
Gets Emergency Payment Details Optional Fields: ReimbursementStatus and paymentMethod are optional fields |
| GET V1/EmergencyBillPayments.{ext}/EmergencyPayments?EBPId={EBPId} |
Get Emergency Bill Payment Details By EBPId Mandatory Fields: EBPId is mandatory field |
| POST V1/EmergencyBillPayments.{ext}/EmergencyPayments?EBPId={EBPId}&comments={comments} |
Updates Reimburse Comments By EBPId Mandatory Fields: EBPId and comments are mandatory fields |
| POST V1/EmergencyBillPayments.{ext}/EmergencyPayments |
Initiate Emergency Bill Payment |
Exceptions
Exception workflow : An Exception is a trigger the “Data Processing Group” raises due to their inability to process an invoice due to any reason.
The Client/Partner gets to review such
Exceptions and resolve them. Only after the resolution is given, the Data Processing Group picks those resolutions and processes the bills further
The various Exception Types are Image, Master Data and Bill Validation etc.
Image Level Exception: Images are blank or illegible to process
Master Data Exception: Unable to link a Bill to an appropriate entity like Site/Vendor/Account/Meter etc. or any mismatch of such information
FileUpload
To upload files.
FundingStatements
The Creation/Audit/Approval/Funding/Acknowledgement of Funding Statements for Bill Payments is done here.
GHG
IntervalMeterData
Inventory
Inventory API service generates detailed Reports on Sites, Site Groups, Vendors, Accounts, Utilities, Meter Level Data, and Charge Details.
This API service has following features
Site/Facility Explorer – This feature gives the information about Summary of the Sites/Facilities along with the Total Spend(USD), List of Sites in a State, Details of a Site, Utility Accounts of a site and Spend & Consumption of a Site.
Vendor Explorer – This feature gives the information about various details of a Vendor like Service Type Trend, Sites Expenses, Vendor Information, Utility History and Vendor Details.
Utility Account Explorer – Utility Account Explorer provides intrinsic details of any site’s information through all the Account Numbers which contain information related to the commodities and their meters associated, charge details and more.
InvoiceRedirection
Invoice Redirection API service enables the Email Configuration for Site / Account and Sends the Invoices to the respective sites/ Accounts.
This API service has following features
Email Template Creation – This feature enables to create a new template and assigns to the client.
Send IR through Mail / E-Mail – This Feature send the Invoices to the sites/Accounts through the mail / email.
| API | Description |
|---|---|
| GET V1/InvoiceRedirection.{ext}/EmailSignature?templateID={templateID} |
Get Email Signature Template Details and Single Template Details By TemplateID |
| POST V1/InvoiceRedirection.{ext}/EmailSignature |
Adds New Email Signature Template |
| PUT V1/InvoiceRedirection.{ext}/EmailSignature |
Edit Template By TemplateID
|
| DELETE V1/InvoiceRedirection.{ext}/EmailSignature?templateId={templateId} |
Delete Template By Template ID
|
| GET V1/InvoiceRedirection.{ext}/Clients |
Get Clients By UserID |
| GET V1/InvoiceRedirection.{ext}/IREmailConfigs?ids={ids} |
Gets IR Email Configuration Details |
| POST V1/InvoiceRedirection.{ext}/IREmailConfigs |
Insert IR Details |
| PUT V1/InvoiceRedirection.{ext}/IREmailConfigs |
Edit IR Email Config
|
| DELETE V1/InvoiceRedirection.{ext}/IREmailConfigs?irIds={irIds} |
Delete IR Email Config[irIds stands for IR Inventory Id's]
|
| GET V1/InvoiceRedirection.{ext}/MailedIRTrans?type={type}&mode={mode}&nbr={nbr}&irStatus={irStatus}&fromDate={fromDate}&toDate={toDate} |
No documentation available. |
| PUT V1/InvoiceRedirection.{ext}/MailedIRTrans |
Update Mailed IR Transactions
|
| POST V1/InvoiceRedirection.{ext}/SendIREmail |
Sends IR Emails
|
| GET V1/InvoiceRedirection.{ext}/GetOBFsForIR |
Get OBFs For IR |
| GET V1/InvoiceRedirection.{ext}/GetOBFDetailsForIR?siteNumber={siteNumber}&acctNumber={acctNumber}&irType={irType}&irMode={irMode}&obfIds={obfIds}&siteId={siteId} |
No documentation available. |
| DELETE V1/InvoiceRedirection.{ext}/DeleteIRBySiteId?siteId={siteId} |
Delete IR By SiteId |
| GET V1/InvoiceRedirection.{ext}/GetIRAccountDetails?siteNumber={siteNumber}&acctNumber={acctNumber}&groupName={groupName} |
No documentation available. |
| GET V1/InvoiceRedirection.{ext}/GetIRDetailsForEdit?siteNumber={siteNumber}&acctNumber={acctNumber} |
No documentation available. |
LiteCustomerSupport
| API | Description |
|---|---|
| POST V1/Lite/CustomerSupport.{ext}/Collaboration?action={action}&pageIndex={pageIndex}&pageSize={pageSize} |
No documentation available. |
| POST V1/Lite/CustomerSupport.{ext}/Tickets?action={action}&pageIndex={pageIndex}&pageSize={pageSize} |
No documentation available. |
| GET V1/Lite/CustomerSupport.{ext}/IssueDetailsbyIssueId?issueId={issueId} |
No documentation available. |
| GET V1/Lite/CustomerSupport.{ext}/EventDetails?eventId={eventId} |
No documentation available. |
| GET V1/Lite/CustomerSupport.{ext}/TaskDetails?taskId={taskId} |
No documentation available. |
| GET V1/Lite/CustomerSupport.{ext}/DocumentDetails?documentId={documentId} |
No documentation available. |
LiteException
| API | Description |
|---|---|
| POST V1/Lite/Exceptions.{ext}/Exceptions?action={action}&pageIndex={pageIndex}&pageSize={pageSize} |
No documentation available. |
LiteFundingStatements
MasterData
Messages
MissingBill
PaymentReports
PaymentsMasterData
To manage master data regarding payment i.e from vendors to their accounts.
| API | Description |
|---|---|
| GET V1/PaymentsMaster.{ext}/Products?productId={productId}&pageIndex={pageIndex}&pageSize={pageSize} |
Returns products we have in EMS |
| POST V1/PaymentsMaster.{ext}/Vendors?pageIndex={pageIndex}&pageSize={pageSize} |
Returns vendors. |
| PUT V1/PaymentsMaster.{ext}/Vendors?status={status}&vendorId={vendorId} |
To activate or inactivate vendors. |
| GET V1/PaymentsMaster.{ext}/VendorCorrespondenceAddress?vendorId={vendorId}&pageIndex={pageIndex}&pageSize={pageSize} |
Returns Vendor Correspondence Addresses |
| POST V1/PaymentsMaster.{ext}/VendorCorrespondenceAddress |
To Create Vendor Correspondence Address. |
| PUT V1/PaymentsMaster.{ext}/VendorCorrespondenceAddress |
To Update Vendor Correspondence Address |
| DELETE V1/PaymentsMaster.{ext}/VendorCorrespondenceAddress?correspondenceId={correspondenceId} |
To Delete Vendor Correspondence Address. |
| GET V1/PaymentsMaster.{ext}/VendorCheckRemmittance?vendorId={vendorId}&remmitCode={remmitCode}&status={status}&checkRemittanceId={checkRemittanceId}&pageIndex={pageIndex}&pageSize={pageSize} |
Returns Venodr Check Remmittances i.e when payment method is check |
| POST V1/PaymentsMaster.{ext}/VendorCheckRemmittance |
To Create Vendor Check Remmittance. |
| PUT V1/PaymentsMaster.{ext}/VendorCheckRemmittance |
To Update Vendor Check Remmittance. |
| DELETE V1/PaymentsMaster.{ext}/VendorCheckRemmittance?checkRemittanceId={checkRemittanceId} |
To Delete Vendor Check Remmittance. |
| GET V1/PaymentsMaster.{ext}/VendorACHRemittance?vendorId={vendorId}&status={status}&pageIndex={pageIndex}&pageSize={pageSize} |
Returns Vendor ACHRemittance details. |
| POST V1/PaymentsMaster.{ext}/VendorACHRemittance |
To Create Vendor ACH Remittance |
| PUT V1/PaymentsMaster.{ext}/VendorACHRemittance |
To Update Vendor ACH Remittance |
| DELETE V1/PaymentsMaster.{ext}/VendorACHRemittance?aCHRemittanceId={aCHRemittanceId} |
To Delete Vendor ACH Remittance. |
| GET V1/PaymentsMaster.{ext}/SubAccounts?productId={productId}&clientId={clientId}&status={status}&clientSubAccountId={clientSubAccountId}&pageIndex={pageIndex}&pageSize={pageSize} |
Returns client sub accounts details. |
| POST V1/PaymentsMaster.{ext}/SubAccounts |
To Create Sub Account. |
| PUT V1/PaymentsMaster.{ext}/SubAccounts |
To Update Sub Account. |
| DELETE V1/PaymentsMaster.{ext}/SubAccounts?clientSubAccountId={clientSubAccountId} |
To Delete Sub Account. |
| GET V1/PaymentsMaster.{ext}/Checks?productId={productId}&clientId={clientId}&status={status}&pageIndex={pageIndex}&pageSize={pageSize} |
Returns Checks. |
| PUT V1/PaymentsMaster.{ext}/Checks |
To Update Check. |
| POST V1/PaymentsMaster.{ext}/VendorBankDetails?pageIndex={pageIndex}&pageSize={pageSize} |
Returns Vendor Bank Details . |
| GET V1/PaymentsMaster.{ext}/CheckDeliveryMethods |
Returns Checks Delivery Methods. |
| POST V1/PaymentsMaster.{ext}/RemitCodes?pageIndex={pageIndex}&pageSize={pageSize} |
Returns Check Remit Codes based on search criteria.. |
| PUT V1/PaymentsMaster.{ext}/MapAccountToRemitCode |
To Map Account To RemitCode. |
| POST V1/PaymentsMaster.{ext}/GeneratePennyTestFile |
To generate penny test file for ACH type bank accounts. |
| POST V1/PaymentsMaster.{ext}/PennyTestVerifiedDetails?pageIndex={pageIndex}&pageSize={pageSize} |
Returns Penny Test Files Details. |
| GET V1/PaymentsMaster.{ext}/VerifyPennyTestFiles?PfName={PfName}&vendorName={vendorName}&bankName={bankName}&pageIndex={pageIndex}&pageSize={pageSize} |
To get penny test files which are to be verified and which are in paid status. |
| POST V1/PaymentsMaster.{ext}/VerifyPennyTestFiles |
To Verify Penny test files. |
| GET V1/PaymentsMaster.{ext}/BankNameByABARoutingNumber?ABARoutingNumber={ABARoutingNumber} |
Gets Bank Name by ABA Routing Number |
| GET V1/PaymentsMaster.{ext}/CompanyBankDetails?companyId={companyId} |
Gets Get Company Bank Details |
| GET V1/PaymentsMaster.{ext}/ClientDetailsByProdId?productId={productId} |
Get Client Details By ProdId |
| GET V1/PaymentsMaster.{ext}/BillPayClients?ProductId={ProductId} |
No documentation available. |
PaymentsNotificationConfiguration
Notification API enables us to Create the Notifications with different notification Type and allows to configure these
notifications to the client
| API | Description |
|---|---|
| GET V1/Notification.{ext}/NotificationTypes?notificationId={notificationId} |
Gets Notification Types |
| GET V1/Notification.{ext}/Notifications?notificationId={notificationId}¬ificationDetId={notificationDetId}&pageIndex={pageIndex}&pageSize={pageSize} |
Get Notifications |
| POST V1/Notification.{ext}/Notifications |
Add New Notification |
| PUT V1/Notification.{ext}/Notifications |
Edit Notification Details |
| DELETE V1/Notification.{ext}/Notifications?notificationDetId={notificationDetId} |
Delete Notification |
| GET V1/Notification.{ext}/ClientNotifications?clientNotificationId={clientNotificationId}¬ificationId={notificationId}¬ificationDetId={notificationDetId}&clientId={clientId}&pageIndex={pageIndex}&pageSize={pageSize} |
No documentation available. |
| GET V1/Notification.{ext}/Clients |
Get Clients |
| GET V1/Notification.{ext}/FromEmailIds |
Get From Email Ids |
| GET V1/Notification.{ext}/ToAndCCEmailIds?clientId={clientId} |
Gets To and CC Email Ids |
| POST V1/Notification.{ext}/ClientNotifications |
Add Client Notification |
| PUT V1/Notification.{ext}/ClientNotifications |
Update Client Notification Details |
| DELETE V1/Notification.{ext}/ClientNotifications?clientNotificationId={clientNotificationId} |
Delete Client Notification Details |
| GET V1/Notification.{ext}/GetAmountRange?clientId={clientId} |
No documentation available. |
PaymentsReconcile
Manipulates Reconciliation of Payments/payments files
| API | Description |
|---|---|
| GET V1/PaymentsReconcile.{ext}/Acknowledgements |
Get all Acknowledgement Files from PROK and ISTX account. |
| GET V1/PaymentsReconcile.{ext}/SUCC |
Get SUCC File Details from WellsFargo PROK and ISTX folders. |
| GET V1/PaymentsReconcile.{ext}/Confirmations |
Get Confirmation Files from PROK and ISTX folders (Folder : InboundConf). |
| GET V1/PaymentsReconcile.{ext}/CheckImages |
Get CheckImages from PROK and ISTX folders (Folder : CheckImages). |
| GET V1/PaymentsReconcile.{ext}/ProcessQueueStatusSummary?companyCode={companyCode}&pageIndex={pageIndex}&pageSize={pageSize} |
Get Process Queue Status Summary . |
| GET V1/PaymentsReconcile.{ext}/ProcessQueueFiles?companyCode={companyCode}&pageIndex={pageIndex}&pageSize={pageSize} |
Get Process Queue Payment File Details.
Information about the present status of Payments info (Pf Name, Status,Aging, Company, Currency) |
| GET V1/PaymentsReconcile.{ext}/FilesArchived?companyCode={companyCode}&pageIndex={pageIndex}&pageSize={pageSize} |
Get Payment Files Archived Details. |
| GET V1/PaymentsReconcile.{ext}/PaymentFileComments?paymentFileName={paymentFileName} |
Get Payment file comments based on Payment File Name. |
| POST V1/PaymentsReconcile.{ext}/InitiateStopPayments?pageIndex={pageIndex}&pageSize={pageSize} |
Will Get List of Payment Files which are in AckAccepted Status, which still confirmation need to be updated. |
| GET V1/PaymentsReconcile.{ext}/ApproveStopPayments?pageIndex={pageIndex}&pageSize={pageSize} |
Will get all the Payment files for which Stop Payment has beed initiated (SP Initiated). |
| GET V1/PaymentsReconcile.{ext}/ExecuteOrReIssuePayments?pageIndex={pageIndex}&pageSize={pageSize} |
Will get all payment files which are in "SP Approved" Status for Executing the Stop Payments. |
| POST V1/PaymentsReconcile.{ext}/UpdateAcknowledgement?fileName={fileName}&comapny={comapny} |
Update Acknowledgement Files of PROK and ISTX from WellsFargo.
Which will update the Payment file Status. |
| POST V1/PaymentsReconcile.{ext}/UpdateSUCCAcknowledgement?fileName={fileName}&comapny={comapny} |
Update SUCC Acknowledgement of ISTX and Prokarma from wellsFargo. |
| POST V1/PaymentsReconcile.{ext}/UpdateConfirmation?fileName={fileName}&fileType={fileType}&company={company} |
Update Confirmation File of all types (ACH/CHECk/SUCC). |
| POST V1/PaymentsReconcile.{ext}/UpdateCheckImage?fileName={fileName}&fileType={fileType}&company={company} |
Update Check Images of ISTX and PROK |
| POST V1/PaymentsReconcile.{ext}/StopPayment?PFTransactionId={PFTransactionId} |
Initiate Stop Payment for the Payment Files which are in ACKACCEPTED Status. |
| POST V1/PaymentsReconcile.{ext}/ApproveStopPayment?pfStopPaymentId={pfStopPaymentId} |
Approve Stop Payment which are in "SP Initiated" Status. |
| POST V1/PaymentsReconcile.{ext}/RejectStopPayment?pfStopPaymentId={pfStopPaymentId} |
Reject Stop Payment of Payment Files which are in "SP Initiated" status. |
| POST V1/PaymentsReconcile.{ext}/ExecuteStopPayment?pfStopPaymentId={pfStopPaymentId} |
Execute Stop Payment of Payment Files which are in "SP Approved" status. |
| GET V1/PaymentsReconcile.{ext}/StopPaymentComments?pfStopPaymentId={pfStopPaymentId} |
Get comments for Stop Payments for a Payment File. |
| GET V1/PaymentsReconcile.{ext}/DownloadPaymentFile?fileName={fileName}&company={company}&fileType={fileType}&paymentType={paymentType}&pfStatus={pfStatus}&fileExtension={fileExtension} |
Download Wells Fargo Payment File (xml) |
PaymentsReconciliation
PaymentsWorkflow
Payments workflow is used to Verify the funds for funding statements and then generating the payment file by including the funding statements and generating the E-Check payment files also.Here we have the approving the payment file and also getting payment files which are acknowdleged.
| API | Description |
|---|---|
| GET V1/Payments.{ext}?productId={productId}&fundingStatmentName={fundingStatmentName}&pageIndex={pageIndex}&pageSize={pageSize} |
Will Get All the funding statement which are funded and waiting for Verify funds. |
| POST V1/Payments.{ext}/UploadFSFile |
Upload file for Funding Statement |
| GET V1/Payments.{ext}/FSAttachements?fsID={fsID}&pageIndex={pageIndex}&pageSize={pageSize} |
Returns funding statement attachments |
| POST V1/Payments.{ext}/VerifyFunds |
Verifying the funds |
| GET V1/Payments.{ext}/Funds?fsID={fsID}&pageIndex={pageIndex}&pageSize={pageSize} |
Returns funds along with comments for a particular Funding Statement. |
| PUT V1/Payments.{ext}/UpdateFSAmount |
Add/Update Funds for a particular Funding Statement. |
| GET V1/Payments.{ext}/BillPaymentFS?companyId={companyId}¤cy={currency}&pageIndex={pageIndex}&pageSize={pageSize} |
Get Funding Statements for which verification of funds
Mandatory Fields : companyId,currency |
| GET V1/Payments.{ext}/FSDetails?fundingStatementId={fundingStatementId}&transactionId={transactionId}&pageIndex={pageIndex}&pageSize={pageSize}&action={action} |
No documentation available. |
| GET V1/Payments.{ext}/DownloadFSdetails?fsId={fsId} |
No documentation available. |
| GET V1/Payments.{ext}/BillPaymentFSDetails?fsID={fsID}&pfDate={pfDate}&companyId={companyId}&pageIndex={pageIndex}&pageSize={pageSize} |
Get All the Funding Statements which are available for Payments |
| GET V1/Payments.{ext}/RemitCodeACH?remitCode={remitCode}&pageIndex={pageIndex}&pageSize={pageSize} |
Get All Remit Details of ACH Payment Type |
| GET V1/Payments.{ext}/RemitCodeCheck?remitCode={remitCode}&pageIndex={pageIndex}&pageSize={pageSize} |
Get All Remit Details of Check Payment Type |
| POST V1/Payments.{ext}/GeneratePaymentFile?companyId={companyId}¬ificationId={notificationId}&paymentFileDate={paymentFileDate} |
Generate Payment File for the List of FSDetails(bills/Transactions) from different Funding Statements and one payment file can have bills/transactions from different clients. |
| POST V1/Payments.{ext}/GenerateECheckPaymentFile?companyId={companyId}&fsIds={fsIds}&fSDeatilIds={fSDeatilIds}&paymentDate={paymentDate}¬ificationId={notificationId} |
Generate E-Check Payment File for the List of FSDetails(bills/Transactions) from different Funding Statements and one payment file can have bills/transactions from different clients. |
| GET V1/Payments.{ext}/PaymentFiles?pageIndex={pageIndex}&pageSize={pageSize} |
Will get all payment files which are in DRAFT status and waiting for regular approval process(Not High Value Approval).
Mandatory Fields : N/A |
| POST V1/Payments.{ext}/PaymentFiles |
Reject Payment File (We can reject only few transactions in Payment File). |
| GET V1/Payments.{ext}/PaymentFileHeader?pfId={pfId} |
Will get Payemnt file Header Information. |
| GET V1/Payments.{ext}/PaymentFileTransactions?pfId={pfId}&pfDetailStatus={pfDetailStatus} |
Will Get List of Transactions/Comments for Payment File(Header information). |
| GET V1/Payments.{ext}/PaymentFileAcknowledgements?pfId={pfId} |
Gets Payment File Acknowledgement Details |
| GET V1/Payments.{ext}/PaymentFileConfirmations?pfId={pfId}&type={type} |
Gets Payment File Confirmation Details |
| GET V1/Payments.{ext}/PaymentFileComments?pfName={pfName} |
Gets Payment File Comment Details. |
| GET V1/Payments.{ext}/PaymentFilesHighApproval?pageIndex={pageIndex}&pageSize={pageSize} |
List of all payment files which are for High Value Approval. |
| GET V1/Payments.{ext}/AllPaymentFiles?pageIndex={pageIndex}&pageSize={pageSize}&pfName={pfName}&pfMonth={pfMonth}&pfYear={pfYear}&pfStatus={pfStatus}&productName={productName}&clientId={clientId}&fsName={fsName}&disbursementAcc={disbursementAcc} |
List of all payment files |
| POST V1/Payments.{ext}/TransmitPaymentFile?pfId={pfId} |
Transmit Payment File. (We can transmit only those payemnt files which are in Approved Status) |
| GET V1/Payments.{ext}/RemitCodes?pageIndex={pageIndex}&pageSize={pageSize}&type={type} |
Will Get All Remit Code Details |
| GET V1/Payments.{ext}/RemitCodes?remitCode={remitCode} |
Get Remit Code Details By Remit Code |
| POST V1/Payments.{ext}/ApprovePaymentFile |
Approve / Partially Approve Payment file based on the pfStatus for both Regular and High Value Approval. |
| GET V1/Payments.{ext}/PaymentClientFeed?fsName={fsName}&fsId={fsId}&siteGroup={siteGroup} |
No documentation available. |
| GET V1/Payments.{ext}/GetRefuseClientName?action={action}&prefix={prefix} |
No documentation available. |
| GET V1/Payments.{ext}/RefusePaymentClientFeed?fsName={fsName}&clientName={clientName} |
No documentation available. |
| GET V1/Payments.{ext}/SpendAndConsumptionByUtility?clientId={clientId}&clientCode={clientCode}&requestFromService={requestFromService} |
No documentation available. |
| GET V1/Payments.{ext}/SpendAndConsumptionByFundingCycleForAsbury?clientId={clientId}&clientCode={clientCode} |
No documentation available. |
| GET V1/Payments.{ext}/ReeceMonthlyFeedData?clientId={clientId}&clientCode={clientCode} |
No documentation available. |
| POST V1/Payments.{ext}/ClientwiseMonthlyFeedData |
No documentation available. |
| POST V1/Payments.{ext}/SallyBeautySiteGroupwiseSummary |
No documentation available. |
| GET V1/Payments.{ext}/ClientwiseFeedDataSchedules?clientId={clientId} |
No documentation available. |
| GET V1/Payments.{ext}/IsFsPdfDownloadIconRequired |
No documentation available. |
| GET V1/Payments.{ext}/viewclientACHdetails |
No documentation available. |
| POST V1/Payments.{ext}/UpdateClientDetails?ClientbankId={ClientbankId}&ClientName={ClientName}&ProductId={ProductId}&ProductName={ProductName}&ClientNumber={ClientNumber}&ClientCode={ClientCode}&ClientDUNSNumber={ClientDUNSNumber}&status={status}&ClientID={ClientID} |
No documentation available. |
| POST V1/Payments.{ext}/ClientACHdetails |
No documentation available. |
| POST V1/Payments.{ext}/DeleteClientDetails?ClientbankId={ClientbankId}&ClientID={ClientID} |
No documentation available. |
| POST V1/Payments.{ext}/UpdateStatusClientDetails?ClientbankId={ClientbankId}&Status={Status}&Type={Type}&ClientID={ClientID} |
No documentation available. |
| GET V1/Payments.{ext}/GetClientBankAccountDetails?ClientId={ClientId} |
No documentation available. |
| GET V1/Payments.{ext}/SiteGroupByClient?clientId={clientId}&idRequired={idRequired} |
No documentation available. |
| GET V1/Payments.{ext}/Transmitdebitpaymentfile |
No documentation available. |
| GET V1/Payments.{ext}/updateTransmitdebitStatus?pfId={pfId}&paymentfileName={paymentfileName}&companyCode={companyCode} |
No documentation available. |
| GET V1/Payments.{ext}/getdebitpaymentfiledetails?pfId={pfId} |
No documentation available. |
| POST V1/Payments.{ext}/getBillpayRiskMasterData |
No documentation available. |
| POST V1/Payments.{ext}/getBillpayRiskDetailedData |
No documentation available. |
| POST V1/Payments.{ext}/getBillpayRiskDashboardData |
No documentation available. |
| GET V1/Payments.{ext}/getBillpayClients |
No documentation available. |
| GET V1/Payments.{ext}/BillpayRiskProducts |
No documentation available. |
| GET V1/Payments.{ext}/BillpayRiskScore |
No documentation available. |
ProAdminAccountReceivables
ProAdminFundingStatements
ProAdminPaymentsMasterData
ProAdminPaymentsNotificationConfiguration
| API | Description |
|---|---|
| GET V1/ProAdminNotification.{ext}/ClientBroadCastDetails?notificationTypeId={notificationTypeId}¬ificationNameId={notificationNameId}&clientId={clientId} |
No documentation available. |
| POST V1/ProAdminNotification.{ext}/SetClientBroadCastBO?Action={Action}&NotificationType={NotificationType}&ClientName={ClientName}&ToMailIds={ToMailIds}&CCMailIds={CCMailIds} |
No documentation available. |
| POST V1/ProAdminNotification.{ext}/InsertClientBroadCast?status={status} |
No documentation available. |
| GET V1/ProAdminNotification.{ext}/EmailIds?clientId={clientId} |
No documentation available. |
| GET V1/ProAdminNotification.{ext}/NotificationNamesByType?notificationId={notificationId} |
No documentation available. |
| GET V1/ProAdminNotification.{ext}/GetEmailIdsByClientId?clientId={clientId} |
No documentation available. |
ProAdminPaymentsWorkflow
Projects
Projects
RateAndTariff
Rate And Tariff
ReportScheduler
RevenueTrackingSystem
RubsandVCR
Security
| API | Description |
|---|---|
| GET V1/Lite/Security.{ext}/ValidateUser?loginId={loginId}&password={password} |
No documentation available. |
| POST V1/Lite/Security.{ext}/AccountRegistration |
No documentation available. |
| GET V1/Lite/Security.{ext}/BadgersCount |
No documentation available. |
| POST V1/Lite/Security.{ext}/MobileSettings |
No documentation available. |
| GET V1/Lite/Security.{ext}/MobileSettings |
No documentation available. |
| GET V1/Lite/Security.{ext}/MobileUserProfile?userId={userId} |
No documentation available. |
| POST V1/Lite/Security.{ext}/MobileException |
No documentation available. |
| GET V1/Lite/Security.{ext}/SiteAssets |
No documentation available. |
| GET V1/Lite/Security.{ext}/LocalData |
No documentation available. |
| GET V1/Lite/Security.{ext}/MobileMenu |
No documentation available. |
| GET V1/Lite/Security.{ext}/Constants |
No documentation available. |
| GET V1/Lite/Security.{ext}/Configuration |
No documentation available. |
| GET V1/Lite/Security.{ext}/DownloadFile |
No documentation available. |
SmartClient
SpendAndConsumption
Survey
TicketManagement
Ticket Management Controller
ToolsAndLibrary
Tools and Library
UploadFile
| API | Description |
|---|---|
| POST V1/Lite/FileUpload.{ext}/FileUpload?type={type}&tempFolderName={tempFolderName} |
No documentation available. |
| GET V1/Lite/FileUpload.{ext}/MoveFile?type={type}&tempFolderName={tempFolderName}&parentFolderName={parentFolderName}&isQuickAction={isQuickAction} |
No documentation available. |
| GET V1/Lite/FileUpload.{ext}/DeleteFolder?type={type}&tempFolderName={tempFolderName} |
No documentation available. |
| GET V1/Lite/FileUpload.{ext}/DeleteFile?type={type}&tempFolderName={tempFolderName}&fileName={fileName} |
No documentation available. |
| GET V1/Lite/FileUpload.{ext}/CreateProfilePics |
No documentation available. |
| GET V1/Lite/FileUpload.{ext}/FileDownload?type={type}&fileName={fileName} |
No documentation available. |
Users
UtilityExplorer
Weather
| API | Description |
|---|---|
| GET V1/Weather.{ext}/SendMissingWeatherDataNotifications |
No documentation available. |
| GET V1/Weather.{ext}/MapWeatherStationCodes?ClientId={ClientId} |
No documentation available. |
| GET V1/Weather.{ext}/WeatherDataMaster?city={city}&state={state}&country={country}&zip={zip} |
No documentation available. |
| GET V1/Weather.{ext}/GetWSCode |
No documentation available. |
| POST V1/Weather.{ext}/MapSelectedZipsTpWS?zipIds={zipIds}&wsCodeId={wsCodeId}&wsId={wsId} |
No documentation available. |
| GET V1/Weather.{ext}/SearchWeatherInfo?city={city}&state={state}&country={country}&zip={zip}&wsId={wsId}&wsCodeId={wsCodeId} |
No documentation available. |