The Accounting resource: ERP connections, general ledger accounts, custom accounting dimensions ("fields") and their selectable options, and reporting sync status back to Ramp.
This is the largest resource in the API, so it's organized into five sections, each its own set of functions on this module:
- Connections -
get_all_connections/1,get_connection/2,disconnect_connection/1 - GL Accounts -
list_gl_accounts/2,get_gl_account/2,create_gl_accounts/2,update_gl_account/3,delete_gl_account/2 - Custom Fields -
list_fields/2,create_field/2,update_field/3,delete_field/2 - Field Options -
list_field_options/3,create_field_options/3,update_field_option/3,delete_field_option/2 - Sync -
post_sync_status/2,mark_ready_to_sync/2
Summary
Functions
Creates a new custom accounting dimension. input_type is typically
"SINGLE_CATEGORY_SELECT" or "MULTI_CATEGORY_SELECT" -- see the Ramp
API reference for the full set of supported field input types.
Creates one or more selectable options for field_id in a single batch request.
Creates one or more GL accounts in a single batch request.
Deletes a custom accounting field.
Deletes a field option.
Deletes a GL account.
Removes the currently active accounting connection.
Returns all configured accounting connections.
Returns a specific accounting connection by ID.
Fetches a single GL account by ID.
Returns a lazily auto-paginating Stream of Ramp.Accounting.FieldOptions
for field_id.
Fetches a single page of field options. See Ramp.Page.
Returns a lazily auto-paginating Stream of Ramp.Accounting.CustomFields.
Fetches a single page of custom fields. See Ramp.Page.
Returns a lazily auto-paginating Stream of Ramp.Accounting.GLAccounts.
Fetches a single page of GL accounts. See Ramp.Page.
Marks a batch of objects (by ID) as ready for ERP sync.
Reports a batch of ERP sync results back to Ramp.
Updates a custom field's name, active status, and/or required status.
Updates a field option's name, code, active status, and/or visibility.
Updates a GL account's name, code, and/or active status.
Types
@type field_list_opt() :: {:start, String.t()} | {:page_size, pos_integer()} | {:remote_id, String.t()} | {:accounting_connection_id, String.t()} | {:is_active, boolean()}
Functions
@spec create_field(Ramp.Client.t(), String.t(), String.t(), [create_field_opt()]) :: {:ok, Ramp.Accounting.CustomField.t()} | {:error, Ramp.Error.t()}
Creates a new custom accounting dimension. input_type is typically
"SINGLE_CATEGORY_SELECT" or "MULTI_CATEGORY_SELECT" -- see the Ramp
API reference for the full set of supported field input types.
@spec create_field_options(Ramp.Client.t(), String.t(), [create_field_option()]) :: {:ok, [Ramp.Accounting.FieldOption.t()]} | {:error, Ramp.Error.t()}
Creates one or more selectable options for field_id in a single batch request.
@spec create_gl_accounts(Ramp.Client.t(), [create_gl_account()]) :: {:ok, [Ramp.Accounting.GLAccount.t()]} | {:error, Ramp.Error.t()}
Creates one or more GL accounts in a single batch request.
@spec delete_field(Ramp.Client.t(), String.t()) :: :ok | {:error, Ramp.Error.t()}
Deletes a custom accounting field.
@spec delete_field_option(Ramp.Client.t(), String.t()) :: :ok | {:error, Ramp.Error.t()}
Deletes a field option.
@spec delete_gl_account(Ramp.Client.t(), String.t()) :: :ok | {:error, Ramp.Error.t()}
Deletes a GL account.
@spec disconnect_connection(Ramp.Client.t()) :: :ok | {:error, Ramp.Error.t()}
Removes the currently active accounting connection.
@spec get_all_connections(Ramp.Client.t()) :: {:ok, [Ramp.Accounting.Connection.t()]} | {:error, Ramp.Error.t()}
Returns all configured accounting connections.
@spec get_connection(Ramp.Client.t(), String.t()) :: {:ok, Ramp.Accounting.Connection.t()} | {:error, Ramp.Error.t()}
Returns a specific accounting connection by ID.
@spec get_gl_account(Ramp.Client.t(), String.t()) :: {:ok, Ramp.Accounting.GLAccount.t()} | {:error, Ramp.Error.t()}
Fetches a single GL account by ID.
@spec list_field_options(Ramp.Client.t(), String.t(), [field_option_list_opt()]) :: Enumerable.t(Ramp.Accounting.FieldOption.t())
Returns a lazily auto-paginating Stream of Ramp.Accounting.FieldOptions
for field_id.
@spec list_field_options_page(Ramp.Client.t(), String.t(), [field_option_list_opt()]) :: {:ok, Ramp.Page.t(Ramp.Accounting.FieldOption.t())} | {:error, Ramp.Error.t()}
Fetches a single page of field options. See Ramp.Page.
@spec list_fields(Ramp.Client.t(), [field_list_opt()]) :: Enumerable.t(Ramp.Accounting.CustomField.t())
Returns a lazily auto-paginating Stream of Ramp.Accounting.CustomFields.
@spec list_fields_page(Ramp.Client.t(), [field_list_opt()]) :: {:ok, Ramp.Page.t(Ramp.Accounting.CustomField.t())} | {:error, Ramp.Error.t()}
Fetches a single page of custom fields. See Ramp.Page.
@spec list_gl_accounts(Ramp.Client.t(), [gl_list_opt()]) :: Enumerable.t(Ramp.Accounting.GLAccount.t())
Returns a lazily auto-paginating Stream of Ramp.Accounting.GLAccounts.
@spec list_gl_accounts_page(Ramp.Client.t(), [gl_list_opt()]) :: {:ok, Ramp.Page.t(Ramp.Accounting.GLAccount.t())} | {:error, Ramp.Error.t()}
Fetches a single page of GL accounts. See Ramp.Page.
@spec mark_ready_to_sync(Ramp.Client.t(), [String.t()]) :: :ok | {:error, Ramp.Error.t()}
Marks a batch of objects (by ID) as ready for ERP sync.
@spec post_sync_status(Ramp.Client.t(), [sync_entry()], String.t() | nil) :: :ok | {:error, Ramp.Error.t()}
Reports a batch of ERP sync results back to Ramp.
object_type is one of "TRANSACTION", "REIMBURSEMENT", "BILL",
"STATEMENT", "CASHBACK"; sync_status is "SUCCESS" or "FAILED"
(include :error_message when reporting a failure).
idempotency_key prevents duplicate sync reports on network retries; one
is generated for you if omitted.
@spec update_field(Ramp.Client.t(), String.t(), [update_field_opt()]) :: {:ok, Ramp.Accounting.CustomField.t()} | {:error, Ramp.Error.t()}
Updates a custom field's name, active status, and/or required status.
@spec update_field_option(Ramp.Client.t(), String.t(), [update_field_option_opt()]) :: {:ok, Ramp.Accounting.FieldOption.t()} | {:error, Ramp.Error.t()}
Updates a field option's name, code, active status, and/or visibility.
@spec update_gl_account(Ramp.Client.t(), String.t(), [update_gl_account_opt()]) :: {:ok, Ramp.Accounting.GLAccount.t()} | {:error, Ramp.Error.t()}
Updates a GL account's name, code, and/or active status.