Exigo Web Services API v2022.12.19.1

 Search

GetCustomerBalances

Returns the sum of orders, payments, and adjustments per currency.

Input Properties

GetCustomerBalancesRequest
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

Output Properties

GetCustomerBalancesResponse
PropertyData TypeNotes
CustomerBalancesCustomerBalanceResponse[]
CustomerBalanceResponse
PropertyData TypeNotes
CurrencyCode String
CurrencyDescriptionString
BalanceDecimal

Http Request

GET https://yourcompany-api.exigo.com/3.0/customers/balances?customerID=1
  &customerKey=1
Authorization: Basic base64Encoded

Http Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: length


{
  "customerBalances": null,
  "result": null
}

Soap Request

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /3.0/ExigoApi.asmx HTTP/1.1
Host: totallife-api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/GetCustomerBalances"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <ApiAuthentication xmlns="http://api.exigo.com/">
      <LoginName>string</LoginName>
      <Password>string</Password>
      <Company>string</Company>
      <Identity>string</Identity>
      <RequestTimeUtc>dateTime</RequestTimeUtc>
      <Signature>string</Signature>
    </ApiAuthentication>
  </soap:Header>
  <soap:Body>
    <GetCustomerBalancesRequest xmlns="http://api.exigo.com/">
      <CustomerID>int</CustomerID>
      <CustomerKey>string</CustomerKey>
    </GetCustomerBalancesRequest>
  </soap:Body>
</soap:Envelope>

Soap Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope 
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
      xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetCustomerBalancesResult xmlns="http://api.exigo.com/">
      <CustomerBalances>
        <CustomerBalanceResponse>
          <CurrencyCode>string</CurrencyCode>
          <CurrencyDescription>string</CurrencyDescription>
          <Balance>decimal</Balance>
        </CustomerBalanceResponse>
      </CustomerBalances>
    </GetCustomerBalancesResult>
  </soap:Body>
</soap:Envelope>

C# Rest Client

Install Nuget package Exigo.Api.Client

try

{

    //Create Api Client

    var api = new ExigoApiClient("yourcmpany", "yourlogin", "yourpassword");

 

    //Create Request

    var req = new GetCustomerBalancesRequest();

 

    req.CustomerID = 1;             //Unique numeric identifier for customer record.

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

 

    //Send Request to Server and Get Response

    var res = await api.GetCustomerBalancesAsync(req);

 

    //Now examine the results:

 

    foreach (var customerBalance in res.CustomerBalances)

    {

        Console.WriteLine("CurrencyCode: {0}", customerBalance.CurrencyCode);

        Console.WriteLine("CurrencyDescription: {0}", customerBalance.CurrencyDescription);

        Console.WriteLine("Balance: {0}", customerBalance.Balance);

    }

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

C# Soap Client

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.LoginName = "yourLoginName";

    auth.Password = "yourPassword";

    auth.Company = "yourCompany";

    api.ApiAuthenticationValue = auth;

 

    //Create Request

    GetCustomerBalancesRequest req = new GetCustomerBalancesRequest();

 

    req.CustomerID = 1;             //Unique numeric identifier for customer record.

    req.CustomerKey = "1";          //Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.

 

    //Send Request to Server and Get Response

    GetCustomerBalancesResponse res = api.GetCustomerBalances(req);

 

    //Now examine the results:

 

    foreach (CustomerBalanceResponse customerBalance in res.CustomerBalances)

    {

        Console.WriteLine("CurrencyCode: {0}", customerBalance.CurrencyCode);

        Console.WriteLine("CurrencyDescription: {0}", customerBalance.CurrencyDescription);

        Console.WriteLine("Balance: {0}", customerBalance.Balance);

    }

}

catch (Exception ex)

{

    Console.WriteLine("Error: " + ex.Message);

}

VB.Net

Try

    'Create Main API Context Object

    Dim api as new ExigoApi()

 

    'Create Authentication Header

    Dim auth as new ApiAuthentication()

    auth.LoginName = "yourLoginName"

    auth.Password = "yourPassword"

    auth.Company = "yourCompany"

    api.ApiAuthenticationValue = auth

 

    'Create Request

    Dim req as new GetCustomerBalancesRequest()

 

    req.CustomerID = 1

    req.CustomerKey = "1"

 

    'Send Request to Server and Get Response

    Dim res As GetCustomerBalancesResponse = api.GetCustomerBalances(req)

 

    'Now examine the results:

 

    For Each customerBalance As CustomerBalanceResponse In res.CustomerBalances

        Console.WriteLine("CurrencyCode: {0}", customerBalance.CurrencyCode)

        Console.WriteLine("CurrencyDescription: {0}", customerBalance.CurrencyDescription)

        Console.WriteLine("Balance: {0}", customerBalance.Balance)

    Next

Catch ex As Exception

    Console.WriteLine("Error: " & ex.Message)

End Try

PHP

Note: PHP is not officially supported.

<?php

try

{

    //Setup the SoapClient and Authentication

    $api = new SoapClient("http://api.exigo.com/3.0/ExigoApi.asmx?WSDL");

    $ns = "http://api.exigo.com/";

    $auth = array()

    $auth["LoginName"] = new SoapVar("yourLoginName",XSD_STRING,null,null,null,$ns);

    $auth["Password"] = new SoapVar("yourPassword",XSD_STRING,null,null,null,$ns);

    $auth["Company"] = new SoapVar("yourCompany",XSD_STRING,null,null,null,$ns);

    $headerBody = new SoapVar($auth, SOAP_ENC_OBJECT);

    $header = new SoapHeader($ns, 'ApiAuthentication', $headerBody);

    $api->__setSoapHeaders(array($header));

 

    //Create Request

 

    $req->CustomerID = 1;

    $req->CustomerKey = "1";

 

    //Send Request to Server and Get Response

    $res = $api.GetCustomerBalances($req);

 

    //Now examine the results:

}

catch (SoapFault $ex)

{

    echo "Error: ", $ex->getMessage();

}

?>

Java

Note: Java is not officially supported.

try

{

    //Create Main API Context Object

    ExigoApi api = new ExigoApi();

 

    //Create Authentication Header

    ApiAuthentication auth = new ApiAuthentication();

    auth.setLoginName("yourLoginName");

    auth.setPassword("yourPassword");

    auth.setCompany("yourCompany");

    api.setApiAuthenticationValue(auth);

 

    //Create Request

    GetCustomerBalancesRequest req = new GetCustomerBalancesRequest();

 

    req.setCustomerID(1);

    req.setCustomerKey("1");

 

    //Send Request to Server and Get Response

    GetCustomerBalancesResponse res = api.getExigoApiSoap().getCustomerBalances(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

    System.out.println("Error: " + ex.getMessage());

}

CSV

This method does not support csv output.