@flowio/api-internal-mock-generator 4.1.10 → 4.1.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -302,7 +302,7 @@
302
302
  "application" : {
303
303
  "key" : "common"
304
304
  },
305
- "version" : "0.9.9",
305
+ "version" : "0.9.10",
306
306
  "enums" : [ "attribute_data_type", "availability_status", "calendar", "capability", "change_type", "currency_label_formatter", "currency_symbol_format", "day_of_week", "delivered_duty", "discount_target", "environment", "exception_type", "goods_supply", "holiday_calendar", "included_levy_key", "incoterm", "input_specification_type", "margin_type", "measurement_system", "merchant_of_record", "order_merchant_of_record", "price_book_status", "role", "rounding_method", "rounding_type", "schedule_exception_status", "sort_direction", "unit_of_measurement", "unit_of_time", "user_status", "value_added_service", "visibility" ],
307
307
  "unions" : [ "discount_offer", "expandable_organization", "expandable_user", "input_specification_limitation", "price_source", "repeat_schedule" ],
308
308
  "models" : [ "address", "billing_address", "catalog_item_reference", "catalog_item_summary", "checkout_reference", "contact", "customer_invoice", "customer_reference", "datetime_range", "dimension", "dimensions", "discount_form", "discount_offer_fixed", "discount_offer_percent", "discounts_form", "duration", "exception", "experience_summary", "included_levies", "input_form", "input_form_specification", "input_specification", "input_specification_limitation_max", "input_specification_limitations", "item_reference", "line_item", "line_item_form", "margin", "measurement", "merchant_of_record_entity", "merchant_of_record_entity_registration", "money", "money_with_base", "money_with_optional_base", "name", "order_customer", "order_customer_form", "organization", "organization_defaults", "organization_reference", "organization_summary", "partner_reference", "price", "price_form", "price_source_catalog", "price_source_price_book", "price_source_price_book_reference", "price_source_provided", "price_with_base", "repeat_daily", "repeat_hourly", "repeat_monthly", "repeat_weekly", "rounding", "schedule", "session_reference", "user", "user_reference", "zone" ],
@@ -316,7 +316,7 @@
316
316
  "application" : {
317
317
  "key" : "error"
318
318
  },
319
- "version" : "0.9.4",
319
+ "version" : "0.9.10",
320
320
  "enums" : [ "generic_error_code" ],
321
321
  "unions" : [ ],
322
322
  "models" : [ "generic_error" ],
@@ -330,7 +330,7 @@
330
330
  "application" : {
331
331
  "key" : "permission"
332
332
  },
333
- "version" : "0.9.4",
333
+ "version" : "0.9.10",
334
334
  "enums" : [ "authentication_technique", "flow_addon_role", "flow_behavior", "flow_user_role", "permitted_http_method" ],
335
335
  "unions" : [ "flow_role" ],
336
336
  "models" : [ "behavior_audit", "permission_audit", "permission_check", "permission_error", "permitted_route", "route_audit", "simple_permission_check" ],
@@ -344,7 +344,7 @@
344
344
  "application" : {
345
345
  "key" : "price"
346
346
  },
347
- "version" : "0.9.4",
347
+ "version" : "0.9.10",
348
348
  "enums" : [ "levy_component", "levy_strategy", "price_accuracy", "price_detail_component_key", "price_detail_key", "pricing_levy_setting" ],
349
349
  "unions" : [ "deminimis" ],
350
350
  "models" : [ "currency_format", "deminimis_per_item", "deminimis_simple", "duty", "local_price_details", "price_book", "price_book_form", "price_book_item", "price_book_item_form", "price_book_item_query_form", "price_book_item_schedule", "price_book_reference", "price_check", "price_detail", "price_detail_component", "price_details", "price_equation", "pricing", "tax" ],
@@ -2948,7 +2948,7 @@
2948
2948
  "application" : {
2949
2949
  "key" : "tracking-internal"
2950
2950
  },
2951
- "version" : "0.8.91",
2951
+ "version" : "0.8.92",
2952
2952
  "enums" : [ "crossdock_tracking_status" ],
2953
2953
  "unions" : [ "carrier_credentials" ],
2954
2954
  "models" : [ "dhl", "dhl_ecommerce", "fedex_crossborder", "landmark", "sf_express", "tracking_event", "tracking_request", "tracking_response", "ups" ],
@@ -2976,7 +2976,7 @@
2976
2976
  "application" : {
2977
2977
  "key" : "payment-internal"
2978
2978
  },
2979
- "version" : "0.8.91",
2979
+ "version" : "0.8.92",
2980
2980
  "enums" : [ "chargeback_payment_status", "chargeback_process_status", "http_method", "processor", "redirect_reason", "risk_check" ],
2981
2981
  "unions" : [ "authorization_payload", "internal_authorization_details", "internal_refund_form", "payment_account", "payment_account_form", "payment_redirect" ],
2982
2982
  "models" : [ "adyen_authentication_data_reference", "adyen_payment_details_form", "adyen_refund_form", "afterpay_authentication_data_reference", "apple_payment_token", "apple_payment_token_header", "authentication_form", "authorization_metadata", "authorization_parameters", "authorization_parameters_form", "bitpay_authentication_data_reference", "chargeback", "chargeback_version", "cipher", "cipher_form", "cipher_reference", "classic_payment_redirect_form", "encryption", "fiserv_authentication_data_reference", "internal_adyen_authorization_details", "internal_afterpay_authorization_details", "internal_bitpay_authorization_details", "internal_card_authorization_details", "internal_fiserv_authorization_details", "internal_paypal_authorization_details", "internal_redirect_authorization_details", "internal_stripe_authorization_details", "key", "key_reference", "online_authorization_completed", "passphrase", "passphrase_form", "passphrase_summary", "paypal_authentication_data", "paypal_authentication_data_reference", "paypal_authorization_payload", "redirect", "stripe_account", "stripe_account_form", "stripe_authentication_data_reference", "tribe" ],
@@ -2990,7 +2990,7 @@
2990
2990
  "application" : {
2991
2991
  "key" : "ratecard-internal"
2992
2992
  },
