API Endpoints - Solarecliente

Clients

Manage client information and records.

List Clients

GET /v1/clients

Query Parameters

page

integer

default:"1"

Page number for pagination

limit

integer

default:"20"

Number of items per page (max: 100)

string

Search by client name, email, or phone

status

string

Filter by status: active, inactive, pending

Response

success

boolean

Indicates if the request was successful

data

array

Array of client objects

Show Client Object

string

Unique client identifier

name

string

Client full name

string

Client email address

phone

string

Client phone number

address

object

Client address information

Show Address Object

street

string

Street address

city

string

City name

state

string

State or province

postalCode

string

Postal or ZIP code

country

string

Country code (ISO 3166-1 alpha-2)

status

string

Client status: active, inactive, pending

createdAt

string

ISO 8601 timestamp of creation

updatedAt

string

ISO 8601 timestamp of last update

Get Client

GET /v1/clients/{clientId}

Path Parameters

clientId

string

required

The unique identifier of the client

Create Client

POST /v1/clients

Body Parameters

name

string

required

Client full name

string

required

Client email address

phone

string

required

Client phone number

address

object

required

Client address information

Show Address Fields

street

string

required

Street address

city

string

required

City name

state

string

required

State or province

postalCode

string

required

Postal or ZIP code

country

string

required

Country code (ISO 3166-1 alpha-2)

taxId

string

Tax identification number (CPF/CNPJ)

notes

string

Additional notes about the client

Update Client

PUT /v1/clients/{clientId}

Delete Client

DELETE /v1/clients/{clientId}

Projects

Manage solar installation projects.

List Projects

GET /v1/projects

Query Parameters

clientId

string

Filter projects by client ID

status

string

Filter by status: planning, approved, in_progress, completed, cancelled

page

integer

default:"1"

Page number for pagination

limit

integer

default:"20"

Number of items per page

Create Project

POST /v1/projects

Body Parameters

clientId

string

required

ID of the client for this project

name

string

required

Project name or description

systemSize

number

required

Solar system size in kW

estimatedCost

number

required

Estimated project cost in currency units

startDate

string

Planned start date (ISO 8601 format)

notes

string

Additional project notes

Installations

Track solar panel installations and maintenance.

List Installations

GET /v1/installations

Get Installation Details

GET /v1/installations/{installationId}

Response Fields

string

Installation unique identifier

projectId

string

Associated project ID

status

string

Installation status: scheduled, in_progress, completed, maintenance

panels

array

Array of solar panel information

Show Panel Object

serialNumber

string

Panel serial number

manufacturer

string

Panel manufacturer

wattage

number

Panel wattage in watts

installDate

string

Installation date (ISO 8601)

inverter

object

Inverter information

Show Inverter Object

model

string

Inverter model

manufacturer

string

Inverter manufacturer

capacity

number

Inverter capacity in kW

Invoices

Manage billing and invoices.

List Invoices

GET /v1/invoices

Query Parameters

clientId

string

Filter invoices by client ID

status

string

Filter by status: draft, sent, paid, overdue, cancelled

startDate

string

Filter by invoices created after this date (ISO 8601)

endDate

string

Filter by invoices created before this date (ISO 8601)

Create Invoice

POST /v1/invoices

Body Parameters

clientId

string

required

Client ID for this invoice

projectId

string

Associated project ID

items

array

required

Array of invoice line items

Show Item Object

description

string

required

Item description

quantity

number

required

Item quantity

unitPrice

number

required

Price per unit

dueDate

string

required

Invoice due date (ISO 8601 format)

notes

string

Additional invoice notes

Reports

Generate and retrieve analytics reports.

Generate Energy Production Report

POST /v1/reports/energy-production

Body Parameters

installationId

string

required

Installation ID for the report

startDate

string

required

Report start date (ISO 8601)

endDate

string

required

Report end date (ISO 8601)

format

string

default:"json"

Report format: json, pdf, csv

Get Client Summary Report

GET /v1/reports/client-summary/{clientId}

totalProjects

number

Total number of projects for the client

totalRevenue

number

Total revenue from the client

activeInstallations

number

Number of active installations

totalEnergyProduced

number

Total energy produced in kWh

API

​Clients

​List Clients

​Query Parameters

​Response

​Get Client

​Path Parameters

​Create Client

​Body Parameters

​Update Client

​Delete Client

​Projects

​List Projects

​Query Parameters

​Create Project

​Body Parameters

​Installations

​List Installations

​Get Installation Details

​Response Fields

​Invoices

​List Invoices

​Query Parameters

​Create Invoice

​Body Parameters

​Reports

​Generate Energy Production Report

​Body Parameters

​Get Client Summary Report

Build docs developers (and LLMs) love

Clients

List Clients

Query Parameters

Response

Get Client

Path Parameters

Create Client

Body Parameters

Update Client

Delete Client

Projects

List Projects

Query Parameters

Create Project

Body Parameters

Installations

List Installations

Get Installation Details

Response Fields

Invoices

List Invoices

Query Parameters

Create Invoice

Body Parameters

Reports

Generate Energy Production Report

Body Parameters

Get Client Summary Report