GET api/customerdashboard/{id}

Returns dashboard info (Balance, Last Payment, Open Service Tickets, etc.) by CustomerID

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

CustomerDashboard

Name	Description	Type	Additional information
CustomerId	Sedona internal autonumber for the Customer record	integer	None.
CustomerNumber	Customer Number the customer sees	string	Required String length: inclusive between 0 and 15
CustomerName	If a person, CustomerName should be passed in as "Last, First"	string	String length: inclusive between 0 and 60
CurrentBalance	Sum of Net Due for open invoices	decimal number	None.
LastPaymentDate	Last Date an invoice was paid	date	None.
LastPaymentAmount	Amount of last invoice payment	decimal number	None.
NextPaymentDate	Next date an invoice is due	date	None.
OpenServiceTicketCount	Number of open Service Tickets (not closed, i.e. OP, RS, SC, IP, GB, etc.)	integer	None.
PaperlessBilling	Customer is signed up for Paperless billing, i.e. AR_Customer.Print_Cycle_Invoices = "N"	boolean	None.
AutoBillPay	Customer has a bank or credit card record where UsedForAutoProcess = "Y"	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "CustomerNumber": "sample string 2",
  "CustomerName": "sample string 3",
  "CurrentBalance": 4.0,
  "LastPaymentDate": "2024-10-18T01:18:44.386438-05:00",
  "LastPaymentAmount": 1.0,
  "NextPaymentDate": "2024-10-18T01:18:44.386438-05:00",
  "OpenServiceTicketCount": 5,
  "PaperlessBilling": true,
  "AutoBillPay": true
}

application/xml, text/xml

Sample:

<CustomerDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SedonaServices.Models">
  <AutoBillPay>true</AutoBillPay>
  <CurrentBalance>4</CurrentBalance>
  <CustomerId>1</CustomerId>
  <CustomerName>sample string 3</CustomerName>
  <CustomerNumber>sample string 2</CustomerNumber>
  <LastPaymentAmount>1</LastPaymentAmount>
  <LastPaymentDate>2024-10-18T01:18:44.386438-05:00</LastPaymentDate>
  <NextPaymentDate>2024-10-18T01:18:44.386438-05:00</NextPaymentDate>
  <OpenServiceTicketCount>5</OpenServiceTicketCount>
  <PaperlessBilling>true</PaperlessBilling>
</CustomerDashboard>