2993
- "version" : "0.8.91",
2993
+ "version" : "0.8.92",
2994
2994
  "enums" : [ ],
2995
2995
  "unions" : [ ],
2996
2996
  "models" : [ "rate_with_fees", "ratecard_lane_aggregate", "ratecard_standard_configuration", "ratecard_standard_configuration_form", "ratecard_standard_settings", "ratecard_summary" ],
@@ -3032,7 +3032,7 @@
3032
3032
  "application" : {
3033
3033
  "key" : "currency-internal"
3034
3034
  },
3035
- "version" : "0.8.91",
3035
+ "version" : "0.8.92",
3036
3036
  "enums" : [ "rate_source" ],
3037
3037
  "unions" : [ ],
3038
3038
  "models" : [ "flow_currency_setting", "flow_currency_setting_form", "flow_currency_setting_version", "organization_currency_settings", "rate", "rate_data", "rate_data_v3", "spot_rate", "spot_rate_version" ],
@@ -3088,7 +3088,7 @@
3088
3088
  "application" : {
3089
3089
  "key" : "checkout-configuration"
3090
3090
  },
3091
- "version" : "0.8.91",
3091
+ "version" : "0.8.92",
3092
3092
  "enums" : [ "checkout_asset_type", "checkout_prompt_behavior", "checkout_shipping_method_prompt_behavior", "checkout_url_type", "google_analytics_plugin" ],
3093
3093
  "unions" : [ "tracker" ],
3094
3094
  "models" : [ "checkout_analytics", "checkout_asset", "checkout_behavior", "checkout_behavior_customer_info", "checkout_behavior_customer_info_email", "checkout_behavior_shipping_address", "checkout_behavior_shipping_method", "checkout_configuration", "checkout_configuration_form", "checkout_configuration_reference", "checkout_settings", "checkout_url", "facebook_pixel", "google_analytics", "google_global_site_tag", "google_tag_manager", "snapchat_pixel" ],
@@ -3102,7 +3102,7 @@
3102
3102
  "application" : {
3103
3103
  "key" : "experiment-internal"
3104
3104
  },
3105
- "version" : "0.8.91",
3105
+ "version" : "0.8.92",
3106
3106
  "enums" : [ "experiment_discriminator_key", "scope", "status", "timeseries_type" ],
3107
3107
  "unions" : [ "experiment", "variant", "variant_form" ],
3108
3108
  "models" : [ "experience_experiment", "experience_variant", "experience_variant_form", "experiment_form", "experiment_form_default", "experiment_form_default_discriminator", "experiment_form_default_discriminator_value", "experiment_form_default_variant", "experiment_results", "experiment_results_with_timestamp", "experiment_variant_summary", "experiment_version", "feature_experiment", "feature_variant", "feature_variant_form" ],
@@ -3186,7 +3186,7 @@
3186
3186
  "application" : {
3187
3187
  "key" : "label-internal"
3188
3188
  },
3189
- "version" : "0.8.91",
3189
+ "version" : "0.8.92",
3190
3190
  "enums" : [ "carrier_label_generation_method", "label_billing_strategy" ],
3191
3191
  "unions" : [ ],
3192
3192
  "models" : [ "carrier_account", "carrier_invoice", "flow_label_setting", "flow_label_setting_form" ],
@@ -3214,7 +3214,7 @@
3214
3214
  "application" : {
3215
3215
  "key" : "experience-internal"
3216
3216
  },
3217
- "version" : "0.8.91",
3217
+ "version" : "0.8.92",
3218
3218
  "enums" : [ "delivered_duty_option_message_type", "discount_request_order_entitlement_key", "experience_order_action", "experience_order_action_trigger", "order_attribute_intent", "price_selector" ],
3219
3219
  "unions" : [ "discount_request_offer_form" ],
3220
3220
  "models" : [ "allocation_item_reference", "delivered_duty_option", "delivered_duty_option_message", "delivered_duty_preference", "delivered_duty_preference_form", "discount_code", "discount_request_form", "discount_request_offer_fixed_amount_form", "discount_request_order_entitlement_form", "discount_request_order_form", "email_modification_form", "experience_order_action_rule", "gift_card", "gift_card_authorization_error", "gift_card_form", "gift_card_program", "internal_order", "item_filter_response", "item_filter_value_response", "item_filter_values_form", "item_query_response", "item_sales_margin", "item_sales_margin_post_form", "item_sales_margin_put_form", "item_sales_margin_version", "item_values_form", "loyalty_program", "loyalty_program_message", "loyalty_program_reward", "loyalty_program_rewards", "order_attribute", "order_payment_authorization", "order_service_change_csv_form", "organization_settings", "organization_settings_form" ],
@@ -3256,7 +3256,7 @@
3256
3256
  "application" : {
3257
3257
  "key" : "catalog-internal"
3258
3258
  },
3259
- "version" : "0.8.91",
3259
+ "version" : "0.8.92",
3260
3260
  "enums" : [ ],
3261
3261
  "unions" : [ "index_task_type" ],
3262
3262
  "models" : [ "catalog_item_batch_index_task", "catalog_item_delete_index_task", "catalog_item_index_task", "change_settings_index_task", "delete_index_task", "internal_item_form", "item_restriction", "item_restriction_post_form", "item_restriction_put_form", "item_restriction_version" ],
@@ -3298,7 +3298,7 @@
3298
3298
  "application" : {
3299
3299
  "key" : "feature"
3300
3300
  },
3301
- "version" : "0.8.91",
3301
+ "version" : "0.8.92",
3302
3302
  "enums" : [ "feature_scope", "feature_status", "feature_type" ],
3303
3303
  "unions" : [ "feature_default_value", "feature_rule", "feature_rule_form", "feature_value" ],
3304
3304
  "models" : [ "boolean_feature_default_value", "boolean_feature_rule", "boolean_feature_rule_form", "boolean_feature_value", "feature", "feature_context_form", "feature_form", "feature_geo_form", "feature_reference", "feature_release_form", "feature_status_form", "feature_value_form", "feature_value_result", "string_feature_default_value", "string_feature_rule", "string_feature_rule_form", "string_feature_value" ],
