📘

Response Definitions

For Response Definitions, visit Data Feilds That Taggun Extracts.

Example Request

curl --request POST \
     --url https://api.taggun.io/api/receipt/v1/verbose/encoded \
     --header 'accept: application/json' \
     --header 'apikey: 12345678abcd1234efgh567890abcdef' \
     --header 'content-type: application/json' \
     --data '
{
  "extractLineItems": true,
  "extractTime": false,
  "refresh": false,
  "incognito": false,
  "image": "example-file.png",
  "filename": "example-file-name",
  "contentType": " image/jpeg"
}
'

example-file.png:


























Example JSON Response

ℹ️

Important Notes

  • Region-specific data (X-Y) has been removed for readability.
  • Advanced features are not enabled in this example.
{
  "totalAmount": {
    "data": 14.42,
    "confidenceLevel": 0.9199999999999999,
    "text": "CP Card 14.42",
    "index": 20,
    "keyword": "-",
    "currencyCode": "USD",
    "regions": []
  },
  "taxAmount": {
    "data": 0.82,
    "confidenceLevel": 0.9199999999999999,
    "text": "Tax 0.82",
    "index": 18,
    "keyword": "-",
    "currencyCode": "USD",
    "regions": []
  },
  "discountAmount": {
    "confidenceLevel": 0
  },
  "paidAmount": {
    "data": 14.42,
    "confidenceLevel": 0.9199999999999999,
    "text": "CP Card 14.42",
    "index": 20,
    "regions": []
  },
  "confidenceLevel": 0.898,
  "date": {
    "data": "2024-09-25T12:00:00.000Z",
    "confidenceLevel": 0.9199999999999999,
    "text": "Host: Cicily 09/25/2024",
    "index": 6,
    "regions": []
  },
  "dueDate": {
    "confidenceLevel": 0
  },
  "text": {
    "text": "CHIPOTLE\nMEVIC GRILL\nBUILD-YOUR-OWN HAPPINESS\n702 E Boise Avenue\nBoise, ID 83706\n208-509-4827\nHost: Cicily 09/25/2024\n7:16 PM\nORDER #409 10310\nChicken Bowl 9.10\nGuacamole\nChips 2.65\n1.85\nHow're we doing? Let us know at\nChipotleFeedback.com\nUnique Code:\n390 009 100 054 210 001 71\nSubtotal 13.60\nTax 0.82\nTAKE OUT Total 14.42\nCP Card 14.42\nAuthorizing. ..\nBalance Due 14.42\nLove Chipotle? Join Our Team\nGet great benefits like:\nFree Chipotle\nDebt-free college degrees\nBonus eligibility\nRapid career growth\nAnd more!\nVisit jobs.chipotle.com\nText \"CHIPJOBS\" to 97211",
    "regions": []
  },
  "amounts": [
    {
      "data": 9.1,
      "index": 9,
      "regions": [],
      "text": "Chicken Bowl 9.10"
    },
    {
      "data": 2.65,
      "index": 11,
      "regions": [],
      "text": "Chips 2.65"
    },
    {
      "data": 1.85,
      "index": 12,
      "regions": [],
      "text": "1.85"
    },
    {
      "data": 13.6,
      "index": 17,
      "regions": [],
      "text": "Subtotal 13.60"
    },
    {
      "data": 0.82,
      "index": 18,
      "regions": [],
      "text": "Tax 0.82"
    },
    {
      "data": 14.42,
      "index": 19,
      "regions": [],
      "text": "TAKE OUT Total 14.42"
    },
    {
      "data": 14.42,
      "index": 20,
      "regions": [],
      "text": "CP Card 14.42"
    },
    {
      "data": 14.42,
      "index": 22,
      "regions": [],
      "text": "Balance Due 14.42"
    }
  ],
  "numbers": [
    {
      "data": 702,
      "text": "702 E Boise Avenue",
      "regions": [],
      "index": 3
    },
    {
      "data": 83706,
      "text": "Boise, ID 83706",
      "regions": [],
      "index": 4
    },
    {
      "data": 409,
      "text": "ORDER #409 10310",
      "regions": [],
      "index": 8,
      "classifyResult": "primaryTotal"
    },
    {
      "data": 10310,
      "text": "ORDER #409 10310",
      "regions": [],
      "index": 8,
      "classifyResult": "primaryTotal"
    },
    {
      "data": 390,
      "text": "390 009 100 054 210 001 71",
      "regions": [],
      "index": 16
    },
    {
      "data": 100,
      "text": "390 009 100 054 210 001 71",
      "regions": [],
      "index": 16
    },
    {
      "data": 210,
      "text": "390 009 100 054 210 001 71",
      "regions": [],
      "index": 16
    },
    {
      "data": 71,
      "text": "390 009 100 054 210 001 71",
      "regions": [],
      "index": 16
    },
    {
      "data": 97211,
      "text": "Text \"CHIPJOBS\" to 97211",
      "regions": [],
      "index": 31
    }
  ],
  "entities": {
    "productLineItems": [
      {
        "data": {
          "quantity": {
            "data": 1,
            "regions": [],
            "text": "1"
          },
          "unitPrice": {
            "data": 9.1,
            "regions": [],
            "text": "9.10"
          },
          "totalPrice": {
            "data": 9.1,
            "regions": [],
            "text": "9.10"
          },
          "name": {
            "data": "Chicken Bowl",
            "regions": [],
            "text": "Chicken Bowl"
          }
        },
        "confidenceLevel": 0.65,
        "text": "Chicken Bowl 9.10",
        "index": 9,
        "regions": []
      },
      {
        "data": {
          "quantity": {
            "data": 1,
            "regions": [],
            "text": "1"
          },
          "unitPrice": {
            "data": 1.85,
            "regions": [],
            "text": "1.85"
          },
          "totalPrice": {
            "data": 1.85,
            "regions": [],
            "text": "1.85"
          },
          "name": {
            "data": "Guacamole",
            "regions": [],
            "text": "Guacamole"
          }
        },
        "confidenceLevel": 0.65,
        "text": "Guacamole",
        "index": 10,
        "regions": []
      },
      {
        "data": {
          "quantity": {
            "data": 1,
            "regions": [],
            "text": "1"
          },
          "unitPrice": {
            "data": 2.65,
            "regions": [],
            "text": "2.65"
          },
          "totalPrice": {
            "data": 2.65,
            "regions": [],
            "text": "2.65"
          },
          "name": {
            "data": "Chips",
            "regions": [],
            "text": "Chips"
          }
        },
        "confidenceLevel": 0.65,
        "text": "Chips 2.65",
        "index": 11,
        "regions": []
      }
    ],
    "invoiceNumber": {
      "confidenceLevel": 0
    },
    "receiptNumber": {
      "data": "10310",
      "confidenceLevel": 0.9199999999999999,
      "text": "ORDER #409 10310",
      "keyword": "-",
      "index": 8,
      "regions": []
    },
    "last4": {
      "confidenceLevel": 0
    },
  "lineAmounts": [],
  "itemsCount": {
    "data": 0,
    "confidenceLevel": 0
  },
  "paymentType": {
    "confidenceLevel": 0
  },
  "trackingId": "T-20241008-6053437",
  "merchantName": {
    "data": "CHIPOTLE",
    "confidenceLevel": 0.8100000000000002,
    "text": "CHIPOTLE",
    "index": 0,
    "regions": []
  },
  "merchantAddress": {
    "data": "702 E Boise Ave, Boise, Idaho, 83706",
    "confidenceLevel": 0.99,
    "text": "702 E Boise Avenue\nBoise, ID 83706",
    "index": 4,
    "regions": []
  },
  "merchantCity": {
    "data": "Boise",
    "confidenceLevel": 0.99,
    "text": "702 E Boise Avenue\nBoise, ID 83706",
    "index": 4,
    "regions": []
  },
  "merchantState": {
    "data": "Ada County, Idaho",
    "confidenceLevel": 0.99,
    "text": "702 E Boise Avenue\nBoise, ID 83706",
    "index": 4,
    "regions": []
  },
  "merchantCountryCode": {
    "data": "US",
    "confidenceLevel": 0.99,
    "text": "702 E Boise Avenue\nBoise, ID 83706",
    "index": 4,
    "regions": []
  },
  "merchantPostalCode": {
    "data": "83706",
    "confidenceLevel": 0.99,
    "text": "702 E Boise Avenue\nBoise, ID 83706",
    "index": 4,
    "regions": []
  },
  "targetRotation": 0,
  "elapsed": 4538.480549000204
}