Dokumentation för API-funktioner
GET CRM/Economy/{customerId}/CRM/Estate/{estateId}/deposit

Hämtar uppgifter om handpenning avseende en bostad.

För att kunna hämta uppgifter så krävs det en giltig API nyckel och ett kundid.

Request Information URI Parameters
NamnBeskrivningTypInformation
customerId Kundid string Krävs
estateId bostadsid string Krävs
Response Information Resource Description Hämtar handpenningsuppgifter. Deposit
NamnBeskrivningTypInformation
Amount Belopp decimal number

PayDay Dag för erläggning date

PaidAt Erlagd date

ReportedAt Redovisad date

CommissionReceivedAt Provision erhållen date

ContractDay Kontraktsdag date

AdmissionDay Tillträde date

Kodexempel

curl "https://connect.maklare.vitec.net/CRM/Economy/StringValue/CRM/Estate/StringValue/deposit" -X GET -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" 
            

$URL = "https://connect.maklare.vitec.net/CRM/Economy/StringValue/CRM/Estate/StringValue/deposit"
Invoke-WebRequest -Uri $URL -Method GET -Headers @{"authorization" = "basic {Base64 kodad användarnamn och lösenord}"} 
                

// HttpClientInstance ska deklareras som en singleton
// public static readonly HttpClient HttpClientInstance = new HttpClient {
//     BaseAddress = new Uri("https://connect.maklare.vitec.net"),
//     DefaultRequestHeaders = {
//         Authorization = new AuthenticationHeaderValue("Basic", "{Base64 kodad användarnamn och lösenord}")
//     }
// }
using (var response = await HttpClientInstance.GetAsync("CRM/Economy/StringValue/CRM/Estate/StringValue/deposit")) {
    if (response.StatusCode == HttpStatusCode.Unauthorized) {
        // Authorization headern är inte korrekt
    }
    if (response.StatusCode == HttpStatusCode.Forbidden) {
        // Begärt data som det saknas åtkomst till
    }
    if (response.StatusCode == HttpStatusCode.InternalServerError) {
        // Oväntat fel, kontakta Vitec
    }
    if (response.StatusCode == HttpStatusCode.BadRequest) {
        var json = await response.Content.ReadAsStringAsync();
        var result = JsonConvert.DeserializeObject<dynamic>(json);
        // Hantera valideringsfel, presenteras i resultatet
    }
    
    var json = await response.Content.ReadAsStringAsync();
    // JsonConvert finns i biblioteket Newtonsoft.Json
    var result = JsonConvert.DeserializeObject<dynamic>(json);
    
    var amount = result.amount.Value;
    // TODO: Gör något med resultatet
}

$URL = "https://connect.maklare.vitec.net/CRM/Economy/StringValue/CRM/Estate/StringValue/deposit";

$ch = curl_init();

curl_setopt($ch, CURLOPT_USERNAME, "{Användarnamn}");
curl_setopt($ch, CURLOPT_PASSWORD, "{Lösenord}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_URL, $URL);

$result = curl_exec($ch);

if (curl_errno($ch)) {
    die(curl_getinfo($ch));
}

$info = curl_getinfo($ch);
curl_close($ch);

$http_code = $info["http_code"];
if ($http_code == 401) {
    // Användarnamnet eller lösenordet är felaktigt
}
if ($http_code == 403) {
    // Begärt data som det saknas åtkomst till
}
if ($http_code == 500) {
    // Oväntat fel, kontakta Vitec
}
if ($http_code == 400) {
    $json = json_decode($result, true);
    // Hantera valideringsfel, presenteras i $json
}

$field_on_result = $result["amount"];
// TODO: Gör något med resultatet
Testformulär Text input
Response Formats
{
  "amount": 1.1,
  "payDay": "2024-04-28T01:50:57.8316696+02:00",
  "paidAt": "2024-04-28T01:50:57.8316696+02:00",
  "reportedAt": "2024-04-28T01:50:57.8316696+02:00",
  "commissionReceivedAt": "2024-04-28T01:50:57.8316696+02:00",
  "contractDay": "2024-04-28T01:50:57.8316696+02:00",
  "admissionDay": "2024-04-28T01:50:57.8316696+02:00"
}
<Deposit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Economy">
  <AdmissionDay>2024-04-28T01:50:57.8316696+02:00</AdmissionDay>
  <Amount>1.1</Amount>
  <CommissionReceivedAt>2024-04-28T01:50:57.8316696+02:00</CommissionReceivedAt>
  <ContractDay>2024-04-28T01:50:57.8316696+02:00</ContractDay>
  <PaidAt>2024-04-28T01:50:57.8316696+02:00</PaidAt>
  <PayDay>2024-04-28T01:50:57.8316696+02:00</PayDay>
  <ReportedAt>2024-04-28T01:50:57.8316696+02:00</ReportedAt>
</Deposit>