fams-ts 1.0.10 → 1.0.18

package/dist/account.d.ts

@@ -43,6 +43,15 @@ export interface PeriodResponse {
     endDate: string;
     status: string;
 }
+export interface SettingsCategoryRequest {
+    values: any;
+    isPublic?: boolean;
+}
+export interface SettingsCategoryResponse {
+    category: string;
+    isPublic: boolean;
+    values: any;
+}
 export interface ValidationError {
     loc: number | string[];
     msg: string;

package/dist/approvals.d.ts

@@ -10,14 +10,37 @@ export interface AIEDetailResponse {
     purpose?: string;
     status: string;
     createdAt: string;
+    documentDetails: AIEDocumentDetailsResponse;
+}
+export interface AIEDocumentDetailsResponse {
+    treasuryForm: string;
+    warrantType: string;
+    aieNumber: string;
+    authorityTo?: string;
+    department?: string;
+    address?: string;
+    station?: string;
+    yearOfAccount: string;
+    headNo?: string;
+    subHeadNo?: string;
+    itemCode?: string;
+    itemDescription?: string;
+    servicesDescription: string;
+    beneficiary?: string;
+    beneficiaryAddress?: string;
+    financialAuthorityReference?: string;
+    officerName?: string;
+    officerDesignation?: string;
+    signatureDate?: string;
+    amountInWords: string;
 }
 export interface AddApprovalCommentRequest {
     comment: string;
 }
 export interface AddApprovalInstructionRequest {
     instruction: string;
-    amount: number;
-    payTo: string;
+    amount: number | string;
+    payTo: InlinePaymentDestinationRequest | string;
     payFrom: string;
     authority: string;
 }
@@ -31,6 +54,21 @@ export interface AddApprovalToFolderResponse {
     addedBy?: string;
     addedAt: string;
 }
+export interface ApprovalActorResponse {
+    id: string;
+    username?: string;
+    email?: string;
+    title?: string;
+    firstName?: string;
+    middleName?: string;
+    lastName?: string;
+    fullName?: string;
+    avatar?: string;
+    departmentCode?: string;
+    departmentName?: string;
+    roleCode?: string;
+    roleName?: string;
+}
 export interface ApprovalCommentResponse {
     id: string;
     commentedBy?: string;
@@ -48,11 +86,24 @@ export interface ApprovalInstructionResponse {
     amount: number;
     payToId: string;
     payFromCode: string;
+    budgetHeadCode: string;
     authorityId: string;
     aieReference?: string;
     aie?: AIEDetailResponse;
     createdAt: string;
 }
+export interface ApprovalStageHistoryResponse {
+    id: string;
+    approvalId: string;
+    departmentCode: string;
+    action: string;
+    fromStage?: string;
+    toStage?: string;
+    status: string;
+    comment?: string;
+    processedBy?: ApprovalActorResponse;
+    processedAt: string;
+}
 export interface ApprovalStatusResponse {
     id: string;
     status: string;
@@ -94,6 +145,7 @@ export interface CreateDestinationRequest {
     name: string;
     type: string;
     reference?: string;
+    address?: string;
     accountNumber?: string;
     bankName?: string;
     bankCode?: string;
@@ -118,10 +170,22 @@ export interface DestinationResponse {
     name: string;
     type: string;
     reference: string;
+    address?: string;
     accountNumber?: string;
     bankName?: string;
     bankCode?: string;
 }
+export interface DocumentExportResponse {
+    format: string;
+    filename: string;
+    contentType: string;
+    bucket: string;
+    objectName: string;
+    url: string;
+    expiresInSeconds: number;
+    documentType: string;
+    reference: string;
+}
 export interface FolderApprovalsResponse {
     folder: FolderResponse;
     approvals: PaymentApprovalSummaryResponse[];
@@ -152,6 +216,15 @@ export interface GLPostingResponse {
 export interface HTTPValidationError {
     detail?: ValidationError[];
 }
+export interface InlinePaymentDestinationRequest {
+    name: string;
+    type?: string;
+    reference?: string;
+    address?: string;
+    accountNumber?: string;
+    bankName?: string;
+    bankCode?: string;
+}
 export interface PaymentApprovalDetailResponse {
     id: string;
     paymentId: string;
@@ -167,6 +240,7 @@ export interface PaymentApprovalDetailResponse {
     attachments?: AttachmentResponse[];
     comments?: ApprovalCommentResponse[];
     instructions?: ApprovalInstructionResponse[];
+    history?: ApprovalStageHistoryResponse[];
 }
 export interface PaymentApprovalResponse {
     id: string;
@@ -192,6 +266,11 @@ export interface PaymentStatusResponse {
     id: string;
     status: string;
 }
+export interface PaymentVoucherDeductionResponse {
+    deductionType: string;
+    rate?: string;
+    amount: string;
+}
 export interface PaymentVoucherDetailResponse {
     id: string;
     pvNumber: string;
@@ -200,6 +279,61 @@ export interface PaymentVoucherDetailResponse {
     description?: string;
     status: string;
     createdAt: string;
+    documentDetails: PaymentVoucherDocumentDetailsResponse;
+}
+export interface PaymentVoucherDocumentDetailsResponse {
+    voucherType: 'ADVANCES' | 'RECURRENT' | 'CAPITAL';
+    treasuryForm: string;
+    departmentalReference: string;
+    fiscalYear: number;
+    station?: string;
+    headNo?: string;
+    subHeadNo?: string;
+    classificationCode?: string;
+    mandateNumber?: string;
+    financialAuthorityReference?: string;
+    payeeName: string;
+    payeeAddress?: string;
+    serviceDate: string;
+    serviceDescription: string;
+    supportingReference?: string;
+    grossAmount: string;
+    contractAmount?: string;
+    previousPaymentsTotal?: string;
+    balanceDueBeforePayment?: string;
+    amountApproved: string;
+    deductions?: PaymentVoucherDeductionResponse[];
+    certificationText?: string;
+    authorizingOfficer?: string;
+    authorizingOfficerDesignation?: string;
+    checkedBy?: string;
+    passedFor?: string;
+    place?: string;
+    netAmount: string;
+    amountInWords: string;
+}
+export interface PostToGLRequest {
+    entryDate?: string;
+}
+export interface ProcessedApprovalResponse {
+    historyId: string;
+    approvalId: string;
+    paymentId: string;
+    status: string;
+    currentStage?: string;
+    createdBy?: string;
+    createdAt: string;
+    documentUrl: string;
+    pvNumber?: string;
+    glPosted?: boolean;
+    processMetadata?: any;
+    departmentCode: string;
+    action: string;
+    fromStage?: string;
+    toStage?: string;
+    comment?: string;
+    processedBy?: ApprovalActorResponse;
+    processedAt: string;
 }
 export interface RejectPaymentApprovalRequest {
     reason: string;
@@ -226,4 +360,7 @@ export interface ValidationError {
 export interface VoucherResponse {
     id: string;
     pvNumber: string;
+    status: string;
+    currentStage: string;
+    voucher: PaymentVoucherDetailResponse;
 }

package/dist/auth.d.ts

@@ -19,7 +19,8 @@ export interface ChangePasswordSchema {
 }
 export interface CreateDepartmentSchema {
     name: string;
-    code: string;
+    code?: string;
+    departmentalCode?: string;
 }
 export interface CreatePermissionSchema {
     name: string;
@@ -36,6 +37,7 @@ export interface DepartmentSchema {
     id: string;
     name: string;
     code: string;
+    departmentalCode?: string;
 }
 export interface HTTPValidationError {
     detail?: ValidationError[];
@@ -44,6 +46,17 @@ export interface LoginResponseSchema {
     session: SessionSchema;
     user: UserInfoSchema;
 }
+export interface ManagedUserRegisterSchema {
+    username: string;
+    password: string;
+    email: string;
+    departmentId?: string;
+    roleId?: string;
+    title?: string;
+    firstName?: string;
+    middleName?: string;
+    lastName?: string;
+}
 export interface PermissionSchema {
     id: string;
     name: string;
@@ -116,8 +129,6 @@ export interface UserRegisterSchema {
     username: string;
     password: string;
     email: string;
-    departmentId?: string;
-    roleId?: string;
     title?: string;
     firstName?: string;
     middleName?: string;

package/dist/budget.d.ts

@@ -2,11 +2,56 @@
  * Auto-generated by custom Python script.
  * Do not edit manually.
  */
+export interface AIEDocumentDetailsRequest {
+    treasuryForm?: string;
+    warrantType?: string;
+    aieNumber?: string;
+    authorityTo?: string;
+    department?: string;
+    address?: string;
+    station?: string;
+    yearOfAccount?: string;
+    headNo?: string;
+    subHeadNo?: string;
+    itemCode?: string;
+    itemDescription?: string;
+    servicesDescription?: string;
+    beneficiary?: string;
+    beneficiaryAddress?: string;
+    financialAuthorityReference?: string;
+    officerName?: string;
+    officerDesignation?: string;
+    signatureDate?: string;
+    amountInWords?: string;
+}
+export interface AIEDocumentDetailsResponse {
+    treasuryForm: string;
+    warrantType: string;
+    aieNumber: string;
+    authorityTo?: string;
+    department?: string;
+    address?: string;
+    station?: string;
+    yearOfAccount: string;
+    headNo?: string;
+    subHeadNo?: string;
+    itemCode?: string;
+    itemDescription?: string;
+    servicesDescription: string;
+    beneficiary?: string;
+    beneficiaryAddress?: string;
+    financialAuthorityReference?: string;
+    officerName?: string;
+    officerDesignation?: string;
+    signatureDate?: string;
+    amountInWords: string;
+}
 export interface AIERequest {
     budgetHeadCode: string;
     referenceNo: string;
     amount: number | string;
     purpose: string;
+    documentDetails?: AIEDocumentDetailsRequest;
 }
 export interface AIEResponse {
     id: string;
@@ -17,23 +62,52 @@ export interface AIEResponse {
     status: string;
     instructionId?: string;
     createdAt: string;
+    documentDetails: AIEDocumentDetailsResponse;
 }
 export interface BudgetHeadCreateRequest {
     code: string;
     name: string;
     accountCode: string;
     appropriation: number | string;
+    headNo?: string;
+    subHeadNo?: string;
+    itemCode?: string;
+    classificationCode?: string;
 }
 export interface BudgetHeadResponse {
     id: string;
     code: string;
     name: string;
     accountCode: string;
+    headNo: string;
+    subHeadNo: string;
+    itemCode: string;
+    classificationCode: string;
     appropriation: string;
     commitments: string;
     totalActual: string;
     available: string;
 }
+export interface BudgetHeadUpdateRequest {
+    name?: string;
+    accountCode?: string;
+    appropriation?: number | string;
+    headNo?: string;
+    subHeadNo?: string;
+    itemCode?: string;
+    classificationCode?: string;
+}
+export interface DocumentExportResponse {
+    format: string;
+    filename: string;
+    contentType: string;
+    bucket: string;
+    objectName: string;
+    url: string;
+    expiresInSeconds: number;
+    documentType: string;
+    reference: string;
+}
 export interface HTTPValidationError {
     detail?: ValidationError[];
 }

package/dist/expenditure.d.ts

@@ -2,6 +2,17 @@
  * Auto-generated by custom Python script.
  * Do not edit manually.
  */
+export interface DocumentExportResponse {
+    format: string;
+    filename: string;
+    contentType: string;
+    bucket: string;
+    objectName: string;
+    url: string;
+    expiresInSeconds: number;
+    documentType: string;
+    reference: string;
+}
 export interface HTTPValidationError {
     detail?: ValidationError[];
 }
@@ -21,14 +32,85 @@ export interface PaymentVoucherCreateRequest {
     aieReference: string;
     date: string;
     description: string;
+    documentDetails: PaymentVoucherDocumentDetailsRequest;
     lines: PaymentLineCreateRequest[];
 }
+export interface PaymentVoucherDeductionRequest {
+    deductionType: string;
+    rate?: string;
+    amount: number | string;
+}
+export interface PaymentVoucherDeductionResponse {
+    deductionType: string;
+    rate?: string;
+    amount: string;
+}
+export interface PaymentVoucherDocumentDetailsRequest {
+    voucherType?: 'ADVANCES' | 'RECURRENT' | 'CAPITAL';
+    treasuryForm?: string;
+    departmentalReference?: string;
+    station?: string;
+    headNo?: string;
+    subHeadNo?: string;
+    classificationCode?: string;
+    mandateNumber?: string;
+    financialAuthorityReference?: string;
+    payeeName: string;
+    payeeAddress?: string;
+    serviceDate?: string;
+    serviceDescription?: string;
+    supportingReference?: string;
+    contractAmount?: number | string;
+    previousPaymentsTotal?: number | string;
+    balanceDueBeforePayment?: number | string;
+    amountApproved?: number | string;
+    deductions?: PaymentVoucherDeductionRequest[];
+    certificationText?: string;
+    authorizingOfficer?: string;
+    authorizingOfficerDesignation?: string;
+    checkedBy?: string;
+    passedFor?: string;
+    place?: string;
+    amountInWords?: string;
+}
+export interface PaymentVoucherDocumentDetailsResponse {
+    voucherType: 'ADVANCES' | 'RECURRENT' | 'CAPITAL';
+    treasuryForm: string;
+    departmentalReference: string;
+    fiscalYear: number;
+    station?: string;
+    headNo?: string;
+    subHeadNo?: string;
+    classificationCode?: string;
+    mandateNumber?: string;
+    financialAuthorityReference?: string;
+    payeeName: string;
+    payeeAddress?: string;
+    serviceDate: string;
+    serviceDescription: string;
+    supportingReference?: string;
+    grossAmount: string;
+    contractAmount?: string;
+    previousPaymentsTotal?: string;
+    balanceDueBeforePayment?: string;
+    amountApproved: string;
+    deductions?: PaymentVoucherDeductionResponse[];
+    certificationText?: string;
+    authorizingOfficer?: string;
+    authorizingOfficerDesignation?: string;
+    checkedBy?: string;
+    passedFor?: string;
+    place?: string;
+    netAmount: string;
+    amountInWords: string;
+}
 export interface PaymentVoucherResponse {
     id: string;
     aieReference: string;
     date: string;
     description: string;
     status: string;
+    documentDetails: PaymentVoucherDocumentDetailsResponse;
     lines: PaymentLineResponse[];
     stub?: boolean;
 }

package/dist/index.d.ts

@@ -1,10 +1,13 @@
 /**
  * Auto-generated index.
  */
-export { AccountCreateRequest, AccountResponse, Body_open_period_master_periods_open__period_code___post, HTTPValidationError, OpeningBalanceRequest, OpeningBalanceResponse, PeriodResponse, ValidationError } from './account';
-export { AIEDetailResponse, AddApprovalCommentRequest, AddApprovalInstructionRequest, AddApprovalToFolderRequest, AddApprovalToFolderResponse, ApprovalCommentResponse, ApprovalDocumentUrlResponse, ApprovalInstructionResponse, ApprovalStatusResponse, ApprovePaymentApprovalRequest, AttachmentResponse, AuthorityResponse, Body_upload_attachment_approvals__id__attach__post, Body_upload_payment_approval_approvals_upload__post, CreateAuthorityRequest, CreateDestinationRequest, CreateFolderRequest, DeleteFolderResponse, DepartmentSummaryResponse, DestinationResponse, FolderApprovalsResponse, FolderMembershipResponse, FolderResponse, GLPostingResponse, PaymentApprovalDetailResponse, PaymentApprovalResponse, PaymentApprovalSummaryResponse, PaymentStatusResponse, PaymentVoucherDetailResponse, RejectPaymentApprovalRequest, RemoveApprovalFromFolderResponse, ReturnPaymentApprovalRequest, UpdateFolderRequest, VoucherResponse } from './approvals';
+export { AccountCreateRequest, AccountResponse, Body_open_period_master_periods_open__period_code___post, HTTPValidationError, OpeningBalanceRequest, OpeningBalanceResponse, PeriodResponse, SettingsCategoryRequest, SettingsCategoryResponse, ValidationError } from './account';
+export { AIEDetailResponse, AIEDocumentDetailsResponse, AddApprovalCommentRequest, AddApprovalInstructionRequest, AddApprovalToFolderRequest, AddApprovalToFolderResponse, ApprovalActorResponse, ApprovalCommentResponse, ApprovalDocumentUrlResponse, ApprovalInstructionResponse, ApprovalStageHistoryResponse, ApprovalStatusResponse, ApprovePaymentApprovalRequest, AttachmentResponse, AuthorityResponse, Body_upload_attachment_approvals__id__attach__post, Body_upload_payment_approval_approvals_upload__post, CreateAuthorityRequest, CreateDestinationRequest, CreateFolderRequest, DeleteFolderResponse, DepartmentSummaryResponse, DestinationResponse, DocumentExportResponse, FolderApprovalsResponse, FolderMembershipResponse, FolderResponse, GLPostingResponse, InlinePaymentDestinationRequest, PaymentApprovalDetailResponse, PaymentApprovalResponse, PaymentApprovalSummaryResponse, PaymentStatusResponse, PaymentVoucherDeductionResponse, PaymentVoucherDetailResponse, PaymentVoucherDocumentDetailsResponse, PostToGLRequest, ProcessedApprovalResponse, RejectPaymentApprovalRequest, RemoveApprovalFromFolderResponse, ReturnPaymentApprovalRequest, UpdateFolderRequest, VoucherResponse } from './approvals';
 export { AssetCreateSchema, LiabilityCreateSchema, ReceivableCreateSchema } from './assets';
-export { ActiveSessionSchema, AssignUserRoleSchema, ChangePasswordSchema, CreateDepartmentSchema, CreatePermissionSchema, CreateRoleSchema, DepartmentSchema, LoginResponseSchema, PermissionSchema, RefreshTokenSchema, RolePermissionsSchema, RoleSchema, SessionSchema, UpdateRoleSchema, UserInfoSchema, UserLoginSchema, UserLookupSchema, UserPermissionOverrideSchema, UserRegisterSchema } from './auth';
-export { AIERequest, AIEResponse, BudgetHeadCreateRequest, BudgetHeadResponse } from './budget';
-export { PaymentLineCreateRequest, PaymentLineResponse, PaymentVoucherCreateRequest, PaymentVoucherResponse } from './expenditure';
-export { RecordReceipt } from './receipts';
+export { ActiveSessionSchema, AssignUserRoleSchema, ChangePasswordSchema, CreateDepartmentSchema, CreatePermissionSchema, CreateRoleSchema, DepartmentSchema, LoginResponseSchema, ManagedUserRegisterSchema, PermissionSchema, RefreshTokenSchema, RolePermissionsSchema, RoleSchema, SessionSchema, UpdateRoleSchema, UserInfoSchema, UserLoginSchema, UserLookupSchema, UserPermissionOverrideSchema, UserRegisterSchema } from './auth';
+export { AIEDocumentDetailsRequest, AIERequest, AIEResponse, BudgetHeadCreateRequest, BudgetHeadResponse, BudgetHeadUpdateRequest } from './budget';
+export { PaymentLineCreateRequest, PaymentLineResponse, PaymentVoucherCreateRequest, PaymentVoucherDeductionRequest, PaymentVoucherDocumentDetailsRequest, PaymentVoucherResponse } from './expenditure';
+export { MarkReadRequest, NotificationResponse } from './notifications';
+export { ReceiptResponse, RecordReceiptRequest } from './receipts';
+export { ReportExportResponse } from './reporting';
+export { BankAccountCreateSchema, BankAccountSchema, OutstandingReceiptSchema, PaymentProcessSchema, ReceiptDepositBatchCreateSchema, ReceiptDepositBatchResponse } from './treasury';

package/dist/notifications.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Auto-generated by custom Python script.
+ * Do not edit manually.
+ */
+export interface HTTPValidationError {
+    detail?: ValidationError[];
+}
+export interface MarkReadRequest {
+    notificationId: string;
+}
+export interface NotificationResponse {
+    id: string;
+    type: string;
+    title: string;
+    message: string;
+    departmentCode?: string;
+    userId?: string;
+    approvalId?: string;
+    paymentId?: string;
+    priority: string;
+    data?: any;
+    createdAt: string;
+    readAt?: string;
+}
+export interface ValidationError {
+    loc: number | string[];
+    msg: string;
+    type: string;
+}

package/dist/notifications.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Auto-generated by custom Python script.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/receipts.d.ts

@@ -5,12 +5,33 @@
 export interface HTTPValidationError {
     detail?: ValidationError[];
 }
-export interface RecordReceipt {
+export interface ReceiptResponse {
+    id: string;
+    createdAt: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
     receiptNumber: string;
     payer: string;
-    amount: string;
+    amount: number;
     revenueAccountCode: string;
     budgetHeadCode?: string;
+    paymentMethod: string;
+    receivedAt: string;
+    cashierUserId?: string;
+    bankAccountId?: string;
+    status: string;
+    remarks?: string;
+}
+export interface RecordReceiptRequest {
+    payer: string;
+    amount: number | string;
+    revenueAccountCode: string;
+    paymentMethod?: string;
+    receivedAt?: string;
+    budgetHeadCode?: string;
+    bankAccountId?: string;
+    remarks?: string;
 }
 export interface ValidationError {
     loc: number | string[];

package/dist/reporting.d.ts

@@ -5,6 +5,17 @@
 export interface HTTPValidationError {
     detail?: ValidationError[];
 }
+export interface ReportExportResponse {
+    format: string;
+    filename: string;
+    contentType: string;
+    bucket: string;
+    objectName: string;
+    url: string;
+    expiresInSeconds: number;
+    report: string;
+    period: string;
+}
 export interface ValidationError {
     loc: number | string[];
     msg: string;

package/dist/treasury.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Auto-generated by custom Python script.
+ * Do not edit manually.
+ */
+export interface BankAccountCreateSchema {
+    accountNumber: string;
+    bankName: string;
+    description?: string;
+    glAccountCode?: string;
+}
+export interface BankAccountSchema {
+    id: string;
+    createdAt: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+    accountNumber: string;
+    bankName: string;
+    balance: string;
+    description?: string;
+    glAccountCode?: string;
+}
+export interface HTTPValidationError {
+    detail?: ValidationError[];
+}
+export interface OutstandingReceiptSchema {
+    id: string;
+    createdAt: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+    receiptNumber: string;
+    payer: string;
+    amount: number;
+    revenueAccountCode: string;
+    budgetHeadCode?: string;
+    paymentMethod: string;
+    receivedAt: string;
+    cashierUserId?: string;
+    bankAccountId?: string;
+    status: string;
+    remarks?: string;
+}
+export interface PaymentProcessSchema {
+    pvNumber: string;
+    budgetHeadCode: string;
+    amount: number | string;
+    debitAccountCode: string;
+    creditAccountCode: string;
+    paymentDate: string;
+    payeeName?: string;
+    remarks?: string;
+}
+export interface ReceiptDepositBatchCreateSchema {
+    depositSlipNumber: string;
+    bankAccountId: string;
+    depositDate: string;
+    receiptIds: string[];
+    remarks?: string;
+}
+export interface ReceiptDepositBatchResponse {
+    id: string;
+    createdAt: string;
+    updatedAt?: string;
+    createdBy?: string;
+    updatedBy?: string;
+    depositSlipNumber: string;
+    bankAccountId: string;
+    depositDate: string;
+    recordedByUserId?: string;
+    totalAmount: number;
+    status: string;
+    remarks?: string;
+    receiptIds: string[];
+}
+export interface ValidationError {
+    loc: number | string[];
+    msg: string;
+    type: string;
+}

package/dist/treasury.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * Auto-generated by custom Python script.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "fams-ts",
-    "version": "1.0.10",
+    "version": "1.0.18",
     "description": "TypeScript types for FAMS Backend (Auto-generated)",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",