Billcom v0.1.1 Billcom.Vendor View Source

Link to this section Summary

Link to this section Functions

Link to this function

create(connection, data)

View Source

Specs

create(map(), map()) :: {atom(), map()}

Billcom.Vendor.create/2 for bill.com api

Parameters:

  • conn: a connection strucure (see Billcom.login!/0)
  • data: data object to send for the object

return:

success:

{:ok, data}

Returned data from create for Vendor

failure:

{:error, val}

Where val hold information about failure reason.

Link to this function

delete(connection, data)

View Source

Specs

delete(map(), map()) :: {atom(), map()}

Billcom.Vendor.delete/2 for bill.com api

Parameters:

  • conn: a connection strucure (see Billcom.login!/0)
  • data: data object to send for the object

return:

success:

{:ok, data}

Returned data from delete for Vendor

failure:

{:error, val}

Where val hold information about failure reason.

Specs

list(map(), map()) :: {atom(), map()}

Billcom.Vendor.list/2 for bill.com api

Parameters:

  • conn: a connection strucure (see Billcom.login!/0)
  • data: data object to send for the object

return:

success:

{:ok, data}

Where data is a collection of Vendor object list

failure:

{:error, val}

Where val hold information about failure reason.

Specs

read(map(), map()) :: {atom(), map()}

Billcom.Vendor.read/2 for bill.com api

Parameters:

  • conn: a connection strucure (see Billcom.login!/0)
  • data: data object to send for the object

return:

success:

{:ok, data}

Returned data from read for Vendor

failure:

{:error, val}

Where val hold information about failure reason.

Link to this function

undelete(connection, data)

View Source

Specs

undelete(map(), map()) :: {atom(), map()}

Billcom.Vendor.undelete/2 for bill.com api

Parameters:

  • conn: a connection strucure (see Billcom.login!/0)
  • data: data object to send for the object

return:

success:

{:ok, data}

Returned data from undelete for Vendor

failure:

{:error, val}

Where val hold information about failure reason.

Link to this function

update(connection, data)

View Source

Specs

update(map(), map()) :: {atom(), map()}

Billcom.Vendor.update/2 for bill.com api

Parameters:

  • conn: a connection strucure (see Billcom.login!/0)
  • data: data object to send for the object

return:

success:

{:ok, data}

Returned data from update for Vendor

failure:

{:error, val}

Where val hold information about failure reason.