@zeniai/client-epic-state 5.3.10-beta0KB → 5.3.10-beta1KB

package/lib/esm/view/transactionDetail/createTransaction/createTransactionPayload.js

@@ -137,7 +137,15 @@ export const prepareCreateTransactionPayload = (state, localData) => {
     if (transactionType === 'journal_entry') {
         return { ...base, ...documentId, lines };
     }
-    // A bill posts to accounts payable, so it carries no header account or payment type.
+    // Both post to accounts payable, so they carry no header account or payment type.
+    if (transactionType === 'vendor_credit') {
+        return {
+            ...base,
+            vendor_id: toQboVendorId(state, localData.vendorId),
+            ...documentId,
+            lines,
+        };
+    }
     if (transactionType === 'bill') {
         return {
             ...base,

package/lib/esm/view/transactionDetail/createTransaction/createTransactionState.js

@@ -9,4 +9,5 @@ export const ALL_CREATABLE_TRANSACTION_TYPES = [
     'transfer',
     'journal_entry',
     'bill',
+    'vendor_credit',
 ];

package/lib/view/transactionDetail/createTransaction/createTransactionPayload.d.ts

@@ -13,8 +13,9 @@ import { CreateTransactionLocalData } from './createTransactionState';
  *    constant NAMES; ZENI_LINE_DETAIL_TYPE_TO_QBO_LINE_DETAIL_TYPE_MAP converts them for the
  *    body the backend sends on to QuickBooks, never for ours.
  * 2. The QBO Purchases (check, credit_card_credit) send their reference number as
- *    `document_number`; a journal entry sends its entry name, and a bill its bill number, as
- *    `document_id`. All land on QBO's DocNumber, but QBOJournalEntry reads only `document_id`.
+ *    `document_number`; a journal entry sends its entry name, a bill its bill number and a
+ *    vendor credit its reference number as `document_id`. All land on QBO's DocNumber, but
+ *    QBOJournalEntry reads only `document_id`.
  */
 export interface CreateTransactionAccountPayload {
     qbo_id: ID;
@@ -53,7 +54,7 @@ export interface CreateTransactionRemitToAddressPayload {
 export interface CreateTransactionRequest extends Record<string, unknown> {
     transaction_date: string;
     transaction_type: string;
-    /** journal_entry entry name or bill number (QBO DocNumber). */
+    /** journal_entry entry name, bill number or vendor_credit reference number (QBO DocNumber). */
     document_id?: string;
     /** check / credit_card_credit reference number (QBO Purchase). */
     document_number?: string;

package/lib/view/transactionDetail/createTransaction/createTransactionPayload.js

@@ -141,7 +141,15 @@ const prepareCreateTransactionPayload = (state, localData) => {
     if (transactionType === 'journal_entry') {
         return { ...base, ...documentId, lines };
     }
-    // A bill posts to accounts payable, so it carries no header account or payment type.
+    // Both post to accounts payable, so they carry no header account or payment type.
+    if (transactionType === 'vendor_credit') {
+        return {
+            ...base,
+            vendor_id: toQboVendorId(state, localData.vendorId),
+            ...documentId,
+            lines,
+        };
+    }
     if (transactionType === 'bill') {
         return {
             ...base,

package/lib/view/transactionDetail/createTransaction/createTransactionState.d.ts

@@ -9,7 +9,7 @@ import { ZeniDate } from '../../../zeniDayJS';
  * The transaction types the Create Transaction flow can originate. A narrow subset of
  * TransactionType -- everything else is read-only and arrives via sync.
  */
-export declare const ALL_CREATABLE_TRANSACTION_TYPES: readonly ["expense", "check", "credit_card_credit", "transfer", "journal_entry", "bill"];
+export declare const ALL_CREATABLE_TRANSACTION_TYPES: readonly ["expense", "check", "credit_card_credit", "transfer", "journal_entry", "bill", "vendor_credit"];
 export type CreatableTransactionType = (typeof ALL_CREATABLE_TRANSACTION_TYPES)[number];
 /**
  * The wire shape the create endpoint expects for a check's remit-to address. Deliberately not
@@ -54,7 +54,10 @@ export interface CreateTransactionLocalData {
     /** Empty for transfer, which has no lines at all. */
     lines: CreateTransactionLineLocalData[];
     transactionType: CreatableTransactionType;
-    /** check / credit_card_credit reference number, journal_entry entry name, or bill number. */
+    /**
+     * check / credit_card_credit / vendor_credit reference number, journal_entry entry name, or
+     * bill number.
+     */
     documentNumber?: string;
     /** bill only. */
     dueDate?: ZeniDate;

package/lib/view/transactionDetail/createTransaction/createTransactionState.js

@@ -12,4 +12,5 @@ exports.ALL_CREATABLE_TRANSACTION_TYPES = [
     'transfer',
     'journal_entry',
     'bill',
+    'vendor_credit',
 ];

package/lib/view/transactionDetail/transactionDetailReducer.d.ts

@@ -177,39 +177,39 @@ export declare const downloadAccountingProviderAttachment: import("@reduxjs/tool
 }, "transactionDetail/deleteSplitLine", never, never>, toggleSplitEditMode: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionId: TransactionID, editMode: boolean], {
     transactionId: TransactionID;
     editMode: boolean;
-}, "transactionDetail/toggleSplitEditMode", never, never>, initializeCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry"], {
-    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
-}, "transactionDetail/initializeCreateTransactionLocalData", never, never>, updateCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", localData: Partial<CreateTransactionLocalData>], {
-    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/toggleSplitEditMode", never, never>, initializeCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry"], {
+    transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/initializeCreateTransactionLocalData", never, never>, updateCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry", localData: Partial<CreateTransactionLocalData>], {
+    transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry";
     localData: Partial<CreateTransactionLocalData>;
-}, "transactionDetail/updateCreateTransactionLocalData", never, never>, updateCreateTransactionLineLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", lineId: string, lineUpdates: Partial<CreateTransactionLineLocalData>], {
-    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/updateCreateTransactionLocalData", never, never>, updateCreateTransactionLineLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry", lineId: string, lineUpdates: Partial<CreateTransactionLineLocalData>], {
+    transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry";
     lineId: string;
     lineUpdates: Partial<CreateTransactionLineLocalData>;
-}, "transactionDetail/updateCreateTransactionLineLocalData", never, never>, addCreateTransactionLine: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", line?: Partial<CreateTransactionLineLocalData> | undefined], {
-    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/updateCreateTransactionLineLocalData", never, never>, addCreateTransactionLine: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry", line?: Partial<CreateTransactionLineLocalData> | undefined], {
+    transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry";
     line: Partial<CreateTransactionLineLocalData> | undefined;
-}, "transactionDetail/addCreateTransactionLine", never, never>, removeCreateTransactionLine: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", lineId: string], {
-    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/addCreateTransactionLine", never, never>, removeCreateTransactionLine: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry", lineId: string], {
+    transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry";
     lineId: string;
-}, "transactionDetail/removeCreateTransactionLine", never, never>, resetCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry"], {
-    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
-}, "transactionDetail/resetCreateTransactionLocalData", never, never>, createTransaction: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry"], {
-    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/removeCreateTransactionLine", never, never>, resetCreateTransactionLocalData: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry"], {
+    transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/resetCreateTransactionLocalData", never, never>, createTransaction: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry"], {
+    transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry";
 }, "transactionDetail/createTransaction", never, never>, createTransactionSuccessOrFailure: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[fetchState: FetchState, createdTransactionId?: TransactionID | undefined, error?: ZeniAPIStatus<Record<string, unknown>> | undefined], {
     fetchState: FetchState;
     createdTransactionId: TransactionID | undefined;
     error: ZeniAPIStatus<Record<string, unknown>> | undefined;
-}, "transactionDetail/createTransactionSuccessOrFailure", never, never>, setRecommendationsForCreateTransactionLines: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[], recommendations: Recommendation[], isAccountingClassesEnabled: boolean], {
-    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/createTransactionSuccessOrFailure", never, never>, setRecommendationsForCreateTransactionLines: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[], recommendations: Recommendation[], isAccountingClassesEnabled: boolean], {
+    transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry";
     lineIds: string[];
     recommendations: Recommendation[];
     isAccountingClassesEnabled: boolean;
-}, "transactionDetail/setRecommendationsForCreateTransactionLines", never, never>, clearRecommendationsForCreateTransactionLines: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[]], {
-    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/setRecommendationsForCreateTransactionLines", never, never>, clearRecommendationsForCreateTransactionLines: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[]], {
+    transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry";
     lineIds: string[];
-}, "transactionDetail/clearRecommendationsForCreateTransactionLines", never, never>, fetchVendorRecommendationsForCreateTransaction: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[], entity?: Entity | undefined], {
-    transactionType: "expense" | "check" | "bill" | "credit_card_credit" | "transfer" | "journal_entry";
+}, "transactionDetail/clearRecommendationsForCreateTransactionLines", never, never>, fetchVendorRecommendationsForCreateTransaction: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry", lineIds: string[], entity?: Entity | undefined], {
+    transactionType: "expense" | "check" | "bill" | "vendor_credit" | "credit_card_credit" | "transfer" | "journal_entry";
     lineIds: string[];
     entity: Entity | undefined;
 }, "transactionDetail/fetchVendorRecommendationsForCreateTransaction", never, never>, createTransactionAttachmentUploadFailure: import("@reduxjs/toolkit").ActionCreatorWithPreparedPayload<[failedAttachmentFileNames: string[]], {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeniai/client-epic-state",
-  "version": "5.3.10-beta0KB",
+  "version": "5.3.10-beta1KB",
   "description": "Shared module between Web & Mobile containing required abstractions for state management, async network communication. ",
   "main": "lib/index.js",
   "module": "lib/esm/index.js",