### EnergyMeters API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for retrieving lists of energy meters (installations) and individual meters by their ID. ```APIDOC ## GET /EnergyMeters ### Description Returns a list of installations (energy meters). ### Method GET ### Endpoint /EnergyMeters ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **meters** (array) - A list of energy meter objects. #### Response Example { "meters": [ { "id": "meter1", "location": "Main Street" } ] } ## GET /EnergyMeters/{id} ### Description Returns a specific installation (energy meter) element by its identifier. ### Method GET ### Endpoint /EnergyMeters/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the energy meter. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **meter** (object) - The energy meter object. #### Response Example { "id": "meter1", "location": "Main Street" } ``` -------------------------------- ### Queries API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides an endpoint to query open customer debits. ```APIDOC ## GET /Queries/GetCustomerDebits/{registrationNumber} ### Description Returns a list of open customer debit slips (boletos) and their statuses based on a CPF (Brazilian individual taxpayer registry ID). ### Method GET ### Endpoint /Queries/GetCustomerDebits/{registrationNumber} ### Parameters #### Path Parameters - **registrationNumber** (string) - Required - The customer's CPF. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **debits** (array) - A list of customer debit objects. #### Response Example { "debits": [ { "link": "http://example.com/boleto1", "status": "Open" } ] } ``` -------------------------------- ### Leads API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for retrieving lists of leads (prospects) and individual leads by their ID. ```APIDOC ## GET /Leads ### Description Returns a list of leads (prospects). ### Method GET ### Endpoint /Leads ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **leads** (array) - A list of lead objects. #### Response Example { "leads": [ { "id": "lead1", "name": "Potential Client A" } ] } ## GET /Leads/{id} ### Description Returns a specific lead element by its identifier. ### Method GET ### Endpoint /Leads/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the lead. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **lead** (object) - The lead object. #### Response Example { "id": "lead1", "name": "Potential Client A" } ``` -------------------------------- ### Contracts API Source: https://dev-server.solatioenergialivre.com.br/docs/index Endpoint for generating signature links for contracts. ```APIDOC ## POST /Contracts/GetSignatureLink/{documentURL} ### Description Generates a signature link for a given contract document URL. ### Method POST ### Endpoint /Contracts/GetSignatureLink/{documentURL} ### Parameters #### Path Parameters - **documentURL** (string) - Required - The URL of the contract document. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **signatureLink** (string) - The generated signature link. #### Response Example { "signatureLink": "https://example.com/sign?doc=123" } ``` -------------------------------- ### Prospector API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for cashback inquiries and updating lead contract status. ```APIDOC ## GET /ProspectorAPI/Cashback ### Description If you are a partner working with Cashback, you can consult customers who should receive cashback in a given period related to payments. ### Method GET ### Endpoint /ProspectorAPI/Cashback ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **cashbackData** (array) - A list of cashback data objects. #### Response Example { "cashbackData": [ { "customerId": "cust1", "cashbackAmount": 50.00 } ] } ## GET /ProspectorAPI/AdhesionCashback ### Description If you are a partner working with Cashback, you can consult customers who should receive cashback in a given period related to adhesions. ### Method GET ### Endpoint /ProspectorAPI/AdhesionCashback ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **adhesionCashbackData** (array) - A list of adhesion cashback data objects. #### Response Example { "adhesionCashbackData": [ { "customerId": "cust2", "adhesionCashbackAmount": 25.00 } ] } ## PATCH /ProspectorAPI/SetLeadContractStatus ### Description Completes some fields of the prospect in the database related to the contract signature. ### Method PATCH ### Endpoint /ProspectorAPI/SetLeadContractStatus ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **leadId** (string) - Required - The ID of the lead. - **status** (string) - Required - The new contract status. ### Request Example { "leadId": "lead1", "status": "Signed" } ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example { "message": "Lead contract status updated successfully." } ## PATCH /ProspectorAPI/FinishLead ### Description Completes some fields of the prospect in the database related to the contract finalization. ### Method PATCH ### Endpoint /ProspectorAPI/FinishLead ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **leadId** (string) - Required - The ID of the lead. - **completionDetails** (object) - Required - Details about the lead finalization. ### Request Example { "leadId": "lead1", "completionDetails": { "finalizedDate": "2023-03-01" } } ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example { "message": "Lead finalized successfully." } ``` -------------------------------- ### Customers API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for retrieving lists of customers and individual customers by their ID. ```APIDOC ## GET /Customers ### Description Returns a list of customer accesses. ### Method GET ### Endpoint /Customers ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **customers** (array) - A list of customer objects. #### Response Example { "customers": [ { "id": "cust1", "name": "Acme Corp" } ] } ## GET /Customers/{id} ### Description Returns a specific customer element by its identifier. ### Method GET ### Endpoint /Customers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the customer. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **customer** (object) - The customer object. #### Response Example { "id": "cust1", "name": "Acme Corp" } ``` -------------------------------- ### Vouchers API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for retrieving lists of vouchers (coupons) and individual vouchers by their ID. ```APIDOC ## GET /Vouchers ### Description Returns a list of vouchers (coupons). ### Method GET ### Endpoint /Vouchers ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **vouchers** (array) - A list of voucher objects. #### Response Example { "vouchers": [ { "id": "voucher1", "code": "SUMMER20" } ] } ## GET /Vouchers/{id} ### Description Returns a specific voucher element by its identifier. ### Method GET ### Endpoint /Vouchers/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the voucher. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **voucher** (object) - The voucher object. #### Response Example { "id": "voucher1", "code": "SUMMER20" } ``` -------------------------------- ### EnergyMeterInvoices API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for retrieving lists of energy meter invoices and individual invoices by their ID. ```APIDOC ## GET /EnergyMeterInvoices ### Description Returns a list of energy meter billing statements. ### Method GET ### Endpoint /EnergyMeterInvoices ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **invoices** (array) - A list of energy meter invoice objects. #### Response Example { "invoices": [ { "id": "inv1", "period": "2023-01", "total": 120.00 } ] } ## GET /EnergyMeterInvoices/{id} ### Description Returns a specific energy meter invoice element by its identifier. ### Method GET ### Endpoint /EnergyMeterInvoices/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the energy meter invoice. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **invoice** (object) - The energy meter invoice object. #### Response Example { "id": "inv1", "period": "2023-01", "total": 120.00 } ``` -------------------------------- ### EnergyMeterPayments API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for retrieving lists of energy meter payments and individual payments by their ID. ```APIDOC ## GET /EnergyMeterPayments ### Description Returns a list of energy meter payment receipts. ### Method GET ### Endpoint /EnergyMeterPayments ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **payments** (array) - A list of energy meter payment objects. #### Response Example { "payments": [ { "id": "pay1", "date": "2023-02-15", "amount": 120.00 } ] } ## GET /EnergyMeterPayments/{id} ### Description Returns a specific energy meter payment element by its identifier. ### Method GET ### Endpoint /EnergyMeterPayments/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the energy meter payment. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **payment** (object) - The energy meter payment object. #### Response Example { "id": "pay1", "date": "2023-02-15", "amount": 120.00 } ``` -------------------------------- ### EnergyMeterBills API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for retrieving lists of energy meter bills and individual bills by their ID. ```APIDOC ## GET /EnergyMeterBills ### Description Returns a list of energy meter bills for the installation at the Distributor. ### Method GET ### Endpoint /EnergyMeterBills ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **bills** (array) - A list of energy meter bill objects. #### Response Example { "bills": [ { "id": "bill1", "month": "January", "amount": 100.50 } ] } ## GET /EnergyMeterBills/{id} ### Description Returns a specific energy meter bill element by its identifier. ### Method GET ### Endpoint /EnergyMeterBills/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the energy meter bill. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **bill** (object) - The energy meter bill object. #### Response Example { "id": "bill1", "month": "January", "amount": 100.50 } ``` -------------------------------- ### Contacts API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for retrieving lists of contacts and individual contacts by their ID. ```APIDOC ## GET /Contacts ### Description Returns a list of contacts. ### Method GET ### Endpoint /Contacts ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **contacts** (array) - A list of contact objects. #### Response Example { "contacts": [ { "id": "123", "name": "John Doe" } ] } ## GET /Contacts/{id} ### Description Returns a specific contact element by its identifier. ### Method GET ### Endpoint /Contacts/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the contact. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **contact** (object) - The contact object. #### Response Example { "id": "123", "name": "John Doe" } ``` -------------------------------- ### Tickets API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for retrieving lists of tickets (attendments) and individual tickets by their ID. ```APIDOC ## GET /Tickets ### Description Returns a list of attendments (tickets). ### Method GET ### Endpoint /Tickets ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **tickets** (array) - A list of ticket objects. #### Response Example { "tickets": [ { "id": "ticket1", "subject": "Inquiry about service" } ] } ## GET /Tickets/{id} ### Description Returns a specific attendment (ticket) element by its identifier. ### Method GET ### Endpoint /Tickets/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the ticket. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **ticket** (object) - The ticket object. #### Response Example { "id": "ticket1", "subject": "Inquiry about service" } ``` -------------------------------- ### Prospectors API Source: https://dev-server.solatioenergialivre.com.br/docs/index Provides endpoints for retrieving lists of prospectors and individual prospectors by their ID. ```APIDOC ## GET /Prospectors ### Description Returns a list of prospectors. ### Method GET ### Endpoint /Prospectors ### Parameters #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **prospectors** (array) - A list of prospector objects. #### Response Example { "prospectors": [ { "id": "pros1", "name": "Prospector Alpha" } ] } ## GET /Prospectors/{id} ### Description Returns a specific prospector element by its identifier. ### Method GET ### Endpoint /Prospectors/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the prospector. #### Query Parameters None #### Request Body None ### Response #### Success Response (200) - **prospector** (object) - The prospector object. #### Response Example { "id": "pros1", "name": "Prospector Alpha" } ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.