{"_id":"5632a5ea49e16d0d0012249d","githubsync":"","version":{"_id":"5632a5e549e16d0d00122443","__v":6,"project":"55b933b3146ef121002158d3","createdAt":"2015-10-29T23:04:05.701Z","releaseDate":"2015-10-29T23:04:05.701Z","categories":["5632a5e749e16d0d00122444","5632a5e749e16d0d00122445","5632a5e749e16d0d00122446","5632a5e749e16d0d00122447","5632a5e749e16d0d00122448","5632a5e749e16d0d00122449","5632a5e749e16d0d0012244a","5632a5e749e16d0d0012244b","5632a5e749e16d0d0012244c","5632a5e749e16d0d0012244d","5632a5e749e16d0d0012244e","5632a5e749e16d0d0012244f","5632a5e749e16d0d00122450","5632b179df556c0d00cd095b","564e13053b2b4a19000cd69b","59caa9df65accc001a489c95","59cab50965accc001a489d28","59cadd464ab7b70024378e74"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"project":"55b933b3146ef121002158d3","category":{"_id":"5632a5e749e16d0d0012244d","__v":1,"pages":["5632a5ea49e16d0d00122481","5632a5ea49e16d0d00122482","5632a5ea49e16d0d00122483","5632a5ea49e16d0d00122484","5632a5ea49e16d0d00122485","5632a5ea49e16d0d00122486","5632a5ea49e16d0d00122487","5632a5ea49e16d0d00122488","5632a5ea49e16d0d00122489","5632a5ea49e16d0d0012248a","5632a5ea49e16d0d0012248b","5632a5ea49e16d0d0012248c","5632a5ea49e16d0d0012248d","5632a5ea49e16d0d0012248e","5632a5ea49e16d0d0012248f","5632a5ea49e16d0d00122490","5632a5ea49e16d0d00122491","5632a5ea49e16d0d00122492","5632a5ea49e16d0d00122493","5632a5ea49e16d0d00122494","5632a5ea49e16d0d00122495","5632a5ea49e16d0d00122496","5632a5ea49e16d0d00122497","5632a5ea49e16d0d00122498","5632a5ea49e16d0d00122499","5632a5ea49e16d0d0012249a","5632a5ea49e16d0d0012249b","5632a5ea49e16d0d0012249c","5632a5ea49e16d0d0012249d","5632a5ea49e16d0d0012249e","5632a5ea49e16d0d0012249f","5632a5ea49e16d0d001224a0","5632a5ea49e16d0d001224a1","5632a5ea49e16d0d001224a2","5632a5ea49e16d0d001224a3","5632a5ea49e16d0d001224a4","5632a5ea49e16d0d001224a5","5632a5ea49e16d0d001224a6","5632a5ea49e16d0d001224a7"],"project":"55b933b3146ef121002158d3","version":"5632a5e549e16d0d00122443","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-04T17:34:02.800Z","from_sync":false,"order":12,"slug":"objects","title":"Objects"},"user":"55b932ba8fd1a02b00f496c8","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-04T17:58:24.556Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":27,"body":"Contains transaction specific data.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Description\"\n}\n[/block]\nThis object is used with several transaction methods and contains important transaction specific data such as invoice number, originating terminal, total amount of transaction, portions of total alloted for tip, tax and shipping, and currency code.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Properties\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Type\",\n    \"h-1\": \"Name\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"string\",\n    \"0-1\": \"Invoice\",\n    \"0-2\": \"Transaction invoice number. Will be truncated to 10 characters. If this field is not provided, the system will submit the RefNum in its place.\",\n    \"1-0\": \"string\",\n    \"1-1\": \"PONum\",\n    \"1-2\": \"Purchase Order Number for commercial card transactions - 25 characters. (Required for Level 2 & 3)\",\n    \"2-0\": \"string\",\n    \"2-1\": \"OrderID\",\n    \"2-2\": \"Transaction order ID. This field should be used to assign a unique order id to the transaction. The order ID can support 64 characters.\",\n    \"3-0\": \"string\",\n    \"3-1\": \"SessionID\",\n    \"3-2\": \"Optional Session ID used for customer analytics and fraud prevention. Must be get generated using the [getSession](/docs/getsession) method. See the profiling guide for more information\",\n    \"4-0\": \"string\",\n    \"4-1\": \"Clerk\",\n    \"4-2\": \"Sales Clerk. Optional value indicating the clerk/person processing transaction, for reporting purposes.\",\n    \"5-0\": \"string\",\n    \"5-1\": \"Terminal\",\n    \"5-2\": \"Terminal Name. Optional value indicating the terminal used to process transaction, for reporting purposes.\",\n    \"6-0\": \"string\",\n    \"6-1\": \"Table\",\n    \"6-2\": \"Restaurant Table Number. Optional value indicating the restaurant table, for reporting purposes\",\n    \"7-0\": \"string\",\n    \"7-1\": \"Description\",\n    \"7-2\": \"Transaction description.\",\n    \"8-0\": \"string\",\n    \"8-1\": \"Comments\",\n    \"8-2\": \"Comments. Free form text.\",\n    \"9-0\": \"boolean\",\n    \"9-1\": \"AllowPartialAuth\",\n    \"9-2\": \"Allow a partial authorization if full amount is not available (Defaults to false)\",\n    \"10-0\": \"double\",\n    \"10-1\": \"Amount\",\n    \"10-2\": \"Total billing amount. (Subtotal+Tax+Tip+Shipping-Discount=Amount.)\",\n    \"11-0\": \"string\",\n    \"11-1\": \"Currency\",\n    \"11-2\": \"Currency Code. 3 digit currency code of total amount.\",\n    \"12-0\": \"double\",\n    \"12-1\": \"Tax\",\n    \"12-2\": \"Portion of total amount that is tax. (Required for Level 2 & 3)\",\n    \"13-0\": \"double\",\n    \"13-1\": \"Tip\",\n    \"13-2\": \"Portion of total amount that is tip.\",\n    \"14-0\": \"boolean\",\n    \"14-1\": \"NonTax\",\n    \"14-2\": \"Determines whether a transaction is non-taxable.\",\n    \"15-0\": \"double\",\n    \"15-1\": \"Shipping\",\n    \"15-2\": \"Portion of total amount that is shipping charges. (Required for Level 3)\",\n    \"16-0\": \"double\",\n    \"16-1\": \"ShipFromZip\",\n    \"16-2\": \"Zipcode that the order is shipping from. (Required for Level 3)\",\n    \"17-0\": \"double\",\n    \"17-1\": \"Discount\",\n    \"17-2\": \"Amount of discount.\",\n    \"18-0\": \"double\",\n    \"18-1\": \"Duty\",\n    \"18-2\": \"Amount of duty charged. (Required for Level 3)\",\n    \"19-0\": \"double\",\n    \"19-1\": \"Subtotal\",\n    \"19-2\": \"The amount of the transaction before tax, tip, shipping and discount have been applied.\"\n  },\n  \"cols\": 3,\n  \"rows\": 20\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\n## Visual Basic (.Net) \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"Dim details As eBizCharge.TransactionDetail = New eBizCharge.TransactionDetail\\n       details.Amount = \\\"34.50\\\"\\n       details.AmountSpecified = True\\n       details.Description = \\\"Example QuickSale\\\"\\n       details.Invoice = \\\"123456\\\"\",\n      \"language\": \"asp\"\n    }\n  ]\n}\n[/block]\n## C Sharp (.Net)\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"eBizCharge.TransactionDetail details = new eBizCharge.TransactionDetail();\\n           details.Amount = 34.50;\\n           details.AmountSpecified = true;\\n           details.Description = \\\"Example QuickSale\\\";\\n           details.Invoice = \\\"123456\\\";\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"transactiondetail","type":"basic","title":"TransactionDetail"}
Contains transaction specific data. [block:api-header] { "type": "basic", "title": "Description" } [/block] This object is used with several transaction methods and contains important transaction specific data such as invoice number, originating terminal, total amount of transaction, portions of total alloted for tip, tax and shipping, and currency code. [block:api-header] { "type": "basic", "title": "Properties" } [/block] [block:parameters] { "data": { "h-0": "Type", "h-1": "Name", "h-2": "Description", "0-0": "string", "0-1": "Invoice", "0-2": "Transaction invoice number. Will be truncated to 10 characters. If this field is not provided, the system will submit the RefNum in its place.", "1-0": "string", "1-1": "PONum", "1-2": "Purchase Order Number for commercial card transactions - 25 characters. (Required for Level 2 & 3)", "2-0": "string", "2-1": "OrderID", "2-2": "Transaction order ID. This field should be used to assign a unique order id to the transaction. The order ID can support 64 characters.", "3-0": "string", "3-1": "SessionID", "3-2": "Optional Session ID used for customer analytics and fraud prevention. Must be get generated using the [getSession](/docs/getsession) method. See the profiling guide for more information", "4-0": "string", "4-1": "Clerk", "4-2": "Sales Clerk. Optional value indicating the clerk/person processing transaction, for reporting purposes.", "5-0": "string", "5-1": "Terminal", "5-2": "Terminal Name. Optional value indicating the terminal used to process transaction, for reporting purposes.", "6-0": "string", "6-1": "Table", "6-2": "Restaurant Table Number. Optional value indicating the restaurant table, for reporting purposes", "7-0": "string", "7-1": "Description", "7-2": "Transaction description.", "8-0": "string", "8-1": "Comments", "8-2": "Comments. Free form text.", "9-0": "boolean", "9-1": "AllowPartialAuth", "9-2": "Allow a partial authorization if full amount is not available (Defaults to false)", "10-0": "double", "10-1": "Amount", "10-2": "Total billing amount. (Subtotal+Tax+Tip+Shipping-Discount=Amount.)", "11-0": "string", "11-1": "Currency", "11-2": "Currency Code. 3 digit currency code of total amount.", "12-0": "double", "12-1": "Tax", "12-2": "Portion of total amount that is tax. (Required for Level 2 & 3)", "13-0": "double", "13-1": "Tip", "13-2": "Portion of total amount that is tip.", "14-0": "boolean", "14-1": "NonTax", "14-2": "Determines whether a transaction is non-taxable.", "15-0": "double", "15-1": "Shipping", "15-2": "Portion of total amount that is shipping charges. (Required for Level 3)", "16-0": "double", "16-1": "ShipFromZip", "16-2": "Zipcode that the order is shipping from. (Required for Level 3)", "17-0": "double", "17-1": "Discount", "17-2": "Amount of discount.", "18-0": "double", "18-1": "Duty", "18-2": "Amount of duty charged. (Required for Level 3)", "19-0": "double", "19-1": "Subtotal", "19-2": "The amount of the transaction before tax, tip, shipping and discount have been applied." }, "cols": 3, "rows": 20 } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] ## Visual Basic (.Net) [block:code] { "codes": [ { "code": "Dim details As eBizCharge.TransactionDetail = New eBizCharge.TransactionDetail\n details.Amount = \"34.50\"\n details.AmountSpecified = True\n details.Description = \"Example QuickSale\"\n details.Invoice = \"123456\"", "language": "asp" } ] } [/block] ## C Sharp (.Net) [block:code] { "codes": [ { "code": "eBizCharge.TransactionDetail details = new eBizCharge.TransactionDetail();\n details.Amount = 34.50;\n details.AmountSpecified = true;\n details.Description = \"Example QuickSale\";\n details.Invoice = \"123456\";", "language": "csharp" } ] } [/block]