@crediblex.io/fineract-api-client 0.1.9 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -9,6 +9,7 @@ import { FineractReportsApi } from "./api/fineract-reports-api";
9
9
  import { FineractHolidaysApi } from "./api/fineract-holidays-api";
10
10
  import { FineractWorkingDaysApi } from "./api/fineract-workingdays-api";
11
11
  import { FineractCreditLinesApi } from "./api/fineract-creditlines-api";
12
+ import { FineractInvoicesApi } from "./api/fineract-invoices-api";
12
13
  /**
13
14
  * Configuration for the FineractSDK.
14
15
  */
@@ -30,6 +31,7 @@ export declare class FineractSDK {
30
31
  readonly holidays: FineractHolidaysApi;
31
32
  readonly workingdays: FineractWorkingDaysApi;
32
33
  readonly creditlines: FineractCreditLinesApi;
34
+ readonly invoices: FineractInvoicesApi;
33
35
  /**
34
36
  * Initializes a new instance of the FineractSDK.
35
37
  * @param config Configuration for the SDK, including baseURL, tenantId, and credentials.
@@ -1 +1 @@
1
- {"version":3,"file":"fineract-sdk.d.ts","sourceRoot":"","sources":["../src/fineract-sdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAExE;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;CAAG;AAE9D;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,SAAgB,GAAG,EAAE,cAAc,CAAC;IACpC,SAAgB,SAAS,EAAE,oBAAoB,CAAC;IAChD,SAAgB,YAAY,EAAE,uBAAuB,CAAC;IACtD,SAAgB,eAAe,EAAE,0BAA0B,CAAC;IAC5D,SAAgB,eAAe,EAAE,0BAA0B,CAAC;IAC5D,SAAgB,aAAa,EAAE,wBAAwB,CAAC;IACxD,SAAgB,OAAO,EAAE,kBAAkB,CAAC;IAC5C,SAAgB,QAAQ,EAAE,mBAAmB,CAAC;IAC9C,SAAgB,WAAW,EAAE,sBAAsB,CAAC;IACpD,SAAgB,WAAW,EAAE,sBAAsB,CAAC;IACpD;;;OAGG;gBACS,MAAM,EAAE,iBAAiB;IAcrC;;;OAGG;IACI,aAAa,IAAI,UAAU;CAGnC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,WAAW,CAExE"}
1
+ {"version":3,"file":"fineract-sdk.d.ts","sourceRoot":"","sources":["../src/fineract-sdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,EAAE,uBAAuB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;CAAG;AAE9D;;;GAGG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,SAAgB,GAAG,EAAE,cAAc,CAAC;IACpC,SAAgB,SAAS,EAAE,oBAAoB,CAAC;IAChD,SAAgB,YAAY,EAAE,uBAAuB,CAAC;IACtD,SAAgB,eAAe,EAAE,0BAA0B,CAAC;IAC5D,SAAgB,eAAe,EAAE,0BAA0B,CAAC;IAC5D,SAAgB,aAAa,EAAE,wBAAwB,CAAC;IACxD,SAAgB,OAAO,EAAE,kBAAkB,CAAC;IAC5C,SAAgB,QAAQ,EAAE,mBAAmB,CAAC;IAC9C,SAAgB,WAAW,EAAE,sBAAsB,CAAC;IACpD,SAAgB,WAAW,EAAE,sBAAsB,CAAC;IACpD,SAAgB,QAAQ,EAAE,mBAAmB,CAAC;IAC9C;;;OAGG;gBACS,MAAM,EAAE,iBAAiB;IAerC;;;OAGG;IACI,aAAa,IAAI,UAAU;CAGnC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,iBAAiB,GAAG,WAAW,CAExE"}
@@ -12,6 +12,7 @@ const fineract_reports_api_1 = require("./api/fineract-reports-api");
12
12
  const fineract_holidays_api_1 = require("./api/fineract-holidays-api");
13
13
  const fineract_workingdays_api_1 = require("./api/fineract-workingdays-api");
14
14
  const fineract_creditlines_api_1 = require("./api/fineract-creditlines-api");
15
+ const fineract_invoices_api_1 = require("./api/fineract-invoices-api");
15
16
  /**
16
17
  * Main SDK class for interacting with Fineract APIs.
17
18
  * It provides access to various API modules, starting with FineractClientApi.
@@ -33,6 +34,7 @@ class FineractSDK {
33
34
  this.holidays = new fineract_holidays_api_1.FineractHolidaysApi(this.httpClient);
34
35
  this.workingdays = new fineract_workingdays_api_1.FineractWorkingDaysApi(this.httpClient);
35
36
  this.creditlines = new fineract_creditlines_api_1.FineractCreditLinesApi(this.httpClient);
37
+ this.invoices = new fineract_invoices_api_1.FineractInvoicesApi(this.httpClient);
36
38
  }
37
39
  /**
38
40
  * Allows direct access to the underlying HttpClient for advanced use cases
@@ -1 +1 @@
1
- {"version":3,"file":"fineract-sdk.js","sourceRoot":"","sources":["../src/fineract-sdk.ts"],"names":[],"mappings":";;;AAAA,qDAAmE;AACnE,6DAAwD;AACxD,yEAAoE;AACpE,+EAA0E;AAC1E,qFAAgF;AAChF,qFAAgF;AAChF,iFAA4E;AAC5E,qEAAgE;AAChE,uEAAkE;AAClE,6EAAwE;AACxE,6EAAwE;AAOxE;;;GAGG;AACH,MAAa,WAAW;IAYtB;;;OAGG;IACH,YAAY,MAAyB;QACnC,IAAI,CAAC,UAAU,GAAG,IAAI,wBAAU,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,GAAG,IAAI,iCAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,6CAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAI,CAAC,YAAY,GAAG,IAAI,mDAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,GAAG,IAAI,yDAA0B,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvE,IAAI,CAAC,eAAe,GAAG,IAAI,yDAA0B,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvE,IAAI,CAAC,aAAa,GAAG,IAAI,qDAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAG,IAAI,yCAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,GAAG,IAAI,2CAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,WAAW,GAAG,IAAI,iDAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,GAAG,IAAI,iDAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF;AArCD,kCAqCC;AAED;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,MAAyB;IACzD,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAFD,8CAEC"}
1
+ {"version":3,"file":"fineract-sdk.js","sourceRoot":"","sources":["../src/fineract-sdk.ts"],"names":[],"mappings":";;;AAAA,qDAAmE;AACnE,6DAAwD;AACxD,yEAAoE;AACpE,+EAA0E;AAC1E,qFAAgF;AAChF,qFAAgF;AAChF,iFAA4E;AAC5E,qEAAgE;AAChE,uEAAkE;AAClE,6EAAwE;AACxE,6EAAwE;AACxE,uEAAkE;AAOlE;;;GAGG;AACH,MAAa,WAAW;IAatB;;;OAGG;IACH,YAAY,MAAyB;QACnC,IAAI,CAAC,UAAU,GAAG,IAAI,wBAAU,CAAC,MAAM,CAAC,CAAC;QACzC,IAAI,CAAC,GAAG,GAAG,IAAI,iCAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,GAAG,IAAI,6CAAoB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAI,CAAC,YAAY,GAAG,IAAI,mDAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,GAAG,IAAI,yDAA0B,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvE,IAAI,CAAC,eAAe,GAAG,IAAI,yDAA0B,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvE,IAAI,CAAC,aAAa,GAAG,IAAI,qDAAwB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAG,IAAI,yCAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvD,IAAI,CAAC,QAAQ,GAAG,IAAI,2CAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,WAAW,GAAG,IAAI,iDAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,WAAW,GAAG,IAAI,iDAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,QAAQ,GAAG,IAAI,2CAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAC3D,CAAC;IAED;;;OAGG;IACI,aAAa;QAClB,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF;AAvCD,kCAuCC;AAED;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,MAAyB;IACzD,OAAO,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAFD,8CAEC"}
package/dist/index.d.ts CHANGED
@@ -3,6 +3,7 @@ export { FineractSmeApi } from "./api/fineract-sme-api";
3
3
  export { FineractHolidaysApi } from "./api/fineract-holidays-api";
4
4
  export { FineractWorkingDaysApi } from "./api/fineract-workingdays-api";
5
5
  export { FineractCreditLinesApi } from "./api/fineract-creditlines-api";
6
+ export { FineractInvoicesApi } from "./api/fineract-invoices-api";
6
7
  export { HttpClient, HttpClientConfig } from "./utils/http-client";
7
8
  export * from "./types";
8
9
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAGxE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGnE,cAAc,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,WAAW,EACX,iBAAiB,EACjB,iBAAiB,GAClB,MAAM,gBAAgB,CAAC;AAGxB,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAClE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAGlE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAGnE,cAAc,SAAS,CAAC"}
package/dist/index.js CHANGED
@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
14
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
15
  };
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
- exports.HttpClient = exports.FineractCreditLinesApi = exports.FineractWorkingDaysApi = exports.FineractHolidaysApi = exports.FineractSmeApi = exports.createFineractSDK = exports.FineractSDK = void 0;
17
+ exports.HttpClient = exports.FineractInvoicesApi = exports.FineractCreditLinesApi = exports.FineractWorkingDaysApi = exports.FineractHolidaysApi = exports.FineractSmeApi = exports.createFineractSDK = exports.FineractSDK = void 0;
18
18
  // Main SDK exports
19
19
  var fineract_sdk_1 = require("./fineract-sdk");
20
20
  Object.defineProperty(exports, "FineractSDK", { enumerable: true, get: function () { return fineract_sdk_1.FineractSDK; } });
@@ -28,6 +28,8 @@ var fineract_workingdays_api_1 = require("./api/fineract-workingdays-api");
28
28
  Object.defineProperty(exports, "FineractWorkingDaysApi", { enumerable: true, get: function () { return fineract_workingdays_api_1.FineractWorkingDaysApi; } });
29
29
  var fineract_creditlines_api_1 = require("./api/fineract-creditlines-api");
30
30
  Object.defineProperty(exports, "FineractCreditLinesApi", { enumerable: true, get: function () { return fineract_creditlines_api_1.FineractCreditLinesApi; } });
31
+ var fineract_invoices_api_1 = require("./api/fineract-invoices-api");
32
+ Object.defineProperty(exports, "FineractInvoicesApi", { enumerable: true, get: function () { return fineract_invoices_api_1.FineractInvoicesApi; } });
31
33
  // Utility exports (optional, if you want to expose HttpClient directly)
32
34
  var http_client_1 = require("./utils/http-client");
33
35
  Object.defineProperty(exports, "HttpClient", { enumerable: true, get: function () { return http_client_1.HttpClient; } });
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,mBAAmB;AACnB,+CAIwB;AAHtB,2GAAA,WAAW,OAAA;AAEX,iHAAA,iBAAiB,OAAA;AAGnB,cAAc;AACd,2DAAwD;AAA/C,kHAAA,cAAc,OAAA;AACvB,qEAAkE;AAAzD,4HAAA,mBAAmB,OAAA;AAC5B,2EAAwE;AAA/D,kIAAA,sBAAsB,OAAA;AAC/B,2EAAwE;AAA/D,kIAAA,sBAAsB,OAAA;AAE/B,wEAAwE;AACxE,mDAAmE;AAA1D,yGAAA,UAAU,OAAA;AAEnB,eAAe;AACf,0CAAwB"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,mBAAmB;AACnB,+CAIwB;AAHtB,2GAAA,WAAW,OAAA;AAEX,iHAAA,iBAAiB,OAAA;AAGnB,cAAc;AACd,2DAAwD;AAA/C,kHAAA,cAAc,OAAA;AACvB,qEAAkE;AAAzD,4HAAA,mBAAmB,OAAA;AAC5B,2EAAwE;AAA/D,kIAAA,sBAAsB,OAAA;AAC/B,2EAAwE;AAA/D,kIAAA,sBAAsB,OAAA;AAC/B,qEAAkE;AAAzD,4HAAA,mBAAmB,OAAA;AAE5B,wEAAwE;AACxE,mDAAmE;AAA1D,yGAAA,UAAU,OAAA;AAEnB,eAAe;AACf,0CAAwB"}
@@ -4,4 +4,5 @@ export * from "./reports";
4
4
  export * from "./holidays";
5
5
  export * from "./workingdays";
6
6
  export * from "./creditlines";
7
+ export * from "./invoices";
7
8
  //# sourceMappingURL=index.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,mBAAmB,CAAC;AAClC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}
@@ -20,6 +20,7 @@ __exportStar(require("./reports"), exports);
20
20
  __exportStar(require("./holidays"), exports);
21
21
  __exportStar(require("./workingdays"), exports);
22
22
  __exportStar(require("./creditlines"), exports);
23
+ __exportStar(require("./invoices"), exports);
23
24
  // If you have other type files, export them here as well
24
25
  // export * from './common'; // For example, if you add a common types file
25
26
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,oDAAkC;AAClC,4CAA0B;AAC1B,6CAA2B;AAC3B,gDAA8B;AAC9B,gDAA8B;AAC9B,yDAAyD;AACzD,2EAA2E"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAsB;AACtB,oDAAkC;AAClC,4CAA0B;AAC1B,6CAA2B;AAC3B,gDAA8B;AAC9B,gDAA8B;AAC9B,6CAA2B;AAC3B,yDAAyD;AACzD,2EAA2E"}
@@ -0,0 +1,237 @@
1
+ import type { CalculateLoanRepaymentScheduleRequest, CalculateLoanRepaymentScheduleResponse } from "./loansaccounts";
2
+ /**
3
+ * Request parameters for getting invoices against a line of credit
4
+ */
5
+ export interface GetInvoicesRequest {
6
+ /** Client ID to get invoices for */
7
+ clientId: number;
8
+ /** Line of Credit ID */
9
+ locId: number;
10
+ /** Starting record offset for pagination (default: 0) */
11
+ offset?: number;
12
+ /** Maximum number of records to return (default: 10) */
13
+ limit?: number;
14
+ /** Additional query parameters if needed */
15
+ [key: string]: any;
16
+ }
17
+ /**
18
+ * Response structure for invoice data
19
+ */
20
+ export interface Invoice {
21
+ /** Unique identifier for the invoice/loan */
22
+ id: number;
23
+ /** Account number */
24
+ accountNo: string;
25
+ /** External ID if available */
26
+ externalId?: string;
27
+ /** Client ID associated with the invoice */
28
+ clientId: number;
29
+ /** Line of Credit ID */
30
+ locId?: number;
31
+ /** Invoice/Loan status */
32
+ status: {
33
+ id: number;
34
+ code: string;
35
+ value: string;
36
+ };
37
+ /** Principal amount */
38
+ principal: number;
39
+ /** Approved principal amount */
40
+ approvedPrincipal?: number;
41
+ /** Interest rate */
42
+ annualInterestRate?: number;
43
+ /** Term details */
44
+ termFrequency?: number;
45
+ termPeriodFrequencyType?: {
46
+ id: number;
47
+ code: string;
48
+ value: string;
49
+ };
50
+ /** Timeline information */
51
+ timeline?: {
52
+ submittedOnDate?: number[];
53
+ submittedByUsername?: string;
54
+ submittedByFirstname?: string;
55
+ submittedByLastname?: string;
56
+ actualDisbursementDate?: number[];
57
+ disbursedByUsername?: string;
58
+ disbursedByFirstname?: string;
59
+ disbursedByLastname?: string;
60
+ };
61
+ /** Summary information */
62
+ summary?: {
63
+ currency: {
64
+ code: string;
65
+ name: string;
66
+ decimalPlaces: number;
67
+ inMultiplesOf: number;
68
+ displaySymbol: string;
69
+ nameCode: string;
70
+ displayLabel: string;
71
+ };
72
+ principalDisbursed: number;
73
+ principalPaid: number;
74
+ principalWrittenOff: number;
75
+ principalOutstanding: number;
76
+ principalOverdue: number;
77
+ interestCharged: number;
78
+ interestPaid: number;
79
+ interestWaived: number;
80
+ interestWrittenOff: number;
81
+ interestOutstanding: number;
82
+ interestOverdue: number;
83
+ feeChargesCharged: number;
84
+ feeChargesDueAtDisbursementCharged: number;
85
+ feeChargesPaid: number;
86
+ feeChargesWaived: number;
87
+ feeChargesWrittenOff: number;
88
+ feeChargesOutstanding: number;
89
+ feeChargesOverdue: number;
90
+ penaltyChargesCharged: number;
91
+ penaltyChargesPaid: number;
92
+ penaltyChargesWaived: number;
93
+ penaltyChargesWrittenOff: number;
94
+ penaltyChargesOutstanding: number;
95
+ penaltyChargesOverdue: number;
96
+ totalExpectedRepayment: number;
97
+ totalRepayment: number;
98
+ totalExpectedCostOfLoan: number;
99
+ totalCostOfLoan: number;
100
+ totalWaived: number;
101
+ totalWrittenOff: number;
102
+ totalOutstanding: number;
103
+ totalOverdue: number;
104
+ };
105
+ /** Additional fields that might be present */
106
+ [key: string]: any;
107
+ }
108
+ /**
109
+ * Response structure for getting invoices
110
+ */
111
+ export interface GetInvoicesResponse {
112
+ /** Array of invoices/loans */
113
+ pageItems: Invoice[];
114
+ /** Total number of available invoices */
115
+ totalFilteredRecords: number;
116
+ /** Additional pagination or metadata fields */
117
+ [key: string]: any;
118
+ }
119
+ /**
120
+ * Base fields common to both Receivables and Payables invoice creation payloads
121
+ */
122
+ interface CreateInvoiceBase {
123
+ productId: number;
124
+ loanOfficerId: number;
125
+ loanPurposeId?: string | number | null;
126
+ fundId?: string | number | null;
127
+ submittedOnDate: string;
128
+ expectedDisbursementDate: string;
129
+ externalId?: string;
130
+ linkAccountId: number;
131
+ createStandingInstructionAtDisbursement: boolean;
132
+ lineOfCreditId: string | number;
133
+ factorRateEnabled: boolean;
134
+ loanTermFrequency: number;
135
+ loanTermFrequencyType: number;
136
+ numberOfRepayments: number;
137
+ repaymentEvery: number;
138
+ repaymentFrequencyType: number;
139
+ repaymentFrequencyNthDayType?: string | number | null;
140
+ repaymentFrequencyDayOfWeekType?: string | number | null;
141
+ repaymentsStartingFromDate?: string | null;
142
+ interestChargedFromDate?: string | null;
143
+ interestType: number;
144
+ isEqualAmortization: boolean;
145
+ amortizationType: number;
146
+ interestCalculationPeriodType: number;
147
+ loanIdToClose?: string | number | null;
148
+ isTopup?: boolean | string | null;
149
+ transactionProcessingStrategyCode: string;
150
+ interestRateFrequencyType: number;
151
+ interestRatePerPeriod: number;
152
+ charges: any[];
153
+ collateral: any[];
154
+ invoiceNo: string;
155
+ invoiceDate: string;
156
+ invoiceDueDate: string;
157
+ invoiceAmount: number;
158
+ invoiceCurrency: string;
159
+ disapprovedAmount: number;
160
+ advancePercentage: number;
161
+ amountAfterAdvance: number;
162
+ markup: number;
163
+ amountInFacilityCurrency: number;
164
+ dateFormat: string;
165
+ locale: string;
166
+ clientId: number;
167
+ loanType: string;
168
+ principal: number;
169
+ allowPartialPeriodInterestCalcualtion: boolean;
170
+ }
171
+ /**
172
+ * Receivables-specific invoice creation payload
173
+ */
174
+ export interface CreateInvoiceReceivablesRequest extends CreateInvoiceBase {
175
+ approvedReceivableAmount: number;
176
+ buyerDetails: number[];
177
+ exchangeRate?: number;
178
+ }
179
+ /**
180
+ * Payables-specific invoice creation payload
181
+ */
182
+ export interface CreateInvoicePayablesRequest extends CreateInvoiceBase {
183
+ approvedPayableAmount: number;
184
+ supplierDetails: number[];
185
+ exchangeRate: number;
186
+ }
187
+ /**
188
+ * Union type for invoice creation payloads
189
+ */
190
+ export type CreateInvoiceRequest = CreateInvoiceReceivablesRequest | CreateInvoicePayablesRequest;
191
+ /**
192
+ * Response structure returned upon successful invoice (loan) creation
193
+ */
194
+ export interface CreateInvoiceResponse {
195
+ officeId: number;
196
+ clientId: number;
197
+ loanId: number;
198
+ resourceId: number;
199
+ }
200
+ /**
201
+ * Base type for fetching repayment details for invoices (drawdowns),
202
+ * extends the existing loan repayment schedule request.
203
+ */
204
+ export interface FetchRepaymentDetailsBaseRequest extends CalculateLoanRepaymentScheduleRequest {
205
+ lineOfCreditId: number | string;
206
+ invoiceNo: string;
207
+ invoiceDate: string;
208
+ invoiceDueDate: string;
209
+ invoiceAmount: number;
210
+ invoiceCurrency: string;
211
+ advancePercentage: number;
212
+ amountAfterAdvance: number;
213
+ markup: number;
214
+ amountInFacilityCurrency: number;
215
+ }
216
+ /**
217
+ * Payables-specific repayment details request extends base with payables fields.
218
+ */
219
+ export interface FetchRepaymentDetailsPayablesRequest extends FetchRepaymentDetailsBaseRequest {
220
+ approvedPayableAmount: number;
221
+ supplierDetails: number[];
222
+ exchangeRate: number;
223
+ }
224
+ /**
225
+ * Receivables-specific repayment details request extends base with receivables fields.
226
+ */
227
+ export interface FetchRepaymentDetailsReceivablesRequest extends FetchRepaymentDetailsBaseRequest {
228
+ approvedReceivableAmount: number;
229
+ buyerDetails: number[];
230
+ }
231
+ /**
232
+ * Union type for invoice repayment details request
233
+ */
234
+ export type FetchRepaymentDetailsRequest = FetchRepaymentDetailsPayablesRequest | FetchRepaymentDetailsReceivablesRequest;
235
+ export type FetchRepaymentDetailsResponse = CalculateLoanRepaymentScheduleResponse;
236
+ export {};
237
+ //# sourceMappingURL=invoices.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"invoices.d.ts","sourceRoot":"","sources":["../../src/types/invoices.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,qCAAqC,EACrC,sCAAsC,EACvC,MAAM,iBAAiB,CAAC;AAEzB;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,oCAAoC;IACpC,QAAQ,EAAE,MAAM,CAAC;IAEjB,wBAAwB;IACxB,KAAK,EAAE,MAAM,CAAC;IAEd,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,wDAAwD;IACxD,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,4CAA4C;IAC5C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IAEX,qBAAqB;IACrB,SAAS,EAAE,MAAM,CAAC;IAElB,+BAA+B;IAC/B,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;IAEjB,wBAAwB;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,0BAA0B;IAC1B,MAAM,EAAE;QACN,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IAEF,uBAAuB;IACvB,SAAS,EAAE,MAAM,CAAC;IAElB,gCAAgC;IAChC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,oBAAoB;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,mBAAmB;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uBAAuB,CAAC,EAAE;QACxB,EAAE,EAAE,MAAM,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IAEF,2BAA2B;IAC3B,QAAQ,CAAC,EAAE;QACT,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;QAC3B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,sBAAsB,CAAC,EAAE,MAAM,EAAE,CAAC;QAClC,mBAAmB,CAAC,EAAE,MAAM,CAAC;QAC7B,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAC9B,mBAAmB,CAAC,EAAE,MAAM,CAAC;KAC9B,CAAC;IAEF,0BAA0B;IAC1B,OAAO,CAAC,EAAE;QACR,QAAQ,EAAE;YACR,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,EAAE,MAAM,CAAC;YACb,aAAa,EAAE,MAAM,CAAC;YACtB,aAAa,EAAE,MAAM,CAAC;YACtB,aAAa,EAAE,MAAM,CAAC;YACtB,QAAQ,EAAE,MAAM,CAAC;YACjB,YAAY,EAAE,MAAM,CAAC;SACtB,CAAC;QACF,kBAAkB,EAAE,MAAM,CAAC;QAC3B,aAAa,EAAE,MAAM,CAAC;QACtB,mBAAmB,EAAE,MAAM,CAAC;QAC5B,oBAAoB,EAAE,MAAM,CAAC;QAC7B,gBAAgB,EAAE,MAAM,CAAC;QACzB,eAAe,EAAE,MAAM,CAAC;QACxB,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,EAAE,MAAM,CAAC;QACvB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,mBAAmB,EAAE,MAAM,CAAC;QAC5B,eAAe,EAAE,MAAM,CAAC;QACxB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,kCAAkC,EAAE,MAAM,CAAC;QAC3C,cAAc,EAAE,MAAM,CAAC;QACvB,gBAAgB,EAAE,MAAM,CAAC;QACzB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,qBAAqB,EAAE,MAAM,CAAC;QAC9B,iBAAiB,EAAE,MAAM,CAAC;QAC1B,qBAAqB,EAAE,MAAM,CAAC;QAC9B,kBAAkB,EAAE,MAAM,CAAC;QAC3B,oBAAoB,EAAE,MAAM,CAAC;QAC7B,wBAAwB,EAAE,MAAM,CAAC;QACjC,yBAAyB,EAAE,MAAM,CAAC;QAClC,qBAAqB,EAAE,MAAM,CAAC;QAC9B,sBAAsB,EAAE,MAAM,CAAC;QAC/B,cAAc,EAAE,MAAM,CAAC;QACvB,uBAAuB,EAAE,MAAM,CAAC;QAChC,eAAe,EAAE,MAAM,CAAC;QACxB,WAAW,EAAE,MAAM,CAAC;QACpB,eAAe,EAAE,MAAM,CAAC;QACxB,gBAAgB,EAAE,MAAM,CAAC;QACzB,YAAY,EAAE,MAAM,CAAC;KACtB,CAAC;IAEF,8CAA8C;IAC9C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,8BAA8B;IAC9B,SAAS,EAAE,OAAO,EAAE,CAAC;IAErB,yCAAyC;IACzC,oBAAoB,EAAE,MAAM,CAAC;IAE7B,+CAA+C;IAC/C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED;;GAEG;AACH,UAAU,iBAAiB;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACvC,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,wBAAwB,EAAE,MAAM,CAAC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,EAAE,MAAM,CAAC;IACtB,uCAAuC,EAAE,OAAO,CAAC;IACjD,cAAc,EAAE,MAAM,GAAG,MAAM,CAAC;IAChC,iBAAiB,EAAE,OAAO,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,cAAc,EAAE,MAAM,CAAC;IACvB,sBAAsB,EAAE,MAAM,CAAC;IAC/B,4BAA4B,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACtD,+BAA+B,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACzD,0BAA0B,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3C,uBAAuB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,YAAY,EAAE,MAAM,CAAC;IACrB,mBAAmB,EAAE,OAAO,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;IACzB,6BAA6B,EAAE,MAAM,CAAC;IACtC,aAAa,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IACvC,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAAC;IAClC,iCAAiC,EAAE,MAAM,CAAC;IAC1C,yBAAyB,EAAE,MAAM,CAAC;IAClC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,OAAO,EAAE,GAAG,EAAE,CAAC;IACf,UAAU,EAAE,GAAG,EAAE,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB,EAAE,MAAM,CAAC;IACjC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,qCAAqC,EAAE,OAAO,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,iBAAiB;IACxE,wBAAwB,EAAE,MAAM,CAAC;IACjC,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,iBAAiB;IACrE,qBAAqB,EAAE,MAAM,CAAC;IAC9B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAC5B,+BAA+B,GAC/B,4BAA4B,CAAC;AAEjC;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,gCACf,SAAQ,qCAAqC;IAE7C,cAAc,EAAE,MAAM,GAAG,MAAM,CAAC;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,kBAAkB,EAAE,MAAM,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB,EAAE,MAAM,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,oCACf,SAAQ,gCAAgC;IACxC,qBAAqB,EAAE,MAAM,CAAC;IAC9B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,uCACf,SAAQ,gCAAgC;IACxC,wBAAwB,EAAE,MAAM,CAAC;IACjC,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,GACpC,oCAAoC,GACpC,uCAAuC,CAAA;AAE3C,MAAM,MAAM,6BAA6B,GACvC,sCAAsC,CAAC"}
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=invoices.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"invoices.js","sourceRoot":"","sources":["../../src/types/invoices.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@crediblex.io/fineract-api-client",
3
- "version": "0.1.9",
3
+ "version": "0.4.0",
4
4
  "description": "TypeScript client for Fineract APIs",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",