Gettings Started


BILLIVING API (Application Programming Interface)

The BILLIVING API is created for you to interact with our system programmatically. With just a few lines of code you're able to create & send invoices to your customers from any application (i.e. your online store, your CRM etc.).

Keep in mind, if you have any questions we're here to help.

Service URL

The BILLIVING API is an interface for accessing your BILLIVING account data using HTTP and XML through a single access point: https://www.BILLIVING.com/API/XMLRequest/

Please note the use of https:// in the URL above. All BILLIVING API communication is encrypted over HTTPS. We recommend establishing a test connection with the secure API entry point before sending sensitive data.

API Authentication Token

Access to the API is enabled via an Authentication Token. Your token is placed within your account (under API in the main menu).

The API Token is a unique string and has the following GUID pattern:
956B64CB-79A9-4235-B069-5CF732E06768.

Sample Request

  • Every request must contain at least one action (may contain multiple actions).
  • Every action must have its "type" and "method" attributes.
  • Type specifies the domain worked on (i.e. invoice, client etc.)
  • Method specifies the type of action taken on the domain (i.e.: create, delete etc.)


Successful Response

Action element will contain a status attribute with "success" as its value.
1 <?xml version="1.0" encoding="utf-8" ?> 2 3 <!--authentication token is placed in your account--> 4 <Request authtoken="YOUR-AUTHENTICATION-TOKEN" password="YOUR-PASSWORD"> 5 6 <Action type="invoice" method="delete" status="success"> 7 8 <!--Mandatory--> 9 <DocNumber>0000000001</DocNumber> 10 11 </Action> 12 13 </Request>


Unsuccessful Response

Action element will contain a status attribute with the error information.
1 <?xml version="1.0" encoding="utf-8" ?> 2 3 <!--authentication token is placed in your account--> 4 <Request authtoken="YOUR-AUTHENTICATION-TOKEN" password="YOUR-PASSWORD"> 5 6 <Action type="invoice" method="delete" status="invalid DocNumber"> 7 8 <!--Mandatory--> 9 <DocNumber>0000000001</DocNumber> 10 11 </Action> 12 13 </Request>


Custom Response

Response XML will always contain all input variables in addition to action-specific return variables. Your custom XML variables will also be returned if you choose to include any.

Formats

  • All XML should be UTF-8 encoded.
  • Booleans are either 1 (true) or 0 (false).
 

Overview



Client Methods


Invoice Methods


Estimate Methods


Purchase Order Methods


© 2014 BILLIVING.com. All rights reserved.