{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/payments:taxamo/get-countries-dict":{"get":{"operationId":"payments_taxamo_get_countries_dict","summary":"Countries","description":"GET /api/v1/dictionaries/countries","tags":["payments"],"parameters":[{"name":"tax_supported","in":"query","required":false,"description":"Should only countries with tax supported be listed?","schema":{"type":"boolean","description":"Should only countries with tax supported be listed?"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-currencies-dict":{"get":{"operationId":"payments_taxamo_get_currencies_dict","summary":"Currencies","description":"GET /api/v1/dictionaries/currencies","tags":["payments"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-product-types-dict":{"get":{"operationId":"payments_taxamo_get_product_types_dict","summary":"Product types","description":"GET /api/v1/dictionaries/product_types","tags":["payments"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/locate-my-ip":{"get":{"operationId":"payments_taxamo_locate_my_ip","summary":"Locate IP","description":"GET /api/v1/geoip","tags":["payments"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/locate-given-ip":{"get":{"operationId":"payments_taxamo_locate_given_ip","summary":"Locate provided IP","description":"GET /api/v1/geoip/{ip}","tags":["payments"],"parameters":[{"name":"ip","in":"query","required":true,"description":"IP address.","schema":{"type":"string","description":"IP address."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-domestic-summary-report":{"get":{"operationId":"payments_taxamo_get_domestic_summary_report","summary":"Calculate domestic summary","description":"GET /api/v1/reports/domestic/summary","tags":["payments"],"parameters":[{"name":"format","in":"query","required":false,"description":"Output format. 'xml' and 'csv' values are accepted. Default format - json","schema":{"type":"string","description":"Output format. 'xml' and 'csv' values are accepted. Default format - json"}},{"name":"country_code","in":"query","required":true,"description":"ISO 2-letter country code which will be used for determining which country is domestic.","schema":{"type":"string","description":"ISO 2-letter country code which will be used for determining which country is domestic."}},{"name":"currency_code","in":"query","required":false,"description":"ISO 3-letter currency code, e.g. EUR or USD. Defaults to the one assigned to MOSS calculations for a given country code.","schema":{"type":"string","description":"ISO 3-letter currency code, e.g. EUR or USD. Defaults to the one assigned to MOSS calculations for a given country code."}},{"name":"start_month","in":"query","required":true,"description":"Period start month in yyyy-MM format.","schema":{"type":"string","description":"Period start month in yyyy-MM format."}},{"name":"end_month","in":"query","required":true,"description":"Period end month in yyyy-MM format.","schema":{"type":"string","description":"Period end month in yyyy-MM format."}},{"name":"fx_date_type","in":"query","required":false,"description":"Which date should be used for FX.","schema":{"type":"string","description":"Which date should be used for FX."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-eu-vies-report":{"get":{"operationId":"payments_taxamo_get_eu_vies_report","summary":"Calculate EU VIES report","description":"GET /api/v1/reports/eu/vies","tags":["payments"],"parameters":[{"name":"period_length","in":"query","required":false,"description":"Length of report period. 'month', 'quarter' and 'year' values are accepted. Required only if Large Filer Format is requested.","schema":{"type":"string","description":"Length of report period. 'month', 'quarter' and 'year' values are accepted. Required only if Large Filer Format is requested."}},{"name":"lff_sequence_number","in":"query","required":false,"description":"Sequence number used to generate report in Large Filer Format. If not specified then '0000000001' will be used.","schema":{"type":"string","description":"Sequence number used to generate report in Large Filer Format. If not specified then '0000000001' will be used."}},{"name":"transformation","in":"query","required":false,"description":"Which transformation should be applied. Please note that transformation will be applied only for xml and csv formats.","schema":{"type":"string","description":"Which transformation should be applied. Please note that transformation will be applied only for xml and csv formats."}},{"name":"currency_code","in":"query","required":false,"description":"ISO 3-letter currency code, e.g. EUR or USD. Defaults to the one assigned to MOSS calculations for a given country code.","schema":{"type":"string","description":"ISO 3-letter currency code, e.g. EUR or USD. Defaults to the one assigned to MOSS calculations for a given country code."}},{"name":"end_month","in":"query","required":true,"description":"Period end month in yyyy-MM format.","schema":{"type":"string","description":"Period end month in yyyy-MM format."}},{"name":"tax_id","in":"query","required":false,"description":"MOSS-assigned tax ID - if not provided, merchant's national tax number will be used.","schema":{"type":"string","description":"MOSS-assigned tax ID - if not provided, merchant's national tax number will be used."}},{"name":"start_month","in":"query","required":true,"description":"Period start month in yyyy-MM format.","schema":{"type":"string","description":"Period start month in yyyy-MM format."}},{"name":"eu_country_code","in":"query","required":true,"description":"ISO 2-letter country code which will be used for determining which country is domestic.","schema":{"type":"string","description":"ISO 2-letter country code which will be used for determining which country is domestic."}},{"name":"fx_date_type","in":"query","required":false,"description":"Which date should be used for FX.","schema":{"type":"string","description":"Which date should be used for FX."}},{"name":"format","in":"query","required":false,"description":"Output format. 'xml', 'csv' and 'lff' (only for Ireland) values are accepted as well","schema":{"type":"string","description":"Output format. 'xml', 'csv' and 'lff' (only for Ireland) values are accepted as well"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-detailed-refunds":{"get":{"operationId":"payments_taxamo_get_detailed_refunds","summary":"Detailed refunds","description":"GET /api/v1/settlement/detailed_refunds","tags":["payments"],"parameters":[{"name":"format","in":"query","required":false,"description":"Output format. 'json' or 'csv'. Default value is 'json'","schema":{"type":"string","description":"Output format. 'json' or 'csv'. Default value is 'json'"}},{"name":"country_codes","in":"query","required":false,"description":"Comma separated list of 2-letter country codes","schema":{"type":"string","description":"Comma separated list of 2-letter country codes"}},{"name":"date_from","in":"query","required":false,"description":"Take only refunds issued at or after the date. Format: yyyy-MM-dd","schema":{"type":"string","description":"Take only refunds issued at or after the date. Format: yyyy-MM-dd"}},{"name":"date_to","in":"query","required":false,"description":"Take only refunds issued at or before the date. Format: yyyy-MM-dd","schema":{"type":"string","description":"Take only refunds issued at or before the date. Format: yyyy-MM-dd"}},{"name":"limit","in":"query","required":false,"description":"Limit (no more than 1000, defaults to 100).","schema":{"type":"number","description":"Limit (no more than 1000, defaults to 100)."}},{"name":"offset","in":"query","required":false,"description":"Offset. Defaults to 0","schema":{"type":"number","description":"Offset. Defaults to 0"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-refunds":{"get":{"operationId":"payments_taxamo_get_refunds","summary":"Fetch refunds","description":"GET /api/v1/settlement/refunds","tags":["payments"],"parameters":[{"name":"format","in":"query","required":false,"description":"Output format. 'csv' value is accepted as well","schema":{"type":"string","description":"Output format. 'csv' value is accepted as well"}},{"name":"moss_country_code","in":"query","required":false,"description":"MOSS country code, used to determine currency. If ommited, merchant default setting is used.","schema":{"type":"string","description":"MOSS country code, used to determine currency. If ommited, merchant default setting is used."}},{"name":"tax_region","in":"query","required":false,"description":"Tax region key, defaults to EU for backwards compatibility.","schema":{"type":"string","description":"Tax region key, defaults to EU for backwards compatibility."}},{"name":"date_from","in":"query","required":true,"description":"Take only refunds issued at or after the date. Format: yyyy-MM-dd","schema":{"type":"string","description":"Take only refunds issued at or after the date. Format: yyyy-MM-dd"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-settlement-summary":{"get":{"operationId":"payments_taxamo_get_settlement_summary","summary":"Fetch summary","description":"GET /api/v1/settlement/summary/{quarter}","tags":["payments"],"parameters":[{"name":"moss_country_code","in":"query","required":false,"description":"MOSS country code, used to determine currency. If ommited, merchant default setting is used.","schema":{"type":"string","description":"MOSS country code, used to determine currency. If ommited, merchant default setting is used."}},{"name":"tax_region","in":"query","required":false,"description":"Tax region key","schema":{"type":"string","description":"Tax region key"}},{"name":"start_month","in":"query","required":false,"description":"Period start month in yyyy-MM format. Either quarter or start-month and end-month have to be provided.","schema":{"type":"string","description":"Period start month in yyyy-MM format. Either quarter or start-month and end-month have to be provided."}},{"name":"end_month","in":"query","required":false,"description":"Period end month in yyyy-MM format. Either quarter or start-month and end-month have to be provided.","schema":{"type":"string","description":"Period end month in yyyy-MM format. Either quarter or start-month and end-month have to be provided."}},{"name":"quarter","in":"query","required":true,"description":"Quarter in yyyy-MM format. If start-date and end-date are provided, quarter is ignored and should be set to 'range'.","schema":{"type":"string","description":"Quarter in yyyy-MM format. If start-date and end-date are provided, quarter is ignored and should be set to 'range'."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-settlement":{"get":{"operationId":"payments_taxamo_get_settlement","summary":"Fetch settlement","description":"GET /api/v1/settlement/{quarter}","tags":["payments"],"parameters":[{"name":"moss_tax_id","in":"query","required":false,"description":"MOSS-assigned tax ID - if not provided, merchant's national tax number will be used. Deprecated, please use tax-id.","schema":{"type":"string","description":"MOSS-assigned tax ID - if not provided, merchant's national tax number will be used. Deprecated, please use tax-id."}},{"name":"currency_code","in":"query","required":false,"description":"ISO 3-letter currency code, e.g. EUR or USD. If provided, all amounts will be coerced for this currency. Defaults to region's currency code.","schema":{"type":"string","description":"ISO 3-letter currency code, e.g. EUR or USD. If provided, all amounts will be coerced for this currency. Defaults to region's currency code."}},{"name":"end_month","in":"query","required":false,"description":"Period end month in yyyy-MM format. Either quarter or start-month and end-month have to be provided.","schema":{"type":"string","description":"Period end month in yyyy-MM format. Either quarter or start-month and end-month have to be provided."}},{"name":"tax_id","in":"query","required":false,"description":"MOSS-assigned tax ID - if not provided, merchant's national tax number will be used. Deprecated, please use tax-id.","schema":{"type":"string","description":"MOSS-assigned tax ID - if not provided, merchant's national tax number will be used. Deprecated, please use tax-id."}},{"name":"refund_date_kind_override","in":"query","required":false,"description":"Set to 'order_date' to show only refunds for the transactions in the selected reporting period. Set to 'refund_timestamp' to show refunds…","schema":{"type":"string","description":"Set to 'order_date' to show only refunds for the transactions in the selected reporting period. Set to 'refund_timestamp' to show refunds…"}},{"name":"start_month","in":"query","required":false,"description":"Period start month in yyyy-MM format. Either quarter or start-month and end-month have to be provided.","schema":{"type":"string","description":"Period start month in yyyy-MM format. Either quarter or start-month and end-month have to be provided."}},{"name":"moss_country_code","in":"query","required":false,"description":"MOSS country code, used to determine currency/region. If ommited, merchant default setting is used. Deprecated: please use tax-country-code.","schema":{"type":"string","description":"MOSS country code, used to determine currency/region. If ommited, merchant default setting is used. Deprecated: please use tax-country-code."}},{"name":"format","in":"query","required":false,"description":"Output format. 'csv' value is accepted as well","schema":{"type":"string","description":"Output format. 'csv' value is accepted as well"}},{"name":"tax_country_code","in":"query","required":false,"description":"Tax entity country code, used to determine currency/region.","schema":{"type":"string","description":"Tax entity country code, used to determine currency/region."}},{"name":"quarter","in":"query","required":true,"description":"Quarter in yyyy-MM format. If start-date and end-date are provided, quarter is ignored and should be set to 'range'.","schema":{"type":"string","description":"Quarter in yyyy-MM format. If start-date and end-date are provided, quarter is ignored and should be set to 'range'."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-settlement-stats-by-country":{"get":{"operationId":"payments_taxamo_get_settlement_stats_by_country","summary":"Settlement by country","description":"GET /api/v1/stats/settlement/by_country","tags":["payments"],"parameters":[{"name":"date_from","in":"query","required":true,"description":"Date from in yyyy-MM format.","schema":{"type":"string","description":"Date from in yyyy-MM format."}},{"name":"date_to","in":"query","required":true,"description":"Date to in yyyy-MM format.","schema":{"type":"string","description":"Date to in yyyy-MM format."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-settlement-stats-by-taxation-type":{"get":{"operationId":"payments_taxamo_get_settlement_stats_by_taxation_type","summary":"Settlement by tax type","description":"GET /api/v1/stats/settlement/by_taxation_type","tags":["payments"],"parameters":[{"name":"date_from","in":"query","required":true,"description":"Date from in yyyy-MM format.","schema":{"type":"string","description":"Date from in yyyy-MM format."}},{"name":"date_to","in":"query","required":true,"description":"Date to in yyyy-MM format.","schema":{"type":"string","description":"Date to in yyyy-MM format."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-daily-settlement-stats":{"get":{"operationId":"payments_taxamo_get_daily_settlement_stats","summary":"Settlement stats over time","description":"GET /api/v1/stats/settlement/daily","tags":["payments"],"parameters":[{"name":"interval","in":"query","required":true,"description":"Interval type - day, week, month.","schema":{"type":"string","description":"Interval type - day, week, month."}},{"name":"date_from","in":"query","required":true,"description":"Date from in yyyy-MM format.","schema":{"type":"string","description":"Date from in yyyy-MM format."}},{"name":"date_to","in":"query","required":true,"description":"Date to in yyyy-MM format.","schema":{"type":"string","description":"Date to in yyyy-MM format."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-transactions-stats":{"get":{"operationId":"payments_taxamo_get_transactions_stats","summary":"Transaction stats","description":"GET /api/v1/stats/transactions","tags":["payments"],"parameters":[{"name":"date_from","in":"query","required":true,"description":"Date from in yyyy-MM format.","schema":{"type":"string","description":"Date from in yyyy-MM format."}},{"name":"date_to","in":"query","required":true,"description":"Date to in yyyy-MM format.","schema":{"type":"string","description":"Date to in yyyy-MM format."}},{"name":"interval","in":"query","required":false,"description":"Interval. Accepted values are 'day', 'week' and 'month'.","schema":{"type":"string","description":"Interval. Accepted values are 'day', 'week' and 'month'."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-transactions-stats-by-country":{"get":{"operationId":"payments_taxamo_get_transactions_stats_by_country","summary":"Settlement by country","description":"GET /api/v1/stats/transactions/by_country","tags":["payments"],"parameters":[{"name":"global_currency_code","in":"query","required":false,"description":"Global currency code to use for conversion - in addition to country's currency if rate is available. Conversion is indicative and based on…","schema":{"type":"string","description":"Global currency code to use for conversion - in addition to country's currency if rate is available. Conversion is indicative and based on…"}},{"name":"date_from","in":"query","required":true,"description":"Date from in yyyy-MM format.","schema":{"type":"string","description":"Date from in yyyy-MM format."}},{"name":"date_to","in":"query","required":true,"description":"Date to in yyyy-MM format.","schema":{"type":"string","description":"Date to in yyyy-MM format."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/calculate-simple-tax":{"get":{"operationId":"payments_taxamo_calculate_simple_tax","summary":"Simple tax","description":"GET /api/v1/tax/calculate","tags":["payments"],"parameters":[{"name":"product_type","in":"query","required":false,"description":"Product type, according to dictionary /dictionaries/product_types.","schema":{"type":"string","description":"Product type, according to dictionary /dictionaries/product_types."}},{"name":"invoice_address_city","in":"query","required":false,"description":"Invoice address/postal_code","schema":{"type":"string","description":"Invoice address/postal_code"}},{"name":"buyer_credit_card_prefix","in":"query","required":false,"description":"First 6 digits of buyer's credit card prefix.","schema":{"type":"string","description":"First 6 digits of buyer's credit card prefix."}},{"name":"currency_code","in":"query","required":true,"description":"Currency code for transaction - e.g. EUR.","schema":{"type":"string","description":"Currency code for transaction - e.g. EUR."}},{"name":"invoice_address_region","in":"query","required":false,"description":"Invoice address/region","schema":{"type":"string","description":"Invoice address/region"}},{"name":"unit_price","in":"query","required":false,"description":"Unit price.","schema":{"type":"number","description":"Unit price."}},{"name":"quantity","in":"query","required":false,"description":"Quantity Defaults to 1.","schema":{"type":"number","description":"Quantity Defaults to 1."}},{"name":"buyer_tax_number","in":"query","required":false,"description":"Buyer's tax number - EU VAT number for example. If using EU VAT number, it is possible to provide country code in it (e.g. IE1234567X) or…","schema":{"type":"string","description":"Buyer's tax number - EU VAT number for example. If using EU VAT number, it is possible to provide country code in it (e.g. IE1234567X) or…"}},{"name":"force_country_code","in":"query","required":false,"description":"Two-letter ISO country code, e.g. FR. Use it to force country code for tax calculation.","schema":{"type":"string","description":"Two-letter ISO country code, e.g. FR. Use it to force country code for tax calculation."}},{"name":"order_date","in":"query","required":false,"description":"Order date in yyyy-MM-dd format, in merchant's timezone. If provided by the API caller, no timezone conversion is performed. Default value…","schema":{"type":"string","description":"Order date in yyyy-MM-dd format, in merchant's timezone. If provided by the API caller, no timezone conversion is performed. Default value…"}},{"name":"amount","in":"query","required":false,"description":"Amount. Required if total amount or both unit price and quantity are not provided.","schema":{"type":"number","description":"Amount. Required if total amount or both unit price and quantity are not provided."}},{"name":"billing_country_code","in":"query","required":false,"description":"Billing two letter ISO country code.","schema":{"type":"string","description":"Billing two letter ISO country code."}},{"name":"invoice_address_postal_code","in":"query","required":false,"description":"Invoice address/postal_code","schema":{"type":"string","description":"Invoice address/postal_code"}},{"name":"total_amount","in":"query","required":false,"description":"Total amount. Required if amount or both unit price and quantity are not provided.","schema":{"type":"number","description":"Total amount. Required if amount or both unit price and quantity are not provided."}},{"name":"tax_deducted","in":"query","required":false,"description":"If the transaction is in a country supported by Taxamo, but the tax is not calculated due to merchant settings or EU B2B transaction for…","schema":{"type":"boolean","description":"If the transaction is in a country supported by Taxamo, but the tax is not calculated due to merchant settings or EU B2B transaction for…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/calculate-tax":{"post":{"operationId":"payments_taxamo_calculate_tax","summary":"Calculate tax","description":"POST /api/v1/tax/calculate","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/calculate-tax-location":{"get":{"operationId":"payments_taxamo_calculate_tax_location","summary":"Calculate location","description":"GET /api/v1/tax/location/calculate","tags":["payments"],"parameters":[{"name":"billing_country_code","in":"query","required":false,"description":"Billing two letter ISO country code.","schema":{"type":"string","description":"Billing two letter ISO country code."}},{"name":"buyer_credit_card_prefix","in":"query","required":false,"description":"First 6 digits of buyer's credit card prefix.","schema":{"type":"string","description":"First 6 digits of buyer's credit card prefix."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/validate-tax-number":{"get":{"operationId":"payments_taxamo_validate_tax_number","summary":"Validate VAT number","description":"GET /api/v1/tax/vat_numbers/{tax_number}/validate","tags":["payments"],"parameters":[{"name":"country_code","in":"query","required":false,"description":"Two-letter ISO country code.","schema":{"type":"string","description":"Two-letter ISO country code."}},{"name":"tax_number","in":"query","required":true,"description":"Tax number","schema":{"type":"string","description":"Tax number"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/list-transactions":{"get":{"operationId":"payments_taxamo_list_transactions","summary":"Browse transactions","description":"GET /api/v1/transactions","tags":["payments"],"parameters":[{"name":"filter_text","in":"query","required":false,"description":"Filtering expression","schema":{"type":"string","description":"Filtering expression"}},{"name":"offset","in":"query","required":false,"description":"Offset","schema":{"type":"integer","description":"Offset"}},{"name":"has_note","in":"query","required":false,"description":"Return only transactions with a note field set.","schema":{"type":"boolean","description":"Return only transactions with a note field set."}},{"name":"key_or_custom_id","in":"query","required":false,"description":"Taxamo provided transaction key or custom id","schema":{"type":"string","description":"Taxamo provided transaction key or custom id"}},{"name":"currency_code","in":"query","required":false,"description":"Three letter ISO currency code.","schema":{"type":"string","description":"Three letter ISO currency code."}},{"name":"order_date_to","in":"query","required":false,"description":"Order date to in yyyy-MM-dd format.","schema":{"type":"string","description":"Order date to in yyyy-MM-dd format."}},{"name":"sort_reverse","in":"query","required":false,"description":"If true, results are sorted in descending order.","schema":{"type":"boolean","description":"If true, results are sorted in descending order."}},{"name":"limit","in":"query","required":false,"description":"Limit (no more than 1000, defaults to 100).","schema":{"type":"integer","description":"Limit (no more than 1000, defaults to 100)."}},{"name":"invoice_number","in":"query","required":false,"description":"Transaction invoice number.","schema":{"type":"string","description":"Transaction invoice number."}},{"name":"tax_country_codes","in":"query","required":false,"description":"Comma separated list of two letter ISO tax country codes.","schema":{"type":"string","description":"Comma separated list of two letter ISO tax country codes."}},{"name":"statuses","in":"query","required":false,"description":"Comma separated list of of transaction statuses. 'N' - unconfirmed transaction, 'C' - confirmed transaction.","schema":{"type":"string","description":"Comma separated list of of transaction statuses. 'N' - unconfirmed transaction, 'C' - confirmed transaction."}},{"name":"original_transaction_key","in":"query","required":false,"description":"Taxamo provided original transaction key","schema":{"type":"string","description":"Taxamo provided original transaction key"}},{"name":"order_date_from","in":"query","required":false,"description":"Order date from in yyyy-MM-dd format.","schema":{"type":"string","description":"Order date from in yyyy-MM-dd format."}},{"name":"total_amount_greater_than","in":"query","required":false,"description":"Return only transactions with total amount greater than given number. Transactions with total amount equal to a given number (e.g. 0) are…","schema":{"type":"string","description":"Return only transactions with total amount greater than given number. Transactions with total amount equal to a given number (e.g. 0) are…"}},{"name":"format","in":"query","required":false,"description":"Output format - supports 'csv' value for this operation.","schema":{"type":"string","description":"Output format - supports 'csv' value for this operation."}},{"name":"total_amount_less_than","in":"query","required":false,"description":"Return only transactions with total amount less than a given number. Transactions with total amount equal to a given number (e.g. 1) are…","schema":{"type":"string","description":"Return only transactions with total amount less than a given number. Transactions with total amount equal to a given number (e.g. 1) are…"}},{"name":"tax_country_code","in":"query","required":false,"description":"Two letter ISO tax country code.","schema":{"type":"string","description":"Two letter ISO tax country code."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/create-transaction":{"post":{"operationId":"payments_taxamo_create_transaction","summary":"Store transaction","description":"POST /api/v1/transactions","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/get-transaction":{"get":{"operationId":"payments_taxamo_get_transaction","summary":"Retrieve transaction data.","description":"GET /api/v1/transactions/{key}","tags":["payments"],"parameters":[{"name":"key","in":"query","required":true,"description":"Transaction key","schema":{"type":"string","description":"Transaction key"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/update-transaction":{"post":{"operationId":"payments_taxamo_update_transaction","summary":"Update transaction","description":"PUT /api/v1/transactions/{key}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","body"],"properties":{"key":{"type":"string","description":"Transaction key."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/cancel-transaction":{"post":{"operationId":"payments_taxamo_cancel_transaction","summary":"Delete transaction","description":"DELETE /api/v1/transactions/{key}","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"Transaction key"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/confirm-transaction":{"post":{"operationId":"payments_taxamo_confirm_transaction","summary":"Confirm transaction","description":"POST /api/v1/transactions/{key}/confirm","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","body"],"properties":{"key":{"type":"string","description":"Transaction key."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/email-refund":{"post":{"operationId":"payments_taxamo_email_refund","summary":"Email credit note","description":"POST /api/v1/transactions/{key}/invoice/refunds/{refund_note_number}/send_email","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","refund_note_number","body"],"properties":{"key":{"type":"string","description":"Transaction key."},"refund_note_number":{"type":"string","description":"Refund note id."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/email-invoice":{"post":{"operationId":"payments_taxamo_email_invoice","summary":"Email invoice","description":"POST /api/v1/transactions/{key}/invoice/send_email","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","body"],"properties":{"key":{"type":"string","description":"Transaction key."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/list-payments":{"get":{"operationId":"payments_taxamo_list_payments","summary":"List payments","description":"GET /api/v1/transactions/{key}/payments","tags":["payments"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Max record count (no more than 100, defaults to 10).","schema":{"type":"string","description":"Max record count (no more than 100, defaults to 10)."}},{"name":"offset","in":"query","required":false,"description":"How many records need to be skipped, defaults to 0.","schema":{"type":"string","description":"How many records need to be skipped, defaults to 0."}},{"name":"key","in":"query","required":true,"description":"Transaction key.","schema":{"type":"string","description":"Transaction key."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/create-payment":{"post":{"operationId":"payments_taxamo_create_payment","summary":"Register a payment","description":"POST /api/v1/transactions/{key}/payments","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","body"],"properties":{"key":{"type":"string","description":"Transaction key."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/capture-payment":{"post":{"operationId":"payments_taxamo_capture_payment","summary":"Capture payment","description":"POST /api/v1/transactions/{key}/payments/capture","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key"],"properties":{"key":{"type":"string","description":"Transaction key."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/list-refunds":{"get":{"operationId":"payments_taxamo_list_refunds","summary":"Get transaction refunds","description":"GET /api/v1/transactions/{key}/refunds","tags":["payments"],"parameters":[{"name":"key","in":"query","required":true,"description":"Transaction key.","schema":{"type":"string","description":"Transaction key."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/payments:taxamo/create-refund":{"post":{"operationId":"payments_taxamo_create_refund","summary":"Create a refund","description":"POST /api/v1/transactions/{key}/refunds","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","body"],"properties":{"key":{"type":"string","description":"Transaction key."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/unconfirm-transaction":{"post":{"operationId":"payments_taxamo_unconfirm_transaction","summary":"Un-confirm the transaction","description":"POST /api/v1/transactions/{key}/unconfirm","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["key","body"],"properties":{"key":{"type":"string","description":"Transaction key."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/create-smstoken":{"post":{"operationId":"payments_taxamo_create_smstoken","summary":"Create SMS token","description":"POST /api/v1/verification/sms","tags":["payments"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/payments:taxamo/verify-smstoken":{"get":{"operationId":"payments_taxamo_verify_smstoken","summary":"Verify SMS token","description":"GET /api/v1/verification/sms/{token}","tags":["payments"],"parameters":[{"name":"token","in":"query","required":true,"description":"Provided token.","schema":{"type":"string","description":"Provided token."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}