Skip to content
/
Search clients

SunLync API (V2) API Definition (0.0.1)

Open API Specificaitons for SunLync API V2

Download OpenAPI description
openapi.json
openapi.yaml
Overview
API Support
support@sunlync.com
License
Languages
Servers
Sandbox server
https://sandbox.sunlync.net:9000/

Client

Client related endpoints

Operations

Get billing info

Request

Returns a list of client billing accounts for a given client number

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000046
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/billinginfo?clientnumber=stringstri'

Responses

Get Billing Info

Bodyapplicaiton/json
accountsArray of objects(clientBillingInfo)
Response
applicaiton/json
{
  "accounts": [
    { … }
  ]
}

Search clients

Request

Returns a list of clients

Security
BasicAuthCredentials
Query
clientnumberstring= 10 characters
Examples:
clientnumber=0000000046
firstnamestring
Examples:
firstname=John
lastnamestring
Examples:
lastname=Doe
dobstring
Examples:
dob=1980-12-01
addressstring
Examples:
address=10 Test St
phonestring
Examples:
phone=7165555555
emailstring
Examples:
email=test@test.com
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/search?clientnumber=stringstri&firstname=string&lastname=string&dob=string&address=string&phone=string&email=string'

Responses

Search Clients

Bodyapplicaiton/json
packagesArray of objects(clientInfo)
Response
applicaiton/json
{
  "packages": [
    { … }
  ]
}

Get client transaction history

Request

Returns a list trasnsactions for a given client number

Security
BasicAuthCredentials
Query
clientnumberstring= 10 charactersrequired
Examples:
clientnumber=0000000046
startdatestring(date)required
Examples:
startdate=2025-01-01
enddatestring(date)required
Examples:
enddate=2025-01-01
includedetailintegerrequired
Examples:
includedetail=1
trantypesstring
Examples:
trantypes=T,R,M,P
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.sunlync.net:9000/slapi/clients/transactionhistory?clientnumber=stringstri&startdate=2019-08-24&enddate=2019-08-24&includedetail=0&trantypes=string'

Responses

Get a list of tranactions

Bodyapplicaiton/json
transactionsArray of objects(transactions)
Response
applicaiton/json
{
  "transactions": [
    { … }
  ]
}

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations