SquareUp.TypeSpecs (SquareUp v0.1.1) View Source
Link to this section Summary
Link to this section Types
Specs
accept_dispute_request() :: %{}
Specs
Specs
accumulate_loyalty_points_request() :: %{ accumulate_points: loyalty_event_accumulate_points(), idempotency_key: binary(), location_id: binary() }
Specs
accumulate_loyalty_points_response() :: %{ optional(:errors) => [error()], optional(:event) => loyalty_event() }
Specs
action_cancel_reason() :: binary()
Specs
add_group_to_customer_request() :: %{}
Specs
add_group_to_customer_response() :: %{optional(:errors) => [error()]}
Specs
Specs
address() :: %{ optional(:address_line_1) => binary(), optional(:address_line_2) => binary(), optional(:address_line_3) => binary(), optional(:administrative_district_level_1) => binary(), optional(:administrative_district_level_2) => binary(), optional(:administrative_district_level_3) => binary(), optional(:country) => binary(), optional(:first_name) => binary(), optional(:last_name) => binary(), optional(:locality) => binary(), optional(:organization) => binary(), optional(:postal_code) => binary(), optional(:sublocality) => binary(), optional(:sublocality_2) => binary(), optional(:sublocality_3) => binary() }
Specs
adjust_loyalty_points_request() :: %{ adjust_points: loyalty_event_adjust_points(), idempotency_key: binary() }
Specs
adjust_loyalty_points_response() :: %{ optional(:errors) => [error()], optional(:event) => loyalty_event() }
Specs
Specs
bank_account() :: %{ :account_number_suffix => binary(), :account_type => binary(), optional(:bank_name) => binary(), :country => binary(), :creditable => boolean(), :currency => binary(), optional(:debit_mandate_reference_id) => binary(), :debitable => boolean(), optional(:fingerprint) => binary(), :holder_name => binary(), :id => binary(), optional(:location_id) => binary(), :primary_bank_identification_number => binary(), optional(:reference_id) => binary(), optional(:secondary_bank_identification_number) => binary(), :status => binary(), optional(:version) => integer() }
Specs
bank_account_status() :: binary()
Specs
bank_account_type() :: binary()
Specs
batch_change_inventory_request() :: %{ optional(:changes) => [inventory_change()], optional(:idempotency_key) => binary(), optional(:ignore_unchanged_counts) => boolean() }
Specs
batch_change_inventory_response() :: %{ optional(:counts) => [inventory_count()], optional(:errors) => [error()] }
Specs
batch_delete_catalog_objects_request() :: %{optional(:object_ids) => [binary()]}
Specs
Specs
Specs
batch_retrieve_catalog_objects_response() :: %{ optional(:errors) => [error()], optional(:objects) => [catalog_object()], optional(:related_objects) => [catalog_object()] }
Specs
batch_retrieve_inventory_changes_request() :: %{ optional(:catalog_object_ids) => [binary()], optional(:cursor) => binary(), optional(:location_ids) => [binary()], optional(:states) => [binary()], optional(:types) => [binary()], optional(:updated_after) => binary(), optional(:updated_before) => binary() }
Specs
batch_retrieve_inventory_changes_response() :: %{ optional(:changes) => [inventory_change()], optional(:cursor) => binary(), optional(:errors) => [error()] }
Specs
Specs
batch_retrieve_inventory_counts_response() :: %{ optional(:counts) => [inventory_count()], optional(:cursor) => binary(), optional(:errors) => [error()] }
Specs
Specs
Specs
batch_upsert_catalog_objects_request() :: %{ batches: [catalog_object_batch()], idempotency_key: binary() }
Specs
batch_upsert_catalog_objects_response() :: %{ optional(:errors) => [error()], optional(:id_mappings) => [catalog_id_mapping()], optional(:objects) => [catalog_object()], optional(:updated_at) => binary() }
Specs
Specs
Specs
bulk_create_team_members_request() :: %{team_members: map()}
Specs
Specs
bulk_update_team_members_request() :: %{team_members: map()}
Specs
Specs
business_hours() :: %{optional(:periods) => [business_hours_period()]}
Specs
Specs
Specs
Specs
calculate_order_request() :: %{ :order => order(), optional(:proposed_rewards) => [order_reward()] }
Specs
Specs
cancel_invoice_request() :: %{version: integer()}
Specs
Specs
cancel_payment_by_idempotency_key_request() :: %{idempotency_key: binary()}
Specs
cancel_payment_by_idempotency_key_response() :: %{ optional(:errors) => [error()] }
Specs
cancel_payment_request() :: %{}
Specs
Specs
cancel_subscription_request() :: %{}
Specs
cancel_subscription_response() :: %{ optional(:errors) => [error()], optional(:subscription) => subscription() }
Specs
cancel_terminal_checkout_request() :: %{}
Specs
cancel_terminal_checkout_response() :: %{ optional(:checkout) => terminal_checkout(), optional(:errors) => [error()] }
Specs
capture_transaction_request() :: %{}
Specs
capture_transaction_response() :: %{optional(:errors) => [error()]}
Specs
card() :: %{ optional(:billing_address) => address(), optional(:bin) => binary(), optional(:card_brand) => binary(), optional(:card_type) => binary(), optional(:cardholder_name) => binary(), optional(:exp_month) => integer(), optional(:exp_year) => integer(), optional(:fingerprint) => binary(), optional(:id) => binary(), optional(:last_4) => binary(), optional(:prepaid_type) => binary() }
Specs
card_brand() :: binary()
Specs
card_payment_details() :: %{ optional(:application_cryptogram) => binary(), optional(:application_identifier) => binary(), optional(:application_name) => binary(), optional(:auth_result_code) => binary(), optional(:avs_status) => binary(), optional(:card) => card(), optional(:cvv_status) => binary(), optional(:device_details) => device_details(), optional(:entry_method) => binary(), optional(:errors) => [error()], optional(:refund_requires_card_presence) => boolean(), optional(:statement_description) => binary(), optional(:status) => binary(), optional(:verification_method) => binary(), optional(:verification_results) => binary() }
Specs
card_prepaid_type() :: binary()
Specs
card_square_product() :: binary()
Specs
card_type() :: binary()
Specs
Specs
cash_drawer_event_type() :: binary()
Specs
cash_drawer_shift() :: %{ optional(:cash_paid_in_money) => money(), optional(:cash_paid_out_money) => money(), optional(:cash_payment_money) => money(), optional(:cash_refunds_money) => money(), optional(:closed_at) => binary(), optional(:closed_cash_money) => money(), optional(:closing_employee_id) => binary(), optional(:description) => binary(), optional(:device) => cash_drawer_device(), optional(:employee_ids) => [binary()], optional(:ended_at) => binary(), optional(:ending_employee_id) => binary(), optional(:expected_cash_money) => money(), optional(:id) => binary(), optional(:opened_at) => binary(), optional(:opened_cash_money) => money(), optional(:opening_employee_id) => binary(), optional(:state) => binary() }
Specs
Specs
cash_drawer_shift_state() :: binary()
Specs
cash_drawer_shift_summary() :: %{ optional(:closed_at) => binary(), optional(:closed_cash_money) => money(), optional(:description) => binary(), optional(:ended_at) => binary(), optional(:expected_cash_money) => money(), optional(:id) => binary(), optional(:opened_at) => binary(), optional(:opened_cash_money) => money(), optional(:state) => binary() }
Specs
catalog_category() :: %{optional(:name) => binary()}
Specs
catalog_custom_attribute_definition() :: %{ :allowed_object_types => [binary()], optional(:app_visibility) => binary(), optional(:custom_attribute_usage_count) => integer(), optional(:description) => binary(), optional(:key) => binary(), :name => binary(), optional(:number_config) => catalog_custom_attribute_definition_number_config(), optional(:selection_config) => catalog_custom_attribute_definition_selection_config(), optional(:seller_visibility) => binary(), optional(:source_application) => source_application(), optional(:string_config) => catalog_custom_attribute_definition_string_config(), :type => binary() }
Specs
catalog_custom_attribute_definition_app_visibility() :: binary()
Specs
catalog_custom_attribute_definition_number_config() :: %{ optional(:precision) => integer() }
Specs
catalog_custom_attribute_definition_selection_config() :: %{ optional(:allowed_selections) => [ catalog_custom_attribute_definition_selection_config_custom_attribute_selection() ], optional(:max_allowed_selections) => integer() }
Link to this type
catalog_custom_attribute_definition_selection_config_custom_attribute_selection()
View SourceSpecs
Specs
catalog_custom_attribute_definition_seller_visibility() :: binary()
Specs
catalog_custom_attribute_definition_string_config() :: %{ optional(:enforce_uniqueness) => boolean() }
Specs
catalog_custom_attribute_definition_type() :: binary()
Specs
catalog_custom_attribute_value() :: %{ optional(:boolean_value) => boolean(), optional(:custom_attribute_definition_id) => binary(), optional(:key) => binary(), optional(:name) => binary(), optional(:number_value) => binary(), optional(:selection_uid_values) => [binary()], optional(:string_value) => binary(), optional(:type) => binary() }
Specs
Specs
catalog_discount_modify_tax_basis() :: binary()
Specs
catalog_discount_type() :: binary()
Specs
Specs
Specs
catalog_info_request() :: %{}
Specs
catalog_info_response() :: %{ optional(:errors) => [error()], optional(:limits) => catalog_info_response_limits(), optional(:standard_unit_description_group) => standard_unit_description_group() }
Specs
catalog_info_response_limits() :: %{ optional(:batch_delete_max_object_ids) => integer(), optional(:batch_retrieve_max_object_ids) => integer(), optional(:batch_upsert_max_objects_per_batch) => integer(), optional(:batch_upsert_max_total_objects) => integer(), optional(:search_max_page_limit) => integer(), optional(:update_item_modifier_lists_max_item_ids) => integer(), optional(:update_item_modifier_lists_max_modifier_lists_to_disable) => integer(), optional(:update_item_modifier_lists_max_modifier_lists_to_enable) => integer(), optional(:update_item_taxes_max_item_ids) => integer(), optional(:update_item_taxes_max_taxes_to_disable) => integer(), optional(:update_item_taxes_max_taxes_to_enable) => integer() }
Specs
catalog_item() :: %{ optional(:abbreviation) => binary(), optional(:available_electronically) => boolean(), optional(:available_for_pickup) => boolean(), optional(:available_online) => boolean(), optional(:category_id) => binary(), optional(:description) => binary(), optional(:item_options) => [catalog_item_option_for_item()], optional(:label_color) => binary(), optional(:modifier_list_info) => [catalog_item_modifier_list_info()], optional(:name) => binary(), optional(:product_type) => binary(), optional(:skip_modifier_screen) => boolean(), optional(:tax_ids) => [binary()], optional(:variations) => [catalog_object()] }
Specs
catalog_item_modifier_list_info() :: %{ optional(:enabled) => boolean(), optional(:max_selected_modifiers) => integer(), optional(:min_selected_modifiers) => integer(), :modifier_list_id => binary(), optional(:modifier_overrides) => [catalog_modifier_override()] }
Specs
Specs
catalog_item_option_for_item() :: %{optional(:item_option_id) => binary()}
Specs
Specs
Specs
catalog_item_product_type() :: binary()
Specs
catalog_item_variation() :: %{ optional(:inventory_alert_threshold) => integer(), optional(:inventory_alert_type) => binary(), optional(:item_id) => binary(), optional(:item_option_values) => [ catalog_item_option_value_for_item_variation() ], optional(:location_overrides) => [item_variation_location_overrides()], optional(:measurement_unit_id) => binary(), optional(:name) => binary(), optional(:ordinal) => integer(), optional(:price_money) => money(), optional(:pricing_type) => binary(), optional(:service_duration) => integer(), optional(:sku) => binary(), optional(:track_inventory) => boolean(), optional(:upc) => binary(), optional(:user_data) => binary() }
Specs
catalog_measurement_unit() :: %{ optional(:measurement_unit) => measurement_unit(), optional(:precision) => integer() }
Specs
Specs
catalog_modifier_list() :: %{ optional(:modifiers) => [catalog_object()], optional(:name) => binary(), optional(:ordinal) => integer(), optional(:selection_type) => binary() }
Specs
catalog_modifier_list_selection_type() :: binary()
Specs
Specs
catalog_object() :: %{ optional(:absent_at_location_ids) => [binary()], optional(:catalog_v1_ids) => [catalog_v1_id()], optional(:category_data) => catalog_category(), optional(:custom_attribute_definition_data) => catalog_custom_attribute_definition(), optional(:custom_attribute_values) => map(), optional(:discount_data) => catalog_discount(), :id => binary(), optional(:image_data) => catalog_image(), optional(:image_id) => binary(), optional(:is_deleted) => boolean(), optional(:item_data) => catalog_item(), optional(:item_option_data) => catalog_item_option(), optional(:item_option_value_data) => catalog_item_option_value(), optional(:item_variation_data) => catalog_item_variation(), optional(:measurement_unit_data) => catalog_measurement_unit(), optional(:modifier_data) => catalog_modifier(), optional(:modifier_list_data) => catalog_modifier_list(), optional(:present_at_all_locations) => boolean(), optional(:present_at_location_ids) => [binary()], optional(:pricing_rule_data) => catalog_pricing_rule(), optional(:product_set_data) => catalog_product_set(), optional(:quick_amounts_settings_data) => catalog_quick_amounts_settings(), optional(:subscription_plan_data) => catalog_subscription_plan(), optional(:tax_data) => catalog_tax(), optional(:time_period_data) => catalog_time_period(), :type => binary(), optional(:updated_at) => binary(), optional(:version) => integer() }
Specs
catalog_object_batch() :: %{objects: [catalog_object()]}
Specs
catalog_object_type() :: binary()
Specs
catalog_pricing_rule() :: %{ optional(:apply_products_id) => binary(), optional(:discount_id) => binary(), optional(:exclude_products_id) => binary(), optional(:exclude_strategy) => binary(), optional(:match_products_id) => binary(), optional(:name) => binary(), optional(:time_period_ids) => [binary()], optional(:valid_from_date) => binary(), optional(:valid_from_local_time) => binary(), optional(:valid_until_date) => binary(), optional(:valid_until_local_time) => binary() }
Specs
catalog_pricing_type() :: binary()
Specs
Specs
catalog_query() :: %{ optional(:exact_query) => catalog_query_exact(), optional(:item_variations_for_item_option_values_query) => catalog_query_item_variations_for_item_option_values(), optional(:items_for_item_options_query) => catalog_query_items_for_item_options(), optional(:items_for_modifier_list_query) => catalog_query_items_for_modifier_list(), optional(:items_for_tax_query) => catalog_query_items_for_tax(), optional(:prefix_query) => catalog_query_prefix(), optional(:range_query) => catalog_query_range(), optional(:sorted_attribute_query) => catalog_query_sorted_attribute(), optional(:text_query) => catalog_query_text() }
Specs
Specs
catalog_query_item_variations_for_item_option_values() :: %{ optional(:item_option_value_ids) => [binary()] }
Specs
catalog_query_items_for_item_options() :: %{ optional(:item_option_ids) => [binary()] }
Specs
catalog_query_items_for_modifier_list() :: %{modifier_list_ids: [binary()]}
Specs
catalog_query_items_for_tax() :: %{tax_ids: [binary()]}
Specs
Specs
Specs
Specs
catalog_query_text() :: %{keywords: [binary()]}
Specs
Specs
catalog_quick_amount_type() :: binary()
Specs
catalog_quick_amounts_settings() :: %{ optional(:amounts) => [catalog_quick_amount()], optional(:eligible_for_auto_amounts) => boolean(), :option => binary() }
Specs
catalog_quick_amounts_settings_option() :: binary()
Specs
catalog_subscription_plan() :: %{ optional(:name) => binary(), optional(:phases) => [subscription_phase()] }
Specs
Specs
catalog_time_period() :: %{optional(:event) => binary()}
Specs
Specs
charge_request() :: %{ optional(:additional_recipients) => [additional_recipient()], :amount_money => money(), optional(:billing_address) => address(), optional(:buyer_email_address) => binary(), optional(:card_nonce) => binary(), optional(:customer_card_id) => binary(), optional(:customer_id) => binary(), optional(:delay_capture) => boolean(), :idempotency_key => binary(), optional(:note) => binary(), optional(:order_id) => binary(), optional(:reference_id) => binary(), optional(:shipping_address) => address(), optional(:verification_token) => binary() }
Specs
Specs
charge_response() :: %{ optional(:errors) => [error()], optional(:transaction) => transaction() }
Specs
checkout() :: %{ optional(:additional_recipients) => [additional_recipient()], optional(:ask_for_shipping_address) => boolean(), optional(:checkout_page_url) => binary(), optional(:created_at) => binary(), optional(:id) => binary(), optional(:merchant_support_email) => binary(), optional(:order) => order(), optional(:pre_populate_buyer_email) => binary(), optional(:pre_populate_shipping_address) => address(), optional(:redirect_url) => binary() }
Specs
complete_payment_request() :: %{}
Specs
Specs
Specs
country() :: binary()
Specs
create_break_type_request() :: %{ :break_type => break_type(), optional(:idempotency_key) => binary() }
Specs
create_break_type_response() :: %{ optional(:break_type) => break_type(), optional(:errors) => [error()] }
Specs
create_catalog_image_request() :: %{ :idempotency_key => binary(), optional(:image) => catalog_object(), optional(:object_id) => binary() }
Specs
create_catalog_image_response() :: %{ optional(:errors) => [error()], optional(:image) => catalog_object() }
Specs
create_checkout_request() :: %{ optional(:additional_recipients) => [charge_request_additional_recipient()], optional(:ask_for_shipping_address) => boolean(), :idempotency_key => binary(), optional(:merchant_support_email) => binary(), optional(:note) => binary(), :order => create_order_request(), optional(:pre_populate_buyer_email) => binary(), optional(:pre_populate_shipping_address) => address(), optional(:redirect_url) => binary() }
Specs
Specs
Specs
Specs
create_customer_group_request() :: %{ :group => customer_group(), optional(:idempotency_key) => binary() }
Specs
create_customer_group_response() :: %{ optional(:errors) => [error()], optional(:group) => customer_group() }
Specs
create_customer_request() :: %{ optional(:address) => address(), optional(:birthday) => binary(), optional(:company_name) => binary(), optional(:email_address) => binary(), optional(:family_name) => binary(), optional(:given_name) => binary(), optional(:idempotency_key) => binary(), optional(:nickname) => binary(), optional(:note) => binary(), optional(:phone_number) => binary(), optional(:reference_id) => binary() }
Specs
Specs
create_device_code_request() :: %{ device_code: device_code(), idempotency_key: binary() }
Specs
create_device_code_response() :: %{ optional(:device_code) => device_code(), optional(:errors) => [error()] }
Specs
Specs
create_dispute_evidence_file_response() :: %{ optional(:errors) => [error()], optional(:evidence) => dispute_evidence() }
Specs
Specs
create_dispute_evidence_text_response() :: %{ optional(:errors) => [error()], optional(:evidence) => dispute_evidence() }
Specs
Specs
Specs
create_location_request() :: %{optional(:location) => location()}
Specs
Specs
create_loyalty_account_request() :: %{ idempotency_key: binary(), loyalty_account: loyalty_account() }
Specs
create_loyalty_account_response() :: %{ optional(:errors) => [error()], optional(:loyalty_account) => loyalty_account() }
Specs
create_loyalty_reward_request() :: %{ idempotency_key: binary(), reward: loyalty_reward() }
Specs
create_loyalty_reward_response() :: %{ optional(:errors) => [error()], optional(:reward) => loyalty_reward() }
Specs
create_mobile_authorization_code_request() :: %{ optional(:location_id) => binary() }
Specs
Specs
Specs
Specs
create_payment_request() :: %{ optional(:accept_partial_authorization) => boolean(), :amount_money => money(), optional(:app_fee_money) => money(), optional(:autocomplete) => boolean(), optional(:billing_address) => address(), optional(:buyer_email_address) => binary(), optional(:customer_id) => binary(), optional(:delay_duration) => binary(), :idempotency_key => binary(), optional(:location_id) => binary(), optional(:note) => binary(), optional(:order_id) => binary(), optional(:reference_id) => binary(), optional(:shipping_address) => address(), :source_id => binary(), optional(:statement_description_identifier) => binary(), optional(:tip_money) => money(), optional(:verification_token) => binary() }
Specs
Specs
Specs
Specs
Specs
Specs
create_subscription_request() :: %{ optional(:canceled_date) => binary(), optional(:card_id) => binary(), :customer_id => binary(), :idempotency_key => binary(), :location_id => binary(), :plan_id => binary(), optional(:price_override_money) => money(), optional(:start_date) => binary(), optional(:tax_percentage) => binary(), optional(:timezone) => binary() }
Specs
create_subscription_response() :: %{ optional(:errors) => [error()], optional(:subscription) => subscription() }
Specs
create_team_member_request() :: %{ optional(:idempotency_key) => binary(), optional(:team_member) => team_member() }
Specs
create_team_member_response() :: %{ optional(:errors) => [error()], optional(:team_member) => team_member() }
Specs
create_terminal_checkout_request() :: %{ checkout: terminal_checkout(), idempotency_key: binary() }
Specs
create_terminal_checkout_response() :: %{ optional(:checkout) => terminal_checkout(), optional(:errors) => [error()] }
Specs
currency() :: binary()
Specs
Specs
customer() :: %{ optional(:address) => address(), optional(:birthday) => binary(), optional(:cards) => [card()], optional(:company_name) => binary(), optional(:created_at) => binary(), optional(:creation_source) => binary(), optional(:email_address) => binary(), optional(:family_name) => binary(), optional(:given_name) => binary(), optional(:group_ids) => [binary()], optional(:groups) => [customer_group_info()], optional(:id) => binary(), optional(:nickname) => binary(), optional(:note) => binary(), optional(:phone_number) => binary(), optional(:preferences) => customer_preferences(), optional(:reference_id) => binary(), optional(:segment_ids) => [binary()], optional(:updated_at) => binary() }
Specs
customer_creation_source() :: binary()
Specs
Specs
customer_filter() :: %{ optional(:created_at) => time_range(), optional(:creation_source) => customer_creation_source_filter(), optional(:email_address) => customer_text_filter(), optional(:group_ids) => filter_value(), optional(:phone_number) => customer_text_filter(), optional(:reference_id) => customer_text_filter(), optional(:updated_at) => time_range() }
Specs
Specs
Specs
customer_inclusion_exclusion() :: binary()
Specs
customer_preferences() :: %{optional(:email_unsubscribed) => boolean()}
Specs
customer_query() :: %{ optional(:filter) => customer_filter(), optional(:sort) => customer_sort() }
Specs
Specs
Specs
customer_sort_field() :: binary()
Specs
Specs
Specs
day_of_week() :: binary()
Specs
delete_break_type_request() :: %{}
Specs
delete_break_type_response() :: %{optional(:errors) => [error()]}
Specs
delete_catalog_object_request() :: %{}
Specs
Specs
delete_customer_card_request() :: %{}
Specs
delete_customer_card_response() :: %{optional(:errors) => [error()]}
Specs
delete_customer_group_request() :: %{}
Specs
delete_customer_group_response() :: %{optional(:errors) => [error()]}
Specs
delete_customer_request() :: %{}
Specs
delete_customer_response() :: %{optional(:errors) => [error()]}
Specs
delete_invoice_request() :: %{optional(:version) => integer()}
Specs
delete_invoice_response() :: %{optional(:errors) => [error()]}
Specs
delete_loyalty_reward_request() :: %{}
Specs
delete_loyalty_reward_response() :: %{optional(:errors) => [error()]}
Specs
delete_shift_request() :: %{}
Specs
delete_shift_response() :: %{optional(:errors) => [error()]}
Specs
Specs
device_checkout_options() :: %{ :device_id => binary(), optional(:skip_receipt_screen) => boolean(), optional(:tip_settings) => tip_settings() }
Specs
device_code() :: %{ optional(:code) => binary(), optional(:created_at) => binary(), optional(:device_id) => binary(), optional(:id) => binary(), optional(:location_id) => binary(), optional(:name) => binary(), optional(:pair_by) => binary(), optional(:paired_at) => binary(), :product_type => binary(), optional(:status) => binary(), optional(:status_changed_at) => binary() }
Specs
device_code_status() :: binary()
Specs
Specs
dispute() :: %{ optional(:amount_money) => money(), optional(:brand_dispute_id) => binary(), optional(:card_brand) => binary(), optional(:created_at) => binary(), optional(:dispute_id) => binary(), optional(:disputed_payment) => disputed_payment(), optional(:due_at) => binary(), optional(:evidence_ids) => [binary()], optional(:location_id) => binary(), optional(:reason) => binary(), optional(:reported_date) => binary(), optional(:state) => binary(), optional(:updated_at) => binary(), optional(:version) => integer() }
Specs
Specs
Specs
dispute_evidence_type() :: binary()
Specs
dispute_reason() :: binary()
Specs
dispute_state() :: binary()
Specs
disputed_payment() :: %{optional(:payment_id) => binary()}
Specs
ecom_visibility() :: binary()
Specs
employee() :: %{ optional(:created_at) => binary(), optional(:email) => binary(), optional(:first_name) => binary(), optional(:id) => binary(), optional(:is_owner) => boolean(), optional(:last_name) => binary(), optional(:location_ids) => [binary()], optional(:phone_number) => binary(), optional(:status) => binary(), optional(:updated_at) => binary() }
Specs
employee_status() :: binary()
Specs
Specs
Specs
error_category() :: binary()
Specs
error_code() :: binary()
Specs
exclude_strategy() :: binary()
Specs
Specs
get_bank_account_by_v1_id_request() :: %{}
Specs
get_bank_account_by_v1_id_response() :: %{ optional(:bank_account) => bank_account(), optional(:errors) => [error()] }
Specs
get_bank_account_request() :: %{}
Specs
get_bank_account_response() :: %{ optional(:bank_account) => bank_account(), optional(:errors) => [error()] }
Specs
get_break_type_request() :: %{}
Specs
get_break_type_response() :: %{ optional(:break_type) => break_type(), optional(:errors) => [error()] }
Specs
get_device_code_request() :: %{}
Specs
get_device_code_response() :: %{ optional(:device_code) => device_code(), optional(:errors) => [error()] }
Specs
get_employee_wage_request() :: %{}
Specs
get_employee_wage_response() :: %{ optional(:employee_wage) => employee_wage(), optional(:errors) => [error()] }
Specs
get_invoice_request() :: %{}
Specs
Specs
get_payment_refund_request() :: %{}
Specs
get_payment_refund_response() :: %{ optional(:errors) => [error()], optional(:refund) => payment_refund() }
Specs
get_payment_request() :: %{}
Specs
Specs
get_shift_request() :: %{}
Specs
Specs
get_team_member_wage_request() :: %{}
Specs
get_team_member_wage_response() :: %{ optional(:errors) => [error()], optional(:team_member_wage) => team_member_wage() }
Specs
get_terminal_checkout_request() :: %{}
Specs
get_terminal_checkout_response() :: %{ optional(:checkout) => terminal_checkout(), optional(:errors) => [error()] }
Specs
inventory_adjustment() :: %{ optional(:catalog_object_id) => binary(), optional(:catalog_object_type) => binary(), optional(:created_at) => binary(), optional(:employee_id) => binary(), optional(:from_state) => binary(), optional(:goods_receipt_id) => binary(), optional(:id) => binary(), optional(:location_id) => binary(), optional(:occurred_at) => binary(), optional(:purchase_order_id) => binary(), optional(:quantity) => binary(), optional(:reference_id) => binary(), optional(:refund_id) => binary(), optional(:source) => source_application(), optional(:to_state) => binary(), optional(:total_price_money) => money(), optional(:transaction_id) => binary() }
Specs
inventory_alert_type() :: binary()
Specs
inventory_change() :: %{ optional(:adjustment) => inventory_adjustment(), optional(:physical_count) => inventory_physical_count(), optional(:transfer) => inventory_transfer(), optional(:type) => binary() }
Specs
inventory_change_type() :: binary()
Specs
Specs
inventory_physical_count() :: %{ optional(:catalog_object_id) => binary(), optional(:catalog_object_type) => binary(), optional(:created_at) => binary(), optional(:employee_id) => binary(), optional(:id) => binary(), optional(:location_id) => binary(), optional(:occurred_at) => binary(), optional(:quantity) => binary(), optional(:reference_id) => binary(), optional(:source) => source_application(), optional(:state) => binary() }
Specs
inventory_state() :: binary()
Specs
inventory_transfer() :: %{ optional(:catalog_object_id) => binary(), optional(:catalog_object_type) => binary(), optional(:created_at) => binary(), optional(:employee_id) => binary(), optional(:from_location_id) => binary(), optional(:id) => binary(), optional(:occurred_at) => binary(), optional(:quantity) => binary(), optional(:reference_id) => binary(), optional(:source) => source_application(), optional(:state) => binary(), optional(:to_location_id) => binary() }
Specs
invoice() :: %{ optional(:created_at) => binary(), optional(:description) => binary(), optional(:id) => binary(), optional(:invoice_number) => binary(), optional(:location_id) => binary(), optional(:next_payment_amount_money) => money(), optional(:order_id) => binary(), optional(:payment_requests) => [invoice_payment_request()], optional(:primary_recipient) => invoice_recipient(), optional(:public_url) => binary(), optional(:scheduled_at) => binary(), optional(:status) => binary(), optional(:timezone) => binary(), optional(:title) => binary(), optional(:updated_at) => binary(), optional(:version) => integer() }
Specs
Specs
Specs
invoice_payment_reminder_status() :: binary()
Specs
invoice_payment_request() :: %{ optional(:card_id) => binary(), optional(:computed_amount_money) => money(), optional(:due_date) => binary(), optional(:fixed_amount_requested_money) => money(), optional(:percentage_requested) => binary(), optional(:reminders) => [invoice_payment_reminder()], optional(:request_method) => binary(), optional(:request_type) => binary(), optional(:rounding_adjustment_included_money) => money(), optional(:tipping_enabled) => boolean(), optional(:total_completed_amount_money) => money(), optional(:uid) => binary() }
Specs
invoice_query() :: %{ :filter => invoice_filter(), optional(:sort) => invoice_sort() }
Specs
Specs
invoice_request_method() :: binary()
Specs
invoice_request_type() :: binary()
Specs
Specs
invoice_sort_field() :: binary()
Specs
invoice_status() :: binary()
Specs
Specs
Specs
job_assignment_pay_type() :: binary()
Specs
Specs
list_bank_accounts_response() :: %{ optional(:bank_accounts) => [bank_account()], optional(:cursor) => binary(), optional(:errors) => [error()] }
Specs
Specs
list_break_types_response() :: %{ optional(:break_types) => [break_type()], optional(:cursor) => binary(), optional(:errors) => [error()] }
Specs
Specs
list_cash_drawer_shift_events_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:events) => [cash_drawer_shift_event()] }
Specs
Specs
list_cash_drawer_shifts_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:items) => [cash_drawer_shift_summary()] }
Specs
Specs
list_catalog_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:objects) => [catalog_object()] }
Specs
list_customer_groups_request() :: %{optional(:cursor) => binary()}
Specs
list_customer_groups_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:groups) => [customer_group()] }
Specs
list_customer_segments_request() :: %{optional(:cursor) => binary()}
Specs
list_customer_segments_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:segments) => [customer_segment()] }
Specs
Specs
Specs
Specs
list_device_codes_response() :: %{ optional(:cursor) => binary(), optional(:device_codes) => [device_code()], optional(:errors) => [error()] }
Specs
list_dispute_evidence_request() :: %{}
Specs
list_dispute_evidence_response() :: %{ optional(:errors) => [error()], optional(:evidence) => [dispute_evidence()] }
Specs
Specs
Specs
Specs
list_employee_wages_response() :: %{ optional(:cursor) => binary(), optional(:employee_wages) => [employee_wage()], optional(:errors) => [error()] }
Specs
Specs
Specs
Specs
Specs
list_locations_request() :: %{}
Specs
Specs
list_loyalty_programs_request() :: %{}
Specs
list_loyalty_programs_response() :: %{ optional(:errors) => [error()], optional(:programs) => [loyalty_program()] }
Specs
list_merchants_request() :: %{optional(:cursor) => integer()}
Specs
Specs
Specs
list_payment_refunds_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:refunds) => [payment_refund()] }
Specs
Specs
Specs
Specs
Specs
Specs
list_subscription_events_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:subscription_events) => [subscription_event()] }
Specs
Specs
list_team_member_wages_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:team_member_wages) => [team_member_wage()] }
Specs
Specs
list_transactions_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:transactions) => [transaction()] }
Specs
Specs
list_workweek_configs_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:workweek_configs) => [workweek_config()] }
Specs
location() :: %{ optional(:address) => address(), optional(:business_email) => binary(), optional(:business_hours) => business_hours(), optional(:business_name) => binary(), optional(:capabilities) => [binary()], optional(:coordinates) => coordinates(), optional(:country) => binary(), optional(:created_at) => binary(), optional(:currency) => binary(), optional(:description) => binary(), optional(:facebook_url) => binary(), optional(:id) => binary(), optional(:instagram_username) => binary(), optional(:language_code) => binary(), optional(:logo_url) => binary(), optional(:mcc) => binary(), optional(:merchant_id) => binary(), optional(:name) => binary(), optional(:phone_number) => binary(), optional(:pos_background_url) => binary(), optional(:status) => binary(), optional(:timezone) => binary(), optional(:twitter_username) => binary(), optional(:type) => binary(), optional(:website_url) => binary() }
Specs
location_capability() :: binary()
Specs
location_status() :: binary()
Specs
location_type() :: binary()
Specs
loyalty_account() :: %{ optional(:balance) => integer(), optional(:created_at) => binary(), optional(:customer_id) => binary(), optional(:enrolled_at) => binary(), optional(:id) => binary(), optional(:lifetime_points) => integer(), :mappings => [loyalty_account_mapping()], :program_id => binary(), optional(:updated_at) => binary() }
Specs
Specs
loyalty_account_mapping_type() :: binary()
Specs
loyalty_event() :: %{ optional(:accumulate_points) => loyalty_event_accumulate_points(), optional(:adjust_points) => loyalty_event_adjust_points(), optional(:create_reward) => loyalty_event_create_reward(), :created_at => binary(), optional(:delete_reward) => loyalty_event_delete_reward(), optional(:expire_points) => loyalty_event_expire_points(), :id => binary(), optional(:location_id) => binary(), :loyalty_account_id => binary(), optional(:other_event) => loyalty_event_other(), optional(:redeem_reward) => loyalty_event_redeem_reward(), :source => binary(), :type => binary() }
Specs
Specs
Specs
Specs
loyalty_event_date_time_filter() :: %{created_at: time_range()}
Specs
Specs
Specs
loyalty_event_filter() :: %{ optional(:date_time_filter) => loyalty_event_date_time_filter(), optional(:location_filter) => loyalty_event_location_filter(), optional(:loyalty_account_filter) => loyalty_event_loyalty_account_filter(), optional(:order_filter) => loyalty_event_order_filter(), optional(:type_filter) => loyalty_event_type_filter() }
Specs
loyalty_event_location_filter() :: %{location_ids: [binary()]}
Specs
loyalty_event_loyalty_account_filter() :: %{loyalty_account_id: binary()}
Specs
loyalty_event_order_filter() :: %{order_id: binary()}
Specs
Specs
loyalty_event_query() :: %{optional(:filter) => loyalty_event_filter()}
Specs
Specs
loyalty_event_source() :: binary()
Specs
loyalty_event_type() :: binary()
Specs
loyalty_event_type_filter() :: %{types: [binary()]}
Specs
loyalty_program() :: %{ :accrual_rules => [loyalty_program_accrual_rule()], :created_at => binary(), optional(:expiration_policy) => loyalty_program_expiration_policy(), :id => binary(), :location_ids => [binary()], :reward_tiers => [loyalty_program_reward_tier()], :status => binary(), :terminology => loyalty_program_terminology(), :updated_at => binary() }
Specs
Specs
loyalty_program_accrual_rule_type() :: binary()
Specs
loyalty_program_expiration_policy() :: %{expiration_duration: binary()}
Specs
Specs
loyalty_program_reward_definition_scope() :: binary()
Specs
loyalty_program_reward_definition_type() :: binary()
Specs
loyalty_program_reward_tier() :: %{ created_at: binary(), definition: loyalty_program_reward_definition(), id: binary(), name: binary(), points: integer() }
Specs
loyalty_program_status() :: binary()
Specs
Specs
loyalty_reward() :: %{ optional(:created_at) => binary(), optional(:id) => binary(), :loyalty_account_id => binary(), optional(:order_id) => binary(), optional(:points) => integer(), optional(:redeemed_at) => binary(), :reward_tier_id => binary(), optional(:status) => binary(), optional(:updated_at) => binary() }
Specs
loyalty_reward_status() :: binary()
Specs
measurement_unit() :: %{ optional(:area_unit) => binary(), optional(:custom_unit) => measurement_unit_custom(), optional(:generic_unit) => binary(), optional(:length_unit) => binary(), optional(:time_unit) => binary(), optional(:type) => binary(), optional(:volume_unit) => binary(), optional(:weight_unit) => binary() }
Specs
measurement_unit_area() :: binary()
Specs
Specs
measurement_unit_generic() :: binary()
Specs
measurement_unit_length() :: binary()
Specs
measurement_unit_time() :: binary()
Specs
measurement_unit_unit_type() :: binary()
Specs
measurement_unit_volume() :: binary()
Specs
measurement_unit_weight() :: binary()
Specs
Specs
merchant_status() :: binary()
Specs
Specs
Specs
obtain_token_response() :: %{ optional(:access_token) => binary(), optional(:expires_at) => binary(), optional(:id_token) => binary(), optional(:merchant_id) => binary(), optional(:plan_id) => binary(), optional(:refresh_token) => binary(), optional(:subscription_id) => binary(), optional(:token_type) => binary() }
Specs
order() :: %{ optional(:closed_at) => binary(), optional(:created_at) => binary(), optional(:customer_id) => binary(), optional(:discounts) => [order_line_item_discount()], optional(:fulfillments) => [order_fulfillment()], optional(:id) => binary(), optional(:line_items) => [order_line_item()], :location_id => binary(), optional(:metadata) => map(), optional(:net_amounts) => order_money_amounts(), optional(:pricing_options) => order_pricing_options(), optional(:reference_id) => binary(), optional(:refunds) => [refund()], optional(:return_amounts) => order_money_amounts(), optional(:returns) => [order_return()], optional(:rewards) => [order_reward()], optional(:rounding_adjustment) => order_rounding_adjustment(), optional(:service_charges) => [order_service_charge()], optional(:source) => order_source(), optional(:state) => binary(), optional(:taxes) => [order_line_item_tax()], optional(:tenders) => [tender()], optional(:total_discount_money) => money(), optional(:total_money) => money(), optional(:total_service_charge_money) => money(), optional(:total_tax_money) => money(), optional(:total_tip_money) => money(), optional(:updated_at) => binary(), optional(:version) => integer() }
Specs
Specs
order_created_object() :: %{optional(:order_created) => order_created()}
Specs
Specs
order_fulfillment() :: %{ optional(:metadata) => map(), optional(:pickup_details) => order_fulfillment_pickup_details(), optional(:shipment_details) => order_fulfillment_shipment_details(), optional(:state) => binary(), optional(:type) => binary(), optional(:uid) => binary() }
Specs
order_fulfillment_pickup_details() :: %{ optional(:accepted_at) => binary(), optional(:auto_complete_duration) => binary(), optional(:cancel_reason) => binary(), optional(:canceled_at) => binary(), optional(:curbside_pickup_details) => order_fulfillment_pickup_details_curbside_pickup_details(), optional(:expired_at) => binary(), optional(:expires_at) => binary(), optional(:is_curbside_pickup) => boolean(), optional(:note) => binary(), optional(:picked_up_at) => binary(), optional(:pickup_at) => binary(), optional(:pickup_window_duration) => binary(), optional(:placed_at) => binary(), optional(:prep_time_duration) => binary(), optional(:ready_at) => binary(), optional(:recipient) => order_fulfillment_recipient(), optional(:rejected_at) => binary(), optional(:schedule_type) => binary() }
Specs
Specs
order_fulfillment_pickup_details_schedule_type() :: binary()
Specs
Specs
order_fulfillment_shipment_details() :: %{ optional(:cancel_reason) => binary(), optional(:canceled_at) => binary(), optional(:carrier) => binary(), optional(:expected_shipped_at) => binary(), optional(:failed_at) => binary(), optional(:failure_reason) => binary(), optional(:in_progress_at) => binary(), optional(:packaged_at) => binary(), optional(:placed_at) => binary(), optional(:recipient) => order_fulfillment_recipient(), optional(:shipped_at) => binary(), optional(:shipping_note) => binary(), optional(:shipping_type) => binary(), optional(:tracking_number) => binary(), optional(:tracking_url) => binary() }
Specs
order_fulfillment_state() :: binary()
Specs
order_fulfillment_type() :: binary()
Specs
order_fulfillment_updated() :: %{ optional(:created_at) => binary(), optional(:fulfillment_update) => [order_fulfillment_updated_update()], optional(:location_id) => binary(), optional(:order_id) => binary(), optional(:state) => binary(), optional(:updated_at) => binary(), optional(:version) => integer() }
Specs
order_fulfillment_updated_object() :: %{ optional(:order_fulfillment_updated) => order_fulfillment_updated() }
Specs
Specs
order_line_item() :: %{ optional(:applied_discounts) => [order_line_item_applied_discount()], optional(:applied_taxes) => [order_line_item_applied_tax()], optional(:base_price_money) => money(), optional(:catalog_object_id) => binary(), optional(:gross_sales_money) => money(), optional(:metadata) => map(), optional(:modifiers) => [order_line_item_modifier()], optional(:name) => binary(), optional(:note) => binary(), :quantity => binary(), optional(:quantity_unit) => order_quantity_unit(), optional(:total_discount_money) => money(), optional(:total_money) => money(), optional(:total_tax_money) => money(), optional(:uid) => binary(), optional(:variation_name) => binary(), optional(:variation_total_price_money) => money() }
Specs
Specs
Specs
order_line_item_discount() :: %{ optional(:amount_money) => money(), optional(:applied_money) => money(), optional(:catalog_object_id) => binary(), optional(:metadata) => map(), optional(:name) => binary(), optional(:percentage) => binary(), optional(:pricing_rule_id) => binary(), optional(:reward_ids) => [binary()], optional(:scope) => binary(), optional(:type) => binary(), optional(:uid) => binary() }
Specs
order_line_item_discount_scope() :: binary()
Specs
order_line_item_discount_type() :: binary()
Specs
Specs
Specs
order_line_item_tax_scope() :: binary()
Specs
order_line_item_tax_type() :: binary()
Specs
Specs
order_pricing_options() :: %{optional(:auto_apply_discounts) => boolean()}
Specs
order_quantity_unit() :: %{ optional(:measurement_unit) => measurement_unit(), optional(:precision) => integer() }
Specs
order_return() :: %{ optional(:return_amounts) => order_money_amounts(), optional(:return_discounts) => [order_return_discount()], optional(:return_line_items) => [order_return_line_item()], optional(:return_service_charges) => [order_return_service_charge()], optional(:return_taxes) => [order_return_tax()], optional(:rounding_adjustment) => order_rounding_adjustment(), optional(:source_order_id) => binary(), optional(:uid) => binary() }
Specs
order_return_discount() :: %{ optional(:amount_money) => money(), optional(:applied_money) => money(), optional(:catalog_object_id) => binary(), optional(:name) => binary(), optional(:percentage) => binary(), optional(:scope) => binary(), optional(:source_discount_uid) => binary(), optional(:type) => binary(), optional(:uid) => binary() }
Specs
order_return_line_item() :: %{ optional(:applied_discounts) => [order_line_item_applied_discount()], optional(:applied_taxes) => [order_line_item_applied_tax()], optional(:base_price_money) => money(), optional(:catalog_object_id) => binary(), optional(:gross_return_money) => money(), optional(:name) => binary(), optional(:note) => binary(), :quantity => binary(), optional(:quantity_unit) => order_quantity_unit(), optional(:return_modifiers) => [order_return_line_item_modifier()], optional(:source_line_item_uid) => binary(), optional(:total_discount_money) => money(), optional(:total_money) => money(), optional(:total_tax_money) => money(), optional(:uid) => binary(), optional(:variation_name) => binary(), optional(:variation_total_price_money) => money() }
Specs
Specs
order_return_service_charge() :: %{ optional(:amount_money) => money(), optional(:applied_money) => money(), optional(:applied_taxes) => [order_line_item_applied_tax()], optional(:calculation_phase) => binary(), optional(:catalog_object_id) => binary(), optional(:name) => binary(), optional(:percentage) => binary(), optional(:source_service_charge_uid) => binary(), optional(:taxable) => boolean(), optional(:total_money) => money(), optional(:total_tax_money) => money(), optional(:uid) => binary() }
Specs
Specs
Specs
Specs
order_service_charge() :: %{ optional(:amount_money) => money(), optional(:applied_money) => money(), optional(:applied_taxes) => [order_line_item_applied_tax()], optional(:calculation_phase) => binary(), optional(:catalog_object_id) => binary(), optional(:metadata) => map(), optional(:name) => binary(), optional(:percentage) => binary(), optional(:taxable) => boolean(), optional(:total_money) => money(), optional(:total_tax_money) => money(), optional(:uid) => binary() }
Specs
order_service_charge_calculation_phase() :: binary()
Specs
order_source() :: %{optional(:name) => binary()}
Specs
order_state() :: binary()
Specs
Specs
order_updated_object() :: %{optional(:order_updated) => order_updated()}
Specs
Specs
Specs
payment() :: %{ optional(:amount_money) => money(), optional(:app_fee_money) => money(), optional(:billing_address) => address(), optional(:buyer_email_address) => binary(), optional(:card_details) => card_payment_details(), optional(:created_at) => binary(), optional(:customer_id) => binary(), optional(:delay_action) => binary(), optional(:delay_duration) => binary(), optional(:delayed_until) => binary(), optional(:employee_id) => binary(), optional(:id) => binary(), optional(:location_id) => binary(), optional(:note) => binary(), optional(:order_id) => binary(), optional(:processing_fee) => [processing_fee()], optional(:receipt_number) => binary(), optional(:receipt_url) => binary(), optional(:reference_id) => binary(), optional(:refund_ids) => [binary()], optional(:refunded_money) => money(), optional(:shipping_address) => address(), optional(:source_type) => binary(), optional(:statement_description_identifier) => binary(), optional(:status) => binary(), optional(:tip_money) => money(), optional(:total_money) => money(), optional(:updated_at) => binary() }
Specs
payment_options() :: %{optional(:autocomplete) => boolean()}
Specs
payment_refund() :: %{ :amount_money => money(), optional(:app_fee_money) => money(), optional(:created_at) => binary(), :id => binary(), optional(:location_id) => binary(), optional(:order_id) => binary(), optional(:payment_id) => binary(), optional(:processing_fee) => [processing_fee()], optional(:reason) => binary(), optional(:status) => binary(), optional(:updated_at) => binary() }
Specs
Specs
product() :: binary()
Specs
product_type() :: binary()
Specs
Specs
Specs
Specs
Specs
redeem_loyalty_reward_response() :: %{ optional(:errors) => [error()], optional(:event) => loyalty_event() }
Specs
refund() :: %{ optional(:additional_recipients) => [additional_recipient()], :amount_money => money(), optional(:created_at) => binary(), :id => binary(), :location_id => binary(), optional(:processing_fee_money) => money(), :reason => binary(), :status => binary(), :tender_id => binary(), :transaction_id => binary() }
Specs
Specs
refund_payment_response() :: %{ optional(:errors) => [error()], optional(:refund) => payment_refund() }
Specs
refund_status() :: binary()
Specs
register_domain_request() :: %{domain_name: binary()}
Specs
Specs
register_domain_response_status() :: binary()
Specs
remove_dispute_evidence_request() :: %{}
Specs
remove_dispute_evidence_response() :: %{optional(:errors) => [error()]}
Specs
remove_group_from_customer_request() :: %{}
Specs
remove_group_from_customer_response() :: %{optional(:errors) => [error()]}
Specs
renew_token_request() :: %{optional(:access_token) => binary()}
Specs
Specs
retrieve_cash_drawer_shift_request() :: %{location_id: binary()}
Specs
retrieve_cash_drawer_shift_response() :: %{ optional(:cash_drawer_shift) => cash_drawer_shift(), optional(:errors) => [error()] }
Specs
retrieve_catalog_object_request() :: %{ optional(:include_related_objects) => boolean() }
Specs
retrieve_catalog_object_response() :: %{ optional(:errors) => [error()], optional(:object) => catalog_object(), optional(:related_objects) => [catalog_object()] }
Specs
retrieve_customer_group_request() :: %{}
Specs
retrieve_customer_group_response() :: %{ optional(:errors) => [error()], optional(:group) => customer_group() }
Specs
retrieve_customer_request() :: %{}
Specs
Specs
retrieve_customer_segment_request() :: %{}
Specs
retrieve_customer_segment_response() :: %{ optional(:errors) => [error()], optional(:segment) => customer_segment() }
Specs
retrieve_dispute_evidence_request() :: %{}
Specs
retrieve_dispute_evidence_response() :: %{ optional(:errors) => [error()], optional(:evidence) => dispute_evidence() }
Specs
retrieve_dispute_request() :: %{}
Specs
Specs
retrieve_employee_request() :: %{}
Specs
Specs
retrieve_inventory_adjustment_request() :: %{}
Specs
retrieve_inventory_adjustment_response() :: %{ optional(:adjustment) => inventory_adjustment(), optional(:errors) => [error()] }
Specs
Specs
retrieve_inventory_changes_response() :: %{ optional(:changes) => [inventory_change()], optional(:cursor) => binary(), optional(:errors) => [error()] }
Specs
Specs
retrieve_inventory_count_response() :: %{ optional(:counts) => [inventory_count()], optional(:cursor) => binary(), optional(:errors) => [error()] }
Specs
retrieve_inventory_physical_count_request() :: %{}
Specs
retrieve_inventory_physical_count_response() :: %{ optional(:count) => inventory_physical_count(), optional(:errors) => [error()] }
Specs
retrieve_location_request() :: %{}
Specs
Specs
retrieve_loyalty_account_request() :: %{}
Specs
retrieve_loyalty_account_response() :: %{ optional(:errors) => [error()], optional(:loyalty_account) => loyalty_account() }
Specs
retrieve_loyalty_reward_request() :: %{}
Specs
retrieve_loyalty_reward_response() :: %{ optional(:errors) => [error()], optional(:reward) => loyalty_reward() }
Specs
retrieve_merchant_request() :: %{}
Specs
Specs
retrieve_subscription_request() :: %{}
Specs
retrieve_subscription_response() :: %{ optional(:errors) => [error()], optional(:subscription) => subscription() }
Specs
retrieve_team_member_request() :: %{}
Specs
retrieve_team_member_response() :: %{ optional(:errors) => [error()], optional(:team_member) => team_member() }
Specs
retrieve_transaction_request() :: %{}
Specs
retrieve_transaction_response() :: %{ optional(:errors) => [error()], optional(:transaction) => transaction() }
Specs
retrieve_wage_setting_request() :: %{}
Specs
retrieve_wage_setting_response() :: %{ optional(:errors) => [error()], optional(:wage_setting) => wage_setting() }
Specs
Specs
revoke_token_response() :: %{optional(:success) => boolean()}
Specs
search_catalog_items_request() :: %{ optional(:category_ids) => [binary()], optional(:cursor) => binary(), optional(:custom_attribute_filters) => [custom_attribute_filter()], optional(:enabled_location_ids) => [binary()], optional(:limit) => integer(), optional(:product_types) => [binary()], optional(:sort_order) => binary(), optional(:stock_levels) => [binary()], optional(:text_filter) => binary() }
Specs
search_catalog_items_request_stock_level() :: binary()
Specs
search_catalog_items_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:items) => [catalog_object()], optional(:matched_variation_ids) => [binary()] }
Specs
search_catalog_objects_request() :: %{ optional(:begin_time) => binary(), optional(:cursor) => binary(), optional(:include_deleted_objects) => boolean(), optional(:include_related_objects) => boolean(), optional(:limit) => integer(), optional(:object_types) => [binary()], optional(:query) => catalog_query() }
Specs
search_catalog_objects_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:latest_time) => binary(), optional(:objects) => [catalog_object()], optional(:related_objects) => [catalog_object()] }
Specs
search_customers_request() :: %{ optional(:cursor) => binary(), optional(:limit) => integer(), optional(:query) => customer_query() }
Specs
Specs
search_invoices_request() :: %{ optional(:cursor) => binary(), optional(:limit) => integer(), :query => invoice_query() }
Specs
Specs
search_loyalty_accounts_request() :: %{ optional(:cursor) => binary(), optional(:limit) => integer(), optional(:query) => search_loyalty_accounts_request_loyalty_account_query() }
Specs
search_loyalty_accounts_request_loyalty_account_query() :: %{ optional(:mappings) => [loyalty_account_mapping()] }
Specs
search_loyalty_accounts_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:loyalty_accounts) => [loyalty_account()] }
Specs
search_loyalty_events_request() :: %{ optional(:cursor) => binary(), optional(:limit) => integer(), optional(:query) => loyalty_event_query() }
Specs
search_loyalty_events_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:events) => [loyalty_event()] }
Specs
search_loyalty_rewards_request() :: %{ optional(:cursor) => binary(), optional(:limit) => integer(), optional(:query) => search_loyalty_rewards_request_loyalty_reward_query() }
Specs
Specs
search_loyalty_rewards_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:rewards) => [loyalty_reward()] }
Specs
search_orders_customer_filter() :: %{optional(:customer_ids) => [binary()]}
Specs
search_orders_date_time_filter() :: %{ optional(:closed_at) => time_range(), optional(:created_at) => time_range(), optional(:updated_at) => time_range() }
Specs
search_orders_filter() :: %{ optional(:customer_filter) => search_orders_customer_filter(), optional(:date_time_filter) => search_orders_date_time_filter(), optional(:fulfillment_filter) => search_orders_fulfillment_filter(), optional(:source_filter) => search_orders_source_filter(), optional(:state_filter) => search_orders_state_filter() }
Specs
Specs
search_orders_query() :: %{ optional(:filter) => search_orders_filter(), optional(:sort) => search_orders_sort() }
Specs
search_orders_request() :: %{ optional(:cursor) => binary(), optional(:limit) => integer(), optional(:location_ids) => [binary()], optional(:query) => search_orders_query(), optional(:return_entries) => boolean() }
Specs
search_orders_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:order_entries) => [order_entry()], optional(:orders) => [order()] }
Specs
Specs
search_orders_sort_field() :: binary()
Specs
search_orders_source_filter() :: %{optional(:source_names) => [binary()]}
Specs
search_orders_state_filter() :: %{states: [binary()]}
Specs
search_shifts_request() :: %{ optional(:cursor) => binary(), optional(:limit) => integer(), optional(:query) => shift_query() }
Specs
Specs
Specs
search_subscriptions_query() :: %{ optional(:filter) => search_subscriptions_filter() }
Specs
search_subscriptions_request() :: %{ optional(:cursor) => binary(), optional(:limit) => integer(), optional(:query) => search_subscriptions_query() }
Specs
search_subscriptions_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:subscriptions) => [subscription()] }
Specs
Specs
search_team_members_query() :: %{ optional(:filter) => search_team_members_filter() }
Specs
search_team_members_request() :: %{ optional(:cursor) => binary(), optional(:limit) => integer(), optional(:query) => search_team_members_query() }
Specs
search_team_members_response() :: %{ optional(:cursor) => binary(), optional(:errors) => [error()], optional(:team_members) => [team_member()] }
Specs
search_terminal_checkouts_request() :: %{ optional(:cursor) => binary(), optional(:limit) => integer(), optional(:query) => terminal_checkout_query() }
Specs
search_terminal_checkouts_response() :: %{ optional(:checkouts) => [terminal_checkout()], optional(:cursor) => binary(), optional(:errors) => [error()] }
Specs
shift() :: %{ optional(:breaks) => [break()], optional(:created_at) => binary(), optional(:employee_id) => binary(), optional(:end_at) => binary(), optional(:id) => binary(), optional(:location_id) => binary(), :start_at => binary(), optional(:status) => binary(), optional(:team_member_id) => binary(), optional(:timezone) => binary(), optional(:updated_at) => binary(), optional(:version) => integer(), optional(:wage) => shift_wage() }
Specs
shift_filter() :: %{ optional(:employee_ids) => [binary()], optional(:end) => time_range(), :location_ids => [binary()], optional(:start) => time_range(), optional(:status) => binary(), :team_member_ids => [binary()], optional(:workday) => shift_workday() }
Specs
shift_filter_status() :: binary()
Specs
shift_query() :: %{ optional(:filter) => shift_filter(), optional(:sort) => shift_sort() }
Specs
Specs
shift_sort_field() :: binary()
Specs
shift_status() :: binary()
Specs
Specs
shift_workday() :: %{ optional(:date_range) => date_range(), optional(:default_timezone) => binary(), optional(:match_shifts_by) => binary() }
Specs
shift_workday_matcher() :: binary()
Specs
sort_order() :: binary()
Specs
Specs
standard_unit_description() :: %{ optional(:abbreviation) => binary(), optional(:name) => binary(), optional(:unit) => measurement_unit() }
Specs
standard_unit_description_group() :: %{ optional(:language_code) => binary(), optional(:standard_unit_descriptions) => [standard_unit_description()] }
Specs
submit_evidence_request() :: %{}
Specs
Specs
subscription() :: %{ optional(:canceled_date) => binary(), optional(:card_id) => binary(), optional(:created_at) => binary(), optional(:customer_id) => binary(), optional(:id) => binary(), optional(:invoice_ids) => [binary()], optional(:location_id) => binary(), optional(:paid_until_date) => binary(), optional(:plan_id) => binary(), optional(:price_override_money) => money(), optional(:start_date) => binary(), optional(:status) => binary(), optional(:tax_percentage) => binary(), optional(:timezone) => binary(), optional(:version) => integer() }
Specs
subscription_cadence() :: binary()
Specs
Specs
subscription_event_subscription_event_type() :: binary()
Specs
Specs
subscription_status() :: binary()
Specs
tax_calculation_phase() :: binary()
Specs
tax_inclusion_type() :: binary()
Specs
team_member() :: %{ optional(:assigned_locations) => team_member_assigned_locations(), optional(:created_at) => binary(), optional(:email_address) => binary(), optional(:family_name) => binary(), optional(:given_name) => binary(), optional(:id) => binary(), optional(:is_owner) => boolean(), optional(:phone_number) => binary(), optional(:reference_id) => binary(), optional(:status) => binary(), optional(:updated_at) => binary() }
Specs
Specs
team_member_assigned_locations_assignment_type() :: binary()
Specs
team_member_status() :: binary()
Specs
Specs
tender() :: %{ optional(:additional_recipients) => [additional_recipient()], optional(:amount_money) => money(), optional(:bank_transfer_details) => tender_bank_transfer_details(), optional(:card_details) => tender_card_details(), optional(:cash_details) => tender_cash_details(), optional(:created_at) => binary(), optional(:customer_id) => binary(), optional(:id) => binary(), optional(:location_id) => binary(), optional(:note) => binary(), optional(:payment_id) => binary(), optional(:processing_fee_money) => money(), optional(:tip_money) => money(), optional(:transaction_id) => binary(), :type => binary() }
Specs
tender_bank_transfer_details() :: %{optional(:status) => binary()}
Specs
tender_bank_transfer_details_status() :: binary()
Specs
Specs
tender_card_details_entry_method() :: binary()
Specs
tender_card_details_status() :: binary()
Specs
Specs
tender_type() :: binary()
Specs
terminal_checkout() :: %{ :amount_money => money(), optional(:cancel_reason) => binary(), optional(:created_at) => binary(), optional(:deadline_duration) => binary(), :device_options => device_checkout_options(), optional(:id) => binary(), optional(:note) => binary(), optional(:payment_ids) => [binary()], optional(:reference_id) => binary(), optional(:status) => binary(), optional(:updated_at) => binary() }
Specs
terminal_checkout_query() :: %{ optional(:filter) => terminal_checkout_query_filter(), optional(:sort) => terminal_checkout_query_sort() }
Specs
terminal_checkout_query_filter() :: %{ optional(:created_at) => time_range(), optional(:device_id) => binary(), optional(:status) => binary() }
Specs
terminal_checkout_query_sort() :: %{optional(:sort_order) => binary()}
Specs
Specs
Specs
transaction() :: %{ optional(:client_id) => binary(), optional(:created_at) => binary(), optional(:id) => binary(), optional(:location_id) => binary(), optional(:order_id) => binary(), optional(:product) => binary(), optional(:reference_id) => binary(), optional(:refunds) => [refund()], optional(:shipping_address) => address(), optional(:tenders) => [tender()] }
Specs
transaction_product() :: binary()
Specs
transaction_type() :: binary()
Specs
update_break_type_request() :: %{break_type: break_type()}
Specs
update_break_type_response() :: %{ optional(:break_type) => break_type(), optional(:errors) => [error()] }
Specs
update_customer_group_request() :: %{group: customer_group()}
Specs
update_customer_group_response() :: %{ optional(:errors) => [error()], optional(:group) => customer_group() }
Specs
update_customer_request() :: %{ optional(:address) => address(), optional(:birthday) => binary(), optional(:company_name) => binary(), optional(:email_address) => binary(), optional(:family_name) => binary(), optional(:given_name) => binary(), optional(:nickname) => binary(), optional(:note) => binary(), optional(:phone_number) => binary(), optional(:reference_id) => binary() }
Specs
Specs
Specs
Specs
Specs
Specs
Specs
Specs
update_location_request() :: %{optional(:location) => location()}
Specs
Specs
Specs
Specs
update_shift_request() :: %{shift: shift()}
Specs
Specs
update_subscription_request() :: %{optional(:subscription) => subscription()}
Specs
update_subscription_response() :: %{ optional(:errors) => [error()], optional(:subscription) => subscription() }
Specs
update_team_member_request() :: %{optional(:team_member) => team_member()}
Specs
update_team_member_response() :: %{ optional(:errors) => [error()], optional(:team_member) => team_member() }
Specs
update_wage_setting_request() :: %{wage_setting: wage_setting()}
Specs
update_wage_setting_response() :: %{ optional(:errors) => [error()], optional(:wage_setting) => wage_setting() }
Specs
update_workweek_config_request() :: %{workweek_config: workweek_config()}
Specs
update_workweek_config_response() :: %{ optional(:errors) => [error()], optional(:workweek_config) => workweek_config() }
Specs
upsert_catalog_object_request() :: %{ idempotency_key: binary(), object: catalog_object() }
Specs
upsert_catalog_object_response() :: %{ optional(:catalog_object) => catalog_object(), optional(:errors) => [error()], optional(:id_mappings) => [catalog_id_mapping()] }
Specs
Specs
v1_adjust_inventory_request_adjustment_type() :: binary()
Specs
v1_apply_fee_request() :: %{}
Specs
v1_apply_modifier_list_request() :: %{}
Specs
v1_bank_account() :: %{ optional(:account_number_suffix) => binary(), optional(:bank_name) => binary(), optional(:currency_code) => binary(), optional(:id) => binary(), optional(:merchant_id) => binary(), optional(:name) => binary(), optional(:routing_number) => binary(), optional(:type) => binary() }
Specs
v1_bank_account_type() :: binary()
Specs
Specs
v1_cash_drawer_event_event_type() :: binary()
Specs
v1_cash_drawer_shift() :: %{ optional(:cash_paid_in_money) => v1_money(), optional(:cash_paid_out_money) => v1_money(), optional(:cash_payment_money) => v1_money(), optional(:cash_refunds_money) => v1_money(), optional(:closed_at) => binary(), optional(:closed_cash_money) => v1_money(), optional(:closing_employee_id) => binary(), optional(:description) => binary(), optional(:device) => device(), optional(:employee_ids) => [binary()], optional(:ended_at) => binary(), optional(:ending_employee_id) => binary(), optional(:event_type) => binary(), optional(:events) => [v1_cash_drawer_event()], optional(:expected_cash_money) => v1_money(), optional(:id) => binary(), optional(:opened_at) => binary(), optional(:opening_employee_id) => binary(), optional(:starting_cash_money) => v1_money() }
Specs
v1_cash_drawer_shift_event_type() :: binary()
Specs
Specs
v1_create_category_request() :: %{optional(:body) => v1_category()}
Specs
v1_create_discount_request() :: %{optional(:body) => v1_discount()}
Specs
v1_create_employee_role_request() :: %{ optional(:employee_role) => v1_employee_role() }
Specs
v1_create_fee_request() :: %{optional(:body) => v1_fee()}
Specs
v1_create_item_request() :: %{optional(:body) => v1_item()}
Specs
v1_create_modifier_list_request() :: %{optional(:body) => v1_modifier_list()}
Specs
v1_create_modifier_option_request() :: %{ optional(:body) => v1_modifier_option() }
Specs
v1_create_page_request() :: %{optional(:body) => v1_page()}
Specs
Specs
v1_create_refund_request_type() :: binary()
Specs
v1_create_variation_request() :: %{optional(:body) => v1_variation()}
Specs
v1_delete_category_request() :: %{}
Specs
v1_delete_discount_request() :: %{}
Specs
v1_delete_fee_request() :: %{}
Specs
v1_delete_item_request() :: %{}
Specs
v1_delete_modifier_list_request() :: %{}
Specs
v1_delete_modifier_option_request() :: %{}
Specs
Specs
v1_delete_page_request() :: %{}
Specs
v1_delete_timecard_request() :: %{}
Specs
v1_delete_timecard_response() :: %{}
Specs
v1_delete_variation_request() :: %{}
Specs
Specs
v1_discount_color() :: binary()
Specs
v1_discount_discount_type() :: binary()
Specs
v1_employee() :: %{ optional(:authorized_location_ids) => [binary()], optional(:created_at) => binary(), optional(:email) => binary(), optional(:external_id) => binary(), :first_name => binary(), optional(:id) => binary(), :last_name => binary(), optional(:role_ids) => [binary()], optional(:status) => binary(), optional(:updated_at) => binary() }
Specs
Specs
v1_employee_role_permissions() :: binary()
Specs
v1_employee_status() :: binary()
Specs
v1_fee() :: %{ optional(:adjustment_type) => binary(), optional(:applies_to_custom_amounts) => boolean(), optional(:calculation_phase) => binary(), optional(:enabled) => boolean(), optional(:id) => binary(), optional(:inclusion_type) => binary(), optional(:name) => binary(), optional(:rate) => binary(), optional(:type) => binary(), optional(:v2_id) => binary() }
Specs
v1_fee_adjustment_type() :: binary()
Specs
v1_fee_calculation_phase() :: binary()
Specs
v1_fee_inclusion_type() :: binary()
Specs
v1_fee_type() :: binary()
Specs
Specs
v1_item() :: %{ optional(:abbreviation) => binary(), optional(:available_for_pickup) => boolean(), optional(:available_online) => boolean(), optional(:category) => v1_category(), optional(:category_id) => binary(), optional(:color) => binary(), optional(:description) => binary(), optional(:fees) => [v1_fee()], optional(:id) => binary(), optional(:master_image) => v1_item_image(), optional(:modifier_lists) => [v1_modifier_list()], optional(:name) => binary(), optional(:taxable) => boolean(), optional(:type) => binary(), optional(:v2_id) => binary(), optional(:variations) => [v1_variation()], optional(:visibility) => binary() }
Specs
v1_item_color() :: binary()
Specs
Specs
v1_item_type() :: binary()
Specs
v1_item_visibility() :: binary()
Specs
v1_list_bank_accounts_request() :: %{}
Specs
v1_list_bank_accounts_response() :: %{optional(:items) => [v1_bank_account()]}
Specs
Specs
v1_list_cash_drawer_shifts_response() :: %{ optional(:items) => [v1_cash_drawer_shift()] }
Specs
v1_list_categories_request() :: %{}
Specs
v1_list_categories_response() :: %{optional(:items) => [v1_category()]}
Specs
v1_list_discounts_request() :: %{}
Specs
v1_list_discounts_response() :: %{optional(:items) => [v1_discount()]}
Specs
Specs
v1_list_employee_roles_response() :: %{optional(:items) => [v1_employee_role()]}
Specs
v1_list_employees_request() :: %{ optional(:batch_token) => binary(), optional(:begin_created_at) => binary(), optional(:begin_updated_at) => binary(), optional(:end_created_at) => binary(), optional(:end_updated_at) => binary(), optional(:external_id) => binary(), optional(:limit) => integer(), optional(:order) => binary(), optional(:status) => binary() }
Specs
v1_list_employees_request_status() :: binary()
Specs
v1_list_employees_response() :: %{optional(:items) => [v1_employee()]}
Specs
v1_list_fees_request() :: %{}
Specs
v1_list_fees_response() :: %{optional(:items) => [v1_fee()]}
Specs
Specs
v1_list_inventory_response() :: %{optional(:items) => [v1_inventory_entry()]}
Specs
v1_list_items_request() :: %{optional(:batch_token) => binary()}
Specs
v1_list_items_response() :: %{optional(:items) => [v1_item()]}
Specs
v1_list_locations_request() :: %{}
Specs
v1_list_locations_response() :: %{optional(:items) => [v1_merchant()]}
Specs
v1_list_modifier_lists_request() :: %{}
Specs
v1_list_modifier_lists_response() :: %{optional(:items) => [v1_modifier_list()]}
Specs
Specs
v1_list_orders_response() :: %{optional(:items) => [v1_order()]}
Specs
v1_list_pages_request() :: %{}
Specs
v1_list_pages_response() :: %{optional(:items) => [v1_page()]}
Specs
Specs
v1_list_payments_response() :: %{optional(:items) => [v1_payment()]}
Specs
Specs
v1_list_refunds_response() :: %{optional(:items) => [v1_refund()]}
Specs
Specs
v1_list_settlements_request_status() :: binary()
Specs
v1_list_settlements_response() :: %{optional(:items) => [v1_settlement()]}
Specs
v1_list_timecard_events_request() :: %{}
Specs
v1_list_timecard_events_response() :: %{ optional(:items) => [v1_timecard_event()] }
Specs
v1_list_timecards_request() :: %{ optional(:batch_token) => binary(), optional(:begin_clockin_time) => binary(), optional(:begin_clockout_time) => binary(), optional(:begin_updated_at) => binary(), optional(:deleted) => boolean(), optional(:employee_id) => binary(), optional(:end_clockin_time) => binary(), optional(:end_clockout_time) => binary(), optional(:end_updated_at) => binary(), optional(:limit) => integer(), optional(:order) => binary() }
Specs
v1_list_timecards_response() :: %{optional(:items) => [v1_timecard()]}
Specs
v1_merchant() :: %{ optional(:account_capabilities) => [binary()], optional(:account_type) => binary(), optional(:business_address) => address(), optional(:business_name) => binary(), optional(:business_phone) => v1_phone_number(), optional(:business_type) => binary(), optional(:country_code) => binary(), optional(:currency_code) => binary(), optional(:email) => binary(), optional(:id) => binary(), optional(:language_code) => binary(), optional(:location_details) => v1_merchant_location_details(), optional(:market_url) => binary(), optional(:name) => binary(), optional(:shipping_address) => address() }
Specs
v1_merchant_account_type() :: binary()
Specs
v1_merchant_business_type() :: binary()
Specs
v1_merchant_location_details() :: %{optional(:nickname) => binary()}
Specs
v1_modifier_list() :: %{ optional(:id) => binary(), optional(:modifier_options) => [v1_modifier_option()], optional(:name) => binary(), optional(:selection_type) => binary(), optional(:v2_id) => binary() }
Specs
v1_modifier_list_selection_type() :: binary()
Specs
Specs
Specs
v1_order() :: %{ optional(:btc_price_satoshi) => number(), optional(:btc_receive_address) => binary(), optional(:buyer_email) => binary(), optional(:buyer_note) => binary(), optional(:canceled_note) => binary(), optional(:completed_note) => binary(), optional(:created_at) => binary(), optional(:errors) => [error()], optional(:expires_at) => binary(), optional(:id) => binary(), optional(:order_history) => [v1_order_history_entry()], optional(:payment_id) => binary(), optional(:promo_code) => binary(), optional(:recipient_name) => binary(), optional(:recipient_phone_number) => binary(), optional(:refunded_note) => binary(), optional(:shipping_address) => address(), optional(:state) => binary(), optional(:subtotal_money) => v1_money(), optional(:tender) => v1_tender(), optional(:total_discount_money) => v1_money(), optional(:total_price_money) => v1_money(), optional(:total_shipping_money) => v1_money(), optional(:total_tax_money) => v1_money(), optional(:updated_at) => binary() }
Specs
Specs
v1_order_history_entry_action() :: binary()
Specs
v1_order_state() :: binary()
Specs
v1_page() :: %{ optional(:cells) => [v1_page_cell()], optional(:id) => binary(), optional(:name) => binary(), optional(:page_index) => integer() }
Specs
Specs
v1_page_cell_object_type() :: binary()
Specs
v1_page_cell_placeholder_type() :: binary()
Specs
v1_payment() :: %{ optional(:additive_tax) => [v1_payment_tax()], optional(:additive_tax_money) => v1_money(), optional(:created_at) => binary(), optional(:creator_id) => binary(), optional(:device) => device(), optional(:discount_money) => v1_money(), optional(:gross_sales_money) => v1_money(), optional(:id) => binary(), optional(:inclusive_tax) => [v1_payment_tax()], optional(:inclusive_tax_money) => v1_money(), optional(:is_partial) => boolean(), optional(:itemizations) => [v1_payment_itemization()], optional(:merchant_id) => binary(), optional(:net_sales_money) => v1_money(), optional(:net_total_money) => v1_money(), optional(:payment_url) => binary(), optional(:processing_fee_money) => v1_money(), optional(:receipt_url) => binary(), optional(:refunded_money) => v1_money(), optional(:refunds) => [v1_refund()], optional(:surcharge_money) => v1_money(), optional(:surcharges) => [v1_payment_surcharge()], optional(:swedish_rounding_money) => v1_money(), optional(:tax_money) => v1_money(), optional(:tender) => [v1_tender()], optional(:tip_money) => v1_money(), optional(:total_collected_money) => v1_money() }
Specs
Specs
Specs
v1_payment_itemization() :: %{ optional(:discount_money) => v1_money(), optional(:discounts) => [v1_payment_discount()], optional(:gross_sales_money) => v1_money(), optional(:item_detail) => v1_payment_item_detail(), optional(:item_variation_name) => binary(), optional(:itemization_type) => binary(), optional(:modifiers) => [v1_payment_modifier()], optional(:name) => binary(), optional(:net_sales_money) => v1_money(), optional(:notes) => binary(), optional(:quantity) => number(), optional(:single_quantity_money) => v1_money(), optional(:taxes) => [v1_payment_tax()], optional(:total_money) => v1_money() }
Specs
v1_payment_itemization_itemization_type() :: binary()
Specs
Specs
v1_payment_surcharge() :: %{ optional(:amount_money) => v1_money(), optional(:applied_money) => v1_money(), optional(:name) => binary(), optional(:rate) => binary(), optional(:surcharge_id) => binary(), optional(:taxable) => boolean(), optional(:taxes) => [v1_payment_tax()], optional(:type) => binary() }
Specs
v1_payment_surcharge_type() :: binary()
Specs
Specs
v1_payment_tax_inclusion_type() :: binary()
Specs
Specs
v1_refund() :: %{ optional(:created_at) => binary(), optional(:is_exchange) => boolean(), optional(:merchant_id) => binary(), optional(:payment_id) => binary(), optional(:processed_at) => binary(), optional(:reason) => binary(), optional(:refunded_additive_tax) => [v1_payment_tax()], optional(:refunded_additive_tax_money) => v1_money(), optional(:refunded_discount_money) => v1_money(), optional(:refunded_inclusive_tax) => [v1_payment_tax()], optional(:refunded_inclusive_tax_money) => v1_money(), optional(:refunded_money) => v1_money(), optional(:refunded_processing_fee_money) => v1_money(), optional(:refunded_surcharge_money) => v1_money(), optional(:refunded_surcharges) => [v1_payment_surcharge()], optional(:refunded_tax_money) => v1_money(), optional(:refunded_tip_money) => v1_money(), optional(:type) => binary() }
Specs
v1_refund_type() :: binary()
Specs
v1_remove_fee_request() :: %{}
Specs
v1_remove_modifier_list_request() :: %{}
Specs
v1_retrieve_bank_account_request() :: %{}
Specs
v1_retrieve_business_request() :: %{}
Specs
v1_retrieve_cash_drawer_shift_request() :: %{}
Specs
v1_retrieve_employee_request() :: %{}
Specs
v1_retrieve_employee_role_request() :: %{}
Specs
v1_retrieve_item_request() :: %{}
Specs
v1_retrieve_modifier_list_request() :: %{}
Specs
v1_retrieve_order_request() :: %{}
Specs
v1_retrieve_payment_request() :: %{}
Specs
v1_retrieve_settlement_request() :: %{}
Specs
v1_retrieve_timecard_request() :: %{}
Specs
Specs
Specs
v1_settlement_entry_type() :: binary()
Specs
v1_settlement_status() :: binary()
Specs
v1_tender() :: %{ optional(:card_brand) => binary(), optional(:change_back_money) => v1_money(), optional(:employee_id) => binary(), optional(:entry_method) => binary(), optional(:id) => binary(), optional(:is_exchange) => boolean(), optional(:name) => binary(), optional(:pan_suffix) => binary(), optional(:payment_note) => binary(), optional(:receipt_url) => binary(), optional(:refunded_money) => v1_money(), optional(:settled_at) => binary(), optional(:tendered_at) => binary(), optional(:tendered_money) => v1_money(), optional(:total_money) => v1_money(), optional(:type) => binary() }
Specs
v1_tender_card_brand() :: binary()
Specs
v1_tender_entry_method() :: binary()
Specs
v1_tender_type() :: binary()
Specs
v1_timecard() :: %{ optional(:clockin_location_id) => binary(), optional(:clockin_time) => binary(), optional(:clockout_location_id) => binary(), optional(:clockout_time) => binary(), optional(:created_at) => binary(), optional(:deleted) => boolean(), optional(:doubletime_seconds_worked) => number(), :employee_id => binary(), optional(:id) => binary(), optional(:overtime_seconds_worked) => number(), optional(:regular_seconds_worked) => number(), optional(:updated_at) => binary() }
Specs
Specs
v1_timecard_event_event_type() :: binary()
Specs
v1_update_category_request() :: %{body: v1_category()}
Specs
v1_update_discount_request() :: %{body: v1_discount()}
Specs
v1_update_employee_request() :: %{body: v1_employee()}
Specs
v1_update_employee_role_request() :: %{body: v1_employee_role()}
Specs
v1_update_fee_request() :: %{body: v1_fee()}
Specs
v1_update_item_request() :: %{body: v1_item()}
Specs
Specs
v1_update_modifier_list_request_selection_type() :: binary()
Specs
v1_update_modifier_option_request() :: %{body: v1_modifier_option()}
Specs
Specs
v1_update_order_request_action() :: binary()
Specs
v1_update_page_cell_request() :: %{body: v1_page_cell()}
Specs
v1_update_page_request() :: %{body: v1_page()}
Specs
v1_update_timecard_request() :: %{body: v1_timecard()}
Specs
v1_update_variation_request() :: %{body: v1_variation()}
Specs
v1_variation() :: %{ optional(:id) => binary(), optional(:inventory_alert_threshold) => integer(), optional(:inventory_alert_type) => binary(), optional(:item_id) => binary(), optional(:name) => binary(), optional(:ordinal) => integer(), optional(:price_money) => v1_money(), optional(:pricing_type) => binary(), optional(:sku) => binary(), optional(:track_inventory) => boolean(), optional(:user_data) => binary(), optional(:v2_id) => binary() }
Specs
v1_variation_inventory_alert_type() :: binary()
Specs
v1_variation_pricing_type() :: binary()
Specs
void_transaction_request() :: %{}
Specs
void_transaction_response() :: %{optional(:errors) => [error()]}
Specs
Specs
weekday() :: binary()