Exigo Web Services API v2022.12.19.1

CreateBill

Creates a new bill

Input Properties

CreateBillRequest
PropertyData TypeNotes
CustomerIDInt32Unique numeric identifier for customer record.
CurrencyCode StringOptional.
IsOtherIncomeBoolean
DueDateDateTime
AmountDecimal
ReferenceStringOptional.
NotesStringOptional.
BillStatusTypeIDInt32Optional. Bill Status (default is Unpaid).
PayableTypeIDOverrideInt32Optional. Optionally override the payable type of the bill.
CustomerKeyStringOptional. Unique alpha numeric identifier for customer record. Exeption will occur if CustomerID & CustomerKey are provided.
TaxablePeriodTy Int32Optional.
TaxablePeriodID Int32Optional.

Output Properties

CreateBillResponse
PropertyData TypeNotes
BillIDInt32

Http Request

POST https://yourcompany-api.exigo.com/3.0/bill HTTP/1.1
Content-Type: application/json
Authorization: Basic base64Encoded(yourlogin@yourcompany:yourpassword)

{ "customerID": 1, "currencyCode": "usd", "isOtherIncome": true, "dueDate": "2024-11-04T00:00:00-06:00", "amount": null, "reference": "", "notes": "", "billStatusTypeID": 1, "payableTypeIDOverride": 1, "customerKey": "1", "taxablePeriodTy": 1, "taxablePeriodID": 1 }

Http Response

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

{ "billID": 1, "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/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> <CustomerKey>string</CustomerKey> <TaxablePeriodTy>int</TaxablePeriodTy> <TaxablePeriodID>int</TaxablePeriodID> </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# Rest Client

Install Nuget package Exigo.Api.Client

try

{

    //Create Api Client

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

 

    //Create Request

    var req = new CreateBillRequest();

 

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

    req.CurrencyCode = "usd";

    req.IsOtherIncome = true;

    req.DueDate = DateTime.Today;

    req.Amount = 1;

    req.Reference = "1";

    req.Notes = "1";

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

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

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

    req.TaxablePeriodTy = 1;

    req.TaxablePeriodID = 1;

 

    //Send Request to Server and Get Response

    var res = await api.CreateBillAsync(req);

 

    //Now examine the results:

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

}

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

    CreateBillRequest req = new CreateBillRequest();

 

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

    req.CurrencyCode = "usd";

    req.IsOtherIncome = true;

    req.DueDate = DateTime.Today;

    req.Amount = 1;

    req.Reference = "1";

    req.Notes = "1";

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

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

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

    req.TaxablePeriodTy = 1;

    req.TaxablePeriodID = 1;

 

    //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

    req.CustomerKey = "1"

    req.TaxablePeriodTy = 1

    req.TaxablePeriodID = 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;

    $req->CustomerKey = "1";

    $req->TaxablePeriodTy = 1;

    $req->TaxablePeriodID = 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);

    req.setCustomerKey("1");

    req.setTaxablePeriodTy(1);

    req.setTaxablePeriodID(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.