@@ -3326,7 +3326,7 @@
3326
3326
  "application" : {
3327
3327
  "key" : "item-dimension-estimate"
3328
3328
  },
3329
- "version" : "0.8.91",
3329
+ "version" : "0.8.92",
3330
3330
  "enums" : [ ],
3331
3331
  "unions" : [ ],
3332
3332
  "models" : [ "item_dimension_estimate" ],
@@ -3340,7 +3340,7 @@
3340
3340
  "application" : {
3341
3341
  "key" : "duty-internal"
3342
3342
  },
3343
- "version" : "0.8.91",
3343
+ "version" : "0.8.92",
3344
3344
  "enums" : [ "duty_compound_expression_type", "duty_rate_unit_of_measure", "duty_simple_expression_type" ],
3345
3345
  "unions" : [ "duty_expression" ],
3346
3346
  "models" : [ "duty_compound_expression", "duty_rate", "duty_raw", "duty_simple_expression" ],
@@ -3354,7 +3354,7 @@
3354
3354
  "application" : {
3355
3355
  "key" : "harmonization-internal"
3356
3356
  },
3357
- "version" : "0.8.91",
3357
+ "version" : "0.8.92",
3358
3358
  "enums" : [ "empty_attribute", "item_classification_action", "item_classification_status", "item_harmonization_status", "item_type", "unclassified_product_status" ],
3359
3359
  "unions" : [ "classification_judgement_form", "classification_label_attribute", "task_data" ],
3360
3360
  "models" : [ "allowed_labels", "attribute_label", "blacklisted_item", "classification_item", "classification_product", "classification_product_id", "classification_product_summary", "classification_product_summary_page", "classified_product", "customs", "customs_description_statistics", "customs_description_suggestion", "customs_description_tariff_code_duty", "customs_description_tariff_code_duty_form", "duties", "harmonization_countries", "harmonization_statistics", "harmonization_statistics_breakout", "harmonization_summary", "item_harmonization", "item_harmonization_summary", "label_aliases", "label_association", "label_taxonomy", "levies", "levies_address", "levies_form", "levies_item", "no_classification_form", "product_classification", "product_classification_form", "product_classification_judgement_form", "product_classification_result", "product_harmonization", "product_harmonization_form", "product_labels", "search_item_hs6_code", "supported_labels", "tariff_code_duty", "task_import", "task_item_upserted", "task_process_queued_event", "task_summarize_code", "unclassified_products_form", "unphrased_products_export", "vies_result" ],
@@ -3396,7 +3396,7 @@
3396
3396
  "application" : {
3397
3397
  "key" : "shopify-internal"
3398
3398
  },
3399
- "version" : "0.8.91",
3399
+ "version" : "0.8.92",
3400
3400
  "enums" : [ "flow_app", "shopify_check_inventory_error_code", "shopify_grant_status", "shopify_promotion_offer_allocation_method", "shopify_promotion_order_entitlement_component", "shopify_promotion_status" ],
3401
3401
  "unions" : [ "shopify_promotion_offer_discount", "shopify_promotion_offer_entitlement", "shopify_promotion_offer_max", "shopify_promotion_prerequisite" ],
3402
3402
  "models" : [ "complete_price_rule", "install_form", "order_submission_form", "shop", "shop_form", "shop_version", "shopify_check_inventory_error", "shopify_code_form", "shopify_experience_short_id", "shopify_gift_card_balance", "shopify_gift_card_balance_form", "shopify_gift_card_payment_form", "shopify_gift_card_redemption", "shopify_gift_card_redemption_form", "shopify_gift_card_reversal", "shopify_gift_card_reversal_form", "shopify_grants_check", "shopify_order_authorization", "shopify_order_content", "shopify_order_detail", "shopify_order_discount_content", "shopify_order_inventory_check", "shopify_order_line_attribute", "shopify_order_line_content", "shopify_payment_summary", "shopify_promo_form", "shopify_promotion", "shopify_promotion_attribute_value", "shopify_promotion_fixed_amount", "shopify_promotion_form", "shopify_promotion_item_entitlement", "shopify_promotion_item_prerequisite", "shopify_promotion_max_amount", "shopify_promotion_max_limit", "shopify_promotion_offer", "shopify_promotion_order_entitlement", "shopify_promotion_order_prerequisite", "shopify_promotion_percent", "shopify_promotion_rule", "shopify_webhook", "shopify_webhook_event", "shopify_webhook_form" ],
@@ -3410,7 +3410,7 @@
3410
3410
  "application" : {
3411
3411
  "key" : "content-internal"
3412
3412
  },
3413
- "version" : "0.8.91",
3413
+ "version" : "0.8.92",
3414
3414
  "enums" : [ "content_element_type", "content_status", "content_type", "content_type_cast", "format" ],
3415
3415
  "unions" : [ "content_item", "localizable_content", "validation_rule" ],
3416
3416
  "models" : [ "apm_content", "checkbox", "checkout_content_details", "checkout_content_summary", "checkout_marketing_content", "checkout_payment_content", "content_schema", "content_schema_element", "content_schema_form", "content_schema_summary", "dict", "href", "label", "labeled_content", "load", "localizable_content_reference", "localization", "localization_form", "localization_ref", "localized_content", "localized_content_element", "localized_content_form", "location", "logo", "validation_character_length" ],
@@ -3424,7 +3424,7 @@
3424
3424
  "application" : {
3425
3425
  "key" : "currency-internal"
3426
3426
  },
3427
- "version" : "0.8.91",
3427
+ "version" : "0.8.92",
3428
3428
  "enums" : [ "rate_source" ],
3429
3429
  "unions" : [ ],
3430
3430
  "models" : [ "flow_currency_setting", "flow_currency_setting_form", "flow_currency_setting_version", "organization_currency_settings", "rate", "rate_data", "rate_data_v3", "spot_rate", "spot_rate_version" ],
