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

conn() :: %{
  dev_key: String.t(),
  org_id: String.t(),
  password: String.t(),
  user_name: String.t(),
  session_id: String.t(),
  api_url: String.t(),
  conn_url: String.t()
}

Link to this section Functions

Link to this function

approve(connection, data)

View Source

Specs

approve(map(), map()) :: any()

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}

Link to this function

cancel_invite(connection, data)

View Source

Specs

cancel_invite(map(), map()) :: any()

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}

Link to this function

cancelap_payment(connection, data)

View Source

Specs

cancelap_payment(map(), map()) :: any()

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}

Link to this function

charge_customer(connection, data)

View Source

Specs

charge_customer(map(), map()) :: any()

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}

Link to this function

clear_approvers(connection, data)

View Source

Specs

clear_approvers(map(), map()) :: any()

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}

Link to this function

connect_large_biller_as_vendor(connection, data)

View Source

Specs

connect_large_biller_as_vendor(map(), map()) :: any()

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(map(), map()) :: any()

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}

Link to this function

disconnect_customer_from_network(connection, data)

View Source

Specs

disconnect_customer_from_network(map(), map()) :: any()

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}

Link to this function

disconnect_vendor_from_network(connection, data)

View Source

Specs

disconnect_vendor_from_network(map(), map()) :: any()

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}

Link to this function

fa_authenticate(connection, data)

View Source

Specs

fa_authenticate(map(), map()) :: any()

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}

Link to this function

fa_challenge(connection, data)

View Source

Specs

fa_challenge(map(), map()) :: any()

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}

Link to this function

fa_status(connection, data)

View Source

Specs

fa_status(map(), map()) :: any()

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(conn()) :: String.t()

get_api_url get object value api_url

Parameters:

conn - actual connexion structure

return:

api_url value

Link to this function

get_bank_balance(connection, data)

View Source

Specs

get_bank_balance(map(), map()) :: any()

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}

Link to this function

get_check_image_data(connection, data)

View Source

Specs

get_check_image_data(map(), map()) :: any()

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(conn()) :: String.t()

get_dev_key get object value dev_key

Parameters:

conn - actual connexion structure

return:

dev_key value

Link to this function

get_disbursement_data(connection, data)

View Source

Specs

get_disbursement_data(map(), map()) :: any()

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}

Link to this function

get_document_pages(connection, data)

View Source

Specs

get_document_pages(map(), map()) :: any()

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}

Link to this function

get_entity_metadata(connection, data)

View Source

Specs

get_entity_metadata(map(), map()) :: any()

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}

Link to this function

get_large_biller_payment_address(connection, data)

View Source

Specs

get_large_biller_payment_address(map(), map()) :: any()

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}

Link to this function

get_network_status(connection, data)

View Source

Specs

get_network_status(map(), map()) :: any()

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}

Link to this function

get_object_url(connection, data)

View Source

Specs

get_object_url(map(), map()) :: any()

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(conn()) :: String.t()

get_org_id get object value org_id

Parameters:

conn - actual connexion structure

return:

org_id value

Specs

get_password(conn()) :: String.t()

get_password get object value password

Parameters:

conn - actual connexion structure

return:

password value

Link to this function

get_profile_permissions(connection, data)

View Source

Specs

get_profile_permissions(map(), map()) :: any()

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(conn()) :: String.t()

get_session_id get object value session_id

Parameters:

conn - actual connexion structure

return:

session_id value

Specs

get_user_name(conn()) :: String.t()

get_user_name get object value user_name

Parameters:

conn - actual connexion structure

return:

user_name value

Specs

get_val(map(), String.t()) :: atom()

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?

Link to this function

getap_summary(connection, data)

View Source

Specs

getap_summary(map(), map()) :: any()

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}

Link to this function

getar_summary(connection, data)

View Source

Specs

getar_summary(map(), map()) :: any()

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

has_key?(map(), String.t()) :: atom()

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

Link to this function

large_biller_search(connection, data)

View Source

Specs

large_biller_search(map(), map()) :: any()

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}

Link to this function

list_approvers(connection, data)

View Source

Specs

list_approvers(map(), map()) :: any()

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}

Link to this function

list_message(connection, data)

View Source

Specs

list_message(map(), map()) :: any()

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

list_orgs(conn()) :: {atom(), map()}

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

Link to this function

list_payments(connection, data)

View Source

Specs

list_payments(map(), map()) :: any()

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}

Link to this function

list_user_approvals(connection, data)

View Source

Specs

list_user_approvals(map(), map()) :: any()

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(conn()) :: {atom(), map()}

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

Link to this function

mail_invoice(connection, data)

View Source

Specs

mail_invoice(map(), map()) :: any()

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}

Link to this function

network_search(connection, data)

View Source

Specs

network_search(map(), map()) :: any()

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}

Link to this function

recordap_payment(connection, data)

View Source

Specs

recordap_payment(map(), map()) :: any()

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}

Link to this function

recordar_payment(connection, data)

View Source

Specs

recordar_payment(map(), map()) :: any()

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}

Link to this function

search_entity(connection, data)

View Source

Specs

search_entity(map(), map()) :: any()

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}

Link to this function

send_invite(connection, data)

View Source

Specs

send_invite(map(), map()) :: any()

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}

Link to this function

send_invoice(connection, data)

View Source

Specs

send_invoice(map(), map()) :: any()

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}

Link to this function

send_message(connection, data)

View Source

Specs

send_message(map(), map()) :: any()

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}

Link to this function

send_vendor_invite(connection, data)

View Source

Specs

send_vendor_invite(map(), map()) :: any()

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(conn(), String.t()) :: String.t()

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

Link to this function

set_approvers(connection, data)

View Source

Specs

set_approvers(map(), map()) :: any()

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}

Link to this function

set_bank_balance(connection, data)

View Source

Specs

set_bank_balance(map(), map()) :: any()

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}

Link to this function

set_customer_authorization(connection, data)

View Source

Specs

set_customer_authorization(map(), map()) :: any()

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(conn(), String.t()) :: String.t()

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(conn(), String.t()) :: String.t()

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(conn(), String.t()) :: String.t()

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

Link to this function

set_session_id(conn, val)

View Source

Specs

set_session_id(conn(), String.t()) :: String.t()

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

Link to this function

set_user_name(conn, val)

View Source

Specs

set_user_name(conn(), String.t()) :: String.t()

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

Link to this function

update_map(map, key, val)

View Source
Link to this function

upload_attachment(connection, data)

View Source

Specs

upload_attachment(map(), map()) :: any()

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}

Link to this function

voidap_payment(connection, data)

View Source

Specs

voidap_payment(map(), map()) :: any()

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}