QuoteInterface.php 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. <?php
  2. /**
  3. * @copyright Vertex. All rights reserved. https://www.vertexinc.com/
  4. * @author Mediotype https://www.mediotype.com/
  5. */
  6. namespace Vertex\Tax\Api;
  7. use Magento\Store\Model\ScopeInterface;
  8. use Vertex\Exception\ApiException;
  9. use Vertex\Exception\ConfigurationException;
  10. use Vertex\Exception\ValidationException;
  11. use Vertex\Services\Quote\RequestInterface;
  12. use Vertex\Services\Quote\ResponseInterface;
  13. /**
  14. * Quotation Request Service
  15. *
  16. * This message initiates a Quotation request. Use the Quotation message to estimate taxes on a proposed sale, rental,
  17. * or lease of goods or services by the Seller. Quotations may be called from a CRM, Mobile Sale, Order Entry, or
  18. * Internet Sale application. Quotation transactions are subject to change until an invoice is finalized. Consequently,
  19. * Quotation transactions are not written to the Tax Journal.
  20. *
  21. * Please see {@see RequestInterface} for more information on the fields available.
  22. *
  23. * @api
  24. */
  25. interface QuoteInterface
  26. {
  27. /**
  28. * Request a taxation quote from Vertex
  29. *
  30. * @param RequestInterface $request
  31. * @param string|null $scopeCode Scope ID
  32. * @param string $scopeType
  33. * @return ResponseInterface
  34. * @throws ApiException
  35. * @throws ConfigurationException
  36. * @throws ValidationException
  37. */
  38. public function request(RequestInterface $request, $scopeCode = null, $scopeType = ScopeInterface::SCOPE_STORE);
  39. }