@@ -3452,7 +3452,7 @@
3452
3452
  "application" : {
3453
3453
  "key" : "issuer"
3454
3454
  },
3455
- "version" : "0.8.91",
3455
+ "version" : "0.8.92",
3456
3456
  "enums" : [ ],
3457
3457
  "unions" : [ ],
3458
3458
  "models" : [ "issuer" ],
@@ -3466,7 +3466,7 @@
3466
3466
  "application" : {
3467
3467
  "key" : "optin-internal"
3468
3468
  },
3469
- "version" : "0.8.91",
3469
+ "version" : "0.8.92",
3470
3470
  "enums" : [ "prompt_action", "prompt_checkout_display_position", "prompt_options", "prompt_target" ],
3471
3471
  "unions" : [ "optin_prompt_display" ],
3472
3472
  "models" : [ "consumer_optin_activity", "optin_attribute", "optin_attribute_form", "optin_prompt", "optin_prompt_checkout_display", "optin_prompt_copy", "optin_prompt_copy_form", "optin_prompt_form" ],
@@ -3480,7 +3480,7 @@
3480
3480
  "application" : {
3481
3481
  "key" : "duty-internal"
3482
3482
  },
3483
- "version" : "0.8.91",
3483
+ "version" : "0.8.92",
3484
3484
  "enums" : [ "duty_compound_expression_type", "duty_rate_unit_of_measure", "duty_simple_expression_type" ],
3485
3485
  "unions" : [ "duty_expression" ],
3486
3486
  "models" : [ "duty_compound_expression", "duty_rate", "duty_raw", "duty_simple_expression" ],
@@ -3494,7 +3494,7 @@
3494
3494
  "application" : {
3495
3495
  "key" : "billing-internal"
3496
3496
  },
3497
- "version" : "0.8.91",
3497
+ "version" : "0.8.92",
3498
3498
  "enums" : [ "billing_allocation_key", "processing_transaction_type", "responsible_party", "transfer_method" ],
3499
3499
  "unions" : [ "transaction" ],
3500
3500
  "models" : [ "account_put_form", "bank_payment", "bank_payment_form", "billing_allocation_breakout", "billing_authorization_reference", "billing_invoice_summary", "billing_order_destination", "billing_order_summary", "billing_organization_processing_rates", "billing_organization_settings", "billing_statement_pending_review", "billing_statement_review", "billing_statement_review_form", "components", "explicit_statement_date_form", "fee", "fees", "invoice_transaction", "manual_transaction", "manual_transaction_form", "master_transaction", "pending_bank_payment", "pending_bank_payment_detail", "processing_transaction", "subscription_transaction", "tax_remittance_transaction", "transaction_reference", "transfer_transaction", "virtual_card_transaction" ],
@@ -3508,7 +3508,7 @@
3508
3508
  "application" : {
3509
3509
  "key" : "billing"
3510
3510
  },
3511
- "version" : "0.8.91",
3511
+ "version" : "0.8.92",
3512
3512
  "enums" : [ "billing_statement_attachment_key", "billing_transaction_status", "billing_transaction_type", "subscription_frequency" ],
3513
3513
  "unions" : [ ],
3514
3514
  "models" : [ "account", "account_contact", "account_contact_form", "account_deposit_rule", "account_deposit_rule_form", "account_reference", "account_statistics", "billing_statement", "billing_statement_attachment", "billing_statement_reference", "billing_statement_totals", "billing_transaction", "email_form", "explicit_statement_date", "next_billing_statement", "subscription" ],
@@ -3522,7 +3522,7 @@
3522
3522
  "application" : {
3523
3523
  "key" : "fraud-internal"
3524
3524
  },
3525
- "version" : "0.8.91",
3525
+ "version" : "0.8.92",
3526
3526
  "enums" : [ "fraud_provider", "fraud_review_responsible_party", "risk_evaluation" ],
3527
3527
  "unions" : [ ],
3528
3528
  "models" : [ "decision", "fraud_pending_review", "fraud_review", "fraud_review_decision", "fraud_review_decision_form", "fraud_review_version", "notification" ],
@@ -3536,7 +3536,7 @@
3536
3536
  "application" : {
3537
3537
  "key" : "currency-internal"
3538
3538
  },
3539
- "version" : "0.8.91",
3539
+ "version" : "0.8.92",
3540
3540
  "enums" : [ "rate_source" ],
3541
3541
  "unions" : [ ],
3542
3542
  "models" : [ "flow_currency_setting", "flow_currency_setting_form", "flow_currency_setting_version", "organization_currency_settings", "rate", "rate_data", "rate_data_v3", "spot_rate", "spot_rate_version" ],
@@ -3550,7 +3550,7 @@
3550
3550
  "application" : {
3551
3551
  "key" : "fulfillment-internal"
3552
3552
  },
3553
- "version" : "0.8.91",
3553
+ "version" : "0.8.92",
3554
3554
  "enums" : [ ],
3555
3555
  "unions" : [ ],
3556
3556
  "models" : [ "center_query_builder", "fulfillment_experience_reference", "pregenerated_quote", "prioritized_center_reference" ],
@@ -3592,7 +3592,7 @@
3592
3592
  "application" : {
3593
3593
  "key" : "billing-internal"
3594
3594
  },
3595
- "version" : "0.8.91",
3595
+ "version" : "0.8.92",
3596
3596
  "enums" : [ "billing_allocation_key", "processing_transaction_type", "responsible_party", "transfer_method" ],
3597
3597
  "unions" : [ "transaction" ],
3598
3598
  "models" : [ "account_put_form", "bank_payment", "bank_payment_form", "billing_allocation_breakout", "billing_authorization_reference", "billing_invoice_summary", "billing_order_destination", "billing_order_summary", "billing_organization_processing_rates", "billing_organization_settings", "billing_statement_pending_review", "billing_statement_review", "billing_statement_review_form", "components", "explicit_statement_date_form", "fee", "fees", "invoice_transaction", "manual_transaction", "manual_transaction_form", "master_transaction", "pending_bank_payment", "pending_bank_payment_detail", "processing_transaction", "subscription_transaction", "tax_remittance_transaction", "transaction_reference", "transfer_transaction", "virtual_card_transaction" ],
