Exigo Web Services API v2022.12.19.1

 Search

GetBillAmountsDue

Gets customer bill amounts due grouped by customer.

Input Properties

GetBillAmountsDueRequest
PropertyData TypeNotes
StartDateDateTime
EndDateDateTime
CurrencyCode String
CountryCode String
PayableType Int32
PaymentCardType Int32Optional. The type of paycard.
MinimumAmountDecimal
MaximumAmountDecimalOptional.
CustomersInt32[]Optional. Use this to filter list by one or more customer ids. Defaults to System.Int32[].

Output Properties

GetBillAmountsDueResponse
PropertyData TypeNotes
AmountsDueBillAmount[]
BillAmount
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for a customer record.
NameString
BillDetailsBillDetail[]
AmountDueDecimal
TotalBillsInt32
BillDetail
PropertyData TypeNotes
BillIDInt32
AmountDueDecimal

Http Request

GET https://yourcompany-api.exigo.com/3.0/payout/amountsdue?startDate=1
  &endDate=1
  &currencyCode=1
  &countryCode=1
  &payableType=1
  &paymentCardType=1
  &minimumAmount=1
  &maximumAmount=1
  &customers=1
Authorization: Basic base64Encoded

Http Response

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


{
  "amountsDue": 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/GetBillAmountsDue"

<?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>
    <GetBillAmountsDueRequest xmlns="http://api.exigo.com/">
      <StartDate>dateTime</StartDate>
      <EndDate>dateTime</EndDate>
      <CurrencyCode>string</CurrencyCode>
      <CountryCode>string</CountryCode>
      <PayableType>int</PayableType>
      <PaymentCardType>int</PaymentCardType>
      <MinimumAmount>decimal</MinimumAmount>
      <MaximumAmount>decimal</MaximumAmount>
      <Customers>
        <int>int</int>
      </Customers>
    </GetBillAmountsDueRequest>
  </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>
    <GetBillAmountsDueResult xmlns="http://api.exigo.com/">
      <AmountsDue>
        <BillAmount>
          <CustomerID>int</CustomerID>
          <Name>string</Name>
          <BillDetails>
            <BillDetail>
              <BillID>int</BillID>
              <AmountDue>decimal</AmountDue>
            </BillDetail>
          </BillDetails>
          <AmountDue>decimal</AmountDue>
          <TotalBills>int</TotalBills>
        </BillAmount>
      </AmountsDue>
    </GetBillAmountsDueResult>
  </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 GetBillAmountsDueRequest();

 

    req.StartDate = DateTime.Today;

    req.EndDate = DateTime.Today;

    req.CurrencyCode = "1";

    req.CountryCode = "1";

    req.PayableType = 1;

    req.PaymentCardType = 1;        //The type of paycard

    req.MinimumAmount = 1;

    req.MaximumAmount = 1;

 

    //Add Customers

    var customers = new List<Int32>();

    customers.Add(1);

    customers.Add(2);

 

    //Now attach the list to the request

    req.Customers = customers.ToArray();

 

    //Send Request to Server and Get Response

    var res = await api.GetBillAmountsDueAsync(req);

 

    //Now examine the results:

 

    foreach (var billAmount in res.AmountsDue)

    {

        Console.WriteLine("CustomerID: {0}", billAmount.CustomerID);

        Console.WriteLine("Name: {0}", billAmount.Name);

 

        foreach (var billDetail in billAmount.BillDetails)

        {

            Console.WriteLine("BillID: {0}", billDetail.BillID);

            Console.WriteLine("AmountDue: {0}", billDetail.AmountDue);

        }

        Console.WriteLine("AmountDue: {0}", billAmount.AmountDue);

        Console.WriteLine("TotalBills: {0}", billAmount.TotalBills);

    }

}

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

    GetBillAmountsDueRequest req = new GetBillAmountsDueRequest();

 

    req.StartDate = DateTime.Today;

    req.EndDate = DateTime.Today;

    req.CurrencyCode = "1";

    req.CountryCode = "1";

    req.PayableType = 1;

    req.PaymentCardType = 1;        //The type of paycard

    req.MinimumAmount = 1;

    req.MaximumAmount = 1;

 

    //Add Customers

    List<Int32> customers = new List<Int32>();

    customers.Add(1);

    customers.Add(2);

 

    //Now attach the list to the request

    req.Customers = customers.ToArray();

 

    //Send Request to Server and Get Response

    GetBillAmountsDueResponse res = api.GetBillAmountsDue(req);

 

    //Now examine the results:

 

    foreach (BillAmount billAmount in res.AmountsDue)

    {

        Console.WriteLine("CustomerID: {0}", billAmount.CustomerID);

        Console.WriteLine("Name: {0}", billAmount.Name);

 

        foreach (BillDetail billDetail in billAmount.BillDetails)

        {

            Console.WriteLine("BillID: {0}", billDetail.BillID);

            Console.WriteLine("AmountDue: {0}", billDetail.AmountDue);

        }

        Console.WriteLine("AmountDue: {0}", billAmount.AmountDue);

        Console.WriteLine("TotalBills: {0}", billAmount.TotalBills);

    }

}

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 GetBillAmountsDueRequest()

 

    req.StartDate = DateTime.Today

    req.EndDate = DateTime.Today

    req.CurrencyCode = "1"

    req.CountryCode = "1"

    req.PayableType = 1

    req.PaymentCardType = 1

    req.MinimumAmount = 1

    req.MaximumAmount = 1

 

    'Add Customers

    Dim customers As New List(Of Int32)()

    customers.Add(1)

    customers.Add(2)

 

    'Now attach the list to the request

    req.Customers = customers.ToArray()

 

    'Send Request to Server and Get Response

    Dim res As GetBillAmountsDueResponse = api.GetBillAmountsDue(req)

 

    'Now examine the results:

 

    For Each billAmount As BillAmount In res.AmountsDue

        Console.WriteLine("CustomerID: {0}", billAmount.CustomerID)

        Console.WriteLine("Name: {0}", billAmount.Name)

 

        For Each billDetail As BillDetail In billAmount.BillDetails

            Console.WriteLine("BillID: {0}", billDetail.BillID)

            Console.WriteLine("AmountDue: {0}", billDetail.AmountDue)

        Next

        Console.WriteLine("AmountDue: {0}", billAmount.AmountDue)

        Console.WriteLine("TotalBills: {0}", billAmount.TotalBills)

    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->StartDate = 1;

    $req->EndDate = 1;

    $req->CurrencyCode = "1";

    $req->CountryCode = "1";

    $req->PayableType = 1;

    $req->PaymentCardType = 1;

    $req->MinimumAmount = 1;

    $req->MaximumAmount = 1;

 

    //Add Customers

 

 

 

    //Now attach the list to the request

    req.Customers = array(customer1,customer2);

 

    //Send Request to Server and Get Response

    $res = $api.GetBillAmountsDue($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

    GetBillAmountsDueRequest req = new GetBillAmountsDueRequest();

 

    req.setStartDate(1);

    req.setEndDate(1);

    req.setCurrencyCode("1");

    req.setCountryCode("1");

    req.setPayableType(1);

    req.setPaymentCardType(1);

    req.setMinimumAmount(1);

    req.setMaximumAmount(1);

 

    //Add Customers

    ArrayOfSystem.Int32 customers = new ArrayOfSystem.Int32();

 

    Int32 customer1 = new Int32();

    customers.Add(customer1);

 

    Int32 customer2 = new Int32();

    customers.Add(customer2);

 

    //Now attach the list to the request

    req.setCustomers(customers);

 

    //Send Request to Server and Get Response

    GetBillAmountsDueResponse res = api.getExigoApiSoap().getBillAmountsDue(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.