ExQuickbooks.Customers (ex_quickbooks v0.9.0)

Copy Markdown View Source

Customer resource helpers for QuickBooks.

Summary

Functions

Fetches a customer by ID.

Lists customers, optionally filtered with a WHERE clause and query pagination.

Functions

create(client, attributes, options \\ [])

@spec create(ExQuickbooks.Client.t(), map(), keyword()) ::
  {:ok, map()} | {:error, ExQuickbooks.Error.t()}

Creates a customer.

get(client, id, options \\ [])

@spec get(ExQuickbooks.Client.t(), String.t() | integer(), keyword()) ::
  {:ok, map()} | {:error, ExQuickbooks.Error.t()}

Fetches a customer by ID.

list(client, options \\ [])

@spec list(
  ExQuickbooks.Client.t(),
  keyword()
) :: {:ok, [map()]} | {:error, ExQuickbooks.Error.t()}

Lists customers, optionally filtered with a WHERE clause and query pagination.

update(client, attributes, options \\ [])

@spec update(ExQuickbooks.Client.t(), map(), keyword()) ::
  {:ok, map()} | {:error, ExQuickbooks.Error.t()}

Updates a customer.