{"info":{"_postman_id":"02068479-4c2f-454a-a602-bd67e01ca15a","name":"Vertex Rest API","description":"

These are the Vertex REST API end points available as of Feb 24, 2018.

Any questions or interest in integrating to Vertex Cloud please email cloudsupport@vertexinc.com.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8370452","collectionId":"02068479-4c2f-454a-a602-bd67e01ca15a","publishedId":"SVYtNJVZ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2019-08-08T16:48:08.000Z"},"item":[{"name":"v1","item":[{"name":"Retrieves tax area information using a postal address as the criteria.","id":"48bcd2aa-343f-418d-b143-8887e3c91f3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"postalAddress\": {\n \"streetAddress1\": \"\",\n \"streetAddress2\": \"\",\n \"city\": \"\",\n \"mainDivision\": \"\",\n \"subDivision\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n },\n \"asOfDate\": \"\",\n \"lookupId\": \"\"\n}"},"url":"#unknown://#unknown/vertex-restapi/v1/addresslookup","description":"

The address idklookupsdfsd process takes an address and attempts to verify and cleanse the address by determining possible vertex defined tax areas and associated jurisdictions.

\n","urlObject":{"hash":"unknown://#unknown/vertex-restapi/v1/addresslookup","query":[],"variable":[{"id":"ef306574-fd55-4dbb-a148-dc61cc7e881a","description":{"content":"","type":"text/plain"},"type":"string","value":"unknown","key":"CloudApiDnsProtocol"},{"id":"7d96ff2e-1ff4-413c-a4ca-11836e4c111b","description":{"content":"","type":"text/plain"},"type":"string","value":"unknown","key":"CloudApiDnsName"}]}},"response":[{"id":"2c45caa4-de5a-4ea0-bcab-d2f5462f0c97","name":"Internal Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"postalAddress\": {\n \"streetAddress1\": \"\",\n \"streetAddress2\": \"\",\n \"city\": \"\",\n \"mainDivision\": \"\",\n \"subDivision\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n },\n \"asOfDate\": \"\",\n \"lookupId\": \"\"\n}"},"url":"#unknown://#unknown/vertex-restapi/v1/addresslookup"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": \"500\",\n \"code\": \"InternalServerError\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"The server encountered an internal server error or misconfiguration and was unable to complete your request.\"\n }\n ]\n}"},{"id":"67a82149-b474-474c-bda4-b45f0925a225","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"postalAddress\": {\n \"streetAddress1\": \"\",\n \"streetAddress2\": \"\",\n \"city\": \"\",\n \"mainDivision\": \"\",\n \"subDivision\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n },\n \"asOfDate\": \"\",\n \"lookupId\": \"\"\n}"},"url":"#unknown://#unknown/vertex-restapi/v1/addresslookup"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": \"401\",\n \"code\": \"Unauthorized\",\n \"title\": \"Unauthorized\",\n \"detail\": \"Authorization has been denied for this request.\"\n }\n ]\n}"},{"id":"854bc9e8-8f25-4233-8933-7461054dd6c6","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"postalAddress\": {\n \"streetAddress1\": \"\",\n \"streetAddress2\": \"\",\n \"city\": \"\",\n \"mainDivision\": \"\",\n \"subDivision\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n },\n \"asOfDate\": \"\",\n \"lookupId\": \"\"\n}"},"url":"#unknown://#unknown/vertex-restapi/v1/addresslookup"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": \"400\",\n \"code\": \"Bad Request\",\n \"title\": \"Bad Request\",\n \"detail\": \"The request is invalid and cannot be processed.\"\n }\n ]\n}"},{"id":"baa91808-5e2b-4282-a6ef-2eb6d6c61d2c","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"postalAddress\": {\n \"streetAddress1\": \"\",\n \"streetAddress2\": \"\",\n \"city\": \"\",\n \"mainDivision\": \"\",\n \"subDivision\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n },\n \"asOfDate\": \"\",\n \"lookupId\": \"\"\n}"},"url":"#unknown://#unknown/vertex-restapi/v1/addresslookup"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": \"403\",\n \"code\": \"Forbidden\",\n \"title\": \"Forbidden\",\n \"detail\": \"You do not have permission to access this resource.\"\n }\n ]\n}"},{"id":"e00e9948-d047-4f36-9f05-bafb36ca6296","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"postalAddress\": {\n \"streetAddress1\": \"\",\n \"streetAddress2\": \"\",\n \"city\": \"\",\n \"mainDivision\": \"\",\n \"subDivision\": \"\",\n \"postalCode\": \"\",\n \"country\": \"\"\n },\n \"asOfDate\": \"\",\n \"lookupId\": \"\"\n}"},"url":"#unknown://#unknown/vertex-restapi/v1/addresslookup"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2018-02-09T14:08:07.838Z\",\n \"timeElapsed(ms)\": 47\n },\n \"data\": {\n \"lookupResults\": [\n {\n \"jurisdictions\": [\n {\n \"jurisdictionLevel\": \"COUNTRY\",\n \"jurisdictionId\": 1,\n \"effectiveDate\": \"1900-01-01\",\n \"expirationDate\": \"9999-12-31\",\n \"value\": \"UNITED STATES\"\n },\n {\n \"jurisdictionLevel\": \"STATE\",\n \"jurisdictionId\": 31152,\n \"effectiveDate\": \"1900-01-01\",\n \"expirationDate\": \"9999-12-31\",\n \"value\": \"PENNSYLVANIA\"\n },\n {\n \"jurisdictionLevel\": \"COUNTY\",\n \"jurisdictionId\": 32897,\n \"effectiveDate\": \"1900-01-01\",\n \"expirationDate\": \"9999-12-31\",\n \"value\": \"MONTGOMERY\"\n }\n ],\n \"postalAddresses\": [\n {\n \"streetAddress1\": \"2301 Renaissance Blvd Ste 7\",\n \"city\": \"King Of Prussia\",\n \"mainDivision\": \"PA\",\n \"subDivision\": \"Montgomery\",\n \"postalCode\": \"19406-2772\",\n \"country\": \"USA\"\n }\n ],\n \"statuses\": [\n {\n \"lookupResult\": \"NORMAL\"\n }\n ],\n \"taxAreaId\": 390910000,\n \"asOfDate\": \"2017-12-18\",\n \"confidenceIndicator\": 100\n }\n ]\n }\n}"}],"_postman_id":"48bcd2aa-343f-418d-b143-8887e3c91f3c"},{"name":"Represents tax calculation from the seller's perspective.","id":"6a2e29d7-490d-4442-a30b-c1f54c09b165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/sale","description":"

Performs a calculation request based on the set property of the Sale Message Type. Valid values are Quotation, Invoice, or Distribute Tax. Based on the property SaleMessageType value, a tax calculation is performed and may or may not be saved for reporting and tax remittance.

Quotation call / message

A quotation request is used to estimate taxes on a proposed sale or rental by the seller.Because it is an estimate, a quotation request is subject to change until the transaction is finalized and is not stored for reporting and remittance.

Invoice call / message

An Invoice request is used to initiate tax calculation on a transaction.Use this request to calculate tax at the time of shipping, billing, or invoicing from the seller’s perspective.Invoice transactions are stored and used for reporting and remittance.

Distribute Tax / message

A Distribute tax message is used to initial a Distribute Tax Calculation.This request can be used for a tax-only adjustment(debit or credit) to reconcile a tax underpayment or overpayment.It accepts a combined total tax amount for a purchase and distributes that tax to the appropriate jurisdictions.The engine uses the total tax amount with the combined rate for the taxing jurisdictions to determine the taxable base and then redistributes the calculated taxes to each level for remittance.Distribute tax transactions are stored and may affect revenue and be used in reporting and remittance.

\n","urlObject":{"hash":"unknown://#unknown/vertex-restapi/v1/sale","query":[],"variable":[{"id":"0407dcea-ecf7-4dd2-bafc-67fca43807bf","description":{"content":"","type":"text/plain"},"type":"string","value":"unknown","key":"CloudApiDnsProtocol"},{"id":"63f75710-f652-467f-ba57-bc8d8bb9918b","description":{"content":"","type":"text/plain"},"type":"string","value":"unknown","key":"CloudApiDnsName"}]}},"response":[{"id":"0936e80c-de60-4e3e-873a-39e182af3484","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/sale"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2018-02-09T14:13:23.091Z\",\n \"timeElapsed(ms)\": 77\n },\n \"data\": {\n \"saleMessage\": \"QUOTATION\",\n \"seller\": {\n \"company\": \"COMPANY\"\n },\n \"subTotal\": 120,\n \"total\": 129.6,\n \"totalTax\": 9.6,\n \"lineItems\": [\n {\n \"seller\": {\n \"physicalOrigin\": {\n \"taxAreaId\": 391013000\n }\n },\n \"customer\": {\n \"customerCode\": {\n \"classCode\": \"custclass\",\n \"value\": \"cust\"\n },\n \"destination\": {\n \"taxAreaId\": 390910000,\n \"streetAddress1\": \"2301 Renaissance Blvd\",\n \"streetAddress2\": \"Suite 100\",\n \"city\": \"King of Prussia\",\n \"mainDivision\": \"PA\",\n \"postalCode\": \"19406\",\n \"country\": \"UNITED STATES\"\n }\n },\n \"product\": {\n \"productClass\": \"PRODCLASS\",\n \"value\": \"PRODCODE\"\n },\n \"quantity\": {\n \"value\": 10\n },\n \"fairMarketValue\": 100,\n \"unitPrice\": 10,\n \"extendedPrice\": 100,\n \"taxes\": [\n {\n \"jurisdiction\": {\n \"jurisdictionLevel\": \"STATE\",\n \"jurisdictionId\": 31152,\n \"value\": \"PENNSYLVANIA\"\n },\n \"calculatedTax\": 6,\n \"effectiveRate\": 0.06,\n \"taxable\": 100,\n \"imposition\": {\n \"impositionId\": 1,\n \"value\": \"Sales and Use Tax\"\n },\n \"impositionType\": {\n \"impositionTypeId\": 1,\n \"value\": \"General Sales and Use Tax\"\n },\n \"taxRuleId\": {\n \"value\": 17423\n },\n \"taxResult\": \"TAXABLE\",\n \"taxType\": \"SALES\",\n \"situs\": \"PHYSICAL_ORIGIN\",\n \"taxCollectedFromParty\": \"BUYER\",\n \"taxStructure\": \"SINGLE_RATE\"\n },\n {\n \"jurisdiction\": {\n \"jurisdictionLevel\": \"CITY\",\n \"jurisdictionId\": 33126,\n \"value\": \"PHILADELPHIA\"\n },\n \"calculatedTax\": 2,\n \"effectiveRate\": 0.02,\n \"taxable\": 100,\n \"imposition\": {\n \"impositionId\": 1,\n \"value\": \"Local Sales and Use Tax\"\n },\n \"impositionType\": {\n \"impositionTypeId\": 1,\n \"value\": \"General Sales and Use Tax\"\n },\n \"taxRuleId\": {\n \"value\": 286671\n },\n \"taxResult\": \"TAXABLE\",\n \"taxType\": \"SALES\",\n \"situs\": \"PHYSICAL_ORIGIN\",\n \"taxCollectedFromParty\": \"BUYER\",\n \"taxStructure\": \"SINGLE_RATE\"\n }\n ],\n \"totalTax\": 8,\n \"flexibleFields\": {\n \"flexibleCodeFields\": [\n {\n \"fieldId\": 1,\n \"value\": \"FLEXCodeField1\"\n }\n ],\n \"flexibleNumericFields\": [\n {\n \"fieldId\": 1,\n \"value\": 111\n }\n ],\n \"flexibleDateFields\": [\n {\n \"fieldId\": 1,\n \"value\": \"2017-12-18\"\n }\n ]\n },\n \"lineItemNumber\": 1,\n \"deliveryTerm\": \"FOB\"\n },\n {\n \"seller\": {\n \"physicalOrigin\": {\n \"taxAreaId\": 391013000\n }\n },\n \"customer\": {\n \"customerCode\": {\n \"classCode\": \"custclass\",\n \"value\": \"cust\"\n },\n \"destination\": {\n \"taxAreaId\": 390910000,\n \"streetAddress1\": \"2301 Renaissance Blvd\",\n \"streetAddress2\": \"Suite 100\",\n \"city\": \"King of Prussia\",\n \"mainDivision\": \"PA\",\n \"postalCode\": \"19406\",\n \"country\": \"UNITED STATES\"\n }\n },\n \"product\": {\n \"productClass\": \"SHIPPINGCLASS\",\n \"value\": \"SHIPPING\"\n },\n \"quantity\": {\n \"value\": 1\n },\n \"fairMarketValue\": 20,\n \"extendedPrice\": 20,\n \"taxes\": [\n {\n \"jurisdiction\": {\n \"jurisdictionLevel\": \"STATE\",\n \"jurisdictionId\": 31152,\n \"value\": \"PENNSYLVANIA\"\n },\n \"calculatedTax\": 1.2,\n \"effectiveRate\": 0.06,\n \"taxable\": 20,\n \"imposition\": {\n \"impositionId\": 1,\n \"value\": \"Sales and Use Tax\"\n },\n \"impositionType\": {\n \"impositionTypeId\": 1,\n \"value\": \"General Sales and Use Tax\"\n },\n \"taxRuleId\": {\n \"value\": 17423\n },\n \"taxResult\": \"TAXABLE\",\n \"taxType\": \"SALES\",\n \"situs\": \"PHYSICAL_ORIGIN\",\n \"taxCollectedFromParty\": \"BUYER\",\n \"taxStructure\": \"SINGLE_RATE\"\n },\n {\n \"jurisdiction\": {\n \"jurisdictionLevel\": \"CITY\",\n \"jurisdictionId\": 33126,\n \"value\": \"PHILADELPHIA\"\n },\n \"calculatedTax\": 0.4,\n \"effectiveRate\": 0.02,\n \"taxable\": 20,\n \"imposition\": {\n \"impositionId\": 1,\n \"value\": \"Local Sales and Use Tax\"\n },\n \"impositionType\": {\n \"impositionTypeId\": 1,\n \"value\": \"General Sales and Use Tax\"\n },\n \"taxRuleId\": {\n \"value\": 286671\n },\n \"taxResult\": \"TAXABLE\",\n \"taxType\": \"SALES\",\n \"situs\": \"PHYSICAL_ORIGIN\",\n \"taxCollectedFromParty\": \"BUYER\",\n \"taxStructure\": \"SINGLE_RATE\"\n }\n ],\n \"totalTax\": 1.6,\n \"lineItemNumber\": 2\n }\n ],\n \"documentNumber\": 12345,\n \"documentDate\": \"2017-12-18\",\n \"transactionType\": \"SALE\"\n }\n}"},{"id":"35ef1a7d-70bf-46aa-9253-35d6330e4621","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/sale"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": \"400\",\n \"code\": \"Bad Request\",\n \"title\": \"Bad Request\",\n \"detail\": \"The request is invalid and cannot be processed.\"\n }\n ]\n}"},{"id":"5bf051f2-f6c0-4a0b-87ca-82f4bff7be58","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/sale"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": \"403\",\n \"code\": \"Forbidden\",\n \"title\": \"Forbidden\",\n \"detail\": \"You do not have permission to access this resource.\"\n }\n ]\n}"},{"id":"79b96dc2-c27f-4a54-a9ce-e593edcad08d","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/sale"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": \"401\",\n \"code\": \"Unauthorized\",\n \"title\": \"Unauthorized\",\n \"detail\": \"Authorization has been denied for this request.\"\n }\n ]\n}"},{"id":"af1679c2-6777-4b8f-a5f1-9065c4e9057e","name":"Internal Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/sale"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": \"500\",\n \"code\": \"InternalServerError\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"The server encountered an internal server error or misconfiguration and was unable to complete your request.\"\n }\n ]\n}"}],"_postman_id":"6a2e29d7-490d-4442-a30b-c1f54c09b165"},{"name":"Represents tax calculation from the buyer's perspective.","id":"38d34ba7-6ac5-4075-b61e-890aaf41262f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{"basicConfig":[]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/purchase","description":"

Performs a calculation request based on the set property of the Purchase Message Type. Valid values are PurchaseOrder, InvoiceVerification, Accrual, or DistributeTax. Based on the property PurchaseMessageType value, a tax calculation is performed and may or may not be saved for reporting and tax remittance.

PurchaseOrder call / message

A Purchase Order is used to estimate the tax on intended purchases for a Buyer. The intended purchase of goods or services, including tax, is used as input to generate the purchase order. The ultimate use of the goods or services typically dictates the taxability of the purchase. Purchase Order transactions are not stored for reporting or used in tax remittance.

Accrual call / message

The Accrual Request initiates a self-accrual calculation. This situation occurs when the buyer must remit tax on tangible personal property or services(used or consumed) when tax due on the transaction has not been paid. Accrual transactions are stored and used for reporting and remittance.

Invoice Verification call / message

The Invoice Verification is used to verify tax on incoming invoices to the buyer for tangible personal property, rentals, and leases. The invoice is recreated from the seller's perspective to validate that the proper tax has been applied. The Invoice Verification compares the total vendor-charged or supplier-charged tax amount from the original invoice to the Vertex-calculated tax amount. If any user-defined verification thresholds are setup, the engine validate for tolerances at the transaction level and returns an indicator to the host system for undercharges and overcharges outside of the settings. The invoice may display no tax if the buyer has filed a direct pay permit with the vendor or supplier. Invoice Verification transactions are not stored for reporting or used in tax remittance.

Distribute Tax / message

The Distribute Tax Procurement accepts a combined total tax amount for a purchase and distributes that tax to the appropriate jurisdictions. The Engine uses the total tax amount with the combined rates for the taxing jurisdictions to determine the taxable base, and then redistributes the calculated taxes to each level for remittance. Use this request for a tax-only adjustment (debit or credit) to reconcile a tax underpayment or overpayment. The Engine uses Vertex taxability rules that are effective on the date specified in the documentDate attribute. The Engine processes records for jurisdiction registration, product exception or customer exception, or customer exemption if they are dated on or before that date. A Distribute Tax Procurement transaction impacts revenue unless you designate it as a tax-only adjustment. Distribute Tax Procurement transactions are stored for reporting.

\n","urlObject":{"hash":"unknown://#unknown/vertex-restapi/v1/purchase","query":[],"variable":[{"id":"79312539-f26b-4635-b145-61ce5e8d015a","description":{"content":"","type":"text/plain"},"type":"string","value":"unknown","key":"CloudApiDnsProtocol"},{"id":"d49d14fe-0198-4963-897a-62006b168ce6","description":{"content":"","type":"text/plain"},"type":"string","value":"unknown","key":"CloudApiDnsName"}]}},"response":[{"id":"18ec4fa0-e35e-4fa8-97a8-2c287d4e0043","name":"Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/purchase"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": 403,\n \"code\": \"Forbidden\",\n \"title\": \"Forbidden\",\n \"detail\": \"You do not have permission to access this resource.\"\n }\n ]\n}"},{"id":"6a1f5011-090f-4654-9c73-df193e28a949","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/purchase"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2018-02-09T14:13:23.091Z\",\n \"timeElapsed(ms)\": 77\n },\n \"data\": {\n \"saleMessage\": \"PURCHASE_ORDER\",\n \"buyer\": {\n \"company\": \"COMPANY\"\n },\n \"subTotal\": 120,\n \"total\": 129.6,\n \"totalTax\": 9.6,\n \"lineItems\": [\n {\n \"buyer\": {\n \"destination\": {\n \"taxAreaId\": 391013000\n }\n },\n \"vendor\": {\n \"vendorCode\": {\n \"classCode\": \"venclass\",\n \"value\": \"ven\"\n },\n \"physicalOrigin\": {\n \"taxAreaId\": 390910000,\n \"streetAddress1\": \"2301 Renaissance Blvd\",\n \"streetAddress2\": \"Suite 100\",\n \"city\": \"King of Prussia\",\n \"mainDivision\": \"PA\",\n \"postalCode\": 19406,\n \"country\": \"UNITED STATES\"\n }\n },\n \"purchase\": {\n \"purchaseClass\": \"PURCLASS\",\n \"value\": \"PURCODE\"\n },\n \"quantity\": {\n \"value\": 10\n },\n \"fairMarketValue\": 100,\n \"unitPrice\": 10,\n \"extendedPrice\": 100,\n \"taxes\": [\n {\n \"jurisdiction\": {\n \"jurisdictionLevel\": \"STATE\",\n \"jurisdictionId\": 31152,\n \"value\": \"PENNSYLVANIA\"\n },\n \"calculatedTax\": 6,\n \"effectiveRate\": 0.06,\n \"taxable\": 100,\n \"imposition\": {\n \"impositionId\": 1,\n \"value\": \"Sales and Use Tax\"\n },\n \"impositionType\": {\n \"impositionTypeId\": 1,\n \"value\": \"General Sales and Use Tax\"\n },\n \"taxRuleId\": {\n \"value\": 17423\n },\n \"taxResult\": \"TAXABLE\",\n \"taxType\": \"SALES\",\n \"situs\": \"PHYSICAL_ORIGIN\",\n \"taxCollectedFromParty\": \"BUYER\",\n \"taxStructure\": \"SINGLE_RATE\"\n },\n {\n \"jurisdiction\": {\n \"jurisdictionLevel\": \"CITY\",\n \"jurisdictionId\": 33126,\n \"value\": \"PHILADELPHIA\"\n },\n \"calculatedTax\": 2,\n \"effectiveRate\": 0.02,\n \"taxable\": 100,\n \"imposition\": {\n \"impositionId\": 1,\n \"value\": \"Local Sales and Use Tax\"\n },\n \"impositionType\": {\n \"impositionTypeId\": 1,\n \"value\": \"General Sales and Use Tax\"\n },\n \"taxRuleId\": {\n \"value\": 286671\n },\n \"taxResult\": \"TAXABLE\",\n \"taxType\": \"SALES\",\n \"situs\": \"PHYSICAL_ORIGIN\",\n \"taxCollectedFromParty\": \"BUYER\",\n \"taxStructure\": \"SINGLE_RATE\"\n }\n ],\n \"totalTax\": 8,\n \"flexibleFields\": {\n \"flexibleCodeFields\": [\n {\n \"fieldId\": 1,\n \"value\": \"FLEXCodeField1\"\n }\n ],\n \"flexibleNumericFields\": [\n {\n \"fieldId\": 1,\n \"value\": 111\n }\n ],\n \"flexibleDateFields\": [\n {\n \"fieldId\": 1,\n \"value\": \"2017-12-18\"\n }\n ]\n },\n \"lineItemNumber\": 1,\n \"deliveryTerm\": \"FOB\"\n },\n {\n \"buyer\": {\n \"destination\": {\n \"taxAreaId\": 391013000\n }\n },\n \"vendor\": {\n \"vendorCode\": {\n \"classCode\": \"venclass\",\n \"value\": \"ven\"\n },\n \"physicalOrigin\": {\n \"taxAreaId\": 390910000,\n \"streetAddress1\": \"2301 Renaissance Blvd\",\n \"streetAddress2\": \"Suite 100\",\n \"city\": \"King of Prussia\",\n \"mainDivision\": \"PA\",\n \"postalCode\": 19406,\n \"country\": \"UNITED STATES\"\n }\n },\n \"purchase\": {\n \"purchaseClass\": \"SHIPPINGCLASS\",\n \"value\": \"SHIPPING\"\n },\n \"quantity\": {\n \"value\": 1\n },\n \"fairMarketValue\": 20,\n \"extendedPrice\": 20,\n \"taxes\": [\n {\n \"jurisdiction\": {\n \"jurisdictionLevel\": \"STATE\",\n \"jurisdictionId\": 31152,\n \"value\": \"PENNSYLVANIA\"\n },\n \"calculatedTax\": 1.2,\n \"effectiveRate\": 0.06,\n \"taxable\": 20,\n \"imposition\": {\n \"impositionId\": 1,\n \"value\": \"Sales and Use Tax\"\n },\n \"impositionType\": {\n \"impositionTypeId\": 1,\n \"value\": \"General Sales and Use Tax\"\n },\n \"taxRuleId\": {\n \"value\": 17423\n },\n \"taxResult\": \"TAXABLE\",\n \"taxType\": \"SALES\",\n \"situs\": \"PHYSICAL_ORIGIN\",\n \"taxCollectedFromParty\": \"BUYER\",\n \"taxStructure\": \"SINGLE_RATE\"\n },\n {\n \"jurisdiction\": {\n \"jurisdictionLevel\": \"CITY\",\n \"jurisdictionId\": 33126,\n \"value\": \"PHILADELPHIA\"\n },\n \"calculatedTax\": 0.4,\n \"effectiveRate\": 0.02,\n \"taxable\": 20,\n \"imposition\": {\n \"impositionId\": 1,\n \"value\": \"Local Sales and Use Tax\"\n },\n \"impositionType\": {\n \"impositionTypeId\": 1,\n \"value\": \"General Sales and Use Tax\"\n },\n \"taxRuleId\": {\n \"value\": 286671\n },\n \"taxResult\": \"TAXABLE\",\n \"taxType\": \"SALES\",\n \"situs\": \"PHYSICAL_ORIGIN\",\n \"taxCollectedFromParty\": \"BUYER\",\n \"taxStructure\": \"SINGLE_RATE\"\n }\n ],\n \"totalTax\": 1.6,\n \"lineItemNumber\": 2\n }\n ],\n \"documentNumber\": 12345,\n \"documentDate\": \"2017-12-18\",\n \"transactionType\": \"PURCHASE\"\n }\n}"},{"id":"d25153f8-0a91-4bda-8069-7b92283cf6f2","name":"Internal Error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/purchase"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": 500,\n \"code\": \"InternalServerError\",\n \"title\": \"Internal Server Error\",\n \"detail\": \"The server encountered an internal server error or misconfiguration and was unable to complete your request.\"\n }\n ]\n}"},{"id":"e0cf8791-ffa5-4234-9e4b-9ffcfd044258","name":"Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/purchase"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": 400,\n \"code\": \"Bad Request\",\n \"title\": \"Bad Request\",\n \"detail\": \"The request is invalid and cannot be processed.\"\n }\n ]\n}"},{"id":"e4e6546e-a113-471e-9489-b8108c27c01c","name":"Unauthorized","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null"},"url":"#unknown://#unknown/vertex-restapi/v1/purchase"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"meta\": {\n \"app\": \"Vertex REST API v0.1.0\",\n \"timeReceived\": \"2017-12-13T15:13:23.2577828Z\",\n \"timeElapsed(ms)\": 15\n },\n \"errors\": [\n {\n \"status\": 401,\n \"code\": \"Unauthorized\",\n \"title\": \"Unauthorized\",\n \"detail\": \"Authorization has been denied for this request.\"\n }\n ]\n}"}],"_postman_id":"38d34ba7-6ac5-4075-b61e-890aaf41262f"}],"id":"f1d04797-7af4-4c19-aafb-f45a58880268","_postman_id":"f1d04797-7af4-4c19-aafb-f45a58880268","description":""}],"variable":[{"id":"CloudApiDnsProtocol","key":"CloudApiDnsProtocol","value":"unknown","type":"any","description":"undefined"},{"id":"CloudApiDnsName","key":"CloudApiDnsName","value":"unknown","type":"any","description":"undefined"},{"id":"baseUrl","key":"baseUrl","value":"#unknown://#unknown/vertex-restapi","type":"string"}]}