Retrieve transaction

GET

transactions

{transaction_id}

Retrieve Transaction

curl --request GET \
  --url https://api.taxwire.com/transactions/{transaction_id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.taxwire.com/transactions/{transaction_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.taxwire.com/transactions/{transaction_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taxwire.com/transactions/{transaction_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.taxwire.com/transactions/{transaction_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "txn_123",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "filing_tax_amount": "100",
  "filing_tax_amount_source": "provided",
  "status": "draft",
  "tax_calculation": {
    "tax_amount": "2999",
    "line_items": [
      {
        "id": "<string>",
        "tax_amount": "<string>",
        "taxes": [
          {
            "detail": "County Transportation Fund",
            "jurisdiction_name": "California",
            "jurisdiction_type": "state",
            "tax_amount": "10",
            "tax_type": "California District Transaction Tax",
            "is_registered": true,
            "rule_name": "Clothing taxability rule",
            "taxable_base": "100",
            "tax_rate": "0.05",
            "rate_type": "percentage"
          }
        ],
        "tax_amount_before_discounts": "<string>",
        "discounts": [
          {
            "id": "disc_123",
            "tax_amount_reduction": "400"
          }
        ]
      }
    ],
    "currency": "USD"
  },
  "currency": "USD",
  "discount_amount": "100",
  "vendor_discount_amount": "100",
  "transaction_date": "2024-03-15T12:00:00Z",
  "line_items": [
    {
      "customer": {
        "address": {
          "city": "Anytown",
          "line1": "123 Main St",
          "postal_code": "12345",
          "state": "CA"
        },
        "tax_ids": [
          {
            "country": "DE",
            "type": "eu_vat",
            "value": "DE123456789"
          }
        ]
      },
      "id": "item_123",
      "product": {
        "tax_attributes": [
          "DIGITAL_PROPERTY.DIGITAL_SOFTWARE._DOWNLOADED"
        ]
      },
      "quantity": "1",
      "unit_price": "100"
    }
  ],
  "parent_transaction_id": "txn_123",
  "reference_id": "INV-123",
  "type": "sale",
  "tax_amount": "100"
}

{
  "errors": [
    {
      "status": "422",
      "code": "validation_required_field",
      "title": "Missing quantity",
      "detail": "Please provide a value for the required quantity field",
      "source": {
        "pointer": "/data/attributes/line_items/0/quantity"
      }
    }
  ]
}

{
  "errors": [
    {
      "status": "429",
      "code": "rate_limit_error",
      "title": "Too Many Requests",
      "detail": "Rate limit exceeded"
    }
  ]
}

{
  "errors": [
    {
      "status": "500",
      "code": "system_internal_error",
      "title": "Internal Error",
      "detail": "An unexpected error occurred. Our team has been notified."
    }
  ]
}

Authorizations

X-API-Key

string

header

required

Path Parameters

transaction_id

string

required

Response

Successful Response

Transaction response model.

string

required

Unique identifier for the transaction

Example:

"txn_123"

created_at

string<date-time>

required

Date at which the transaction record was created

updated_at

string<date-time>

required

Date at which the transaction record was last updated

filing_tax_amount

string

required

Amount of tax collected to be reported, filed, and remitted. Defaults to tax_amount if provided, otherwise the tax recorded as collected on the transaction, otherwise tax_calculation.tax_amount. The collected tax can differ from tax_calculation.tax_amount, e.g. after a finalized transaction is recalculated, or on a credit limited to its parent's remaining tax

Example:

"100"

filing_tax_amount_source

enum<string>

required

Source of the filing tax amount. Defaults to provided if a tax_amount is provided, otherwise calculated, including when the amount is the tax recorded as collected

Available options:

provided,

calculated

Examples:

"provided"

"calculated"

status

enum<string>

required

Status of the transaction. Draft will exist for 24hrs

Available options:

draft,

finalized,

void,

filed

Examples:

"draft"

"finalized"

"void"

"filed"

tax_calculation

CreateCalculationResponse · object

required

Tax calculation for the transaction

Show child attributes

currency

string

default:USD

The currency of the transaction. Defaults to USD. The currency must be a valid ISO 4217 currency code.

Required string length: 3

Example:

"USD"

discount_amount

string | null

Amount of discount applied to the transaction. Amount is expressed in the currency of the transaction and in denominations of the smallest unit of the currency, such as cents for USD. e.g: "100" would be 100 cents or $1.00 in a USD transaction.

Example:

"100"

vendor_discount_amount

string | null

Amount of discount applied to the vendor in the transaction. Most of the time, you should use the discount_amount field instead. Unlike discount_amount, this discount is funded by the vendor and typically does not reduce the taxable base of the transaction. Amount is expressed in the currency of the transaction and in denominations of the smallest unit of the currency, such as cents for USD. e.g: "100" would be 100 cents or $1.00 in a USD transaction.

