ExQuickBooks v0.6.0 ExQuickBooks.API.Preferences

Functions for interacting with the Preferences API.

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

Summary

Functions

Retrieves preferences for the realm

Updates and retrieves preferences for the realm

Types

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

Functions

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

Retrieves preferences for the realm.

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

Updates and retrieves preferences for the realm.

This operation performs a full update. The preferences map must define all of the keys in the full preferences map returned by read_preferences/1, otherwise the omitted values are set to their default values or NULL.