Exigo Web Services API v2022.12.19.1

 Search

GetBillPayments

Gets customer bill payments and associated bill records .

Input Properties

GetBillPaymentsRequest
PropertyData TypeNotes
PaymentIDsInt32[]Optional. . Defaults to System.Int32[].
StartPaymentIDInt32Optional.
EndPaymentIDInt32Optional.

Output Properties

GetBillPaymentsResponse
PropertyData TypeNotes
BillPaymentsBillPayment[]
BillPayment
PropertyData TypeNotes
PaymentIDInt32
CustomerIDInt32Unique numeric identifier for a customer record.
PaymentType Int32Payment type.
PaymentDateDateTime
AmountDecimal
CurrencyCode String
BankAccountID Int32Bank account identifier.
PayeeNameString
PayeeAddress1String
PayeeAddress2String
PayeeCityString
PayeeStateString
PayeeZipString
PayeeCountryString
CheckNumberStringCheck number will be auto generated if pay by check.
CheckDateDateTime
ClearedDateDateTime
VoidedDateDateTime
DeductionType Int32
DeductionNotesString
IsTaxableBoolean
PeriodID Int32
ReferenceString
TransactionDateDateTime
ModifiedDateDateTime
CreatedByString
ModifiedByString
PayeeCompanyString
DepositNumberStringWill be auto generated if pay by direct deposit.
Other1 String
Other2 String
Other3 String
Other4 String

Http Request

GET https://yourcompany-api.exigo.com/3.0/payout/payments?paymentIDs=1
  &startPaymentID=1
  &endPaymentID=1
Authorization: Basic base64Encoded

Http Response

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


