Codat.Platform.CustomData (codat v1.0.0)

Copy Markdown View Source

Read custom data pulled from integrations via supplemental data configuration.

After configuring supplemental data via Codat.Platform.SupplementalData, you can read the custom fields using the standard list/get endpoints — they will appear in the supplementalData.content map on each record.

This module also provides access to raw custom data endpoints for integrations that support them (e.g. reading raw QuickBooks objects by their native type).

Example

# Read invoices — supplementalData is included automatically
{:ok, page} = Codat.Accounting.Invoices.list(client, company_id)

invoice = hd(page.results)
invoice["supplementalData"]["content"]["PONumber"]  # => "PO-4521"

Summary

Functions

get(client_or_company_id, company_or_data_type, data_type_or_id, id_or_opts \\ [])

Returns a single custom data record by ID.

list(client_or_company_id, company_or_data_type, data_type_or_opts \\ [], opts \\ [])

Returns a paginated list of custom data records for a company and data type.

Functions

get(client_or_company_id, company_or_data_type, data_type_or_id, id_or_opts \\ [])

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

Returns a single custom data record by ID.

Example

{:ok, record} = Codat.Platform.CustomData.get(client, company_id, "CustomTransaction", "record-id")

list(client_or_company_id, company_or_data_type, data_type_or_opts \\ [], opts \\ [])

@spec list(
  Codat.Client.t() | String.t(),
  String.t(),
  String.t() | keyword(),
  keyword()
) ::
  {:ok, Codat.Pagination.t()} | {:error, Codat.Error.t()}

Returns a paginated list of custom data records for a company and data type.

This reads from the raw integration data pulled by Codat (not normalized).

Example

{:ok, page} = Codat.Platform.CustomData.list(client, company_id, "CustomTransaction")