Example:

"100"

transaction_date

string<date-time>

Date and time for the tax calculation. Timezone is required for better accuracy. Use the ISO 8601 format. e.g: 2024-03-15T12:00:00Z. If not provided, the current UTC date and time will be used.

Example:

"2024-03-15T12:00:00Z"

line_items

LineItem · object[] | null

List of line items for an invoice or transaction. Required for sale transactions, optional for credits. A credit transaction without line_items will be assumed to be a full refund of the invoice.

Show child attributes

Example:

[
  {
    "customer": {
      "address": {
        "city": "Anytown",
        "line1": "123 Main St",
        "postal_code": "12345",
        "state": "CA"
      },
      "tax_ids": [
        {
          "country": "DE",
          "type": "eu_vat",
          "value": "DE123456789"
        }
      ]
    },
    "id": "item_123",
    "product": {
      "tax_attributes": [
        "DIGITAL_PROPERTY.DIGITAL_SOFTWARE._DOWNLOADED"
      ]
    },
    "quantity": "1",
    "unit_price": "100"
  }
]

parent_transaction_id

string | null

ID of the parent transaction. Used for credits on previous invoices.

Example:

"txn_123"

reference_id

string | null

Reference number for the transaction for your internal use.

Example:

"INV-123"

type

enum<string>

default:sale

Type of the transaction

Available options:

sale,

credit

Examples:

"sale"

"credit"

tax_amount

string | null

Amount of tax passed in the request: the amount provided. Amount is expressed in the currency of the transaction and in denominations of the smallest unit of the currency, such as cents for USD. e.g: 100 would be 100 cents or $1.00 in a USD transaction.

Example:

"100"

Retrieve Transaction

curl --request GET \
  --url https://api.taxwire.com/transactions/{transaction_id} \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.taxwire.com/transactions/{transaction_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.taxwire.com/transactions/{transaction_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taxwire.com/transactions/{transaction_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.taxwire.com/transactions/{transaction_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "txn_123",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "filing_tax_amount": "100",
  "filing_tax_amount_source": "provided",
  "status": "draft",
  "tax_calculation": {
    "tax_amount": "2999",
    "line_items": [
      {
        "id": "<string>",
        "tax_amount": "<string>",
        "taxes": [
          {
            "detail": "County Transportation Fund",
            "jurisdiction_name": "California",
            "jurisdiction_type": "state",
            "tax_amount": "10",
            "tax_type": "California District Transaction Tax",
            "is_registered": true,
            "rule_name": "Clothing taxability rule",
            "taxable_base": "100",
            "tax_rate": "0.05",
            "rate_type": "percentage"
          }
        ],
        "tax_amount_before_discounts": "<string>",
        "discounts": [
          {
            "id": "disc_123",
            "tax_amount_reduction": "400"
          }
        ]
      }
    ],
    "currency": "USD"
  },
  "currency": "USD",
  "discount_amount": "100",
  "vendor_discount_amount": "100",
  "transaction_date": "2024-03-15T12:00:00Z",
  "line_items": [
    {
      "customer": {
        "address": {
          "city": "Anytown",
          "line1": "123 Main St",
          "postal_code": "12345",
          "state": "CA"
        },
        "tax_ids": [
          {
            "country": "DE",
            "type": "eu_vat",
            "value": "DE123456789"
          }
        ]
      },
      "id": "item_123",
      "product": {
        "tax_attributes": [
          "DIGITAL_PROPERTY.DIGITAL_SOFTWARE._DOWNLOADED"
        ]
      },
      "quantity": "1",
      "unit_price": "100"
    }
  ],
  "parent_transaction_id": "txn_123",
  "reference_id": "INV-123",
  "type": "sale",
  "tax_amount": "100"
}

{
  "errors": [
    {
      "status": "422",
      "code": "validation_required_field",
      "title": "Missing quantity",
      "detail": "Please provide a value for the required quantity field",
      "source": {
        "pointer": "/data/attributes/line_items/0/quantity"
      }
    }
  ]
}

{
  "errors": [
    {
      "status": "429",
      "code": "rate_limit_error",
      "title": "Too Many Requests",
      "detail": "Rate limit exceeded"
    }
  ]
}

{
  "errors": [
    {
      "status": "500",
      "code": "system_internal_error",
      "title": "Internal Error",
      "detail": "An unexpected error occurred. Our team has been notified."
    }
  ]
}

Getting Started

Guides

Transaction flows

API details

Calculations

Transactions

Customers

Certificates

Jurisdictions

Product Tax Codes (PTC) & Attributes

Products

Resources

Authorizations

Path Parameters

Response