@@ -3606,7 +3606,7 @@
3606
3606
  "application" : {
3607
3607
  "key" : "billing"
3608
3608
  },
3609
- "version" : "0.8.91",
3609
+ "version" : "0.8.92",
3610
3610
  "enums" : [ "billing_statement_attachment_key", "billing_transaction_status", "billing_transaction_type", "subscription_frequency" ],
3611
3611
  "unions" : [ ],
3612
3612
  "models" : [ "account", "account_contact", "account_contact_form", "account_deposit_rule", "account_deposit_rule_form", "account_reference", "account_statistics", "billing_statement", "billing_statement_attachment", "billing_statement_reference", "billing_statement_totals", "billing_transaction", "email_form", "explicit_statement_date", "next_billing_statement", "subscription" ],
@@ -4982,6 +4982,28 @@
4982
4982
  } ],
4983
4983
  "attributes" : [ ],
4984
4984
  "description" : "Strategy for billing client"
4985
+ }, {
4986
+ "name" : "liability_type",
4987
+ "plural" : "liability_types",
4988
+ "values" : [ {
4989
+ "name" : "full_value_tax",
4990
+ "attributes" : [ ],
4991
+ "description" : "Tax on full value of sale."
4992
+ }, {
4993
+ "name" : "low_value_goods_tax",
4994
+ "attributes" : [ ],
4995
+ "description" : "Tax on just the low value goods in a sale."
4996
+ }, {
4997
+ "name" : "high_value_goods_tax",
4998
+ "attributes" : [ ],
4999
+ "description" : "Tax on just the high value goods in a sale."
5000
+ }, {
5001
+ "name" : "duties",
5002
+ "attributes" : [ ],
5003
+ "description" : "Import duties on full value of sale"
5004
+ } ],
5005
+ "attributes" : [ ],
5006
+ "description" : "Describes the scope of liability."
4985
5007
  }, {
4986
5008
  "name" : "marketing_gateway_feed_download_format",
4987
5009
  "plural" : "marketing_gateway_feed_download_formats",
@@ -5134,6 +5156,62 @@
5134
5156
  "attributes" : [ ]
5135
5157
  } ],
5136
5158
  "attributes" : [ ]
5159
+ }, {
5160
+ "name" : "nature_of_sale",
5161
+ "plural" : "nature_of_sales",
5162
+ "values" : [ {
5163
+ "name" : "consumer",
5164
+ "attributes" : [ ],
5165
+ "description" : "Sale between Flow and a non-business entity"
5166
+ }, {
5167
+ "name" : "to_non_registered_business",
5168
+ "attributes" : [ ],
5169
+ "description" : "Sale between Flow and a suspected business entity for which we don't have a business registration"
5170
+ }, {
5171
+ "name" : "to_registered_business",
5172
+ "attributes" : [ ],
5173
+ "description" : "Sale between Flow and a registered business entity"
5174
+ }, {
5175
+ "name" : "flash_title",
5176
+ "attributes" : [ ],
5177
+ "description" : "Sale between Flow and a client"
5178
+ } ],
5179
+ "attributes" : [ ],
5180
+ "description" : "Describes the nature of the sale for which a liability is incurred."
5181
+ }, {
5182
+ "name" : "no_liability_reason_code",
5183
+ "plural" : "no_liability_reason_codes",
5184
+ "values" : [ {
5185
+ "name" : "zero_basis",
5186
+ "attributes" : [ ],
5187
+ "description" : "When all the applicable components of an item price were added up, the result was a $0 basis"
5188
+ }, {
5189
+ "name" : "zero_rate_on_goods",
5190
+ "attributes" : [ ],
5191
+ "description" : "A 0% rate is defined for items of this type (such as medical devices)"
5192
+ }, {
5193
+ "name" : "zero_rate_on_sale",
5194
+ "attributes" : [ ],
5195
+ "description" : "A 0% rate is defined for sales of this type (such as B2B sales)"
5196
+ }, {
5197
+ "name" : "basis_above_value_threshold",
5198
+ "attributes" : [ ],
5199
+ "description" : "For a low value good liability, goods with high value are paid via a different mechanism."
5200
+ }, {
5201
+ "name" : "basis_below_value_threshold",
5202
+ "attributes" : [ ],
5203
+ "description" : "For a low value good liability, goods with low value are paid via a different mechanism."
5204
+ }, {
5205
+ "name" : "order_below_de_minimis_threshold",
5206
+ "attributes" : [ ],
5207
+ "description" : "The order is below the de minimis threshold."
5208
+ }, {
5209
+ "name" : "total_amount_below_de_minimis_threshold",
5210
+ "attributes" : [ ],
5211
+ "description" : "The total amount is below the de minimis threshold."
5212
+ } ],
5213
+ "attributes" : [ ],
5214
+ "description" : "Describes the reason for a $0 liability amount."
5137
5215
  }, {
5138
5216
  "name" : "order_action",
5139
5217
  "plural" : "order_actions",
@@ -5443,6 +5521,28 @@
5443
5521
  } ],
5444
5522
  "attributes" : [ ],
5445
5523
  "description" : "An interval of time; used to roll-up the fidelity of time series graphs."
5524
+ }, {
5525
+ "name" : "reporting_scheme",
5526
+ "plural" : "reporting_schemes",
5527
+ "values" : [ {
5528
+ "name" : "immediate_reporting_to_tax_authority",
5529
+ "attributes" : [ ],
5530
+ "description" : "Liability will be recorded in a Consumer or B2B invoice and reported immediately via e-invoicing."
5531
+ }, {
5532
+ "name" : "periodic_reporting_to_tax_authority",
5533
+ "attributes" : [ ],
5534
+ "description" : "Liability will be recorded in a Consumer or B2B invoice and reported periodically via batch reports."
5535
+ }, {
5536
+ "name" : "paid_at_border",
5537
+ "attributes" : [ ],
5538
+ "description" : "Liability will be reported via a Commercial Invoice at the border."
5539
+ }, {
5540
+ "name" : "paid_on_delivery",
5541
+ "attributes" : [ ],
5542
+ "description" : "Liability will be reported via a Commercial Invoice at the border."
5543
+ } ],
5544
+ "attributes" : [ ],
5545
+ "description" : "Describes the mechanism by which a liability will be reported paid."
5446
5546
  }, {
5447
5547
  "name" : "responsible_party",
5448
5548
  "plural" : "responsible_parties",
@@ -5659,6 +5759,23 @@
5659
5759
  "description" : "Destination is located in a jurisdiction that can't be calculated by current logic or settings."
5660
5760
  } ],
