net.nextpulse.jacumulus

Class AcumulusClient

java.lang.Object

net.nextpulse.jacumulus.AcumulusClient

public class AcumulusClient
extends Object

Main class of the Acumulus API client. Instantiate the object with your credentials and call the appropriate methods.

Constructor Summary

Constructors

Constructor and Description
AcumulusClient(Contract contract) Constructor for the Acumulus API client, initialized with your API credentials.

Method Summary

Modifier and Type	Method and Description
AddExpenseResponse	addExpense(Supplier supplier) Adds a Supplier if no supplier was found using the provided supplierId or suppliers email address and adds an invoice for this supplier.
InvoiceResponse	addInvoice(Customer customer) Adds a Customer if no customer was found using the provided customerId or customer's email address and adds an invoice for this customer.
ListContactsResponse	listContacts() Overloaded listContacts method that will return the first 100 contacts.
ListContactsResponse	listContacts(Integer count, Integer offset, String filter, ContactStatus status, ContactType contactType) Full featured listContacts method that allows you to search for or paginate through the contacts using the API.
ListInvoicesResponse	listIncomingInvoices(String contactId) Lists the incoming invoices for the specified contactId.
ListInvoicesResponse	listOutgoingInvoices(String contactId) Lists the outgoing invoices for the specified contactId.
protected String	serializeRequest(AcumulusRequest xmlRequest) Serializes the provided request to XML.
void	setApiUrl(String apiUrl) Changes the API url prefix to use for all API calls
void	setTestMode(boolean testMode) Set the client to test mode, ensuring no actions will result in actual updates of the data.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AcumulusClient

public AcumulusClient(Contract contract)

Constructor for the Acumulus API client, initialized with your API credentials.

Parameters:

contract - credentials to use when contacting the Acumulus API

Method Detail

addInvoice

public InvoiceResponse addInvoice(Customer customer)
                           throws JAXBException,
                                  IOException

Adds a Customer if no customer was found using the provided customerId or customer's email address and adds an invoice for this customer.

Parameters:

customer - customer with embedded invoice to add to the system

Returns:

InvoiceResponse from the server, containing zero or more errors and warnings

Throws:

JAXBException - if the serialization failed for some reason

IOException - if there was an error contacting the Acumulus servers

addExpense

public AddExpenseResponse addExpense(Supplier supplier)
                              throws JAXBException,
                                     IOException

Adds a Supplier if no supplier was found using the provided supplierId or suppliers email address and adds an invoice for this supplier.

Parameters:

supplier - supplier with embedded expense to add to the system

Returns:

response from the server, containing zero or more errors and warnings

Throws:

JAXBException - if the serialization failed for some reason

IOException - if there was an error contacting the Acumulus servers

listIncomingInvoices

public ListInvoicesResponse listIncomingInvoices(String contactId)
                                          throws JAXBException,
                                                 IOException

Lists the incoming invoices for the specified contactId.

Parameters:

contactId - contact to list the invoices for

Returns:

ListInvoicesResponse

Throws:

JAXBException - if the serialization failed for some reason

IOException - if there was an error contacting the Acumulus servers

listOutgoingInvoices

public ListInvoicesResponse listOutgoingInvoices(String contactId)
                                          throws JAXBException,
                                                 IOException

Lists the outgoing invoices for the specified contactId.

Parameters:

contactId - contact to list the invoices for

Returns:

ListInvoicesResponse

Throws:

JAXBException - if the serialization failed for some reason

IOException - if there was an error contacting the Acumulus servers

listContacts

public ListContactsResponse listContacts()
                                  throws JAXBException,
                                         IOException

Overloaded listContacts method that will return the first 100 contacts.

Returns:

list of contacts

Throws:

JAXBException - if the serialization failed for some reason

IOException - if there was an error contacting the Acumulus servers

listContacts

public ListContactsResponse listContacts(Integer count,
                                         Integer offset,
                                         String filter,
                                         ContactStatus status,
                                         ContactType contactType)
                                  throws JAXBException,
                                         IOException

Full featured listContacts method that allows you to search for or paginate through the contacts using the API.

Parameters:

count - number of contacts to return, 0 for all

offset - number of contacts to skip from the beginning of the list

filter - optional string to search through contact names, addresses and postal codes

status - contact status to return

contactType - type of contact to return, null for all

Returns:

list of contacts

Throws:

JAXBException - if the serialization failed for some reason

IOException - if there was an error contacting the Acumulus servers

serializeRequest

protected String serializeRequest(AcumulusRequest xmlRequest)
                           throws JAXBException

Serializes the provided request to XML.

Parameters:

xmlRequest - object to serialize

Returns:

XNK string

Throws:

JAXBException - if the serialization failed for any reason

setTestMode

public void setTestMode(boolean testMode)

Set the client to test mode, ensuring no actions will result in actual updates of the data.

Parameters:

testMode - set to true to enable test mode, false to disable

setApiUrl

public void setApiUrl(String apiUrl)

Changes the API url prefix to use for all API calls

Parameters:

apiUrl - new url to set, including https:// and trailing slash.