Browse transactions

Use this request to browse transaction information.

To browse a transaction, use a GET method and the following URL:

https://services.taxamo.com/api/v2/transactions/

For example:

$ curl -H "Private-Token: priv_***********" \
 'https://services.taxamo.com/api/v2/transactions?tax_country_code=IE&offset=1&limit=2'

Details

Value

Type

Endpoint

/api/v2/transactions/

Method

GET

API Reference

Browse transactions

Query Parameters

Parameter

Description

private_token

Private token.

order_date_from

Order date from in the yyyy-MM-dd format.

order_date_to

Order date to in the yyyy-MM-dd format.

sort_by

Select a field used for sorting. Default is to sort in creation order.

sort_reverse

If set to true, results are sorted in descending order.

filter_text

Filtering expression. Placeholder field, not supported yet.

limit

Limit (no more than 1000, defaults to 100).

offset

Offset

format

Output format - supports 'csv' value for this operation.

tax_country_code

Two letter ISO tax country code.

tax_country_codes

Comma separated list of two letter ISO tax country codes.

currency_code

Three letter ISO currency code.

statuses

Comma separated list of of transaction statuses. 'N' - unconfirmed transaction, 'C' - confirmed transaction.

key_or_custom_id

Vertex provided transaction key or custom ID.

original_transaction_key

Vertex provided original transaction key.

invoice_number

Transaction invoice number.

total_amount_greater_than

Return only transactions with total amount greater than given number. Transactions with total amount equal to a given number (for example 0) are not returned.

total_amount_less_than

Return only transactions with total amount less than a given number. Transactions with total amount equal to a given number (for example 1) are not returned.

has_note

Return only transactions with a note field set.

external_unique_id

Search by the external unique ID.

no_sub_account_id

Only return transactions without sub_account_id set.

has_sub_account_id

Only return transactions with sub_account_id set.

buyer_tax_number

Only return transactions with a provided buyer tax number.

buyer_tax_number_not

Only return transactions without provided number or with a different buyer tax number.

product_classes

Only return transactions with provided product classes.

Response Example

The following is an example of a successful response:

