POST api/v7/TransactionLookups/TaxDetails

Retrieve the tax details in a transaction (group by line item).

Request Information

URI Parameters

None.

Body Parameters

The transaction with line items to pull-out .

RefundTaxDetailsRequest
NameDescriptionTypeRequired?Additional information
Transaction

RefundTaxTransaction

No

None.

Request Formats

application/json, text/json

Sample:
{
  "Transaction": {
    "StoreNumber": "111",
    "TerminalNumber": "6",
    "TransactionId": "14",
    "BusinessDate": "2020-04-15T00:00:00",
    "Source": "DSR",
    "ReceiptNumber": "0000011100000006000000140415200103",
    "Items": [
      {
        "SequenceNumber": 1,
        "ItemCode": "11111111111111"
      },
      {
        "SequenceNumber": 2,
        "ItemCode": "08462795138528"
      },
      {
        "SequenceNumber": 3,
        "ItemCode": "22222223333333"
      }
    ]
  }
}

Response Information

Resource Description

The transaction with tax details on each line item .

RefundTaxDetailsResponse
NameDescriptionType
Transaction

RefundTaxTransaction
Success

boolean

Response Formats

application/json, text/json

Sample:
{
  "Transaction": {
    "ReceiptNumber": "0000011100000006000000140415200103",
    "Items": [
      {
        "SequenceNumber": 1,
        "ItemCode": "11111111111111",
        "Tax": [
          {
            "taxCode": "6",
            "taxRate": 0.08,
            "thresholdMethod": 0,
            "thresholdAmount": 0.0,
            "returnTaxDays": 0,
            "taxTypeCode": "6",
            "taxTypeCharacters": "P",
            "taxTableCode": "",
            "compoundTax": [
              {
                "taxTypeCode": "4"
              }
            ],
            "taxClassInfo": [],
            "description": "Override"
          }
        ]
      },
      {
        "SequenceNumber": 2,
        "ItemCode": "08462795138528",
        "Tax": [
          {
            "taxCode": "8",
            "taxRate": 0.018,
            "thresholdMethod": 0,
            "thresholdAmount": 0.0,
            "returnTaxDays": 0,
            "taxTypeCode": "8",
            "taxTypeCharacters": "I",
            "taxTableCode": "",
            "compoundTax": [],
            "taxClassInfo": [],
            "description": "Override"
          },
          {
            "taxCode": "3",
            "taxRate": 0.075,
            "returnTaxDays": 0,
            "taxTypeCode": "9",
            "taxTypeCharacters": "ST1",
            "taxTableCode": "",
            "compoundTax": [
              {
                "taxTypeCode": "8"
              }
            ],
            "taxClassInfo": [],
            "description": "7.5% State Tax"
          }
        ]
      },
      {
        "SequenceNumber": 3,
        "ItemCode": "22222223333333",
        "Tax": [
          {
            "taxCode": "6",
            "taxRate": 0.075,
            "thresholdMethod": 0,
            "thresholdAmount": 0.0,
            "returnTaxDays": 0,
            "taxTypeCode": "6",
            "taxTypeCharacters": "P",
            "taxTableCode": "",
            "compoundTax": [
              {
                "taxTypeCode": "4"
              }
            ],
            "taxClassInfo": [],
            "description": "Override"
          },
          {
            "taxCode": "8",
            "taxRate": 0.018,
            "thresholdMethod": 0,
            "thresholdAmount": 0.0,
            "returnTaxDays": 0,
            "taxTypeCode": "8",
            "taxTypeCharacters": "I",
            "taxTableCode": "",
            "compoundTax": [],
            "taxClassInfo": [],
            "description": "Override"
          },
          {
            "taxCode": "3",
            "taxRate": 0.075,
            "returnTaxDays": 0,
            "taxTypeCode": "9",
            "taxTypeCharacters": "ST1",
            "taxTableCode": "",
            "compoundTax": [
              {
                "taxTypeCode": "8"
              }
            ],
            "taxClassInfo": [],
            "description": "7.5% State Tax"
          }
        ]
      }
    ]
  },
  "Success": true
}