ExQuickBooks v0.6.0 ExQuickBooks.API.Item

Functions for interacting with the Item API.

This module directly implements operations from the official API: https://developer.intuit.com/v2/docs/api/accounting/item

Summary

Functions

Creates an item

Retrieves an item

Updates and retrieves an item

Types

json_map()
json_map() :: %{required(String.t) => any}

Functions

create_item(token, item)
create_item(ExQuickBooks.OAuth.AccessToken.t, json_map) ::
  {:ok, json_map} |
  {:error, any}

Creates an item.

The item name must be unique. Sales items must define IncomeAccountRef. Purchase items must define ExpenseAccountRef.

read_item(token, item_id)
read_item(ExQuickBooks.OAuth.AccessToken.t, String.t) ::
  {:ok, json_map} |
  {:error, any}

Retrieves an item.

update_item(token, item)
update_item(ExQuickBooks.OAuth.AccessToken.t, json_map) ::
  {:ok, json_map} |
  {:error, any}

Updates and retrieves an item.

The item map must define all of the keys in the full item map returned by read_item/2, otherwise the omitted values are set to their default values or NULL.