5661
5761
  "attributes" : [ ]
5762
+ }, {
5763
+ "name" : "tax_party",
5764
+ "plural" : "tax_parties",
5765
+ "values" : [ {
5766
+ "name" : "consumer",
5767
+ "attributes" : [ ]
5768
+ }, {
5769
+ "name" : "organization",
5770
+ "attributes" : [ ]
5771
+ }, {
5772
+ "name" : "flow",
5773
+ "attributes" : [ ]
5774
+ }, {
5775
+ "name" : "carrier",
5776
+ "attributes" : [ ]
5777
+ } ],
5778
+ "attributes" : [ ]
5662
5779
  }, {
5663
5780
  "name" : "timeseries_type",
5664
5781
  "plural" : "timeseries_types",
@@ -18956,6 +19073,239 @@
18956
19073
  } ],
18957
19074
  "attributes" : [ ],
18958
19075
  "description" : "Item information to calculate levies."
19076
+ }, {
19077
+ "name" : "liability",
19078
+ "plural" : "liabilities",
19079
+ "fields" : [ {
19080
+ "name" : "delivery_key",
19081
+ "type" : "string",
19082
+ "required" : true,
19083
+ "attributes" : [ ],
19084
+ "annotations" : [ ]
19085
+ }, {
19086
+ "name" : "tax_jurisdiction",
19087
+ "type" : "string",
19088
+ "required" : true,
19089
+ "attributes" : [ ],
19090
+ "annotations" : [ ],
19091
+ "description" : "An ISO 3166-3 country code. Case insensitive. See https://api.flow.io/reference/countries",
19092
+ "example" : "IRL"
19093
+ }, {
19094
+ "name" : "liability_type",
19095
+ "type" : "liability_type",
19096
+ "required" : true,
19097
+ "attributes" : [ ],
19098
+ "annotations" : [ ],
19099
+ "description" : "Describes the scope of liability. Most useful for high and low value goods taxes."
19100
+ }, {
19101
+ "name" : "reporting_scheme",
19102
+ "type" : "reporting_scheme",
19103
+ "required" : true,
19104
+ "attributes" : [ ],
19105
+ "annotations" : [ ],
19106
+ "description" : "Describes the mechanism by which liabilities will be reported and paid."
19107
+ }, {
19108
+ "name" : "nature_of_sale",
19109
+ "type" : "nature_of_sale",
19110
+ "required" : true,
19111
+ "attributes" : [ ],
19112
+ "annotations" : [ ],
19113
+ "description" : "Describes the nature of the sale for which a liability is incurred."
19114
+ }, {
19115
+ "name" : "liable_party",
19116
+ "type" : "tax_party",
19117
+ "required" : true,
19118
+ "attributes" : [ ],
19119
+ "annotations" : [ ],
19120
+ "description" : "The party who is liable for the tax being remitted, such as the seller in a consumer sale or the buyer in a reverse charge sale."
19121
+ }, {
19122
+ "name" : "funding_party",
19123
+ "type" : "tax_party",
19124
+ "required" : true,
19125
+ "attributes" : [ ],
19126
+ "annotations" : [ ],
19127
+ "description" : "The party whose money will be used for this remittance, usually the consumer unless subsidies are in play"
19128
+ }, {
19129
+ "name" : "reporting_party",
19130
+ "type" : "tax_party",
19131
+ "required" : true,
19132
+ "attributes" : [ ],
19133
+ "annotations" : [ ],
19134
+ "description" : "The party that will report this liability to the proper tax jurisdiction"
19135
+ }, {
19136
+ "name" : "remitting_party",
19137
+ "type" : "tax_party",
19138
+ "required" : true,
19139
+ "attributes" : [ ],
19140
+ "annotations" : [ ],
19141
+ "description" : "The party that will be paying this liability."
19142
+ }, {
19143
+ "name" : "seller",
19144
+ "type" : "io.flow.common.v0.models.merchant_of_record_entity",
19145
+ "required" : true,
19146
+ "attributes" : [ ],
19147
+ "annotations" : [ ],
19148
+ "description" : "MoR Entity of Seller, including tax number"
19149
+ }, {
19150
+ "name" : "buyer",
19151
+ "type" : "io.flow.common.v0.models.merchant_of_record_entity",
19152
+ "required" : false,
19153
+ "attributes" : [ ],
19154
+ "annotations" : [ ],
19155
+ "description" : "MoR Entity of Buyer, if known"
19156
+ }, {
19157
+ "name" : "amount",
19158
+ "type" : "liability_money",
19159
+ "required" : true,
19160
+ "attributes" : [ ],
19161
+ "annotations" : [ ],
19162
+ "description" : "Amount of the liability in local, base and tax reporting currencies"
19163
+ }, {
19164
+ "name" : "rate",
19165
+ "type" : "decimal",
19166
+ "required" : true,
19167
+ "attributes" : [ ],
19168
+ "annotations" : [ ],
19169
+ "description" : "Amount / basis. This is not effective rate (which would be amount / total)."
19170
+ }, {
19171
+ "name" : "name",
19172
+ "type" : "string",
19173
+ "required" : true,
19174
+ "attributes" : [ ],
19175
+ "annotations" : [ ],
19176
+ "description" : "The name of a liability",
19177
+ "example" : "AUS Goods and Services Tax on Low Value Goods."
19178
+ }, {
19179
+ "name" : "basis",
19180
+ "type" : "liability_money",
19181
+ "required" : true,
19182
+ "attributes" : [ ],
19183
+ "annotations" : [ ],
19184
+ "description" : "Sum of basis of all liability items."
19185
+ }, {
19186
+ "name" : "items",
19187
+ "type" : "liability_item",
19188
+ "required" : true,
19189
+ "attributes" : [ ],
19190
+ "annotations" : [ ],
19191
+ "description" : "Ordered items that should be reported as part of this liability. Should include items in this delivery, even if they're untaxable. Should not include lines for other deliveries. May include a line for shipping; if so, it will be the final line in the collection."
19192
+ } ],
19193
+ "attributes" : [ ],
19194
+ "description" : "Describes all of the taxes and fees that should be paid or reported to third parties as a result of a Flow order. Will include taxes where no money is owed but documentation is required."
19195
+ }, {
19196
+ "name" : "liability_item",
19197
+ "plural" : "liability_items",
19198
+ "fields" : [ {
19199
+ "name" : "item_number",
19200
+ "type" : "string",
19201
+ "required" : false,
19202
+ "attributes" : [ ],
19203
+ "annotations" : [ ]
19204
+ }, {
19205
+ "name" : "line_number",
19206
+ "type" : "string",
19207
+ "required" : false,
19208
+ "attributes" : [ ],
19209
+ "annotations" : [ ]
19210
+ }, {
19211
+ "name" : "description",
19212
+ "type" : "string",
19213
+ "required" : true,
19214
+ "attributes" : [ ],
19215
+ "annotations" : [ ],
19216
+ "description" : "Description of this line to use for purposes of reporting liability."
19217
+ }, {
19218
+ "name" : "code",
19219
+ "type" : "string",
19220
+ "required" : false,
19221
+ "attributes" : [ ],
19222
+ "annotations" : [ ],
19223
+ "description" : "This is where an HS or tax code would go if one is available."
19224
+ }, {
19225
+ "name" : "amount",
19226
+ "type" : "liability_money",
19227
+ "required" : true,
19228
+ "attributes" : [ ],
19229
+ "annotations" : [ ],
19230
+ "description" : "Amount of tax"
19231
+ }, {
19232
+ "name" : "rate",
19233
+ "type" : "decimal",
19234
+ "required" : true,
19235
+ "attributes" : [ ],
19236
+ "annotations" : [ ],
19237
+ "description" : "Rate of the liability for this item. Will only be zero if tax never applies to an order; if an item is untaxable, we reduce its basis to $0 and keep the rate."
19238
+ }, {
19239
+ "name" : "basis",
19240
+ "type" : "liability_money",
19241
+ "required" : true,
19242
+ "attributes" : [ ],
19243
+ "annotations" : [ ],
19244
+ "description" : "Basis for tax amount"
19245
+ }, {
19246
+ "name" : "included_components",
19247
+ "type" : "[io.flow.price.v0.enums.levy_component]",
19248
+ "required" : true,
19249
+ "attributes" : [ ],
19250
+ "annotations" : [ ],
19251
+ "description" : "The components from which basis was calculated."
19252
+ }, {
19253
+ "name" : "no_liability_reason_code",
19254
+ "type" : "no_liability_reason_code",
19255
+ "required" : false,
19256
+ "attributes" : [ ],
19257
+ "annotations" : [ ],
19258
+ "description" : "If amount is 0, list the reason."
19259
+ } ],
19260
+ "attributes" : [ ],
19261
+ "description" : "Ordered items that should be reported as part of this liability. Should include items in this delivery, even if they're untaxable. Should not include lines for other deliveries. May include a line for shipping; if so, it will be the final line in the collection."
19262
+ }, {
19263
+ "name" : "liability_money",
19264
+ "plural" : "liability_moneys",
19265
+ "fields" : [ {
19266
+ "name" : "local",
19267
+ "type" : "io.flow.common.v0.models.money",
19268
+ "required" : true,
19269
+ "attributes" : [ ],
19270
+ "annotations" : [ ],
19271
+ "description" : "Local currency of the transaction this money relates to."
19272
+ }, {
19273
+ "name" : "base",
19274
+ "type" : "io.flow.common.v0.models.money",
19275
+ "required" : true,
19276
+ "attributes" : [ ],
19277
+ "annotations" : [ ],
19278
+ "description" : "Base currency of the transaction this money relates to."
19279
+ }, {
19280
+ "name" : "remittance",
19281
+ "type" : "io.flow.common.v0.models.money",
19282
+ "required" : true,
19283
+ "attributes" : [ ],
19284
+ "annotations" : [ ],
19285
+ "description" : "Currency of the jurisdiction to be paid."
19286
+ } ],
19287
+ "attributes" : [ ],
19288
+ "description" : "Describes a tax amount in three currencies: the local, base and that of the jurisdiction to be paid."
19289
+ }, {
19290
+ "name" : "liability_remittance_plan",
19291
+ "plural" : "liability_remittance_plans",
19292
+ "fields" : [ {
19293
+ "name" : "liabilities",
19294
+ "type" : "[liability]",
19295
+ "required" : true,
19296
+ "attributes" : [ ],
19297
+ "annotations" : [ ],
19298
+ "description" : "All of the liabilities Flow is responsible for as a result of this order."
19299
+ }, {
19300
+ "name" : "total_tax",
19301
+ "type" : "io.flow.common.v0.models.money_with_base",
19302
+ "required" : true,
19303
+ "attributes" : [ ],
19304
+ "annotations" : [ ],
19305
+ "description" : "Total tax to be paid to all tax authorities"
19306
+ } ],
19307
+ "attributes" : [ ],
19308
+ "description" : "Describes all of the taxes and fees that should be paid or reported to third parties as a result of a Flow order. Will include taxes where no money is owed but documentation is required."
18959
19309
  }, {
18960
19310
  "name" : "line_action_form",
18961
19311
  "plural" : "line_action_forms",
@@ -42974,6 +43324,178 @@
42974
43324
  }
