AlugSol (1.0)

Download OpenAPI specification:Download

API Documentation for AlugSol

Contract

Updates the contract's status

Updates contract status at the scheduling/installation stage

header Parameters

s-api-key

required

string

RMTP Access token

Request Body schema: application/json

contractId required	string ID do contrato
status required	string Enum: "CONTRACT_ANALYSIS" "CONTRACT_APPROVED" "CONTRACT_CANCELED" "CONTRACT_REJECTED" "HOMOLOG_APPROVED" "HOMOLOG_REJECTED" "CARRIER_DISPATCH_DATE" "CARRIER_SCHEDULING_DATE" "CARRIER_DELIVERY_DATE" "SCHEDULED" "RESCHEDULED" "SCHEDULING_CANCELED" "INSTALLATION" "INSTALLATION_RESCHEDULED" "INSTALLATION_CANCELED" "INSTALLATION_COMPLETED" "INSPECTION_COMPLETED" Provides the status of the contract. Only items on the list are accepted.
status_change_reasons	Array of strings Items Enum: "INSTALLATION_AREA_INSUFFICIENT" "INSTALLATION_AFFECTED_BY_SHADING" "DOCUMENTATION_REJECTED" "PHOTOS_REJECTED" List of reasons for status change. This field is required when the status is 'CONTRACT_REJECTED' or 'CONTRACT_CANCELED', if no observation is provided.
carrier_dispatch_date	string <date-time> Order dispatch date in ISO 8601 (UTC) format. Required property only when status is 'CARRIER_DISPATCH_DATE'
carrier_expected_delivery_date	string <date-time> Estimated delivery date in ISO 8601 (UTC) format. Required property only when status is 'CARRIER_DISPATCH_DATE'
carrier_scheduling_date	string <date-time> Appointment date in ISO 8601 (UTC) format. Required property only when status is 'CARRIER_SCHEDULING_DATE'
carrier_delivery_date	string <date-time> Date of delivery of material in ISO 8601 (UTC) format. Required property only when status is 'CARRIER_DELIVERY_DATE'
carrier_name	string <string> Name of the carrier company Required property only when status is 'CARRIER_DISPATCH_DATE'
carrier_order_number	string <string> Code of the order on the carrier system. This property is required only when the status is 'CARRIER_DISPATCH_DATE'.
carrier_receipt_number	string <string> Number of the order receipt on the carrier system. This property is required only when the status is 'CARRIER_DISPATCH_DATE'.
installation_start_date	string <date-time> Date of when the installation starts in ISO 8601 (UTC) format. Required property only when status is 'INSTALLATION'
installation_end_date	string <date-time> Date of when the installation ends in ISO 8601 (UTC) format. Required property only when status is 'INSTALLATION_COMPLETED'
power_plant_connection_date	string <date-time> Date of power plant connection in ISO 8601 (UTC) format. Required property only when status is 'INSPECTION_COMPLETED'
installation_scheduled_date	string <date-time> Installation rescheduled date in ISO 8601 (UTC) format. Required property only when status is 'INSTALLATION_RESCHEDULED'
	object (Observation)

Responses

Request samples

Payload

Content type

application/json

{"contractId": "623b3b46f59591002100e37b",
"status": "CARRIER_DISPATCH_DATE",
"status_change_reasons": ["INSTALLATION_AREA_INSUFFICIENT",
"DOCUMENTATION_REJECTED"
],
"carrier_dispatch_date": "2025-02-10T20:34:23.777Z",
"carrier_expected_delivery_date": "2025-02-10T20:34:23.777Z",
"carrier_scheduling_date": "2025-02-10T20:34:23.777Z",
"carrier_delivery_date": "2025-02-10T20:34:23.777Z",
"carrier_name": "Sunne transportes",
"carrier_order_number": "536577",
"carrier_receipt_number": "43766876",
"installation_start_date": "2025-02-10T20:34:23.777Z",
"installation_end_date": "2025-02-10T20:34:23.777Z",
"power_plant_connection_date": "2025-02-10T20:34:23.777Z",
"installation_scheduled_date": "2025-02-10T20:34:23.777Z",
"observation": {"description": "Telhado com problemas na estrutura",
"attachments": [{"mediaType": "image/png",
"url": "https://sunnesaas.s3.us-east-2.amazonaws.com/assets_saas/logo.png",
"description": "Foto da estrutura"
}
]
}
}

Response samples

Content type

application/json

{"id": "623b3b46f59591002100e37b",
"status": "CARRIER_DISPATCH_DATE",
"updated_at": "2025-02-10T20:34:23.777Z"
}

Retrieve a contract by id

Retrieve a contract infos by id

header Parameters

s-api-key

required

string

RMTP Access token

Request Body schema: application/json

contractId

required

string

ID do contrato

Responses

Request samples

Payload

Content type

application/json

{"contractId": "623b3b46f59591002100e37b"
}

Response samples

Content type

application/json

{"id": "623b3b46f59591002100e37b",
"status": "CARRIER_DISPATCH_DATE",
"name": "Sunne test",
"carrier_dispatch_date": "2025-02-10T20:34:23.777Z",
"carrier_expected_delivery_date": "2025-02-10T20:34:23.777Z",
"carrier_scheduling_date": "2025-02-10T20:34:23.777Z",
"carrier_delivery_date": "2025-02-10T20:34:23.777Z",
"installation_scheduled_date": "2025-02-10T20:34:23.777Z",
"carrier_order_number": "56765634",
"carrier_receipt_number": "56765634",
"installation_start_date": "2025-02-10T20:34:23.777Z",
"installation_end_date": "2025-02-10T20:34:23.777Z",
"meter_replacement_date": "2025-02-10T20:34:23.777Z",
"power_plant_connection_date": "2025-02-10T20:34:23.777Z",
"carrier_name": "Sunne logistics",
"status_history": [{"id": "65464653y658778",
"previous_status": "CARRIER_DISPATCH_DATE",
"new_status": "CARRIER_SCHEDULING_DATE",
"status_change_reasons": ["INSTALLATION_AREA_INSUFFICIENT"
],
"status_change_comment": "Contract rejected because of insufficient area",
"created_at": "2025-02-10T20:34:23.777Z"
}
]
}