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

Uppdaterar handpenningsupppgifter.

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
Body Parameters Uppdateringsinformation DepositData
NamnBeskrivningTypInformation
PaidAt Erlagd date

ReportedAt Redovisad date

CommissionReceivedAt Provision erhållen date

Request Formats

{
  "paidAt": "2024-11-21T11:22:27.5332596+01:00",
  "reportedAt": "2024-11-21T11:22:27.5332596+01:00",
  "commissionReceivedAt": "2024-11-21T11:22:27.5332596+01:00"
}
<DepositData xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Vitec.Housing.Connect.Api.Models.Economy">
  <CommissionReceivedAt>2024-11-21T11:22:27.5332596+01:00</CommissionReceivedAt>
  <PaidAt>2024-11-21T11:22:27.5332596+01:00</PaidAt>
  <ReportedAt>2024-11-21T11:22:27.5332596+01:00</ReportedAt>
</DepositData>
Response Information Resource Description Uppdaterar handpenningsupppgifter. string Kodexempel

curl "https://connect.maklare.vitec.net/CRM/Economy/StringValue/Estate/StringValue/deposit" -X PUT -H "Content-Type: application/json" -H "Authorization: basic {Base64 kodad användarnamn och lösenord}" -d {\"paidAt\":\"2015-01-01T12:00:00\",\"reportedAt\":\"2015-01-01T12:00:00\",\"commissionReceivedAt\":\"2015-01-01T12:00:00\"}
            

$URL = "https://connect.maklare.vitec.net/CRM/Economy/StringValue/Estate/StringValue/deposit"
$data = "{`"paidAt`":`"2015-01-01T12:00:00`",`"reportedAt`":`"2015-01-01T12:00:00`",`"commissionReceivedAt`":`"2015-01-01T12:00:00`"}"
Invoke-WebRequest -Uri $URL -Method PUT -Headers @{"Content-Type" = "application/json"; "authorization" = "basic {Base64 kodad användarnamn och lösenord}"} -Body $data
                

// 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}")
//     }
// }
var json = "{\"paidAt\":\"2015-01-01T12:00:00\",\"reportedAt\":\"2015-01-01T12:00:00\",\"commissionReceivedAt\":\"2015-01-01T12:00:00\"}";
using (var response = await HttpClientInstance.PutAsync("CRM/Economy/StringValue/Estate/StringValue/deposit", new StringContent(json, Encoding.UTF8, "application/json"))) {
    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);
    
    // TODO: Gör något med resultatet
}

$URL = "https://connect.maklare.vitec.net/CRM/Economy/StringValue/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);
$data = "{\"paidAt\":\"2015-01-01T12:00:00\",\"reportedAt\":\"2015-01-01T12:00:00\",\"commissionReceivedAt\":\"2015-01-01T12:00:00\"}";
$headers = array( "Content-Type: application/json", "Content-Length: " . strlen($data) );
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');

curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data)
));

$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
}

// TODO: Gör något med resultatet
Testformulär Text input
Response Formats
"sample string 1"
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>