openapi-directory/api/taxamo.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Taxamo’s elegant suite of APIs and comprehensive reporting dashboard enables digital merchants to easily comply with EU regulatory requirements on tax calculation, evidence collection, tax return creation and data storage.","title":"Taxamo","version":"1","x-apisguru-categories":["payment"],"x-logo":{"url":"http://i.imgur.com/C7ouKJt.png"},"x-origin":[{"format":"swagger","url":"https://api.taxamo.com/swagger","version":"1.2"}],"x-providerName":"taxamo.com"},"tags":[{"description":"Dictionaries","name":"dictionaries"},{"description":"GeoIP","name":"geoip"},{"description":"Invoices","name":"invoices"},{"description":"Payments","name":"payments"},{"description":"Refunds","name":"refunds"},{"description":"Reporting","name":"reporting"},{"description":"Settlement","name":"settlement"},{"description":"Statistics","name":"statistics"},{"description":"Tax","name":"tax"},{"description":"Transactions","name":"transactions"},{"description":"Verification","name":"verification"}],"paths":{"/api/v1/dictionaries/countries":{"get":{"operationId":"getCountriesDict","parameters":[{"description":"Should only countries with tax supported be listed?","in":"query","name":"tax_supported","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getCountriesDictOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Countries","tags":["dictionaries"]}},"/api/v1/dictionaries/currencies":{"get":{"operationId":"getCurrenciesDict","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getCurrenciesDictOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Currencies","tags":["dictionaries"]}},"/api/v1/dictionaries/product_types":{"get":{"operationId":"getProductTypesDict","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getProductTypesDictOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Product types","tags":["dictionaries"]}},"/api/v1/geoip":{"get":{"operationId":"locateMyIP","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/locateMyIPOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Locate IP","tags":["geoip"]}},"/api/v1/geoip/{ip}":{"get":{"operationId":"locateGivenIP","parameters":[{"description":"IP address.","in":"path","name":"ip","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/locateGivenIPOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Locate provided IP","tags":["geoip"]}},"/api/v1/reports/domestic/summary":{"get":{"operationId":"getDomesticSummaryReport","parameters":[{"description":"Output format. 'xml' and 'csv' values are accepted. Default format - json","in":"query","name":"format","required":false,"schema":{"type":"string"}},{"description":"ISO 2-letter country code which will be used for determining which country is domestic.","in":"query","name":"country_code","required":true,"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.","in":"query","name":"currency_code","required":false,"schema":{"type":"string"}},{"description":"Period start month in yyyy-MM format.","in":"query","name":"start_month","required":true,"schema":{"type":"string"}},{"description":"Period end month in yyyy-MM format.","in":"query","name":"end_month","required":true,"schema":{"type":"string"}},{"description":"Which date should be used for FX.","in":"query","name":"fx_date_type","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getDomesticSummaryReportOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Calculate domestic summary","tags":["reporting"]}},"/api/v1/reports/eu/vies":{"get":{"operationId":"getEuViesReport","parameters":[{"description":"Length of report period. 'month', 'quarter' and 'year' values are accepted. Required only if Large Filer Format is requested.","in":"query","name":"period_length","required":false,"schema":{"type":"string"}},{"description":"Sequence number used to generate report in Large Filer Format. If not specified then '0000000001' will be used.","in":"query","name":"lff_sequence_number","required":false,"schema":{"type":"string"}},{"description":"Which transformation should be applied. Please note that transformation will be applied only for xml and csv formats.","in":"query","name":"transformation","required":false,"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.","in":"query","name":"currency_code","required":false,"schema":{"type":"string"}},{"description":"Period end month in yyyy-MM format.","in":"query","name":"end_month","required":true,"schema":{"type":"string"}},{"description":"MOSS-assigned tax ID - if not provided, merchant's national tax number will be used.","in":"query","name":"tax_id","required":false,"schema":{"type":"string"}},{"description":"Period start month in yyyy-MM format.","in":"query","name":"start_month","required":true,"schema":{"type":"string"}},{"description":"ISO 2-letter country code which will be used for determining which country is domestic.","in":"query","name":"eu_country_code","required":true,"schema":{"type":"string"}},{"description":"Which date should be used for FX.","in":"query","name":"fx_date_type","required":false,"schema":{"type":"string"}},{"description":"Output format. 'xml', 'csv' and 'lff' (only for Ireland) values are accepted as well","in":"query","name":"format","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getEuViesReportOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Calculate EU VIES report","tags":["reporting"]}},"/api/v1/settlement/detailed_refunds":{"get":{"operationId":"getDetailedRefunds","parameters":[{"description":"Output format. 'json' or 'csv'. Default value is 'json'","in":"query","name":"format","required":false,"schema":{"type":"string"}},{"description":"Comma separated list of 2-letter country codes","in":"query","name":"country_codes","required":false,"schema":{"type":"string"}},{"description":"Take only refunds issued at or after the date. Format: yyyy-MM-dd","in":"query","name":"date_from","required":false,"schema":{"type":"string"}},{"description":"Take only refunds issued at or before the date. Format: yyyy-MM-dd","in":"query","name":"date_to","required":false,"schema":{"type":"string"}},{"description":"Limit (no more than 1000, defaults to 100).","in":"query","name":"limit","required":false,"schema":{"type":"number"}},{"description":"Offset. Defaults to 0","in":"query","name":"offset","required":false,"schema":{"type":"number"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getDetailedRefundsOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Detailed refunds","tags":["settlement"]}},"/api/v1/settlement/refunds":{"get":{"operationId":"getRefunds","parameters":[{"description":"Output format. 'csv' value is accepted as well","in":"query","name":"format","required":false,"schema":{"type":"string"}},{"description":"MOSS country code, used to determine currency. If ommited, merchant default setting is used.","in":"query","name":"moss_country_code","required":false,"schema":{"type":"string"}},{"description":"Tax region key, defaults to EU for backwards compatibility.","in":"query","name":"tax_region","required":false,"schema":{"type":"string"}},{"description":"Take only refunds issued at or after the date. Format: yyyy-MM-dd","in":"query","name":"date_from","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getRefundsOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Fetch refunds","tags":["settlement"]}},"/api/v1/settlement/summary/{quarter}":{"get":{"operationId":"getSettlementSummary","parameters":[{"description":"MOSS country code, used to determine currency. If ommited, merchant default setting is used.","in":"query","name":"moss_country_code","required":false,"schema":{"type":"string"}},{"description":"Tax region key","in":"query","name":"tax_region","required":false,"schema":{"type":"string"}},{"description":"Period start month in yyyy-MM format. Either quarter or start-month and end-month have to be provided.","in":"query","name":"start_month","required":false,"schema":{"type":"string"}},{"description":"Period end month in yyyy-MM format. Either quarter or start-month and end-month have to be provided.","in":"query","name":"end_month","required":false,"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'.","in":"path","name":"quarter","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSettlementSummaryOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Fetch summary","tags":["settlement"]}},"/api/v1/settlement/{quarter}":{"get":{"operationId":"getSettlement","parameters":[{"description":"MOSS-assigned tax ID - if not provided, merchant's national tax number will be used. Deprecated, please use tax-id.","in":"query","name":"moss_tax_id","required":false,"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.","in":"query","name":"currency_code","required":false,"schema":{"type":"string"}},{"description":"Period end month in yyyy-MM format. Either quarter or start-month and end-month have to be provided.","in":"query","name":"end_month","required":false,"schema":{"type":"string"}},{"description":"MOSS-assigned tax ID - if not provided, merchant's national tax number will be used. Deprecated, please use tax-id.","in":"query","name":"tax_id","required":false,"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 that were created in the selected reporting period. Do not set to use the default region's setting.","in":"query","name":"refund_date_kind_override","required":false,"schema":{"type":"string"}},{"description":"Period start month in yyyy-MM format. Either quarter or start-month and end-month have to be provided.","in":"query","name":"start_month","required":false,"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.","in":"query","name":"moss_country_code","required":false,"schema":{"type":"string"}},{"description":"Output format. 'csv' value is accepted as well","in":"query","name":"format","required":false,"schema":{"type":"string"}},{"description":"Tax entity country code, used to determine currency/region. ","in":"query","name":"tax_country_code","required":false,"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'.","in":"path","name":"quarter","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSettlementOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Fetch settlement","tags":["settlement"]}},"/api/v1/stats/settlement/by_country":{"get":{"operationId":"getSettlementStatsByCountry","parameters":[{"description":"Date from in yyyy-MM format.","in":"query","name":"date_from","required":true,"schema":{"type":"string"}},{"description":"Date to in yyyy-MM format.","in":"query","name":"date_to","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSettlementStatsByCountryOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Settlement by country","tags":["statistics"]}},"/api/v1/stats/settlement/by_taxation_type":{"get":{"operationId":"getSettlementStatsByTaxationType","parameters":[{"description":"Date from in yyyy-MM format.","in":"query","name":"date_from","required":true,"schema":{"type":"string"}},{"description":"Date to in yyyy-MM format.","in":"query","name":"date_to","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getSettlementStatsByTaxationTypeOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Settlement by tax type","tags":["statistics"]}},"/api/v1/stats/settlement/daily":{"get":{"operationId":"getDailySettlementStats","parameters":[{"description":"Interval type - day, week, month.","in":"query","name":"interval","required":true,"schema":{"type":"string"}},{"description":"Date from in yyyy-MM format.","in":"query","name":"date_from","required":true,"schema":{"type":"string"}},{"description":"Date to in yyyy-MM format.","in":"query","name":"date_to","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getDailySettlementStatsOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Settlement stats over time","tags":["statistics"]}},"/api/v1/stats/transactions":{"get":{"operationId":"getTransactionsStats","parameters":[{"description":"Date from in yyyy-MM format.","in":"query","name":"date_from","required":true,"schema":{"type":"string"}},{"description":"Date to in yyyy-MM format.","in":"query","name":"date_to","required":true,"schema":{"type":"string"}},{"description":"Interval. Accepted values are 'day', 'week' and 'month'.","in":"query","name":"interval","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getTransactionsStatsOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Transaction stats","tags":["statistics"]}},"/api/v1/stats/transactions/by_country":{"get":{"operationId":"getTransactionsStatsByCountry","parameters":[{"description":"Global currency code to use for conversion - in addition to country's currency if rate is available. Conversion is indicative and based on most-recent rate from ECB.","in":"query","name":"global_currency_code","required":false,"schema":{"type":"string"}},{"description":"Date from in yyyy-MM format.","in":"query","name":"date_from","required":true,"schema":{"type":"string"}},{"description":"Date to in yyyy-MM format.","in":"query","name":"date_to","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getTransactionsStatsByCountryOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Settlement by country","tags":["statistics"]}},"/api/v1/tax/calculate":{"get":{"operationId":"calculateSimpleTax","parameters":[{"description":"Product type, according to dictionary /dictionaries/product_types. ","in":"query","name":"product_type","required":false,"schema":{"type":"string"}},{"description":"Invoice address/postal_code","in":"query","name":"invoice_address_city","required":false,"schema":{"type":"string"}},{"description":"First 6 digits of buyer's credit card prefix.","in":"query","name":"buyer_credit_card_prefix","required":false,"schema":{"type":"string"}},{"description":"Currency code for transaction - e.g. EUR.","in":"query","name":"currency_code","required":true,"schema":{"type":"string"}},{"description":"Invoice address/region","in":"query","name":"invoice_address_region","required":false,"schema":{"type":"string"}},{"description":"Unit price.","in":"query","name":"unit_price","required":false,"schema":{"type":"number"}},{"description":"Quantity Defaults to 1.","in":"query","name":"quantity","required":false,"schema":{"type":"number"}},{"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 simply use billing_country_code field for that. In the first case, if billing_country_code value was provided, it will be overwritten with country code value extracted from VAT number - but only if the VAT has been verified properly.","in":"query","name":"buyer_tax_number","required":false,"schema":{"type":"string"}},{"description":"Two-letter ISO country code, e.g. FR. Use it to force country code for tax calculation.","in":"query","name":"force_country_code","required":false,"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 is current date and time. When using public token, the default value is used.","in":"query","name":"order_date","required":false,"schema":{"type":"string"}},{"description":"Amount. Required if total amount or both unit price and quantity are not provided.","in":"query","name":"amount","required":false,"schema":{"type":"number"}},{"description":"Billing two letter ISO country code.","in":"query","name":"billing_country_code","required":false,"schema":{"type":"string"}},{"description":"Invoice address/postal_code","in":"query","name":"invoice_address_postal_code","required":false,"schema":{"type":"string"}},{"description":"Total amount. Required if amount or both unit price and quantity are not provided.","in":"query","name":"total_amount","required":false,"schema":{"type":"number"}},{"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 example.","in":"query","name":"tax_deducted","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calculateSimpleTaxOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Simple tax","tags":["tax"]},"post":{"operationId":"calculateTax","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/calculateTaxIn"}}},"description":"Input","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calculateTaxOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Calculate tax","tags":["tax"]}},"/api/v1/tax/location/calculate":{"get":{"operationId":"calculateTaxLocation","parameters":[{"description":"Billing two letter ISO country code.","in":"query","name":"billing_country_code","required":false,"schema":{"type":"string"}},{"description":"First 6 digits of buyer's credit card prefix.","in":"query","name":"buyer_credit_card_prefix","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/calculateTaxLocationOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Calculate location","tags":["tax"]}},"/api/v1/tax/vat_numbers/{tax_number}/validate":{"get":{"operationId":"validateTaxNumber","parameters":[{"description":"Two-letter ISO country code.","in":"query","name":"country_code","required":false,"schema":{"type":"string"}},{"description":"Tax number","in":"path","name":"tax_number","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/validateTaxNumberOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Validate VAT number","tags":["tax"]}},"/api/v1/transactions":{"get":{"operationId":"listTransactions","parameters":[{"description":"Filtering expression","in":"query","name":"filter_text","required":false,"schema":{"type":"string"}},{"description":"Offset","in":"query","name":"offset","required":false,"schema":{"type":"integer"}},{"description":"Return only transactions with a note field set.","in":"query","name":"has_note","required":false,"schema":{"type":"boolean"}},{"description":"Taxamo provided transaction key or custom id","in":"query","name":"key_or_custom_id","required":false,"schema":{"type":"string"}},{"description":"Three letter ISO currency code.","in":"query","name":"currency_code","required":false,"schema":{"type":"string"}},{"description":"Order date to in yyyy-MM-dd format.","in":"query","name":"order_date_to","required":false,"schema":{"type":"string"}},{"description":"If true, results are sorted in descending order.","in":"query","name":"sort_reverse","required":false,"schema":{"type":"boolean"}},{"description":"Limit (no more than 1000, defaults to 100).","in":"query","name":"limit","required":false,"schema":{"type":"integer"}},{"description":"Transaction invoice number.","in":"query","name":"invoice_number","required":false,"schema":{"type":"string"}},{"description":"Comma separated list of two letter ISO tax country codes.","in":"query","name":"tax_country_codes","required":false,"schema":{"type":"string"}},{"description":"Comma separated list of of transaction statuses. 'N' - unconfirmed transaction, 'C' - confirmed transaction.","in":"query","name":"statuses","required":false,"schema":{"type":"string"}},{"description":"Taxamo provided original transaction key","in":"query","name":"original_transaction_key","required":false,"schema":{"type":"string"}},{"description":"Order date from in yyyy-MM-dd format.","in":"query","name":"order_date_from","required":false,"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 not returned.","in":"query","name":"total_amount_greater_than","required":false,"schema":{"type":"string"}},{"description":"Output format - supports 'csv' value for this operation.","in":"query","name":"format","required":false,"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 not returned.","in":"query","name":"total_amount_less_than","required":false,"schema":{"type":"string"}},{"description":"Two letter ISO tax country code.","in":"query","name":"tax_country_code","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/listTransactionsOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Browse transactions","tags":["transactions"]},"post":{"operationId":"createTransaction","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createTransactionIn"}}},"description":"Input","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createTransactionOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Store transaction","tags":["transactions"]}},"/api/v1/transactions/{key}":{"delete":{"operationId":"cancelTransaction","parameters":[{"description":"Transaction key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cancelTransactionOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Delete transaction","tags":["transactions"]},"get":{"operationId":"getTransaction","parameters":[{"description":"Transaction key","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/getTransactionOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Retrieve transaction data.","tags":["transactions"]},"put":{"operationId":"updateTransaction","parameters":[{"description":"Transaction key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateTransactionIn"}}},"description":"Input","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateTransactionOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Update transaction","tags":["transactions"]}},"/api/v1/transactions/{key}/confirm":{"post":{"operationId":"confirmTransaction","parameters":[{"description":"Transaction key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/confirmTransactionIn"}}},"description":"Input","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/confirmTransactionOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Confirm transaction","tags":["transactions"]}},"/api/v1/transactions/{key}/invoice/refunds/{refund_note_number}/send_email":{"post":{"operationId":"emailRefund","parameters":[{"description":"Transaction key.","in":"path","name":"key","required":true,"schema":{"type":"string"}},{"description":"Refund note id.","in":"path","name":"refund_note_number","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailRefundIn"}}},"description":"Input","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailRefundOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Email credit note","tags":["invoices"]}},"/api/v1/transactions/{key}/invoice/send_email":{"post":{"operationId":"emailInvoice","parameters":[{"description":"Transaction key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailInvoiceIn"}}},"description":"Input","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/emailInvoiceOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Email invoice","tags":["invoices"]}},"/api/v1/transactions/{key}/payments":{"get":{"operationId":"listPayments","parameters":[{"description":"Max record count (no more than 100, defaults to 10).","in":"query","name":"limit","required":false,"schema":{"type":"string"}},{"description":"How many records need to be skipped, defaults to 0.","in":"query","name":"offset","required":false,"schema":{"type":"string"}},{"description":"Transaction key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/listPaymentsOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"List payments","tags":["payments"]},"post":{"operationId":"createPayment","parameters":[{"description":"Transaction key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createPaymentIn"}}},"description":"Input","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createPaymentOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Register a payment","tags":["payments"]}},"/api/v1/transactions/{key}/payments/capture":{"post":{"operationId":"capturePayment","parameters":[{"description":"Transaction key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/capturePaymentOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Capture payment","tags":["payments"]}},"/api/v1/transactions/{key}/refunds":{"get":{"operationId":"listRefunds","parameters":[{"description":"Transaction key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/listRefundsOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Get transaction refunds","tags":["refunds"]},"post":{"operationId":"createRefund","parameters":[{"description":"Transaction key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createRefundIn"}}},"description":"Input","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createRefundOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Create a refund","tags":["refunds"]}},"/api/v1/transactions/{key}/unconfirm":{"post":{"operationId":"unconfirmTransaction","parameters":[{"description":"Transaction key.","in":"path","name":"key","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/unconfirmTransactionIn"}}},"description":"Input","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/unconfirmTransactionOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Un-confirm the transaction","tags":["transactions"]}},"/api/v1/verification/sms":{"post":{"operationId":"createSMSToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createSMSTokenIn"}}},"description":"Input","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/createSMSTokenOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Create SMS token","tags":["verification"]}},"/api/v1/verification/sms/{token}":{"get":{"operationId":"verifySMSToken","parameters":[{"description":"Provided token.","in":"path","name":"token","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/verifySMSTokenOut"}}}},"400":{"description":"Validation failed, see JSON body response for details."},"401":{"description":"Incorrect token"}},"summary":"Verify SMS token","tags":["verification"]}}},"servers":[{"url":"https://api.taxamo.com"}],"components":{"securitySchemes":{"apiKey":{"in":"header","name":"Token","type":"apiKey"}},"schemas":{"C":{"properties":{"day":{"description":"Date for stats in yyyy-MM-dd format.","type":"string"},"day_raw":{"description":"Date for stats in yyyy-MM-dd'T'hh:mm:ss'Z' format.","type":"string"},"status":{"description":"Transaction status (C or N).","type":"string"},"value":{"description":"Transaction count.","type":"number"}},"type":"object"},"N":{"properties":{"day":{"description":"Date for stats in yyyy-MM-dd format.","type":"string"},"day_raw":{"description":"Date for stats in yyyy-MM-dd'T'hh:mm:ss'Z' format.","type":"string"},"status":{"description":"Transaction status (C or N).","type":"string"},"value":{"description":"Transaction count.","type":"number"}},"type":"object"},"additional_currencies":{"properties":{"invoice":{"$ref":"#/components/schemas/additional_currency"}},"type":"object"},"additional_currency":{"properties":{"amount":{"description":"Amount (w/o TAX) in designated currency.","type":"number"},"currency_code":{"description":"3-letter ISO currency code.","type":"string"},"fx_rate":{"description":"Foreign exchange rate used in calculation","type":"number"},"tax_amount":{"description":"Tax amount in designated currency.","type":"number"},"total_amount":{"description":"Total amount in designated currency.","type":"number"}},"type":"object"},"by_country":{"properties":{"currency_code":{"description":"Three-letter ISO currency code.","type":"string"},"tax_country_code":{"description":"Two letter ISO country code.","type":"string"},"tax_country_name":{"description":"Country name","type":"string"},"value":{"description":"Tax amount","type":"number"}},"type":"object"},"by_status":{"properties":{"C":{"description":"Confirmed transactions","items":{"$ref":"#/components/schemas/C"},"type":"array"},"N":{"description":"New transactions","items":{"$ref":"#/components/schemas/N"},"type":"array"}},"type":"object"},"by_taxation_type":{"properties":{"deducted_count":{"description":"Number of tax deducted transactions.","type":"number"},"eu_b2b":{"description":"Total EU B2B transaction count.","type":"integer"},"eu_taxed":{"description":"Total EU Taxed transaction count.","type":"integer"},"taxed_count":{"description":"Number of taxed transactions.","type":"number"},"transactions_count":{"description":"Total number of transactions","type":"number"}},"type":"object"},"calculateSimpleTaxIn":{"properties":{"amount":{"description":"Amount. Required if total amount or both unit price and quantity are not provided.","type":"number"},"billing_country_code":{"description":"Billing two letter ISO country code.","type":"string"},"buyer_credit_card_prefix":{"description":"First 6 digits of buyer's credit card prefix.","type":"string"},"buyer_tax_number":{"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 simply use billing_country_code field for that. In the first case, if billing_country_code value was provided, it will be overwritten with country code value extracted from VAT number - but only if the VAT has been verified properly.","type":"string"},"currency_code":{"description":"Currency code for transaction - e.g. EUR.","type":"string"},"force_country_code":{"description":"Two-letter ISO country code, e.g. FR. Use it to force country code for tax calculation.","type":"string"},"invoice_address_city":{"description":"Invoice address/postal_code","type":"string"},"invoice_address_postal_code":{"description":"Invoice address/postal_code","type":"string"},"invoice_address_region":{"description":"Invoice address/region","type":"string"},"order_date":{"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 is current date and time. When using public token, the default value is used.","type":"string"},"product_type":{"description":"Product type, according to dictionary /dictionaries/product_types. ","type":"string"},"quantity":{"description":"Quantity Defaults to 1.","type":"number"},"tax_deducted":{"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 example.","type":"boolean"},"total_amount":{"description":"Total amount. Required if amount or both unit price and quantity are not provided.","type":"number"},"unit_price":{"description":"Unit price.","type":"number"}},"required":["currency_code"],"type":"object"},"calculateSimpleTaxOut":{"properties":{"storage_required_fields":{"description":"Fields required for transaction storage (can be added later - it's up to merchant software). Depends on the region/transaction type.","items":{"$ref":"#/components/schemas/storage_required_fields"},"type":"array"},"tax_required_fields":{"description":"Fields required for tax calculation. Depends on the region/transaction type.","items":{"$ref":"#/components/schemas/tax_required_fields"},"type":"array"},"transaction":{"$ref":"#/components/schemas/transaction"}},"type":"object"},"calculateTaxIn":{"properties":{"transaction":{"$ref":"#/components/schemas/input_transaction"}},"required":["transaction"],"type":"object"},"calculateTaxLocationIn":{"properties":{"billing_country_code":{"description":"Billing two letter ISO country code.","type":"string"},"buyer_credit_card_prefix":{"description":"First 6 digits of buyer's credit card prefix.","type":"string"}},"type":"object"},"calculateTaxLocationOut":{"properties":{"billing_country_code":{"description":"Billing two letter ISO country code.","type":"string"},"buyer_credit_card_prefix":{"description":"First 6 digits of buyer's credit card prefix.","type":"string"},"buyer_ip":{"description":"IP address of the buyer in dotted decimal (IPv4) or text format (IPv6).","type":"string"},"countries":{"$ref":"#/components/schemas/countries"},"evidence":{"$ref":"#/components/schemas/evidence"},"tax_country_code":{"description":"Two-letter ISO country code, e.g. FR. This code applies to detected/set country for transaction, but can be set using manual mode.","type":"string"},"tax_deducted":{"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 example.","type":"boolean"},"tax_supported":{"description":"Is tax calculation supported for a detected tax location?","type":"boolean"}},"type":"object"},"calculateTaxOut":{"properties":{"storage_required_fields":{"description":"Fields required for transaction storage (can be added later - it's up to merchant software). Depends on the region/transaction type.","items":{"$ref":"#/components/schemas/storage_required_fields"},"type":"array"},"tax_required_fields":{"description":"Fields required for tax calculation. Depends on the region/transaction type.","items":{"$ref":"#/components/schemas/tax_required_fields"},"type":"array"},"transaction":{"$ref":"#/components/schemas/transaction"}},"type":"object"},"cancelTransactionOut":{"properties":{"success":{"description":"Was operation successful?","type":"boolean"}},"type":"object"},"capturePaymentOut":{"properties":{"success":{"description":"Was the operation successful?","type":"boolean"}},"type":"object"},"confirmTransactionIn":{"properties":{"transaction":{"$ref":"#/components/schemas/input_transaction_update"}},"type":"object"},"confirmTransactionOut":{"properties":{"storage_required_fields":{"description":"Fields required for transaction storage (can be added later - it's up to merchant software). Depends on the region/transaction type.","items":{"$ref":"#/components/schemas/storage_required_fields"},"type":"array"},"tax_required_fields":{"description":"Fields required for tax calculation. Depends on the region/transaction type.","items":{"$ref":"#/components/schemas/tax_required_fields"},"type":"array"},"transaction":{"$ref":"#/components/schemas/transaction"}},"type":"object"},"countries":{"properties":{"by_2003_rules":{"$ref":"#/components/schemas/country_schema"},"by_billing":{"$ref":"#/components/schemas/country_schema"},"by_cc":{"$ref":"#/components/schemas/country_schema"},"by_ip":{"$ref":"#/components/schemas/country_schema"},"by_tax_number":{"$ref":"#/components/schemas/country_schema"},"by_token":{"$ref":"#/components/schemas/country_schema"},"detected":{"$ref":"#/components/schemas/country_schema"},"forced":{"$ref":"#/components/schemas/country_schema"},"guessed_from_ip":{"$ref":"#/components/schemas/country_schema"},"other_commercially_relevant_info":{"$ref":"#/components/schemas/country_schema"},"self_declaration":{"$ref":"#/components/schemas/country_schema"}},"type":"object"},"country":{"properties":{"callingCode":{"description":"List of phone number calling codes.","items":{"type":"string"},"type":"array"},"cca2":{"description":"Two letter ISO country code.","type":"string"},"cca3":{"description":"Three letter ISO country code.","type":"string"},"ccn3":{"description":"Country ISO 3-digit code.","type":"string"},"code":{"description":"Two letter ISO country code.","type":"string"},"code_long":{"description":"Three letter ISO country code.","type":"string"},"codenum":{"description":"Country ISO 3-digit code.","type":"string"},"currency":{"description":"List of currencies.","items":{"type":"string"},"type":"array"},"name":{"description":"Country name.","type":"string"},"tax_number_country_code":{"description":"VAT number country code. Important for Greece.","type":"string"},"tax_region":{"description":"Tax region code - e.g. EU, US, NO, JP...","type":"string"},"tax_supported":{"description":"True if tax calculation supported for this country.","type":"boolean"}},"type":"object"},"country_schema":{"properties":{"callingCode":{"description":"List of phone number calling codes.","items":{"type":"string"},"type":"array"},"cca2":{"description":"Two letter ISO country code.","type":"string"},"cca3":{"description":"Three letter ISO country code.","type":"string"},"ccn3":{"description":"Country ISO 3-digit code.","type":"string"},"code":{"description":"Two letter ISO country code.","type":"string"},"code_long":{"description":"Three letter ISO country code.","type":"string"},"codenum":{"description":"Country ISO 3-digit code.","type":"string"},"currency":{"description":"List of currencies.","items":{"type":"string"},"type":"array"},"name":{"description":"Country name.","type":"string"},"tax_number_country_code":{"description":"VAT number country code. Important for Greece.","type":"string"},"tax_region":{"description":"Tax region code - e.g. EU, US, NO, JP...","type":"string"},"tax_supported":{"description":"True if tax calculation supported for this country.","type":"boolean"}},"type":"object"},"createPaymentIn":{"properties":{"amount":{"description":"Amount that has been paid. Use negative value to register refunds.","type":"number"},"payment_information":{"description":"Additional payment information.","type":"string"},"payment_timestamp":{"description":"When the payment was received in yyyy-MM-dd'T'HH:mm:ss(.SSS)'Z' format (24 hour, UTC timezone). Defaults to current date and time.","type":"string"}},"required":["amount"],"type":"object"},"createPaymentOut":{"properties":{"success":{"description":"Was the operation successful?","type":"boolean"}},"type":"object"},"createRefundIn":{"properties":{"amount":{"description":"Amount (without tax) to be refunded. Either amount or total amount is required. In case of line key and custom id missing, only total_amount can be used.","type":"number"},"custom_id":{"description":"Line custom identifier. If neither line key or custom id is provided, the refund amount will be assigned to lines in order.","type":"string"},"line_key":{"description":"Line identifier. If neither line key or custom id is provided, the refund amount will be assigned to lines in order.","type":"string"},"refund_reason":{"description":"Refund reason, displayed on the credit note.","type":"string"},"total_amount":{"description":"Total amount, including tax, to be refunded. Either amount or total amount is required. In case of line key and custom id missing, only total_amount can be used.","type":"number"}},"type":"object"},"createRefundOut":{"properties":{"refunded_tax_amount":{"description":"Total tax amount, that was refunded for this line.","type":"number"},"refunded_total_amount":{"description":"Total amount, including tax, that was refunded for this line.","type":"number"},"tax_amount":{"description":"Calculated tax amount, that was refunded in this call.","type":"number"},"total_amount":{"description":"Total amount, including tax, that was refunded in this call.","type":"number"}},"type":"object"},"createSMSTokenIn":{"properties":{"country_code":{"description":"Two letter ISO country code.","type":"string"},"recipient":{"description":"Recipient phone number.","type":"string"}},"required":["country_code","recipient"],"type":"object"},"createSMSTokenOut":{"properties":{"success":{"description":"Always set to true. Success means that the message has been queued for delivery. In some cases message may be undelivered at the end, e.g. mobile number is blacklisted. API errors are signalled with appropriate error codes.","type":"boolean"}},"type":"object"},"createTransactionIn":{"properties":{"manual_mode":{"description":"Use manual mode, bypassing country detection. Only allowed with private token. This flag allows to use original_transaction_key field","type":"boolean"},"transaction":{"$ref":"#/components/schemas/input_transaction"}},"required":["transaction"],"type":"object"},"createTransactionOut":{"properties":{"storage_required_fields":{"description":"Fields required for transaction storage (can be added later - it's up to merchant software). Depends on the region/transaction type.","items":{"$ref":"#/components/schemas/storage_required_fields"},"type":"array"},"tax_required_fields":{"description":"Fields required for tax calculation. Depends on the region/transaction type.","items":{"$ref":"#/components/schemas/tax_required_fields"},"type":"array"},"transaction":{"$ref":"#/components/schemas/transaction"}},"type":"object"},"currency_schema":{"properties":{"code":{"description":"Currency 3-letter ISO code.","type":"string"},"description":{"description":"Currency description.","type":"string"},"isocode":{"description":"Currency 3-letter ISO code.","type":"string"},"isonum":{"description":"Currency iso numeric code.","type":"integer"},"minorunits":{"description":"Number of minor units for currency.","type":"integer"}},"type":"object"},"custom_fields":{"properties":{"key":{"description":"Field's key.","type":"string"},"value":{"description":"Field's value.","type":"string"}},"type":"object"},"emailInvoiceIn":{"properties":{"buyer_email":{"description":"Email to send the invoice. If not provided, transaction.buyer_email will be used.","type":"string"}},"type":"object"},"emailInvoiceOut":{"properties":{"success":{"description":"Was operation successful?","type":"boolean"}},"type":"object"},"emailRefundIn":{"properties":{"buyer_email":{"description":"Email to send the credit note/refund note. If not provided, transaction.buyer_email will be used.","type":"string"}},"type":"object"},"emailRefundOut":{"properties":{"success":{"description":"Was operation successful?","type":"boolean"}},"type":"object"},"evidence":{"properties":{"by_2003_rules":{"$ref":"#/components/schemas/evidence_schema"},"by_billing":{"$ref":"#/components/schemas/evidence_schema"},"by_cc":{"$ref":"#/components/schemas/evidence_schema"},"by_ip":{"$ref":"#/components/schemas/evidence_schema"},"by_payment_method":{"$ref":"#/components/schemas/evidence_schema"},"by_tax_number":{"$ref":"#/components/schemas/evidence_schema"},"by_token":{"$ref":"#/components/schemas/evidence_schema"},"forced":{"$ref":"#/components/schemas/evidence_schema"},"guessed_from_ip":{"$ref":"#/components/schemas/evidence_schema"},"other_commercially_relevant_info":{"$ref":"#/components/schemas/evidence_schema"},"self_declaration":{"$ref":"#/components/schemas/evidence_schema"}},"type":"object"},"evidence_schema":{"properties":{"evidence_type":{"description":"Type of evidence.","type":"string"},"evidence_value":{"description":"Value provided as evidence - for example IP address.","