@payabli/sdk-node 0.0.135 → 0.0.136

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.
Files changed (177) hide show
  1. package/README.md +13 -13
  2. package/dist/cjs/BaseClient.js +2 -2
  3. package/dist/cjs/Client.d.ts +6 -0
  4. package/dist/cjs/Client.js +52 -42
  5. package/dist/cjs/api/resources/ghostCard/client/Client.d.ts +67 -0
  6. package/dist/cjs/api/resources/ghostCard/client/Client.js +201 -0
  7. package/dist/cjs/api/resources/ghostCard/client/index.d.ts +1 -0
  8. package/dist/cjs/api/resources/ghostCard/client/index.js +17 -0
  9. package/dist/cjs/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.d.ts +53 -0
  10. package/dist/cjs/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.js +3 -0
  11. package/dist/cjs/api/resources/ghostCard/client/requests/UpdateCardRequestBody.d.ts +14 -0
  12. package/dist/cjs/api/resources/ghostCard/client/requests/UpdateCardRequestBody.js +3 -0
  13. package/dist/cjs/api/resources/ghostCard/client/requests/index.d.ts +2 -0
  14. package/dist/cjs/api/resources/ghostCard/client/requests/index.js +2 -0
  15. package/dist/cjs/api/resources/ghostCard/exports.d.ts +2 -0
  16. package/dist/cjs/api/resources/ghostCard/exports.js +21 -0
  17. package/dist/cjs/api/resources/ghostCard/index.d.ts +2 -0
  18. package/dist/cjs/api/resources/ghostCard/index.js +18 -0
  19. package/dist/cjs/api/resources/ghostCard/types/CardStatus.d.ts +8 -0
  20. package/dist/cjs/api/resources/ghostCard/types/CardStatus.js +11 -0
  21. package/dist/cjs/api/resources/ghostCard/types/CreateGhostCardResponse.d.ts +17 -0
  22. package/dist/cjs/api/resources/ghostCard/types/CreateGhostCardResponse.js +3 -0
  23. package/dist/cjs/api/resources/ghostCard/types/index.d.ts +2 -0
  24. package/dist/cjs/api/resources/ghostCard/types/index.js +18 -0
  25. package/dist/cjs/api/resources/index.d.ts +6 -0
  26. package/dist/cjs/api/resources/index.js +7 -1
  27. package/dist/cjs/api/resources/payoutSubscription/client/Client.d.ts +156 -0
  28. package/dist/cjs/api/resources/payoutSubscription/client/Client.js +385 -0
  29. package/dist/cjs/api/resources/payoutSubscription/client/index.d.ts +1 -0
  30. package/dist/cjs/api/resources/payoutSubscription/client/index.js +17 -0
  31. package/dist/cjs/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.d.ts +67 -0
  32. package/dist/cjs/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.js +3 -0
  33. package/dist/cjs/api/resources/payoutSubscription/client/requests/index.d.ts +1 -0
  34. package/dist/cjs/api/resources/payoutSubscription/client/requests/index.js +2 -0
  35. package/dist/cjs/api/resources/payoutSubscription/exports.d.ts +2 -0
  36. package/dist/cjs/api/resources/payoutSubscription/exports.js +21 -0
  37. package/dist/cjs/api/resources/payoutSubscription/index.d.ts +2 -0
  38. package/dist/cjs/api/resources/payoutSubscription/index.js +18 -0
  39. package/dist/cjs/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.d.ts +20 -0
  40. package/dist/cjs/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.js +3 -0
  41. package/dist/cjs/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.d.ts +14 -0
  42. package/dist/cjs/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.js +3 -0
  43. package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.ts +151 -0
  44. package/dist/cjs/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.js +3 -0
  45. package/dist/cjs/api/resources/payoutSubscription/types/PayoutPaymentDetail.d.ts +31 -0
  46. package/dist/cjs/api/resources/payoutSubscription/types/PayoutPaymentDetail.js +3 -0
  47. package/dist/cjs/api/resources/payoutSubscription/types/PayoutScheduleDetail.d.ts +9 -0
  48. package/dist/cjs/api/resources/payoutSubscription/types/PayoutScheduleDetail.js +3 -0
  49. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSetPause.d.ts +4 -0
  50. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSetPause.js +3 -0
  51. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.ts +195 -0
  52. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.js +3 -0
  53. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.ts +195 -0
  54. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.js +3 -0
  55. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.d.ts +69 -0
  56. package/dist/cjs/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.js +3 -0
  57. package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.ts +155 -0
  58. package/dist/cjs/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.js +3 -0
  59. package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.d.ts +9 -0
  60. package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.js +3 -0
  61. package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.d.ts +15 -0
  62. package/dist/cjs/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.js +3 -0
  63. package/dist/cjs/api/resources/payoutSubscription/types/index.d.ts +12 -0
  64. package/dist/cjs/api/resources/payoutSubscription/types/index.js +28 -0
  65. package/dist/cjs/api/resources/query/client/Client.d.ts +46 -6
  66. package/dist/cjs/api/resources/query/client/Client.js +150 -6
  67. package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.d.ts +84 -0
  68. package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.js +3 -0
  69. package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.d.ts +84 -0
  70. package/dist/cjs/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.js +3 -0
  71. package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -0
  72. package/dist/cjs/api/types/Remitaddress1.d.ts +1 -1
  73. package/dist/cjs/api/types/Remitaddress2.d.ts +1 -1
  74. package/dist/cjs/api/types/Remitcity.d.ts +1 -1
  75. package/dist/cjs/api/types/Remitcountry.d.ts +1 -1
  76. package/dist/cjs/api/types/Remitstate.d.ts +1 -1
  77. package/dist/cjs/api/types/Remitzip.d.ts +1 -1
  78. package/dist/cjs/api/types/VendorData.d.ts +6 -6
  79. package/dist/cjs/api/types/VendorEin.d.ts +1 -1
  80. package/dist/cjs/api/types/VendorName1.d.ts +1 -1
  81. package/dist/cjs/api/types/VendorName2.d.ts +1 -1
  82. package/dist/cjs/api/types/VendorNumber.d.ts +1 -1
  83. package/dist/cjs/api/types/VendorOutData.d.ts +9 -9
  84. package/dist/cjs/api/types/VendorQueryRecord.d.ts +1 -1
  85. package/dist/cjs/api/types/Vendorstatus.d.ts +5 -3
  86. package/dist/cjs/core/file/file.js +3 -2
  87. package/dist/cjs/version.d.ts +1 -1
  88. package/dist/cjs/version.js +1 -1
  89. package/dist/esm/BaseClient.mjs +2 -2
  90. package/dist/esm/Client.d.mts +6 -0
  91. package/dist/esm/Client.mjs +10 -0
  92. package/dist/esm/api/resources/ghostCard/client/Client.d.mts +67 -0
  93. package/dist/esm/api/resources/ghostCard/client/Client.mjs +164 -0
  94. package/dist/esm/api/resources/ghostCard/client/index.d.mts +1 -0
  95. package/dist/esm/api/resources/ghostCard/client/index.mjs +1 -0
  96. package/dist/esm/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.d.mts +53 -0
  97. package/dist/esm/api/resources/ghostCard/client/requests/CreateGhostCardRequestBody.mjs +2 -0
  98. package/dist/esm/api/resources/ghostCard/client/requests/UpdateCardRequestBody.d.mts +14 -0
  99. package/dist/esm/api/resources/ghostCard/client/requests/UpdateCardRequestBody.mjs +2 -0
  100. package/dist/esm/api/resources/ghostCard/client/requests/index.d.mts +2 -0
  101. package/dist/esm/api/resources/ghostCard/client/requests/index.mjs +1 -0
  102. package/dist/esm/api/resources/ghostCard/exports.d.mts +2 -0
  103. package/dist/esm/api/resources/ghostCard/exports.mjs +3 -0
  104. package/dist/esm/api/resources/ghostCard/index.d.mts +2 -0
  105. package/dist/esm/api/resources/ghostCard/index.mjs +2 -0
  106. package/dist/esm/api/resources/ghostCard/types/CardStatus.d.mts +8 -0
  107. package/dist/esm/api/resources/ghostCard/types/CardStatus.mjs +8 -0
  108. package/dist/esm/api/resources/ghostCard/types/CreateGhostCardResponse.d.mts +17 -0
  109. package/dist/esm/api/resources/ghostCard/types/CreateGhostCardResponse.mjs +2 -0
  110. package/dist/esm/api/resources/ghostCard/types/index.d.mts +2 -0
  111. package/dist/esm/api/resources/ghostCard/types/index.mjs +2 -0
  112. package/dist/esm/api/resources/index.d.mts +6 -0
  113. package/dist/esm/api/resources/index.mjs +6 -0
  114. package/dist/esm/api/resources/payoutSubscription/client/Client.d.mts +156 -0
  115. package/dist/esm/api/resources/payoutSubscription/client/Client.mjs +348 -0
  116. package/dist/esm/api/resources/payoutSubscription/client/index.d.mts +1 -0
  117. package/dist/esm/api/resources/payoutSubscription/client/index.mjs +1 -0
  118. package/dist/esm/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.d.mts +67 -0
  119. package/dist/esm/api/resources/payoutSubscription/client/requests/RequestPayoutSchedule.mjs +2 -0
  120. package/dist/esm/api/resources/payoutSubscription/client/requests/index.d.mts +1 -0
  121. package/dist/esm/api/resources/payoutSubscription/client/requests/index.mjs +1 -0
  122. package/dist/esm/api/resources/payoutSubscription/exports.d.mts +2 -0
  123. package/dist/esm/api/resources/payoutSubscription/exports.mjs +3 -0
  124. package/dist/esm/api/resources/payoutSubscription/index.d.mts +2 -0
  125. package/dist/esm/api/resources/payoutSubscription/index.mjs +2 -0
  126. package/dist/esm/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.d.mts +20 -0
  127. package/dist/esm/api/resources/payoutSubscription/types/AddPayoutSubscriptionResponse.mjs +2 -0
  128. package/dist/esm/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.d.mts +14 -0
  129. package/dist/esm/api/resources/payoutSubscription/types/DeletePayoutSubscriptionResponse.mjs +2 -0
  130. package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.d.mts +151 -0
  131. package/dist/esm/api/resources/payoutSubscription/types/GetPayoutSubscriptionResponse.mjs +2 -0
  132. package/dist/esm/api/resources/payoutSubscription/types/PayoutPaymentDetail.d.mts +31 -0
  133. package/dist/esm/api/resources/payoutSubscription/types/PayoutPaymentDetail.mjs +2 -0
  134. package/dist/esm/api/resources/payoutSubscription/types/PayoutScheduleDetail.d.mts +9 -0
  135. package/dist/esm/api/resources/payoutSubscription/types/PayoutScheduleDetail.mjs +2 -0
  136. package/dist/esm/api/resources/payoutSubscription/types/PayoutSetPause.d.mts +4 -0
  137. package/dist/esm/api/resources/payoutSubscription/types/PayoutSetPause.mjs +2 -0
  138. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.d.mts +195 -0
  139. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecord.mjs +2 -0
  140. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.d.mts +195 -0
  141. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionQueryRecordPascal.mjs +2 -0
  142. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.d.mts +69 -0
  143. package/dist/esm/api/resources/payoutSubscription/types/PayoutSubscriptionRequestBody.mjs +2 -0
  144. package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.d.mts +155 -0
  145. package/dist/esm/api/resources/payoutSubscription/types/QueryPayoutSubscriptionResponse.mjs +2 -0
  146. package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.d.mts +9 -0
  147. package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionBody.mjs +2 -0
  148. package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.d.mts +15 -0
  149. package/dist/esm/api/resources/payoutSubscription/types/UpdatePayoutSubscriptionResponse.mjs +2 -0
  150. package/dist/esm/api/resources/payoutSubscription/types/index.d.mts +12 -0
  151. package/dist/esm/api/resources/payoutSubscription/types/index.mjs +12 -0
  152. package/dist/esm/api/resources/query/client/Client.d.mts +46 -6
  153. package/dist/esm/api/resources/query/client/Client.mjs +150 -6
  154. package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.d.mts +84 -0
  155. package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsOrgRequest.mjs +2 -0
  156. package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.d.mts +84 -0
  157. package/dist/esm/api/resources/query/client/requests/ListPayoutSubscriptionsRequest.mjs +2 -0
  158. package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -0
  159. package/dist/esm/api/types/Remitaddress1.d.mts +1 -1
  160. package/dist/esm/api/types/Remitaddress2.d.mts +1 -1
  161. package/dist/esm/api/types/Remitcity.d.mts +1 -1
  162. package/dist/esm/api/types/Remitcountry.d.mts +1 -1
  163. package/dist/esm/api/types/Remitstate.d.mts +1 -1
  164. package/dist/esm/api/types/Remitzip.d.mts +1 -1
  165. package/dist/esm/api/types/VendorData.d.mts +6 -6
  166. package/dist/esm/api/types/VendorEin.d.mts +1 -1
  167. package/dist/esm/api/types/VendorName1.d.mts +1 -1
  168. package/dist/esm/api/types/VendorName2.d.mts +1 -1
  169. package/dist/esm/api/types/VendorNumber.d.mts +1 -1
  170. package/dist/esm/api/types/VendorOutData.d.mts +9 -9
  171. package/dist/esm/api/types/VendorQueryRecord.d.mts +1 -1
  172. package/dist/esm/api/types/Vendorstatus.d.mts +5 -3
  173. package/dist/esm/core/file/file.mjs +3 -2
  174. package/dist/esm/version.d.mts +1 -1
  175. package/dist/esm/version.mjs +1 -1
  176. package/package.json +29 -7
  177. package/reference.md +682 -78
