@taxbit/react-sdk 2.2.0-beta.0 → 2.2.0-beta.1

package/README.md

@@ -157,9 +157,22 @@ The serverData object contains the currently saved tax documentation data for th
 The `useTaxbit` hook will return a `status` object that can be used to determine the status of the user's tax documentation. The `status` object will have the following shape:
 
 ```typescript
+type QuestionnaireIssue = {
+  issueType:
+    | 'CARE_OF_PERMANENT_ADDRESS'
+    | 'PO_BOX_PERMANENT_ADDRESS'
+    | 'US_PERMANENT_ADDRESS'
+    | 'TREATY_COUNTRY_MISMATCH'
+    | 'US_INDICIA'
+    | 'WITHHOLDING_DOCUMENTATION'
+    | 'CHANGE_IN_CIRCUMSTANCES';
+  createdAt: string;
+};
+
 type ClientTaxDocumentationStatus = {
   dpsQuestionnaire?: {
     dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
+    expirationDate?: string;
     vatStatus?:
       | 'PENDING'
       | 'VALID'
@@ -168,12 +181,13 @@ type ClientTaxDocumentationStatus = {
       | 'NOT_REQUIRED'
       | 'NON_EU';
     vatValidationDate?: string;
-    expirationDate?: string;
   };
   wFormQuestionnaire?: {
     dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
     type: 'W-9' | 'W-8BEN' | 'W-8BEN-E' | 'W-8IMY';
     expirationDate?: string;
+    issues?: QuestionnaireIssue[];
+    needsResubmission?: boolean;
     tinStatus?:
       | 'PENDING'
       | 'FOREIGN'
@@ -185,11 +199,12 @@ type ClientTaxDocumentationStatus = {
       | 'TIN_NOT_ISSUED'
       | 'ERROR';
     tinValidationDate?: string;
-    needsResubmission: boolean;
+    treatyClaimStatus?: 'VALID' | 'INVALID';
   };
   selfCertification?: {
     dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
-    needsResubmission: boolean;
+    issues?: QuestionnaireIssue[];
+    needsResubmission?: boolean;
   };
 };
 ```
@@ -331,6 +346,10 @@ type QuestionnaireType = 'DPS' | 'W-FORM' | 'SELF-CERT';
 
 ## Changelog
 
+### Version 2.2.0-beta.1
+
+1. Updating TaxDocumentationStatus type to include issues and treatyClaimStatus.
+
 ### Version 2.2.0-beta.0
 
 1. Adding SERR support for Australian residents.

package/dist/src/types/client/ClientTaxDocumentationStatus.d.ts

@@ -1,20 +1,28 @@
+type QuestionnaireIssue = {
+    issueType: 'CARE_OF_PERMANENT_ADDRESS' | 'PO_BOX_PERMANENT_ADDRESS' | 'US_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'WITHHOLDING_DOCUMENTATION' | 'CHANGE_IN_CIRCUMSTANCES';
+    createdAt: string;
+};
 export type ClientTaxDocumentationStatus = {
     dpsQuestionnaire?: {
         dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
+        expirationDate?: string;
         vatStatus?: 'PENDING' | 'VALID' | 'INVALID' | 'INSUFFICIENT_DATA' | 'NOT_REQUIRED' | 'NON_EU';
         vatValidationDate?: string;
-        expirationDate?: string;
     };
     wFormQuestionnaire?: {
         dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
-        type: 'W-9' | 'W-8BEN' | 'W-8BEN-E';
+        type: 'W-9' | 'W-8BEN' | 'W-8BEN-E' | 'W-8IMY';
         expirationDate?: string;
+        issues?: QuestionnaireIssue[];
+        needsResubmission?: boolean;
         tinStatus?: 'PENDING' | 'FOREIGN' | 'INVALID_DATA' | 'VALID_SSN_MATCH' | 'VALID_EIN_MATCH' | 'VALID_SSN_EIN_MATCH' | 'MISMATCH' | 'TIN_NOT_ISSUED' | 'ERROR';
         tinValidationDate?: string;
-        needsResubmission: boolean;
+        treatyClaimStatus?: 'VALID' | 'INVALID';
     };
     selfCertification?: {
         dataCollectionStatus: 'COMPLETE' | 'INCOMPLETE';
-        needsResubmission: boolean;
+        issues?: QuestionnaireIssue[];
+        needsResubmission?: boolean;
     };
 };
+export {};

package/dist/src/types/server/TaxDocumentationStatus.d.ts

@@ -1,20 +1,28 @@
+type Issue = {
+    issue_type: 'CARE_OF_PERMANENT_ADDRESS' | 'PO_BOX_PERMANENT_ADDRESS' | 'US_PERMANENT_ADDRESS' | 'TREATY_COUNTRY_MISMATCH' | 'US_INDICIA' | 'WITHHOLDING_DOCUMENTATION' | 'CHANGE_IN_CIRCUMSTANCES';
+    created_at: string;
+};
 export type TaxDocumentationStatus = {
     dps_questionnaire?: {
         data_collection_status: 'COMPLETE' | 'INCOMPLETE';
+        expiration_date?: string;
         vat_status?: 'PENDING' | 'VALID' | 'INVALID' | 'INSUFFICIENT_DATA' | 'NOT_REQUIRED' | 'NON_EU';
         vat_validation_date?: string;
-        expiration_date?: string;
     };
     w_form_questionnaire?: {
         data_collection_status: 'COMPLETE' | 'INCOMPLETE';
-        type: 'W-9' | 'W-8BEN' | 'W-8BEN-E';
+        type: 'W-9' | 'W-8BEN' | 'W-8BEN-E' | 'W-8IMY';
         expiration_date?: string;
+        issues?: Issue[];
+        needs_resubmission?: boolean;
         tin_status?: 'PENDING' | 'FOREIGN' | 'INVALID_DATA' | 'VALID_SSN_MATCH' | 'VALID_EIN_MATCH' | 'VALID_SSN_EIN_MATCH' | 'MISMATCH' | 'TIN_NOT_ISSUED' | 'ERROR';
         tin_validation_date?: string;
-        needs_resubmission: boolean;
+        treaty_claim_status?: 'VALID' | 'INVALID';
     };
     self_certification: {
         data_collection_status: 'COMPLETE' | 'INCOMPLETE';
-        needs_resubmission: boolean;
+        issues?: Issue[];
+        needs_resubmission?: boolean;
     };
 };
+export {};

package/dist/taxbit-react-sdk.js

@@ -5283,7 +5283,7 @@ const Ei = (e, i, t, o) => {
     regardedOwnerEntityPaymentsCertified: "entityPaymentsCertified",
     regardedOwnerProvidesWithholdingStatementCertified: "providesWithholdingStatementCertified"
   };
-}, zl = "2.2.0-beta.0", Oi = (e) => e === "yes", S = (e) => e === void 0 ? void 0 : e === "yes", Sl = (e) => ({
+}, zl = "2.2.0-beta.1", Oi = (e) => e === "yes", S = (e) => e === void 0 ? void 0 : e === "yes", Sl = (e) => ({
   // 14
   isQiCertified: S(
     e.accountHolderIsQiCertified || e.regardedOwnerIsQiCertified