{"openapi":"3.1.0","info":{"title":"Legacy API Reference","version":"1.0.0"},"paths":{"/Ping":{"post":{"operationId":"essentials_ping","summary":"Ping","description":"If this call fails, API credentials are questionable.\n","tags":["essentials"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_PingResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Ping Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_PingRequest"}}}}}},"/VerifyAddress":{"post":{"operationId":"essentials_verifyAddress","summary":"Verify Address","description":"Verify (hopefully improve) a customer provided delivery address. <B>VERY IMPORTANT</B> for proper tax juridiction assesment. \n","tags":["essentials"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_VerifyAddressResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Lookup Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_VerifyAddress"}}}}}},"/Lookup":{"post":{"operationId":"essentials_basicLookup","summary":"Lookup","description":"Lookup is the \"work horse\" of our APIs. Determine applicable tax amounts for items being purchased based on a variety of factors.\n","tags":["essentials"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_LookupResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Lookup Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_LookupRequest"}}}}}},"/AuthorizedWithCapture":{"post":{"operationId":"essentials_basicAuthCap","summary":"Authorized with Capture","description":"Authorize and Capture a previous Lookup request. <b>Required for tax reporting.</b>\n","tags":["essentials"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_AuthorizedWithCaptureResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Authorized With Capture Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_AuthorizedWithCapture"}}}}}},"/Returned":{"post":{"operationId":"essentials_basicReturned","summary":"Returned","description":"Return an entire order previously <i>Captured</i>.\n","tags":["essentials"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_ReturnedResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Return a previously captured order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_Returned"}}}}}},"/LookupForDate":{"post":{"operationId":"advanced_dateLookup","summary":"Lookup for Date","description":"Lookup applicable tax amounts, based on a particular date, for items being purchased based on a variety of factors.\n","tags":["advanced"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_LookupResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Lookup Request for a particular date","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_LookupForDate"}}}}}},"/Authorized":{"post":{"operationId":"advanced_basicAuthorized","summary":"Authorized","description":"Mark a previous Lookup as Authorized. Authorized should be called <b>after</b> the similar step with your payment processor.\n","tags":["advanced"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_AuthorizedResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Mark a previous Lookup as Authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_Authorized"}}}}}},"/Captured":{"post":{"operationId":"advanced_basicCaptured","summary":"Captured","description":"Mark a previously Authorized order as Captured. Captured should be called <b>after</b> the similar step with your payment processor. Typically the Captured API is called when you ship your order to your customer. <b>This is the actual date of taxation, triggered by transfer of possesion from the seller to the buyer.</b>\n","tags":["advanced"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_CapturedResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Mark a previously Authorized order as Captured","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_Captured"}}}}}},"/ReturnedPro":{"post":{"operationId":"advanced_proReturned","summary":"Returned Pro","description":"Return or adjust a previously Captured transaction. [Additional License Required]. Our regular Returned API does not allow you to return (adjust) the original sales price. ReturnedPro enables you to Return a negative quantity, thereby increasing the original sales price (such as when a customer doesn't want to wait for a back-ordered item, and opts for a more expensive product instead).\n","tags":["advanced"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_ReturnedProResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Return or adjust a previously Captured transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_ReturnedPro"}}}}}},"/AddExemptCertificate":{"post":{"operationId":"exemptionCertificates_addExemptionCert","summary":"Add Exemption Certificate","description":"Create a TaxCloud maintained Exemption Certificate.\n","tags":["exemptionCertificates"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_AddExemptCertificateResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Create a TaxCloud maintained Exemption Certificate.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_AddExemptCertificate"}}}}}},"/GetExemptCertificates":{"post":{"operationId":"exemptionCertificates_getExemptionCertificates","summary":"Get Exemption Certificates","description":"Get a list of Exemption Certificate previously saved in TaxCloud for a particular customerID\n","tags":["exemptionCertificates"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_GetExemptCertificatesResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Get a list of Exemption Certificate previously saved in TaxCloud for a particular customerID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_GetExemptCertificates"}}}}}},"/DeleteExemptCertificate":{"post":{"operationId":"exemptionCertificates_deleteExemptionCertificate","summary":"Delete Exemption Certificate","description":"Delete previously saved Exemption Certificate. Technically, the certificate is marked as disabled (invalid for further use). There are no deletes in TaxCloud.\n","tags":["exemptionCertificates"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_DeleteExemptCertificateResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Delete previously saved Exemption Certificate. Technically, the certificate is marked as disabled (invalid for further use). There are no deletes in TaxCloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_DeleteExemptCertificate"}}}}}},"/GetTICs":{"post":{"operationId":"tiCs_getAllTics","summary":"Get all TICs","description":"Retrieve a list of all TaxCloud Taxability Information Codes\n","tags":["tiCs"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_GetAllTicsResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Retrieve a list of all TaxCloud Taxability Information Codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_GetAllTics"}}}}}},"/GetTICGroups":{"post":{"operationId":"tiCs_getTICGroups","summary":"Get TIC Groups","description":"Get a list of TaxCloud Taxability Information Code Groupings\n","tags":["tiCs"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_GetTICGroupsResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Get a list of TaxCloud Taxability Information Code Groupings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_GetTICGroups"}}}}}},"/GetTICsByGroup":{"post":{"operationId":"tiCs_getTicsByGroup","summary":"Get TICS by Group","description":"Retrieve a list of all TaxCloud Taxability Information Codes for a particular group\n","tags":["tiCs"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_GetTICsByGroupResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Retrieve a list of all TaxCloud Taxability Information Codes for a particular group","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_GetTICsByGroup"}}}}}},"/CreatePlatformAccount":{"post":{"operationId":"partners_createPlatformAccount","summary":"Create Platform Account","description":"Provision a new TaxCloud Account [Additional License Required] \n","tags":["partners"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_CreatePlatformAccountResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Create a new TaxCloud account for your customer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_CreatePlatformAccount"}}}}}},"/GetLocations":{"post":{"operationId":"partners_getLocations","summary":"Get Locations","description":"Get a list of the locations currently associated with the TaxCloud account associated with the API ID being used.\n","tags":["partners"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_GetLocationsResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Create a new TaxCloud account for your customer.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_GetLocations"}}}}}},"/AddTransactions":{"post":{"operationId":"partners_addTransactions","summary":"Add Transactions","description":"Add a batch of transactions from offline sources.\n","tags":["partners"],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_AddTransactionsResponse"}}}},"500":{"description":"Unexpected Error","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"description":"Add a batch of transactions from offline sources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/API_v1_AddTransactions"}}}}}}},"tags":[{"name":"essentials"},{"name":"advanced"},{"name":"exemptionCertificates"},{"name":"tiCs"},{"name":"partners"}],"servers":[{"url":"https://api.taxcloud.net/1.0/TaxCloud","description":"TaxCloud Production Environment"}],"components":{"schemas":{"API_v1_apiLoginID":{"type":"string","minLength":7,"maxLength":8,"description":"Find your API ID via <a href=\"https://app.taxcloud.com/go/stores/\" target=\"_blank\">https://app.taxcloud.com/go/stores/</a>","title":"apiLoginID"},"API_v1_apiKey":{"type":"string","minLength":8,"maxLength":8,"description":"Find your API KEY via <a href=\"https://app.taxcloud.com/go/stores/\" target=\"_blank\">https://app.taxcloud.com/go/stores/</a>","title":"apiKey"},"API_v1_PingRequest":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"}},"required":["apiLoginID","apiKey"],"title":"PingRequest"},"API_v1_ResponseType":{"type":"integer","description":"Response Types include <ul><li>0 = Error. Likely invalid API Credentials</li><li>1 = Warning. Something is wrong.</li><li>2 = Informational. Something could be better</li><li><b>3 = SUCCESS!</b> You did it!","title":"ResponseType"},"API_v1_Messages":{"type":"array","items":{"type":"string"},"description":"Optional array of messages related to the response.","title":"Messages"},"API_v1_PingResponse":{"type":"object","properties":{"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"PingResponse"},"API_v1_VerifyAddress":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"Address1":{"type":"string","minLength":5,"maxLength":50},"Address2":{"type":"string","minLength":0,"maxLength":50},"City":{"type":"string","minLength":0,"maxLength":50},"State":{"type":"string","minLength":2,"maxLength":2},"Zip5":{"type":"number","format":"double"},"Zip4":{"type":"number","format":"double"}},"required":["apiLoginID","apiKey","Address1","City","State"],"title":"VerifyAddress"},"API_v1_VerifyAddressResponseVerifyAddressResult":{"type":"object","properties":{"ErrNumber":{"type":"string","description":"Our response for VerifyAddress is a little odd.  If ErrNumber is \"0\" then there was no error, and ErrDescription will be null. <b style=\"color:red;\">IMORTANT</b> Even if there are errors (the address couldn't be validated/improved) <b style=\"color:red;\">YOU SHOULD PROCEED WITH THE CUSTOMER PROVIDED ADDRESS</b>."},"ErrDescription":{"type":"string","description":"If null, there were no errors."},"Address1":{"type":"string"},"Address2":{"type":"string"},"City":{"type":"string"},"State":{"type":"string"},"Zip5":{"type":"string"},"Zip4":{"type":"string"}},"title":"VerifyAddressResponseVerifyAddressResult"},"API_v1_VerifyAddressResponse":{"type":"object","properties":{"VerifyAddressResult":{"$ref":"#/components/schemas/API_v1_VerifyAddressResponseVerifyAddressResult"}},"title":"VerifyAddressResponse"},"API_v1_customerID":{"type":"string","minLength":5,"maxLength":50,"description":"This should be the abstract identifier used by your system to uniquely identify customers. <i style=\"color:red;\">**Note:** This should <b>not</b> be your customer's email address or any other form of Personally Identifiable Information (PII).</i>","title":"customerID"},"API_v1_cartID":{"type":"string","format":"uuid","minLength":5,"maxLength":50,"description":"CartID is very similar to an Order ID, except most systems do not issue immutable (permanent) identifiers for orders until customers actually place their order (clicking the BUY button).<p/><div><B>IMPORTANT:</B> You must be able to persist the CartID accross all Lookup requests for a particular customer (including situations where a customer puts an item in her cart before logging in, then proceeds ordering after logging in).<p/>If your system does not provide a mechanism to create unique identifiers, you can omit this parameter (or submit as null) and TaxCloud will provide a unique identifier in the response (which you should persist for subsequent <i>Lookup</i> calls and the ultimate <i>Authorized</i> or <i>AuthorizedWithCapture</i> calls).</div>","title":"cartID"},"API_v1_deliveredBySeller":{"type":"boolean","default":false,"description":"If you ship orders to customers via common carrier (USPS, UPS, FedEx, etc) should always be false.","title":"deliveredBySeller"},"API_v1_Address.Address1":{"type":"string","minLength":5,"maxLength":50,"title":"Address.Address1"},"API_v1_Address.Address2":{"type":"string","minLength":0,"maxLength":50,"title":"Address.Address2"},"API_v1_Address.City":{"type":"string","minLength":0,"maxLength":50,"title":"Address.City"},"API_v1_Address.State":{"description":"Any type","title":"Address.State"},"API_v1_Address.Zip5":{"type":"number","format":"double","title":"Address.Zip5"},"API_v1_Address.Zip4":{"type":"number","format":"double","title":"Address.Zip4"},"API_v1_Address":{"type":"object","properties":{"Address1":{"$ref":"#/components/schemas/API_v1_Address.Address1"},"Address2":{"$ref":"#/components/schemas/API_v1_Address.Address2"},"City":{"$ref":"#/components/schemas/API_v1_Address.City"},"State":{"$ref":"#/components/schemas/API_v1_Address.State"},"Zip5":{"$ref":"#/components/schemas/API_v1_Address.Zip5"},"Zip4":{"$ref":"#/components/schemas/API_v1_Address.Zip4"}},"required":["Address1","City","State","Zip5","Zip4"],"title":"Address"},"API_v1_CartItem":{"type":"object","properties":{"Index":{"type":"integer"},"ItemID":{"type":"string","minLength":5,"maxLength":50},"TIC":{"type":"integer","maximum":99999},"Price":{"type":"string","title":"float"},"Qty":{"type":"integer"},"Tax":{"type":"string","title":"float","description":"<b>Tax</b> property is only valid for use with TIC 99999 (in-store sales)"}},"required":["Index","ItemID","TIC","Price","Qty"],"title":"CartItem"},"API_v1_cartItems":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_CartItem"},"title":"cartItems"},"API_v1_LookupRequest":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"customerID":{"$ref":"#/components/schemas/API_v1_customerID"},"cartID":{"$ref":"#/components/schemas/API_v1_cartID"},"deliveredBySeller":{"$ref":"#/components/schemas/API_v1_deliveredBySeller"},"origin":{"$ref":"#/components/schemas/API_v1_Address"},"destination":{"$ref":"#/components/schemas/API_v1_Address"},"cartItems":{"$ref":"#/components/schemas/API_v1_cartItems"}},"required":["apiLoginID","apiKey","customerID","deliveredBySeller","origin","destination","cartItems"],"title":"LookupRequest"},"API_v1_CartItemResponse":{"type":"object","properties":{"CartItemIndex":{"type":"integer"},"TaxAmount":{"type":"string","title":"float"}},"title":"CartItemResponse"},"API_v1_LookupResponseLookupResult":{"type":"object","properties":{"CartID":{"$ref":"#/components/schemas/API_v1_cartID"},"CartItemsResponse":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_CartItemResponse"}},"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"LookupResponseLookupResult"},"API_v1_LookupResponse":{"type":"object","properties":{"LookupResult":{"$ref":"#/components/schemas/API_v1_LookupResponseLookupResult"}},"title":"LookupResponse"},"API_v1_orderID":{"type":"string","minLength":5,"maxLength":50,"description":"This is the immutable Order identifier used by your system to idenitify unique orders.","title":"orderID"},"API_v1_dateAuthorized":{"type":"string","format":"date-time","description":"The Date/Time of record for Authorization. If omitted, this value is inferred from the time the API call is received.","title":"dateAuthorized"},"API_v1_dateCaptured":{"type":"string","format":"date-time","description":"The Date/Time of record for Capture (or shipping date). If omitted, this value is inferred from the time the API call is received.","title":"dateCaptured"},"API_v1_AuthorizedWithCapture":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"customerID":{"$ref":"#/components/schemas/API_v1_customerID"},"cartID":{"$ref":"#/components/schemas/API_v1_cartID"},"orderID":{"$ref":"#/components/schemas/API_v1_orderID"},"dateAuthorized":{"$ref":"#/components/schemas/API_v1_dateAuthorized"},"dateCaptured":{"$ref":"#/components/schemas/API_v1_dateCaptured"}},"required":["apiLoginID","apiKey","customerID","cartID","orderID"],"title":"AuthorizedWithCapture"},"API_v1_AuthorizedWithCaptureResponseAuthorizedWithCaptureResult":{"type":"object","properties":{"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"AuthorizedWithCaptureResponseAuthorizedWithCaptureResult"},"API_v1_AuthorizedWithCaptureResponse":{"type":"object","properties":{"AuthorizedWithCaptureResult":{"$ref":"#/components/schemas/API_v1_AuthorizedWithCaptureResponseAuthorizedWithCaptureResult"}},"title":"AuthorizedWithCaptureResponse"},"API_v1_dateReturned":{"type":"string","format":"date-time","description":"The Date/Time the order was returned. <b>IMPORTANT:</b> Returning a previously captured order will create a tax credit which TaxCloud will automatically track and deduct from your next tax remittance.<p/>Although our Returned API requires you to set the ReturnedDate parameter, this <b>should be set to today's date</b> unless you know what you are doing.<p/><b>TO BE VERY CLEAR:</b> If you provide a <i>returnedDate</i>, such as the original purchase date, and the tax return for that period has already been filed, you will trigger an obligation for TaxCloud (or any tax preparer) to file an <b>Amended Sales Tax Return</b> for that period (and likely any interviening period through current). <b>AMENDED RETURNS INCUR AMENDMENT FEES</b>.","title":"dateReturned"},"API_v1_Returned":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"orderID":{"$ref":"#/components/schemas/API_v1_orderID"},"cartItems":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_cartItems"}},"returnedDate":{"$ref":"#/components/schemas/API_v1_dateReturned"}},"required":["apiLoginID","apiKey","orderID"],"title":"Returned"},"API_v1_ReturnedResponseReturnedResult":{"type":"object","properties":{"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"ReturnedResponseReturnedResult"},"API_v1_ReturnedResponse":{"type":"object","properties":{"ReturnedResult":{"$ref":"#/components/schemas/API_v1_ReturnedResponseReturnedResult"}},"title":"ReturnedResponse"},"API_v1_LookupForDate":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"useDate":{"type":"string","format":"date-time","description":"Rather than inferring the Lookup date, specify the Lookup date."},"customerID":{"$ref":"#/components/schemas/API_v1_customerID"},"cartID":{"$ref":"#/components/schemas/API_v1_cartID"},"deliveredBySeller":{"$ref":"#/components/schemas/API_v1_deliveredBySeller"},"origin":{"$ref":"#/components/schemas/API_v1_Address"},"destination":{"$ref":"#/components/schemas/API_v1_Address"},"cartItems":{"$ref":"#/components/schemas/API_v1_cartItems"}},"required":["apiLoginID","apiKey","customerID","deliveredBySeller","origin","destination","cartItems"],"title":"LookupForDate"},"API_v1_Authorized":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"customerID":{"$ref":"#/components/schemas/API_v1_customerID"},"cartID":{"$ref":"#/components/schemas/API_v1_cartID"},"orderID":{"$ref":"#/components/schemas/API_v1_orderID"},"dateAuthorized":{"$ref":"#/components/schemas/API_v1_dateAuthorized"}},"required":["apiLoginID","apiKey","customerID","cartID","orderID"],"title":"Authorized"},"API_v1_AuthorizedResponseAuthorizedResult":{"type":"object","properties":{"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"AuthorizedResponseAuthorizedResult"},"API_v1_AuthorizedResponse":{"type":"object","properties":{"AuthorizedResult":{"$ref":"#/components/schemas/API_v1_AuthorizedResponseAuthorizedResult"}},"title":"AuthorizedResponse"},"API_v1_Captured":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"orderID":{"$ref":"#/components/schemas/API_v1_orderID"}},"required":["apiLoginID","apiKey","orderID"],"title":"Captured"},"API_v1_CapturedResponseCapturedResult":{"type":"object","properties":{"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"CapturedResponseCapturedResult"},"API_v1_CapturedResponse":{"type":"object","properties":{"CapturedResult":{"$ref":"#/components/schemas/API_v1_CapturedResponseCapturedResult"}},"title":"CapturedResponse"},"API_v1_ReturnedPro":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"orderID":{"$ref":"#/components/schemas/API_v1_orderID"},"cartItems":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_cartItems"}},"returnedDate":{"$ref":"#/components/schemas/API_v1_dateReturned"}},"required":["apiLoginID","apiKey","orderID"],"title":"ReturnedPro"},"API_v1_ReturnedProResponseReturnedProResult":{"type":"object","properties":{"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"ReturnedProResponseReturnedProResult"},"API_v1_ReturnedProResponse":{"type":"object","properties":{"ReturnedProResult":{"$ref":"#/components/schemas/API_v1_ReturnedProResponseReturnedProResult"}},"title":"ReturnedProResponse"},"API_v1_CertificateID":{"type":"string","format":"uuid","title":"CertificateID"},"API_v1_State":{"type":"string","enum":["AL","AK","AZ","AR","CA","CO","CT","DE","DC","FL","GA","HI","ID","IL","IN","IA","KS","KY","LA","ME","MD","MA","MI","MN","MS","MO","MT","NE","NV","NH","NJ","NM","NY","NC","ND","OH","OK","OR","PA","RI","SC","SD","TN","TX","UT","VT","VA","WA","WV","WI","WY"],"title":"State"},"API_v1_ExemptState":{"type":"object","properties":{"StateAbbr":{"$ref":"#/components/schemas/API_v1_State"},"ReasonForExemption":{"type":"string","minLength":5,"maxLength":50},"IdentificationNumber":{"type":"string","minLength":5,"maxLength":50}},"required":["StateAbbr","ReasonForExemption","IdentificationNumber"],"title":"ExemptState"},"API_v1_ExemptStates":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_ExemptState"},"description":"Typically, Exemption Certificates are state-by-state, however, for Federal Government Purchasers, multiple states can be specified.","title":"ExemptStates"},"API_v1_TaxType":{"type":"string","title":"TaxType"},"API_v1_ExemptPurchaserTaxID":{"type":"object","properties":{"TaxType":{"$ref":"#/components/schemas/API_v1_TaxType"},"IDNumber":{"type":"string","minLength":5,"maxLength":50},"StateOfIssue":{"$ref":"#/components/schemas/API_v1_State"}},"required":["TaxType","IDNumber","StateOfIssue"],"title":"ExemptPurchaserTaxID"},"API_v1_ExemptPurchaserBusinessType":{"type":"string","enum":["AccommodationAndFoodServices","Agricultural_Forestry_Fishing_Hunting","Construction","FinanceAndInsurance","Information_PublishingAndCommunications","Manufacturing","Mining","RealEstate","RentalAndLeasing","RetailTrade","TransportationAndWarehousing","Utilities","WholesaleTrade","BusinessServices","ProfessionalServices","EducationAndHealthCareServices","NonprofitOrganization","Government","NotABusiness","Other"],"title":"ExemptPurchaserBusinessType"},"API_v1_PurchaserExemptionReason":{"type":"string","enum":["FederalGovernmentDepartment","StateOrLocalGovernmentName","TribalGovernmentName","ForeignDiplomat","CharitableOrganization","EducationalOrganization","Resale","AgriculturalProduction","IndustrialProductionOrManufacturing","DirectPayPermit","DirectMail","Other","ReligiousOrganization"],"title":"PurchaserExemptionReason"},"API_v1_ExemptionCertificateDetail":{"type":"object","properties":{"ExemptStates":{"$ref":"#/components/schemas/API_v1_ExemptStates"},"PurchaserFirstName":{"type":"string","minLength":5,"maxLength":50},"PurchaserLastName":{"type":"string","minLength":5,"maxLength":50},"PurchaserTitle":{"type":"string","minLength":5,"maxLength":50},"PurchaserAddress1":{"type":"string","minLength":5,"maxLength":50},"PurchaserAddress2":{"type":"string","minLength":5,"maxLength":50},"PurchaserCity":{"type":"string","minLength":5,"maxLength":50},"PurchaserState":{"type":"string","minLength":5,"maxLength":2},"PurchaserZip":{"type":"string","minLength":5,"maxLength":5},"PurchaserTaxID":{"$ref":"#/components/schemas/API_v1_ExemptPurchaserTaxID"},"PurchaserBusinessType":{"$ref":"#/components/schemas/API_v1_ExemptPurchaserBusinessType"},"PurchaserBusinessTypeOtherValue":{"type":"string","minLength":5,"maxLength":50,"description":"Required if PurchaserBusinessType selected is \"Other\""},"PurchaserExemptionReason":{"$ref":"#/components/schemas/API_v1_PurchaserExemptionReason"},"PurchaserExemptionReasonOtherValue":{"type":"string","minLength":5,"maxLength":50,"description":"Required if PurchaserExemptionReason selected is \"Other\""},"CreatedDate":{"type":"string","format":"date-time","description":"The Date/Time of the exemption certificate being created. If omitted, this value is inferred from the time the API call is received. Exemption Certificate is not valid (will not be honored by TaxCloud) before this date."}},"required":["ExemptStates","PurchaserFirstName","PurchaserLastName","PurchaserTitle","PurchaserAddress1","PurchaserAddress2","PurchaserCity","PurchaserState","PurchaserZip","PurchaserTaxID","PurchaserBusinessType","PurchaserExemptionReason","CreatedDate"],"title":"ExemptionCertificateDetail"},"API_v1_exemptCert":{"type":"object","properties":{"CertificateID":{"$ref":"#/components/schemas/API_v1_CertificateID"},"Detail":{"$ref":"#/components/schemas/API_v1_ExemptionCertificateDetail"}},"title":"exemptCert"},"API_v1_AddExemptCertificate":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"customerID":{"$ref":"#/components/schemas/API_v1_customerID"},"exemptCert":{"$ref":"#/components/schemas/API_v1_exemptCert"}},"required":["apiLoginID","apiKey","customerID","exemptCert"],"title":"AddExemptCertificate"},"API_v1_AddExemptCertificateResponseAddExemptCertificateResult":{"type":"object","properties":{"CertificateID":{"$ref":"#/components/schemas/API_v1_CertificateID"},"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"AddExemptCertificateResponseAddExemptCertificateResult"},"API_v1_AddExemptCertificateResponse":{"type":"object","properties":{"AddExemptCertificateResult":{"$ref":"#/components/schemas/API_v1_AddExemptCertificateResponseAddExemptCertificateResult"}},"title":"AddExemptCertificateResponse"},"API_v1_GetExemptCertificates":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"customerID":{"$ref":"#/components/schemas/API_v1_customerID"}},"required":["apiLoginID","apiKey","customerID"],"title":"GetExemptCertificates"},"API_v1_ExemptionCertificate":{"type":"object","properties":{"CertificateID":{"$ref":"#/components/schemas/API_v1_CertificateID"},"Detail":{"$ref":"#/components/schemas/API_v1_ExemptionCertificateDetail"}},"title":"ExemptionCertificate"},"API_v1_GetExemptCertificatesResponseGetExemptCertificatesResult":{"type":"object","properties":{"ExemptCertificates":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_ExemptionCertificate"}},"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"GetExemptCertificatesResponseGetExemptCertificatesResult"},"API_v1_GetExemptCertificatesResponse":{"type":"object","properties":{"GetExemptCertificatesResult":{"$ref":"#/components/schemas/API_v1_GetExemptCertificatesResponseGetExemptCertificatesResult"}},"title":"GetExemptCertificatesResponse"},"API_v1_DeleteExemptCertificate":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"certificateID":{"$ref":"#/components/schemas/API_v1_CertificateID"}},"required":["apiLoginID","apiKey","certificateID"],"title":"DeleteExemptCertificate"},"API_v1_DeleteExemptCertificateResponseDeleteExemptCertificateResult":{"type":"object","properties":{"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"DeleteExemptCertificateResponseDeleteExemptCertificateResult"},"API_v1_DeleteExemptCertificateResponse":{"type":"object","properties":{"DeleteExemptCertificateResult":{"$ref":"#/components/schemas/API_v1_DeleteExemptCertificateResponseDeleteExemptCertificateResult"}},"title":"DeleteExemptCertificateResponse"},"API_v1_GetAllTics":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"}},"required":["apiLoginID","apiKey"],"title":"GetAllTics"},"API_v1_TIC":{"type":"object","properties":{"TICID":{"type":"integer"},"Description":{"type":"string","maxLength":300}},"title":"TIC"},"API_v1_GetAllTicsResponseGetTiCsResult":{"type":"object","properties":{"TICs":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_TIC"}},"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"GetAllTicsResponseGetTiCsResult"},"API_v1_GetAllTicsResponse":{"type":"object","properties":{"GetTICsResult":{"$ref":"#/components/schemas/API_v1_GetAllTicsResponseGetTiCsResult"}},"title":"GetAllTicsResponse"},"API_v1_GetTICGroups":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"}},"required":["apiLoginID","apiKey"],"title":"GetTICGroups"},"API_v1_TICGroup":{"type":"object","properties":{"GroupID":{"type":"integer"},"Description":{"type":"string","maxLength":300}},"title":"TICGroup"},"API_v1_GetTicGroupsResponseGetTicGroupsResult":{"type":"object","properties":{"TICs":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_TICGroup"}},"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"GetTicGroupsResponseGetTicGroupsResult"},"API_v1_GetTICGroupsResponse":{"type":"object","properties":{"GetTICGroupsResult":{"$ref":"#/components/schemas/API_v1_GetTicGroupsResponseGetTicGroupsResult"}},"title":"GetTICGroupsResponse"},"API_v1_GetTICsByGroup":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"ticGroup":{"type":"integer"}},"required":["apiLoginID","apiKey","ticGroup"],"title":"GetTICsByGroup"},"API_v1_GetTiCsByGroupResponseGetTiCsByGroupResult":{"type":"object","properties":{"TICs":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_TIC"}},"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"GetTiCsByGroupResponseGetTiCsByGroupResult"},"API_v1_GetTICsByGroupResponse":{"type":"object","properties":{"GetTICsByGroupResult":{"$ref":"#/components/schemas/API_v1_GetTiCsByGroupResponseGetTiCsByGroupResult"}},"title":"GetTICsByGroupResponse"},"API_v1_CreatePlatformAccount":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"CompanyName":{"type":"string","minLength":5,"maxLength":50},"FirstName":{"type":"string","minLength":5,"maxLength":50},"LastName":{"type":"string","minLength":5,"maxLength":50},"Email":{"type":"string","format":"email","minLength":5,"maxLength":50}},"required":["apiLoginID","apiKey","CompanyName"],"title":"CreatePlatformAccount"},"API_v1_CreatePlatformAccountResponseCreatePlatformAccountResult":{"type":"object","properties":{"NewAccountApiID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"NewAccountApiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"CreatePlatformAccountResponseCreatePlatformAccountResult"},"API_v1_CreatePlatformAccountResponse":{"type":"object","properties":{"CreatePlatformAccountResult":{"$ref":"#/components/schemas/API_v1_CreatePlatformAccountResponseCreatePlatformAccountResult"}},"title":"CreatePlatformAccountResponse"},"API_v1_GetLocations":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"}},"required":["apiLoginID","apiKey"],"title":"GetLocations"},"API_v1_Location":{"type":"object","properties":{"LocationID":{"type":"integer"},"Name":{"type":"string","minLength":1,"maxLength":50},"PrimaryBusinessAddress":{"type":"boolean","default":true},"MailingAddress":{"type":"boolean","default":true},"Created":{"type":"string","format":"date-time"},"Address1":{"$ref":"#/components/schemas/API_v1_Address.Address1"},"Address2":{"$ref":"#/components/schemas/API_v1_Address.Address2"},"City":{"$ref":"#/components/schemas/API_v1_Address.City"},"State":{"$ref":"#/components/schemas/API_v1_Address.State"},"Zip5":{"$ref":"#/components/schemas/API_v1_Address.Zip5"},"Zip4":{"$ref":"#/components/schemas/API_v1_Address.Zip4"},"Country":{"type":"string","minLength":0,"maxLength":3,"description":"ISO 3166-1 alpha-3"}},"required":["Name","City","State"],"title":"Location"},"API_v1_GetLocationsResponseGetLocationsResult":{"type":"object","properties":{"Locations":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_Location"}},"NewAccountApiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"GetLocationsResponseGetLocationsResult"},"API_v1_GetLocationsResponse":{"type":"object","properties":{"GetLocationsResult":{"$ref":"#/components/schemas/API_v1_GetLocationsResponseGetLocationsResult"}},"title":"GetLocationsResponse"},"API_v1_TransactionCartItem":{"type":"object","properties":{"Index":{"type":"integer"},"ItemID":{"type":"string","minLength":5,"maxLength":50},"TIC":{"type":"integer","maximum":99999},"Price":{"type":"string","title":"float"},"Qty":{"type":"integer"},"Tax":{"type":"string","title":"float"},"Rate":{"type":"string","title":"float"}},"required":["Index","ItemID","TIC","Price","Qty","Rate"],"title":"TransactionCartItem"},"API_v1_Transaction":{"type":"object","properties":{"customerID":{"$ref":"#/components/schemas/API_v1_customerID"},"cartID":{"$ref":"#/components/schemas/API_v1_cartID"},"orderID":{"$ref":"#/components/schemas/API_v1_orderID"},"cartItems":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_TransactionCartItem"}},"deliveredBySeller":{"$ref":"#/components/schemas/API_v1_deliveredBySeller","default":false},"origin":{"$ref":"#/components/schemas/API_v1_Address"},"destination":{"$ref":"#/components/schemas/API_v1_Address"},"exemptCert":{"$ref":"#/components/schemas/API_v1_CertificateID"},"dateTransaction":{"type":"string","format":"date-time","description":"The Date/Time of order/invoice creation"},"dateAuthorized":{"$ref":"#/components/schemas/API_v1_dateAuthorized"},"dateCaptured":{"$ref":"#/components/schemas/API_v1_dateCaptured"}},"title":"Transaction"},"API_v1_AddTransactions":{"type":"object","properties":{"apiLoginID":{"$ref":"#/components/schemas/API_v1_apiLoginID"},"apiKey":{"$ref":"#/components/schemas/API_v1_apiKey"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/API_v1_Transaction"}}},"required":["apiLoginID","apiKey","transactions"],"title":"AddTransactions"},"API_v1_AddTransactionsResponseAddTransactionsResult":{"type":"object","properties":{"ResponseType":{"$ref":"#/components/schemas/API_v1_ResponseType"},"Messages":{"$ref":"#/components/schemas/API_v1_Messages"}},"title":"AddTransactionsResponseAddTransactionsResult"},"API_v1_AddTransactionsResponse":{"type":"object","properties":{"AddTransactionsResult":{"$ref":"#/components/schemas/API_v1_AddTransactionsResponseAddTransactionsResult"}},"title":"AddTransactionsResponse"}}}}