Exigo Web Services API v3.4.272

CreateBill

Creates a new bill

Input Properties

CreateBillRequest
PropertyData TypeNotes
CustomerIDInt32Unique identifier for a customer entity.
CurrencyCode StringOptional.
IsOtherIncomeBoolean
DueDateDateTime
AmountDecimal
ReferenceStringOptional.
NotesStringOptional.
BillStatusTypeIDInt32Optional. Optional Bill Status (default is Unpaid).
PayableTypeIDOverrideInt32Optional. Optionally override the payable type of the bill.

Output Properties

CreateBillResponse
PropertyData TypeNotes
BillIDInt32

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: "http://api.exigo.com/CreateBill"

<?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> <CreateBillRequest xmlns="http://api.exigo.com/"> <CustomerID>int</CustomerID> <CurrencyCode>string</CurrencyCode> <IsOtherIncome>boolean</IsOtherIncome> <DueDate>dateTime</DueDate> <Amount>decimal</Amount> <Reference>string</Reference> <Notes>string</Notes> <BillStatusTypeID>int</BillStatusTypeID> <PayableTypeIDOverride>int</PayableTypeIDOverride> </CreateBillRequest> </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> <CreateBillResult xmlns="http://api.exigo.com/"> <BillID>int</BillID> </CreateBillResult> </soap:Body> </soap:Envelope>

C#

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

    CreateBillRequest req = new CreateBillRequest();

 

    req.CustomerID = 1;             //Unique identifier for a customer entity.

    req.CurrencyCode = "usd";

    req.IsOtherIncome = true;

    req.DueDate = DateTime.Today;

    req.Amount = 1;

    req.Reference = "1";

    req.Notes = "1";

    req.BillStatusTypeID = 1;       //Optional Bill Status (default is Unpaid)

    req.PayableTypeIDOverride = 1;  //Optionally override the payable type of the bill

 

    //Send Request to Server and Get Response

    CreateBillResponse res = api.CreateBill(req);

 

    //Now examine the results:

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

}

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

 

    req.CustomerID = 1

    req.CurrencyCode = "usd"

    req.IsOtherIncome = true

    req.DueDate = DateTime.Today

    req.Amount = 1

    req.Reference = "1"

    req.Notes = "1"

    req.BillStatusTypeID = 1

    req.PayableTypeIDOverride = 1

 

    'Send Request to Server and Get Response

    Dim res As CreateBillResponse = api.CreateBill(req)

 

    'Now examine the results:

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

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->CurrencyCode = "usd";

    $req->IsOtherIncome = 1;

    $req->DueDate = 1;

    $req->Amount = 1;

    $req->Reference = "1";

    $req->Notes = "1";

    $req->BillStatusTypeID = 1;

    $req->PayableTypeIDOverride = 1;

 

    //Send Request to Server and Get Response

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

    CreateBillRequest req = new CreateBillRequest();

 

    req.setCustomerID(1);

    req.setCurrencyCode("usd");

    req.setIsOtherIncome(1);

    req.setDueDate(1);

    req.setAmount(1);

    req.setReference("1");

    req.setNotes("1");

    req.setBillStatusTypeID(1);

    req.setPayableTypeIDOverride(1);

 

    //Send Request to Server and Get Response

    CreateBillResponse res = api.getExigoApiSoap().createBill(req, auth);

 

    //Now examine the results:

}

catch (Exception ex)

{

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

}

CSV

This method does not support csv output.