Feature/v3 api upgrade by taxcloud-havlek · Pull Request #314 · FedTax/simplesalestax

taxcloud-havlek · 2025-01-15T11:03:02Z

apply V3 api https://api.v3.taxcloud.com/tax/docs#

bjongbloedt · 2025-01-15T15:52:37Z

includes/TaxCloud/Client.php

+                    "states" => $states
+                ];
+                break;
+            case "get-exempt-certificates":


There isn't a post for this search

bjongbloedt · 2025-01-15T15:53:43Z

includes/TaxCloud/Client.php

+                ];
+                break;
+            case "carts/orders":
+                $xApiKey = $payload->getApiLoginID();


xAPIKey isn't 1-1 with api login id. It's actually a different concept that didn't exist in v1 and can be pulled from the API key section of the taxcloud UI.

HI Ben,
For V3, it is 1-many. whether it means one connection id has many xapikey? if yes, what is the UI in wordpress tax dashboard?

Sorry when I said 1 - 1, I meant that the api login id is not equal to the xapikey value, it is a totally different concept created for v3. I don't know that it has a value in the wordpress tax dashboard. I was wondering if the plan was to re-use the api login id field, or if a new field needed to be added to that page?

Currently I reuse the api login id field. no need to add a new field to that page. I have change the text description at frontend to be TaxCloud X-API-Key .

bjongbloedt · 2025-01-15T15:55:11Z

includes/TaxCloud/Client.php

+                }
+                $destinationLine1 = $payload->getDestination()->getAddress1();
+                if(!$destinationLine1){
+                    $destinationLine1 = "650 street";


usually if address1 is not known, we will default to unknown instead of an address so we don't accidentally match some address logic for a specific address.

For the V3 API, the requirement is that line1 must be provided. However, considering that the street field is not essential for tax calculation purposes, it would be beneficial to make line1 optional in the V3 API. This adjustment aligns with the behavior of the V1 API, which also does not mandate the street field. By modifying the V3 API to allow line1 to be optional then we do not need to process $destinationLine1. How do you think?

bjongbloedt · 2025-01-15T15:57:55Z

includes/TaxCloud/Client.php

+        switch ($endpoint){
+            case "get-exempt-certificates":
+                $customerId = $payload->getCustomerID();
+                $url = 'https://api.v3.taxcloud.com/tax/exemption-certificates?customerId='.$customerId;


You probably want to use connectionID here where connectionID is the old api key. This will get all the exemption certificates for this currently hooked up connection.

Also this is a cursor paged endpoint, so if a user has over 20 exemption certificates, they will only be shown the first 20 results.

bjongbloedt · 2025-01-15T16:01:01Z

includes/TaxCloud/Client.php

+                  "line1" => $destinationLine1,
+                  "line2" => $payload->getAddress2(),
+                  "state"=> $payload->getState(),
+                  "zip" =>  $payload->getZip5()


Any chance there would be a +4 on this zip?

@bjongbloedt i have updated the code, please have a check again

bjongbloedt · 2025-01-29T22:17:48Z

Looks like some cypress tests are failing post update. @taxcloud-havlek can you look into these?

bjongbloedt · 2025-02-05T21:07:04Z

includes/TaxCloud/Client.php

+        switch ($endpoint){
+            case "get-exempt-certificates":
+                $customerId = $payload->getCustomerID();
+                $url = 'https://api.v3.taxcloud.com/tax/exemption-certificates?customerId='.$customerId."&&limit=100";


Do you have the connection id available here for the connectionID param? It would make the query quicker, and this current setup could return certs that may not be associated with the current setup

bjongbloedt · 2025-02-05T21:10:25Z

includes/TaxCloud/Client.php

+  {
+    try {
+      $response = $this->postV3('refunds', $parameters);
+      if ($response->getResponseType() == 'OK') {


I don't think this old ok field applies anymore. It should check for status and errors

bjongbloedt · 2025-02-05T21:11:20Z

includes/TaxCloud/Client.php

+   * @param  Captured $parameters
+   * @return bool
+   */
+  public function Captured(Captured $parameters)


This action would need to be done on an existing order with the update order endpoint where completedDate is the date it was captured

bjongbloedt · 2025-02-05T21:13:01Z

includes/TaxCloud/Client.php

+   * @param  AuthorizedWithCapture $parameters
+   * @return bool
+   */
+  public function AuthorizedWithCapture(AuthorizedWithCapture $parameters)


Capturing is done in the new system by converting a cart to an order. To capture at the same time, you need to set the completed flag to true

when call postV3 with carts/orders, default is true for completed flag

bjongbloedt · 2025-02-05T21:13:24Z

includes/TaxCloud/Client.php

+   * @param  Authorized $parameters
+   * @return bool
+   */
+  public function Authorized(Authorized $parameters)


Authorizing is done in the new system by converting a cart to an order. To capture at the same time, you need to set the completed flag to false

bjongbloedt · 2025-02-05T21:15:51Z

includes/TaxCloud/Client.php

+  public function AddTransactions(AddTransactions $parameters)
+  {
+    try {
+      $response = new AddTransactionsResponse($this->post('AddTransactions', $parameters));


You might want to pivot this into the create transaction endpoint instead. It doesn't have the multiple at a time functionality, but it is v3 vs v1

bjongbloedt · 2025-02-05T21:16:36Z

includes/TaxCloud/Client.php

+                break;
+            case "ping":
+                $connectionId = $payload->getApiKey();
+                $url = "https://api.v3.taxcloud.com/tax/connections/$connectionId/ping";


Could you interpolate these 2 urls with the base url for v3 above?

bjongbloedt · 2025-02-05T21:17:30Z

includes/TaxCloud/Client.php

+                        "itemId" => (string)$eachItem->getItemID(),
+                        "price" => (double)$eachItem->getPrice(),
+                        "quantity" => $eachItem->getQty(),
+                        "tic" => (int) $eachItem->getTIC()


In the new world, if there is no tic we would prefer this value to be set to null or omitted. That way the default tic and/or product mapping logic could automatically assign the tic

Currently the tic is required. Could i use "tic" => 0 if there is no tic in the new world?

I think the required is coming from the response. The requests for both cart and order should allow null to be passed in

….0.0

taxcloud-havlek added 2 commits January 15, 2025 16:55

add V3 code

2e2a8ef

Load class in TaxCloud

2876220

taxcloud-havlek requested a review from bjongbloedt January 15, 2025 11:03

bjongbloedt reviewed Jan 15, 2025

View reviewed changes

taxcloud-havlek added 6 commits January 19, 2025 07:28

deleted useless code

edd821e

fix bug: display Exemption certificates at frontend in my account

a4f1db9

add limit

305695b

add zip + 4

6ca3e81

use xAPIKey instead of getApiLoginID

066772b

fix error: npm run build

146bbea

bjongbloedt reviewed Feb 5, 2025

View reviewed changes

taxcloud-havlek added 6 commits February 6, 2025 15:23

reuse TICS from V1 to pass cypress test

d8bb475

interpolate these 2 urls with the base url for v3

5ade042

add connectionID to api get-exempt-certificates

ce1bebc

check status and errors for refunds api

96b8532

delete useless function in V1

30d10e1

set tic to be 0 default

007c0d9

omnicolor self-assigned this Feb 12, 2025

1. set line1 to be unknown when it is null. 2. update version to be 9…

9e1caa8

….0.0

Conversation

taxcloud-havlek commented Jan 15, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bjongbloedt commented Jan 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bjongbloedt Feb 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bjongbloedt Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bjongbloedt Feb 5, 2025 •

edited

Loading

bjongbloedt Feb 7, 2025 •

edited

Loading