@@ -0,0 +1,151 @@
1
+ import type * as Payabli from "../../../index.js";
2
+ /**
3
+ * Success response
4
+ *
5
+ * @example
6
+ * {
7
+ * responseText: "Success",
8
+ * isSuccess: true,
9
+ * responseData: {
10
+ * idOutSubscription: 42,
11
+ * status: 1,
12
+ * events: [{
13
+ * description: "TransferCreated",
14
+ * eventTime: "2025-09-01T06:00:00Z",
15
+ * extraData: {
16
+ * "key": "value"
17
+ * },
18
+ * refData: "refData",
19
+ * source: "api"
20
+ * }],
21
+ * vendor: {
22
+ * VendorNumber: "1234",
23
+ * Name1: "Herman's Coatings",
24
+ * Name2: "Herman's Coating Supply Company, LLC",
25
+ * EIN: "123456789",
26
+ * Phone: "2125551234",
27
+ * Email: "example@email.com",
28
+ * Address1: "123 Ocean Drive",
29
+ * Address2: "Suite 400",
30
+ * City: "Bristol",
31
+ * State: "GA",
32
+ * Zip: "31113",
33
+ * Country: "US",
34
+ * Mcc: "7777",
35
+ * LocationCode: "LOC123",
36
+ * Contacts: {
37
+ * ContactEmail: "eric@martinezcoatings.com",
38
+ * ContactName: "Eric Martinez",
39
+ * ContactPhone: "5555555555",
40
+ * ContactTitle: "Owner"
41
+ * },
42
+ * BillingData: {
43
+ * id: 123456,
44
+ * accountId: "bank-account-001",
45
+ * nickname: "Main Checking Account",
46
+ * bankName: "Example Bank",
47
+ * routingAccount: "123456789",
48
+ * accountNumber: "9876543210",
49
+ * typeAccount: Payabli.TypeAccount.Checking,
50
+ * bankAccountHolderName: "John Doe",
51
+ * bankAccountHolderType: Payabli.BankAccountHolderType.Business,
52
+ * bankAccountFunction: 2,
53
+ * verified: true,
54
+ * status: 1,
55
+ * services: [],
56
+ * "default": true
57
+ * },
58
+ * VendorStatus: 1,
59
+ * VendorId: 1,
60
+ * Summary: {
61
+ * ActiveBills: 2,
62
+ * PendingBills: 4,
63
+ * InTransitBills: 3,
64
+ * PaidBills: 18,
65
+ * OverdueBills: 1,
66
+ * ApprovedBills: 5,
67
+ * DisapprovedBills: 1,
68
+ * TotalBills: 34,
69
+ * ActiveBillsAmount: 1250.75,
70
+ * PendingBillsAmount: 2890.5,
71
+ * InTransitBillsAmount: 1675.25,
72
+ * PaidBillsAmount: 15420.8,
73
+ * OverdueBillsAmount: 425,
74
+ * ApprovedBillsAmount: 3240.9,
75
+ * DisapprovedBillsAmount: 180,
76
+ * TotalBillsAmount: 25083.2
77
+ * },
78
+ * PaypointLegalname: "Sunshine Services, LLC",
79
+ * PaypointDbaname: "Sunshine Gutters",
80
+ * PaypointEntryname: "d193cf9a46",
81
+ * ParentOrgName: "PropertyManager Pro",
82
+ * ParentOrgId: 1000,
83
+ * CreatedDate: "2022-07-01T15:00:01Z",
84
+ * LastUpdated: "2022-07-01T15:00:01Z",
85
+ * remitAddress1: "123 Walnut Street",
86
+ * remitAddress2: "Suite 900",
87
+ * remitCity: "Miami",
88
+ * remitState: "FL",
89
+ * remitZip: "31113",
90
+ * remitCountry: "US",
91
+ * payeeName1: "payeeName1",
92
+ * payeeName2: "payeeName2",
93
+ * customField1: "",
94
+ * customField2: "",
95
+ * customerVendorAccount: "123-456",
96
+ * InternalReferenceId: 1000000,
97
+ * externalPaypointID: "Paypoint-100",
98
+ * StoredMethods: []
99
+ * },
100
+ * billData: [{
101
+ * billId: 3001,
102
+ * invoiceNumber: "INV-5001",
103
+ * netAmount: "500",
104
+ * invoiceDate: "2025-08-01",
105
+ * dueDate: "2025-08-15"
106
+ * }],
107
+ * externalPaypointID: "d193cf9a46-10",
108
+ * method: "ach",
109
+ * paypointId: 255,
110
+ * totalAmount: 500,
111
+ * netAmount: 500,
112
+ * feeAmount: 0,
113
+ * paymentData: {
114
+ * AccountType: "checking",
115
+ * HolderName: "Herman Coatings",
116
+ * Initiator: "merchant",
117
+ * MaskedAccount: "XXXXXX5666",
118
+ * paymentDetails: {
119
+ * currency: "USD",
120
+ * serviceFee: 0,
121
+ * totalAmount: 500
122
+ * },
123
+ * Sequence: "subsequent",
124
+ * StoredMethodUsageType: "recurring"
125
+ * },
126
+ * startDate: "2025-09-01T00:00:00Z",
127
+ * endDate: "2026-09-01T00:00:00Z",
128
+ * nextDate: "2025-10-01T00:00:00Z",
129
+ * frequency: "monthly",
130
+ * totalCycles: 12,
131
+ * leftCycles: 11,
132
+ * lastRun: "2025-09-01T06:00:00Z",
133
+ * entrypageId: 0,
134
+ * untilCancelled: false,
135
+ * lastUpdated: "2025-08-01T12:00:00Z",
136
+ * createdAt: "2025-08-01T12:00:00Z",
137
+ * paypointLegalname: "Sunshine Services, LLC",
138
+ * paypointDbaname: "Sunshine Gutters",
139
+ * paypointEntryname: "d193cf9a46",
140
+ * parentOrgName: "PropertyManager Pro",
141
+ * parentOrgId: 236,
142
+ * source: "api"
143
+ * }
144
+ * }
145
+ */
146
+ export interface GetPayoutSubscriptionResponse {
147
+ isSuccess?: Payabli.IsSuccess | undefined;
148
+ responseText: Payabli.ResponseText;
149
+ /** The payout subscription record. */
150
+ responseData?: Payabli.PayoutSubscriptionQueryRecord | undefined;
151
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,31 @@
1
+ /**
2
+ * Payment details for payout subscriptions.
3
+ */
4
+ export interface PayoutPaymentDetail {
5
+ /** Total payout amount. If a service fee is included, this amount should include the service fee. */
6
+ totalAmount: number;
7
+ /** Service fee to be deducted from the total amount. This amount must be a number, percentages aren't accepted. */
8
+ serviceFee?: number | undefined;
9
+ /** Currency code ISO-4217. If no code is provided, the currency in the paypoint setting is used. Default is `USD`. */
10
+ currency?: string | undefined;
11
+ /** A check number for the payout. Required when the payment method is `check`. */
12
+ checkNumber?: string | undefined;
13
+ /** Description of the payout order. */
14
+ orderDescription?: string | undefined;
15
+ /** Order identifier associated with the payout. */
16
+ orderId?: string | undefined;
17
+ /** Alternative order identifier. */
18
+ orderIdAlternative?: string | undefined;
19
+ /** Description of the payment. */
20
+ paymentDescription?: string | undefined;
21
+ /** Settlement descriptor for the payout. */
22
+ settlementDescriptor?: string | undefined;
23
+ /** Group number for the payout. */
24
+ groupNumber?: string | undefined;
25
+ /** Source identifier for the payout. */
26
+ source?: string | undefined;
27
+ /** Payabli transaction identifier. */
28
+ payabliTransId?: string | undefined;
29
+ /** When `true`, each bill is processed as a separate payout. When `false` or not provided, multiple bills are paid with a single payout. */
30
+ unbundled?: boolean | undefined;
31
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ import type * as Payabli from "../../../index.js";
2
+ export interface PayoutScheduleDetail {
3
+ /** Subscription start date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY. This must be a future date. */
4
+ startDate?: string | undefined;
5
+ /** Subscription end date in any of the accepted formats: YYYY-MM-DD, MM/DD/YYYY or the value `untilcancelled` to indicate a scheduled payout with infinite cycle. */
6
+ endDate?: string | undefined;
7
+ /** Frequency of the payout subscription. */
8
+ frequency?: Payabli.Frequency | undefined;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,4 @@
1
+ /**
2
+ * Flag indicating if the payout subscription is paused. When a payout subscription is paused, no payouts are processed until it's unpaused, and the next payment date isn't calculated automatically.
3
+ */
4
+ export type PayoutSetPause = boolean;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,195 @@
1
+ import type * as Payabli from "../../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * idOutSubscription: 42,
6
+ * status: 1,
7
+ * events: [{
8
+ * description: "TransferCreated",
9
+ * eventTime: "2025-09-01T06:00:00Z",
10
+ * extraData: {
11
+ * "key": "value"
12
+ * },
13
+ * refData: "refData",
14
+ * source: "api"
15
+ * }],
16
+ * vendor: {
17
+ * VendorNumber: "1234",
18
+ * Name1: "Herman's Coatings",
19
+ * Name2: "Herman's Coating Supply Company, LLC",
20
+ * EIN: "123456789",
21
+ * Phone: "2125551234",
22
+ * Email: "example@email.com",
23
+ * Address1: "123 Ocean Drive",
24
+ * Address2: "Suite 400",
25
+ * City: "Bristol",
26
+ * State: "GA",
27
+ * Zip: "31113",
28
+ * Country: "US",
29
+ * Mcc: "7777",
30
+ * LocationCode: "LOC123",
31
+ * Contacts: {
32
+ * ContactEmail: "eric@martinezcoatings.com",
33
+ * ContactName: "Eric Martinez",
34
+ * ContactPhone: "5555555555",
35
+ * ContactTitle: "Owner"
36
+ * },
37
+ * BillingData: {
38
+ * id: 123456,
39
+ * accountId: "bank-account-001",
40
+ * nickname: "Main Checking Account",
41
+ * bankName: "Example Bank",
42
+ * routingAccount: "123456789",
43
+ * accountNumber: "9876543210",
44
+ * typeAccount: Payabli.TypeAccount.Checking,
45
+ * bankAccountHolderName: "John Doe",
46
+ * bankAccountHolderType: Payabli.BankAccountHolderType.Business,
47
+ * bankAccountFunction: 2,
48
+ * verified: true,
49
+ * status: 1,
50
+ * services: [],
51
+ * "default": true
52
+ * },
53
+ * VendorStatus: 1,
54
+ * VendorId: 1,
55
+ * Summary: {
56
+ * ActiveBills: 2,
57
+ * PendingBills: 4,
58
+ * InTransitBills: 3,
59
+ * PaidBills: 18,
60
+ * OverdueBills: 1,
61
+ * ApprovedBills: 5,
62
+ * DisapprovedBills: 1,
63
+ * TotalBills: 34,
64
+ * ActiveBillsAmount: 1250.75,
65
+ * PendingBillsAmount: 2890.5,
66
+ * InTransitBillsAmount: 1675.25,
67
+ * PaidBillsAmount: 15420.8,
68
+ * OverdueBillsAmount: 425,
69
+ * ApprovedBillsAmount: 3240.9,
70
+ * DisapprovedBillsAmount: 180,
71
+ * TotalBillsAmount: 25083.2
72
+ * },
73
+ * PaypointLegalname: "Sunshine Services, LLC",
74
+ * PaypointDbaname: "Sunshine Gutters",
75
+ * PaypointEntryname: "d193cf9a46",
76
+ * ParentOrgName: "PropertyManager Pro",
77
+ * ParentOrgId: 1000,
78
+ * CreatedDate: "2022-07-01T15:00:01Z",
79
+ * LastUpdated: "2022-07-01T15:00:01Z",
80
+ * remitAddress1: "123 Walnut Street",
81
+ * remitAddress2: "Suite 900",
82
+ * remitCity: "Miami",
83
+ * remitState: "FL",
84
+ * remitZip: "31113",
85
+ * remitCountry: "US",
86
+ * payeeName1: "payeeName1",
87
+ * payeeName2: "payeeName2",
88
+ * customField1: "",
89
+ * customField2: "",
90
+ * customerVendorAccount: "123-456",
91
+ * InternalReferenceId: 1000000,
92
+ * externalPaypointID: "Paypoint-100",
93
+ * StoredMethods: []
94
+ * },
95
+ * billData: [{
96
+ * billId: 3001,
97
+ * invoiceNumber: "INV-5001",
98
+ * netAmount: "500",
99
+ * invoiceDate: "2025-08-01",
100
+ * dueDate: "2025-08-15"
101
+ * }],
102
+ * externalPaypointID: "d193cf9a46-10",
103
+ * method: "ach",
104
+ * paypointId: 255,
105
+ * totalAmount: 500,
106
+ * netAmount: 500,
107
+ * feeAmount: 0,
108
+ * paymentData: {
109
+ * AccountType: "checking",
110
+ * HolderName: "Herman Coatings",
111
+ * Initiator: "merchant",
112
+ * MaskedAccount: "XXXXXX5666",
113
+ * paymentDetails: {
114
+ * currency: "USD",
115
+ * serviceFee: 0,
116
+ * totalAmount: 500
117
+ * },
118
+ * Sequence: "subsequent",
119
+ * StoredMethodUsageType: "recurring"
120
+ * },
121
+ * startDate: "2025-09-01T00:00:00Z",
122
+ * endDate: "2026-09-01T00:00:00Z",
123
+ * nextDate: "2025-10-01T00:00:00Z",
124
+ * frequency: "monthly",
125
+ * totalCycles: 12,
126
+ * leftCycles: 11,
127
+ * lastRun: "2025-09-01T06:00:00Z",
128
+ * entrypageId: 0,
129
+ * untilCancelled: false,
130
+ * lastUpdated: "2025-08-01T12:00:00Z",
131
+ * createdAt: "2025-08-01T12:00:00Z",
132
+ * paypointLegalname: "Sunshine Services, LLC",
133
+ * paypointDbaname: "Sunshine Gutters",
134
+ * paypointEntryname: "d193cf9a46",
135
+ * parentOrgName: "PropertyManager Pro",
136
+ * parentOrgId: 236,
137
+ * source: "api"
138
+ * }
139
+ */
140
+ export interface PayoutSubscriptionQueryRecord {
141
+ /** The payout subscription's ID. */
142
+ idOutSubscription?: number | undefined;
143
+ /**
144
+ * The payout subscription's status.
145
+ * - 0: Paused
146
+ * - 1: Active
147
+ */
148
+ status?: number | undefined;
149
+ /** Events associated with the payout subscription. */
150
+ events?: Payabli.GeneralEvents[] | undefined;
151
+ vendor?: Payabli.VendorQueryRecord | undefined;
152
+ /** Bills associated with the payout subscription. */
153
+ billData?: Payabli.BillPayOutData[] | undefined;
154
+ externalPaypointID?: Payabli.ExternalPaypointId | undefined;
155
+ /** The payout subscription's payment method. */
156
+ method?: string | undefined;
157
+ paypointId?: Payabli.PaypointId | undefined;
158
+ /** The payout subscription amount, including any fees. */
159
+ totalAmount?: number | undefined;
160
+ /** The payout subscription amount, minus any fees. */
161
+ netAmount?: Payabli.Netamountnullable | undefined;
162
+ /** Fee applied to the payout subscription. */
163
+ feeAmount?: number | undefined;
164
+ paymentData?: Payabli.QueryPaymentData | undefined;
165
+ /** The payout subscription start date. */
166
+ startDate: string | null;
167
+ /** The payout subscription's end date. */
168
+ endDate: string | null;
169
+ /** The next date the payout subscription will be processed. */
170
+ nextDate: string | null;
171
+ /** The payout subscription's frequency. */
172
+ frequency?: string | undefined;
173
+ /** The total number of cycles the payout subscription is set to run. */
174
+ totalCycles?: number | undefined;
175
+ /** The number of cycles the payout subscription has left. */
176
+ leftCycles?: number | undefined;
177
+ /** The last time the payout subscription was processed. */
178
+ lastRun: string | null;
179
+ entrypageId?: Payabli.EntrypageId | undefined;
180
+ /** When `true`, the payout subscription has no explicit end date and runs until canceled. */
181
+ untilCancelled?: boolean | undefined;
182
+ /** The last date and time the payout subscription was updated. */
183
+ lastUpdated?: Payabli.LastModified | undefined;
184
+ /** Timestamp of when the payout subscription was created, in UTC. */
185
+ createdAt?: Payabli.CreatedAt | undefined;
186
+ /** The paypoint's legal name. */
187
+ paypointLegalname?: Payabli.Legalname | undefined;
188
+ /** The paypoint's DBA name. */
189
+ paypointDbaname?: Payabli.Dbaname | undefined;
190
+ /** The paypoint's entryname. */
191
+ paypointEntryname?: Payabli.Entrypointfield | undefined;
192
+ parentOrgName?: Payabli.OrgParentName | undefined;
193
+ parentOrgId?: Payabli.OrgParentId | undefined;
194
+ source?: Payabli.Source | undefined;
195
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,195 @@
1
+ import type * as Payabli from "../../../index.js";
2
+ /**
3
+ * @example
4
+ * {
5
+ * IdOutSubscription: 42,
6
+ * Status: 1,
7
+ * Events: [{
8
+ * description: "TransferCreated",
9
+ * eventTime: "2025-09-01T06:00:00Z",
10
+ * extraData: {
11
+ * "key": "value"
12
+ * },
13
+ * refData: "refData",
14
+ * source: "api"
15
+ * }],
16
+ * Vendor: {
17
+ * VendorNumber: "1234",
18
+ * Name1: "Herman's Coatings",
19
+ * Name2: "Herman's Coating Supply Company, LLC",
20
+ * EIN: "123456789",
21
+ * Phone: "2125551234",
22
+ * Email: "example@email.com",
23
+ * Address1: "123 Ocean Drive",
24
+ * Address2: "Suite 400",
25
+ * City: "Bristol",
26
+ * State: "GA",
27
+ * Zip: "31113",
28
+ * Country: "US",
29
+ * Mcc: "7777",
30
+ * LocationCode: "LOC123",
31
+ * Contacts: {
32
+ * ContactEmail: "eric@martinezcoatings.com",
33
+ * ContactName: "Eric Martinez",
34
+ * ContactPhone: "5555555555",
35
+ * ContactTitle: "Owner"
36
+ * },
37
+ * BillingData: {
38
+ * id: 123456,
39
+ * accountId: "bank-account-001",
40
+ * nickname: "Main Checking Account",
41
+ * bankName: "Example Bank",
42
+ * routingAccount: "123456789",
43
+ * accountNumber: "9876543210",
44
+ * typeAccount: Payabli.TypeAccount.Checking,
45
+ * bankAccountHolderName: "John Doe",
46
+ * bankAccountHolderType: Payabli.BankAccountHolderType.Business,
47
+ * bankAccountFunction: 2,
48
+ * verified: true,
49
+ * status: 1,
50
+ * services: [],
51
+ * "default": true
52
+ * },
53
+ * VendorStatus: 1,
54
+ * VendorId: 1,
55
+ * Summary: {
56
+ * ActiveBills: 2,
57
+ * PendingBills: 4,
58
+ * InTransitBills: 3,
59
+ * PaidBills: 18,
60
+ * OverdueBills: 1,
61
+ * ApprovedBills: 5,
62
+ * DisapprovedBills: 1,
63
+ * TotalBills: 34,
64
+ * ActiveBillsAmount: 1250.75,
65
+ * PendingBillsAmount: 2890.5,
66
+ * InTransitBillsAmount: 1675.25,
67
+ * PaidBillsAmount: 15420.8,
68
+ * OverdueBillsAmount: 425,
69
+ * ApprovedBillsAmount: 3240.9,
70
+ * DisapprovedBillsAmount: 180,
71
+ * TotalBillsAmount: 25083.2
72
+ * },
73
+ * PaypointLegalname: "Sunshine Services, LLC",
74
+ * PaypointDbaname: "Sunshine Gutters",
75
+ * PaypointEntryname: "d193cf9a46",
76
+ * ParentOrgName: "PropertyManager Pro",
77
+ * ParentOrgId: 1000,
78
+ * CreatedDate: "2022-07-01T15:00:01Z",
79
+ * LastUpdated: "2022-07-01T15:00:01Z",
80
+ * remitAddress1: "123 Walnut Street",
81
+ * remitAddress2: "Suite 900",
82
+ * remitCity: "Miami",
83
+ * remitState: "FL",
84
+ * remitZip: "31113",
85
+ * remitCountry: "US",
86
+ * payeeName1: "payeeName1",
87
+ * payeeName2: "payeeName2",
88
+ * customField1: "",
89
+ * customField2: "",
90
+ * customerVendorAccount: "123-456",
91
+ * InternalReferenceId: 1000000,
92
+ * externalPaypointID: "Paypoint-100",
93
+ * StoredMethods: []
94
+ * },
95
+ * BillData: [{
96
+ * billId: 3001,
97
+ * invoiceNumber: "INV-5001",
98
+ * netAmount: "500",
99
+ * invoiceDate: "2025-08-01",
100
+ * dueDate: "2025-08-15"
101
+ * }],
102
+ * ExternalPaypointID: "d193cf9a46-10",
103
+ * Method: "ach",
104
+ * PaypointId: 255,
105
+ * TotalAmount: 500,
106
+ * NetAmount: 500,
107
+ * FeeAmount: 0,
108
+ * PaymentData: {
109
+ * AccountType: "checking",
110
+ * HolderName: "Herman Coatings",
111
+ * Initiator: "merchant",
112
+ * MaskedAccount: "XXXXXX5666",
113
+ * paymentDetails: {
114
+ * currency: "USD",
115
+ * serviceFee: 0,
116
+ * totalAmount: 500
117
+ * },
118
+ * Sequence: "subsequent",
119
+ * StoredMethodUsageType: "recurring"
120
+ * },
121
+ * StartDate: "2025-09-01T00:00:00Z",
122
+ * EndDate: "2026-09-01T00:00:00Z",
123
+ * NextDate: "2025-10-01T00:00:00Z",
124
+ * Frequency: "monthly",
125
+ * TotalCycles: 12,
126
+ * LeftCycles: 11,
127
+ * LastRun: "2025-09-01T06:00:00Z",
128
+ * EntrypageId: 0,
129
+ * UntilCancelled: false,
130
+ * LastUpdated: "2025-08-01T12:00:00Z",
131
+ * CreatedAt: "2025-08-01T12:00:00Z",
132
+ * PaypointLegalname: "Sunshine Services, LLC",
133
+ * PaypointDbaname: "Sunshine Gutters",
134
+ * PaypointEntryname: "d193cf9a46",
135
+ * ParentOrgName: "PropertyManager Pro",
136
+ * ParentOrgId: 236,
137
+ * Source: "api"
138
+ * }
139
+ */
140
+ export interface PayoutSubscriptionQueryRecordPascal {
141
+ /** The payout subscription's ID. */
142
+ IdOutSubscription?: number | undefined;
143
+ /**
144
+ * The payout subscription's status.
145
+ * - 0: Paused
146
+ * - 1: Active
147
+ */
148
+ Status?: number | undefined;
149
+ /** Events associated with the payout subscription. */
150
+ Events?: Payabli.GeneralEvents[] | undefined;
151
+ Vendor?: Payabli.VendorQueryRecord | undefined;
152
+ /** Bills associated with the payout subscription. */
153
+ BillData?: Payabli.BillPayOutData[] | undefined;
154
+ ExternalPaypointID?: Payabli.ExternalPaypointId | undefined;
155
+ /** The payout subscription's payment method. */
156
+ Method?: string | undefined;
157
+ PaypointId?: Payabli.PaypointId | undefined;
158
+ /** The payout subscription amount, including any fees. */
159
+ TotalAmount?: number | undefined;
160
+ /** The payout subscription amount, minus any fees. */
161
+ NetAmount?: Payabli.Netamountnullable | undefined;
162
+ /** Fee applied to the payout subscription. */
163
+ FeeAmount?: number | undefined;
164
+ PaymentData?: Payabli.QueryPaymentData | undefined;
165
+ /** The payout subscription start date. */
166
+ StartDate: string | null;
167
+ /** The payout subscription's end date. */
168
+ EndDate: string | null;
169
+ /** The next date the payout subscription will be processed. */
170
+ NextDate: string | null;
171
+ /** The payout subscription's frequency. */
172
+ Frequency?: string | undefined;
173
+ /** The total number of cycles the payout subscription is set to run. */
174
+ TotalCycles?: number | undefined;
175
+ /** The number of cycles the payout subscription has left. */
176
+ LeftCycles?: number | undefined;
177
+ /** The last time the payout subscription was processed. */
178
+ LastRun: string | null;
179
+ EntrypageId?: Payabli.EntrypageId | undefined;
180
+ /** When `true`, the payout subscription has no explicit end date and runs until canceled. */
181
+ UntilCancelled?: boolean | undefined;
182
+ /** The last date and time the payout subscription was updated. */
183
+ LastUpdated?: Payabli.LastModified | undefined;
184
+ /** Timestamp of when the payout subscription was created, in UTC. */
185
+ CreatedAt?: Payabli.CreatedAt | undefined;
186
+ /** The paypoint's legal name. */
187
+ PaypointLegalname?: Payabli.Legalname | undefined;
188
+ /** The paypoint's DBA name. */
189
+ PaypointDbaname?: Payabli.Dbaname | undefined;
190
+ /** The paypoint's entryname. */
191
+ PaypointEntryname?: Payabli.Entrypointfield | undefined;
192
+ ParentOrgName?: Payabli.OrgParentName | undefined;
193
+ ParentOrgId?: Payabli.OrgParentId | undefined;
194
+ Source?: Payabli.Source | undefined;
195
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });