get transaction logs

1 min

GET

https://api.upstartcommerce.com/v1/tax/transactions

This endpoint displays all the transactions that have been logged against a certain tenant.

Authorized permissions:

Authorizers.taxRead

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site this call is for.
x-upstart-sitestring
Description
Unique identifier for the site.

Responses

200

Success-found the logged transactions.

object[]
Min Items
1
Unique Items
yes
- transactionIdstringrequired
  Description
  Unique transaction identifier of this logged transaction.
  Min Length
  1
- tenantstringrequired
  Description
  Tenant by which the transaction was made.
  Min Length
  1
- siteIdstringrequired
  Description
  Site identifier against the tenant.
  Min Length
  1
- cartIdstringrequired
  Description
  Cart identifier for this transaction.
  Min Length
  1
- apiNamestringrequired
  Description
  API call name for which this transaction is logged.
  Min Length
  1
- requestobjectrequired
  Description
  Request body of the API call for which this transaction is logged.
  - codestring
  - linesobject[]
    - quantitynumber
    - amountnumber
    - addressesobject
      - shipFromobject
        line1string
        line2string
        citystring
        regionstring
        countrystring
        postalCodestring
      - shipToobject
        line1string
        line2string
        citystring
        regionstring
        countrystring
        postalCodestring
      - singleLocationobject
        line1string
        line2string
        citystring
        regionstring
        countrystring
        postalCodestring
    - taxCodestring
    - entityUseCodestring
    - itemCodestring
    - discountedboolean
    - ref1string
    - descriptionstring
  - typestring
  - commitboolean
  - companyCodestring
  - datestring
  - customerCodestring
  - purchaseOrderNostring
  - exemptionNostring
  - addressesobject
    - shipFromobject
      - line1string
      - line2string
      - citystring
      - regionstring
      - countrystring
      - postalCodestring
    - shipToobject
      - line1string
      - line2string
      - citystring
      - regionstring
      - countrystring
      - postalCodestring
    - singleLocationobject
      - line1string
      - line2string
      - citystring
      - regionstring
      - countrystring
      - postalCodestring
  - currencyCodestring
- responseobjectrequired
  Description
  Response body of the API call for which this transaction is logged.
  - object
    - idnumber
    - codestring
    - companyIdnumber
    - datenumber
    - paymentDatenumber
    - statusstring
    - typestring
    - batchCodestring
    - currencyCodestring
    - customerUsageTypestring
    - entityUseCodestring
    - customerVendorCodestring
    - customerCodestring
    - exemptNostring
    - reconciledboolean
    - locationCodestring
    - reportingLocationCodestring
    - purchaseOrderNostring
    - referenceCodestring
    - salespersonCodestring
    - taxOverrideTypestring
    - taxOverrideAmountnumber
    - taxOverrideReasonstring
    - totalAmountnumber
    - totalExemptnumber
    - totalDiscountnumber
    - totalTaxnumber
    - totalTaxablenumber
    - totalTaxCalculatednumber
    - adjustmentReasonstring
    - adjustmentDescriptionstring
    - lockedboolean
    - regionstring
    - countrystring
    - versionnumber
    - softwareVersionstring
    - originAddressIdnumber
    - destinationAddressIdnumber
    - exchangeRateEffectiveDatenumber
    - exchangeRatenumber
    - descriptionstring
    - emailstring
    - businessIdentificationNostring
    - modifiedDatenumber
    - modifiedUserIdnumber
    - taxDatenumber
    - linesobject[]
      - idnumber
      - transactionIdnumber
      - lineNumberstring
      - boundaryOverrideIdnumber
      - customerUsageTypestring
      - entityUseCodestring
      - descriptionstring
      - destinationAddressIdnumber
      - originAddressIdnumber
      - discountAmountnumber
      - discountTypeIdnumber
      - exemptAmountnumber
      - exemptCertIdnumber
      - exemptNostring
      - isItemTaxableboolean
      - isSSTPboolean
      - itemCodestring
      - lineAmountnumber
      - quantitynumber
      - ref1string
      - ref2string
      - reportingDatenumber
      - revAccountstring
      - sourcingstring
      - taxnumber
      - taxableAmountnumber
      - taxCalculatednumber
      - taxCodestring
      - taxCodeIdnumber
      - taxDatenumber
      - taxEnginestring
      - taxOverrideTypestring
      - businessIdentificationNostring
      - taxOverrideAmountnumber
      - taxOverrideReasonstring
      - taxIncludedboolean
      - detailsobject[]
        idnumber
        transactionLineIdnumber
        transactionIdnumber
        addressIdnumber
        countrystring
        regionstring
        countyFIPSstring
        stateFIPSstring
        exemptAmountnumber
        exemptReasonIdnumber
        inStateboolean
        jurisCodestring
        jurisNamestring
        jurisdictionIdnumber
        signatureCodestring
        stateAssignedNostring
        jurisTypestring
        jurisdictionTypestring
        nonTaxableAmountnumber
        nonTaxableRuleIdnumber
        nonTaxableTypestring
        ratenumber
        rateRuleIdnumber
        rateSourceIdnumber
        serCodestring
        sourcingstring
        taxnumber
        taxableAmountnumber
        taxTypestring
        taxSubTypeIdstring
        taxTypeGroupIdstring
        taxNamestring
        taxAuthorityTypeIdnumber
        taxRegionIdnumber
        taxCalculatednumber
        taxOverridenumber
        rateTypeCodestring
        taxableUnitsnumber
        nonTaxableUnitsnumber
        exemptUnitsnumber
        unitOfBasisstring
        isNonPassThruboolean
      - nonPassthroughDetailsobject[]
      - lineLocationTypesobject[]
        documentLineLocationTypeIdnumber
        documentLineIdnumber
        documentAddressIdnumber
        locationTypeCodestring
      - hsCodestring
      - costInsuranceFreightnumber
      - vatCodestring
      - vatNumberTypeIdnumber
    - addressesobject[]
      - idnumber
      - transactionIdnumber
      - boundaryLevelstring
      - line1string
      - line2string
      - line3string
      - citystring
      - regionstring
      - postalCodestring
      - countrystring
        Min Length
        1
      - taxRegionIdnumber
      - latitudestring
        Min Length
        1
      - longitudestring
        Min Length
        1
    - locationTypesobject[]
      - documentLocationTypeIdnumber
      - documentIdnumber
      - documentAddressIdnumber
      - locationTypeCodestring
        Min Length
        1
    - summaryobject[]
      - countrystring
        Min Length
        1
      - regionstring
        Min Length
        1
      - jurisTypestring
        Min Length
        1
      - jurisCodestring
        Min Length
        1
      - jurisNamestring
        Min Length
        1
      - taxAuthorityTypenumber
      - stateAssignedNostring
      - taxTypestring
        Min Length
        1
      - taxNamestring
        Min Length
        1
      - taxablenumber
      - ratenumber
      - taxnumber
      - taxCalculatednumber
      - nonTaxablenumber
      - exemptionnumber
  - object
    - levelstringrequired
      Description
      Error level.
    - codestringrequired
      Description
      Error code.
    - messagestringrequired
      Description
      Error message.