{
   "transactions" : [
      {
         "tax_region" : "EU",
         "create_timestamp" : "2016-10-21T11:13:04Z",
         "key" : "TVkoAAAABbqWsHyiY0pNYCfhARgk",
         "buyer_ip" : "109.129.135.236",
         "custom_id" : "customId1",
         "status" : "C",
         "refunded_tax_amount" : 0,
         "amount" : 22,
         "test" : true,
         "currency_code" : "EUR",
         "transaction_lines" : [
            {
               "custom_id" : "1",
               "quantity" : 1,
               "line_key" : "MHeD7qijA4G_EqYH",
               "tax_rate" : 0,
               "tax_name" : "European VAT",
               "tax_amount" : 0,
               "line_num" : 1,
               "total_amount" : 22,
               "product_type" : "default",
               "num" : null,
               "amount" : 22,
               "deducted_tax_amount" : 0,
               "unit_price" : 22
            }
         ],
         "buyer_tax_number_valid" : true,
         "order_date" : "2016-10-21T11:11:50Z",
         "buyer_credit_card_prefix" : "424242424",
         "additional_currencies" : {},
         "source" : "Stripe webhook in Taxamo",
         "update_timestamp" : 1477048386857,
         "total_amount" : 22,
         "fully_informative" : false,
         "tax_amount" : 0,
         "kind" : "eu-b2b",
         "manual" : true,
         "invoice_place" : "Tralee232323",
         "confirm_timestamp" : "2016-10-21T11:13:06Z",
         "custom_fields" : [
            {
               "key" : "stripe-customer-id",
               "value" : "cus_5mJjLVSJQjMmnK"
            },
            {
               "key" : "stripe-token",
               "value" : "tok_15al5d2qiE2goZc6kQN795Zg"
            },
            {
               "value" : "some value",
               "key" : "some-custom-key"
            }
         ],
         "tax_deducted" : true,
         "billing_country_code" : "IE",
         "buyer_email" : "[email protected]",
         "buyer_name" : "ASTERION SOFTWARE LIMITED",
         "description" : "Evidence placeholder for Stripe subscription",
         "evidence" : {
            "by_tax_number" : {
               "evidence_type" : "by-tax-number",
               "resolved_country_code" : "IE",
               "used" : true,
               "evidence_value" : "IE6437116J"
            },
            "by_ip" : {
               "evidence_value" : "109.129.135.236",
               "used" : false,
               "resolved_country_code" : "BE",
               "evidence_type" : "by-ip"
            },
            "by_cc" : {
               "evidence_type" : "by-cc",
               "resolved_country_code" : "BE",
               "used" : false,
               "evidence_value" : "424242424"
            },
            "by_billing" : {
               "evidence_value" : "IE",
               "resolved_country_code" : "IE",
               "used" : true,
               "evidence_type" : "by-billing"
            }
         },
         "original_transaction_key" : "TksMAAAABOresHwQZaepU8ELNraw",
         "tax_country_code" : "IE",
         "invoice_address" : {
            "freeform_address" : "GLENACRE ,LACKENROE ,GLANMIRE ,CO.CORK",
            "country" : "IE"
         },
         "refunded_total_amount" : 0,
         "deducted_tax_amount" : 0,
         "tax_timezone" : "GB",
         "tax_number_service" : "vies",
         "buyer_tax_number" : "IE6437116J"
      },
      {
         "refunded_total_amount" : 0,
         "invoice_address" : {},
         "tax_number_service" : "vies",
         "tax_timezone" : "GB",
         "deducted_tax_amount" : 0,
         "billing_country_code" : "IE",
         "custom_fields" : [
            {
               "key" : "stripe-subscription-id",
               "value" : "sub_8H1LGcEuNmRCHB"
            },
            {
               "key" : "stripe-customer-id",
               "value" : "cus_8H1LVCm0c2OVMj"
            },
            {
               "value" : "tok_180TIn2qiE2goZc6IbGhSxVb",
               "key" : "stripe-token"
            },
            {
               "value" : "taxamo_test_b2c",
               "key" : "taxed-plan-id"
            },
            {
               "key" : "untaxed-plan-id",
               "value" : "taxamo_test_b2b"
            }
         ],
         "confirm_timestamp" : "2016-10-21T10:33:14Z",
         "invoice_place" : "London, Some where",
         "kind" : "eu-b2c",
         "manual" : true,
         "tax_amount" : 2.24,
         "fully_informative" : false,
         "tax_country_code" : "IE",
         "original_transaction_key" : "TcWEAAAABPLqsHy3CyBJXELTRGco",
         "description" : "Taxamo B2C Test plan",
         "evidence" : {
            "by_billing" : {
               "evidence_type" : "by-billing",
               "resolved_country_code" : "IE",
               "used" : true,
               "evidence_value" : "IE"
            },
            "by_cc" : {
               "evidence_value" : "424242",
               "resolved_country_code" : "BE",
               "used" : false,
               "evidence_type" : "by-cc"
            },
            "by_ip" : {
               "evidence_type" : "by-ip",
               "used" : true,
               "resolved_country_code" : "IE",
               "evidence_value" : "52.48.232.115"
            }
         },
         "order_date" : "2016-10-21T10:31:56Z",
         "transaction_lines" : [
            {
               "tax_amount" : 2.24,
               "line_key" : "CfWpHZTqNtfQNlRP",
               "tax_name" : "European VAT",
               "tax_rate" : 23,
               "quantity" : 1,
               "custom_id" : "1",
               "unit_price" : 9.76,
               "num" : null,
               "description" : "Taxamo B2C Test plan",
               "amount" : 9.76,
               "line_num" : 1,
               "total_amount" : 12
            }
         ],
         "total_amount" : 12,
         "update_timestamp" : 1477045994604,
         "source" : "Stripe webhook in Taxamo",
         "buyer_credit_card_prefix" : "424242",
         "additional_currencies" : {},
         "buyer_ip" : "52.48.232.115",
         "key" : "TrOYAAAAB1IOsHyiY_2dYCe7ov4o",
         "create_timestamp" : "2016-10-21T10:33:12Z",
         "tax_region" : "EU",
         "currency_code" : "EUR",
         "amount" : 9.76,
         "test" : true,
         "refunded_tax_amount" : 0,
         "status" : "C"
      }
   ]
}

Did this page help you?