{
  "billPayments": 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: api.exigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://api.exigo.com/GetBillPayments"

<?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>
    <GetBillPaymentsRequest xmlns="http://api.exigo.com/">
      <PaymentIDs>
        <int>int</int>
      </PaymentIDs>
      <StartPaymentID>int</StartPaymentID>
      <EndPaymentID>int</EndPaymentID>
    </GetBillPaymentsRequest>
  </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>
    <GetBillPaymentsResult xmlns="http://api.exigo.com/">
      <BillPayments>
        <BillPayment>
          <BillItems>
            <BillItem>
              <BillID>int</BillID>
              <BillType>int</BillType>
              <CustomerID>int</CustomerID>
              <WarehouseID>int</WarehouseID>
              <PeriodID>int</PeriodID>
              <RunID>int</RunID>
              <StatusType>int</StatusType>
              <Reference>string</Reference>
              <Notes>string</Notes>
              <SubTotal>decimal</SubTotal>
              <Shipping>decimal</Shipping>
              <Tax>decimal</Tax>
              <Amount>decimal</Amount>
              <CurrencyCode>string</CurrencyCode>
              <DateReceived>dateTime</DateReceived>
              <DatePaymentDue>dateTime</DatePaymentDue>
              <DateEntered>dateTime</DateEntered>
              <CreatedBy>string</CreatedBy>
              <ModifiedBy>string</ModifiedBy>
              <ModifiedDate>dateTime</ModifiedDate>
              <BillImage>string</BillImage>
              <IsOtherIncome>boolean</IsOtherIncome>
              <SourceType>int</SourceType>
              <PayableType>int</PayableType>
              <TaxablePeriodType>int</TaxablePeriodType>
              <TaxablePeriodID>int</TaxablePeriodID>
            </BillItem>
          </BillItems>
          <PaymentID>int</PaymentID>
          <CustomerID>int</CustomerID>
          <PaymentType>int</PaymentType>
          <PaymentDate>dateTime</PaymentDate>
          <Amount>decimal</Amount>
          <CurrencyCode>string</CurrencyCode>
          <BankAccountID>int</BankAccountID>
          <PayeeName>string</PayeeName>
          <PayeeAddress1>string</PayeeAddress1>
          <PayeeAddress2>string</PayeeAddress2>
          <PayeeCity>string</PayeeCity>
          <PayeeState>string</PayeeState>
          <PayeeZip>string</PayeeZip>
          <PayeeCountry>string</PayeeCountry>
          <CheckNumber>string</CheckNumber>
          <CheckDate>dateTime</CheckDate>
          <ClearedDate>dateTime</ClearedDate>
          <VoidedDate>dateTime</VoidedDate>
          <DeductionType>int</DeductionType>
          <DeductionNotes>string</DeductionNotes>
          <IsTaxable>boolean</IsTaxable>
          <PeriodID>int</PeriodID>
          <Reference>string</Reference>
          <TransactionDate>dateTime</TransactionDate>
          <ModifiedDate>dateTime</ModifiedDate>
          <CreatedBy>string</CreatedBy>
          <ModifiedBy>string</ModifiedBy>
          <PayeeCompany>string</PayeeCompany>
          <DepositNumber>string</DepositNumber>
          <Other1>string</Other1>
          <Other2>string</Other2>
          <Other3>string</Other3>
          <Other4>string</Other4>
        </BillPayment>
      </BillPayments>
    </GetBillPaymentsResult>
  </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 GetBillPaymentsRequest();

 

 

    //Add PaymentIDs

    var paymentids = new List<Int32>();

    paymentids.Add(1);

    paymentids.Add(2);

 

    //Now attach the list to the request

    req.PaymentIDs = paymentids.ToArray();

    req.StartPaymentID = 1;

    req.EndPaymentID = 1;

 

    //Send Request to Server and Get Response

    var res = await api.GetBillPaymentsAsync(req);

 

    //Now examine the results:

 

    foreach (var billPayment in res.BillPayments)

    {

        Console.WriteLine("PaymentID: {0}", billPayment.PaymentID);

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

        Console.WriteLine("PaymentType: {0}", billPayment.PaymentType);

        Console.WriteLine("PaymentDate: {0}", billPayment.PaymentDate);

        Console.WriteLine("Amount: {0}", billPayment.Amount);

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

        Console.WriteLine("PayeeName: {0}", billPayment.PayeeName);

        Console.WriteLine("PayeeAddress1: {0}", billPayment.PayeeAddress1);

        Console.WriteLine("PayeeAddress2: {0}", billPayment.PayeeAddress2);

        Console.WriteLine("PayeeCity: {0}", billPayment.PayeeCity);

        Console.WriteLine("PayeeState: {0}", billPayment.PayeeState);

        Console.WriteLine("PayeeZip: {0}", billPayment.PayeeZip);

        Console.WriteLine("PayeeCountry: {0}", billPayment.PayeeCountry);

        Console.WriteLine("CheckNumber: {0}", billPayment.CheckNumber);

        Console.WriteLine("CheckDate: {0}", billPayment.CheckDate);

        Console.WriteLine("ClearedDate: {0}", billPayment.ClearedDate);

        Console.WriteLine("VoidedDate: {0}", billPayment.VoidedDate);

        Console.WriteLine("DeductionNotes: {0}", billPayment.DeductionNotes);

        Console.WriteLine("IsTaxable: {0}", billPayment.IsTaxable);

        Console.WriteLine("PeriodID: {0}", billPayment.PeriodID);

        Console.WriteLine("Reference: {0}", billPayment.Reference);

        Console.WriteLine("TransactionDate: {0}", billPayment.TransactionDate);

        Console.WriteLine("ModifiedDate: {0}", billPayment.ModifiedDate);

        Console.WriteLine("CreatedBy: {0}", billPayment.CreatedBy);

        Console.WriteLine("ModifiedBy: {0}", billPayment.ModifiedBy);

        Console.WriteLine("PayeeCompany: {0}", billPayment.PayeeCompany);

        Console.WriteLine("DepositNumber: {0}", billPayment.DepositNumber);

    }

}

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

    GetBillPaymentsRequest req = new GetBillPaymentsRequest();

 

 

    //Add PaymentIDs

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

    paymentids.Add(1);

    paymentids.Add(2);

 

    //Now attach the list to the request

    req.PaymentIDs = paymentids.ToArray();

    req.StartPaymentID = 1;

    req.EndPaymentID = 1;

 

    //Send Request to Server and Get Response

    GetBillPaymentsResponse res = api.GetBillPayments(req);

 

    //Now examine the results:

 

    foreach (BillPayment billPayment in res.BillPayments)

    {

        Console.WriteLine("PaymentID: {0}", billPayment.PaymentID);

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

        Console.WriteLine("PaymentType: {0}", billPayment.PaymentType);

        Console.WriteLine("PaymentDate: {0}", billPayment.PaymentDate);

        Console.WriteLine("Amount: {0}", billPayment.Amount);

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

        Console.WriteLine("PayeeName: {0}", billPayment.PayeeName);

        Console.WriteLine("PayeeAddress1: {0}", billPayment.PayeeAddress1);

        Console.WriteLine("PayeeAddress2: {0}", billPayment.PayeeAddress2);

        Console.WriteLine("PayeeCity: {0}", billPayment.PayeeCity);

        Console.WriteLine("PayeeState: {0}", billPayment.PayeeState);

        Console.WriteLine("PayeeZip: {0}", billPayment.PayeeZip);

        Console.WriteLine("PayeeCountry: {0}", billPayment.PayeeCountry);

        Console.WriteLine("CheckNumber: {0}", billPayment.CheckNumber);

        Console.WriteLine("CheckDate: {0}", billPayment.CheckDate);

        Console.WriteLine("ClearedDate: {0}", billPayment.ClearedDate);

        Console.WriteLine("VoidedDate: {0}", billPayment.VoidedDate);

        Console.WriteLine("DeductionNotes: {0}", billPayment.DeductionNotes);

        Console.WriteLine("IsTaxable: {0}", billPayment.IsTaxable);

        Console.WriteLine("PeriodID: {0}", billPayment.PeriodID);

        Console.WriteLine("Reference: {0}", billPayment.Reference);

        Console.WriteLine("TransactionDate: {0}", billPayment.TransactionDate);

        Console.WriteLine("ModifiedDate: {0}", billPayment.ModifiedDate);

        Console.WriteLine("CreatedBy: {0}", billPayment.CreatedBy);

        Console.WriteLine("ModifiedBy: {0}", billPayment.ModifiedBy);

        Console.WriteLine("PayeeCompany: {0}", billPayment.PayeeCompany);

        Console.WriteLine("DepositNumber: {0}", billPayment.DepositNumber);

    }

}

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

 

 

    'Add PaymentIDs

    Dim paymentids As New List(Of Int32)()

    paymentids.Add(1)

    paymentids.Add(2)

 

    'Now attach the list to the request

    req.PaymentIDs = paymentids.ToArray()

    req.StartPaymentID = 1

    req.EndPaymentID = 1

 

    'Send Request to Server and Get Response

    Dim res As GetBillPaymentsResponse = api.GetBillPayments(req)

 

    'Now examine the results:

 

    For Each billPayment As BillPayment In res.BillPayments

        Console.WriteLine("PaymentID: {0}", billPayment.PaymentID)

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

        Console.WriteLine("PaymentType: {0}", billPayment.PaymentType)

        Console.WriteLine("PaymentDate: {0}", billPayment.PaymentDate)

        Console.WriteLine("Amount: {0}", billPayment.Amount)

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

        Console.WriteLine("PayeeName: {0}", billPayment.PayeeName)

        Console.WriteLine("PayeeAddress1: {0}", billPayment.PayeeAddress1)

        Console.WriteLine("PayeeAddress2: {0}", billPayment.PayeeAddress2)

        Console.WriteLine("PayeeCity: {0}", billPayment.PayeeCity)

        Console.WriteLine("PayeeState: {0}", billPayment.PayeeState)

        Console.WriteLine("PayeeZip: {0}", billPayment.PayeeZip)

        Console.WriteLine("PayeeCountry: {0}", billPayment.PayeeCountry)

        Console.WriteLine("CheckNumber: {0}", billPayment.CheckNumber)

        Console.WriteLine("CheckDate: {0}", billPayment.CheckDate)

        Console.WriteLine("ClearedDate: {0}", billPayment.ClearedDate)

        Console.WriteLine("VoidedDate: {0}", billPayment.VoidedDate)

        Console.WriteLine("DeductionNotes: {0}", billPayment.DeductionNotes)

        Console.WriteLine("IsTaxable: {0}", billPayment.IsTaxable)

        Console.WriteLine("PeriodID: {0}", billPayment.PeriodID)

        Console.WriteLine("Reference: {0}", billPayment.Reference)

        Console.WriteLine("TransactionDate: {0}", billPayment.TransactionDate)

        Console.WriteLine("ModifiedDate: {0}", billPayment.ModifiedDate)

        Console.WriteLine("CreatedBy: {0}", billPayment.CreatedBy)

        Console.WriteLine("ModifiedBy: {0}", billPayment.ModifiedBy)

        Console.WriteLine("PayeeCompany: {0}", billPayment.PayeeCompany)

        Console.WriteLine("DepositNumber: {0}", billPayment.DepositNumber)

    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

 

 

    //Add PaymentIDs

 

 

 

    //Now attach the list to the request

    req.PaymentIDs = array(paymentID1,paymentID2);

    $req->StartPaymentID = 1;

    $req->EndPaymentID = 1;

 

    //Send Request to Server and Get Response

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

    GetBillPaymentsRequest req = new GetBillPaymentsRequest();

 

 

    //Add PaymentIDs

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

 

    Int32 paymentID1 = new Int32();

    paymentids.Add(paymentID1);

 

    Int32 paymentID2 = new Int32();

    paymentids.Add(paymentID2);

 

    //Now attach the list to the request

    req.setPaymentIDs(paymentids);

    req.setStartPaymentID(1);

    req.setEndPaymentID(1);

 

    //Send Request to Server and Get Response

    GetBillPaymentsResponse res = api.getExigoApiSoap().getBillPayments(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.