Billcom v0.1.0 Billcom View Source
Simple api library to connect to bill.com api
config your bill.com connection:
config :billcom, :api, %{ devKey: "myDevKey", orgId: "myOrgId", password: "myPassword", userName: "myUsername", prod: true #optional: to request of bill.com production servers }
Then use
... conn = Billcom.login Billcom.list_orgs(conn) ...
Link to this section Summary
Functions
Approve for bill.com api
CancelInvite for bill.com api
CancelAPPayment for bill.com api
ChargeCustomer for bill.com api
ClearApprovers for bill.com api
ConnectLargeBillerAsVendor for bill.com api
Deny for bill.com api
DisconnectCustomerFromNetwork for bill.com api
DisconnectVendorFromNetwork for bill.com api
MFAAuthenticate for bill.com api
MFAChallenge for bill.com api
MFAStatus for bill.com api
get_api_url get object value api_url
GetBankBalance for bill.com api
GetCheckImageData for bill.com api
get_dev_key get object value dev_key
GetDisbursementData for bill.com api
GetDocumentPages for bill.com api
GetEntityMetadata for bill.com api
GetLargeBillerPaymentAddress for bill.com api
GetNetworkStatus for bill.com api
GetObjectUrl for bill.com api
get_org_id get object value org_id
get_password get object value password
GetProfilePermissions for bill.com api
get_session_id get object value session_id
get_user_name get object value user_name
Return the value of a key in the result collections
GetAPSummary for bill.com api
GetARSummary for bill.com api
Check for the presence of a key in the result collections
LargeBillerSearch for bill.com api
ListApprovers for bill.com api
ListMessage for bill.com api
Return the list of organisation associated with your account
ListPayments for bill.com api
ListUserApprovals for bill.com api
Login to bill.com api
logout from Bill.com api
MailInvoice for bill.com api
NetworkSearch for bill.com api
RecordAPPayment for bill.com api
RecordARPayment for bill.com api
SearchEntity for bill.com api
SendInvite for bill.com api
SendInvoice for bill.com api
SendMessage for bill.com api
SendVendorInvite for bill.com api
set_api_url set object "api_url" value
SetApprovers for bill.com api
SetBankBalance for bill.com api
SetCustomerAuthorization for bill.com api
set_dev_key set object "dev_key" value
set_org_id set object "org_id" value
set_password set object "password" value
set_session_id set object "session_id" value
set_user_name set object "user_name" value
UploadAttachment for bill.com api
VoidAPPayment for bill.com api
Link to this section Types
Specs
Link to this section Functions
Specs
Approve for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
CancelInvite for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
CancelAPPayment for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
ChargeCustomer for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
ClearApprovers for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
ConnectLargeBillerAsVendor for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
Deny for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
DisconnectCustomerFromNetwork for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
DisconnectVendorFromNetwork for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
MFAAuthenticate for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
MFAChallenge for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
MFAStatus for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
get_api_url get object value api_url
Parameters:
conn - actual connexion structure
return:
api_url value
Specs
GetBankBalance for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
GetCheckImageData for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
get_dev_key get object value dev_key
Parameters:
conn - actual connexion structure
return:
dev_key value
Specs
GetDisbursementData for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
GetDocumentPages for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
GetEntityMetadata for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
GetLargeBillerPaymentAddress for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
GetNetworkStatus for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
GetObjectUrl for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
get_org_id get object value org_id
Parameters:
conn - actual connexion structure
return:
org_id value
Specs
get_password get object value password
Parameters:
conn - actual connexion structure
return:
password value
Specs
GetProfilePermissions for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
get_session_id get object value session_id
Parameters:
conn - actual connexion structure
return:
session_id value
Specs
get_user_name get object value user_name
Parameters:
conn - actual connexion structure
return:
user_name value
Specs
Return the value of a key in the result collections
Parameters:
result - result collection of a api call key - the key from which to return a value
return:
success - value failure - unkown behavior see has_key?
Specs
GetAPSummary for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
GetARSummary for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
Check for the presence of a key in the result collections
Parameters:
result - result of a api call key - the key you are looking for
return:
success - true failure - false
Specs
LargeBillerSearch for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
ListApprovers for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
ListMessage for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
Return the list of organisation associated with your account
Parameters:
conn - see login
return:
success - {:ok, val} from where you can fetch organisation list (example: val |> Map.fetch!("response_data")) failure - {:error, val} where date are failure reasons
Specs
ListPayments for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
ListUserApprovals for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
login!() :: conn()
Login to bill.com api
Parameters:
none - the module load it's configuration from config file
return:
success - {:ok, conn} where conn is an updated version of the conn passed in parameters with sessionId and usersId failure - raise error
Specs
logout from Bill.com api
Parameters:
conn - see login
return:
success - {:ok, val} where data are logout data failure - {:error, val} where date are failure reasons
Specs
MailInvoice for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
NetworkSearch for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
RecordAPPayment for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
RecordARPayment for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
SearchEntity for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
SendInvite for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
SendInvoice for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
SendMessage for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
SendVendorInvite for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
set_api_url set object "api_url" value
Parameters:
conn - actual connexion structure val - value of the object
return:
new conn strucutre with api_url set to val
Specs
SetApprovers for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
SetBankBalance for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
SetCustomerAuthorization for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
set_dev_key set object "dev_key" value
Parameters:
conn - actual connexion structure val - value of the object
return:
new conn strucutre with dev_key set to val
Specs
set_org_id set object "org_id" value
Parameters:
conn - actual connexion structure val - value of the object
return:
new conn strucutre with org_id set to val
Specs
set_password set object "password" value
Parameters:
conn - actual connexion structure val - value of the object
return:
new conn strucutre with password set to val
Specs
set_session_id set object "session_id" value
Parameters:
conn - actual connexion structure val - value of the object
return:
new conn strucutre with session_id set to val
Specs
set_user_name set object "user_name" value
Parameters:
conn - actual connexion structure val - value of the object
return:
new conn strucutre with user_name set to val
Specs
UploadAttachment for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}
Specs
VoidAPPayment for bill.com api
Parameters:
conn - a connection structure (see Billcom.login/0) data - data object to send for the object
return:
success - {:ok, val} fail - {:error, val}