- creationDatestringrequired
  Example
  2021-11-01T10:09:08.015Z
  Description
  The date on which this transaction was logged into the database.
  Min Length
  1
- roundTripTimenumberrequired
  Description
  The time in nano seconds it takes for this API call to respond.

401

Unauthorized-the provided credentials were invalid for this endpoint.

GeneralError
Description
Error payload returned by the bad-request and unauthorized responses, identifying the failure by name, code and detail.
- namestringrequired
  Description
  Error name.
  Min Length
  1
- codestringrequired
  Description
  Error code.
  Min Length
  1
- reasonstring
  Description
  Reason why this error occurred.
  Min Length
  1
- detailstringrequired
  Description
  Error details.
  Min Length
  1

404

Not Found-the requested resource was not found in the NoChannel system.

curl

curl --request GET \
     --url https://api.upstartcommerce.com/v1/tax/transactions \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/tax/transactions", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/tax/transactions")

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

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"

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

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/tax/transactions"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Success-found the logged transactions.
[
  {
    "transactionId": "",
    "tenant": "",
    "siteId": "",
    "cartId": "",
    "apiName": "",
    "request": {
      "code": "",
      "lines": [
        {
          "quantity": 0,
          "amount": 0,
          "addresses": {
            "shipFrom": {
              "line1": "",
              "line2": "",
              "city": "",
              "region": "",
              "country": "",
              "postalCode": ""
            },
            "shipTo": {
              "line1": "",
              "line2": "",
              "city": "",
              "region": "",
              "country": "",
              "postalCode": ""
            },
            "singleLocation": {
              "line1": "",
              "line2": "",
              "city": "",
              "region": "",
              "country": "",
              "postalCode": ""
            }
          },
          "taxCode": "",
          "entityUseCode": "",
          "itemCode": "",
          "discounted": false,
          "ref1": "",
          "description": ""
        }
      ],
      "type": "",
      "commit": false,
      "companyCode": "",
      "date": "",
      "customerCode": "",
      "purchaseOrderNo": "",
      "exemptionNo": "",
      "addresses": {
        "shipFrom": {
          "line1": "",
          "line2": "",
          "city": "",
          "region": "",
          "country": "",
          "postalCode": ""
        },
        "shipTo": {
          "line1": "",
          "line2": "",
          "city": "",
          "region": "",
          "country": "",
          "postalCode": ""
        },
        "singleLocation": {
          "line1": "",
          "line2": "",
          "city": "",
          "region": "",
          "country": "",
          "postalCode": ""
        }
      },
      "currencyCode": ""
    },
    "response": {},
    "creationDate": "2021-11-01T10:09:08.015Z",
    "roundTripTime": 0
  }
]

401

// Unauthorized-the provided credentials were invalid for this endpoint.
{
  "name": "",
  "code": "",
  "reason": "",
  "detail": ""
}

404

// Not Found-the requested resource was not found in the NoChannel system.