42975
43325
  } ],
42976
43326
  "path" : "/:organization/harmonization/levies"
43327
+ }, {
43328
+ "type" : "liability_remittance_plan",
43329
+ "plural" : "liability_remittance_plans",
43330
+ "operations" : [ {
43331
+ "method" : "GET",
43332
+ "path" : "/:organization/liabilities",
43333
+ "parameters" : [ {
43334
+ "name" : "organization",
43335
+ "type" : "string",
43336
+ "location" : "Path",
43337
+ "required" : true,
43338
+ "description" : "Refers to your organization's account identifier"
43339
+ }, {
43340
+ "name" : "id",
43341
+ "type" : "[string]",
43342
+ "location" : "Query",
43343
+ "required" : false,
43344
+ "description" : "Filter by one or more IDs of this resource",
43345
+ "maximum" : 100
43346
+ }, {
43347
+ "name" : "order_number",
43348
+ "type" : "[string]",
43349
+ "location" : "Query",
43350
+ "required" : false,
43351
+ "maximum" : 100
43352
+ }, {
43353
+ "name" : "limit",
43354
+ "type" : "long",
43355
+ "location" : "Query",
43356
+ "required" : true,
43357
+ "description" : "The maximum number of results to return",
43358
+ "default" : "25",
43359
+ "minimum" : 1,
43360
+ "maximum" : 100
43361
+ }, {
43362
+ "name" : "offset",
43363
+ "type" : "long",
43364
+ "location" : "Query",
43365
+ "required" : true,
43366
+ "description" : "The number of results to skip before returning results",
43367
+ "default" : "0",
43368
+ "minimum" : 0
43369
+ }, {
43370
+ "name" : "sort",
43371
+ "type" : "string",
43372
+ "location" : "Query",
43373
+ "required" : true,
43374
+ "default" : "-created_at"
43375
+ } ],
43376
+ "responses" : [ {
43377
+ "code" : {
43378
+ "integer" : {
43379
+ "value" : 200
43380
+ }
43381
+ },
43382
+ "type" : "[liability_remittance_plan]",
43383
+ "description" : "Successful response",
43384
+ "attributes" : [ ]
43385
+ }, {
43386
+ "code" : {
43387
+ "integer" : {
43388
+ "value" : 401
43389
+ }
43390
+ },
43391
+ "type" : "unit",
43392
+ "description" : "Authorization failed",
43393
+ "attributes" : [ ]
43394
+ }, {
43395
+ "code" : {
43396
+ "integer" : {
43397
+ "value" : 403
43398
+ }
43399
+ },
43400
+ "type" : "io.flow.permission.v0.models.permission_error",
43401
+ "attributes" : [ ]
43402
+ }, {
43403
+ "code" : {
43404
+ "integer" : {
43405
+ "value" : 404
43406
+ }
43407
+ },
43408
+ "type" : "unit",
43409
+ "description" : "Resource was not found",
43410
+ "attributes" : [ ]
43411
+ } ],
43412
+ "attributes" : [ {
43413
+ "name" : "sort",
43414
+ "value" : {
43415
+ "values" : [ {
43416
+ "value" : "id"
43417
+ }, {
43418
+ "value" : "name"
43419
+ }, {
43420
+ "value" : "order_number"
43421
+ }, {
43422
+ "value" : "created_at"
43423
+ } ]
43424
+ }
43425
+ }, {
43426
+ "name" : "auth",
43427
+ "value" : {
43428
+ "techniques" : [ "user", "token" ],
43429
+ "roles" : [ "organization_admin", "organization_operations", "organization_fulfillment", "organization_marketing", "organization_finance" ]
43430
+ }
43431
+ } ]
43432
+ }, {
43433
+ "method" : "GET",
43434
+ "path" : "/:organization/liabilities/:order_number",
43435
+ "parameters" : [ {
43436
+ "name" : "organization",
43437
+ "type" : "string",
43438
+ "location" : "Path",
43439
+ "required" : true,
43440
+ "description" : "Refers to your organization's account identifier"
43441
+ }, {
43442
+ "name" : "order_number",
43443
+ "type" : "string",
43444
+ "location" : "Path",
43445
+ "required" : true
43446
+ } ],
43447
+ "responses" : [ {
43448
+ "code" : {
43449
+ "integer" : {
43450
+ "value" : 200
43451
+ }
43452
+ },
43453
+ "type" : "liability_remittance_plan",
43454
+ "description" : "Successful response",
43455
+ "attributes" : [ ]
43456
+ }, {
43457
+ "code" : {
43458
+ "integer" : {
43459
+ "value" : 401
43460
+ }
43461
+ },
43462
+ "type" : "unit",
43463
+ "description" : "Authorization failed",
43464
+ "attributes" : [ ]
43465
+ }, {
43466
+ "code" : {
43467
+ "integer" : {
43468
+ "value" : 403
43469
+ }
43470
+ },
43471
+ "type" : "io.flow.permission.v0.models.permission_error",
43472
+ "attributes" : [ ]
43473
+ }, {
43474
+ "code" : {
43475
+ "integer" : {
43476
+ "value" : 404
43477
+ }
43478
+ },
43479
+ "type" : "unit",
43480
+ "description" : "Resource was not found",
43481
+ "attributes" : [ ]
43482
+ } ],
43483
+ "attributes" : [ {
43484
+ "name" : "auth",
43485
+ "value" : {
43486
+ "techniques" : [ "user", "token" ],
43487
+ "roles" : [ "organization_admin", "organization_operations", "organization_fulfillment", "organization_marketing", "organization_finance" ]
43488
+ }
43489
+ } ]
43490
+ } ],
43491
+ "attributes" : [ {
43492
+ "name" : "docs",
43493
+ "value" : {
43494
+ "module" : "general"
43495
+ }
43496
+ } ],
43497
+ "path" : "/:organization/liabilities",
43498
+ "description" : "Describes all of the taxes and fees that should be paid or reported to third parties as a result of a Flow order. Will include taxes where no money is owed but documentation is required."
42977
43499
  }, {
42978
43500
  "type" : "localizable_content",
42979
43501
  "plural" : "localizable_contents",