Skip to content
/
Post account ledger payme...

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

Downgrade membership

Request

Downgrades an active eft membership

Security
BasicAuthCredentials
Bodyapplication/json
membershipIdstring
Example: "0000000001"
downgradeMembershipNumberstring
Example: "0000000001"
nextDuesAmountnumber(float)
Example: 5
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/downgrademembership \
  -H 'Content-Type: application/json' \
  -d '{
    "membershipId": "0000000001",
    "downgradeMembershipNumber": "0000000001",
    "nextDuesAmount": 5
  }'

Responses

Membership downgrades

Bodyapplicaiton/json
messagestring
Example: "Membership downgraded successfully"
membershipIdstring
Example: "0000000001"
Response
applicaiton/json
{
  "message": "Membership downgraded successfully",
  "membershipId": "0000000001"
}

Post account ledger payment

Request

Post account ledger payment

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
membershipIdstring
Example: "0000000001"
amountnumber(float)
Example: 9.99
descriptionstring
Example: "Payment posted from API"
employeeNumberstring
Example: "0000000001"
storecodestring
Example: "0000000001"
isEFtnumber
Example: 1
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/postaccountledgerpayment \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "membershipId": "0000000001",
    "amount": 9.99,
    "description": "Payment posted from API",
    "employeeNumber": "0000000001",
    "storecode": "0000000001",
    "isEFt": 1
  }'

Responses

Account ledger payment posted

Bodyapplicaiton/json
messagestring
Example: "Account ledger payment posted successfully"
balancenumber(float)
Example: -9.99
Response
applicaiton/json
{
  "message": "Account ledger payment posted successfully",
  "balance": -9.99
}

Insert points

Request

Insert points

Security
BasicAuthCredentials
Bodyapplication/json
clientNumberstring
Example: "0000000001"
expDatestring(date)
Example: "2025-12-31"
employeeNumberstring
Example: "0000000001"
storecodestring
Example: "0000000001"
quantityinteger
Example: 10
descriptionstring
Example: "Insert from API"
curl -i -X POST \
  -u <username>:<password> \
  https://sandbox.sunlync.net:9000/slapi/clients/insertpoints \
  -H 'Content-Type: application/json' \
  -d '{
    "clientNumber": "0000000001",
    "expDate": "2025-12-31",
    "employeeNumber": "0000000001",
    "storecode": "0000000001",
    "quantity": 10,
    "description": "Insert from API"
  }'

Responses

Points inserted successfully

Bodyapplicaiton/json
messagestring
Example: "Points inserted successfully"
balancenumber(float)
Example: -9.99
Response
applicaiton/json
{
  "message": "Points inserted successfully",
  "balance": -9.99
}

Configuration

SunLync configuration related endpoints

Operations

User

User related endpoints

Operations