@tesouro/embedded-components-react 0.5.235 → 0.5.243

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 (396) hide show
  1. package/README.md +3 -0
  2. package/dist/fixtures/index.d.ts +3544 -505
  3. package/dist/fixtures/index.js +12 -2
  4. package/dist/index.d.ts +112 -2
  5. package/dist/index.js +27 -27
  6. package/dist/lib/AcceptDisclosuresWidget.js +1 -1
  7. package/dist/lib/BalancesWidget.js +1 -1
  8. package/dist/lib/BankAccountOnboardingWidget.js +2 -2
  9. package/dist/lib/BankAccountsWidget.js +1 -1
  10. package/dist/lib/BillPayWidget.js +1 -1
  11. package/dist/lib/CardDetailsWidget.js +1 -1
  12. package/dist/lib/CounterpartsWidgetPublic.js +1 -1
  13. package/dist/lib/CreditCardsWidget.js +1 -1
  14. package/dist/lib/CustomersWidget.js +1 -1
  15. package/dist/lib/DebitCardsWidget.js +1 -1
  16. package/dist/lib/ExpenseManagementWidget.js +1 -1
  17. package/dist/lib/InsightsWidget.js +2 -2
  18. package/dist/lib/InvoicingWidget.js +1 -1
  19. package/dist/lib/LinkedAccountsWidget.js +1 -1
  20. package/dist/lib/MarketingWidget.js +2 -2
  21. package/dist/lib/ProductsWidget.js +1 -1
  22. package/dist/lib/ReceivablesWidget.d.ts +112 -2
  23. package/dist/lib/ReceivablesWidget.js +1 -1
  24. package/dist/lib/SettingsWidget.js +2 -2
  25. package/dist/lib/TransfersWidget.js +2 -2
  26. package/dist/lib/UploadReceiptWidget.js +1 -1
  27. package/dist/lib/WidgetSuite.js +3 -3
  28. package/dist/libs/tesouro-embedded-components-react/accept-disclosures-widget/feature/dist/index.js +1 -1
  29. package/dist/libs/tesouro-embedded-components-react/accept-disclosures-widget/feature/dist/{index5.js → lib/AcceptDisclosuresWidget/AcceptDisclosuresWidget.js} +18 -18
  30. package/dist/libs/tesouro-embedded-components-react/accept-disclosures-widget/feature/dist/{index3.js → lib/AcceptDisclosuresWidget/resolveAcceptDisclosuresContent.js} +3 -3
  31. package/dist/libs/tesouro-embedded-components-react/accept-disclosures-widget/feature/dist/{index4.js → lib/AcceptDisclosuresWidget/testIds.js} +1 -1
  32. package/dist/libs/tesouro-embedded-components-react/accept-disclosures-widget/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  33. package/dist/libs/tesouro-embedded-components-react/accept-disclosures-widget/feature/dist/mocks/acceptDisclosures.js +62 -0
  34. package/dist/libs/tesouro-embedded-components-react/accept-disclosures-widget/feature/dist/mocks/labels.js +21 -0
  35. package/dist/libs/tesouro-embedded-components-react/accept-disclosures-widget/feature/dist/scenarios.js +2 -0
  36. package/dist/libs/tesouro-embedded-components-react/balances-widget/feature/dist/index.js +1 -1
  37. package/dist/libs/tesouro-embedded-components-react/balances-widget/feature/dist/{index3.js → lib/BalancesWidget/BalancesWidgetContext.js} +12 -12
  38. package/dist/libs/tesouro-embedded-components-react/balances-widget/feature/dist/{index6.js → lib/BalancesWidget/BalancesWidgetFeature.js} +10 -10
  39. package/dist/libs/tesouro-embedded-components-react/balances-widget/feature/dist/{index5.js → lib/BalancesWidget/SingleBalance/SingleBalance.js} +4 -4
  40. package/dist/libs/tesouro-embedded-components-react/balances-widget/feature/dist/{index4.js → lib/BalancesWidget/testIds.js} +1 -1
  41. package/dist/libs/tesouro-embedded-components-react/balances-widget/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  42. package/dist/libs/tesouro-embedded-components-react/balances-widget/feature/dist/mocks/balances.js +69 -0
  43. package/dist/libs/tesouro-embedded-components-react/balances-widget/feature/dist/mocks/labels.js +28 -0
  44. package/dist/libs/tesouro-embedded-components-react/balances-widget/feature/dist/scenarios.js +2 -0
  45. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/index.js +3 -3
  46. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index18.js → lib/BankAccountOnboardingWidget/AdditionalOwnersStep.js} +8 -8
  47. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index26.js → lib/BankAccountOnboardingWidget/BankAccountOnboardingWidget.js} +50 -50
  48. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index13.js → lib/BankAccountOnboardingWidget/BusinessDetailsStep.js} +7 -7
  49. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index15.js → lib/BankAccountOnboardingWidget/PersonalDetailsStep.js} +7 -7
  50. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index16.js → lib/BankAccountOnboardingWidget/additionalOwnerDraft.js} +8 -8
  51. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index19.js → lib/BankAccountOnboardingWidget/apiMapping.js} +2 -2
  52. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index23.js → lib/BankAccountOnboardingWidget/applicationStatusView.js} +9 -9
  53. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index20.js → lib/BankAccountOnboardingWidget/buildOnboardingPrefill.js} +5 -5
  54. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index11.js → lib/BankAccountOnboardingWidget/businessDetailsPanelMapping.js} +10 -10
  55. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index21.js → lib/BankAccountOnboardingWidget/draftApplicationMapping.js} +9 -9
  56. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index2.js → lib/BankAccountOnboardingWidget/fieldInput/formatPhoneNumberInput.js} +1 -1
  57. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index8.js → lib/BankAccountOnboardingWidget/fieldInput/isValidWebsiteUrl.js} +1 -1
  58. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index6.js → lib/BankAccountOnboardingWidget/fieldInput/maskIdentifierLast4.js} +1 -1
  59. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index4.js → lib/BankAccountOnboardingWidget/fieldInput/maskedSsnInput.js} +1 -1
  60. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index9.js → lib/BankAccountOnboardingWidget/fieldInput/maxBirthDate.js} +1 -1
  61. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index5.js → lib/BankAccountOnboardingWidget/fieldInput/sanitizeTaxIdInput.js} +1 -1
  62. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index3.js → lib/BankAccountOnboardingWidget/fieldInput/sanitizeZipCodeInput.js} +1 -1
  63. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index7.js → lib/BankAccountOnboardingWidget/fieldInput/storedIdentifier.js} +2 -2
  64. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index25.js → lib/BankAccountOnboardingWidget/hostInitialValues.js} +1 -1
  65. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index22.js → lib/BankAccountOnboardingWidget/labels.js} +3 -3
  66. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index14.js → lib/BankAccountOnboardingWidget/personalDetailsPanelMapping.js} +9 -9
  67. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index10.js → lib/BankAccountOnboardingWidget/stepSchemas.js} +4 -4
  68. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index12.js → lib/BankAccountOnboardingWidget/testIds.js} +1 -1
  69. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index17.js → lib/BankAccountOnboardingWidget/valuesKey.js} +1 -1
  70. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/{index24.js → lib/analytics/events.js} +1 -1
  71. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/mocks/bankAccountOnboarding.js +71 -0
  72. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/mocks/fixtures.js +36 -0
  73. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/mocks/labels.js +21 -0
  74. package/dist/libs/tesouro-embedded-components-react/bank-account-onboarding-widget/feature/dist/scenarios.js +3 -0
  75. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/index.js +2 -2
  76. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/{index8.js → lib/BankAccountsWidget/BankAccountsWidget.js} +11 -11
  77. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/{index2.js → lib/BankAccountsWidget/analytics/events.js} +1 -1
  78. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/lib/BankAccountsWidget/index.js +1 -0
  79. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/{index3.js → lib/formatters.js} +1 -1
  80. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/{index4.js → lib/labels.js} +1 -1
  81. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/{index5.js → lib/permissions.js} +4 -4
  82. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/{index6.js → lib/teamMembers.js} +1 -1
  83. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/{index7.js → lib/useBankAccountsWidget.js} +25 -25
  84. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/mocks/bankAccounts.js +165 -0
  85. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/mocks/fixtures.js +9 -0
  86. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/mocks/labels.js +16 -0
  87. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/scenarios.js +3 -0
  88. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/bill-detail/feature/dist/index35.js +1 -1
  89. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/bill-upload/data-access/dist/index2.js +1 -1
  90. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/index.js +1 -1
  91. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/lib/BillPayWidget.js +27 -0
  92. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/{index3.js → lib/BillPayWidgetMonite/BillPayWidgetMonite.js} +8 -8
  93. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/lib/BillPayWidgetMonite/index.js +1 -0
  94. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/{index8.js → lib/BillPayWidgetNative/BillPayWidgetNative.js} +19 -19
  95. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/{index6.js → lib/BillPayWidgetNative/BillsTab.js} +14 -14
  96. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/lib/BillPayWidgetNative/index.js +1 -0
  97. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/{index7.js → lib/BillPayWidgetNative/labels.js} +1 -1
  98. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/{index5.js → lib/BillPayWidgetNative/testIds.js} +1 -1
  99. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/{index2.js → lib/analytics/events.js} +2 -2
  100. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/mocks/billPay.js +339 -0
  101. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/mocks/fixtures.js +41 -0
  102. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/mocks/labels.js +37 -0
  103. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/scenarios.js +3 -0
  104. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/index.js +3 -3
  105. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index13.js → lib/CardDetailsWidget.js} +27 -27
  106. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index7.js → lib/activation.js} +6 -6
  107. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  108. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index10.js → lib/cardControls.js} +6 -6
  109. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index4.js → lib/cardDetailsView.js} +5 -5
  110. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index3.js → lib/formatters.js} +2 -2
  111. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index5.js → lib/labels.js} +4 -4
  112. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index6.js → lib/testIds.js} +1 -1
  113. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index9.js → lib/useActivateCard.js} +16 -16
  114. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index11.js → lib/useCardLock.js} +9 -9
  115. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index12.js → lib/useEditCardNickname.js} +9 -9
  116. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/{index8.js → lib/useIdScopedRequest.js} +1 -1
  117. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/mocks/cardDetails.js +54 -0
  118. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/mocks/labels.js +20 -0
  119. package/dist/libs/tesouro-embedded-components-react/card-details-widget/feature/dist/scenarios.js +2 -0
  120. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/index.js +4 -4
  121. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/{index10.js → lib/CardsWidget.js} +14 -14
  122. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/{index11.js → lib/CreditCardsWidget.js} +4 -4
  123. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/{index12.js → lib/DebitCardsWidget.js} +4 -4
  124. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/{index2.js → lib/analytics/events.js} +2 -2
  125. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/{index6.js → lib/formatters.js} +3 -3
  126. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/{index5.js → lib/labels.js} +3 -3
  127. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/{index7.js → lib/permissions.js} +6 -6
  128. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/{index8.js → lib/rows.js} +7 -7
  129. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/{index4.js → lib/testIds.js} +1 -1
  130. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/{index9.js → lib/useCardsWidget.js} +17 -17
  131. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/mocks/creditCards.js +89 -0
  132. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/mocks/debitCards.js +182 -0
  133. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/mocks/labels.js +24 -0
  134. package/dist/libs/tesouro-embedded-components-react/cards-widget/feature/dist/scenarios.js +3 -0
  135. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/index.js +1 -1
  136. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/{index8.js → lib/CounterpartsWidget/CounterpartsWidget.js} +16 -16
  137. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/{index3.js → lib/CounterpartsWidget/constants.js} +1 -1
  138. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/{index5.js → lib/CounterpartsWidget/permissions.js} +1 -1
  139. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/{index4.js → lib/CounterpartsWidget/useCounterpartsTable.js} +10 -10
  140. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/{index7.js → lib/CounterpartsWidget/useCounterpartsWidget.js} +21 -21
  141. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/{index6.js → lib/CounterpartsWidget/viewModels.js} +8 -8
  142. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  143. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/mocks/counterparts.js +394 -0
  144. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/mocks/labels.js +23 -0
  145. package/dist/libs/tesouro-embedded-components-react/counterparts-widget/feature/dist/scenarios.js +2 -0
  146. package/dist/libs/tesouro-embedded-components-react/customers-widget/feature/dist/index.js +1 -1
  147. package/dist/libs/tesouro-embedded-components-react/customers-widget/feature/dist/{index5.js → lib/CustomersWidget/CustomersWidget.js} +6 -6
  148. package/dist/libs/tesouro-embedded-components-react/customers-widget/feature/dist/{index3.js → lib/CustomersWidgetMonite/CustomersWidgetMonite.js} +8 -8
  149. package/dist/libs/tesouro-embedded-components-react/customers-widget/feature/dist/{index4.js → lib/CustomersWidgetNative/CustomersWidgetNative.js} +7 -7
  150. package/dist/libs/tesouro-embedded-components-react/customers-widget/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  151. package/dist/libs/tesouro-embedded-components-react/customers-widget/feature/dist/scenarios.js +3 -0
  152. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/index.js +6 -6
  153. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index19.js → lib/ExpenseManagementWidget/ExpenseManagementWidget.js} +33 -33
  154. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index16.js → lib/ExpenseManagementWidget/actionItemLabels.js} +1 -1
  155. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index3.js → lib/ExpenseManagementWidget/analytics/events.js} +2 -2
  156. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index13.js → lib/ExpenseManagementWidget/datePresets.js} +1 -1
  157. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index4.js → lib/ExpenseManagementWidget/entityUserLabel.js} +1 -1
  158. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/lib/ExpenseManagementWidget/index.js +1 -0
  159. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index12.js → lib/ExpenseManagementWidget/mapTransactionRow.js} +4 -4
  160. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index5.js → lib/ExpenseManagementWidget/permissions.js} +4 -4
  161. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index17.js → lib/ExpenseManagementWidget/useExpenseActionItems.js} +9 -9
  162. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index18.js → lib/ExpenseManagementWidget/useExpenseTabBadgeCounts.js} +7 -7
  163. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index15.js → lib/ExpenseManagementWidget/useExpensesTransactions.js} +10 -10
  164. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index14.js → lib/ExpenseManagementWidget/useExpensesTransactionsFilter.js} +2 -2
  165. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index10.js → lib/TransactionDetails/TransactionDetailsActionsFeature.js} +7 -7
  166. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index11.js → lib/TransactionDetails/TransactionDetailsFeature.js} +37 -37
  167. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index7.js → lib/TransactionDetails/auditHistory/buildExpenseAuditHistory.js} +1 -1
  168. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index8.js → lib/TransactionDetails/auditHistory/labels.js} +1 -1
  169. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index9.js → lib/TransactionDetails/footerActions.js} +1 -1
  170. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index6.js → lib/TransactionDetails/labels.js} +1 -1
  171. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/{index2.js → lib/expenseStatus.js} +1 -1
  172. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/mocks/expenseManagement.js +460 -0
  173. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/mocks/fixtures.js +60 -0
  174. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/mocks/labels.js +21 -0
  175. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/scenarios.js +3 -0
  176. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/index.js +3 -3
  177. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/{index8.js → lib/InsightsWidget/InsightsWidgetContext.js} +12 -12
  178. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/{index12.js → lib/InsightsWidget/InsightsWidgetFeature.js} +11 -11
  179. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/{index11.js → lib/InsightsWidget/SingleInsight/SingleInsight.js} +5 -5
  180. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/{index4.js → lib/InsightsWidget/dismissedInsightsUserDataKey.js} +1 -1
  181. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/{index3.js → lib/InsightsWidget/labels.js} +1 -1
  182. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/{index9.js → lib/InsightsWidget/mapInsightToRowView.js} +1 -1
  183. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/{index7.js → lib/InsightsWidget/permissions.js} +4 -4
  184. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/lib/InsightsWidget/shouldShowRoutingOnboardingInsight.js +10 -0
  185. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/{index10.js → lib/InsightsWidget/testIds.js} +1 -1
  186. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/{index5.js → lib/InsightsWidget/useDismissedInsightIds.js} +6 -6
  187. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  188. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/mocks/insights.js +90 -0
  189. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/mocks/labels.js +22 -0
  190. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/scenarios.js +2 -0
  191. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/index.js +2 -2
  192. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index5.js → lib/ReceivablesWidget/ReceivableAttachmentsSection.js} +3 -3
  193. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index36.js → lib/ReceivablesWidget/ReceivablesWidget.js} +94 -82
  194. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index8.js → lib/ReceivablesWidget/actionsModal.js} +5 -5
  195. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index2.js → lib/ReceivablesWidget/analytics/events.js} +1 -1
  196. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index24.js → lib/ReceivablesWidget/apiValidationErrors.js} +1 -1
  197. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index7.js → lib/ReceivablesWidget/attachments.js} +2 -2
  198. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index19.js → lib/ReceivablesWidget/auditHistory/labels.js} +5 -5
  199. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index20.js → lib/ReceivablesWidget/bankAccounts.js} +4 -4
  200. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index4.js → lib/ReceivablesWidget/constants.js} +1 -1
  201. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/lib/ReceivablesWidget/datePresets.js +102 -0
  202. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index22.js → lib/ReceivablesWidget/details.js} +7 -7
  203. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index11.js → lib/ReceivablesWidget/discount.js} +3 -3
  204. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index13.js → lib/ReceivablesWidget/helpers.js} +58 -41
  205. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/lib/ReceivablesWidget/invoicesFilter.js +163 -0
  206. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/lib/ReceivablesWidget/invoicesFilterLabels.js +58 -0
  207. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index14.js → lib/ReceivablesWidget/labels.js} +5 -5
  208. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index6.js → lib/ReceivablesWidget/lineItems.js} +2 -2
  209. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index10.js → lib/ReceivablesWidget/paymentTerms.js} +3 -3
  210. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index21.js → lib/ReceivablesWidget/preview.js} +7 -7
  211. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index9.js → lib/ReceivablesWidget/recurrence.js} +4 -4
  212. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index15.js → lib/ReceivablesWidget/reminders.js} +8 -8
  213. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index32.js → lib/ReceivablesWidget/statusCards.js} +2 -2
  214. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index12.js → lib/ReceivablesWidget/totals.js} +4 -4
  215. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/lib/ReceivablesWidget/useInvoicesFilter.js +111 -0
  216. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/lib/ReceivablesWidget/useReceivableActions.js +296 -0
  217. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index18.js → lib/ReceivablesWidget/useReceivableActionsModal.js} +13 -13
  218. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index25.js → lib/ReceivablesWidget/useReceivableAttachmentUploads.js} +4 -4
  219. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index28.js → lib/ReceivablesWidget/useReceivableBankAccount.js} +9 -9
  220. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/lib/ReceivablesWidget/useReceivableCustomerNames.js +27 -0
  221. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index23.js → lib/ReceivablesWidget/useReceivableDetails.js} +19 -19
  222. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index31.js → lib/ReceivablesWidget/useReceivableForm.js} +243 -241
  223. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/lib/ReceivablesWidget/useReceivableIssuePreflight.js +28 -0
  224. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index26.js → lib/ReceivablesWidget/useReceivablePaymentTerms.js} +4 -4
  225. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/lib/ReceivablesWidget/useReceivablePreview.js +37 -0
  226. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index27.js → lib/ReceivablesWidget/useReceivableRecurrence.js} +5 -5
  227. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index29.js → lib/ReceivablesWidget/useReceivableReminders.js} +10 -10
  228. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index33.js → lib/ReceivablesWidget/useReceivableStatusCards.js} +4 -4
  229. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/lib/ReceivablesWidget/useReceivablesTable.js +97 -0
  230. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/lib/ReceivablesWidget/useReceivablesWidget.js +146 -0
  231. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/{index3.js → lib/ReceivablesWidgetMonite/ReceivablesWidgetMonite.js} +8 -8
  232. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/mocks/fixtures.js +94 -0
  233. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/mocks/invoicing.js +242 -0
  234. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/mocks/labels.js +37 -0
  235. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/mocks/receivables.js +409 -0
  236. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/scenarios.js +4 -0
  237. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index.js +28 -24
  238. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index10.js +2 -37
  239. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index11.js +9 -214
  240. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index12.js +27 -159
  241. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index13.js +234 -14
  242. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index14.js +48 -22
  243. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index15.js +214 -2
  244. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index16.js +153 -87
  245. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index17.js +16 -3
  246. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index18.js +22 -21
  247. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index19.js +2 -51
  248. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index2.js +30 -15
  249. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index20.js +90 -14
  250. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index21.js +3 -10
  251. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index22.js +20 -69
  252. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index23.js +51 -33
  253. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index24.js +16 -17
  254. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index25.js +8 -14
  255. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index26.js +70 -30
  256. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index27.js +33 -14
  257. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index28.js +17 -25
  258. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index29.js +12 -83
  259. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index3.js +9 -121
  260. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index30.js +28 -401
  261. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index31.js +16 -2
  262. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index32.js +22 -42
  263. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index33.js +80 -65
  264. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index34.js +383 -473
  265. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index35.js +2 -106
  266. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index36.js +48 -0
  267. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index37.js +72 -2
  268. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index38.js +498 -4
  269. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index39.js +106 -1
  270. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index4.js +141 -93
  271. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index41.js +2 -28
  272. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index42.js +4 -236
  273. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index43.js +0 -2
  274. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index44.js +90 -239
  275. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index45.js +24 -89
  276. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index46.js +231 -54
  277. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index47.js +3 -353
  278. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index48.js +249 -0
  279. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index49.js +93 -0
  280. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index5.js +3 -40
  281. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index50.js +59 -0
  282. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index51.js +355 -0
  283. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index6.js +18 -2
  284. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index7.js +121 -9
  285. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index8.js +100 -27
  286. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index9.js +38 -233
  287. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/index.js +2 -2
  288. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/{index10.js → lib/LinkedAccountsWidget.js} +9 -9
  289. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  290. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/{index3.js → lib/forms.js} +1 -1
  291. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/{index4.js → lib/labels.js} +1 -1
  292. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/{index5.js → lib/permissions.js} +4 -4
  293. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/{index6.js → lib/rows.js} +1 -1
  294. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/{index8.js → lib/teamMembers.js} +1 -1
  295. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/{index7.js → lib/useAdminEligibleUserIds.js} +4 -4
  296. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/{index9.js → lib/useLinkedAccountsWidget.js} +34 -34
  297. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/mocks/labels.js +16 -0
  298. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/mocks/linkedAccounts.js +144 -0
  299. package/dist/libs/tesouro-embedded-components-react/linked-accounts-widget/feature/dist/scenarios.js +2 -0
  300. package/dist/libs/tesouro-embedded-components-react/marketing-widget/feature/dist/index.js +2 -2
  301. package/dist/libs/tesouro-embedded-components-react/marketing-widget/feature/dist/{index6.js → lib/MarketingWidget/MarketingWidget.js} +16 -16
  302. package/dist/libs/tesouro-embedded-components-react/marketing-widget/feature/dist/{index4.js → lib/MarketingWidget/labels.js} +1 -1
  303. package/dist/libs/tesouro-embedded-components-react/marketing-widget/feature/dist/{index5.js → lib/MarketingWidget/marketingApplicationView.js} +3 -3
  304. package/dist/libs/tesouro-embedded-components-react/marketing-widget/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  305. package/dist/libs/tesouro-embedded-components-react/marketing-widget/feature/dist/{index3.js → lib/testIds.js} +1 -1
  306. package/dist/libs/tesouro-embedded-components-react/marketing-widget/feature/dist/mocks/labels.js +29 -0
  307. package/dist/libs/tesouro-embedded-components-react/marketing-widget/feature/dist/mocks/marketing.js +34 -0
  308. package/dist/libs/tesouro-embedded-components-react/marketing-widget/feature/dist/scenarios.js +2 -0
  309. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/index.js +1 -1
  310. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/{index10.js → lib/ProductsWidget/ProductsWidget.js} +15 -15
  311. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/{index3.js → lib/ProductsWidget/constants.js} +1 -1
  312. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/{index5.js → lib/ProductsWidget/permissions.js} +3 -3
  313. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/{index4.js → lib/ProductsWidget/testIds.js} +1 -1
  314. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/{index6.js → lib/ProductsWidget/useProductDelete.js} +3 -3
  315. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/{index7.js → lib/ProductsWidget/useProductDetails.js} +4 -4
  316. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/{index8.js → lib/ProductsWidget/useProductsTable.js} +4 -4
  317. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/{index9.js → lib/ProductsWidget/useProductsWidget.js} +12 -12
  318. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  319. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/mocks/labels.js +23 -0
  320. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/mocks/products.js +189 -0
  321. package/dist/libs/tesouro-embedded-components-react/products-widget/feature/dist/scenarios.js +2 -0
  322. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/index.js +4 -4
  323. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/{index5.js → lib/ExpenseSettingsTabs/ExpenseSettingsTabs.js} +6 -6
  324. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/{index6.js → lib/SettingsWidget/SettingsWidget.js} +29 -29
  325. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/{index2.js → lib/SettingsWidget/analytics/events.js} +2 -2
  326. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/lib/SettingsWidget/index.js +6 -0
  327. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/{index3.js → lib/SettingsWidget/labels.js} +1 -1
  328. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/{index4.js → lib/SettingsWidget/sections.js} +1 -1
  329. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/mocks/labels.js +29 -0
  330. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/mocks/settings.js +190 -0
  331. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/scenarios.js +2 -0
  332. package/dist/libs/tesouro-embedded-components-react/shared/data-access/dist/lib/rest/sdk.gen.js +5 -1
  333. package/dist/libs/tesouro-embedded-components-react/shared/data-access/dist/lib/rest/zod.gen.js +2125 -2537
  334. package/dist/libs/tesouro-embedded-components-react/shared/data-access-mocks/dist/lib/fixtures.js +232 -40
  335. package/dist/libs/tesouro-embedded-components-react/shared/data-access-mocks/dist/mocks/scenarios/labels.js +36 -0
  336. package/dist/libs/tesouro-embedded-components-react/shared/data-access-mocks/dist/mocks/scenarios/scenario.js +180 -0
  337. package/dist/libs/tesouro-embedded-components-react/shared/data-access-mocks/dist/mocks/scenarios/team.js +79 -0
  338. package/dist/libs/tesouro-embedded-components-react/shared/data-access-mocks/dist/mocks/scenarios/worlds.js +45 -0
  339. package/dist/libs/tesouro-embedded-components-react/shared/feature/dist/lib/analytics/build-info.js +1 -1
  340. package/dist/libs/tesouro-embedded-components-react/transfers-widget/feature/dist/index.js +2 -2
  341. package/dist/libs/tesouro-embedded-components-react/transfers-widget/feature/dist/{index7.js → lib/TransfersWidget/TransfersWidgetFeature.js} +8 -8
  342. package/dist/libs/tesouro-embedded-components-react/transfers-widget/feature/dist/{index6.js → lib/TransfersWidget/TransfersWidgetInner.js} +21 -21
  343. package/dist/libs/tesouro-embedded-components-react/transfers-widget/feature/dist/{index3.js → lib/TransfersWidget/featureLabels.js} +1 -1
  344. package/dist/libs/tesouro-embedded-components-react/transfers-widget/feature/dist/{index5.js → lib/TransfersWidget/testIds.js} +1 -1
  345. package/dist/libs/tesouro-embedded-components-react/transfers-widget/feature/dist/{index4.js → lib/TransfersWidget/useTransferMoneyModalController.js} +11 -11
  346. package/dist/libs/tesouro-embedded-components-react/transfers-widget/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  347. package/dist/libs/tesouro-embedded-components-react/transfers-widget/feature/dist/mocks/labels.js +22 -0
  348. package/dist/libs/tesouro-embedded-components-react/transfers-widget/feature/dist/mocks/transfers.js +182 -0
  349. package/dist/libs/tesouro-embedded-components-react/transfers-widget/feature/dist/scenarios.js +2 -0
  350. package/dist/libs/tesouro-embedded-components-react/upload-receipt-widget/feature/dist/index.js +1 -1
  351. package/dist/libs/tesouro-embedded-components-react/upload-receipt-widget/feature/dist/{index2.js → lib/UploadReceiptWidget.js} +8 -8
  352. package/dist/libs/tesouro-embedded-components-react/upload-receipt-widget/feature/dist/mocks/labels.js +29 -0
  353. package/dist/libs/tesouro-embedded-components-react/upload-receipt-widget/feature/dist/mocks/uploadReceipt.js +57 -0
  354. package/dist/libs/tesouro-embedded-components-react/upload-receipt-widget/feature/dist/scenarios.js +2 -0
  355. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/index.js +4 -4
  356. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/{index16.js → lib/WidgetSuite/WidgetSuite.js} +28 -28
  357. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/{index6.js → lib/WidgetSuite/WidgetSuiteProvider.js} +2 -2
  358. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/{index3.js → lib/WidgetSuite/disclosureGate.js} +1 -1
  359. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/{index4.js → lib/WidgetSuite/labels.js} +4 -4
  360. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/lib/WidgetSuite/sections/AccountsSection.js +24 -0
  361. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/lib/WidgetSuite/sections/BillPaySection.js +23 -0
  362. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/{index9.js → lib/WidgetSuite/sections/CardsSection.js} +10 -10
  363. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/lib/WidgetSuite/sections/DashboardSection.js +33 -0
  364. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/lib/WidgetSuite/sections/ExpensesSection.js +25 -0
  365. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/lib/WidgetSuite/sections/InvoicingSection.js +20 -0
  366. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/{index13.js → lib/WidgetSuite/sections/SettingsSection.js} +4 -4
  367. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/lib/WidgetSuite/sections/TransfersSection.js +27 -0
  368. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/lib/WidgetSuite/sections/index.js +22 -0
  369. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/{index5.js → lib/WidgetSuite/sections/sectionIds.js} +1 -1
  370. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/{index2.js → lib/analytics/events.js} +1 -1
  371. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/mocks/labels.js +25 -0
  372. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/mocks/widgetSuite.js +70 -0
  373. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/scenarios.js +2 -0
  374. package/dist/scenarios/index.d.ts +583 -0
  375. package/dist/scenarios/index.js +42 -0
  376. package/package.json +6 -1
  377. package/dist/libs/tesouro-embedded-components-react/bank-accounts-widget/feature/dist/index9.js +0 -1
  378. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/index10.js +0 -27
  379. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/index4.js +0 -1
  380. package/dist/libs/tesouro-embedded-components-react/bill-pay-widget/feature/dist/index9.js +0 -1
  381. package/dist/libs/tesouro-embedded-components-react/expense-management-widget/feature/dist/index20.js +0 -1
  382. package/dist/libs/tesouro-embedded-components-react/insights-widget/feature/dist/index6.js +0 -10
  383. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/index16.js +0 -28
  384. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/index17.js +0 -290
  385. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/index30.js +0 -37
  386. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/index34.js +0 -82
  387. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/feature/dist/index35.js +0 -144
  388. package/dist/libs/tesouro-embedded-components-react/invoicing-widget/ui/dist/index40.js +0 -100
  389. package/dist/libs/tesouro-embedded-components-react/settings-widget/feature/dist/index7.js +0 -6
  390. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/index10.js +0 -33
  391. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/index11.js +0 -25
  392. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/index12.js +0 -20
  393. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/index14.js +0 -27
  394. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/index15.js +0 -22
  395. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/index7.js +0 -24
  396. package/dist/libs/tesouro-embedded-components-react/widget-suite/feature/dist/index8.js +0 -23
@@ -1,3 +1,11 @@
1
+ type AddressDto = {
2
+ address1?: null | string;
3
+ address2?: null | string;
4
+ city?: null | string;
5
+ country?: null | string;
6
+ postalCode?: null | string;
7
+ stateOrProvince?: null | string;
8
+ };
1
9
  /**
2
10
  * Output model for address information in responses.
3
11
  */
@@ -43,6 +51,149 @@ type AmountOutput = {
43
51
  */
44
52
  value: number | string;
45
53
  };
54
+ type ApplicationOwnership = 'STARTED_BY_YOU' | 'STARTED_BY_OTHER';
55
+ type ApplicationProduct = 'BANK_ACCOUNT' | 'CREDIT_CARD';
56
+ type ApplicationStatusEntry = {
57
+ /**
58
+ * First name of the applicant who started the application, for either ownership.
59
+ */
60
+ applicantFirstName?: null | string;
61
+ /**
62
+ * Last name of the applicant who started the application, for either ownership.
63
+ */
64
+ applicantLastName?: null | string;
65
+ applicationId?: null | string;
66
+ /**
67
+ * The secret the applicant's own draft already carries, so the widget can authenticate against an
68
+ * application it did not create. Returned only alongside an applicationId, and only while draft.
69
+ * The same value comes back every time, so the secret issued at create time keeps working.
70
+ */
71
+ clientSecret?: null | string;
72
+ /**
73
+ * When the application was started (UTC).
74
+ */
75
+ createdAt: string;
76
+ /**
77
+ * When the application was declined (UTC): DENIED for a bank account, REJECTED for a credit card.
78
+ * Null otherwise, and for applications declined before decline times were recorded.
79
+ */
80
+ deniedAt?: null | string;
81
+ documentVerification?: null | DocumentVerificationOutput;
82
+ kycVerificationStatus?: null | KycVerificationStatusDto;
83
+ ownership: ApplicationOwnership;
84
+ product: ApplicationProduct;
85
+ status: string;
86
+ /**
87
+ * When the application was submitted (UTC). Null until it is submitted, and for applications
88
+ * submitted before submit times were recorded.
89
+ */
90
+ submittedAt?: null | string;
91
+ /**
92
+ * When the application was last saved (UTC).
93
+ */
94
+ updatedAt: string;
95
+ };
96
+ type ApprovalActionEventData = {
97
+ /**
98
+ * ISO timestamp of when the action was performed.
99
+ */
100
+ acted_at?: string | null;
101
+ /**
102
+ * The approval action: 'approved' or 'rejected'.
103
+ */
104
+ action: string;
105
+ approval_policy_id?: string | null;
106
+ approval_policy_name?: string | null;
107
+ approval_policy_process_id?: string | null;
108
+ approval_request_id?: string | null;
109
+ /**
110
+ * 'policy' for policy-based actions.
111
+ */
112
+ approval_source?: string | null;
113
+ /**
114
+ * Reason for rejection, if applicable.
115
+ */
116
+ reject_reason?: string | null;
117
+ };
118
+ type ApprovalPolicyResource = {
119
+ id: string;
120
+ created_at: string;
121
+ updated_at: string;
122
+ created_by: string;
123
+ /**
124
+ * A brief description of the approval policy.
125
+ */
126
+ description?: string | null;
127
+ /**
128
+ * The date and time (in the ISO 8601 format) when the approval policy stops being active and stops triggering approval workflows.If `ends_at` is provided in the request, then `starts_at` must also be provided and `ends_at` must be later than `starts_at`. The value will be converted to UTC.
129
+ */
130
+ ends_at?: string | null;
131
+ /**
132
+ * The name of the approval policy.
133
+ */
134
+ name: string;
135
+ /**
136
+ * The type of object this approval policy applies to.
137
+ */
138
+ object_type: ObjectType;
139
+ /**
140
+ * The priority controls which approval policy takes precedence when a payable matches multiple approval policies. A higher value mean higher priority.
141
+ */
142
+ priority?: number;
143
+ /**
144
+ * A list of JSON objects that represents the approval policy script. The script contains the logic that determines whether an action should be sent to approval. This field is required, and it should contain at least one script object.
145
+ */
146
+ script: Array<boolean | number | string | Array<unknown> | {
147
+ [key: string]: unknown;
148
+ } | null>;
149
+ /**
150
+ * The date and time (in the ISO 8601 format) when the approval policy becomes active. Only payables submitted for approval during the policy's active period will trigger this policy. If omitted or `null`, the policy is effective immediately. The value will be converted to UTC.
151
+ */
152
+ starts_at?: string | null;
153
+ /**
154
+ * The current status of the approval policy.
155
+ */
156
+ status: 'active' | 'pending';
157
+ /**
158
+ * A JSON object that represents the trigger for the approval policy. The trigger specifies the event that will trigger the policy to be evaluated.
159
+ */
160
+ trigger: boolean | number | string | Array<unknown> | {
161
+ [key: string]: unknown;
162
+ } | null;
163
+ updated_by?: string | null;
164
+ };
165
+ /**
166
+ * An approval request as seen by one particular caller.
167
+ *
168
+ * Read endpoints only. The write actions keep returning `ApprovalRequestResourceWithMetadata`,
169
+ * so they neither carry a value that is stale by the time it is read nor pay for the lookup.
170
+ */
171
+ type ApprovalRequestResourceForCaller = {
172
+ id: string;
173
+ created_at: string;
174
+ updated_at: string;
175
+ approval_type: ApprovalTypeEnum;
176
+ approved_by: Array<string>;
177
+ /**
178
+ * Whether the approval policy on this request routes it to the calling user. Answered per caller, so it must not be cached against the approval request id alone. It is also the only thing that governs approving and rejecting here: a caller this reports `false` for is refused, whatever permissions they hold. Force approve is a separate action on the service that owns the object.
179
+ */
180
+ caller_is_policy_approver?: boolean;
181
+ /**
182
+ * ID of the user who created the approval request, or None if it was created by the system (e.g. by an approval policy worker).
183
+ */
184
+ created_by?: string | null;
185
+ object_id: string;
186
+ object_type: ObjectType;
187
+ reject_reason?: string | null;
188
+ rejected_by?: string | null;
189
+ required_approval_count: number;
190
+ role_ids?: Array<string> | null;
191
+ status: ApprovalRequestStatus;
192
+ submitted_by?: string | null;
193
+ user_ids: Array<string>;
194
+ };
195
+ type ApprovalRequestStatus = 'waiting' | 'approved' | 'rejected' | 'canceled';
196
+ type ApprovalTypeEnum = 'user_ids' | 'role' | 'reporting_manager';
46
197
  type AttachmentResponse = {
47
198
  /**
48
199
  * Unique ID of the file with file_type=attachment from /v1/files.
@@ -69,7 +220,170 @@ type AttachmentResponse = {
69
220
  */
70
221
  url: string;
71
222
  };
223
+ /**
224
+ * Output model for applicant information in responses.
225
+ */
226
+ type BankAccountApplicantOutput = {
227
+ /**
228
+ * Date of birth of the applicant.
229
+ */
230
+ birthDate?: null | string;
231
+ /**
232
+ * Timestamp when disclosures were accepted.
233
+ */
234
+ disclosuresAcceptedAtDateTime?: null | string;
235
+ /**
236
+ * The disclosure version that was displayed when the applicant accepted.
237
+ */
238
+ disclosuresAcceptedVersion?: null | string;
239
+ /**
240
+ * The entity-capacity version displayed when the applicant executed for the business.
241
+ */
242
+ entityDisclosuresAcceptedVersion?: null | string;
243
+ /**
244
+ * First name of the applicant.
245
+ */
246
+ firstName?: null | string;
247
+ /**
248
+ * Indicates whether disclosures have been accepted.
249
+ */
250
+ hasAcceptedDisclosures?: null | boolean;
251
+ homeAddress?: null | AddressOutput;
252
+ /**
253
+ * Indicates whether the applicant is legally authorized.
254
+ */
255
+ isLegallyAuthorized?: null | boolean;
256
+ /**
257
+ * Last name of the applicant.
258
+ */
259
+ lastName?: null | string;
260
+ /**
261
+ * Mobile phone number of the applicant.
262
+ */
263
+ mobilePhoneNumber?: null | string;
264
+ /**
265
+ * Ownership percentage as a decimal between 0 and 1 (e.g., 25% = 0.25).
266
+ */
267
+ ownershipPercentage?: null | number | string;
268
+ /**
269
+ * Last four digits of the personal identification number already on file, so an applicant
270
+ * resuming an application can recognise it instead of re-entering it. The full value is
271
+ * never returned.
272
+ */
273
+ personalIdentificationNumberLast4?: null | string;
274
+ /**
275
+ * The signer-capacity version displayed when the applicant acknowledged their authority.
276
+ */
277
+ signerDisclosuresAcceptedVersion?: null | string;
278
+ /**
279
+ * Work email address of the applicant.
280
+ */
281
+ workEmailAddress?: null | string;
282
+ };
283
+ /**
284
+ * Response model for a bank account application.
285
+ */
286
+ type BankAccountApplicationResponse = {
287
+ /**
288
+ * Unique identifier for the bank account application.
289
+ */
290
+ id: string;
291
+ applicant?: null | BankAccountApplicantOutput;
292
+ businessDetails?: null | BusinessDetailsOutput;
293
+ /**
294
+ * List of business owners associated with the application.
295
+ */
296
+ businessOwners?: null | Array<BusinessOwnerOutput>;
297
+ /**
298
+ * When the application was started (UTC).
299
+ */
300
+ createdAt: string;
301
+ /**
302
+ * When the application was denied (UTC). Null unless the status is DENIED, and for applications
303
+ * denied before decline times were recorded.
304
+ */
305
+ deniedAt?: null | string;
306
+ kycVerificationStatus?: null | KycVerificationStatusDto;
307
+ /**
308
+ * Identifier of the organization the application has been onboarded under.
309
+ * Null until the application has been verified and the organization created.
310
+ */
311
+ organizationId?: null | string;
312
+ /**
313
+ * Current status of the bank account application.
314
+ */
315
+ status?: BankAccountApplicationStatusDto;
316
+ /**
317
+ * When the application was submitted (UTC). Null until it is submitted, and for applications
318
+ * submitted before submit times were recorded.
319
+ */
320
+ submittedAt?: null | string;
321
+ /**
322
+ * When the application was last saved (UTC).
323
+ */
324
+ updatedAt: string;
325
+ /**
326
+ * Identifier of the user created for the applicant during onboarding.
327
+ * Null until the application has been verified and the user created.
328
+ */
329
+ userId?: null | string;
330
+ };
331
+ /**
332
+ * Status of a bank account application.
333
+ */
334
+ type BankAccountApplicationStatusDto = 'DRAFT' | 'SUBMITTED' | 'COMPLETE' | 'DELETED' | 'CANCELED' | 'DENIED';
72
335
  type BankAccountHolderType = 'INDIVIDUAL' | 'BUSINESS';
336
+ /**
337
+ * Bank account information for a money movement.
338
+ */
339
+ type BankAccountInfo = {
340
+ /**
341
+ * Bank account identifier.
342
+ */
343
+ id: string;
344
+ /**
345
+ * Optional bank account nickname.
346
+ */
347
+ nickname?: null | string;
348
+ };
349
+ type BankAccountPaymentMethod = {
350
+ details: BankAccountPaymentMethodDetails;
351
+ type: 'bank_account';
352
+ };
353
+ type BankAccountPaymentMethodDetails = {
354
+ /**
355
+ * The name of the person or business that owns this bank account.
356
+ */
357
+ account_holder_name?: string | null;
358
+ /**
359
+ * The bank account number. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits.
360
+ */
361
+ account_number?: string | null;
362
+ /**
363
+ * The SWIFT/BIC code of the bank. Can be either 8 or 11 characters long.
364
+ */
365
+ bic?: string | null;
366
+ /**
367
+ * ISO currency code of the bank account.
368
+ */
369
+ currency?: CurrencyEnum | null;
370
+ /**
371
+ * The IBAN of the bank account, up to 34 characters.
372
+ */
373
+ iban?: string | null;
374
+ /**
375
+ * The name of the bank account, if available. For example, "Primary account" or "Savings account".
376
+ */
377
+ name?: string | null;
378
+ /**
379
+ * The bank's routing transit number (RTN). US routing numbers consist of 9 digits.
380
+ */
381
+ routing_number?: string | null;
382
+ /**
383
+ * The bank's sort code.
384
+ */
385
+ sort_code?: string | null;
386
+ };
73
387
  type BankAccountSnapshot = {
74
388
  account_holder_name?: string | null;
75
389
  account_number?: string | null;
@@ -80,6 +394,35 @@ type BankAccountSnapshot = {
80
394
  * The status of a bank account.
81
395
  */
82
396
  type BankAccountStatus = 'ACTIVE' | 'CLOSED';
397
+ /**
398
+ * Direction of a bank account transaction.
399
+ */
400
+ type BankAccountTransactionDirectionDto = 'CREDIT' | 'DEBIT';
401
+ /**
402
+ * Response model for a bank account transaction.
403
+ */
404
+ type BankAccountTransactionResponse = {
405
+ /**
406
+ * Amount of the transaction in minor units (e.g. cents for USD).
407
+ */
408
+ amount: AmountOutput;
409
+ /**
410
+ * Date the transaction occurred.
411
+ */
412
+ date: string;
413
+ /**
414
+ * Description of the transaction.
415
+ */
416
+ description: string;
417
+ /**
418
+ * Direction of the transaction (credit or debit).
419
+ */
420
+ direction: BankAccountTransactionDirectionDto;
421
+ /**
422
+ * Running balance after this transaction in minor units (e.g. cents for USD).
423
+ */
424
+ runningBalance: AmountOutput;
425
+ };
83
426
  /**
84
427
  * Output model for a bank account transfer account.
85
428
  */
@@ -126,6 +469,12 @@ type BankAccountTransferResponse = {
126
469
  * echoed back unchanged. Null when the request omitted one.
127
470
  */
128
471
  reference?: null | string;
472
+ returnCategory?: null | BankAccountTransferReturnCategoryDto;
473
+ /**
474
+ * The NACHA return code the receiving institution sent (e.g. "R02"), when Status is RETURNED.
475
+ * Intended for support and reconciliation; use ReturnCategory for anything shown to a customer.
476
+ */
477
+ returnCode?: null | string;
129
478
  /**
130
479
  * The status of the transfer.
131
480
  */
@@ -139,10 +488,11 @@ type BankAccountTransferResponse = {
139
488
  */
140
489
  type: BankAccountTransferTypeDto;
141
490
  };
491
+ type BankAccountTransferReturnCategoryDto = 'ACCOUNT_CLOSED' | 'INVALID_ACCOUNT_DETAILS' | 'ACCOUNT_CANNOT_RECEIVE' | 'REFUSED_BY_RECEIVER' | 'GENERIC';
142
492
  /**
143
493
  * Status of a bank account transfer operation.
144
494
  */
145
- type BankAccountTransferStatusDto = 'PENDING' | 'COMPLETED' | 'FAILED';
495
+ type BankAccountTransferStatusDto = 'PENDING' | 'COMPLETED' | 'FAILED' | 'RETURNED';
146
496
  /**
147
497
  * Type of bank account transfer operation.
148
498
  */
@@ -189,87 +539,491 @@ type BankAccountWithBalanceResponse = {
189
539
  status: BankAccountStatus;
190
540
  };
191
541
  /**
192
- * The card network (brand) an issued card runs on, such as Visa or Mastercard.
542
+ * In invoice history, this object contains information about a credit note created for this invoice.
543
+ * In quote history, it contains information about an invoice created from this quote.
193
544
  */
194
- type CardBrand = 'UNKNOWN' | 'VISA' | 'MASTERCARD' | 'DISCOVER' | 'AMERICAN_EXPRESS';
195
- type CounterpartType = 'individual' | 'organization';
196
- type CountryCode = 'AFG' | 'ALB' | 'DZA' | 'ASM' | 'ALA' | 'AND' | 'AGO' | 'AIA' | 'ATA' | 'ATG' | 'ARG' | 'ARM' | 'ABW' | 'AUS' | 'AUT' | 'AZE' | 'BHS' | 'BHR' | 'BGD' | 'BRB' | 'BLR' | 'BEL' | 'BLZ' | 'BEN' | 'BES' | 'BMU' | 'BTN' | 'BOL' | 'BIH' | 'BWA' | 'BVT' | 'BRA' | 'IOT' | 'BRN' | 'BGR' | 'BFA' | 'BDI' | 'CPV' | 'KHM' | 'CMR' | 'CAN' | 'CYM' | 'CAF' | 'TCD' | 'CHL' | 'CHN' | 'CXR' | 'CCK' | 'COL' | 'COM' | 'COD' | 'COG' | 'CIV' | 'COK' | 'CRI' | 'HRV' | 'CUB' | 'CUW' | 'CYP' | 'CZE' | 'DNK' | 'DJI' | 'DMA' | 'DOM' | 'ECU' | 'EGY' | 'SLV' | 'GNQ' | 'ERI' | 'EST' | 'SWZ' | 'ETH' | 'FLK' | 'FRO' | 'FJI' | 'FIN' | 'FRA' | 'GUF' | 'PYF' | 'ATF' | 'GAB' | 'GMB' | 'GEO' | 'DEU' | 'GHA' | 'GIB' | 'GRC' | 'GRL' | 'GRD' | 'GLP' | 'GUM' | 'GTM' | 'GGY' | 'GIN' | 'GNB' | 'GUY' | 'HTI' | 'HMD' | 'HND' | 'HKG' | 'HUN' | 'ISL' | 'IND' | 'IDN' | 'IRL' | 'IRN' | 'IRQ' | 'IMN' | 'ISR' | 'ITA' | 'JAM' | 'JPN' | 'JEY' | 'JOR' | 'KAZ' | 'KEN' | 'KIR' | 'KOR' | 'KWT' | 'KGZ' | 'LAO' | 'LVA' | 'LBN' | 'LSO' | 'LBR' | 'LBY' | 'LIE' | 'LTU' | 'LUX' | 'MDG' | 'MWI' | 'MYS' | 'MDV' | 'MLI' | 'MLT' | 'MHL' | 'MTQ' | 'MRT' | 'MUS' | 'MYT' | 'MEX' | 'FSM' | 'MDA' | 'MCO' | 'MNG' | 'MNE' | 'MSR' | 'MAR' | 'MOZ' | 'MMR' | 'NAM' | 'NRU' | 'NPL' | 'NLD' | 'NCL' | 'NZL' | 'NIC' | 'NER' | 'NGA' | 'NIU' | 'NFK' | 'MAC' | 'MKD' | 'MNP' | 'NOR' | 'OMN' | 'PAK' | 'PLW' | 'PSE' | 'PAN' | 'PNG' | 'PRY' | 'PER' | 'PHL' | 'PCN' | 'POL' | 'PRT' | 'PRI' | 'PRK' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'BLM' | 'SHN' | 'KNA' | 'LCA' | 'MAF' | 'SPM' | 'VCT' | 'WSM' | 'SMR' | 'STP' | 'SAU' | 'SEN' | 'SRB' | 'SYC' | 'SLE' | 'SGP' | 'SXM' | 'SVK' | 'SVN' | 'SLB' | 'SOM' | 'ZAF' | 'SGS' | 'SSD' | 'ESP' | 'LKA' | 'SDN' | 'SUR' | 'SJM' | 'SWE' | 'SYR' | 'CHE' | 'TCA' | 'TWN' | 'TJK' | 'TZA' | 'THA' | 'TLS' | 'TGO' | 'TKL' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TKM' | 'TUV' | 'UGA' | 'UKR' | 'UMI' | 'ARE' | 'GBR' | 'USA' | 'URY' | 'UZB' | 'VUT' | 'VAT' | 'VEN' | 'VIR' | 'VGB' | 'VNM' | 'WLF' | 'ESH' | 'YEM' | 'ZMB' | 'ZWE';
197
- type CreditCardResponse = {
198
- id: string;
199
- cardLimit?: null | number | string;
200
- cardStatus: CreditCardStatus;
201
- cardType: CreditCardType;
202
- cardholderName: string;
203
- createdAt: string;
204
- currentBalance: AmountOutput;
205
- description?: null | string;
206
- lastFourDigits: string;
207
- nickname?: null | string;
208
- updatedAt: string;
209
- userId: string;
210
- };
211
- type CreditCardStatus = 'PENDING_ACTIVATION' | 'ACTIVE' | 'LOCKED' | 'CLOSED';
212
- type CreditCardType = 'DIGITAL' | 'PHYSICAL';
213
- type CreditNoteRenderingSettings = {
545
+ type BasedOnReceivableCreatedEventData = {
214
546
  /**
215
- * If set to `true`, the organization's bank account details will be displayed on the credit note PDF.
547
+ * The ID of the newly created receivable document.
216
548
  */
217
- display_organization_bank_account?: boolean;
218
- };
219
- type CurrencyEnum = 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW';
220
- type DebitCardCredentialsResponse = {
221
- cvv: string;
222
- expirationDate: string;
223
- pan: string;
549
+ receivable_id: string;
550
+ /**
551
+ * The type of the receivable document that was created based on the current document.
552
+ */
553
+ type: ReceivableType;
224
554
  };
225
555
  /**
226
- * The detail view of a single debit card. Extends the fields returned by the list endpoint
227
- * (DebitCardResponse).
556
+ * Output model for business details in responses.
228
557
  */
229
- type DebitCardDetailResponse = {
230
- id: string;
231
- bankAccountId: string;
558
+ type BusinessDetailsOutput = {
559
+ address?: null | AddressOutput;
560
+ businessStructureType?: null | BusinessStructureType;
232
561
  /**
233
- * The billing address the issuer holds for this card.
562
+ * Doing Business As (DBA) name.
234
563
  */
235
- billingAddress: AddressOutput;
236
- cardBrand: CardBrand;
237
- cardStatus: DebitCardStatus;
238
- cardType: DebitCardType;
239
- cardholderName: string;
240
- createdAt: string;
241
- description?: null | string;
242
- expirationDate: string;
243
- lastFourDigits: string;
564
+ dbaName?: null | string;
244
565
  /**
245
- * The MCC groups allowed on this card.
566
+ * Legal business name.
246
567
  */
247
- mccGroups: Array<MccGroupResponse>;
248
- nickname?: null | string;
249
- reference: string;
250
- updatedAt: string;
251
- userId: string;
568
+ legalName?: null | string;
569
+ northAmericanIndustryClassificationSystemCode?: null | NorthAmericanIndustryClassificationSystemCode;
252
570
  /**
253
- * Velocity controls scoped to this card. Single-purchase, daily, and monthly limits appear here as
254
- * controls with a `TRANSACTION`, `DAY`, and `MONTH` window respectively.
571
+ * Business phone number.
255
572
  */
256
- velocityControls: Array<VelocityControlResponse>;
573
+ phoneNumber?: null | string;
574
+ /**
575
+ * Last four digits of the tax id already on file, so an applicant resuming an application can
576
+ * recognise it instead of re-entering it. The full value is never returned. A sole
577
+ * proprietorship files under the owner's SSN, so these can be the last four of an SSN rather
578
+ * than an EIN.
579
+ */
580
+ taxIdLast4?: null | string;
581
+ /**
582
+ * Business website URL.
583
+ */
584
+ website?: null | string;
257
585
  };
258
- type DebitCardStatus = 'PENDING_ACTIVATION' | 'ACTIVE' | 'LOCKED' | 'CLOSED';
259
- type DebitCardType = 'DIGITAL' | 'PHYSICAL';
260
- type DeductionItem = {
586
+ /**
587
+ * Output model for business owner information in responses.
588
+ */
589
+ type BusinessOwnerOutput = {
261
590
  /**
262
- * The amount of the deduction in minor units(https://docs.monite.com/references/currencies#minor-units)
591
+ * Unique identifier of the business owner record. Used by the client to reference
592
+ * existing owners on update requests.
263
593
  */
264
- amount: number;
594
+ id?: null | string;
265
595
  /**
266
- * A note with additional information about this deduction
596
+ * Date of birth of the business owner.
267
597
  */
268
- memo?: string | null;
598
+ birthDate?: null | string;
269
599
  /**
270
- * Name or title of this deduction
600
+ * First name of the business owner.
271
601
  */
272
- name: string;
602
+ firstName?: null | string;
603
+ homeAddress?: null | AddressOutput;
604
+ /**
605
+ * Last name of the business owner.
606
+ */
607
+ lastName?: null | string;
608
+ /**
609
+ * Mobile phone number of the business owner.
610
+ */
611
+ mobilePhoneNumber?: null | string;
612
+ /**
613
+ * Ownership percentage as a decimal between 0 and 1 (e.g., 25% = 0.25).
614
+ */
615
+ ownershipPercentage?: null | number | string;
616
+ /**
617
+ * Last four digits of the personal identification number already on file, so an applicant
618
+ * resuming an application can recognise it instead of re-entering it. The full value is
619
+ * never returned.
620
+ */
621
+ personalIdentificationNumberLast4?: null | string;
622
+ };
623
+ type BusinessStructureType = 'CORPORATION_PUBLIC' | 'CORPORATION_PRIVATE' | 'CORPORATION_NOT_FOR_PROFIT' | 'LLC' | 'LLP' | 'PARTNERSHIP' | 'SOLE_PROPRIETORSHIP' | 'GOVERNMENT' | 'COOPERATIVE' | 'ASSOCIATION' | 'OTHER';
624
+ /**
625
+ * The card network (brand) an issued card runs on, such as Visa or Mastercard.
626
+ */
627
+ type CardBrand = 'UNKNOWN' | 'VISA' | 'MASTERCARD' | 'DISCOVER' | 'AMERICAN_EXPRESS';
628
+ type CardBrandEnum = 'visa' | 'mastercard' | 'maestro' | 'amex' | 'union_pay' | 'jcb' | 'discover' | 'dinners_club' | 'unknown';
629
+ type CardPaymentMethod = {
630
+ details: CardPaymentMethodDetails;
631
+ type: 'card';
632
+ };
633
+ type CardPaymentMethodDetails = {
634
+ /**
635
+ * The card brand name.
636
+ */
637
+ brand: CardBrandEnum;
638
+ /**
639
+ * The card type
640
+ */
641
+ card_type: CardTypeEnum;
642
+ /**
643
+ * The card's expiration month (1 - January, 12 - December).
644
+ */
645
+ expiry_month: number;
646
+ /**
647
+ * The card's expiration year.
648
+ */
649
+ expiry_year: number;
650
+ /**
651
+ * The last four digits of the card number.
652
+ */
653
+ last4: string;
654
+ };
655
+ type CardTypeEnum = 'credit' | 'debit' | 'prepaid' | 'unknown';
656
+ type CounterpartAddressResponseWithCounterpartId = {
657
+ /**
658
+ * Unique ID of the address in the system
659
+ */
660
+ id: string;
661
+ /**
662
+ * City name.
663
+ */
664
+ city: string;
665
+ /**
666
+ * ID of the counterpart that owns the address.
667
+ */
668
+ counterpart_id: string;
669
+ /**
670
+ * Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
671
+ */
672
+ country: AllowedCountries;
673
+ /**
674
+ * Street address.
675
+ */
676
+ line1: string;
677
+ /**
678
+ * Additional address information (if any).
679
+ */
680
+ line2?: string | null;
681
+ /**
682
+ * ZIP or postal code.
683
+ */
684
+ postal_code: string;
685
+ /**
686
+ * State, region, province, or county.
687
+ */
688
+ state?: string | null;
689
+ };
690
+ type CounterpartBankAccountResponse = {
691
+ id: string;
692
+ /**
693
+ * The name of the person or business that owns this bank account. Required for US bank accounts to accept ACH payments.
694
+ */
695
+ account_holder_name?: string | null;
696
+ /**
697
+ * The bank account number. Required for US bank accounts to accept ACH payments. US account numbers contain 9 to 12 digits. UK account numbers typically contain 8 digits.
698
+ */
699
+ account_number?: string | null;
700
+ /**
701
+ * The BIC/SWIFT code of the bank.
702
+ */
703
+ bic?: string | null;
704
+ counterpart_id: string;
705
+ country: AllowedCountries;
706
+ currency: CurrencyEnum;
707
+ /**
708
+ * The IBAN of the bank account.
709
+ */
710
+ iban?: string | null;
711
+ is_default_for_currency?: boolean;
712
+ name?: string | null;
713
+ /**
714
+ * Metadata for partner needs.
715
+ */
716
+ partner_metadata?: {
717
+ [key: string]: unknown;
718
+ };
719
+ /**
720
+ * The bank's routing transit number (RTN). Required for US bank accounts to accept ACH payments. US routing numbers consist of 9 digits.
721
+ */
722
+ routing_number?: string | null;
723
+ /**
724
+ * The bank's sort code.
725
+ */
726
+ sort_code?: string | null;
727
+ };
728
+ type CounterpartOrganizationResponse = {
729
+ /**
730
+ * The email address of the organization.
731
+ */
732
+ email?: string | null;
733
+ /**
734
+ * The legal name of the organization.
735
+ */
736
+ legal_name: string;
737
+ /**
738
+ * The phone number of the organization.
739
+ */
740
+ phone?: string | null;
741
+ /**
742
+ * The list of tags for this counterpart.
743
+ */
744
+ tags?: Array<CounterpartTagSchema> | null;
745
+ };
746
+ /**
747
+ * Represents counterparts that are organizations (juridical persons).
748
+ */
749
+ type CounterpartOrganizationRootResponse = {
750
+ /**
751
+ * Unique ID of the counterpart.
752
+ */
753
+ id: string;
754
+ /**
755
+ * Date and time when the counterpart was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard.
756
+ */
757
+ created_at: string;
758
+ /**
759
+ * Date and time when the counterpart was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard.
760
+ */
761
+ updated_at: string;
762
+ /**
763
+ * `true` if the counterpart was created automatically by Monite when processing incoming invoices with OCR. `false` if the counterpart was created by the API client.
764
+ */
765
+ created_automatically?: boolean;
766
+ /**
767
+ * Entity user ID of counterpart creator.
768
+ */
769
+ created_by_entity_user_id?: string | null;
770
+ /**
771
+ * ID of the counterpart's billing address. If the counterpart is US-based and needs to accept ACH payments, this address must have all fields filled in. If `default_billing_address_id` is not defined, the default address is instead used as the billing address for ACH payments.
772
+ */
773
+ default_billing_address_id?: string | null;
774
+ /**
775
+ * ID of the shipping address.
776
+ */
777
+ default_shipping_address_id?: string | null;
778
+ /**
779
+ * A user-defined identifier of the counterpart. For example, the customer or vendor reference number in the entity's CRM system. If specified, it will be displayed in PDF invoices and other accounts receivable documents created by the entity.
780
+ */
781
+ external_reference?: string | null;
782
+ /**
783
+ * Indicates if the counterpart is a customer.
784
+ */
785
+ is_customer: boolean;
786
+ /**
787
+ * Indicates if the counterpart is a vendor.
788
+ */
789
+ is_vendor: boolean;
790
+ /**
791
+ * The language used to generate PDF documents for this counterpart.
792
+ */
793
+ language?: LanguageCodeEnum | null;
794
+ organization: CounterpartOrganizationResponse;
795
+ reminders_enabled?: boolean | null;
796
+ /**
797
+ * The counterpart's taxpayer identification number or tax ID.
798
+ */
799
+ tax_id?: string | null;
800
+ /**
801
+ * The counterpart type: `organization` (juridical person) or `individual` (natural person).
802
+ */
803
+ type: CounterpartType;
804
+ };
805
+ /**
806
+ * Address information.
807
+ */
808
+ type CounterpartRawAddress = {
809
+ /**
810
+ * City name.
811
+ */
812
+ city?: string | null;
813
+ /**
814
+ * Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
815
+ */
816
+ country?: AllowedCountries | null;
817
+ /**
818
+ * Street address.
819
+ */
820
+ line1?: string | null;
821
+ /**
822
+ * Additional address information (if any).
823
+ */
824
+ line2?: string | null;
825
+ /**
826
+ * ZIP or postal code.
827
+ */
828
+ postal_code?: string | null;
829
+ /**
830
+ * State, region, province, or county.
831
+ */
832
+ state?: string | null;
833
+ };
834
+ type CounterpartRawBankAccount = {
835
+ /**
836
+ * Vendor's bank account name.
837
+ */
838
+ account_holder_name?: string | null;
839
+ /**
840
+ * Vendor's bank account number, IBAN, or similar (if specified in the payable document).
841
+ */
842
+ account_number?: string | null;
843
+ /**
844
+ * SWIFT code (BIC) of the vendor's bank.
845
+ */
846
+ bic?: string | null;
847
+ /**
848
+ * required for non-GB bank accounts
849
+ */
850
+ iban?: string | null;
851
+ /**
852
+ * required for US bank accounts
853
+ */
854
+ routing_number?: string | null;
855
+ /**
856
+ * required for GB bank accounts
857
+ */
858
+ sort_code?: string | null;
859
+ };
860
+ type CounterpartRawData = {
861
+ /**
862
+ * The address of the vendor or supplier.
863
+ */
864
+ address?: CounterpartRawAddress | null;
865
+ /**
866
+ * Object representing counterpart bank account.
867
+ */
868
+ bank_account?: CounterpartRawBankAccount | null;
869
+ /**
870
+ * The email address of the organization
871
+ */
872
+ email?: string | null;
873
+ /**
874
+ * Vendor or supplier name.
875
+ */
876
+ name?: string | null;
877
+ /**
878
+ * The phone number of the organization
879
+ */
880
+ phone?: string | null;
881
+ /**
882
+ * The tax id of the counterpart.
883
+ */
884
+ tax_id?: string | null;
885
+ /**
886
+ * VAT ID of the vendor or supplier which was used in the invoice.
887
+ */
888
+ vat_id?: CounterpartRawVatId | null;
889
+ };
890
+ type CounterpartRawVatId = {
891
+ country?: AllowedCountries | null;
892
+ type?: string | null;
893
+ value?: string | null;
894
+ };
895
+ /**
896
+ * Represents a user-defined tag that can be assigned to resources to filter them.
897
+ */
898
+ type CounterpartTagSchema = {
899
+ /**
900
+ * A unique ID of this tag.
901
+ */
902
+ id: string;
903
+ /**
904
+ * Date and time when the tag was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard.
905
+ */
906
+ created_at: string;
907
+ /**
908
+ * Date and time when the tag was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) standard.
909
+ */
910
+ updated_at: string;
911
+ /**
912
+ * The tag category.
913
+ */
914
+ category?: TagCategory | null;
915
+ /**
916
+ * ID of the user who created the tag.
917
+ */
918
+ created_by_entity_user_id?: string | null;
919
+ /**
920
+ * The tag description.
921
+ */
922
+ description?: string | null;
923
+ /**
924
+ * The tag name.
925
+ */
926
+ name: string;
927
+ };
928
+ type CounterpartType = 'individual' | 'organization';
929
+ type CountryCode = 'AFG' | 'ALB' | 'DZA' | 'ASM' | 'ALA' | 'AND' | 'AGO' | 'AIA' | 'ATA' | 'ATG' | 'ARG' | 'ARM' | 'ABW' | 'AUS' | 'AUT' | 'AZE' | 'BHS' | 'BHR' | 'BGD' | 'BRB' | 'BLR' | 'BEL' | 'BLZ' | 'BEN' | 'BES' | 'BMU' | 'BTN' | 'BOL' | 'BIH' | 'BWA' | 'BVT' | 'BRA' | 'IOT' | 'BRN' | 'BGR' | 'BFA' | 'BDI' | 'CPV' | 'KHM' | 'CMR' | 'CAN' | 'CYM' | 'CAF' | 'TCD' | 'CHL' | 'CHN' | 'CXR' | 'CCK' | 'COL' | 'COM' | 'COD' | 'COG' | 'CIV' | 'COK' | 'CRI' | 'HRV' | 'CUB' | 'CUW' | 'CYP' | 'CZE' | 'DNK' | 'DJI' | 'DMA' | 'DOM' | 'ECU' | 'EGY' | 'SLV' | 'GNQ' | 'ERI' | 'EST' | 'SWZ' | 'ETH' | 'FLK' | 'FRO' | 'FJI' | 'FIN' | 'FRA' | 'GUF' | 'PYF' | 'ATF' | 'GAB' | 'GMB' | 'GEO' | 'DEU' | 'GHA' | 'GIB' | 'GRC' | 'GRL' | 'GRD' | 'GLP' | 'GUM' | 'GTM' | 'GGY' | 'GIN' | 'GNB' | 'GUY' | 'HTI' | 'HMD' | 'HND' | 'HKG' | 'HUN' | 'ISL' | 'IND' | 'IDN' | 'IRL' | 'IRN' | 'IRQ' | 'IMN' | 'ISR' | 'ITA' | 'JAM' | 'JPN' | 'JEY' | 'JOR' | 'KAZ' | 'KEN' | 'KIR' | 'KOR' | 'KWT' | 'KGZ' | 'LAO' | 'LVA' | 'LBN' | 'LSO' | 'LBR' | 'LBY' | 'LIE' | 'LTU' | 'LUX' | 'MDG' | 'MWI' | 'MYS' | 'MDV' | 'MLI' | 'MLT' | 'MHL' | 'MTQ' | 'MRT' | 'MUS' | 'MYT' | 'MEX' | 'FSM' | 'MDA' | 'MCO' | 'MNG' | 'MNE' | 'MSR' | 'MAR' | 'MOZ' | 'MMR' | 'NAM' | 'NRU' | 'NPL' | 'NLD' | 'NCL' | 'NZL' | 'NIC' | 'NER' | 'NGA' | 'NIU' | 'NFK' | 'MAC' | 'MKD' | 'MNP' | 'NOR' | 'OMN' | 'PAK' | 'PLW' | 'PSE' | 'PAN' | 'PNG' | 'PRY' | 'PER' | 'PHL' | 'PCN' | 'POL' | 'PRT' | 'PRI' | 'PRK' | 'QAT' | 'REU' | 'ROU' | 'RUS' | 'RWA' | 'BLM' | 'SHN' | 'KNA' | 'LCA' | 'MAF' | 'SPM' | 'VCT' | 'WSM' | 'SMR' | 'STP' | 'SAU' | 'SEN' | 'SRB' | 'SYC' | 'SLE' | 'SGP' | 'SXM' | 'SVK' | 'SVN' | 'SLB' | 'SOM' | 'ZAF' | 'SGS' | 'SSD' | 'ESP' | 'LKA' | 'SDN' | 'SUR' | 'SJM' | 'SWE' | 'SYR' | 'CHE' | 'TCA' | 'TWN' | 'TJK' | 'TZA' | 'THA' | 'TLS' | 'TGO' | 'TKL' | 'TON' | 'TTO' | 'TUN' | 'TUR' | 'TKM' | 'TUV' | 'UGA' | 'UKR' | 'UMI' | 'ARE' | 'GBR' | 'USA' | 'URY' | 'UZB' | 'VUT' | 'VAT' | 'VEN' | 'VIR' | 'VGB' | 'VNM' | 'WLF' | 'ESH' | 'YEM' | 'ZMB' | 'ZWE';
930
+ type CreditCardResponse = {
931
+ id: string;
932
+ cardLimit?: null | number | string;
933
+ cardStatus: CreditCardStatus;
934
+ cardType: CreditCardType;
935
+ cardholderName: string;
936
+ createdAt: string;
937
+ currentBalance: AmountOutput;
938
+ description?: null | string;
939
+ lastFourDigits: string;
940
+ nickname?: null | string;
941
+ updatedAt: string;
942
+ userId: string;
943
+ };
944
+ type CreditCardStatus = 'PENDING_ACTIVATION' | 'ACTIVE' | 'LOCKED' | 'CLOSED';
945
+ type CreditCardType = 'DIGITAL' | 'PHYSICAL';
946
+ type CreditNoteRenderingSettings = {
947
+ /**
948
+ * If set to `true`, the organization's bank account details will be displayed on the credit note PDF.
949
+ */
950
+ display_organization_bank_account?: boolean;
951
+ };
952
+ type CurrencyEnum = 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SOS' | 'SRD' | 'SSP' | 'SVC' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW';
953
+ type CurrencyExchangeSchema = {
954
+ default_currency_code: string;
955
+ rate: number;
956
+ total: number;
957
+ };
958
+ type DebitCardCredentialsResponse = {
959
+ cvv: string;
960
+ expirationDate: string;
961
+ pan: string;
962
+ };
963
+ /**
964
+ * The detail view of a single debit card. Extends the fields returned by the list endpoint
965
+ * (DebitCardResponse).
966
+ */
967
+ type DebitCardDetailResponse = {
968
+ id: string;
969
+ bankAccountId: string;
970
+ /**
971
+ * The billing address the issuer holds for this card.
972
+ */
973
+ billingAddress: AddressOutput;
974
+ cardBrand: CardBrand;
975
+ cardStatus: DebitCardStatus;
976
+ cardType: DebitCardType;
977
+ cardholderName: string;
978
+ createdAt: string;
979
+ description?: null | string;
980
+ expirationDate: string;
981
+ lastFourDigits: string;
982
+ /**
983
+ * The MCC groups allowed on this card.
984
+ */
985
+ mccGroups: Array<MccGroupResponse>;
986
+ nickname?: null | string;
987
+ reference: string;
988
+ updatedAt: string;
989
+ userId: string;
990
+ /**
991
+ * Velocity controls scoped to this card. Single-purchase, daily, and monthly limits appear here as
992
+ * controls with a `TRANSACTION`, `DAY`, and `MONTH` window respectively.
993
+ */
994
+ velocityControls: Array<VelocityControlResponse>;
995
+ };
996
+ type DebitCardStatus = 'PENDING_ACTIVATION' | 'ACTIVE' | 'LOCKED' | 'CLOSED';
997
+ type DebitCardType = 'DIGITAL' | 'PHYSICAL';
998
+ type DeductionItem = {
999
+ /**
1000
+ * The amount of the deduction in minor units(https://docs.monite.com/references/currencies#minor-units)
1001
+ */
1002
+ amount: number;
1003
+ /**
1004
+ * A note with additional information about this deduction
1005
+ */
1006
+ memo?: string | null;
1007
+ /**
1008
+ * Name or title of this deduction
1009
+ */
1010
+ name: string;
1011
+ };
1012
+ /**
1013
+ * Contains information about a deleted receivable document. Only draft documents can be deleted.
1014
+ */
1015
+ type DeletedEventData = {
1016
+ /**
1017
+ * The status the document held before it was deleted.
1018
+ */
1019
+ old_status: ReceivablesStatusEnum;
1020
+ };
1021
+ type DepartmentListItem = {
1022
+ id: string;
1023
+ createdDateTime: string;
1024
+ memberCount: number | string;
1025
+ name: string;
1026
+ updatedDateTime: string;
273
1027
  };
274
1028
  /**
275
1029
  * Who a disclosure binds, and therefore who can accept it. ENTITY binds the business itself: one
@@ -280,754 +1034,2432 @@ type DeductionItem = {
280
1034
  * independent version stream per bank organization, so a bank can have one version in force per
281
1035
  * scope at a time, and publishing into one stream leaves the others untouched.
282
1036
  */
283
- type DisclosureAcceptanceScope = 'ENTITY' | 'SIGNER' | 'PERSON';
1037
+ type DisclosureAcceptanceScope = 'ENTITY' | 'SIGNER' | 'PERSON';
1038
+ /**
1039
+ * One document the caller is being asked to accept.
1040
+ */
1041
+ type DisclosureDocumentDto = {
1042
+ /**
1043
+ * Display name, as it should be shown to the user.
1044
+ */
1045
+ title: string;
1046
+ /**
1047
+ * Where the document is hosted. This service does not serve the file.
1048
+ */
1049
+ url: string;
1050
+ };
1051
+ /**
1052
+ * One acceptance scope's obligation and where it leaves the caller.
1053
+ */
1054
+ type DisclosureDto = {
1055
+ /**
1056
+ * Who this disclosure binds, and so who can accept it.
1057
+ */
1058
+ acceptanceScope: DisclosureAcceptanceScope;
1059
+ /**
1060
+ * Whether the obligation is met. On the ENTITY scope this is the organization's execution,
1061
+ * so it can be true for a caller who did nothing themselves.
1062
+ */
1063
+ accepted: boolean;
1064
+ /**
1065
+ * Whether this caller can accept it. The ENTITY and SIGNER scopes are a designated
1066
+ * authorized signer's to accept; false on every scope when the read was made on an invitee's
1067
+ * behalf rather than by the person themselves.
1068
+ */
1069
+ canAccept: boolean;
1070
+ /**
1071
+ * The disclosure in force for this scope. Submit it back when accepting.
1072
+ */
1073
+ disclosureId: string;
1074
+ /**
1075
+ * The documents making up this disclosure, in the order to present them.
1076
+ */
1077
+ documents: Array<DisclosureDocumentDto>;
1078
+ /**
1079
+ * When an unmet ENTITY obligation stops being tolerated. Only that scope runs a grace
1080
+ * period, so this is null on the others, and null once the obligation is met.
1081
+ */
1082
+ graceDeadlineTsUtc?: null | string;
1083
+ /**
1084
+ * Clear, owed with time left, or owed with the consequence applying now.
1085
+ */
1086
+ standing: DisclosureStanding;
1087
+ };
1088
+ type DisclosureRequirement = 'NOT_REQUIRED' | 'REQUIRED';
1089
+ /**
1090
+ * Where a caller stands against one acceptance scope's obligation. Three states rather than a boolean
1091
+ * because an unmet entity obligation runs a grace period before it restricts anything.
1092
+ */
1093
+ type DisclosureStanding = 'CLEAR' | 'IN_GRACE' | 'EXPIRED';
1094
+ /**
1095
+ * The disclosures in force for a caller, and whether they have accepted them.
1096
+ */
1097
+ type DisclosuresResponseDto = {
1098
+ /**
1099
+ * Every acceptance scope the caller's bank has a disclosure in force for, whether or not it
1100
+ * falls on this caller, so a client can show what governs the organization. Whether an entry
1101
+ * is this caller's to act on is carried by its `standing` and `canAccept`.
1102
+ */
1103
+ disclosures?: Array<DisclosureDto>;
1104
+ /**
1105
+ * Whether this caller's organization requires disclosures at all.
1106
+ */
1107
+ requirement: DisclosureRequirement;
1108
+ };
1109
+ type Discount = {
1110
+ /**
1111
+ * The actual discount of the product in [minor units](https://docs.monite.com/references/currencies#minor-units) if type field equals amount, else in percent minor units
1112
+ */
1113
+ amount: number;
1114
+ /**
1115
+ * The field specifies whether to use product currency or %.
1116
+ */
1117
+ type: DiscountType;
1118
+ };
1119
+ type DiscountResponse = {
1120
+ /**
1121
+ * The actual discount of the product in [minor units](https://docs.monite.com/references/currencies#minor-units) if type field equals amount, else in percent minor units
1122
+ */
1123
+ amount: number;
1124
+ /**
1125
+ * The field specifies whether to use product currency or %.
1126
+ */
1127
+ type: DiscountType;
1128
+ /**
1129
+ * The monetary amount of the discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). If the discount `type` is `amount`, this value is the same as the `amount` value. If `type` is `percentage`, the value is the calculated discount amount.
1130
+ */
1131
+ value?: number | null;
1132
+ };
1133
+ type DiscountType = 'amount' | 'percentage';
1134
+ /**
1135
+ * Rendering settings that control how different parts of the PDF documents are displayed.
1136
+ * Includes common settings for all document types such as quotes, invoices, and credit notes and document
1137
+ * type-specific settings that are defined in their respective objects.
1138
+ */
1139
+ type DocumentRenderingSettings = {
1140
+ /**
1141
+ * Credit note-specific rendering settings for PDF documents.
1142
+ */
1143
+ credit_note?: CreditNoteRenderingSettings;
1144
+ /**
1145
+ * If set to `true`, the line items table will be displayed on the quote PDF. Defaults to `true`.
1146
+ */
1147
+ display_line_items?: boolean;
1148
+ /**
1149
+ * If set to `true`, the organization's bank account details will be displayed on the PDF documents. Defaults to `true`.
1150
+ */
1151
+ display_organization_bank_account?: boolean;
1152
+ /**
1153
+ * Invoice-specific rendering settings for PDF documents.
1154
+ */
1155
+ invoice?: InvoiceRenderingSettings;
1156
+ /**
1157
+ * Settings for rendering line items in PDF documents.
1158
+ */
1159
+ line_items?: LineItemsRenderingSettings;
1160
+ /**
1161
+ * Quote-specific rendering settings for PDF documents.
1162
+ */
1163
+ quote?: QuoteRenderingSettings;
1164
+ };
1165
+ /**
1166
+ * The document verification the applicant must complete before a KYC decision can be made.
1167
+ */
1168
+ type DocumentVerificationOutput = {
1169
+ /**
1170
+ * The provider's hosted capture link. Open it on a phone, or render it as a QR code for the applicant to scan.
1171
+ */
1172
+ captureUrl: string;
1173
+ };
1174
+ /**
1175
+ * Response DTO for embedded business entity data.
1176
+ */
1177
+ type EmbeddedBusinessDataResponseDto = {
1178
+ /**
1179
+ * The business structure type (e.g., LLC, Corporation).
1180
+ */
1181
+ businessStructureType?: null | string;
1182
+ /**
1183
+ * The date the business was formed.
1184
+ */
1185
+ formationDate?: null | string;
1186
+ naicsCode?: null | NorthAmericanIndustryClassificationSystemCode;
1187
+ taxId?: null | TaxIdResponseDto;
1188
+ };
1189
+ /**
1190
+ * A schema represents address info of the entity
1191
+ */
1192
+ type EntityAddressResponseSchema = {
1193
+ /**
1194
+ * A city (a full name) where the entity is registered
1195
+ */
1196
+ city: string;
1197
+ /**
1198
+ * A country name (as ISO code) where the entity is registered
1199
+ */
1200
+ country: AllowedCountries;
1201
+ /**
1202
+ * A street where the entity is registered
1203
+ */
1204
+ line1: string;
1205
+ /**
1206
+ * An alternative street used by the entity
1207
+ */
1208
+ line2?: string | null;
1209
+ /**
1210
+ * A postal code of the address where the entity is registered
1211
+ */
1212
+ postal_code: string;
1213
+ /**
1214
+ * A state in a country where the entity is registered
1215
+ */
1216
+ state?: string | null;
1217
+ };
1218
+ /**
1219
+ * Represents a US bank account (bank details) owned by an entity.
1220
+ */
1221
+ type EntityBankAccountResponse = {
1222
+ /**
1223
+ * Unique ID of the bank account.
1224
+ */
1225
+ id: string;
1226
+ /**
1227
+ * The name of the person or business that owns this bank account. Required in the following cases:
1228
+ * * the account currency is GBP or USD,
1229
+ * * the account currency is EUR and the entity wishes to receive SEPA Credit transfers to this account.
1230
+ */
1231
+ account_holder_name?: string | null;
1232
+ /**
1233
+ * The bank account number. Required if the account currency is GBP or USD. UK account numbers typically contain 8 digits. US bank account numbers contain 9 to 12 digits.
1234
+ */
1235
+ account_number?: string | null;
1236
+ /**
1237
+ * The last 4 digits of bank account number. Required if the account currency is GBP or USD and there is no information about the full account number.
1238
+ */
1239
+ account_number_last4?: string | null;
1240
+ /**
1241
+ * The bank name.
1242
+ */
1243
+ bank_name?: string | null;
1244
+ /**
1245
+ * User-defined name of this bank account, such as 'Primary account' or 'Savings account'.
1246
+ */
1247
+ display_name?: string | null;
1248
+ /**
1249
+ * The bank's routing transit number (RTN) or branch code. Required if the account currency is USD. US routing numbers consist of 9 digits.
1250
+ */
1251
+ routing_number?: string | null;
1252
+ /**
1253
+ * ID of the entity user who added this bank account, or `null` if it was added using a partner access token.
1254
+ */
1255
+ was_created_by_user_id?: string | null;
1256
+ };
1257
+ type EntityBusinessStructure = 'incorporated_partnership' | 'unincorporated_partnership' | 'public_corporation' | 'private_corporation' | 'sole_proprietorship' | 'single_member_llc' | 'multi_member_llc' | 'private_partnership' | 'unincorporated_association' | 'public_partnership';
1258
+ type EntityOrganizationResponse = {
1259
+ /**
1260
+ * UUID entity ID
1261
+ */
1262
+ id: string;
1263
+ /**
1264
+ * UTC datetime
1265
+ */
1266
+ created_at: string;
1267
+ /**
1268
+ * UTC datetime
1269
+ */
1270
+ updated_at: string;
1271
+ /**
1272
+ * An address description of the entity
1273
+ */
1274
+ address: EntityAddressResponseSchema;
1275
+ /**
1276
+ * An official email address of the entity
1277
+ */
1278
+ email?: string | null;
1279
+ /**
1280
+ * A logo image of the entity
1281
+ */
1282
+ logo?: FileSchema2 | null;
1283
+ /**
1284
+ * A set of metadata describing an organization
1285
+ */
1286
+ organization: OrganizationResponseSchema;
1287
+ /**
1288
+ * A phone number of the entity
1289
+ */
1290
+ phone?: string | null;
1291
+ /**
1292
+ * (Germany only) The name of the local district court (_Amtsgericht_) where the entity is registered. Required if `registration_number` is provided.
1293
+ */
1294
+ registration_authority?: string | null;
1295
+ /**
1296
+ * (Germany only) The entity's commercial register number (_Handelsregisternummer_) in the German Commercial Register, if available.
1297
+ */
1298
+ registration_number?: string | null;
1299
+ /**
1300
+ * record status, 'active' by default
1301
+ */
1302
+ status: EntityStatusEnum;
1303
+ /**
1304
+ * The entity's taxpayer identification number or tax ID. This field is required for entities that are non-VAT registered.
1305
+ */
1306
+ tax_id?: string | null;
1307
+ /**
1308
+ * A type for an organization
1309
+ */
1310
+ type: 'organization';
1311
+ /**
1312
+ * A website of the entity
1313
+ */
1314
+ website?: string | null;
1315
+ };
1316
+ type EntityStatusEnum = 'active' | 'inactive' | 'deleted';
1317
+ type EntityUserResponse = {
1318
+ /**
1319
+ * UUID entity user ID
1320
+ */
1321
+ id: string;
1322
+ /**
1323
+ * UTC datetime
1324
+ */
1325
+ created_at: string;
1326
+ /**
1327
+ * UTC datetime
1328
+ */
1329
+ updated_at: string;
1330
+ /**
1331
+ * An entity user business email
1332
+ */
1333
+ email?: string | null;
1334
+ /**
1335
+ * First name
1336
+ */
1337
+ first_name?: string;
1338
+ /**
1339
+ * Last name
1340
+ */
1341
+ last_name?: string | null;
1342
+ /**
1343
+ * Login
1344
+ */
1345
+ login: string;
1346
+ /**
1347
+ * An entity user phone number in the international format
1348
+ */
1349
+ phone?: string | null;
1350
+ /**
1351
+ * record status, 'active' by default
1352
+ */
1353
+ status: StatusEnum;
1354
+ userpic_file_id?: string | null;
1355
+ };
1356
+ type ExpenseApprovalRequestedEventData = {
1357
+ /**
1358
+ * The policy that matched.
1359
+ */
1360
+ approval_policy_id: string;
1361
+ /**
1362
+ * Policy name, snapshotted at event time.
1363
+ */
1364
+ approval_policy_name?: string | null;
1365
+ /**
1366
+ * The approval request created by this match.
1367
+ */
1368
+ approval_request_id?: string | null;
1369
+ /**
1370
+ * The policy's approval type.
1371
+ */
1372
+ approval_type?: string | null;
1373
+ /**
1374
+ * Designated approvers, if the policy names any.
1375
+ */
1376
+ approver_ids?: Array<string> | null;
1377
+ /**
1378
+ * Approvals the policy requires.
1379
+ */
1380
+ required_approval_count?: number | null;
1381
+ };
1382
+ type ExpenseApprovalsBypassedEventData = {
1383
+ /**
1384
+ * The approvers whose pending approval was cancelled by the force approval.
1385
+ */
1386
+ bypassed_approver_ids: Array<string>;
1387
+ /**
1388
+ * The same approvers, named as they read when the row was written.
1389
+ */
1390
+ bypassed_approvers?: Array<ExpenseBypassedApprover>;
1391
+ /**
1392
+ * The producer's identifier for the force approval, stable across a redelivery.
1393
+ */
1394
+ event_id: string;
1395
+ };
1396
+ type ExpenseAutoApprovedEventData = {
1397
+ /**
1398
+ * ISO timestamp of the auto-approval, taken from the message.
1399
+ */
1400
+ acted_at: string;
1401
+ /**
1402
+ * The policy that auto-approved.
1403
+ */
1404
+ approval_policy_id?: string | null;
1405
+ /**
1406
+ * Policy name, snapshotted at event time.
1407
+ */
1408
+ approval_policy_name?: string | null;
1409
+ };
1410
+ type ExpenseAutoCategorizedEventData = {
1411
+ /**
1412
+ * Memo the enrichment generated.
1413
+ */
1414
+ description?: string | null;
1415
+ /**
1416
+ * Ledger account the enrichment set.
1417
+ */
1418
+ ledger_account_id?: string | null;
1419
+ /**
1420
+ * How the values were set. Always 'generated' today.
1421
+ */
1422
+ source: FieldSourceEnum;
1423
+ };
1424
+ type ExpenseBypassedApprover = {
1425
+ /**
1426
+ * The approver whose pending approval was cancelled.
1427
+ */
1428
+ id: string;
1429
+ /**
1430
+ * Their first name as it read at the time.
1431
+ */
1432
+ first_name?: string | null;
1433
+ /**
1434
+ * Their last name as it read at the time.
1435
+ */
1436
+ last_name?: string | null;
1437
+ };
1438
+ type ExpenseCreatedEventData = {
1439
+ /**
1440
+ * 'feed' when a partner service created it with no entity user, otherwise 'manual'.
1441
+ */
1442
+ created_via: 'feed' | 'manual';
1443
+ /**
1444
+ * Department defaulted from the owner's profile.
1445
+ */
1446
+ department_id?: string | null;
1447
+ /**
1448
+ * The owner assigned at creation.
1449
+ */
1450
+ entity_user_id?: string | null;
1451
+ /**
1452
+ * The expense status the row was created with.
1453
+ */
1454
+ expense_status: ExpenseStatusEnum;
1455
+ /**
1456
+ * Location defaulted from the owner's profile.
1457
+ */
1458
+ location_id?: string | null;
1459
+ /**
1460
+ * Per-field source tracking as it stood at creation.
1461
+ */
1462
+ source_of_data?: {
1463
+ [key: string]: FieldSourceEnum;
1464
+ } | null;
1465
+ };
1466
+ type ExpenseDeletedEventData = {
1467
+ /**
1468
+ * The expense status at the point of deletion.
1469
+ */
1470
+ old_status: ExpenseStatusEnum;
1471
+ };
1472
+ type ExpenseHistoryEntryResponse = {
1473
+ id: string;
1474
+ /**
1475
+ * The acting user's first name as it read when the row was written. Never re-derived, so renaming the user does not change it. Null when recorded_by is 'system' and on rows where it was not captured.
1476
+ */
1477
+ entity_user_first_name: string | null;
1478
+ /**
1479
+ * The user who performed the action. Null when recorded_by is 'system'.
1480
+ */
1481
+ entity_user_id: string | null;
1482
+ /**
1483
+ * The acting user's last name as it read when the row was written. Never re-derived, so renaming the user does not change it. Null when recorded_by is 'system' and on rows where it was not captured.
1484
+ */
1485
+ entity_user_last_name: string | null;
1486
+ /**
1487
+ * The role the acting user held when the row was written. Null when recorded_by is 'system' and on rows where it was not captured.
1488
+ */
1489
+ entity_user_role_id: string | null;
1490
+ /**
1491
+ * The display name of the role the acting user held when the row was written, as it read at that moment. Never re-derived, so renaming or re-roling the user does not change it.
1492
+ */
1493
+ entity_user_role_name: string | null;
1494
+ /**
1495
+ * Structured event payload, or null for an event that carries none. The shape follows event_type: status_changed reads as ExpenseStatusChangedEventData, approval_action as ApprovalActionEventData, expense_updated as ExpenseUpdatedEventData, and each remaining type as the Expense<Type>EventData member of the same name, except reopened and canceled, which are plain status transitions and read as ExpenseStatusChangedEventData.
1496
+ */
1497
+ event_data: ExpenseStatusChangedEventData | ApprovalActionEventData | ExpenseUpdatedEventData | ExpenseCreatedEventData | ExpenseSubmittedEventData | ExpenseApprovalRequestedEventData | ExpenseAutoApprovedEventData | ExpenseApprovalsBypassedEventData | ExpenseDeletedEventData | ExpenseReceiptMatchedEventData | ExpenseReceiptUnlinkedEventData | ExpenseAutoCategorizedEventData | ExpensePaymentStatusChangedEventData | null;
1498
+ /**
1499
+ * The type of the event or change.
1500
+ */
1501
+ event_type: string;
1502
+ /**
1503
+ * Whether the row is attributed to an entity user or to no user: 'user' when entity_user_id is set, 'system' when it is null.
1504
+ */
1505
+ recorded_by: 'user' | 'system';
1506
+ /**
1507
+ * When the event occurred.
1508
+ */
1509
+ timestamp: string;
1510
+ transaction_id: string;
1511
+ };
1512
+ type ExpensePaymentStatusChangedEventData = {
1513
+ /**
1514
+ * Payment status after the transition.
1515
+ */
1516
+ new_status: TransactionStatusEnum;
1517
+ /**
1518
+ * Payment status before the transition.
1519
+ */
1520
+ old_status?: TransactionStatusEnum | null;
1521
+ };
1522
+ type ExpenseReceiptMatchedEventData = {
1523
+ /**
1524
+ * Receipt document id, snapshotted for display.
1525
+ */
1526
+ document_id?: string | null;
1527
+ /**
1528
+ * 'user' for a UI-initiated link, 'automatched' otherwise.
1529
+ */
1530
+ link_source: FieldSourceEnum;
1531
+ /**
1532
+ * Merchant name, snapshotted for display.
1533
+ */
1534
+ merchant_name?: string | null;
1535
+ /**
1536
+ * The receipt linked to the expense.
1537
+ */
1538
+ receipt_id: string;
1539
+ };
1540
+ type ExpenseReceiptUnlinkedEventData = {
1541
+ /**
1542
+ * The receipt that was unlinked.
1543
+ */
1544
+ receipt_id: string;
1545
+ };
1546
+ type ExpenseStatusChangedEventData = {
1547
+ approval_policy_id?: string | null;
1548
+ approval_policy_name?: string | null;
1549
+ approval_policy_process_id?: string | null;
1550
+ approval_request_id?: string | null;
1551
+ /**
1552
+ * How the decision was made: 'policy' when driven by an approval policy, otherwise 'force'.
1553
+ */
1554
+ approval_source?: string | null;
1555
+ /**
1556
+ * Legacy action value carried over by the history table migration.
1557
+ */
1558
+ migrated_action?: string | null;
1559
+ /**
1560
+ * The expense status after the transition.
1561
+ */
1562
+ new_status: ExpenseStatusEnum;
1563
+ /**
1564
+ * The expense status before the transition. Null for migrated rows.
1565
+ */
1566
+ old_status?: ExpenseStatusEnum | null;
1567
+ /**
1568
+ * Reason for rejection, if applicable.
1569
+ */
1570
+ reject_reason?: string | null;
1571
+ };
1572
+ type ExpenseStatusEnum = 'new' | 'approve_in_progress' | 'approved' | 'rejected' | 'canceled' | 'deleted';
1573
+ type ExpenseSubmittedEventData = {
1574
+ /**
1575
+ * Whether receipt validation was bypassed.
1576
+ */
1577
+ bypass_receipt_validation: boolean;
1578
+ /**
1579
+ * The expense status after submission.
1580
+ */
1581
+ new_status: ExpenseStatusEnum;
1582
+ /**
1583
+ * Reason given when bypassing receipt validation.
1584
+ */
1585
+ no_receipt_reason?: string | null;
1586
+ /**
1587
+ * The expense status before submission.
1588
+ */
1589
+ old_status: ExpenseStatusEnum;
1590
+ };
1591
+ type ExpenseUpdatedEventData = {
1592
+ fields?: {
1593
+ [key: string]: FieldDiff;
1594
+ };
1595
+ };
1596
+ /**
1597
+ * A detail held for an external bank account.
1598
+ */
1599
+ type ExternalBankAccountDetailDto = 'ROUTING_NUMBER' | 'ACCOUNT_NUMBER' | 'ACCOUNT_TYPE';
1600
+ /**
1601
+ * Response representing an external bank account.
1602
+ */
1603
+ type ExternalBankAccountResponse = {
1604
+ /**
1605
+ * Unique identifier for the external bank account.
1606
+ */
1607
+ id: string;
1608
+ accountHolderType?: null | BankAccountHolderType;
1609
+ /**
1610
+ * Masked account number (last 4 digits visible).
1611
+ */
1612
+ accountNumber: string;
1613
+ /**
1614
+ * Status of the external bank account.
1615
+ */
1616
+ accountStatus: ExternalBankAccountStatusDto;
1617
+ microDepositVerification?: null | MicroDepositVerificationResponse;
1618
+ /**
1619
+ * Name on the bank account.
1620
+ */
1621
+ nameOnAccount: string;
1622
+ /**
1623
+ * Nickname for the external bank account.
1624
+ */
1625
+ nickname: string;
1626
+ /**
1627
+ * Bank routing number (ABA number).
1628
+ */
1629
+ routingNumber: string;
1630
+ suspension?: null | ExternalBankAccountSuspensionResponse;
1631
+ /**
1632
+ * Type of bank account (checking or savings).
1633
+ */
1634
+ type: ExternalBankAccountTypeDto;
1635
+ verificationFailure?: null | ExternalBankAccountVerificationFailureResponse;
1636
+ /**
1637
+ * Verification status of the external bank account. Where the bank fails verification on the
1638
+ * first incorrect attempt, FAILED can be recovered while attempts remain. Where it fails at the
1639
+ * attempt limit, or after a returned micro-deposit or a notification of change, FAILED is final.
1640
+ */
1641
+ verificationStatus: ExternalBankAccountVerificationStatusDto;
1642
+ };
1643
+ type ExternalBankAccountReturnCategoryDto = 'ACCOUNT_CLOSED' | 'INVALID_ACCOUNT_DETAILS' | 'ACCOUNT_CANNOT_RECEIVE' | 'REFUSED_BY_RECEIVER' | 'GENERIC';
1644
+ /**
1645
+ * Status of an external bank account.
1646
+ */
1647
+ type ExternalBankAccountStatusDto = 'ACTIVE' | 'INACTIVE';
1648
+ type ExternalBankAccountSuspensionReasonDto = 'PAYMENT_RETURNED';
1649
+ /**
1650
+ * Why an external bank account may not be sent to or taken from until it is re-verified.
1651
+ */
1652
+ type ExternalBankAccountSuspensionResponse = {
1653
+ reason?: null | ExternalBankAccountSuspensionReasonDto;
1654
+ returnCategory?: null | BankAccountTransferReturnCategoryDto;
1655
+ /**
1656
+ * When the account was suspended.
1657
+ */
1658
+ suspendedAt: string;
1659
+ };
1660
+ /**
1661
+ * Type of external bank account.
1662
+ */
1663
+ type ExternalBankAccountTypeDto = 'CHECKING' | 'SAVINGS';
1664
+ /**
1665
+ * Why an external bank account's verification failed.
1666
+ */
1667
+ type ExternalBankAccountVerificationFailureReasonDto = 'AMOUNTS_DID_NOT_MATCH' | 'MICRO_DEPOSITS_RETURNED' | 'ACCOUNT_DETAILS_INCORRECT';
1668
+ /**
1669
+ * Why an external bank account's verification failed, in terms safe to show a customer. Neither
1670
+ * the ACH return or change code nor any corrected value from the receiving bank is included.
1671
+ */
1672
+ type ExternalBankAccountVerificationFailureResponse = {
1673
+ /**
1674
+ * The details the receiving bank reported as wrong, when reason is ACCOUNT_DETAILS_INCORRECT;
1675
+ * otherwise empty. Re-link the account with these corrected.
1676
+ */
1677
+ incorrectDetails: Array<ExternalBankAccountDetailDto>;
1678
+ /**
1679
+ * Which of the three kinds of failure this was.
1680
+ */
1681
+ reason: ExternalBankAccountVerificationFailureReasonDto;
1682
+ returnCategory?: null | ExternalBankAccountReturnCategoryDto;
1683
+ };
1684
+ /**
1685
+ * Verification status of an external bank account.
1686
+ */
1687
+ type ExternalBankAccountVerificationStatusDto = 'UNVERIFIED' | 'VERIFICATION_SENT' | 'VERIFIED' | 'FAILED';
1688
+ type FieldDiff = {
1689
+ new: unknown | null;
1690
+ new_label?: string | null;
1691
+ old: unknown | null;
1692
+ old_label?: string | null;
1693
+ redacted?: boolean | null;
1694
+ };
1695
+ type FieldSourceEnum = 'user' | 'generated' | 'automatched';
1696
+ type FileResponse = {
1697
+ id: string;
1698
+ created_at: string;
1699
+ updated_at: string;
1700
+ file_type: string;
1701
+ md5: string;
1702
+ mimetype: string;
1703
+ name: string;
1704
+ region: string;
1705
+ s3_bucket: string;
1706
+ s3_file_path: string;
1707
+ size: number;
1708
+ url: string;
1709
+ };
1710
+ /**
1711
+ * Represents a file (such as a PDF invoice) that was uploaded to Monite.
1712
+ */
1713
+ type FileSchema = {
1714
+ /**
1715
+ * A unique ID of this file.
1716
+ */
1717
+ id: string;
1718
+ /**
1719
+ * UTC date and time when this file was uploaded to Monite. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
1720
+ */
1721
+ created_at: string;
1722
+ /**
1723
+ * The type of the business object associated with this file.
1724
+ */
1725
+ file_type: string;
1726
+ /**
1727
+ * The MD5 hash of the file.
1728
+ */
1729
+ md5: string;
1730
+ /**
1731
+ * The file's [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).
1732
+ */
1733
+ mimetype: string;
1734
+ /**
1735
+ * The original file name (if available).
1736
+ */
1737
+ name: string;
1738
+ /**
1739
+ * If the file is a PDF document, this property contains individual pages extracted from the file. Otherwise, an empty array.
1740
+ */
1741
+ pages?: Array<PageSchema> | null;
1742
+ /**
1743
+ * Preview images generated for this file. There can be multiple images with different sizes.
1744
+ */
1745
+ previews?: Array<PreviewSchema> | null;
1746
+ /**
1747
+ * Geographical region of the data center where the file is stored.
1748
+ */
1749
+ region: string;
1750
+ /**
1751
+ * The file size in bytes.
1752
+ */
1753
+ size: number;
1754
+ /**
1755
+ * The URL to download the file.
1756
+ */
1757
+ url: string;
1758
+ };
1759
+ type FileSchema2 = {
1760
+ /**
1761
+ * A unique ID of this file.
1762
+ */
1763
+ id: string;
1764
+ /**
1765
+ * UTC date and time when this file was uploaded to Monite. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
1766
+ */
1767
+ created_at: string;
1768
+ /**
1769
+ * The type of the business object associated with this file.
1770
+ */
1771
+ file_type: string;
1772
+ /**
1773
+ * The MD5 hash of the file.
1774
+ */
1775
+ md5: string;
1776
+ /**
1777
+ * The file's [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types).
1778
+ */
1779
+ mimetype: string;
1780
+ /**
1781
+ * The original file name (if available).
1782
+ */
1783
+ name: string;
1784
+ /**
1785
+ * If the file is a PDF document, this property contains individual pages extracted from the file. Otherwise, an empty array.
1786
+ */
1787
+ pages?: Array<PageSchema2> | null;
1788
+ /**
1789
+ * Preview images generated for this file. There can be multiple images with different sizes.
1790
+ */
1791
+ previews?: Array<PreviewSchema2> | null;
1792
+ /**
1793
+ * Geographical region of the data center where the file is stored.
1794
+ */
1795
+ region: string;
1796
+ /**
1797
+ * The file size in bytes.
1798
+ */
1799
+ size: number;
1800
+ /**
1801
+ * The URL to download the file.
1802
+ */
1803
+ url: string;
1804
+ };
1805
+ type InlineTermDiscount = {
1806
+ /**
1807
+ * The discount percentage in minor units. E.g., 200 means 2%. 1050 means 10.5%.
1808
+ */
1809
+ discount: number;
1810
+ end_date?: string | null;
1811
+ /**
1812
+ * The amount of days after the invoice issue date.
1813
+ */
1814
+ number_of_days?: number | null;
1815
+ };
1816
+ type InlineTermFinal = {
1817
+ end_date?: string | null;
1818
+ /**
1819
+ * The amount of days after the invoice issue date.
1820
+ */
1821
+ number_of_days?: number | null;
1822
+ };
1823
+ type InvoiceRenderingSettings = {
1824
+ /**
1825
+ * If set to `true`, the organization's bank account details will be displayed on the invoice PDF.
1826
+ */
1827
+ display_organization_bank_account?: boolean;
1828
+ };
1829
+ type InvoiceResponsePayload = {
1830
+ id: string;
1831
+ /**
1832
+ * Time at which the receivable was created. Timestamps follow the ISO 8601 standard.
1833
+ */
1834
+ created_at: string;
1835
+ /**
1836
+ * Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard.
1837
+ */
1838
+ updated_at: string;
1839
+ /**
1840
+ * How much is left to be paid in [minor units](https://docs.monite.com/references/currencies#minor-units). Equal 0 if the Invoice is fully paid.
1841
+ */
1842
+ amount_due: number;
1843
+ /**
1844
+ * How much has been paid [minor units](https://docs.monite.com/references/currencies#minor-units)
1845
+ */
1846
+ amount_paid: number;
1847
+ /**
1848
+ * How much is left to be paid in in [minor units](https://docs.monite.com/references/currencies#minor-units), including payment_term discounts.
1849
+ */
1850
+ amount_to_pay?: number | null;
1851
+ /**
1852
+ * List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated.
1853
+ */
1854
+ attachments?: Array<AttachmentResponse> | null;
1855
+ bank_account_id?: string | null;
1856
+ bank_account_snapshot?: BankAccountSnapshot | null;
1857
+ bank_account_type?: string | null;
1858
+ /**
1859
+ * The unique ID of a previous document related to the receivable if applicable.
1860
+ */
1861
+ based_on?: string | null;
1862
+ /**
1863
+ * The unique document ID of a previous document related to the receivable if applicable.
1864
+ */
1865
+ based_on_document_id?: string | null;
1866
+ /**
1867
+ * Field with a comment for pay/partially/uncollectible info on this Invoice
1868
+ */
1869
+ comment?: string | null;
1870
+ /**
1871
+ * The commercial terms of the receivable (e.g. The products must be delivered in X days).
1872
+ */
1873
+ commercial_condition_description?: string | null;
1874
+ /**
1875
+ * Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company.
1876
+ */
1877
+ counterpart_billing_address?: ReceivablesRepresentationOfCounterpartAddress | null;
1878
+ /**
1879
+ * Different types of companies for different countries, ex. GmbH, SAS, SNC, etc.
1880
+ */
1881
+ counterpart_business_type?: string | null;
1882
+ /**
1883
+ * Additional information about counterpart contacts.
1884
+ */
1885
+ counterpart_contact?: ReceivableCounterpartContact | null;
1886
+ /**
1887
+ * The external reference of the counterpart.
1888
+ */
1889
+ counterpart_external_reference?: string | null;
1890
+ /**
1891
+ * Unique ID of the counterpart.
1892
+ */
1893
+ counterpart_id: string;
1894
+ /**
1895
+ * A legal name of a counterpart it is an organization or first and last name if it is an individual
1896
+ */
1897
+ counterpart_name?: string | null;
1898
+ /**
1899
+ * Address where goods were shipped / where services were provided.
1900
+ */
1901
+ counterpart_shipping_address?: ReceivablesRepresentationOfCounterpartAddress | null;
1902
+ /**
1903
+ * The VAT/TAX ID of the counterpart.
1904
+ */
1905
+ counterpart_tax_id?: string | null;
1906
+ /**
1907
+ * The type of the counterpart.
1908
+ */
1909
+ counterpart_type: CounterpartType;
1910
+ counterpart_vat_id?: ReceivableCounterpartVatIdResponse | null;
1911
+ /**
1912
+ * The currency used in the receivable.
1913
+ */
1914
+ currency: CurrencyEnum;
1915
+ /**
1916
+ * The amount of tax deducted in minor units
1917
+ *
1918
+ * @deprecated
1919
+ */
1920
+ deduction_amount?: number | null;
1921
+ /**
1922
+ * A note with additional information about a tax deduction
1923
+ *
1924
+ * @deprecated
1925
+ */
1926
+ deduction_memo?: string | null;
1927
+ /**
1928
+ * List of deductions applied to the receivable (maximum 10 deductions allowed)
1929
+ */
1930
+ deductions?: Array<DeductionItem> | null;
1931
+ /**
1932
+ * The discount for a receivable.
1933
+ */
1934
+ discount?: DiscountResponse | null;
1935
+ /**
1936
+ * Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units).
1937
+ */
1938
+ discounted_subtotal?: number | null;
1939
+ /**
1940
+ * The sequential code systematically assigned to invoices.
1941
+ */
1942
+ document_id?: string | null;
1943
+ /**
1944
+ * Settings for rendering documents in PDF format, including settings for line items and specific document types.
1945
+ */
1946
+ document_rendering?: DocumentRenderingSettings | null;
1947
+ /**
1948
+ * Optional field representing date until which invoice should be paid
1949
+ */
1950
+ due_date?: string | null;
1951
+ entity: ReceivableEntityOrganization | ReceivableEntityIndividual;
1952
+ entity_address: ReceivableEntityAddressSchema;
1953
+ /**
1954
+ * Deprecated. Always null; use `bank_account_snapshot` instead.
1955
+ *
1956
+ * @deprecated
1957
+ */
1958
+ entity_bank_account?: ReceivablesRepresentationOfEntityBankAccount | null;
1959
+ /**
1960
+ * The entity user who created this document.
1961
+ */
1962
+ entity_user_id?: string | null;
1963
+ entity_vat_id?: ReceivableEntityVatIdResponse | null;
1964
+ /**
1965
+ * The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated.
1966
+ */
1967
+ file_language: LanguageCodeEnum;
1968
+ /**
1969
+ * The receivable's PDF URL in the counterpart's default language.
1970
+ */
1971
+ file_url?: string | null;
1972
+ /**
1973
+ * Optional text displayed below the line items table in the PDF.
1974
+ */
1975
+ footer?: string | null;
1976
+ /**
1977
+ * The date when the goods are shipped or the service is provided. Can be a current, past, or future date.
1978
+ *
1979
+ * Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued.
1980
+ *
1981
+ * In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.
1982
+ */
1983
+ fulfillment_date?: string | null;
1984
+ /**
1985
+ * Optional field for the issue of the entry.
1986
+ */
1987
+ issue_date?: string | null;
1988
+ line_items: Array<ResponseItem>;
1989
+ /**
1990
+ * A note with additional information for a receivable.
1991
+ */
1992
+ memo?: string | null;
1993
+ /**
1994
+ * The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated.
1995
+ */
1996
+ original_file_language: LanguageCodeEnum;
1997
+ /**
1998
+ * The receivable's PDF URL in the entity's default language.
1999
+ */
2000
+ original_file_url?: string | null;
2001
+ overdue_reminder_id?: string | null;
2002
+ /**
2003
+ * Date and time when the invoice was paid.
2004
+ */
2005
+ paid_at?: string | null;
2006
+ /**
2007
+ * Metadata for partner needs
2008
+ */
2009
+ partner_metadata?: {
2010
+ [key: string]: unknown;
2011
+ };
2012
+ /**
2013
+ * Link to the invoice's payment page. Either Monite's payment links or your custom payment links.
2014
+ */
2015
+ payment_page_url?: string | null;
2016
+ payment_reminder_id?: string | null;
2017
+ payment_terms?: PaymentTerms | null;
2018
+ /**
2019
+ * A project related to current receivable
2020
+ */
2021
+ project_id?: string | null;
2022
+ /**
2023
+ * Contain purchase order number.
2024
+ */
2025
+ purchase_order?: string | null;
2026
+ /**
2027
+ * Stores an unique ID of a recurrence if the receivable is in a recurring status
2028
+ */
2029
+ recurrence_id?: string | null;
2030
+ /**
2031
+ * Ids of documents that relate to invoice. I.e credit notes, proforma invoices, etc.
2032
+ */
2033
+ related_documents: RelatedDocuments;
2034
+ /**
2035
+ * The status of the receivable inside the receivable workflow.
2036
+ */
2037
+ status: ReceivablesStatusEnum;
2038
+ /**
2039
+ * The subtotal (excluding tax), in [minor units](https://docs.monite.com/references/currencies#minor-units).
2040
+ */
2041
+ subtotal?: number | null;
2042
+ /**
2043
+ * The subtotal including tax but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units).
2044
+ */
2045
+ subtotal_after_tax?: number | null;
2046
+ /**
2047
+ * The list of tags for this receivable.
2048
+ */
2049
+ tags?: Array<TagReadSchema>;
2050
+ /**
2051
+ * Indicates whether the goods, materials, or services listed in the receivable are exempt from tax or not.
2052
+ */
2053
+ tax_exempt?: boolean | null;
2054
+ /**
2055
+ * The reason for the tax exemption, if applicable.
2056
+ */
2057
+ tax_exemption_rationale?: string | null;
2058
+ /**
2059
+ * Indicates whether the discount is applied to the tax-inclusive or tax-exclusive amount.
2060
+ */
2061
+ tax_inclusive_discount_mode?: VatModeEnum;
2062
+ /**
2063
+ * Defines whether the prices of products in receivable will already include tax or not.
2064
+ */
2065
+ tax_mode?: VatModeEnum;
2066
+ /**
2067
+ * Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_tax_amount.
2068
+ */
2069
+ total_amount?: number;
2070
+ /**
2071
+ * The total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units), including tax and excluding all issued credit notes.
2072
+ */
2073
+ total_amount_with_credit_notes: number;
2074
+ /**
2075
+ * The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units).
2076
+ */
2077
+ total_deduction_amount?: number | null;
2078
+ /**
2079
+ * The total tax of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units).
2080
+ */
2081
+ total_tax_amount: number;
2082
+ /**
2083
+ * List of total tax amount for each tax rate, presented in receivable
2084
+ */
2085
+ total_tax_amounts?: Array<TotalTaxAmountItem> | null;
2086
+ /**
2087
+ * Total price of the receivable with tax withheld in minor units
2088
+ */
2089
+ total_withholding_tax?: number | null;
2090
+ /**
2091
+ * Trade name of the entity
2092
+ */
2093
+ trade_name?: string | null;
2094
+ /**
2095
+ * The type of the document uploaded.
2096
+ */
2097
+ type: 'invoice';
2098
+ /**
2099
+ * The amount of tax withheld in percent minor units
2100
+ */
2101
+ withholding_tax_rate?: number | null;
2102
+ };
2103
+ /**
2104
+ * Contains information about a text block or line extracted from an uploaded document by OCR.
2105
+ */
2106
+ type Item = {
2107
+ /**
2108
+ * OCR confidence score - the estimated accuracy percentage of character recognition of the extracted text, from 0 to 100%.
2109
+ */
2110
+ confidence: number;
2111
+ /**
2112
+ * If the `text` value is identified as a currency amount or a date, `processed_text` contains this value converted to a common format:
2113
+ *
2114
+ * * Currency amounts (such as the total, subtotal, tax/VAT, line item prices) are converted to numbers with the currency character removed. For example, "$1,125.00" becomes 1125.0.* Dates are converted to the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format, `YYYY-MM-DDThh:mm:ss`. For example, "26/3/2021" becomes "2021-03-26T00:00:00".
2115
+ *
2116
+ * If `text` is not a currency amount or a date, `processed_text` is `null`.
2117
+ */
2118
+ processed_text: unknown;
2119
+ /**
2120
+ * The text as recognized by OCR.
2121
+ */
2122
+ text: string;
2123
+ };
2124
+ type KycVerificationStatusDto = 'PENDING' | 'MANUAL_REVIEW' | 'APPROVED' | 'DENIED' | 'DOCUMENT_VERIFICATION_REQUIRED';
2125
+ /**
2126
+ * A label-value pair extracted from an uploaded document by OCR.
2127
+ * For example, the label could be "Total" and the value could be a currency amount.
2128
+ */
2129
+ type LabelNValue = {
2130
+ /**
2131
+ * Text label.
2132
+ */
2133
+ label: Item;
2134
+ /**
2135
+ * The value (if any).
2136
+ */
2137
+ value: Item;
2138
+ };
2139
+ type LanguageCodeEnum = 'ab' | 'aa' | 'af' | 'ak' | 'sq' | 'am' | 'ar' | 'an' | 'hy' | 'av' | 'ae' | 'ay' | 'az' | 'bm' | 'ba' | 'eu' | 'be' | 'bn' | 'bi' | 'bs' | 'br' | 'bg' | 'my' | 'ca' | 'ch' | 'ce' | 'ny' | 'zh' | 'cu' | 'cv' | 'kw' | 'co' | 'cr' | 'hr' | 'cs' | 'da' | 'dv' | 'nl' | 'dz' | 'en' | 'eo' | 'et' | 'ee' | 'fo' | 'fj' | 'fi' | 'fr' | 'fy' | 'ff' | 'gd' | 'gl' | 'lg' | 'ka' | 'de' | 'el' | 'kl' | 'gn' | 'gu' | 'ht' | 'ha' | 'he' | 'hz' | 'hi' | 'ho' | 'hu' | 'io' | 'ig' | 'id' | 'ia' | 'ie' | 'iu' | 'ik' | 'ga' | 'it' | 'ja' | 'jv' | 'kn' | 'kr' | 'ks' | 'kk' | 'km' | 'ki' | 'rw' | 'ky' | 'kv' | 'kg' | 'ko' | 'kj' | 'ku' | 'lo' | 'la' | 'lv' | 'li' | 'ln' | 'lt' | 'lu' | 'lb' | 'mk' | 'mg' | 'ms' | 'ml' | 'mt' | 'gv' | 'mi' | 'mr' | 'mh' | 'mn' | 'na' | 'nv' | 'nd' | 'nr' | 'ng' | 'ne' | 'no' | 'nb' | 'nn' | 'ii' | 'oc' | 'oj' | 'om' | 'os' | 'pi' | 'ps' | 'fa' | 'pl' | 'pt' | 'pa' | 'qu' | 'ro' | 'rm' | 'rn' | 'ru' | 'se' | 'sm' | 'sg' | 'sa' | 'sc' | 'sr' | 'sn' | 'sd' | 'si' | 'sk' | 'sl' | 'so' | 'st' | 'es' | 'su' | 'sw' | 'ss' | 'sv' | 'tl' | 'ty' | 'tg' | 'ta' | 'tt' | 'te' | 'th' | 'bo' | 'ti' | 'to' | 'ts' | 'tn' | 'tr' | 'tk' | 'tw' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'cy' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zu';
2140
+ /**
2141
+ * Represents a general ledger account retrieved from an accounting system.
2142
+ */
2143
+ type LedgerAccountResponse = {
2144
+ /**
2145
+ * A unique identifier of the ledger account.
2146
+ */
2147
+ id: string;
2148
+ /**
2149
+ * The timestamp when the ledger account was created.
2150
+ */
2151
+ created_at: string;
2152
+ /**
2153
+ * The timestamp when the ledger account was last updated.
2154
+ */
2155
+ updated_at: string;
2156
+ /**
2157
+ * The currency of the ledger account, specified as a three-letter [currency code](https://docs.monite.com/references/currencies) (ISO 4217).
2158
+ */
2159
+ currency?: CurrencyEnum | null;
2160
+ /**
2161
+ * The current balance in the account.
2162
+ */
2163
+ current_balance?: number | null;
2164
+ /**
2165
+ * User-defined description of the ledger account.
2166
+ */
2167
+ description?: string | null;
2168
+ /**
2169
+ * Indicates whether this ledger account represents a bank account.
2170
+ */
2171
+ is_bank_account: boolean;
2172
+ /**
2173
+ * Whether the ledger account is from an external system
2174
+ */
2175
+ is_external?: boolean;
2176
+ /**
2177
+ * A user-defined name of the ledger account. Examples: Accounts Receivable, Office Equipment, Advertising, Salaries.
2178
+ */
2179
+ name?: string | null;
2180
+ /**
2181
+ * The account code in the accounting system.
2182
+ */
2183
+ nominal_code?: string | null;
2184
+ /**
2185
+ * The status of the ledger account. Possible values: Active, Archived, Pending, Unknown.
2186
+ */
2187
+ status: string;
2188
+ /**
2189
+ * The subtype or category of the ledger account. Possible values vary based on the accounting system used. Examples: Current, Fixed, Expense, Inventory, Equity.
2190
+ */
2191
+ subtype?: string | null;
2192
+ /**
2193
+ * The type of the ledger account. It determines whether the account is a credit account or a debit account and where it appears in financial reports within the accounting system. Possible values: Asset, Equity, Expense, Income, Liability, Unknown.
2194
+ */
2195
+ type: string;
2196
+ };
2197
+ type LineItemColumnSettings = {
2198
+ display?: boolean;
2199
+ /**
2200
+ * Line item table column header to override Monite's default. If not set, the Monite's default will be used.
2201
+ */
2202
+ label?: string | null;
2203
+ };
2204
+ /**
2205
+ * Extended settings for numeric columns in line items.
2206
+ */
2207
+ type LineItemNumericColumnSettings = {
2208
+ display?: boolean;
2209
+ /**
2210
+ * Line item table column header to override Monite's default. If not set, the Monite's default will be used.
2211
+ */
2212
+ label?: string | null;
2213
+ /**
2214
+ * Number of decimal places to display for numeric values in this column.
2215
+ */
2216
+ precision?: number | null;
2217
+ };
2218
+ type LineItemProduct = {
2219
+ /**
2220
+ * Unique ID of the product.
2221
+ */
2222
+ id: string;
2223
+ /**
2224
+ * Unique identifier of the accounting tax rate object.
2225
+ */
2226
+ accounting_tax_rate_id?: string | null;
2227
+ /**
2228
+ * Description of the product.
2229
+ */
2230
+ description?: string | null;
2231
+ /**
2232
+ * A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog.
2233
+ */
2234
+ external_reference?: string | null;
2235
+ /**
2236
+ * Indicates whether the product is inline
2237
+ */
2238
+ is_inline?: boolean;
2239
+ ledger_account_id?: string | null;
2240
+ measure_unit?: LineItemProductMeasureUnit | null;
2241
+ /**
2242
+ * Name of the product.
2243
+ */
2244
+ name: string;
2245
+ price: Price;
2246
+ price_after_tax: Price;
2247
+ /**
2248
+ * The smallest amount allowed for this product.
2249
+ */
2250
+ smallest_amount?: number | null;
2251
+ tax_rate: LineItemProductTaxRate;
2252
+ /**
2253
+ * Specifies whether this offering is a product or service. This may affect the applicable tax rates.
2254
+ */
2255
+ type?: ProductServiceTypeEnum;
2256
+ };
2257
+ type LineItemProductMeasureUnit = {
2258
+ id?: string | null;
2259
+ description?: string | null;
2260
+ name: string;
2261
+ };
2262
+ type LineItemProductTaxRate = {
2263
+ /**
2264
+ * Unique identifier of the tax rate object.
2265
+ */
2266
+ id?: string | null;
2267
+ /**
2268
+ * Sub-taxes included in the VAT.
2269
+ */
2270
+ components?: Array<VatRateComponent> | null;
2271
+ /**
2272
+ * Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2273
+ */
2274
+ country: AllowedCountries;
2275
+ /**
2276
+ * Indicates whether this tax rate is defined by user.
2277
+ */
2278
+ is_custom?: boolean;
2279
+ /**
2280
+ * Display name of the tax rate.
2281
+ */
2282
+ name?: string | null;
2283
+ /**
2284
+ * Percent minor units. Example: 12.5% is 1250.
2285
+ */
2286
+ value: number;
2287
+ };
2288
+ type LineItemsRenderingSettings = {
2289
+ /**
2290
+ * Settings for the discount column in the line items table.
2291
+ */
2292
+ discount?: LineItemColumnSettings;
2293
+ /**
2294
+ * Settings for the measure unit column in the line items table.
2295
+ */
2296
+ measure_unit?: LineItemColumnSettings;
2297
+ /**
2298
+ * Settings for the name column in the line items table.
2299
+ */
2300
+ name?: LineItemColumnSettings;
2301
+ /**
2302
+ * Settings for the price column in the line items table.
2303
+ */
2304
+ price?: LineItemNumericColumnSettings;
2305
+ /**
2306
+ * Settings for the price after tax column in the line items table.
2307
+ */
2308
+ price_after_tax?: LineItemNumericColumnSettings;
2309
+ /**
2310
+ * Settings for the quantity column in the line items table.
2311
+ */
2312
+ quantity?: LineItemColumnSettings;
2313
+ /**
2314
+ * Settings for the tax rate column in the line items table.
2315
+ */
2316
+ tax_rate?: LineItemNumericColumnSettings;
2317
+ /**
2318
+ * Settings for the total price column in the line items table.
2319
+ */
2320
+ total_price?: LineItemNumericColumnSettings;
2321
+ /**
2322
+ * Settings for the total price after tax column in the line items table.
2323
+ */
2324
+ total_price_after_tax?: LineItemNumericColumnSettings;
2325
+ /**
2326
+ * Settings for the VAT amount column in the line items table.
2327
+ */
2328
+ vat_amount?: LineItemNumericColumnSettings;
2329
+ };
2330
+ type LocationListItem = {
2331
+ id: string;
2332
+ createdDateTime: string;
2333
+ memberCount: number | string;
2334
+ name: string;
2335
+ updatedDateTime: string;
2336
+ };
2337
+ /**
2338
+ * Contains information about a sent email.
2339
+ */
2340
+ type MailSentEventData = {
2341
+ /**
2342
+ * ID of the email sending operation. Can be used to get the email sending status from `GET /receivables/{receivable_id}/mails/{mail_id}`.
2343
+ */
2344
+ mail_id: string;
2345
+ /**
2346
+ * The overall email sending status across all recipients.
2347
+ */
2348
+ mail_status: ReceivableMailStatusEnum;
2349
+ /**
2350
+ * Contains a list of email recipients (To, CC, BCC) and the email sending status for each recipient.
2351
+ */
2352
+ recipients: ReceivableMailRecipients;
2353
+ };
2354
+ type MailboxResponse = {
2355
+ /**
2356
+ * Mailbox UUID
2357
+ */
2358
+ id: string;
2359
+ mailbox_domain_id: string | null;
2360
+ mailbox_full_address: string;
2361
+ mailbox_name: string;
2362
+ related_object_type: string;
2363
+ status: string;
2364
+ };
2365
+ /**
2366
+ * A caller-managed Merchant Category Code group applied as an authorization control at the debit
2367
+ * card issuer. Exactly one of Guid? MccGroupResponse.OrganizationId (organization-scoped) or
2368
+ * Guid? MccGroupResponse.CardId (card-scoped) is set.
2369
+ */
2370
+ type MccGroupResponse = {
2371
+ id: string;
2372
+ active: boolean;
2373
+ cardId?: null | string;
2374
+ createdAt: string;
2375
+ mccs: Array<string>;
2376
+ name: string;
2377
+ organizationId?: null | string;
2378
+ updatedAt: string;
2379
+ };
2380
+ /**
2381
+ * Whether submitted micro-deposit amounts matched the ones deposited.
2382
+ */
2383
+ type MicroDepositVerificationOutcomeDto = 'AMOUNTS_MATCHED' | 'AMOUNTS_DID_NOT_MATCH';
2384
+ /**
2385
+ * The outcome of a micro-deposit validation attempt and what is left of the bank's allowance.
2386
+ */
2387
+ type MicroDepositVerificationResponse = {
2388
+ /**
2389
+ * The maximum number of validation attempts this account's bank allows.
2390
+ */
2391
+ attemptsAllowed: number | string;
2392
+ /**
2393
+ * Validation attempts left after this one.
2394
+ */
2395
+ attemptsRemaining: number | string;
2396
+ /**
2397
+ * Whether another set of amounts would be accepted for this account.
2398
+ */
2399
+ canAttemptAgain: boolean;
2400
+ /**
2401
+ * Whether the bank's policy makes FAILED final. Banks that fail on the first incorrect attempt
2402
+ * always report false; canAttemptAgain reports whether the allowance is spent.
2403
+ */
2404
+ isTerminal: boolean;
2405
+ /**
2406
+ * Whether the submitted amounts matched the ones deposited.
2407
+ */
2408
+ outcome: MicroDepositVerificationOutcomeDto;
2409
+ };
2410
+ /**
2411
+ * Response model for a money movement operation.
2412
+ */
2413
+ type MoneyMovementResponse = {
2414
+ /**
2415
+ * Unique money movement identifier.
2416
+ */
2417
+ id: string;
2418
+ /**
2419
+ * Money movement amount.
2420
+ */
2421
+ amount: AmountOutput;
2422
+ /**
2423
+ * Money movement date.
2424
+ */
2425
+ date: string;
2426
+ /**
2427
+ * Source bank account information.
2428
+ */
2429
+ fromBankAccount: BankAccountInfo;
2430
+ /**
2431
+ * Payment network: BOOK, ACH, RTP, or FED_NOW.
2432
+ */
2433
+ network: BankAccountTransferNetworkTypeDto;
2434
+ /**
2435
+ * The caller-supplied reference from the request, echoed back unchanged.
2436
+ * Null when the request omitted one.
2437
+ */
2438
+ reference?: null | string;
2439
+ /**
2440
+ * Money movement status.
2441
+ */
2442
+ status: BankAccountTransferStatusDto;
2443
+ /**
2444
+ * Destination bank account information.
2445
+ */
2446
+ toBankAccount: BankAccountInfo;
2447
+ };
2448
+ type NorthAmericanIndustryClassificationSystemCode = 'SOYBEAN_FARMING' | 'OILSEED_EXCEPT_SOYBEAN_FARMING' | 'DRY_PEA_AND_BEAN_FARMING' | 'WHEAT_FARMING' | 'CORN_FARMING' | 'RICE_FARMING' | 'OILSEED_AND_GRAIN_COMBINATION_FARMING' | 'ALL_OTHER_GRAIN_FARMING' | 'POTATO_FARMING' | 'OTHER_VEGETABLE_EXCEPT_POTATO_AND_MELON_FARMING' | 'ORANGE_GROVES' | 'CITRUS_EXCEPT_ORANGE_GROVES' | 'APPLE_ORCHARDS' | 'GRAPE_VINEYARDS' | 'STRAWBERRY_FARMING' | 'BERRY_EXCEPT_STRAWBERRY_FARMING' | 'TREE_NUT_FARMING' | 'FRUIT_AND_TREE_NUT_COMBINATION_FARMING' | 'OTHER_NONCITRUS_FRUIT_FARMING' | 'MUSHROOM_PRODUCTION' | 'OTHER_FOOD_CROPS_GROWN_UNDER_COVER' | 'NURSERY_AND_TREE_PRODUCTION' | 'FLORICULTURE_PRODUCTION' | 'TOBACCO_FARMING' | 'COTTON_FARMING' | 'SUGARCANE_FARMING' | 'HAY_FARMING' | 'SUGAR_BEET_FARMING' | 'PEANUT_FARMING' | 'ALL_OTHER_MISCELLANEOUS_CROP_FARMING' | 'BEEF_CATTLE_RANCHING_AND_FARMING' | 'CATTLE_FEEDLOTS' | 'DAIRY_CATTLE_AND_MILK_PRODUCTION' | 'DUAL_PURPOSE_CATTLE_RANCHING_AND_FARMING' | 'HOG_AND_PIG_FARMING' | 'CHICKEN_EGG_PRODUCTION' | 'BROILERS_AND_OTHER_MEAT_TYPE_CHICKEN_PRODUCTION' | 'TURKEY_PRODUCTION' | 'POULTRY_HATCHERIES' | 'OTHER_POULTRY_PRODUCTION' | 'SHEEP_FARMING' | 'GOAT_FARMING' | 'FINFISH_FARMING_AND_FISH_HATCHERIES' | 'SHELLFISH_FARMING' | 'OTHER_AQUACULTURE' | 'APICULTURE' | 'HORSES_AND_OTHER_EQUINE_PRODUCTION' | 'FUR_BEARING_ANIMAL_AND_RABBIT_PRODUCTION' | 'ALL_OTHER_ANIMAL_PRODUCTION' | 'TIMBER_TRACT_OPERATIONS' | 'FOREST_NURSERIES_AND_GATHERING_OF_FOREST_PRODUCTS' | 'LOGGING' | 'FINFISH_FISHING' | 'SHELLFISH_FISHING' | 'OTHER_MARINE_FISHING' | 'HUNTING_AND_TRAPPING' | 'COTTON_GINNING' | 'SOIL_PREPARATION_PLANTING_AND_CULTIVATING' | 'CROP_HARVESTING_PRIMARILY_BY_MACHINE' | 'POSTHARVEST_CROP_ACTIVITIES_EXCEPT_COTTON_GINNING' | 'FARM_LABOR_CONTRACTORS_AND_CREW_LEADERS' | 'FARM_MANAGEMENT_SERVICES' | 'SUPPORT_ACTIVITIES_FOR_ANIMAL_PRODUCTION' | 'SUPPORT_ACTIVITIES_FOR_FORESTRY' | 'CRUDE_PETROLEUM_EXTRACTION' | 'NATURAL_GAS_EXTRACTION' | 'SURFACE_COAL_MINING' | 'UNDERGROUND_COAL_MINING' | 'IRON_ORE_MINING' | 'GOLD_ORE_AND_SILVER_ORE_MINING' | 'COPPER_NICKEL_LEAD_AND_ZINC_MINING' | 'OTHER_METAL_ORE_MINING' | 'DIMENSION_STONE_MINING_AND_QUARRYING' | 'CRUSHED_AND_BROKEN_LIMESTONE_MINING_AND_QUARRYING' | 'CRUSHED_AND_BROKEN_GRANITE_MINING_AND_QUARRYING' | 'OTHER_CRUSHED_AND_BROKEN_STONE_MINING_AND_QUARRYING' | 'CONSTRUCTION_SAND_AND_GRAVEL_MINING' | 'INDUSTRIAL_SAND_MINING' | 'KAOLIN_CLAY_AND_CERAMIC_AND_REFRACTORY_MINERALS_MINING' | 'OTHER_NONMETALLIC_MINERAL_MINING_AND_QUARRYING' | 'DRILLING_OIL_AND_GAS_WELLS' | 'SUPPORT_ACTIVITIES_FOR_OIL_AND_GAS_OPERATIONS' | 'SUPPORT_ACTIVITIES_FOR_COAL_MINING' | 'SUPPORT_ACTIVITIES_FOR_METAL_MINING' | 'SUPPORT_ACTIVITIES_FOR_NONMETALLIC_MINERALS_EXCEPT_FUELS_MINING' | 'HYDROELECTRIC_POWER_GENERATION' | 'FOSSIL_FUEL_ELECTRIC_POWER_GENERATION' | 'NUCLEAR_ELECTRIC_POWER_GENERATION' | 'SOLAR_ELECTRIC_POWER_GENERATION' | 'WIND_ELECTRIC_POWER_GENERATION' | 'GEOTHERMAL_ELECTRIC_POWER_GENERATION' | 'BIOMASS_ELECTRIC_POWER_GENERATION' | 'OTHER_ELECTRIC_POWER_GENERATION' | 'ELECTRIC_BULK_POWER_TRANSMISSION_AND_CONTROL' | 'ELECTRIC_POWER_DISTRIBUTION' | 'NATURAL_GAS_DISTRIBUTION' | 'WATER_SUPPLY_AND_IRRIGATION_SYSTEMS' | 'SEWAGE_TREATMENT_FACILITIES' | 'STEAM_AND_AIR_CONDITIONING_SUPPLY' | 'NEW_SINGLE_FAMILY_HOUSING_CONSTRUCTION_EXCEPT_FOR_SALE_BUILDERS' | 'NEW_MULTIFAMILY_HOUSING_CONSTRUCTION_EXCEPT_FOR_SALE_BUILDERS' | 'NEW_HOUSING_FOR_SALE_BUILDERS' | 'RESIDENTIAL_REMODELERS' | 'INDUSTRIAL_BUILDING_CONSTRUCTION' | 'COMMERCIAL_AND_INSTITUTIONAL_BUILDING_CONSTRUCTION' | 'WATER_AND_SEWER_LINE_AND_RELATED_STRUCTURES_CONSTRUCTION' | 'OIL_AND_GAS_PIPELINE_AND_RELATED_STRUCTURES_CONSTRUCTION' | 'POWER_AND_COMMUNICATION_LINE_AND_RELATED_STRUCTURES_CONSTRUCTION' | 'LAND_SUBDIVISION' | 'HIGHWAY_STREET_AND_BRIDGE_CONSTRUCTION' | 'OTHER_HEAVY_AND_CIVIL_ENGINEERING_CONSTRUCTION' | 'POURED_CONCRETE_FOUNDATION_AND_STRUCTURE_CONTRACTORS' | 'STRUCTURAL_STEEL_AND_PRECAST_CONCRETE_CONTRACTORS' | 'FRAMING_CONTRACTORS' | 'MASONRY_CONTRACTORS' | 'GLASS_AND_GLAZING_CONTRACTORS' | 'ROOFING_CONTRACTORS' | 'SIDING_CONTRACTORS' | 'OTHER_FOUNDATION_STRUCTURE_AND_BUILDING_EXTERIOR_CONTRACTORS' | 'ELECTRICAL_CONTRACTORS_AND_OTHER_WIRING_INSTALLATION_CONTRACTORS' | 'PLUMBING_HEATING_AND_AIR_CONDITIONING_CONTRACTORS' | 'OTHER_BUILDING_EQUIPMENT_CONTRACTORS' | 'DRYWALL_AND_INSULATION_CONTRACTORS' | 'PAINTING_AND_WALL_COVERING_CONTRACTORS' | 'FLOORING_CONTRACTORS' | 'TILE_AND_TERRAZZO_CONTRACTORS' | 'FINISH_CARPENTRY_CONTRACTORS' | 'OTHER_BUILDING_FINISHING_CONTRACTORS' | 'SITE_PREPARATION_CONTRACTORS' | 'ALL_OTHER_SPECIALTY_TRADE_CONTRACTORS' | 'DOG_AND_CAT_FOOD_MANUFACTURING' | 'OTHER_ANIMAL_FOOD_MANUFACTURING' | 'FLOUR_MILLING' | 'RICE_MILLING' | 'MALT_MANUFACTURING' | 'WET_CORN_MILLING_AND_STARCH_MANUFACTURING' | 'SOYBEAN_AND_OTHER_OILSEED_PROCESSING' | 'FATS_AND_OILS_REFINING_AND_BLENDING' | 'BREAKFAST_CEREAL_MANUFACTURING' | 'BEET_SUGAR_MANUFACTURING' | 'CANE_SUGAR_MANUFACTURING' | 'NONCHOCOLATE_CONFECTIONERY_MANUFACTURING' | 'CHOCOLATE_AND_CONFECTIONERY_MANUFACTURING_FROM_CACAO_BEANS' | 'CONFECTIONERY_MANUFACTURING_FROM_PURCHASED_CHOCOLATE' | 'FROZEN_FRUIT_JUICE_AND_VEGETABLE_MANUFACTURING' | 'FROZEN_SPECIALTY_FOOD_MANUFACTURING' | 'FRUIT_AND_VEGETABLE_CANNING' | 'SPECIALTY_CANNING' | 'DRIED_AND_DEHYDRATED_FOOD_MANUFACTURING' | 'FLUID_MILK_MANUFACTURING' | 'CREAMERY_BUTTER_MANUFACTURING' | 'CHEESE_MANUFACTURING' | 'DRY_CONDENSED_AND_EVAPORATED_DAIRY_PRODUCT_MANUFACTURING' | 'ICE_CREAM_AND_FROZEN_DESSERT_MANUFACTURING' | 'ANIMAL_EXCEPT_POULTRY_SLAUGHTERING' | 'MEAT_PROCESSED_FROM_CARCASSES' | 'RENDERING_AND_MEAT_BYPRODUCT_PROCESSING' | 'POULTRY_PROCESSING' | 'SEAFOOD_PRODUCT_PREPARATION_AND_PACKAGING' | 'RETAIL_BAKERIES' | 'COMMERCIAL_BAKERIES' | 'FROZEN_CAKES_PIES_AND_OTHER_PASTRIES_MANUFACTURING' | 'COOKIE_AND_CRACKER_MANUFACTURING' | 'DRY_PASTA_DOUGH_AND_FLOUR_MIXES_MANUFACTURING_FROM_PURCHASED_FLOUR' | 'TORTILLA_MANUFACTURING' | 'ROASTED_NUTS_AND_PEANUT_BUTTER_MANUFACTURING' | 'OTHER_SNACK_FOOD_MANUFACTURING' | 'COFFEE_AND_TEA_MANUFACTURING' | 'FLAVORING_SYRUP_AND_CONCENTRATE_MANUFACTURING' | 'MAYONNAISE_DRESSING_AND_OTHER_PREPARED_SAUCE_MANUFACTURING' | 'SPICE_AND_EXTRACT_MANUFACTURING' | 'PERISHABLE_PREPARED_FOOD_MANUFACTURING' | 'ALL_OTHER_MISCELLANEOUS_FOOD_MANUFACTURING' | 'SOFT_DRINK_MANUFACTURING' | 'BOTTLED_WATER_MANUFACTURING' | 'ICE_MANUFACTURING' | 'BREWERIES' | 'WINERIES' | 'DISTILLERIES' | 'TOBACCO_MANUFACTURING' | 'FIBER_YARN_AND_THREAD_MILLS' | 'BROADWOVEN_FABRIC_MILLS' | 'NARROW_FABRIC_MILLS_AND_SCHIFFLI_MACHINE_EMBROIDERY' | 'NONWOVEN_FABRIC_MILLS' | 'KNIT_FABRIC_MILLS' | 'TEXTILE_AND_FABRIC_FINISHING_MILLS' | 'FABRIC_COATING_MILLS' | 'CARPET_AND_RUG_MILLS' | 'CURTAIN_AND_LINEN_MILLS' | 'TEXTILE_BAG_AND_CANVAS_MILLS' | 'ROPE_CORDAGE_TWINE_TIRE_CORD_AND_TIRE_FABRIC_MILLS' | 'ALL_OTHER_MISCELLANEOUS_TEXTILE_PRODUCT_MILLS' | 'APPAREL_KNITTING_MILLS' | 'CUT_AND_SEW_APPAREL_CONTRACTORS' | 'CUT_AND_SEW_APPAREL_MANUFACTURING_EXCEPT_CONTRACTORS' | 'APPAREL_ACCESSORIES_AND_OTHER_APPAREL_MANUFACTURING' | 'LEATHER_AND_HIDE_TANNING_AND_FINISHING' | 'FOOTWEAR_MANUFACTURING' | 'OTHER_LEATHER_AND_ALLIED_PRODUCT_MANUFACTURING' | 'SAWMILLS' | 'WOOD_PRESERVATION' | 'HARDWOOD_VENEER_AND_PLYWOOD_MANUFACTURING' | 'SOFTWOOD_VENEER_AND_PLYWOOD_MANUFACTURING' | 'ENGINEERED_WOOD_MEMBER_MANUFACTURING' | 'RECONSTITUTED_WOOD_PRODUCT_MANUFACTURING' | 'WOOD_WINDOW_AND_DOOR_MANUFACTURING' | 'CUT_STOCK_RESAWING_LUMBER_AND_PLANING' | 'OTHER_MILLWORK_INCLUDING_FLOORING' | 'WOOD_CONTAINER_AND_PALLET_MANUFACTURING' | 'MANUFACTURED_HOME_MOBILE_HOME_MANUFACTURING' | 'PREFABRICATED_WOOD_BUILDING_MANUFACTURING' | 'ALL_OTHER_MISCELLANEOUS_WOOD_PRODUCT_MANUFACTURING' | 'PULP_MILLS' | 'PAPER_MILLS' | 'PAPERBOARD_MILLS' | 'CORRUGATED_AND_SOLID_FIBER_BOX_MANUFACTURING' | 'FOLDING_PAPERBOARD_BOX_MANUFACTURING' | 'OTHER_PAPERBOARD_CONTAINER_MANUFACTURING' | 'PAPER_BAG_AND_COATED_AND_TREATED_PAPER_MANUFACTURING' | 'STATIONERY_PRODUCT_MANUFACTURING' | 'SANITARY_PAPER_PRODUCT_MANUFACTURING' | 'ALL_OTHER_CONVERTED_PAPER_PRODUCT_MANUFACTURING' | 'COMMERCIAL_PRINTING_EXCEPT_SCREEN_AND_BOOKS' | 'COMMERCIAL_SCREEN_PRINTING' | 'BOOKS_PRINTING' | 'SUPPORT_ACTIVITIES_FOR_PRINTING' | 'PETROLEUM_REFINERIES' | 'ASPHALT_PAVING_MIXTURE_AND_BLOCK_MANUFACTURING' | 'ASPHALT_SHINGLE_AND_COATING_MATERIALS_MANUFACTURING' | 'PETROLEUM_LUBRICATING_OIL_AND_GREASE_MANUFACTURING' | 'ALL_OTHER_PETROLEUM_AND_COAL_PRODUCTS_MANUFACTURING' | 'PETROCHEMICAL_MANUFACTURING' | 'INDUSTRIAL_GAS_MANUFACTURING' | 'SYNTHETIC_DYE_AND_PIGMENT_MANUFACTURING' | 'OTHER_BASIC_INORGANIC_CHEMICAL_MANUFACTURING' | 'ETHYL_ALCOHOL_MANUFACTURING' | 'CYCLIC_CRUDE_INTERMEDIATE_AND_GUM_AND_WOOD_CHEMICAL_MANUFACTURING' | 'ALL_OTHER_BASIC_ORGANIC_CHEMICAL_MANUFACTURING' | 'PLASTICS_MATERIAL_AND_RESIN_MANUFACTURING' | 'SYNTHETIC_RUBBER_MANUFACTURING' | 'ARTIFICIAL_AND_SYNTHETIC_FIBERS_AND_FILAMENTS_MANUFACTURING' | 'NITROGENOUS_FERTILIZER_MANUFACTURING' | 'PHOSPHATIC_FERTILIZER_MANUFACTURING' | 'FERTILIZER_MIXING_ONLY_MANUFACTURING' | 'COMPOST_MANUFACTURING' | 'PESTICIDE_AND_OTHER_AGRICULTURAL_CHEMICAL_MANUFACTURING' | 'MEDICINAL_AND_BOTANICAL_MANUFACTURING' | 'PHARMACEUTICAL_PREPARATION_MANUFACTURING' | 'IN_VITRO_DIAGNOSTIC_SUBSTANCE_MANUFACTURING' | 'BIOLOGICAL_PRODUCT_EXCEPT_DIAGNOSTIC_MANUFACTURING' | 'PAINT_AND_COATING_MANUFACTURING' | 'ADHESIVE_MANUFACTURING' | 'SOAP_AND_OTHER_DETERGENT_MANUFACTURING' | 'POLISH_AND_OTHER_SANITATION_GOOD_MANUFACTURING' | 'SURFACE_ACTIVE_AGENT_MANUFACTURING' | 'TOILET_PREPARATION_MANUFACTURING' | 'PRINTING_INK_MANUFACTURING' | 'EXPLOSIVES_MANUFACTURING' | 'CUSTOM_COMPOUNDING_OF_PURCHASED_RESINS' | 'PHOTOGRAPHIC_FILM_PAPER_PLATE_CHEMICAL_AND_COPY_TONER_MANUFACTURING' | 'ALL_OTHER_MISCELLANEOUS_CHEMICAL_PRODUCT_AND_PREPARATION_MANUFACTURING' | 'PLASTICS_BAG_AND_POUCH_MANUFACTURING' | 'PLASTICS_PACKAGING_FILM_AND_SHEET_INCLUDING_LAMINATED_MANUFACTURING' | 'UNLAMINATED_PLASTICS_FILM_AND_SHEET_EXCEPT_PACKAGING_MANUFACTURING' | 'UNLAMINATED_PLASTICS_PROFILE_SHAPE_MANUFACTURING' | 'PLASTICS_PIPE_AND_PIPE_FITTING_MANUFACTURING' | 'LAMINATED_PLASTICS_PLATE_SHEET_EXCEPT_PACKAGING_AND_SHAPE_MANUFACTURING' | 'POLYSTYRENE_FOAM_PRODUCT_MANUFACTURING' | 'URETHANE_AND_OTHER_FOAM_PRODUCT_EXCEPT_POLYSTYRENE_MANUFACTURING' | 'PLASTICS_BOTTLE_MANUFACTURING' | 'PLASTICS_PLUMBING_FIXTURE_MANUFACTURING' | 'ALL_OTHER_PLASTICS_PRODUCT_MANUFACTURING' | 'TIRE_MANUFACTURING_EXCEPT_RETREADING' | 'TIRE_RETREADING' | 'RUBBER_AND_PLASTICS_HOSES_AND_BELTING_MANUFACTURING' | 'RUBBER_PRODUCT_MANUFACTURING_FOR_MECHANICAL_USE' | 'ALL_OTHER_RUBBER_PRODUCT_MANUFACTURING' | 'POTTERY_CERAMICS_AND_PLUMBING_FIXTURE_MANUFACTURING' | 'CLAY_BUILDING_MATERIAL_AND_REFRACTORIES_MANUFACTURING' | 'FLAT_GLASS_MANUFACTURING' | 'OTHER_PRESSED_AND_BLOWN_GLASS_AND_GLASSWARE_MANUFACTURING' | 'GLASS_CONTAINER_MANUFACTURING' | 'GLASS_PRODUCT_MANUFACTURING_MADE_OF_PURCHASED_GLASS' | 'CEMENT_MANUFACTURING' | 'READY_MIX_CONCRETE_MANUFACTURING' | 'CONCRETE_BLOCK_AND_BRICK_MANUFACTURING' | 'CONCRETE_PIPE_MANUFACTURING' | 'OTHER_CONCRETE_PRODUCT_MANUFACTURING' | 'LIME_MANUFACTURING' | 'GYPSUM_PRODUCT_MANUFACTURING' | 'ABRASIVE_PRODUCT_MANUFACTURING' | 'CUT_STONE_AND_STONE_PRODUCT_MANUFACTURING' | 'GROUND_OR_TREATED_MINERAL_AND_EARTH_MANUFACTURING' | 'MINERAL_WOOL_MANUFACTURING' | 'ALL_OTHER_MISCELLANEOUS_NONMETALLIC_MINERAL_PRODUCT_MANUFACTURING' | 'IRON_AND_STEEL_MILLS_AND_FERROALLOY_MANUFACTURING' | 'IRON_AND_STEEL_PIPE_AND_TUBE_MANUFACTURING_FROM_PURCHASED_STEEL' | 'ROLLED_STEEL_SHAPE_MANUFACTURING' | 'STEEL_WIRE_DRAWING' | 'ALUMINA_REFINING_AND_PRIMARY_ALUMINUM_PRODUCTION' | 'SECONDARY_SMELTING_AND_ALLOYING_OF_ALUMINUM' | 'ALUMINUM_SHEET_PLATE_AND_FOIL_MANUFACTURING' | 'OTHER_ALUMINUM_ROLLING_DRAWING_AND_EXTRUDING' | 'NONFERROUS_METAL_EXCEPT_ALUMINUM_SMELTING_AND_REFINING' | 'COPPER_ROLLING_DRAWING_EXTRUDING_AND_ALLOYING' | 'NONFERROUS_METAL_EXCEPT_COPPER_AND_ALUMINUM_ROLLING_DRAWING_AND_EXTRUDING' | 'SECONDARY_SMELTING_REFINING_AND_ALLOYING_OF_NONFERROUS_METAL_EXCEPT_COPPER_AND_ALUMINUM' | 'IRON_FOUNDRIES' | 'STEEL_INVESTMENT_FOUNDRIES' | 'STEEL_FOUNDRIES_EXCEPT_INVESTMENT' | 'NONFERROUS_METAL_DIE_CASTING_FOUNDRIES' | 'ALUMINUM_FOUNDRIES_EXCEPT_DIE_CASTING' | 'OTHER_NONFERROUS_METAL_FOUNDRIES_EXCEPT_DIE_CASTING' | 'IRON_AND_STEEL_FORGING' | 'NONFERROUS_FORGING' | 'CUSTOM_ROLL_FORMING' | 'POWDER_METALLURGY_PART_MANUFACTURING' | 'METAL_CROWN_CLOSURE_AND_OTHER_METAL_STAMPING_EXCEPT_AUTOMOTIVE' | 'METAL_KITCHEN_COOKWARE_UTENSIL_CUTLERY_AND_FLATWARE_EXCEPT_PRECIOUS_MANUFACTURING' | 'SAW_BLADE_AND_HANDTOOL_MANUFACTURING' | 'PREFABRICATED_METAL_BUILDING_AND_COMPONENT_MANUFACTURING' | 'FABRICATED_STRUCTURAL_METAL_MANUFACTURING' | 'PLATE_WORK_MANUFACTURING' | 'METAL_WINDOW_AND_DOOR_MANUFACTURING' | 'SHEET_METAL_WORK_MANUFACTURING' | 'ORNAMENTAL_AND_ARCHITECTURAL_METAL_WORK_MANUFACTURING' | 'POWER_BOILER_AND_HEAT_EXCHANGER_MANUFACTURING' | 'METAL_TANK_HEAVY_GAUGE_MANUFACTURING' | 'METAL_CAN_MANUFACTURING' | 'OTHER_METAL_CONTAINER_MANUFACTURING' | 'HARDWARE_MANUFACTURING' | 'SPRING_MANUFACTURING' | 'OTHER_FABRICATED_WIRE_PRODUCT_MANUFACTURING' | 'MACHINE_SHOPS' | 'PRECISION_TURNED_PRODUCT_MANUFACTURING' | 'BOLT_NUT_SCREW_RIVET_AND_WASHER_MANUFACTURING' | 'METAL_HEAT_TREATING' | 'METAL_COATING_ENGRAVING_EXCEPT_JEWELRY_AND_SILVERWARE_AND_ALLIED_SERVICES_TO_MANUFACTURERS' | 'ELECTROPLATING_PLATING_POLISHING_ANODIZING_AND_COLORING' | 'INDUSTRIAL_VALVE_MANUFACTURING' | 'FLUID_POWER_VALVE_AND_HOSE_FITTING_MANUFACTURING' | 'PLUMBING_FIXTURE_FITTING_AND_TRIM_MANUFACTURING' | 'OTHER_METAL_VALVE_AND_PIPE_FITTING_MANUFACTURING' | 'BALL_AND_ROLLER_BEARING_MANUFACTURING' | 'SMALL_ARMS_AMMUNITION_MANUFACTURING' | 'AMMUNITION_EXCEPT_SMALL_ARMS_MANUFACTURING' | 'SMALL_ARMS_ORDNANCE_AND_ORDNANCE_ACCESSORIES_MANUFACTURING' | 'FABRICATED_PIPE_AND_PIPE_FITTING_MANUFACTURING' | 'ALL_OTHER_MISCELLANEOUS_FABRICATED_METAL_PRODUCT_MANUFACTURING' | 'FARM_MACHINERY_AND_EQUIPMENT_MANUFACTURING' | 'LAWN_AND_GARDEN_TRACTOR_AND_HOME_LAWN_AND_GARDEN_EQUIPMENT_MANUFACTURING' | 'CONSTRUCTION_MACHINERY_MANUFACTURING' | 'MINING_MACHINERY_AND_EQUIPMENT_MANUFACTURING' | 'OIL_AND_GAS_FIELD_MACHINERY_AND_EQUIPMENT_MANUFACTURING' | 'FOOD_PRODUCT_MACHINERY_MANUFACTURING' | 'SEMICONDUCTOR_MACHINERY_MANUFACTURING' | 'SAWMILL_WOODWORKING_AND_PAPER_MACHINERY_MANUFACTURING' | 'ALL_OTHER_INDUSTRIAL_MACHINERY_MANUFACTURING' | 'COMMERCIAL_AND_SERVICE_INDUSTRY_MACHINERY_MANUFACTURING' | 'INDUSTRIAL_AND_COMMERCIAL_FAN_AND_BLOWER_AND_AIR_PURIFICATION_EQUIPMENT_MANUFACTURING' | 'HEATING_EQUIPMENT_EXCEPT_WARM_AIR_FURNACES_MANUFACTURING' | 'AIR_CONDITIONING_AND_WARM_AIR_HEATING_EQUIPMENT_AND_COMMERCIAL_AND_INDUSTRIAL_REFRIGERATION_EQUIPMENT_MANUFACTURING' | 'INDUSTRIAL_MOLD_MANUFACTURING' | 'SPECIAL_DIE_AND_TOOL_DIE_SET_JIG_AND_FIXTURE_MANUFACTURING' | 'CUTTING_TOOL_AND_MACHINE_TOOL_ACCESSORY_MANUFACTURING' | 'MACHINE_TOOL_MANUFACTURING' | 'ROLLING_MILL_AND_OTHER_METALWORKING_MACHINERY_MANUFACTURING' | 'TURBINE_AND_TURBINE_GENERATOR_SET_UNITS_MANUFACTURING' | 'SPEED_CHANGER_INDUSTRIAL_HIGH_SPEED_DRIVE_AND_GEAR_MANUFACTURING' | 'MECHANICAL_POWER_TRANSMISSION_EQUIPMENT_MANUFACTURING' | 'OTHER_ENGINE_EQUIPMENT_MANUFACTURING' | 'AIR_AND_GAS_COMPRESSOR_MANUFACTURING' | 'MEASURING_DISPENSING_AND_OTHER_PUMPING_EQUIPMENT_MANUFACTURING' | 'ELEVATOR_AND_MOVING_STAIRWAY_MANUFACTURING' | 'CONVEYOR_AND_CONVEYING_EQUIPMENT_MANUFACTURING' | 'OVERHEAD_TRAVELING_CRANE_HOIST_AND_MONORAIL_SYSTEM_MANUFACTURING' | 'INDUSTRIAL_TRUCK_TRACTOR_TRAILER_AND_STACKER_MACHINERY_MANUFACTURING' | 'POWER_DRIVEN_HANDTOOL_MANUFACTURING' | 'WELDING_AND_SOLDERING_EQUIPMENT_MANUFACTURING' | 'PACKAGING_MACHINERY_MANUFACTURING' | 'INDUSTRIAL_PROCESS_FURNACE_AND_OVEN_MANUFACTURING' | 'FLUID_POWER_CYLINDER_AND_ACTUATOR_MANUFACTURING' | 'FLUID_POWER_PUMP_AND_MOTOR_MANUFACTURING' | 'ALL_OTHER_MISCELLANEOUS_GENERAL_PURPOSE_MACHINERY_MANUFACTURING' | 'ELECTRONIC_COMPUTER_MANUFACTURING' | 'COMPUTER_STORAGE_DEVICE_MANUFACTURING' | 'COMPUTER_TERMINAL_AND_OTHER_COMPUTER_PERIPHERAL_EQUIPMENT_MANUFACTURING' | 'TELEPHONE_APPARATUS_MANUFACTURING' | 'RADIO_AND_TELEVISION_BROADCASTING_AND_WIRELESS_COMMUNICATIONS_EQUIPMENT_MANUFACTURING' | 'OTHER_COMMUNICATIONS_EQUIPMENT_MANUFACTURING' | 'AUDIO_AND_VIDEO_EQUIPMENT_MANUFACTURING' | 'BARE_PRINTED_CIRCUIT_BOARD_MANUFACTURING' | 'SEMICONDUCTOR_AND_RELATED_DEVICE_MANUFACTURING' | 'CAPACITOR_RESISTOR_COIL_TRANSFORMER_AND_OTHER_INDUCTOR_MANUFACTURING' | 'ELECTRONIC_CONNECTOR_MANUFACTURING' | 'PRINTED_CIRCUIT_ASSEMBLY_ELECTRONIC_ASSEMBLY_MANUFACTURING' | 'OTHER_ELECTRONIC_COMPONENT_MANUFACTURING' | 'ELECTROMEDICAL_AND_ELECTROTHERAPEUTIC_APPARATUS_MANUFACTURING' | 'SEARCH_DETECTION_NAVIGATION_GUIDANCE_AERONAUTICAL_AND_NAUTICAL_SYSTEM_AND_INSTRUMENT_MANUFACTURING' | 'AUTOMATIC_ENVIRONMENTAL_CONTROL_MANUFACTURING_FOR_RESIDENTIAL_COMMERCIAL_AND_APPLIANCE_USE' | 'INSTRUMENTS_AND_RELATED_PRODUCTS_MANUFACTURING_FOR_MEASURING_DISPLAYING_AND_CONTROLLING_INDUSTRIAL_PROCESS_VARIABLES' | 'TOTALIZING_FLUID_METER_AND_COUNTING_DEVICE_MANUFACTURING' | 'INSTRUMENT_MANUFACTURING_FOR_MEASURING_AND_TESTING_ELECTRICITY_AND_ELECTRICAL_SIGNALS' | 'ANALYTICAL_LABORATORY_INSTRUMENT_MANUFACTURING' | 'IRRADIATION_APPARATUS_MANUFACTURING' | 'OTHER_MEASURING_AND_CONTROLLING_DEVICE_MANUFACTURING' | 'MANUFACTURING_AND_REPRODUCING_MAGNETIC_AND_OPTICAL_MEDIA' | 'RESIDENTIAL_ELECTRIC_LIGHTING_FIXTURE_MANUFACTURING' | 'COMMERCIAL_INDUSTRIAL_AND_INSTITUTIONAL_ELECTRIC_LIGHTING_FIXTURE_MANUFACTURING' | 'ELECTRIC_LAMP_BULB_AND_OTHER_LIGHTING_EQUIPMENT_MANUFACTURING' | 'SMALL_ELECTRICAL_APPLIANCE_MANUFACTURING' | 'MAJOR_HOUSEHOLD_APPLIANCE_MANUFACTURING' | 'POWER_DISTRIBUTION_AND_SPECIALTY_TRANSFORMER_MANUFACTURING' | 'MOTOR_AND_GENERATOR_MANUFACTURING' | 'SWITCHGEAR_AND_SWITCHBOARD_APPARATUS_MANUFACTURING' | 'RELAY_AND_INDUSTRIAL_CONTROL_MANUFACTURING' | 'BATTERY_MANUFACTURING' | 'FIBER_OPTIC_CABLE_MANUFACTURING' | 'OTHER_COMMUNICATION_AND_ENERGY_WIRE_MANUFACTURING' | 'CURRENT_CARRYING_WIRING_DEVICE_MANUFACTURING' | 'NONCURRENT_CARRYING_WIRING_DEVICE_MANUFACTURING' | 'CARBON_AND_GRAPHITE_PRODUCT_MANUFACTURING' | 'ALL_OTHER_MISCELLANEOUS_ELECTRICAL_EQUIPMENT_AND_COMPONENT_MANUFACTURING' | 'AUTOMOBILE_AND_LIGHT_DUTY_MOTOR_VEHICLE_MANUFACTURING' | 'HEAVY_DUTY_TRUCK_MANUFACTURING' | 'MOTOR_VEHICLE_BODY_MANUFACTURING' | 'TRUCK_TRAILER_MANUFACTURING' | 'MOTOR_HOME_MANUFACTURING' | 'TRAVEL_TRAILER_AND_CAMPER_MANUFACTURING' | 'MOTOR_VEHICLE_GASOLINE_ENGINE_AND_ENGINE_PARTS_MANUFACTURING' | 'MOTOR_VEHICLE_ELECTRICAL_AND_ELECTRONIC_EQUIPMENT_MANUFACTURING' | 'MOTOR_VEHICLE_STEERING_AND_SUSPENSION_COMPONENTS_EXCEPT_SPRING_MANUFACTURING' | 'MOTOR_VEHICLE_BRAKE_SYSTEM_MANUFACTURING' | 'MOTOR_VEHICLE_TRANSMISSION_AND_POWER_TRAIN_PARTS_MANUFACTURING' | 'MOTOR_VEHICLE_SEATING_AND_INTERIOR_TRIM_MANUFACTURING' | 'MOTOR_VEHICLE_METAL_STAMPING' | 'OTHER_MOTOR_VEHICLE_PARTS_MANUFACTURING' | 'AIRCRAFT_MANUFACTURING' | 'AIRCRAFT_ENGINE_AND_ENGINE_PARTS_MANUFACTURING' | 'OTHER_AIRCRAFT_PARTS_AND_AUXILIARY_EQUIPMENT_MANUFACTURING' | 'GUIDED_MISSILE_AND_SPACE_VEHICLE_MANUFACTURING' | 'GUIDED_MISSILE_AND_SPACE_VEHICLE_PROPULSION_UNIT_AND_PROPULSION_UNIT_PARTS_MANUFACTURING' | 'OTHER_GUIDED_MISSILE_AND_SPACE_VEHICLE_PARTS_AND_AUXILIARY_EQUIPMENT_MANUFACTURING' | 'RAILROAD_ROLLING_STOCK_MANUFACTURING' | 'SHIP_BUILDING_AND_REPAIRING' | 'BOAT_BUILDING' | 'MOTORCYCLE_BICYCLE_AND_PARTS_MANUFACTURING' | 'MILITARY_ARMORED_VEHICLE_TANK_AND_TANK_COMPONENT_MANUFACTURING' | 'ALL_OTHER_TRANSPORTATION_EQUIPMENT_MANUFACTURING' | 'WOOD_KITCHEN_CABINET_AND_COUNTERTOP_MANUFACTURING' | 'UPHOLSTERED_HOUSEHOLD_FURNITURE_MANUFACTURING' | 'NONUPHOLSTERED_WOOD_HOUSEHOLD_FURNITURE_MANUFACTURING' | 'HOUSEHOLD_FURNITURE_EXCEPT_WOOD_AND_UPHOLSTERED_MANUFACTURING' | 'INSTITUTIONAL_FURNITURE_MANUFACTURING' | 'WOOD_OFFICE_FURNITURE_MANUFACTURING' | 'CUSTOM_ARCHITECTURAL_WOODWORK_AND_MILLWORK_MANUFACTURING' | 'OFFICE_FURNITURE_EXCEPT_WOOD_MANUFACTURING' | 'SHOWCASE_PARTITION_SHELVING_AND_LOCKER_MANUFACTURING' | 'MATTRESS_MANUFACTURING' | 'BLIND_AND_SHADE_MANUFACTURING' | 'SURGICAL_AND_MEDICAL_INSTRUMENT_MANUFACTURING' | 'SURGICAL_APPLIANCE_AND_SUPPLIES_MANUFACTURING' | 'DENTAL_EQUIPMENT_AND_SUPPLIES_MANUFACTURING' | 'OPHTHALMIC_GOODS_MANUFACTURING' | 'DENTAL_LABORATORIES' | 'JEWELRY_AND_SILVERWARE_MANUFACTURING' | 'SPORTING_AND_ATHLETIC_GOODS_MANUFACTURING' | 'DOLL_TOY_AND_GAME_MANUFACTURING' | 'OFFICE_SUPPLIES_EXCEPT_PAPER_MANUFACTURING' | 'SIGN_MANUFACTURING' | 'GASKET_PACKING_AND_SEALING_DEVICE_MANUFACTURING' | 'MUSICAL_INSTRUMENT_MANUFACTURING' | 'FASTENER_BUTTON_NEEDLE_AND_PIN_MANUFACTURING' | 'BROOM_BRUSH_AND_MOP_MANUFACTURING' | 'BURIAL_CASKET_MANUFACTURING' | 'ALL_OTHER_MISCELLANEOUS_MANUFACTURING' | 'AUTOMOBILE_AND_OTHER_MOTOR_VEHICLE_MERCHANT_WHOLESALERS' | 'MOTOR_VEHICLE_SUPPLIES_AND_NEW_PARTS_MERCHANT_WHOLESALERS' | 'TIRE_AND_TUBE_MERCHANT_WHOLESALERS' | 'MOTOR_VEHICLE_PARTS_USED_MERCHANT_WHOLESALERS' | 'FURNITURE_MERCHANT_WHOLESALERS' | 'HOME_FURNISHING_MERCHANT_WHOLESALERS' | 'LUMBER_PLYWOOD_MILLWORK_AND_WOOD_PANEL_MERCHANT_WHOLESALERS' | 'BRICK_STONE_AND_RELATED_CONSTRUCTION_MATERIAL_MERCHANT_WHOLESALERS' | 'ROOFING_SIDING_AND_INSULATION_MATERIAL_MERCHANT_WHOLESALERS' | 'OTHER_CONSTRUCTION_MATERIAL_MERCHANT_WHOLESALERS' | 'PHOTOGRAPHIC_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS' | 'OFFICE_EQUIPMENT_MERCHANT_WHOLESALERS' | 'COMPUTER_AND_COMPUTER_PERIPHERAL_EQUIPMENT_AND_SOFTWARE_MERCHANT_WHOLESALERS' | 'OTHER_COMMERCIAL_EQUIPMENT_MERCHANT_WHOLESALERS' | 'MEDICAL_DENTAL_AND_HOSPITAL_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS' | 'OPHTHALMIC_GOODS_MERCHANT_WHOLESALERS' | 'OTHER_PROFESSIONAL_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS' | 'METAL_SERVICE_CENTERS_AND_OTHER_METAL_MERCHANT_WHOLESALERS' | 'COAL_AND_OTHER_MINERAL_AND_ORE_MERCHANT_WHOLESALERS' | 'ELECTRICAL_APPARATUS_AND_EQUIPMENT_WIRING_SUPPLIES_AND_RELATED_EQUIPMENT_MERCHANT_WHOLESALERS' | 'HOUSEHOLD_APPLIANCES_ELECTRIC_HOUSEWARES_AND_CONSUMER_ELECTRONICS_MERCHANT_WHOLESALERS' | 'OTHER_ELECTRONIC_PARTS_AND_EQUIPMENT_MERCHANT_WHOLESALERS' | 'HARDWARE_MERCHANT_WHOLESALERS' | 'PLUMBING_AND_HEATING_EQUIPMENT_AND_SUPPLIES_HYDRONICS_MERCHANT_WHOLESALERS' | 'WARM_AIR_HEATING_AND_AIR_CONDITIONING_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS' | 'REFRIGERATION_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS' | 'CONSTRUCTION_AND_MINING_EXCEPT_OIL_WELL_MACHINERY_AND_EQUIPMENT_MERCHANT_WHOLESALERS' | 'FARM_AND_GARDEN_MACHINERY_AND_EQUIPMENT_MERCHANT_WHOLESALERS' | 'INDUSTRIAL_MACHINERY_AND_EQUIPMENT_MERCHANT_WHOLESALERS' | 'INDUSTRIAL_SUPPLIES_MERCHANT_WHOLESALERS' | 'SERVICE_ESTABLISHMENT_EQUIPMENT_AND_SUPPLIES_MERCHANT_WHOLESALERS' | 'TRANSPORTATION_EQUIPMENT_AND_SUPPLIES_EXCEPT_MOTOR_VEHICLE_MERCHANT_WHOLESALERS' | 'SPORTING_AND_RECREATIONAL_GOODS_AND_SUPPLIES_MERCHANT_WHOLESALERS' | 'TOY_AND_HOBBY_GOODS_AND_SUPPLIES_MERCHANT_WHOLESALERS' | 'RECYCLABLE_MATERIAL_MERCHANT_WHOLESALERS' | 'JEWELRY_WATCH_PRECIOUS_STONE_AND_PRECIOUS_METAL_MERCHANT_WHOLESALERS' | 'OTHER_MISCELLANEOUS_DURABLE_GOODS_MERCHANT_WHOLESALERS' | 'PRINTING_AND_WRITING_PAPER_MERCHANT_WHOLESALERS' | 'STATIONERY_AND_OFFICE_SUPPLIES_MERCHANT_WHOLESALERS' | 'INDUSTRIAL_AND_PERSONAL_SERVICE_PAPER_MERCHANT_WHOLESALERS' | 'DRUGS_AND_DRUGGISTS_SUNDRIES_MERCHANT_WHOLESALERS' | 'PIECE_GOODS_NOTIONS_AND_OTHER_DRY_GOODS_MERCHANT_WHOLESALERS' | 'FOOTWEAR_MERCHANT_WHOLESALERS' | 'CLOTHING_AND_CLOTHING_ACCESSORIES_MERCHANT_WHOLESALERS' | 'GENERAL_LINE_GROCERY_MERCHANT_WHOLESALERS' | 'PACKAGED_FROZEN_FOOD_MERCHANT_WHOLESALERS' | 'DAIRY_PRODUCT_EXCEPT_DRIED_OR_CANNED_MERCHANT_WHOLESALERS' | 'POULTRY_AND_POULTRY_PRODUCT_MERCHANT_WHOLESALERS' | 'CONFECTIONERY_MERCHANT_WHOLESALERS' | 'FISH_AND_SEAFOOD_MERCHANT_WHOLESALERS' | 'MEAT_AND_MEAT_PRODUCT_MERCHANT_WHOLESALERS' | 'FRESH_FRUIT_AND_VEGETABLE_MERCHANT_WHOLESALERS' | 'OTHER_GROCERY_AND_RELATED_PRODUCTS_MERCHANT_WHOLESALERS' | 'GRAIN_AND_FIELD_BEAN_MERCHANT_WHOLESALERS' | 'LIVESTOCK_MERCHANT_WHOLESALERS' | 'OTHER_FARM_PRODUCT_RAW_MATERIAL_MERCHANT_WHOLESALERS' | 'PLASTICS_MATERIALS_AND_BASIC_FORMS_AND_SHAPES_MERCHANT_WHOLESALERS' | 'OTHER_CHEMICAL_AND_ALLIED_PRODUCTS_MERCHANT_WHOLESALERS' | 'PETROLEUM_BULK_STATIONS_AND_TERMINALS' | 'PETROLEUM_AND_PETROLEUM_PRODUCTS_MERCHANT_WHOLESALERS_EXCEPT_BULK_STATIONS_AND_TERMINALS' | 'BEER_AND_ALE_MERCHANT_WHOLESALERS' | 'WINE_AND_DISTILLED_ALCOHOLIC_BEVERAGE_MERCHANT_WHOLESALERS' | 'FARM_SUPPLIES_MERCHANT_WHOLESALERS' | 'BOOK_PERIODICAL_AND_NEWSPAPER_MERCHANT_WHOLESALERS' | 'FLOWER_NURSERY_STOCK_AND_FLORISTS_SUPPLIES_MERCHANT_WHOLESALERS' | 'TOBACCO_PRODUCT_AND_ELECTRONIC_CIGARETTE_MERCHANT_WHOLESALERS' | 'PAINT_VARNISH_AND_SUPPLIES_MERCHANT_WHOLESALERS' | 'OTHER_MISCELLANEOUS_NONDURABLE_GOODS_MERCHANT_WHOLESALERS' | 'WHOLESALE_TRADE_AGENTS_AND_BROKERS' | 'NEW_CAR_DEALERS' | 'USED_CAR_DEALERS' | 'RECREATIONAL_VEHICLE_DEALERS' | 'BOAT_DEALERS' | 'MOTORCYCLE_ATV_AND_ALL_OTHER_MOTOR_VEHICLE_DEALERS' | 'AUTOMOTIVE_PARTS_AND_ACCESSORIES_RETAILERS' | 'TIRE_DEALERS' | 'HOME_CENTERS' | 'PAINT_AND_WALLPAPER_RETAILERS' | 'HARDWARE_RETAILERS' | 'OTHER_BUILDING_MATERIAL_DEALERS' | 'OUTDOOR_POWER_EQUIPMENT_RETAILERS' | 'NURSERY_GARDEN_CENTER_AND_FARM_SUPPLY_RETAILERS' | 'SUPERMARKETS_AND_OTHER_GROCERY_RETAILERS_EXCEPT_CONVENIENCE_RETAILERS' | 'CONVENIENCE_RETAILERS' | 'VENDING_MACHINE_OPERATORS' | 'FRUIT_AND_VEGETABLE_RETAILERS' | 'MEAT_RETAILERS' | 'FISH_AND_SEAFOOD_RETAILERS' | 'BAKED_GOODS_RETAILERS' | 'CONFECTIONERY_AND_NUT_RETAILERS' | 'ALL_OTHER_SPECIALTY_FOOD_RETAILERS' | 'BEER_WINE_AND_LIQUOR_RETAILERS' | 'FURNITURE_RETAILERS' | 'FLOOR_COVERING_RETAILERS' | 'WINDOW_TREATMENT_RETAILERS' | 'ALL_OTHER_HOME_FURNISHINGS_RETAILERS' | 'ELECTRONICS_AND_APPLIANCE_RETAILERS' | 'DEPARTMENT_STORES' | 'WAREHOUSE_CLUBS_AND_SUPERCENTERS' | 'ALL_OTHER_GENERAL_MERCHANDISE_RETAILERS' | 'PHARMACIES_AND_DRUG_RETAILERS' | 'COSMETICS_BEAUTY_SUPPLIES_AND_PERFUME_RETAILERS' | 'OPTICAL_GOODS_RETAILERS' | 'FOOD_HEALTH_SUPPLEMENT_RETAILERS' | 'ALL_OTHER_HEALTH_AND_PERSONAL_CARE_RETAILERS' | 'GASOLINE_STATIONS_WITH_CONVENIENCE_STORES' | 'OTHER_GASOLINE_STATIONS' | 'FUEL_DEALERS' | 'CLOTHING_AND_CLOTHING_ACCESSORIES_RETAILERS' | 'SHOE_RETAILERS' | 'JEWELRY_RETAILERS' | 'LUGGAGE_AND_LEATHER_GOODS_RETAILERS' | 'SPORTING_GOODS_RETAILERS' | 'HOBBY_TOY_AND_GAME_RETAILERS' | 'SEWING_NEEDLEWORK_AND_PIECE_GOODS_RETAILERS' | 'MUSICAL_INSTRUMENT_AND_SUPPLIES_RETAILERS' | 'BOOK_RETAILERS_AND_NEWS_DEALERS' | 'FLORISTS' | 'OFFICE_SUPPLIES_AND_STATIONERY_RETAILERS' | 'GIFT_NOVELTY_AND_SOUVENIR_RETAILERS' | 'USED_MERCHANDISE_RETAILERS' | 'PET_AND_PET_SUPPLIES_RETAILERS' | 'ART_DEALERS' | 'MANUFACTURED_MOBILE_HOME_DEALERS' | 'TOBACCO_ELECTRONIC_CIGARETTE_AND_OTHER_SMOKING_SUPPLIES_RETAILERS' | 'ALL_OTHER_MISCELLANEOUS_RETAILERS' | 'SCHEDULED_PASSENGER_AIR_TRANSPORTATION' | 'SCHEDULED_FREIGHT_AIR_TRANSPORTATION' | 'NONSCHEDULED_CHARTERED_PASSENGER_AIR_TRANSPORTATION' | 'NONSCHEDULED_CHARTERED_FREIGHT_AIR_TRANSPORTATION' | 'OTHER_NONSCHEDULED_AIR_TRANSPORTATION' | 'LINE_HAUL_RAILROADS' | 'SHORT_LINE_RAILROADS' | 'DEEP_SEA_FREIGHT_TRANSPORTATION' | 'DEEP_SEA_PASSENGER_TRANSPORTATION' | 'COASTAL_AND_GREAT_LAKES_FREIGHT_TRANSPORTATION' | 'COASTAL_AND_GREAT_LAKES_PASSENGER_TRANSPORTATION' | 'INLAND_WATER_FREIGHT_TRANSPORTATION' | 'INLAND_WATER_PASSENGER_TRANSPORTATION' | 'GENERAL_FREIGHT_TRUCKING_LOCAL' | 'GENERAL_FREIGHT_TRUCKING_LONG_DISTANCE_TRUCKLOAD' | 'GENERAL_FREIGHT_TRUCKING_LONG_DISTANCE_LESS_THAN_TRUCKLOAD' | 'USED_HOUSEHOLD_AND_OFFICE_GOODS_MOVING' | 'SPECIALIZED_FREIGHT_EXCEPT_USED_GOODS_TRUCKING_LOCAL' | 'SPECIALIZED_FREIGHT_EXCEPT_USED_GOODS_TRUCKING_LONG_DISTANCE' | 'MIXED_MODE_TRANSIT_SYSTEMS' | 'COMMUTER_RAIL_SYSTEMS' | 'BUS_AND_OTHER_MOTOR_VEHICLE_TRANSIT_SYSTEMS' | 'OTHER_URBAN_TRANSIT_SYSTEMS' | 'INTERURBAN_AND_RURAL_BUS_TRANSPORTATION' | 'TAXI_AND_RIDESHARING_SERVICES' | 'LIMOUSINE_SERVICE' | 'SCHOOL_AND_EMPLOYEE_BUS_TRANSPORTATION' | 'CHARTER_BUS_INDUSTRY' | 'SPECIAL_NEEDS_TRANSPORTATION' | 'ALL_OTHER_TRANSIT_AND_GROUND_PASSENGER_TRANSPORTATION' | 'PIPELINE_TRANSPORTATION_OF_CRUDE_OIL' | 'PIPELINE_TRANSPORTATION_OF_NATURAL_GAS' | 'PIPELINE_TRANSPORTATION_OF_REFINED_PETROLEUM_PRODUCTS' | 'ALL_OTHER_PIPELINE_TRANSPORTATION' | 'SCENIC_AND_SIGHTSEEING_TRANSPORTATION_LAND' | 'SCENIC_AND_SIGHTSEEING_TRANSPORTATION_WATER' | 'SCENIC_AND_SIGHTSEEING_TRANSPORTATION_OTHER' | 'AIR_TRAFFIC_CONTROL' | 'OTHER_AIRPORT_OPERATIONS' | 'OTHER_SUPPORT_ACTIVITIES_FOR_AIR_TRANSPORTATION' | 'SUPPORT_ACTIVITIES_FOR_RAIL_TRANSPORTATION' | 'PORT_AND_HARBOR_OPERATIONS' | 'MARINE_CARGO_HANDLING' | 'NAVIGATIONAL_SERVICES_TO_SHIPPING' | 'OTHER_SUPPORT_ACTIVITIES_FOR_WATER_TRANSPORTATION' | 'MOTOR_VEHICLE_TOWING' | 'OTHER_SUPPORT_ACTIVITIES_FOR_ROAD_TRANSPORTATION' | 'FREIGHT_TRANSPORTATION_ARRANGEMENT' | 'PACKING_AND_CRATING' | 'ALL_OTHER_SUPPORT_ACTIVITIES_FOR_TRANSPORTATION' | 'POSTAL_SERVICE' | 'COURIERS_AND_EXPRESS_DELIVERY_SERVICES' | 'LOCAL_MESSENGERS_AND_LOCAL_DELIVERY' | 'GENERAL_WAREHOUSING_AND_STORAGE' | 'REFRIGERATED_WAREHOUSING_AND_STORAGE' | 'FARM_PRODUCT_WAREHOUSING_AND_STORAGE' | 'OTHER_WAREHOUSING_AND_STORAGE' | 'MOTION_PICTURE_AND_VIDEO_PRODUCTION' | 'MOTION_PICTURE_AND_VIDEO_DISTRIBUTION' | 'MOTION_PICTURE_THEATERS_EXCEPT_DRIVE_INS' | 'DRIVE_IN_MOTION_PICTURE_THEATERS' | 'TELEPRODUCTION_AND_OTHER_POSTPRODUCTION_SERVICES' | 'OTHER_MOTION_PICTURE_AND_VIDEO_INDUSTRIES' | 'MUSIC_PUBLISHERS' | 'SOUND_RECORDING_STUDIOS' | 'RECORD_PRODUCTION_AND_DISTRIBUTION' | 'OTHER_SOUND_RECORDING_INDUSTRIES' | 'NEWSPAPER_PUBLISHERS' | 'PERIODICAL_PUBLISHERS' | 'BOOK_PUBLISHERS' | 'DIRECTORY_AND_MAILING_LIST_PUBLISHERS' | 'GREETING_CARD_PUBLISHERS' | 'ALL_OTHER_PUBLISHERS' | 'SOFTWARE_PUBLISHERS' | 'RADIO_BROADCASTING_STATIONS' | 'TELEVISION_BROADCASTING_STATIONS' | 'MEDIA_STREAMING_DISTRIBUTION_SERVICES_SOCIAL_NETWORKS_AND_OTHER_MEDIA_NETWORKS_AND_CONTENT_PROVIDERS' | 'WIRED_TELECOMMUNICATIONS_CARRIERS' | 'WIRELESS_TELECOMMUNICATIONS_CARRIERS_EXCEPT_SATELLITE' | 'TELECOMMUNICATIONS_RESELLERS' | 'AGENTS_FOR_WIRELESS_TELECOMMUNICATIONS_SERVICES' | 'SATELLITE_TELECOMMUNICATIONS' | 'ALL_OTHER_TELECOMMUNICATIONS' | 'COMPUTING_INFRASTRUCTURE_PROVIDERS_DATA_PROCESSING_WEB_HOSTING_AND_RELATED_SERVICES' | 'LIBRARIES_AND_ARCHIVES' | 'WEB_SEARCH_PORTALS_AND_ALL_OTHER_INFORMATION_SERVICES' | 'MONETARY_AUTHORITIES_CENTRAL_BANK' | 'COMMERCIAL_BANKING' | 'CREDIT_UNIONS' | 'SAVINGS_INSTITUTIONS_AND_OTHER_DEPOSITORY_CREDIT_INTERMEDIATION' | 'CREDIT_CARD_ISSUING' | 'SALES_FINANCING' | 'CONSUMER_LENDING' | 'REAL_ESTATE_CREDIT' | 'INTERNATIONAL_SECONDARY_MARKET_AND_ALL_OTHER_NONDEPOSITORY_CREDIT_INTERMEDIATION' | 'MORTGAGE_AND_NONMORTGAGE_LOAN_BROKERS' | 'FINANCIAL_TRANSACTIONS_PROCESSING_RESERVE_AND_CLEARINGHOUSE_ACTIVITIES' | 'OTHER_ACTIVITIES_RELATED_TO_CREDIT_INTERMEDIATION' | 'INVESTMENT_BANKING_AND_SECURITIES_INTERMEDIATION' | 'COMMODITY_CONTRACTS_INTERMEDIATION' | 'SECURITIES_AND_COMMODITY_EXCHANGES' | 'MISCELLANEOUS_INTERMEDIATION' | 'PORTFOLIO_MANAGEMENT_AND_INVESTMENT_ADVICE' | 'TRUST_FIDUCIARY_AND_CUSTODY_ACTIVITIES' | 'MISCELLANEOUS_FINANCIAL_INVESTMENT_ACTIVITIES' | 'DIRECT_LIFE_INSURANCE_CARRIERS' | 'DIRECT_HEALTH_AND_MEDICAL_INSURANCE_CARRIERS' | 'DIRECT_PROPERTY_AND_CASUALTY_INSURANCE_CARRIERS' | 'DIRECT_TITLE_INSURANCE_CARRIERS' | 'OTHER_DIRECT_INSURANCE_EXCEPT_LIFE_HEALTH_AND_MEDICAL_CARRIERS' | 'REINSURANCE_CARRIERS' | 'INSURANCE_AGENCIES_AND_BROKERAGES' | 'CLAIMS_ADJUSTING' | 'PHARMACY_BENEFIT_MANAGEMENT_AND_OTHER_THIRD_PARTY_ADMINISTRATION_OF_INSURANCE_AND_PENSION_FUNDS' | 'ALL_OTHER_INSURANCE_RELATED_ACTIVITIES' | 'PENSION_FUNDS' | 'HEALTH_AND_WELFARE_FUNDS' | 'OTHER_INSURANCE_FUNDS' | 'OPEN_END_INVESTMENT_FUNDS' | 'TRUSTS_ESTATES_AND_AGENCY_ACCOUNTS' | 'OTHER_FINANCIAL_VEHICLES' | 'LESSORS_OF_RESIDENTIAL_BUILDINGS_AND_DWELLINGS' | 'LESSORS_OF_NONRESIDENTIAL_BUILDINGS_EXCEPT_MINIWAREHOUSES' | 'LESSORS_OF_MINIWAREHOUSES_AND_SELF_STORAGE_UNITS' | 'LESSORS_OF_OTHER_REAL_ESTATE_PROPERTY' | 'OFFICES_OF_REAL_ESTATE_AGENTS_AND_BROKERS' | 'RESIDENTIAL_PROPERTY_MANAGERS' | 'NONRESIDENTIAL_PROPERTY_MANAGERS' | 'OFFICES_OF_REAL_ESTATE_APPRAISERS' | 'OTHER_ACTIVITIES_RELATED_TO_REAL_ESTATE' | 'PASSENGER_CAR_RENTAL' | 'PASSENGER_CAR_LEASING' | 'TRUCK_UTILITY_TRAILER_AND_RV_RECREATIONAL_VEHICLE_RENTAL_AND_LEASING' | 'CONSUMER_ELECTRONICS_AND_APPLIANCES_RENTAL' | 'FORMAL_WEAR_AND_COSTUME_RENTAL' | 'VIDEO_TAPE_AND_DISC_RENTAL' | 'HOME_HEALTH_EQUIPMENT_RENTAL' | 'RECREATIONAL_GOODS_RENTAL' | 'ALL_OTHER_CONSUMER_GOODS_RENTAL' | 'GENERAL_RENTAL_CENTERS' | 'COMMERCIAL_AIR_RAIL_AND_WATER_TRANSPORTATION_EQUIPMENT_RENTAL_AND_LEASING' | 'CONSTRUCTION_MINING_AND_FORESTRY_MACHINERY_AND_EQUIPMENT_RENTAL_AND_LEASING' | 'OFFICE_MACHINERY_AND_EQUIPMENT_RENTAL_AND_LEASING' | 'OTHER_COMMERCIAL_AND_INDUSTRIAL_MACHINERY_AND_EQUIPMENT_RENTAL_AND_LEASING' | 'LESSORS_OF_NONFINANCIAL_INTANGIBLE_ASSETS_EXCEPT_COPYRIGHTED_WORKS' | 'OFFICES_OF_LAWYERS' | 'OFFICES_OF_NOTARIES' | 'TITLE_ABSTRACT_AND_SETTLEMENT_OFFICES' | 'ALL_OTHER_LEGAL_SERVICES' | 'OFFICES_OF_CERTIFIED_PUBLIC_ACCOUNTANTS' | 'TAX_PREPARATION_SERVICES' | 'PAYROLL_SERVICES' | 'OTHER_ACCOUNTING_SERVICES' | 'ARCHITECTURAL_SERVICES' | 'LANDSCAPE_ARCHITECTURAL_SERVICES' | 'ENGINEERING_SERVICES' | 'DRAFTING_SERVICES' | 'BUILDING_INSPECTION_SERVICES' | 'GEOPHYSICAL_SURVEYING_AND_MAPPING_SERVICES' | 'SURVEYING_AND_MAPPING_EXCEPT_GEOPHYSICAL_SERVICES' | 'TESTING_LABORATORIES_AND_SERVICES' | 'INTERIOR_DESIGN_SERVICES' | 'INDUSTRIAL_DESIGN_SERVICES' | 'GRAPHIC_DESIGN_SERVICES' | 'OTHER_SPECIALIZED_DESIGN_SERVICES' | 'CUSTOM_COMPUTER_PROGRAMMING_SERVICES' | 'COMPUTER_SYSTEMS_DESIGN_SERVICES' | 'COMPUTER_FACILITIES_MANAGEMENT_SERVICES' | 'OTHER_COMPUTER_RELATED_SERVICES' | 'ADMINISTRATIVE_MANAGEMENT_AND_GENERAL_MANAGEMENT_CONSULTING_SERVICES' | 'HUMAN_RESOURCES_CONSULTING_SERVICES' | 'MARKETING_CONSULTING_SERVICES' | 'PROCESS_PHYSICAL_DISTRIBUTION_AND_LOGISTICS_CONSULTING_SERVICES' | 'OTHER_MANAGEMENT_CONSULTING_SERVICES' | 'ENVIRONMENTAL_CONSULTING_SERVICES' | 'OTHER_SCIENTIFIC_AND_TECHNICAL_CONSULTING_SERVICES' | 'RESEARCH_AND_DEVELOPMENT_IN_NANOTECHNOLOGY' | 'RESEARCH_AND_DEVELOPMENT_IN_BIOTECHNOLOGY_EXCEPT_NANOBIOTECHNOLOGY' | 'RESEARCH_AND_DEVELOPMENT_IN_THE_PHYSICAL_ENGINEERING_AND_LIFE_SCIENCES_EXCEPT_NANOTECHNOLOGY_AND_BIOTECHNOLOGY' | 'RESEARCH_AND_DEVELOPMENT_IN_THE_SOCIAL_SCIENCES_AND_HUMANITIES' | 'ADVERTISING_AGENCIES' | 'PUBLIC_RELATIONS_AGENCIES' | 'MEDIA_BUYING_AGENCIES' | 'MEDIA_REPRESENTATIVES' | 'INDOOR_AND_OUTDOOR_DISPLAY_ADVERTISING' | 'DIRECT_MAIL_ADVERTISING' | 'ADVERTISING_MATERIAL_DISTRIBUTION_SERVICES' | 'OTHER_SERVICES_RELATED_TO_ADVERTISING' | 'MARKETING_RESEARCH_AND_PUBLIC_OPINION_POLLING' | 'PHOTOGRAPHY_STUDIOS_PORTRAIT' | 'COMMERCIAL_PHOTOGRAPHY' | 'TRANSLATION_AND_INTERPRETATION_SERVICES' | 'VETERINARY_SERVICES' | 'ALL_OTHER_PROFESSIONAL_SCIENTIFIC_AND_TECHNICAL_SERVICES' | 'OFFICES_OF_BANK_HOLDING_COMPANIES' | 'OFFICES_OF_OTHER_HOLDING_COMPANIES' | 'CORPORATE_SUBSIDIARY_AND_REGIONAL_MANAGING_OFFICES' | 'OFFICE_ADMINISTRATIVE_SERVICES' | 'FACILITIES_SUPPORT_SERVICES' | 'EMPLOYMENT_PLACEMENT_AGENCIES' | 'EXECUTIVE_SEARCH_SERVICES' | 'TEMPORARY_HELP_SERVICES' | 'PROFESSIONAL_EMPLOYER_ORGANIZATIONS' | 'DOCUMENT_PREPARATION_SERVICES' | 'TELEPHONE_ANSWERING_SERVICES' | 'TELEMARKETING_BUREAUS_AND_OTHER_CONTACT_CENTERS' | 'PRIVATE_MAIL_CENTERS' | 'OTHER_BUSINESS_SERVICE_CENTERS_INCLUDING_COPY_SHOPS' | 'COLLECTION_AGENCIES' | 'CREDIT_BUREAUS' | 'REPOSSESSION_SERVICES' | 'COURT_REPORTING_AND_STENOTYPE_SERVICES' | 'ALL_OTHER_BUSINESS_SUPPORT_SERVICES' | 'TRAVEL_AGENCIES' | 'TOUR_OPERATORS' | 'CONVENTION_AND_VISITORS_BUREAUS' | 'ALL_OTHER_TRAVEL_ARRANGEMENT_AND_RESERVATION_SERVICES' | 'INVESTIGATION_AND_PERSONAL_BACKGROUND_CHECK_SERVICES' | 'SECURITY_GUARDS_AND_PATROL_SERVICES' | 'ARMORED_CAR_SERVICES' | 'SECURITY_SYSTEMS_SERVICES_EXCEPT_LOCKSMITHS' | 'LOCKSMITHS' | 'EXTERMINATING_AND_PEST_CONTROL_SERVICES' | 'JANITORIAL_SERVICES' | 'LANDSCAPING_SERVICES' | 'CARPET_AND_UPHOLSTERY_CLEANING_SERVICES' | 'OTHER_SERVICES_TO_BUILDINGS_AND_DWELLINGS' | 'PACKAGING_AND_LABELING_SERVICES' | 'CONVENTION_AND_TRADE_SHOW_ORGANIZERS' | 'ALL_OTHER_SUPPORT_SERVICES' | 'SOLID_WASTE_COLLECTION' | 'HAZARDOUS_WASTE_COLLECTION' | 'OTHER_WASTE_COLLECTION' | 'HAZARDOUS_WASTE_TREATMENT_AND_DISPOSAL' | 'SOLID_WASTE_LANDFILL' | 'SOLID_WASTE_COMBUSTORS_AND_INCINERATORS' | 'OTHER_NONHAZARDOUS_WASTE_TREATMENT_AND_DISPOSAL' | 'REMEDIATION_SERVICES' | 'MATERIALS_RECOVERY_FACILITIES' | 'SEPTIC_TANK_AND_RELATED_SERVICES' | 'ALL_OTHER_MISCELLANEOUS_WASTE_MANAGEMENT_SERVICES' | 'ELEMENTARY_AND_SECONDARY_SCHOOLS' | 'JUNIOR_COLLEGES' | 'COLLEGES_UNIVERSITIES_AND_PROFESSIONAL_SCHOOLS' | 'BUSINESS_AND_SECRETARIAL_SCHOOLS' | 'COMPUTER_TRAINING' | 'PROFESSIONAL_AND_MANAGEMENT_DEVELOPMENT_TRAINING' | 'COSMETOLOGY_AND_BARBER_SCHOOLS' | 'FLIGHT_TRAINING' | 'APPRENTICESHIP_TRAINING' | 'OTHER_TECHNICAL_AND_TRADE_SCHOOLS' | 'FINE_ARTS_SCHOOLS' | 'SPORTS_AND_RECREATION_INSTRUCTION' | 'LANGUAGE_SCHOOLS' | 'EXAM_PREPARATION_AND_TUTORING' | 'AUTOMOBILE_DRIVING_SCHOOLS' | 'ALL_OTHER_MISCELLANEOUS_SCHOOLS_AND_INSTRUCTION' | 'EDUCATIONAL_SUPPORT_SERVICES' | 'OFFICES_OF_PHYSICIANS_EXCEPT_MENTAL_HEALTH_SPECIALISTS' | 'OFFICES_OF_PHYSICIANS_MENTAL_HEALTH_SPECIALISTS' | 'OFFICES_OF_DENTISTS' | 'OFFICES_OF_CHIROPRACTORS' | 'OFFICES_OF_OPTOMETRISTS' | 'OFFICES_OF_MENTAL_HEALTH_PRACTITIONERS_EXCEPT_PHYSICIANS' | 'OFFICES_OF_PHYSICAL_OCCUPATIONAL_AND_SPEECH_THERAPISTS_AND_AUDIOLOGISTS' | 'OFFICES_OF_PODIATRISTS' | 'OFFICES_OF_ALL_OTHER_MISCELLANEOUS_HEALTH_PRACTITIONERS' | 'FAMILY_PLANNING_CENTERS' | 'OUTPATIENT_MENTAL_HEALTH_AND_SUBSTANCE_ABUSE_CENTERS' | 'HMO_MEDICAL_CENTERS' | 'KIDNEY_DIALYSIS_CENTERS' | 'FREESTANDING_AMBULATORY_SURGICAL_AND_EMERGENCY_CENTERS' | 'ALL_OTHER_OUTPATIENT_CARE_CENTERS' | 'MEDICAL_LABORATORIES' | 'DIAGNOSTIC_IMAGING_CENTERS' | 'HOME_HEALTH_CARE_SERVICES' | 'AMBULANCE_SERVICES' | 'BLOOD_AND_ORGAN_BANKS' | 'ALL_OTHER_MISCELLANEOUS_AMBULATORY_HEALTH_CARE_SERVICES' | 'GENERAL_MEDICAL_AND_SURGICAL_HOSPITALS' | 'PSYCHIATRIC_AND_SUBSTANCE_ABUSE_HOSPITALS' | 'SPECIALTY_EXCEPT_PSYCHIATRIC_AND_SUBSTANCE_ABUSE_HOSPITALS' | 'NURSING_CARE_FACILITIES_SKILLED_NURSING_FACILITIES' | 'RESIDENTIAL_INTELLECTUAL_AND_DEVELOPMENTAL_DISABILITY_FACILITIES' | 'RESIDENTIAL_MENTAL_HEALTH_AND_SUBSTANCE_ABUSE_FACILITIES' | 'CONTINUING_CARE_RETIREMENT_COMMUNITIES' | 'ASSISTED_LIVING_FACILITIES_FOR_THE_ELDERLY' | 'OTHER_RESIDENTIAL_CARE_FACILITIES' | 'CHILD_AND_YOUTH_SERVICES' | 'SERVICES_FOR_THE_ELDERLY_AND_PERSONS_WITH_DISABILITIES' | 'OTHER_INDIVIDUAL_AND_FAMILY_SERVICES' | 'COMMUNITY_FOOD_SERVICES' | 'TEMPORARY_SHELTERS' | 'OTHER_COMMUNITY_HOUSING_SERVICES' | 'EMERGENCY_AND_OTHER_RELIEF_SERVICES' | 'VOCATIONAL_REHABILITATION_SERVICES' | 'CHILD_CARE_SERVICES' | 'THEATER_COMPANIES_AND_DINNER_THEATERS' | 'DANCE_COMPANIES' | 'MUSICAL_GROUPS_AND_ARTISTS' | 'OTHER_PERFORMING_ARTS_COMPANIES' | 'SPORTS_TEAMS_AND_CLUBS' | 'RACETRACKS' | 'OTHER_SPECTATOR_SPORTS' | 'PROMOTERS_OF_PERFORMING_ARTS_SPORTS_AND_SIMILAR_EVENTS_WITH_FACILITIES' | 'PROMOTERS_OF_PERFORMING_ARTS_SPORTS_AND_SIMILAR_EVENTS_WITHOUT_FACILITIES' | 'AGENTS_AND_MANAGERS_FOR_ARTISTS_ATHLETES_ENTERTAINERS_AND_OTHER_PUBLIC_FIGURES' | 'INDEPENDENT_ARTISTS_WRITERS_AND_PERFORMERS' | 'MUSEUMS' | 'HISTORICAL_SITES' | 'ZOOS_AND_BOTANICAL_GARDENS' | 'NATURE_PARKS_AND_OTHER_SIMILAR_INSTITUTIONS' | 'AMUSEMENT_AND_THEME_PARKS' | 'AMUSEMENT_ARCADES' | 'CASINOS_EXCEPT_CASINO_HOTELS' | 'OTHER_GAMBLING_INDUSTRIES' | 'GOLF_COURSES_AND_COUNTRY_CLUBS' | 'SKIING_FACILITIES' | 'MARINAS' | 'FITNESS_AND_RECREATIONAL_SPORTS_CENTERS' | 'BOWLING_CENTERS' | 'ALL_OTHER_AMUSEMENT_AND_RECREATION_INDUSTRIES' | 'HOTELS_EXCEPT_CASINO_HOTELS_AND_MOTELS' | 'CASINO_HOTELS' | 'BED_AND_BREAKFAST_INNS' | 'ALL_OTHER_TRAVELER_ACCOMMODATION' | 'RV_RECREATIONAL_VEHICLE_PARKS_AND_CAMPGROUNDS' | 'RECREATIONAL_AND_VACATION_CAMPS_EXCEPT_CAMPGROUNDS' | 'ROOMING_AND_BOARDING_HOUSES_DORMITORIES_AND_WORKERS_CAMPS' | 'FOOD_SERVICE_CONTRACTORS' | 'CATERERS' | 'MOBILE_FOOD_SERVICES' | 'DRINKING_PLACES_ALCOHOLIC_BEVERAGES' | 'FULL_SERVICE_RESTAURANTS' | 'LIMITED_SERVICE_RESTAURANTS' | 'CAFETERIAS_GRILL_BUFFETS_AND_BUFFETS' | 'SNACK_AND_NONALCOHOLIC_BEVERAGE_BARS' | 'GENERAL_AUTOMOTIVE_REPAIR' | 'SPECIALIZED_AUTOMOTIVE_REPAIR' | 'AUTOMOTIVE_BODY_PAINT_AND_INTERIOR_REPAIR_AND_MAINTENANCE' | 'AUTOMOTIVE_GLASS_REPLACEMENT_SHOPS' | 'AUTOMOTIVE_OIL_CHANGE_AND_LUBRICATION_SHOPS' | 'CAR_WASHES' | 'ALL_OTHER_AUTOMOTIVE_REPAIR_AND_MAINTENANCE' | 'ELECTRONIC_AND_PRECISION_EQUIPMENT_REPAIR_AND_MAINTENANCE' | 'COMMERCIAL_AND_INDUSTRIAL_MACHINERY_AND_EQUIPMENT_EXCEPT_AUTOMOTIVE_AND_ELECTRONIC_REPAIR_AND_MAINTENANCE' | 'HOME_AND_GARDEN_EQUIPMENT_REPAIR_AND_MAINTENANCE' | 'APPLIANCE_REPAIR_AND_MAINTENANCE' | 'REUPHOLSTERY_AND_FURNITURE_REPAIR' | 'FOOTWEAR_AND_LEATHER_GOODS_REPAIR' | 'OTHER_PERSONAL_AND_HOUSEHOLD_GOODS_REPAIR_AND_MAINTENANCE' | 'BARBER_SHOPS' | 'BEAUTY_SALONS' | 'NAIL_SALONS' | 'DIET_AND_WEIGHT_REDUCING_CENTERS' | 'OTHER_PERSONAL_CARE_SERVICES' | 'FUNERAL_HOMES_AND_FUNERAL_SERVICES' | 'CEMETERIES_AND_CREMATORIES' | 'COIN_OPERATED_LAUNDRIES_AND_DRYCLEANERS' | 'DRYCLEANING_AND_LAUNDRY_SERVICES_EXCEPT_COIN_OPERATED' | 'LINEN_SUPPLY' | 'INDUSTRIAL_LAUNDERERS' | 'PET_CARE_EXCEPT_VETERINARY_SERVICES' | 'PHOTOFINISHING_LABORATORIES_EXCEPT_ONE_HOUR' | 'ONE_HOUR_PHOTOFINISHING' | 'PARKING_LOTS_AND_GARAGES' | 'ALL_OTHER_PERSONAL_SERVICES' | 'RELIGIOUS_ORGANIZATIONS' | 'GRANTMAKING_FOUNDATIONS' | 'VOLUNTARY_HEALTH_ORGANIZATIONS' | 'OTHER_GRANTMAKING_AND_GIVING_SERVICES' | 'HUMAN_RIGHTS_ORGANIZATIONS' | 'ENVIRONMENT_CONSERVATION_AND_WILDLIFE_ORGANIZATIONS' | 'OTHER_SOCIAL_ADVOCACY_ORGANIZATIONS' | 'CIVIC_AND_SOCIAL_ORGANIZATIONS' | 'BUSINESS_ASSOCIATIONS' | 'PROFESSIONAL_ORGANIZATIONS' | 'LABOR_UNIONS_AND_SIMILAR_LABOR_ORGANIZATIONS' | 'POLITICAL_ORGANIZATIONS' | 'OTHER_SIMILAR_ORGANIZATIONS_EXCEPT_BUSINESS_PROFESSIONAL_LABOR_AND_POLITICAL_ORGANIZATIONS' | 'PRIVATE_HOUSEHOLDS' | 'EXECUTIVE_OFFICES' | 'LEGISLATIVE_BODIES' | 'PUBLIC_FINANCE_ACTIVITIES' | 'EXECUTIVE_AND_LEGISLATIVE_OFFICES_COMBINED' | 'AMERICAN_INDIAN_AND_ALASKA_NATIVE_TRIBAL_GOVERNMENTS' | 'OTHER_GENERAL_GOVERNMENT_SUPPORT' | 'COURTS' | 'POLICE_PROTECTION' | 'LEGAL_COUNSEL_AND_PROSECUTION' | 'CORRECTIONAL_INSTITUTIONS' | 'PAROLE_OFFICES_AND_PROBATION_OFFICES' | 'FIRE_PROTECTION' | 'OTHER_JUSTICE_PUBLIC_ORDER_AND_SAFETY_ACTIVITIES' | 'ADMINISTRATION_OF_EDUCATION_PROGRAMS' | 'ADMINISTRATION_OF_PUBLIC_HEALTH_PROGRAMS' | 'ADMINISTRATION_OF_HUMAN_RESOURCE_PROGRAMS_EXCEPT_EDUCATION_PUBLIC_HEALTH_AND_VETERANS_AFFAIRS_PROGRAMS' | 'ADMINISTRATION_OF_VETERANS_AFFAIRS' | 'ADMINISTRATION_OF_AIR_AND_WATER_RESOURCE_AND_SOLID_WASTE_MANAGEMENT_PROGRAMS' | 'ADMINISTRATION_OF_CONSERVATION_PROGRAMS' | 'ADMINISTRATION_OF_HOUSING_PROGRAMS' | 'ADMINISTRATION_OF_URBAN_PLANNING_AND_COMMUNITY_AND_RURAL_DEVELOPMENT' | 'ADMINISTRATION_OF_GENERAL_ECONOMIC_PROGRAMS' | 'REGULATION_AND_ADMINISTRATION_OF_TRANSPORTATION_PROGRAMS' | 'REGULATION_AND_ADMINISTRATION_OF_COMMUNICATIONS_ELECTRIC_GAS_AND_OTHER_UTILITIES' | 'REGULATION_OF_AGRICULTURAL_MARKETING_AND_COMMODITIES' | 'REGULATION_LICENSING_AND_INSPECTION_OF_MISCELLANEOUS_COMMERCIAL_SECTORS' | 'SPACE_RESEARCH_AND_TECHNOLOGY' | 'NATIONAL_SECURITY' | 'INTERNATIONAL_AFFAIRS';
284
2449
  /**
285
- * One acceptance scope's obligation, under the field names it had before the rename. Carries the
286
- * same values as an entry of `disclosures`, and is removed with `capacities`.
2450
+ * In general it's compatible with CounterpartAddress model but
2451
+ * * All fields are optional
2452
+ * * There is an additional field original_country_name
287
2453
  */
288
- type DisclosureCapacityStateDto = {
289
- accepted: boolean;
290
- canAccept: boolean;
2454
+ type OcrAddress = {
291
2455
  /**
292
- * Who this disclosure binds. The former name of `acceptanceScope`.
2456
+ * City name.
293
2457
  */
294
- capacity: DisclosureAcceptanceScope;
295
- documents: Array<DisclosureDocumentDto>;
296
- graceDeadlineTsUtc?: null | string;
297
- standing: DisclosureStanding;
298
- version: string;
2458
+ city?: string | null;
2459
+ /**
2460
+ * Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
2461
+ */
2462
+ country?: string | null;
2463
+ /**
2464
+ * Street address.
2465
+ */
2466
+ line1?: string | null;
2467
+ /**
2468
+ * Additional address information (if any).
2469
+ */
2470
+ line2?: string | null;
2471
+ /**
2472
+ * Country name as it is stated in the document.
2473
+ */
2474
+ original_country_name?: string | null;
2475
+ /**
2476
+ * ZIP or postal code.
2477
+ */
2478
+ postal_code?: string | null;
2479
+ /**
2480
+ * State, region, province, or county.
2481
+ */
2482
+ state?: string | null;
2483
+ };
2484
+ type OcrResponseInvoiceReceiptData = {
2485
+ /**
2486
+ * Counterpart bank ID
2487
+ */
2488
+ counterpart_account_id?: string | null;
2489
+ /**
2490
+ * The bank account number
2491
+ */
2492
+ counterpart_account_number?: string | null;
2493
+ /**
2494
+ * Counterpart address
2495
+ */
2496
+ counterpart_address?: string | null;
2497
+ /**
2498
+ * Counterpart address as a json object compatible with counterparts service
2499
+ */
2500
+ counterpart_address_object?: OcrAddress | null;
2501
+ /**
2502
+ * The bank branch number
2503
+ */
2504
+ counterpart_branch_number?: string | null;
2505
+ /**
2506
+ * Email address of the counterpart
2507
+ */
2508
+ counterpart_email?: string | null;
2509
+ /**
2510
+ * Counterpart name
2511
+ */
2512
+ counterpart_name?: string | null;
2513
+ /**
2514
+ * Phone number of the counterpart
2515
+ */
2516
+ counterpart_phone?: string | null;
2517
+ /**
2518
+ * The bank routing number
2519
+ */
2520
+ counterpart_routing_number?: string | null;
2521
+ /**
2522
+ * Counterpart VAT ID
2523
+ */
2524
+ counterpart_vat_id?: string | null;
2525
+ /**
2526
+ * ISO 4217 currency code
2527
+ */
2528
+ currency?: string | null;
2529
+ /**
2530
+ * Discount Raw amount
2531
+ */
2532
+ discount_raw?: number | null;
2533
+ /**
2534
+ * Document due date in ISO format
2535
+ */
2536
+ document_due_date?: string | null;
2537
+ /**
2538
+ * Invoice/receipt ID
2539
+ */
2540
+ document_id?: string | null;
2541
+ /**
2542
+ * Document issuance date in ISO format
2543
+ */
2544
+ document_issued_at_date?: string | null;
2545
+ /**
2546
+ * List of line items from document raw, without minor units conversion.
2547
+ */
2548
+ line_items_raw?: Array<OcrResponseInvoiceReceiptLineItemRaw>;
2549
+ /**
2550
+ * Raw payment terms parsed but not calculated.
2551
+ */
2552
+ payment_terms_raw?: Array<string> | null;
2553
+ /**
2554
+ * Purchase Order Number
2555
+ */
2556
+ purchase_order_number?: string | null;
2557
+ /**
2558
+ * Tax payer ID
2559
+ */
2560
+ tax_payer_id?: string | null;
2561
+ /**
2562
+ * Subtotal, without minor units
2563
+ */
2564
+ total_excl_vat_raw?: number | null;
2565
+ /**
2566
+ * Total paid amount
2567
+ */
2568
+ total_paid_amount_raw?: number | null;
2569
+ /**
2570
+ * Total, without minor units
2571
+ */
2572
+ total_raw?: number | null;
2573
+ /**
2574
+ * VAT amount, without minor units
2575
+ */
2576
+ total_vat_amount_raw?: number | null;
2577
+ /**
2578
+ * VAT Percent raw, without minor units.
2579
+ */
2580
+ total_vat_rate_raw?: number | null;
2581
+ };
2582
+ type OcrResponseInvoiceReceiptLineItemRaw = {
2583
+ /**
2584
+ * Human-readable line item description
2585
+ */
2586
+ description?: string | null;
2587
+ /**
2588
+ * Item Quantity/Unit Price adjusted
2589
+ */
2590
+ item_adjusted?: boolean;
2591
+ /**
2592
+ * OCR Id of line item
2593
+ */
2594
+ line_item_ocr_id?: string | null;
2595
+ /**
2596
+ * Quantity
2597
+ */
2598
+ quantity?: number | null;
2599
+ /**
2600
+ * Total excluded VAT as parsed.
2601
+ */
2602
+ total_excl_vat?: number | null;
2603
+ /**
2604
+ * Total included VAT as parsed.
2605
+ */
2606
+ total_incl_vat?: number | null;
2607
+ /**
2608
+ * Unit
2609
+ */
2610
+ unit?: string | null;
2611
+ /**
2612
+ * Price as parsed
2613
+ */
2614
+ unit_price?: number | null;
2615
+ /**
2616
+ * VAT Amount as parsed.
2617
+ */
2618
+ vat_amount?: number | null;
2619
+ /**
2620
+ * VAT Percent as parsed.
2621
+ */
2622
+ vat_percentage?: number | null;
299
2623
  };
2624
+ type ObjectType = 'account' | 'accounting_config' | 'accounting_tax_rate' | 'approval' | 'approval_request' | 'approval_policy' | 'approval_policy_process' | 'audit_trail' | 'bank_account' | 'comment' | 'cost_center' | 'counterpart' | 'counterpart_address' | 'counterpart_bank_account' | 'counterpart_contact_person' | 'counterpart_partner_metadata' | 'counterpart_tax_id' | 'counterpart_vat_id' | 'delivery_note' | 'einvoicing' | 'entity' | 'entity_bank_account' | 'entity_settings' | 'entity_token' | 'entity_user' | 'entity_user_token' | 'entity_vat_ids' | 'export' | 'ledger_account' | 'mailbox' | 'monitescript_process' | 'ocr_task' | 'onboarding' | 'overdue_reminder' | 'partner' | 'partner_internal_config' | 'partner_settings' | 'partner_token' | 'payable' | 'payable_line_item' | 'payables_credit_note' | 'payables_purchase_order' | 'payment' | 'payment_intent' | 'payment_link' | 'payment_record' | 'payment_reminder' | 'person' | 'product' | 'project' | 'receivable' | 'reconciliation' | 'recurrence' | 'receipt' | 'role' | 'tag' | 'todo_task' | 'todo_task_mute' | 'transaction' | 'transaction_validation' | 'webhook' | 'workflow' | 'workflow_pipeline';
2625
+ type ObjectTypeEnum = 'receivable' | 'payable';
300
2626
  /**
301
- * One document the caller is being asked to accept.
2627
+ * Contains information about all text blocks extracted from an uploaded invoice by OCR.
2628
+ * The text blocks are grouped into `line_items` (invoice line items) and `summary` (all other information).
2629
+ * Legacy schema used for AWS textract recognition.
302
2630
  */
303
- type DisclosureDocumentDto = {
2631
+ type OcrRecognitionResponse = {
304
2632
  /**
305
- * Display name, as it should be shown to the user.
2633
+ * Text content of the invoice line items as recognized by OCR.
306
2634
  */
307
- title: string;
2635
+ line_items?: Array<LabelNValue> | null;
308
2636
  /**
309
- * Where the document is hosted. This service does not serve the file.
2637
+ * Invoice text content other than the line items. Such as the invoice issue and due dates, vendor name and address, and other general information.
310
2638
  */
311
- url: string;
2639
+ summary?: Array<LabelNValue> | null;
312
2640
  };
2641
+ type OcrStatusEnum = 'processing' | 'error' | 'success' | 'canceled';
313
2642
  /**
314
- * One acceptance scope's obligation and where it leaves the caller.
2643
+ * Response DTO for the organization details endpoint.
315
2644
  */
316
- type DisclosureDto = {
2645
+ type OrganizationDetailsResponseDto = {
317
2646
  /**
318
- * Who this disclosure binds, and so who can accept it.
2647
+ * The unique identifier of the organization.
319
2648
  */
320
- acceptanceScope: DisclosureAcceptanceScope;
2649
+ id: string;
2650
+ address?: null | AddressDto;
321
2651
  /**
322
- * Whether the obligation is met. On the ENTITY scope this is the organization's execution,
323
- * so it can be true for a caller who did nothing themselves.
2652
+ * Counts of direct child organizations grouped by type (e.g., {"VERTICAL_SOFTWARE_PROVIDER": 3, "EMBEDDED": 2}).
2653
+ * Empty dictionary if the organization has no children.
324
2654
  */
325
- accepted: boolean;
2655
+ childOrganizationTypeCounts?: {
2656
+ [key: string]: number | string;
2657
+ };
326
2658
  /**
327
- * Whether this caller can accept it. The ENTITY and SIGNER scopes are a designated
328
- * authorized signer's to accept; false on every scope when the read was made on an invitee's
329
- * behalf rather than by the person themselves.
2659
+ * The display name of the organization.
330
2660
  */
331
- canAccept: boolean;
2661
+ displayName: string;
332
2662
  /**
333
- * The disclosure in force for this scope. Submit it back when accepting.
2663
+ * The domain name / website of the organization.
334
2664
  */
335
- disclosureId: string;
2665
+ domainName?: null | string;
2666
+ embeddedBusinessData?: null | EmbeddedBusinessDataResponseDto;
336
2667
  /**
337
- * The documents making up this disclosure, in the order to present them.
2668
+ * Whether the organization is currently enabled (active within the time window).
338
2669
  */
339
- documents: Array<DisclosureDocumentDto>;
2670
+ isEnabled: boolean;
340
2671
  /**
341
- * When an unmet ENTITY obligation stops being tolerated. Only that scope runs a grace
342
- * period, so this is null on the others, and null once the obligation is met.
2672
+ * The legal name of the organization.
343
2673
  */
344
- graceDeadlineTsUtc?: null | string;
2674
+ legalName: string;
2675
+ logo?: null | OrganizationLogoResponseDto;
345
2676
  /**
346
- * Clear, owed with time left, or owed with the consequence applying now.
2677
+ * The organization's phone number, if available.
347
2678
  */
348
- standing: DisclosureStanding;
2679
+ phoneNumber?: null | string;
2680
+ /**
2681
+ * A short identifier for the organization.
2682
+ */
2683
+ shortName: string;
2684
+ /**
2685
+ * The types assigned to the organization (e.g., VSP, Bank).
2686
+ */
2687
+ types: Array<OrganizationType>;
349
2688
  };
350
- type DisclosureRequirement = 'NOT_REQUIRED' | 'REQUIRED';
351
2689
  /**
352
- * Where a caller stands against one acceptance scope's obligation. Three states rather than a boolean
353
- * because an unmet entity obligation runs a grace period before it restricts anything.
2690
+ * Response DTO for an organization's logo.
354
2691
  */
355
- type DisclosureStanding = 'CLEAR' | 'IN_GRACE' | 'EXPIRED';
2692
+ type OrganizationLogoResponseDto = {
2693
+ /**
2694
+ * The unique identifier of the logo asset.
2695
+ */
2696
+ id: string;
2697
+ /**
2698
+ * UTC timestamp indicating when the logo was uploaded.
2699
+ */
2700
+ createdTsUtc: string;
2701
+ /**
2702
+ * MD5 checksum of the original file.
2703
+ */
2704
+ md5: string;
2705
+ /**
2706
+ * The MIME type of the original file (e.g., "image/png").
2707
+ */
2708
+ mimetype: string;
2709
+ /**
2710
+ * Original filename of the uploaded logo.
2711
+ */
2712
+ name: string;
2713
+ /**
2714
+ * File size in bytes.
2715
+ */
2716
+ size: number | string;
2717
+ /**
2718
+ * Relative URL of the endpoint that serves the logo image.
2719
+ */
2720
+ url: string;
2721
+ };
2722
+ type OrganizationResponseSchema = {
2723
+ /**
2724
+ * Business structure of the company
2725
+ */
2726
+ business_structure?: EntityBusinessStructure | null;
2727
+ directors_provided?: boolean | null;
2728
+ executives_provided?: boolean | null;
2729
+ /**
2730
+ * A code which identifies uniquely a party of a transaction worldwide
2731
+ */
2732
+ legal_entity_id?: string | null;
2733
+ /**
2734
+ * The legal name of the organization.
2735
+ */
2736
+ legal_name: string;
2737
+ owners_provided?: boolean | null;
2738
+ representative_provided?: boolean | null;
2739
+ };
2740
+ type OrganizationType = 'BANK' | 'EMBEDDED' | 'PLATFORM' | 'TRANSACTOR' | 'VERTICAL_SOFTWARE_PROVIDER';
2741
+ type OverdueReminderResponse = {
2742
+ id: string;
2743
+ /**
2744
+ * Time at which the OverdueReminder was created. Timestamps follow the ISO 8601 standard.
2745
+ */
2746
+ created_at: string;
2747
+ /**
2748
+ * Time at which the OverdueReminder was last updated. Timestamps follow the ISO 8601 standard.
2749
+ */
2750
+ updated_at: string;
2751
+ name: string;
2752
+ recipients?: Recipients | null;
2753
+ /**
2754
+ * Overdue reminder terms to send for payment
2755
+ */
2756
+ terms?: Array<OverdueReminderTerm> | null;
2757
+ };
2758
+ type OverdueReminderTerm = {
2759
+ body: string;
2760
+ days_after: number;
2761
+ subject: string;
2762
+ };
356
2763
  /**
357
- * The disclosures in force for a caller, and whether they have accepted them.
2764
+ * When a PDF document is uploaded to Monite, it extracts individual pages from the document
2765
+ * and saves them as PNG images. This object contains the image and metadata of a single page.
358
2766
  */
359
- type DisclosuresResponseDto = {
2767
+ type PageSchema = {
2768
+ /**
2769
+ * A unique ID of the image.
2770
+ */
2771
+ id: string;
2772
+ /**
2773
+ * The [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the image.
2774
+ */
2775
+ mimetype: string;
2776
+ /**
2777
+ * The page number in the PDF document, from 0.
2778
+ */
2779
+ number: number;
2780
+ /**
2781
+ * Image file size, in bytes.
2782
+ */
2783
+ size: number;
2784
+ /**
2785
+ * The URL to download the image.
2786
+ */
2787
+ url: string;
2788
+ };
2789
+ type PageSchema2 = {
2790
+ /**
2791
+ * A unique ID of the image.
2792
+ */
2793
+ id: string;
2794
+ /**
2795
+ * The [media type](https://developer.mozilla.org/en-US/docs/Web/HTTP/MIME_types) of the image.
2796
+ */
2797
+ mimetype: string;
2798
+ /**
2799
+ * The page number in the PDF document, from 0.
2800
+ */
2801
+ number: number;
2802
+ /**
2803
+ * Image file size, in bytes.
2804
+ */
2805
+ size: number;
2806
+ /**
2807
+ * The URL to download the image.
2808
+ */
2809
+ url: string;
2810
+ };
2811
+ type PayableCreditNoteData = {
2812
+ /**
2813
+ * The unique identifier of the credit note.
2814
+ */
2815
+ id: string;
2816
+ /**
2817
+ * The credit note's unique document number.
2818
+ */
2819
+ document_id?: string | null;
2820
+ /**
2821
+ * The date when the credit note was issued, in the YYYY-MM-DD format
2822
+ */
2823
+ issued_at?: string | null;
360
2824
  /**
361
- * Whether this caller has accepted the PERSON disclosure above. False for an invitee, and
362
- * false again for an existing user once a new version is published.
363
- *
364
- * Deprecated. Duplicates the PERSON entry of `disclosures`. Read that instead; this is removed once every client has moved.
365
- *
366
- * @deprecated
2825
+ * The current status of the credit note in its lifecycle
367
2826
  */
368
- accepted: boolean;
2827
+ status: PayableCreditNoteStateEnum;
369
2828
  /**
370
- * The same entries under their former name and shape.
371
- *
372
- * Deprecated. Read `disclosures` instead. Removed once every client has moved.
373
- *
374
- * @deprecated
2829
+ * Credit note total amount.
375
2830
  */
376
- capacities?: Array<DisclosureCapacityStateDto>;
2831
+ total_amount?: number | null;
2832
+ };
2833
+ type PayableCreditNoteStateEnum = 'new' | 'draft' | 'applied' | 'approved' | 'rejected' | 'canceled' | 'submitted_for_approval';
2834
+ /**
2835
+ * One entry of a payable's `duplicates` list.
2836
+ */
2837
+ type PayableDuplicateEmbedded = {
377
2838
  /**
378
- * Every acceptance scope the caller's bank has a disclosure in force for, whether or not it
379
- * falls on this caller, so a client can show what governs the organization. Whether an entry
380
- * is this caller's to act on is carried by its `standing` and `canAccept`.
2839
+ * Unique ID of the duplicate match. Use it to dismiss or confirm the match.
381
2840
  */
382
- disclosures?: Array<DisclosureDto>;
2841
+ id: string;
2842
+ created_at: string;
2843
+ updated_at: string;
383
2844
  /**
384
- * The PERSON disclosure's documents, in the order to present them. Only that scope's:
385
- * `disclosures` carries the documents of every scope in force.
386
- *
387
- * Deprecated. Duplicates the PERSON entry of `disclosures`. Read that instead; this is removed once every client has moved.
388
- *
389
- * @deprecated
2845
+ * ID of the other payable of the pair.
390
2846
  */
391
- documents: Array<DisclosureDocumentDto>;
2847
+ matched_payable_id: string;
392
2848
  /**
393
- * Whether this caller's organization requires disclosures at all.
2849
+ * Current status of the other payable.
394
2850
  */
395
- requirement: DisclosureRequirement;
2851
+ matched_payable_status: PayableStateEnum;
396
2852
  /**
397
- * The PERSON disclosure in force, or null if the caller's bank has published none. This and
398
- * the two fields below describe that one scope; `disclosures` carries every scope.
399
- *
400
- * Deprecated. Duplicates the PERSON entry of `disclosures`. Read that instead; this is removed once every client has moved.
401
- *
402
- * @deprecated
2853
+ * When the match was dismissed or confirmed.
403
2854
  */
404
- version: null | string;
405
- };
406
- type Discount = {
2855
+ resolved_at?: string | null;
407
2856
  /**
408
- * The actual discount of the product in [minor units](https://docs.monite.com/references/currencies#minor-units) if type field equals amount, else in percent minor units
2857
+ * Entity user who dismissed or confirmed the match. Null while the match is suspected, and for verdicts made with a partner access token. Use `status` and `resolved_at` to tell whether the match is resolved.
409
2858
  */
410
- amount: number;
2859
+ resolved_by_user_id?: string | null;
411
2860
  /**
412
- * The field specifies whether to use product currency or %.
2861
+ * Review status of the match: `suspected` - awaiting review, `dismissed` - marked as not a duplicate, `confirmed` - confirmed as a duplicate. Dismissed and confirmed are final.
413
2862
  */
414
- type: DiscountType;
2863
+ status: PayableDuplicateStatusEnum;
415
2864
  };
416
- type DiscountResponse = {
2865
+ type PayableDuplicateStatusEnum = 'suspected' | 'dismissed' | 'confirmed';
2866
+ type PayableOriginEnum = 'upload' | 'email';
2867
+ type PayablePaymentTermDiscount = {
417
2868
  /**
418
- * The actual discount of the product in [minor units](https://docs.monite.com/references/currencies#minor-units) if type field equals amount, else in percent minor units
2869
+ * The discount percentage in minor units. E.g., 200 means 2%, 1050 means 10.5%.
419
2870
  */
420
- amount: number;
2871
+ discount: number;
421
2872
  /**
422
- * The field specifies whether to use product currency or %.
2873
+ * The amount of days after the invoice issue date.
423
2874
  */
424
- type: DiscountType;
2875
+ number_of_days: number;
2876
+ };
2877
+ type PayablePaymentTermFinal = {
425
2878
  /**
426
- * The monetary amount of the discount, in [minor units](https://docs.monite.com/references/currencies#minor-units). If the discount `type` is `amount`, this value is the same as the `amount` value. If `type` is `percentage`, the value is the calculated discount amount.
2879
+ * The amount of days after the invoice issue date.
427
2880
  */
428
- value?: number | null;
2881
+ number_of_days: number;
2882
+ };
2883
+ type PayablePaymentTermsCreatePayload = {
2884
+ description?: string | null;
2885
+ name: string;
2886
+ term_1?: PayablePaymentTermDiscount | null;
2887
+ term_2?: PayablePaymentTermDiscount | null;
2888
+ term_final: PayablePaymentTermFinal;
429
2889
  };
430
- type DiscountType = 'amount' | 'percentage';
431
2890
  /**
432
- * Rendering settings that control how different parts of the PDF documents are displayed.
433
- * Includes common settings for all document types such as quotes, invoices, and credit notes and document
434
- * type-specific settings that are defined in their respective objects.
2891
+ * Represents an Accounts Payable document received from a vendor or supplier.
435
2892
  */
436
- type DocumentRenderingSettings = {
2893
+ type PayableResponseSchema = {
437
2894
  /**
438
- * Credit note-specific rendering settings for PDF documents.
2895
+ * A unique ID assigned to this payable.
439
2896
  */
440
- credit_note?: CreditNoteRenderingSettings;
2897
+ id: string;
441
2898
  /**
442
- * If set to `true`, the line items table will be displayed on the quote PDF. Defaults to `true`.
2899
+ * UTC date and time when this payable was created. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
443
2900
  */
444
- display_line_items?: boolean;
2901
+ created_at: string;
445
2902
  /**
446
- * If set to `true`, the organization's bank account details will be displayed on the PDF documents. Defaults to `true`.
2903
+ * UTC date and time when this payable was last updated. Timestamps follow the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
447
2904
  */
448
- display_organization_bank_account?: boolean;
2905
+ updated_at: string;
449
2906
  /**
450
- * Invoice-specific rendering settings for PDF documents.
2907
+ * How much is left to be paid on the invoice (in minor units).
451
2908
  */
452
- invoice?: InvoiceRenderingSettings;
2909
+ amount_due?: number | null;
453
2910
  /**
454
- * Settings for rendering line items in PDF documents.
2911
+ * How much was paid on the invoice (in minor units).
455
2912
  */
456
- line_items?: LineItemsRenderingSettings;
2913
+ amount_paid?: number | null;
457
2914
  /**
458
- * Quote-specific rendering settings for PDF documents.
2915
+ * How much is left to be paid on the invoice (in minor units) with discounts from payment terms.
459
2916
  */
460
- quote?: QuoteRenderingSettings;
461
- };
462
- /**
463
- * Response representing an external bank account.
464
- */
465
- type ExternalBankAccountResponse = {
2917
+ amount_to_pay?: number | null;
466
2918
  /**
467
- * Unique identifier for the external bank account.
2919
+ * Id of existing approval policy that applies to this payable, if any. A policy is applied if the payable matches the policy trigger conditions.
468
2920
  */
469
- id: string;
470
- accountHolderType?: null | BankAccountHolderType;
2921
+ approval_policy_id?: string | null;
471
2922
  /**
472
- * Masked account number (last 4 digits visible).
2923
+ * Object representing de-normalized counterpart data. Filled at the moment of invoice submitting for approval or payment.
473
2924
  */
474
- accountNumber: string;
2925
+ counterpart?: CounterpartRawData | null;
475
2926
  /**
476
- * Status of the external bank account.
2927
+ * The ID of counterpart address object stored in counterparts service
477
2928
  */
478
- accountStatus: ExternalBankAccountStatusDto;
479
- microDepositVerification?: null | MicroDepositVerificationResponse;
2929
+ counterpart_address_id?: string | null;
480
2930
  /**
481
- * Name on the bank account.
2931
+ * The ID of counterpart bank account object stored in counterparts service
482
2932
  */
483
- nameOnAccount: string;
2933
+ counterpart_bank_account_id?: string | null;
484
2934
  /**
485
- * Nickname for the external bank account.
2935
+ * The ID of the counterpart object that represents the vendor or supplier.
486
2936
  */
487
- nickname: string;
2937
+ counterpart_id?: string | null;
488
2938
  /**
489
- * Bank routing number (ABA number).
2939
+ * Object representing counterpart data which was extracted by OCR. Used for informational purposes.
490
2940
  */
491
- routingNumber: string;
2941
+ counterpart_raw_data?: CounterpartRawData | null;
492
2942
  /**
493
- * Type of bank account (checking or savings).
2943
+ * The ID of counterpart VAT ID object stored in counterparts service
494
2944
  */
495
- type: ExternalBankAccountTypeDto;
2945
+ counterpart_vat_id_id?: string | null;
496
2946
  /**
497
- * Verification status of the external bank account.
2947
+ * The list of linked credit notes of the payable.
498
2948
  */
499
- verificationStatus: ExternalBankAccountVerificationStatusDto;
500
- };
501
- /**
502
- * Status of an external bank account.
503
- */
504
- type ExternalBankAccountStatusDto = 'ACTIVE' | 'INACTIVE';
505
- /**
506
- * Type of external bank account.
507
- */
508
- type ExternalBankAccountTypeDto = 'CHECKING' | 'SAVINGS';
509
- /**
510
- * Verification status of an external bank account.
511
- */
512
- type ExternalBankAccountVerificationStatusDto = 'UNVERIFIED' | 'VERIFICATION_SENT' | 'VERIFIED' | 'FAILED';
513
- type InlineTermDiscount = {
2949
+ credit_notes: Array<PayableCreditNoteData>;
514
2950
  /**
515
- * The discount percentage in minor units. E.g., 200 means 2%. 1050 means 10.5%.
2951
+ * The [currency code](https://docs.monite.com/references/currencies) of the currency used in the payable.
516
2952
  */
517
- discount: number;
518
- end_date?: string | null;
2953
+ currency?: CurrencyEnum | null;
2954
+ currency_exchange?: CurrencyExchangeSchema | null;
519
2955
  /**
520
- * The amount of days after the invoice issue date.
2956
+ * An arbitrary description of this payable.
521
2957
  */
522
- number_of_days?: number | null;
523
- };
524
- type InlineTermFinal = {
525
- end_date?: string | null;
2958
+ description?: string | null;
526
2959
  /**
527
- * The amount of days after the invoice issue date.
2960
+ * The discount stated on the document. This is informational only: total_amount is expected to already reflect it, and the API never applies or subtracts it separately. in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250.
528
2961
  */
529
- number_of_days?: number | null;
530
- };
531
- type InvoiceRenderingSettings = {
2962
+ discount?: number | null;
532
2963
  /**
533
- * If set to `true`, the organization's bank account details will be displayed on the invoice PDF.
2964
+ * A unique invoice number assigned by the invoice issuer for payment tracking purposes. This is different from `id` which is an internal ID created automatically by Monite.
534
2965
  */
535
- display_organization_bank_account?: boolean;
536
- };
537
- type InvoiceResponsePayload = {
538
- id: string;
2966
+ document_id?: string | null;
539
2967
  /**
540
- * Time at which the receivable was created. Timestamps follow the ISO 8601 standard.
2968
+ * The date by which the payable must be paid, in the YYYY-MM-DD format. If the payable specifies payment terms with early payment discounts, this is the final payment date.
541
2969
  */
542
- created_at: string;
2970
+ due_date?: string | null;
543
2971
  /**
544
- * Time at which the receivable was last updated. Timestamps follow the ISO 8601 standard.
2972
+ * Suspected and reviewed duplicates of this payable. Both payables of a matched pair see the same match. Ordered: suspected first, then confirmed, then dismissed, newest first within each group. At most 100 entries are returned.
545
2973
  */
546
- updated_at: string;
2974
+ duplicates?: Array<PayableDuplicateEmbedded>;
547
2975
  /**
548
- * How much is left to be paid in [minor units](https://docs.monite.com/references/currencies#minor-units). Equal 0 if the Invoice is fully paid.
2976
+ * Id of an existing approval policy that should be enforced when submitting the payable for approval.If this field is set, no other policies will be evaluated via their triggers - the specified policy will always be applied instead.
549
2977
  */
550
- amount_due: number;
2978
+ enforce_approval_policy_id?: string | null;
551
2979
  /**
552
- * How much has been paid [minor units](https://docs.monite.com/references/currencies#minor-units)
2980
+ * The ID of the entity to which the payable was issued.
553
2981
  */
554
- amount_paid: number;
2982
+ entity_id: string;
555
2983
  /**
556
- * How much is left to be paid in in [minor units](https://docs.monite.com/references/currencies#minor-units), including payment_term discounts.
2984
+ * The original file from which this payable was created.
557
2985
  */
558
- amount_to_pay?: number | null;
2986
+ file?: FileSchema | null;
559
2987
  /**
560
- * List of attachments to include with the receivable. Each attachment can be configured for email inclusion. If not provided, no attachments will be associated.
2988
+ * File id to retrieve the stored file info.
561
2989
  */
562
- attachments?: Array<AttachmentResponse> | null;
563
- bank_account_id?: string | null;
564
- bank_account_snapshot?: BankAccountSnapshot | null;
565
- bank_account_type?: string | null;
2990
+ file_id?: string | null;
566
2991
  /**
567
- * The unique ID of a previous document related to the receivable if applicable.
2992
+ * The date when the payable was issued, in the YYYY-MM-DD format.
568
2993
  */
569
- based_on?: string | null;
2994
+ issued_at?: string | null;
570
2995
  /**
571
- * The unique document ID of a previous document related to the receivable if applicable.
2996
+ * The ID of the entity user who marked this document as paid.
572
2997
  */
573
- based_on_document_id?: string | null;
2998
+ marked_as_paid_by_entity_user_id?: string | null;
574
2999
  /**
575
- * Field with a comment for pay/partially/uncollectible info on this Invoice
3000
+ * An arbitrary comment that describes how and when this payable was paid.
576
3001
  */
577
- comment?: string | null;
3002
+ marked_as_paid_with_comment?: string | null;
578
3003
  /**
579
- * The commercial terms of the receivable (e.g. The products must be delivered in X days).
3004
+ * Id of OCR request to match asynchronous result of processing payable.
580
3005
  */
581
- commercial_condition_description?: string | null;
3006
+ ocr_request_id?: string | null;
582
3007
  /**
583
- * Address of invoicing, need to state as a separate fields for some countries if it differs from address of a company.
3008
+ * The status of the data recognition process using OCR. The 'processing' status means that the data recognition is in progress and the user needs to wait for the data enrichment. The 'error' status indicates that some error occurred on the OCR side and the user can fill in the data manually. The 'success' status means the data recognition has been successfully completed, after which the user can check the data if desired and enrich or correct it.
584
3009
  */
585
- counterpart_billing_address?: ReceivablesRepresentationOfCounterpartAddress | null;
3010
+ ocr_status?: OcrStatusEnum | null;
586
3011
  /**
587
- * Different types of companies for different countries, ex. GmbH, SAS, SNC, etc.
3012
+ * Data extracted from the uploaded payable by OCR.
588
3013
  */
589
- counterpart_business_type?: string | null;
3014
+ other_extracted_data?: OcrResponseInvoiceReceiptData | OcrRecognitionResponse | null;
590
3015
  /**
591
- * Additional information about counterpart contacts.
3016
+ * The date by which the payable was paid
592
3017
  */
593
- counterpart_contact?: ReceivableCounterpartContact | null;
3018
+ paid_at?: string | null;
594
3019
  /**
595
- * The external reference of the counterpart.
3020
+ * Metadata for partner needs
596
3021
  */
597
- counterpart_external_reference?: string | null;
3022
+ partner_metadata?: {
3023
+ [key: string]: unknown;
3024
+ } | null;
598
3025
  /**
599
- * Unique ID of the counterpart.
3026
+ * Specifies how this payable was created in Monite: `upload` - created via an API call, `email` - sent via email to the entity's mailbox.
600
3027
  */
601
- counterpart_id: string;
3028
+ payable_origin: PayableOriginEnum;
602
3029
  /**
603
- * A legal name of a counterpart it is an organization or first and last name if it is an individual
3030
+ * The number of days to pay with potential discount for options shorter than due_date
604
3031
  */
605
- counterpart_name?: string | null;
3032
+ payment_terms?: PayablePaymentTermsCreatePayload | null;
606
3033
  /**
607
- * Address where goods were shipped / where services were provided.
3034
+ * Project id of a payable.
608
3035
  */
609
- counterpart_shipping_address?: ReceivablesRepresentationOfCounterpartAddress | null;
3036
+ project_id?: string | null;
610
3037
  /**
611
- * The VAT/TAX ID of the counterpart.
3038
+ * The identifier of the purchase order to which this payable belongs.
612
3039
  */
613
- counterpart_tax_id?: string | null;
3040
+ purchase_order_id?: string | null;
614
3041
  /**
615
- * The type of the counterpart.
3042
+ * The PO number as it appears on the document - not validated against, or linked to, any purchase order record. See `purchase_order_id` for that.
616
3043
  */
617
- counterpart_type: CounterpartType;
618
- counterpart_vat_id?: ReceivableCounterpartVatIdResponse | null;
3044
+ purchase_order_number?: string | null;
619
3045
  /**
620
- * The currency used in the receivable.
3046
+ * The date of this payable's earliest live scheduled payment, in the YYYY-MM-DD format, or `null` if it has none. This is the value `sort=scheduled_payment_date` orders by; payables with no live scheduled payment sort last in ascending order and first in descending order.
621
3047
  */
622
- currency: CurrencyEnum;
3048
+ scheduled_payment_date?: string | null;
623
3049
  /**
624
- * The amount of tax deducted in minor units
625
- *
626
- * @deprecated
3050
+ * The email address from which the invoice was sent to the entity.
627
3051
  */
628
- deduction_amount?: number | null;
3052
+ sender?: string | null;
629
3053
  /**
630
- * A note with additional information about a tax deduction
631
- *
632
- * @deprecated
3054
+ * Specifies how the property values of this payable were provided: `ocr` - Monite OCR service extracted the values from the provided PDF or image file, `user_specified` - values were added or updated via an API call.
633
3055
  */
634
- deduction_memo?: string | null;
3056
+ source_of_payable_data: SourceOfPayableDataEnum;
635
3057
  /**
636
- * List of deductions applied to the receivable (maximum 10 deductions allowed)
3058
+ * The [status](https://docs.monite.com/accounts-payable/payables/index) of the payable.
637
3059
  */
638
- deductions?: Array<DeductionItem> | null;
3060
+ status: PayableStateEnum;
639
3061
  /**
640
- * The discount for a receivable.
3062
+ * The subtotal amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250.
641
3063
  */
642
- discount?: DiscountResponse | null;
3064
+ subtotal?: number | null;
643
3065
  /**
644
- * Total price of the receivable with discounts before taxes [minor units](https://docs.monite.com/references/currencies#minor-units).
3066
+ * The suggested date and corresponding discount in which payable could be paid. The date is in the YYYY-MM-DD format. The discount is calculated as X * (10^-4) - for example, 100 is 1%, 25 is 0,25%, 10000 is 100 %. Date varies depending on the payment terms and may even be equal to the due date with discount 0.
645
3067
  */
646
- discounted_subtotal?: number | null;
3068
+ suggested_payment_term?: SuggestedPaymentTerm | null;
647
3069
  /**
648
- * The sequential code systematically assigned to invoices.
3070
+ * A list of user-defined tags (labels) assigned to this payable. Tags can be used to trigger a specific approval policy for this payable.
649
3071
  */
650
- document_id?: string | null;
3072
+ tags?: Array<TagReadSchema> | null;
651
3073
  /**
652
- * Settings for rendering documents in PDF format, including settings for line items and specific document types.
3074
+ * Registered tax percentage applied for a service price in minor units, e.g. 200 means 2%, 1050 means 10.5%.
653
3075
  */
654
- document_rendering?: DocumentRenderingSettings | null;
3076
+ tax?: number | null;
655
3077
  /**
656
- * Optional field representing date until which invoice should be paid
3078
+ * Tax amount in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250.
657
3079
  */
658
- due_date?: string | null;
659
- entity: ReceivableEntityOrganization | ReceivableEntityIndividual;
660
- entity_address: ReceivableEntityAddressSchema;
3080
+ tax_amount?: number | null;
661
3081
  /**
662
- * Deprecated. Always null; use `bank_account_snapshot` instead.
663
- *
664
- * @deprecated
3082
+ * The total amount to be paid, in [minor units](https://docs.monite.com/references/currencies#minor-units). For example, $12.50 is represented as 1250.
665
3083
  */
666
- entity_bank_account?: ReceivablesRepresentationOfEntityBankAccount | null;
3084
+ total_amount?: number | null;
667
3085
  /**
668
- * The entity user who created this document.
3086
+ * The total price of the payable in [minor units](https://docs.monite.com/references/currencies#minor-units), excluding all issued credit notes.
669
3087
  */
670
- entity_user_id?: string | null;
671
- entity_vat_id?: ReceivableEntityVatIdResponse | null;
3088
+ total_amount_with_credit_notes?: number | null;
3089
+ was_created_by_user_id?: string | null;
3090
+ };
3091
+ type PayableStateEnum = 'draft' | 'new' | 'approve_in_progress' | 'waiting_to_be_paid' | 'partially_paid' | 'paid' | 'canceled' | 'rejected';
3092
+ /**
3093
+ * Contains information about a payment received for an invoice.
3094
+ */
3095
+ type PaymentReceivedEventData = {
672
3096
  /**
673
- * The language of the customer-facing PDF file (`file_url`). The value matches the counterpart's `language` at the time when this PDF file was generated.
3097
+ * The remaining amount due of the invoice, in [minor units](https://docs.monite.com/references/currencies#minor-units) of the currency. For example, $12.5 is represented as 1250.
674
3098
  */
675
- file_language: LanguageCodeEnum;
3099
+ amount_due: number;
676
3100
  /**
677
- * The receivable's PDF URL in the counterpart's default language.
3101
+ * The payment amount, in minor units of the currency.
678
3102
  */
679
- file_url?: string | null;
3103
+ amount_paid: number;
680
3104
  /**
681
- * Optional text displayed below the line items table in the PDF.
3105
+ * A user-defined comment about this payment, or `null` if no comment was provided. Comments are available only for payments recorded via `POST /receivables/{receivable_id}/mark_as_paid` and `POST /receivables/{receivable_id}/mark_as_partially_paid`.
682
3106
  */
683
- footer?: string | null;
3107
+ comment?: string | null;
684
3108
  /**
685
- * The date when the goods are shipped or the service is provided. Can be a current, past, or future date.
686
- *
687
- * Some countries require the fulfillment date in invoices for regulatory compliance. In this case, if the fulfillment date was not provided by the user, it is automatically set to the invoice issue date once the invoice gets issued.
688
- *
689
- * In countries where the fulfillment date is optional, Monite does not auto-assign it if it was omitted by the user.
3109
+ * `true` if the payment was recorded manually rather than processed by the platform, `null` if not provided.
690
3110
  */
691
- fulfillment_date?: string | null;
3111
+ is_external?: boolean | null;
692
3112
  /**
693
- * Optional field for the issue of the entry.
3113
+ * Date and time when the payment was made, or `null` if not provided.
694
3114
  */
695
- issue_date?: string | null;
696
- line_items: Array<ResponseItem>;
3115
+ paid_at?: string | null;
697
3116
  /**
698
- * A note with additional information for a receivable.
3117
+ * ID of the payment intent that was paid, or `null` for a manual mark-as-paid.
699
3118
  */
700
- memo?: string | null;
3119
+ payment_intent_id?: string | null;
701
3120
  /**
702
- * The language of the entity's copy of the PDF file (`original_file_url`). The value matches the entity's `language` at the time when this PDF file was generated.
3121
+ * The payment method used, or `null` for a manual mark-as-paid.
703
3122
  */
704
- original_file_language: LanguageCodeEnum;
3123
+ payment_method?: string | null;
705
3124
  /**
706
- * The receivable's PDF URL in the entity's default language.
3125
+ * ID of the Reconciliation payment record behind this payment, or `null` for a manual mark-as-paid.
707
3126
  */
708
- original_file_url?: string | null;
709
- overdue_reminder_id?: string | null;
3127
+ payment_record_id?: string | null;
3128
+ };
3129
+ type PaymentRecordHistoryResponse = {
3130
+ entity_user_id?: string | null;
3131
+ status: PaymentRecordStatusEnum;
3132
+ /**
3133
+ * Timestamp of the change in a history
3134
+ */
3135
+ timestamp: string;
3136
+ };
3137
+ type PaymentRecordObjectResponse = {
3138
+ /**
3139
+ * ID of the invoice
3140
+ */
3141
+ id: string;
3142
+ /**
3143
+ * Status, in which object has been moved
3144
+ */
3145
+ new_status: string;
3146
+ /**
3147
+ * Status, in which object was before payment
3148
+ */
3149
+ old_status: string;
3150
+ type: ObjectTypeEnum;
3151
+ };
3152
+ type PaymentRecordResponse = {
3153
+ id: string;
3154
+ /**
3155
+ * Positive amount in case of successful payment, negative amount in case of payment failure or refund, represented in minor currency units (e.g., cents).
3156
+ */
3157
+ amount: number;
3158
+ /**
3159
+ * Currency code (ISO 4217) indicating the currency in which the payment was made.
3160
+ */
3161
+ currency: CurrencyEnum;
3162
+ /**
3163
+ * ID of the user associated with the payment, if applicable.
3164
+ */
3165
+ entity_user_id?: string | null;
710
3166
  /**
711
- * Date and time when the invoice was paid.
3167
+ * Failure reason reported by the payment provider, if the payment failed. Null otherwise.
712
3168
  */
713
- paid_at?: string | null;
3169
+ error_message?: string | null;
714
3170
  /**
715
- * Metadata for partner needs
3171
+ * History of the payment record.
716
3172
  */
717
- partner_metadata?: {
718
- [key: string]: unknown;
719
- };
3173
+ history: Array<PaymentRecordHistoryResponse>;
3174
+ is_external: boolean;
3175
+ object: PaymentRecordObjectResponse;
720
3176
  /**
721
- * Link to the invoice's payment page. Either Monite's payment links or your custom payment links.
3177
+ * Filled in a case, if payment amount is more, than total_amount
722
3178
  */
723
- payment_page_url?: string | null;
724
- payment_reminder_id?: string | null;
725
- payment_terms?: PaymentTerms | null;
3179
+ overpaid_amount?: number;
726
3180
  /**
727
- * A project related to current receivable
3181
+ * Timestamp marking when the payment was executed. Null if payment hasn't occurred yet.
728
3182
  */
729
- project_id?: string | null;
3183
+ paid_at?: string | null;
730
3184
  /**
731
- * Contain purchase order number.
3185
+ * Identifier for an payment intent.
732
3186
  */
733
- purchase_order?: string | null;
3187
+ payment_intent_id?: string | null;
734
3188
  /**
735
- * Stores an unique ID of a recurrence if the receivable is in a recurring status
3189
+ * Raw status string of the external payment intent.
736
3190
  */
737
- recurrence_id?: string | null;
3191
+ payment_intent_status?: string | null;
738
3192
  /**
739
- * Ids of documents that relate to invoice. I.e credit notes, proforma invoices, etc.
3193
+ * Payment method used or planned for the transaction.
740
3194
  */
741
- related_documents: RelatedDocuments;
3195
+ payment_method?: string | null;
742
3196
  /**
743
- * The status of the receivable inside the receivable workflow.
3197
+ * Scheduled date for future payments, required when the payment is planned but not yet executed.
744
3198
  */
745
- status: ReceivablesStatusEnum;
3199
+ planned_payment_date?: string | null;
746
3200
  /**
747
- * The subtotal (excluding tax), in [minor units](https://docs.monite.com/references/currencies#minor-units).
3201
+ * The current status of the payment record. Possible values: `created`, `processing`, `succeeded`, `canceled`.
748
3202
  */
749
- subtotal?: number | null;
3203
+ status?: string;
3204
+ };
3205
+ type PaymentRecordStatusEnum = 'created' | 'processing' | 'succeeded' | 'canceled';
3206
+ type PaymentReminderResponse = {
3207
+ id: string;
750
3208
  /**
751
- * The subtotal including tax but without invoice discount, in [minor units](https://docs.monite.com/references/currencies#minor-units).
3209
+ * Time at which the PaymentReminder was created. Timestamps follow the ISO 8601 standard.
752
3210
  */
753
- subtotal_after_tax?: number | null;
3211
+ created_at: string;
754
3212
  /**
755
- * The list of tags for this receivable.
3213
+ * Time at which the PaymentReminder was last updated. Timestamps follow the ISO 8601 standard.
756
3214
  */
757
- tags?: Array<TagReadSchema>;
3215
+ updated_at: string;
3216
+ entity_id: string;
3217
+ name: string;
3218
+ recipients?: Recipients | null;
3219
+ status: StatusEnum;
758
3220
  /**
759
- * Indicates whether the goods, materials, or services listed in the receivable are exempt from tax or not.
3221
+ * Reminder to send for first payment term
760
3222
  */
761
- tax_exempt?: boolean | null;
3223
+ term_1_reminder?: Reminder | null;
762
3224
  /**
763
- * The reason for the tax exemption, if applicable.
3225
+ * Reminder to send for second payment term
764
3226
  */
765
- tax_exemption_rationale?: string | null;
3227
+ term_2_reminder?: Reminder | null;
766
3228
  /**
767
- * Indicates whether the discount is applied to the tax-inclusive or tax-exclusive amount.
3229
+ * Reminder to send for final payment term
768
3230
  */
769
- tax_inclusive_discount_mode?: VatModeEnum;
3231
+ term_final_reminder?: Reminder | null;
3232
+ };
3233
+ type PaymentTerms = {
3234
+ id?: string | null;
770
3235
  /**
771
- * Defines whether the prices of products in receivable will already include tax or not.
3236
+ * Description of the payment term.
772
3237
  */
773
- tax_mode?: VatModeEnum;
3238
+ description?: string | null;
3239
+ name?: string | null;
774
3240
  /**
775
- * Total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units). Calculated as a subtotal + total_tax_amount.
3241
+ * The first tier of the payment term. Represents the terms of the first early discount.
776
3242
  */
777
- total_amount?: number;
3243
+ term_1?: InlineTermDiscount | null;
778
3244
  /**
779
- * The total price of the receivable in [minor units](https://docs.monite.com/references/currencies#minor-units), including tax and excluding all issued credit notes.
3245
+ * The second tier of the payment term. Defines the terms of the second early discount.
780
3246
  */
781
- total_amount_with_credit_notes: number;
3247
+ term_2?: InlineTermDiscount | null;
782
3248
  /**
783
- * The total deduction amount of all deductions, in [minor units](https://docs.monite.com/references/currencies#minor-units).
3249
+ * The final tier of the payment term. Defines the invoice due date.
784
3250
  */
785
- total_deduction_amount?: number | null;
3251
+ term_final: InlineTermFinal;
3252
+ };
3253
+ type PaymentTermsResponse = {
3254
+ id: string;
3255
+ description?: string | null;
3256
+ name: string;
786
3257
  /**
787
- * The total tax of all line items, in [minor units](https://docs.monite.com/references/currencies#minor-units).
3258
+ * The first tier of the payment term. Represents the terms of the first early discount.
788
3259
  */
789
- total_tax_amount: number;
3260
+ term_1?: TermDiscountDays | null;
790
3261
  /**
791
- * List of total tax amount for each tax rate, presented in receivable
3262
+ * The second tier of the payment term. Defines the terms of the second early discount.
792
3263
  */
793
- total_tax_amounts?: Array<TotalTaxAmountItem> | null;
3264
+ term_2?: TermDiscountDays | null;
794
3265
  /**
795
- * Total price of the receivable with tax withheld in minor units
3266
+ * The final tier of the payment term. Defines the invoice due date.
796
3267
  */
797
- total_withholding_tax?: number | null;
3268
+ term_final: TermFinalDays;
3269
+ };
3270
+ /**
3271
+ * A preview image generated for a file.
3272
+ */
3273
+ type PreviewSchema = {
798
3274
  /**
799
- * Trade name of the entity
3275
+ * The image height in pixels.
800
3276
  */
801
- trade_name?: string | null;
3277
+ height: number;
802
3278
  /**
803
- * The type of the document uploaded.
3279
+ * The image URL.
804
3280
  */
805
- type: 'invoice';
3281
+ url: string;
806
3282
  /**
807
- * The amount of tax withheld in percent minor units
3283
+ * The image width in pixels.
808
3284
  */
809
- withholding_tax_rate?: number | null;
3285
+ width: number;
810
3286
  };
811
- type LanguageCodeEnum = 'ab' | 'aa' | 'af' | 'ak' | 'sq' | 'am' | 'ar' | 'an' | 'hy' | 'av' | 'ae' | 'ay' | 'az' | 'bm' | 'ba' | 'eu' | 'be' | 'bn' | 'bi' | 'bs' | 'br' | 'bg' | 'my' | 'ca' | 'ch' | 'ce' | 'ny' | 'zh' | 'cu' | 'cv' | 'kw' | 'co' | 'cr' | 'hr' | 'cs' | 'da' | 'dv' | 'nl' | 'dz' | 'en' | 'eo' | 'et' | 'ee' | 'fo' | 'fj' | 'fi' | 'fr' | 'fy' | 'ff' | 'gd' | 'gl' | 'lg' | 'ka' | 'de' | 'el' | 'kl' | 'gn' | 'gu' | 'ht' | 'ha' | 'he' | 'hz' | 'hi' | 'ho' | 'hu' | 'io' | 'ig' | 'id' | 'ia' | 'ie' | 'iu' | 'ik' | 'ga' | 'it' | 'ja' | 'jv' | 'kn' | 'kr' | 'ks' | 'kk' | 'km' | 'ki' | 'rw' | 'ky' | 'kv' | 'kg' | 'ko' | 'kj' | 'ku' | 'lo' | 'la' | 'lv' | 'li' | 'ln' | 'lt' | 'lu' | 'lb' | 'mk' | 'mg' | 'ms' | 'ml' | 'mt' | 'gv' | 'mi' | 'mr' | 'mh' | 'mn' | 'na' | 'nv' | 'nd' | 'nr' | 'ng' | 'ne' | 'no' | 'nb' | 'nn' | 'ii' | 'oc' | 'oj' | 'om' | 'os' | 'pi' | 'ps' | 'fa' | 'pl' | 'pt' | 'pa' | 'qu' | 'ro' | 'rm' | 'rn' | 'ru' | 'se' | 'sm' | 'sg' | 'sa' | 'sc' | 'sr' | 'sn' | 'sd' | 'si' | 'sk' | 'sl' | 'so' | 'st' | 'es' | 'su' | 'sw' | 'ss' | 'sv' | 'tl' | 'ty' | 'tg' | 'ta' | 'tt' | 'te' | 'th' | 'bo' | 'ti' | 'to' | 'ts' | 'tn' | 'tr' | 'tk' | 'tw' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'cy' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zu';
812
- type LineItemColumnSettings = {
813
- display?: boolean;
3287
+ type PreviewSchema2 = {
814
3288
  /**
815
- * Line item table column header to override Monite's default. If not set, the Monite's default will be used.
3289
+ * The image height in pixels.
816
3290
  */
817
- label?: string | null;
3291
+ height: number;
3292
+ /**
3293
+ * The image URL.
3294
+ */
3295
+ url: string;
3296
+ /**
3297
+ * The image width in pixels.
3298
+ */
3299
+ width: number;
818
3300
  };
819
- /**
820
- * Extended settings for numeric columns in line items.
821
- */
822
- type LineItemNumericColumnSettings = {
823
- display?: boolean;
3301
+ type Price = {
824
3302
  /**
825
- * Line item table column header to override Monite's default. If not set, the Monite's default will be used.
3303
+ * The currency in which the price of the product is set.
826
3304
  */
827
- label?: string | null;
3305
+ currency: CurrencyEnum;
828
3306
  /**
829
- * Number of decimal places to display for numeric values in this column.
3307
+ * The actual price of the product.
830
3308
  */
831
- precision?: number | null;
3309
+ value: number;
832
3310
  };
833
- type LineItemProduct = {
3311
+ type ProductServiceResponse = {
834
3312
  /**
835
3313
  * Unique ID of the product.
836
3314
  */
837
3315
  id: string;
838
3316
  /**
839
- * Unique identifier of the accounting tax rate object.
3317
+ * Time at which the product was created. Timestamps follow the ISO 8601 standard.
840
3318
  */
841
- accounting_tax_rate_id?: string | null;
3319
+ created_at: string;
3320
+ /**
3321
+ * Time at which the product was last updated. Timestamps follow the ISO 8601 standard.
3322
+ */
3323
+ updated_at: string;
842
3324
  /**
843
3325
  * Description of the product.
844
3326
  */
845
3327
  description?: string | null;
3328
+ entity_id: string;
3329
+ entity_user_id?: string | null;
846
3330
  /**
847
3331
  * A user-defined identifier of the product. For example, an internal product code or SKU (stock keeping unit). Client applications can use this field to map the products in Monite to an external product catalog.
848
3332
  */
849
3333
  external_reference?: string | null;
3334
+ ledger_account_id?: string | null;
850
3335
  /**
851
- * Indicates whether the product is inline
3336
+ * The unique ID reference of the unit used to measure the quantity of this product (e.g. items, meters, kilograms).
852
3337
  */
853
- is_inline?: boolean;
854
- ledger_account_id?: string | null;
855
- measure_unit?: LineItemProductMeasureUnit | null;
3338
+ measure_unit_id?: string | null;
856
3339
  /**
857
3340
  * Name of the product.
858
3341
  */
859
3342
  name: string;
860
- price: Price;
861
- price_after_tax: Price;
3343
+ price?: Price | null;
862
3344
  /**
863
3345
  * The smallest amount allowed for this product.
864
3346
  */
865
3347
  smallest_amount?: number | null;
866
- tax_rate: LineItemProductTaxRate;
867
3348
  /**
868
3349
  * Specifies whether this offering is a product or service. This may affect the applicable tax rates.
869
3350
  */
870
3351
  type?: ProductServiceTypeEnum;
871
3352
  };
872
- type LineItemProductMeasureUnit = {
873
- id?: string | null;
874
- description?: string | null;
875
- name: string;
876
- };
877
- type LineItemProductTaxRate = {
878
- /**
879
- * Unique identifier of the tax rate object.
880
- */
881
- id?: string | null;
882
- /**
883
- * Sub-taxes included in the VAT.
884
- */
885
- components?: Array<VatRateComponent> | null;
886
- /**
887
- * Two-letter ISO country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).
888
- */
889
- country: AllowedCountries;
890
- /**
891
- * Indicates whether this tax rate is defined by user.
892
- */
893
- is_custom?: boolean;
3353
+ type ProductServiceTypeEnum = 'product' | 'service';
3354
+ type QuoteRenderingSettings = {
894
3355
  /**
895
- * Display name of the tax rate.
3356
+ * If set to `true`, the organization's bank account details will be displayed on the quote PDF.
896
3357
  */
897
- name?: string | null;
3358
+ display_organization_bank_account?: boolean;
898
3359
  /**
899
- * Percent minor units. Example: 12.5% is 1250.
3360
+ * If set to `true`, the signature field will be displayed on the quote PDF.
900
3361
  */
901
- value: number;
3362
+ display_signature?: boolean;
902
3363
  };
903
- type LineItemsRenderingSettings = {
3364
+ type ReceiptLinkSourceEnum = 'user' | 'automatched';
3365
+ type ReceiptOriginEnum = 'upload' | 'email';
3366
+ type ReceiptResponseSchema = {
904
3367
  /**
905
- * Settings for the discount column in the line items table.
3368
+ * Unique receipt ID.
906
3369
  */
907
- discount?: LineItemColumnSettings;
3370
+ id: string;
908
3371
  /**
909
- * Settings for the measure unit column in the line items table.
3372
+ * Creation timestamp.
910
3373
  */
911
- measure_unit?: LineItemColumnSettings;
3374
+ created_at: string;
912
3375
  /**
913
- * Settings for the name column in the line items table.
3376
+ * Update timestamp.
914
3377
  */
915
- name?: LineItemColumnSettings;
3378
+ updated_at: string;
916
3379
  /**
917
- * Settings for the price column in the line items table.
3380
+ * Entity user who created.
918
3381
  */
919
- price?: LineItemNumericColumnSettings;
3382
+ created_by_entity_user_id?: string | null;
920
3383
  /**
921
- * Settings for the price after tax column in the line items table.
3384
+ * Currency code.
922
3385
  */
923
- price_after_tax?: LineItemNumericColumnSettings;
3386
+ currency?: CurrencyEnum | null;
924
3387
  /**
925
- * Settings for the quantity column in the line items table.
3388
+ * Currency exchange details.
926
3389
  */
927
- quantity?: LineItemColumnSettings;
3390
+ currency_exchange?: {
3391
+ [key: string]: unknown;
3392
+ } | null;
928
3393
  /**
929
- * Settings for the tax rate column in the line items table.
3394
+ * Short transaction description.
930
3395
  */
931
- tax_rate?: LineItemNumericColumnSettings;
3396
+ description?: string | null;
932
3397
  /**
933
- * Settings for the total price column in the line items table.
3398
+ * Receipt number.
934
3399
  */
935
- total_price?: LineItemNumericColumnSettings;
3400
+ document_id?: string | null;
936
3401
  /**
937
- * Settings for the total price after tax column in the line items table.
3402
+ * The id of the stored receipt file.
938
3403
  */
939
- total_price_after_tax?: LineItemNumericColumnSettings;
3404
+ file_id?: string | null;
940
3405
  /**
941
- * Settings for the VAT amount column in the line items table.
3406
+ * The original file name.
942
3407
  */
943
- vat_amount?: LineItemNumericColumnSettings;
944
- };
945
- /**
946
- * A caller-managed Merchant Category Code group applied as an authorization control at the debit
947
- * card issuer. Exactly one of Guid? MccGroupResponse.OrganizationId (organization-scoped) or
948
- * Guid? MccGroupResponse.CardId (card-scoped) is set.
949
- */
950
- type MccGroupResponse = {
951
- id: string;
952
- active: boolean;
953
- cardId?: null | string;
954
- createdAt: string;
955
- mccs: Array<string>;
956
- name: string;
957
- organizationId?: null | string;
958
- updatedAt: string;
959
- };
960
- /**
961
- * Whether submitted micro-deposit amounts matched the ones deposited.
962
- */
963
- type MicroDepositVerificationOutcomeDto = 'AMOUNTS_MATCHED' | 'AMOUNTS_DID_NOT_MATCH';
964
- /**
965
- * The outcome of a micro-deposit validation attempt and what is left of the bank's allowance.
966
- */
967
- type MicroDepositVerificationResponse = {
3408
+ file_name?: string | null;
968
3409
  /**
969
- * The maximum number of validation attempts this account's bank allows.
3410
+ * The URL of the stored receipt file.
970
3411
  */
971
- attemptsAllowed: number | string;
3412
+ file_url?: string | null;
972
3413
  /**
973
- * Validation attempts left after this one.
3414
+ * Date when the receipt was issued.
974
3415
  */
975
- attemptsRemaining: number | string;
3416
+ issued_at?: string | null;
976
3417
  /**
977
- * Whether another set of amounts would be accepted for this account.
3418
+ * How the receipt was linked to a transaction.
978
3419
  */
979
- canAttemptAgain: boolean;
3420
+ link_source?: ReceiptLinkSourceEnum | null;
980
3421
  /**
981
- * Whether the bank's policy makes FAILED final. Banks that fail on the first incorrect attempt
982
- * always report false; canAttemptAgain reports whether the allowance is spent.
3422
+ * Merchant location.
983
3423
  */
984
- isTerminal: boolean;
3424
+ merchant_location?: string | null;
985
3425
  /**
986
- * Whether the submitted amounts matched the ones deposited.
3426
+ * Merchant name.
987
3427
  */
988
- outcome: MicroDepositVerificationOutcomeDto;
989
- };
990
- type OrganizationType = 'BANK' | 'EMBEDDED' | 'PLATFORM' | 'TRANSACTOR' | 'VERTICAL_SOFTWARE_PROVIDER';
991
- type PaymentTerms = {
992
- id?: string | null;
3428
+ merchant_name?: string | null;
993
3429
  /**
994
- * Description of the payment term.
3430
+ * OCR request id.
995
3431
  */
996
- description?: string | null;
997
- name?: string | null;
3432
+ ocr_request_id?: string | null;
998
3433
  /**
999
- * The first tier of the payment term. Represents the terms of the first early discount.
3434
+ * OCR status.
1000
3435
  */
1001
- term_1?: InlineTermDiscount | null;
3436
+ ocr_status?: string | null;
1002
3437
  /**
1003
- * The second tier of the payment term. Defines the terms of the second early discount.
3438
+ * Specifies how this receipt was created in Monite.
1004
3439
  */
1005
- term_2?: InlineTermDiscount | null;
3440
+ origin: ReceiptOriginEnum;
1006
3441
  /**
1007
- * The final tier of the payment term. Defines the invoice due date.
3442
+ * Partner metadata.
1008
3443
  */
1009
- term_final: InlineTermFinal;
1010
- };
1011
- type Price = {
3444
+ partner_metadata?: {
3445
+ [key: string]: unknown;
3446
+ } | null;
1012
3447
  /**
1013
- * The currency in which the price of the product is set.
3448
+ * The email address from which the invoice was sent to the entity.
1014
3449
  */
1015
- currency: CurrencyEnum;
3450
+ sender?: string | null;
1016
3451
  /**
1017
- * The actual price of the product.
3452
+ * Source of data.
1018
3453
  */
1019
- value: number;
1020
- };
1021
- type ProductServiceTypeEnum = 'product' | 'service';
1022
- type QuoteRenderingSettings = {
3454
+ source_of_data?: SourceOfReceiptDataEnum | null;
1023
3455
  /**
1024
- * If set to `true`, the organization's bank account details will be displayed on the quote PDF.
3456
+ * Total amount in minor units.
1025
3457
  */
1026
- display_organization_bank_account?: boolean;
3458
+ total_amount?: number | null;
1027
3459
  /**
1028
- * If set to `true`, the signature field will be displayed on the quote PDF.
3460
+ * Transaction ID.
1029
3461
  */
1030
- display_signature?: boolean;
3462
+ transaction_id?: string | null;
1031
3463
  };
1032
3464
  type ReceivableCounterpartContact = {
1033
3465
  /**
@@ -1062,6 +3494,23 @@ type ReceivableCounterpartVatIdResponse = {
1062
3494
  type?: VatIdTypeEnum;
1063
3495
  value: string;
1064
3496
  };
3497
+ /**
3498
+ * Contains information about a newly created receivable document.
3499
+ */
3500
+ type ReceivableCreatedEventData = {
3501
+ /**
3502
+ * How the document was created: directly (`manual`), derived from another document (`based_on`), or issued by a recurrence (`recurrence`).
3503
+ */
3504
+ source: ReceivableCreationSourceEnum;
3505
+ /**
3506
+ * The status the document was created with.
3507
+ */
3508
+ status: ReceivablesStatusEnum;
3509
+ };
3510
+ /**
3511
+ * How a receivable document came into being.
3512
+ */
3513
+ type ReceivableCreationSourceEnum = 'manual' | 'based_on' | 'recurrence';
1065
3514
  /**
1066
3515
  * A schema represents address info of the entity
1067
3516
  */
@@ -1188,6 +3637,111 @@ type ReceivableEntityVatIdResponse = {
1188
3637
  type?: VatIdTypeEnum;
1189
3638
  value: string;
1190
3639
  };
3640
+ type ReceivableFieldDiff = {
3641
+ new: unknown | null;
3642
+ new_label?: string | null;
3643
+ old: unknown | null;
3644
+ old_label?: string | null;
3645
+ };
3646
+ /**
3647
+ * Represents an entry in the change history of an accounts receivable document.
3648
+ */
3649
+ type ReceivableHistoryResponse = {
3650
+ /**
3651
+ * A unique ID of the history record.
3652
+ */
3653
+ id: string;
3654
+ /**
3655
+ * A URL of the PDF file that shows the document state after the change. Available only for the following event types: `receivable_created`, `receivable_updated`, `status_changed`, and `payment_received`. In other event types the `current_pdf_url` value is `null`.
3656
+ *
3657
+ * In `payment_received` events, the `current_pdf_url` value is available only in case of full payments and only if the entity setting `generate_paid_invoice_pdf` is `true`.
3658
+ *
3659
+ * Note that Monite generates PDFs asynchronously. This means that the initial value of `current_pdf_url` for the abovementioned events right after they occurred is usually `null` and the value gets populated later after the PDF document has been generated.
3660
+ */
3661
+ current_pdf_url?: string | null;
3662
+ /**
3663
+ * First name of the entity user who made the change, as it was at the time of the event. `null` on rows where it was not captured: `recorded_by` is `system`, the event predates this field, or the name could not be resolved when the row was written.
3664
+ */
3665
+ entity_user_first_name?: string | null;
3666
+ /**
3667
+ * ID of the entity user who made the change or trigger the event, or `null` if it was done by using a partner access token.
3668
+ */
3669
+ entity_user_id?: string | null;
3670
+ /**
3671
+ * Last name of the entity user who made the change, as it was at the time of the event. `null` on rows where it was not captured: `recorded_by` is `system`, the event predates this field, or the name could not be resolved when the row was written.
3672
+ */
3673
+ entity_user_last_name?: string | null;
3674
+ /**
3675
+ * ID of the role the entity user held at the time of the event. `null` on rows where it was not captured: `recorded_by` is `system`, the event predates this field, or the role could not be resolved when the row was written.
3676
+ */
3677
+ entity_user_role_id?: string | null;
3678
+ /**
3679
+ * Display name of the role the entity user held at the time of the event. `null` on rows where it was not captured: `recorded_by` is `system`, the event predates this field, or the role could not be resolved when the row was written.
3680
+ */
3681
+ entity_user_role_name?: string | null;
3682
+ /**
3683
+ * An object containing additional information about the event or change. The object structure varies based on the `event_type`. In `receivable_created` events it carries the document's initial `status` and its creation `source`. In `receivable_updated` events it carries a `fields` map describing what changed: each entry names a field and gives its `old` and `new` values. An update where nothing tracked changed carries an empty field map (`{"fields": {}}`).
3684
+ */
3685
+ event_data: StatusChangedEventData | ReceivableUpdatedEventData | ReceivableCreatedEventData | BasedOnReceivableCreatedEventData | PaymentReceivedEventData | MailSentEventData | ReminderMailSentEventData | DeletedEventData;
3686
+ /**
3687
+ * The type of the event or change.
3688
+ */
3689
+ event_type: string;
3690
+ /**
3691
+ * ID of the receivable document that was changed or triggered an event.
3692
+ */
3693
+ receivable_id: string;
3694
+ /**
3695
+ * Whether the row is attributed to an entity user or to no user: 'user' when entity_user_id is set, 'system' when it is null.
3696
+ */
3697
+ recorded_by: 'user' | 'system';
3698
+ /**
3699
+ * UTC date and time when the event or change occurred.
3700
+ */
3701
+ timestamp: string;
3702
+ };
3703
+ type ReceivableMailRecipientState = {
3704
+ /**
3705
+ * An email address of the recipient.
3706
+ */
3707
+ email: string;
3708
+ /**
3709
+ * An error message in case the mailing was unsuccessful.
3710
+ */
3711
+ error?: string | null;
3712
+ /**
3713
+ * Whether mail was sent successfully.
3714
+ */
3715
+ is_success: boolean;
3716
+ };
3717
+ type ReceivableMailRecipients = {
3718
+ bcc?: Array<ReceivableMailRecipientState>;
3719
+ cc?: Array<ReceivableMailRecipientState>;
3720
+ to?: Array<ReceivableMailRecipientState>;
3721
+ };
3722
+ type ReceivableMailResponse = {
3723
+ id: string;
3724
+ /**
3725
+ * The time the mail task was created
3726
+ */
3727
+ created_at: string;
3728
+ /**
3729
+ * The time the mail task was updated
3730
+ */
3731
+ updated_at: string;
3732
+ recipients?: ReceivableMailRecipients | null;
3733
+ /**
3734
+ * The status of the mail sent by receivable
3735
+ */
3736
+ status: ReceivableMailStatusEnum;
3737
+ };
3738
+ type ReceivableMailStatusEnum = 'pending' | 'processing' | 'sent' | 'partially_sent' | 'failed';
3739
+ type ReceivableType = 'quote' | 'invoice' | 'credit_note';
3740
+ type ReceivableUpdatedEventData = {
3741
+ fields?: {
3742
+ [key: string]: ReceivableFieldDiff;
3743
+ };
3744
+ };
1191
3745
  type ReceivablesRepresentationOfCounterpartAddress = {
1192
3746
  /**
1193
3747
  * Unique ID of the address in the system
@@ -1259,10 +3813,66 @@ type ReceivablesRepresentationOfEntityBankAccount = {
1259
3813
  * remove this shared Enum.
1260
3814
  */
1261
3815
  type ReceivablesStatusEnum = 'draft' | 'issued' | 'failed' | 'accepted' | 'expired' | 'declined' | 'recurring' | 'partially_paid' | 'paid' | 'overdue' | 'uncollectible' | 'canceled' | 'deleted';
3816
+ type Recipients = {
3817
+ bcc?: Array<string>;
3818
+ cc?: Array<string>;
3819
+ to?: Array<string>;
3820
+ };
1262
3821
  type RelatedDocuments = {
1263
3822
  credit_note_ids?: Array<string>;
1264
3823
  proforma_invoice_id?: string | null;
1265
3824
  };
3825
+ /**
3826
+ * Summary information for a user from a related organization.
3827
+ */
3828
+ type RelatedUserDto = {
3829
+ id: string;
3830
+ createdDateTime: string;
3831
+ department?: null | UserDepartmentDto;
3832
+ email: string;
3833
+ isAuthorizedSigner: boolean;
3834
+ jobTitle?: null | string;
3835
+ lastLoggedInDateTime?: null | string;
3836
+ location?: null | UserLocationDto;
3837
+ name: string;
3838
+ organizationId: string;
3839
+ organizationName: string;
3840
+ reportingManagerUserId?: null | string;
3841
+ role?: null | string;
3842
+ status: string;
3843
+ };
3844
+ type Reminder = {
3845
+ body: string;
3846
+ days_before: number;
3847
+ subject: string;
3848
+ };
3849
+ /**
3850
+ * Contains information about an invoice reminder sent via email.
3851
+ */
3852
+ type ReminderMailSentEventData = {
3853
+ /**
3854
+ * ID of the email sending operation. Can be used to get the email sending status from `GET /receivables/{receivable_id}/mails/{mail_id}`.
3855
+ */
3856
+ mail_id: string;
3857
+ /**
3858
+ * The overall email sending status across all recipients.
3859
+ */
3860
+ mail_status: ReceivableMailStatusEnum;
3861
+ /**
3862
+ * Contains a list of email recipients (To, CC, BCC) and the email sending status for each recipient.
3863
+ */
3864
+ recipients: ReceivableMailRecipients;
3865
+ /**
3866
+ * Invoice reminder type:
3867
+ *
3868
+ * * `term_1` - [payment reminder](https://docs.monite.com/accounts-receivable/invoices/payment-reminders) sent before discount date 1,
3869
+ * * `term_2` - payment reminder sent before discount date 2,
3870
+ * * `term_final` - payment reminder sent before the invoice due date.
3871
+ * * `overdue` - [overdue reminder](https://docs.monite.com/accounts-receivable/invoices/overdue-reminders) sent after the due date.
3872
+ */
3873
+ term: ReminderTypeEnum;
3874
+ };
3875
+ type ReminderTypeEnum = 'term_1' | 'term_2' | 'term_final' | 'overdue';
1266
3876
  type ResponseItem = {
1267
3877
  /**
1268
3878
  * Unique identifier of the line item within the receivable.
@@ -1294,6 +3904,95 @@ type ResponseItem = {
1294
3904
  */
1295
3905
  total_before_tax: number;
1296
3906
  };
3907
+ type RoleResponseDto = {
3908
+ id: string;
3909
+ appliesToOrgType?: null | string;
3910
+ createdDateTime: string;
3911
+ description?: null | string;
3912
+ icon?: null | string;
3913
+ isSystemRole?: boolean;
3914
+ key: SystemRoleKey | string;
3915
+ name: string;
3916
+ organizationId?: null | string;
3917
+ sortOrdinal: number | string;
3918
+ status: string;
3919
+ updatedDateTime: string;
3920
+ };
3921
+ type SourceOfData = {
3922
+ /**
3923
+ * Source of department_id.
3924
+ */
3925
+ department_id?: FieldSourceEnum | null;
3926
+ /**
3927
+ * Source of description.
3928
+ */
3929
+ description?: FieldSourceEnum | null;
3930
+ /**
3931
+ * Source of ledger_account_id.
3932
+ */
3933
+ ledger_account_id?: FieldSourceEnum | null;
3934
+ /**
3935
+ * Source of location_id.
3936
+ */
3937
+ location_id?: FieldSourceEnum | null;
3938
+ /**
3939
+ * Source of receipt_id.
3940
+ */
3941
+ receipt_id?: FieldSourceEnum | null;
3942
+ };
3943
+ type SourceOfPayableDataEnum = 'ocr' | 'user_specified';
3944
+ type SourceOfReceiptDataEnum = 'ocr' | 'user_specified';
3945
+ /**
3946
+ * Response model for an available bank account statement. Metadata only — identifies which
3947
+ * statements exist for the account, not the statement document itself.
3948
+ */
3949
+ type StatementResponse = {
3950
+ /**
3951
+ * Date the statement covers.
3952
+ */
3953
+ statementDate: string;
3954
+ /**
3955
+ * Opaque identifier for the statement, used to retrieve the statement document.
3956
+ */
3957
+ statementId: string;
3958
+ /**
3959
+ * Statement type code, when available (e.g. "ST").
3960
+ */
3961
+ statementType?: null | string;
3962
+ /**
3963
+ * Human-readable description of the statement type, when available (e.g. "Statements").
3964
+ */
3965
+ typeDescription?: null | string;
3966
+ };
3967
+ /**
3968
+ * Contains information about a document's status change. See the applicable
3969
+ * [invoice statuses](https://docs.monite.com/accounts-receivable/invoices/index),
3970
+ * [quote statuses](https://docs.monite.com/accounts-receivable/quotes/index),
3971
+ * and [credit note statuses](https://docs.monite.com/accounts-receivable/credit-notes#credit-note-lifecycle).
3972
+ */
3973
+ type StatusChangedEventData = {
3974
+ /**
3975
+ * A user-defined comment explaining the status change. Present only when a document is marked uncollectible with a comment; `null` otherwise.
3976
+ */
3977
+ comment?: string | null;
3978
+ /**
3979
+ * The new status of a document.
3980
+ */
3981
+ new_status: ReceivablesStatusEnum;
3982
+ /**
3983
+ * The old status of a document.
3984
+ */
3985
+ old_status: ReceivablesStatusEnum;
3986
+ };
3987
+ type StatusEnum = 'active' | 'deleted';
3988
+ /**
3989
+ * Suggested payment date and corresponding discount
3990
+ */
3991
+ type SuggestedPaymentTerm = {
3992
+ date: string;
3993
+ discount?: number | null;
3994
+ };
3995
+ type SystemRoleKey = 'bank:admin' | 'embedded:admin' | 'embedded:bookkeeper' | 'embedded:employee' | 'embedded:finance_admin' | 'platform:admin' | 'vsp:admin';
1297
3996
  type TagCategory = 'document_type' | 'department' | 'project' | 'cost_center' | 'vendor_type' | 'payment_method' | 'approval_status';
1298
3997
  /**
1299
3998
  * Represents a user-defined tag that can be assigned to resources to filter them.
@@ -1328,7 +4027,36 @@ type TagReadSchema = {
1328
4027
  */
1329
4028
  name: string;
1330
4029
  };
4030
+ /**
4031
+ * Response DTO for masked tax identification data.
4032
+ */
4033
+ type TaxIdResponseDto = {
4034
+ /**
4035
+ * The masked tax ID value showing only the last 2 digits (e.g., "*****34").
4036
+ */
4037
+ maskedTaxId: string;
4038
+ /**
4039
+ * The type of tax ID (e.g., EIN, SSN).
4040
+ */
4041
+ taxIdType: string;
4042
+ };
1331
4043
  type TaxStatusEnum = 'taxable' | 'exempt' | 'non_taxable';
4044
+ type TermDiscountDays = {
4045
+ /**
4046
+ * The discount percentage in minor units. E.g., 200 means 2%. 1050 means 10.5%.
4047
+ */
4048
+ discount: number;
4049
+ /**
4050
+ * The amount of days after the invoice issue date.
4051
+ */
4052
+ number_of_days: number;
4053
+ };
4054
+ type TermFinalDays = {
4055
+ /**
4056
+ * The amount of days after the invoice issue date.
4057
+ */
4058
+ number_of_days: number;
4059
+ };
1332
4060
  type TotalTaxAmountItem = {
1333
4061
  id?: string | null;
1334
4062
  /**
@@ -1363,6 +4091,154 @@ type TotalTaxAmountItemComponent = {
1363
4091
  */
1364
4092
  value: number;
1365
4093
  };
4094
+ type TransactionFieldsAllowedForValidate = 'receipt_id' | 'description';
4095
+ type TransactionPaymentMethod = ({
4096
+ type: 'card';
4097
+ } & CardPaymentMethod) | ({
4098
+ type: 'bank_account';
4099
+ } & BankAccountPaymentMethod);
4100
+ type TransactionRequiredFieldItem = {
4101
+ /**
4102
+ * Minimum transaction amount (in minor currency units) for this field to be required. Applied to the absolute value of the transaction amount, so out-flow (negative) amounts are evaluated by magnitude. If null, the field is always required.
4103
+ */
4104
+ amount_threshold?: number | null;
4105
+ field: TransactionFieldsAllowedForValidate;
4106
+ };
4107
+ type TransactionResponse = {
4108
+ /**
4109
+ * A unique Monite-generated ID assigned to this transaction.
4110
+ */
4111
+ id: string;
4112
+ /**
4113
+ * The transaction amount in [minor units](https://docs.monite.com/references/currencies#minor-units). Positive values for in-flow, negative values for out-flow.
4114
+ */
4115
+ amount: number;
4116
+ /**
4117
+ * ID of the approval policy applied to this transaction, if any.
4118
+ */
4119
+ applied_policy_id?: string | null;
4120
+ /**
4121
+ * ISO currency code.
4122
+ */
4123
+ currency: CurrencyEnum;
4124
+ /**
4125
+ * ID of the department associated with this transaction.
4126
+ */
4127
+ department_id?: string | null;
4128
+ /**
4129
+ * A human-readable description of the transaction.
4130
+ */
4131
+ description?: string | null;
4132
+ /**
4133
+ * ID of the entity that owns this resource.
4134
+ */
4135
+ entity_id: string;
4136
+ /**
4137
+ * ID of the entity user who made the transaction, if applicable.
4138
+ */
4139
+ entity_user_id?: string | null;
4140
+ /**
4141
+ * The current expense approval status of the transaction.
4142
+ */
4143
+ expense_status: ExpenseStatusEnum;
4144
+ /**
4145
+ * External identifier for idempotency, if provided by the source system.
4146
+ */
4147
+ external_id?: string | null;
4148
+ /**
4149
+ * Whether the transaction has missing required fields per the entity's TransactionValidation config. Always false when no config is set.
4150
+ */
4151
+ has_validation_errors: boolean;
4152
+ /**
4153
+ * ID of the ledger account from the Accounting service.
4154
+ */
4155
+ ledger_account_id?: string | null;
4156
+ /**
4157
+ * ID of the location associated with this transaction.
4158
+ */
4159
+ location_id?: string | null;
4160
+ /**
4161
+ * Original merchant transaction amount in minor units.
4162
+ */
4163
+ merchant_amount: number;
4164
+ /**
4165
+ * ISO currency code for the `merchant_amount`.
4166
+ */
4167
+ merchant_currency: CurrencyEnum;
4168
+ /**
4169
+ * The merchant location.
4170
+ */
4171
+ merchant_location: string;
4172
+ /**
4173
+ * The merchant name.
4174
+ */
4175
+ merchant_name: string;
4176
+ /**
4177
+ * Reason provided by the employee when submitting without a receipt (e.g. receipt was lost or unavailable). Set via the submit endpoint; bypasses the receipt_id required-field check.
4178
+ */
4179
+ no_receipt_reason?: string | null;
4180
+ /**
4181
+ * Extensible key-value pairs for storing additional custom information for partner needs.
4182
+ */
4183
+ partner_metadata?: {
4184
+ [key: string]: string;
4185
+ } | null;
4186
+ payment_method: TransactionPaymentMethod;
4187
+ /**
4188
+ * The current processing status of the transaction.
4189
+ */
4190
+ payment_processing_status?: TransactionStatusEnum;
4191
+ /**
4192
+ * URL of the attached receipt's file. Present when receipt_id is set and the receipt is reachable; null otherwise.
4193
+ */
4194
+ receipt_file_url?: string | null;
4195
+ /**
4196
+ * ID of the related receipt from payables service, if any.
4197
+ */
4198
+ receipt_id?: string | null;
4199
+ /**
4200
+ * Optional reason explaining why the transaction was rejected.
4201
+ */
4202
+ reject_reason?: string | null;
4203
+ /**
4204
+ * Per-field source tracking. Each field indicates how its value was set: user, generated, or automatched.
4205
+ */
4206
+ source_of_data?: SourceOfData | null;
4207
+ /**
4208
+ * Date and time when the transaction was initiated.
4209
+ */
4210
+ started_at: string;
4211
+ /**
4212
+ * The nature of the transaction.
4213
+ */
4214
+ type: TransactionTypeEnum;
4215
+ };
4216
+ type TransactionStatusEnum = 'created' | 'processing' | 'succeeded' | 'declined' | 'refunded' | 'failed';
4217
+ type TransactionTypeEnum = 'capture' | 'refund' | 'cash_withdrawal' | 'fee' | 'adjustment' | 'reversal';
4218
+ type TransactionValidationResponse = {
4219
+ required_fields: Array<TransactionRequiredFieldItem>;
4220
+ };
4221
+ type UnitResponse = {
4222
+ id: string;
4223
+ created_at: string;
4224
+ updated_at: string;
4225
+ description?: string | null;
4226
+ name: string;
4227
+ };
4228
+ /**
4229
+ * A department reference on a user response.
4230
+ */
4231
+ type UserDepartmentDto = {
4232
+ id: string;
4233
+ name: string;
4234
+ };
4235
+ /**
4236
+ * A location reference on a user response.
4237
+ */
4238
+ type UserLocationDto = {
4239
+ id: string;
4240
+ name: string;
4241
+ };
1366
4242
  type VatIdTypeEnum = 'ae_trn' | 'au_abn' | 'au_arn' | 'bg_uic' | 'br_cnpj' | 'br_cpf' | 'ca_bn' | 'ca_gst_hst' | 'ca_pst_bc' | 'ca_pst_mb' | 'ca_pst_sk' | 'ca_qst' | 'ch_vat' | 'cl_tin' | 'es_cif' | 'eu_oss_vat' | 'eu_vat' | 'gb_vat' | 'ge_vat' | 'hk_br' | 'hu_tin' | 'id_npwp' | 'il_vat' | 'in_gst' | 'is_vat' | 'jp_cn' | 'jp_rn' | 'kr_brn' | 'li_uid' | 'mx_rfc' | 'my_frp' | 'my_itn' | 'my_sst' | 'no_vat' | 'nz_gst' | 'ru_inn' | 'ru_kpp' | 'sa_vat' | 'sg_gst' | 'sg_uen' | 'si_tin' | 'th_vat' | 'tw_vat' | 'ua_vat' | 'us_ein' | 'za_vat' | 'unknown';
1367
4243
  type VatModeEnum = 'exclusive' | 'inclusive';
1368
4244
  type VatRateComponent = {
@@ -1451,6 +4327,44 @@ type WidgetInitResponse = {
1451
4327
  };
1452
4328
  type WidgetUserStatus = 'ACTIVE' | 'INACTIVE' | 'INVITED' | 'NOT_FOUND';
1453
4329
 
4330
+ /**
4331
+ * That organization's own record, as
4332
+ * `GET /identity/v1/organizations/{organizationId}` returns it.
4333
+ *
4334
+ * `address` is the fixture's whole reason for existing: it is what the
4335
+ * create-card flow offers as "the business address on file", and the shipping
4336
+ * address it posts for a physical card is built from it. It is deliberately
4337
+ * **complete** — `address1` is what `isBusinessAddressComplete` requires, and
4338
+ * without it the mailing option renders but Create stays disabled with nothing
4339
+ * on screen to say why. A story wanting that state drops the field by spreading.
4340
+ *
4341
+ * Kept in step with {@link A_DEBIT_CARD}'s billing address, since both describe
4342
+ * the same fictional business.
4343
+ */
4344
+ declare const AN_ORGANIZATION: OrganizationDetailsResponseDto;
4345
+ /**
4346
+ * One organization role, as `GET /identity/v1/roles` returns it.
4347
+ *
4348
+ * `organizationId` is set rather than left null, which makes this a custom role
4349
+ * scoped to one org. `filterRolesForOrganization` then admits it on the org id
4350
+ * alone, so the fixture does not also have to agree with an `organizationTypes`
4351
+ * list that {@link A_WIDGET_INIT} deliberately does not carry.
4352
+ */
4353
+ declare const AN_ORGANIZATION_ROLE: RoleResponseDto;
4354
+ /**
4355
+ * One organization user, as `GET /identity/v1/users` returns it.
4356
+ *
4357
+ * Two fields are not free choices. `id` is {@link A_USER_ID}, so the roster
4358
+ * names the same person widget init says is reading. And `role` carries
4359
+ * {@link AN_ORGANIZATION_ROLE}'s **key**, which is the shape the roster uses; a
4360
+ * value matching no role still renders, as a title-cased key, so a broken join
4361
+ * looks like a slightly odd role name rather than a failure.
4362
+ */
4363
+ declare const AN_ORGANIZATION_USER: RelatedUserDto;
4364
+ declare const AN_ENTITY_USER: EntityUserResponse;
4365
+ declare const AN_ENTITY: EntityOrganizationResponse;
4366
+ declare const A_DEPARTMENT: DepartmentListItem;
4367
+ declare const A_LOCATION: LocationListItem;
1454
4368
  /**
1455
4369
  * A widget-init response that renders the widget rather than a gate.
1456
4370
  *
@@ -1512,6 +4426,24 @@ declare const A_DEBIT_CARD: DebitCardDetailResponse;
1512
4426
  declare const A_DEBIT_CARD_CREDENTIALS: DebitCardCredentialsResponse;
1513
4427
  /** Debit counterpart of {@link A_PENDING_CREDIT_CARD}, and typed for the same reason. */
1514
4428
  declare const A_PENDING_DEBIT_CARD: DebitCardDetailResponse;
4429
+ /**
4430
+ * One caller-managed Merchant Category Code group, as
4431
+ * `GET /authorization-controls/merchant-category-groups` returns it.
4432
+ *
4433
+ * `active: true` matches the only query the widgets issue — the read filters on
4434
+ * it — so an inactive fixture would be a page the API never serves.
4435
+ */
4436
+ declare const A_MERCHANT_CATEGORY_GROUP: MccGroupResponse;
4437
+ /**
4438
+ * What `POST /authorization-controls/velocity-controls` answers with, for a
4439
+ * monthly spend limit scoped to {@link A_DEBIT_CARD}.
4440
+ *
4441
+ * Nothing in the create-card flow renders this body — the card is already on the
4442
+ * success screen by the time it lands. It is here for the same reason
4443
+ * {@link A_BOOK_MONEY_MOVEMENT} is: the write has to answer *something* typed,
4444
+ * and an untyped one would let a reshaped response through.
4445
+ */
4446
+ declare const A_VELOCITY_CONTROL: VelocityControlResponse;
1515
4447
  /**
1516
4448
  * The account {@link A_DEBIT_CARD} is drawn on.
1517
4449
  *
@@ -1520,6 +4452,18 @@ declare const A_PENDING_DEBIT_CARD: DebitCardDetailResponse;
1520
4452
  * a fixture whose id did not match would render the em-dash and look like a bug.
1521
4453
  */
1522
4454
  declare const A_BANK_ACCOUNT: BankAccountWithBalanceResponse;
4455
+ /**
4456
+ * One transaction on {@link A_BANK_ACCOUNT}, as
4457
+ * `GET /bank-accounts/{id}/transactions` returns it.
4458
+ *
4459
+ * `runningBalance` is that account's `balance` rather than a number of its own.
4460
+ * The details screen shows the balance above the table and this row inside it,
4461
+ * so two values that disagree read as an arithmetic bug in the widget — this is
4462
+ * the newest row, and the newest row's running balance *is* the balance.
4463
+ */
4464
+ declare const A_BANK_ACCOUNT_TRANSACTION: BankAccountTransactionResponse;
4465
+ declare const A_BANK_ACCOUNT_APPLICATION: BankAccountApplicationResponse;
4466
+ declare const A_COMPLETE_BANK_ACCOUNT_APPLICATION: ApplicationStatusEntry;
1523
4467
  /**
1524
4468
  * An outside account that has finished micro-deposit verification, as
1525
4469
  * `GET /external-bank-accounts` returns it.
@@ -1546,6 +4490,20 @@ declare const AN_EXTERNAL_BANK_ACCOUNT: ExternalBankAccountResponse;
1546
4490
  * stands; a story wanting both ends resolved re-points them by spreading.
1547
4491
  */
1548
4492
  declare const A_BANK_ACCOUNT_TRANSFER: BankAccountTransferResponse;
4493
+ /**
4494
+ * What `POST /money-movements/book` answers with, describing the same movement
4495
+ * {@link A_BANK_ACCOUNT_TRANSFER} is later read back as.
4496
+ *
4497
+ * Derived from it rather than spelled out again so the pair cannot drift: a
4498
+ * write and the read that follows it disagreeing about amount or direction is
4499
+ * the one thing a transfer story would not survive. `PENDING` because a
4500
+ * just-accepted movement has not settled — the read is the `COMPLETED` half.
4501
+ *
4502
+ * Nothing in the widget renders this body; it is here because the write has to
4503
+ * answer *something* typed, and an untyped one would let a reshaped response
4504
+ * through.
4505
+ */
4506
+ declare const A_BOOK_MONEY_MOVEMENT: MoneyMovementResponse;
1549
4507
  /**
1550
4508
  * `GET /identity/v1/disclosures` for a caller who owes nothing, as every widget
1551
4509
  * that reads it wants it by default.
@@ -1554,7 +4512,7 @@ declare const A_BANK_ACCOUNT_TRANSFER: BankAccountTransferResponse;
1554
4512
  * decides whether `WidgetProvider` replaces the widget with the acceptance
1555
4513
  * gate, and this read decides what the widget itself does about disclosures, so
1556
4514
  * a fixture disagreeing with init would put a story in a state the product
1557
- * cannot be in. `documents` is empty because nothing renders them while
4515
+ * cannot be in. `disclosures` is empty because nothing renders them while
1558
4516
  * `requirement` is `NOT_REQUIRED`.
1559
4517
  */
1560
4518
  declare const NO_DISCLOSURES_OWED: DisclosuresResponseDto;
@@ -1584,6 +4542,62 @@ declare const A_DISCLOSURES_SET: DisclosuresResponseDto;
1584
4542
  * kicks afterwards — so it is here to keep the write typed.
1585
4543
  */
1586
4544
  declare const A_DISCLOSURE_ACCEPTANCE: WidgetDisclosureAcceptance;
4545
+ /**
4546
+ * One uploaded receipt with no transaction yet, as `GET /finops/v1/receipts`
4547
+ * returns it.
4548
+ *
4549
+ * Two fields are not free choices. `created_by_entity_user_id` is
4550
+ * {@link A_WIDGET_INIT}'s user, because the match flow drops any receipt
4551
+ * belonging to a *different* user — a broad `receipt:read` token can see other
4552
+ * people's — so a mismatched id renders as an empty inbox with nothing to say
4553
+ * why. And `ocr_status` is deliberately not `'processing'`: the widget polls the
4554
+ * receipts read every five seconds while any receipt is scanning, which would
4555
+ * put every story holding this fixture on a timer.
4556
+ */
4557
+ declare const A_RECEIPT: ReceiptResponseSchema;
4558
+ /**
4559
+ * The card transaction {@link A_RECEIPT} belongs to, as
4560
+ * `GET /finops/v1/transactions` returns it.
4561
+ *
4562
+ * `amount` is **negative** because a purchase is an out-flow, which is how the
4563
+ * API models it and what the seeded e2e expenses send. The picker's Amount
4564
+ * column therefore reads `-$103.22` rather than `$103.22`; that is the widget
4565
+ * rendering the field it is given, not a typo here.
4566
+ *
4567
+ * `merchant_name` matches the receipt's so a story's match reads as a plausible
4568
+ * one, and `entity_user_id` matches for the same reason the receipt's does.
4569
+ */
4570
+ declare const A_TRANSACTION: TransactionResponse;
4571
+ /**
4572
+ * One expense approval policy, as `GET /finops/v1/approval-policies` returns it.
4573
+ *
4574
+ * `object_type` is `'transaction'`, not the endpoint's `'payable'` default: one
4575
+ * endpoint serves both BillPay and Expense and each reads only its own slice, so
4576
+ * a payable policy here would be an answer to a request the expense widget never
4577
+ * makes.
4578
+ *
4579
+ * `trigger` and `script` are the stored DSL rather than decoration. The widget
4580
+ * parses them back into the rule a card renders, and every shape it fails to
4581
+ * recognise falls through to "for all expenses, auto-approve" — a card that
4582
+ * looks fine and says nothing about what was stored. This one reads back as
4583
+ * *require approval from {@link AN_ORGANIZATION_ROLE} for expenses of $100 or
4584
+ * more*, with the threshold in **cents**, which is how the trigger holds it.
4585
+ */
4586
+ declare const AN_APPROVAL_POLICY: ApprovalPolicyResource;
4587
+ declare const A_MEASURE_UNIT: UnitResponse;
4588
+ declare const A_PRODUCT: ProductServiceResponse;
4589
+ /**
4590
+ * One customer counterpart, as `GET /finops/v1/counterparts` returns it.
4591
+ *
4592
+ * Typed as the organization member of the union rather than as
4593
+ * `CounterpartResponse`, so a story can read `organization.legal_name` without
4594
+ * narrowing — and so the name it asserts on is the one the fixture serves.
4595
+ *
4596
+ * `is_customer` is what the check-deposit picker filters on; `is_vendor` stays
4597
+ * false so the same record cannot also stand in for a bill's payee.
4598
+ */
4599
+ declare const A_CUSTOMER_COUNTERPART: CounterpartOrganizationRootResponse;
4600
+ declare const A_COUNTERPART_ADDRESS: CounterpartAddressResponseWithCounterpartId;
1587
4601
  /**
1588
4602
  * One outstanding invoice for {@link A_CUSTOMER_COUNTERPART}, as
1589
4603
  * `GET /finops/v1/receivables?type=invoice` returns it.
@@ -1603,5 +4617,30 @@ declare const A_DISCLOSURE_ACCEPTANCE: WidgetDisclosureAcceptance;
1603
4617
  * `line_items` is empty because nothing in the deposit flow reads it.
1604
4618
  */
1605
4619
  declare const AN_OUTSTANDING_INVOICE: InvoiceResponsePayload;
4620
+ declare const AN_INVOICE_LINE_ITEM: ResponseItem;
4621
+
4622
+ declare const A_PAYMENT_TERMS: PaymentTermsResponse;
4623
+ declare const A_PAYMENT_REMINDER: PaymentReminderResponse;
4624
+ declare const AN_OVERDUE_REMINDER: OverdueReminderResponse;
4625
+ declare const A_RECEIVABLE_HISTORY_ENTRY: ReceivableHistoryResponse;
4626
+ declare const A_RECEIVABLE_MAIL: ReceivableMailResponse;
4627
+ declare const A_PAYMENT_RECORD: PaymentRecordResponse;
4628
+ declare const A_FILE: FileResponse;
4629
+ declare const AN_ENTITY_BANK_ACCOUNT: EntityBankAccountResponse;
4630
+
4631
+ declare const AN_APPROVAL_REQUEST: ApprovalRequestResourceForCaller;
4632
+ declare const AN_EXPENSE_HISTORY_ENTRY: ExpenseHistoryEntryResponse;
4633
+ declare const A_TRANSACTION_VALIDATION: TransactionValidationResponse;
4634
+ declare const A_LEDGER_ACCOUNT: LedgerAccountResponse;
4635
+ declare const A_RECEIPTS_MAILBOX: MailboxResponse;
4636
+
4637
+ declare const A_BUSINESS_DETAILS: BusinessDetailsOutput;
4638
+ declare const AN_APPLICANT: BankAccountApplicantOutput;
4639
+
4640
+ declare const A_PAYABLES_MAILBOX: MailboxResponse;
4641
+ declare const A_PAYABLE: PayableResponseSchema;
4642
+ declare const A_COUNTERPART_BANK_ACCOUNT: CounterpartBankAccountResponse;
4643
+
4644
+ declare const A_BANK_ACCOUNT_STATEMENT: StatementResponse;
1606
4645
 
1607
- export { AN_EXTERNAL_BANK_ACCOUNT, AN_OUTSTANDING_INVOICE, A_BANK_ACCOUNT, A_BANK_ACCOUNT_TRANSFER, A_CREDIT_CARD, A_DEBIT_CARD, A_DEBIT_CARD_CREDENTIALS, A_DISCLOSURES_SET, A_DISCLOSURE_ACCEPTANCE, A_PENDING_CREDIT_CARD, A_PENDING_DEBIT_CARD, A_WIDGET_INIT, NO_DISCLOSURES_OWED };
4646
+ export { AN_APPLICANT, AN_APPROVAL_POLICY, AN_APPROVAL_REQUEST, AN_ENTITY, AN_ENTITY_BANK_ACCOUNT, AN_ENTITY_USER, AN_EXPENSE_HISTORY_ENTRY, AN_EXTERNAL_BANK_ACCOUNT, AN_INVOICE_LINE_ITEM, AN_ORGANIZATION, AN_ORGANIZATION_ROLE, AN_ORGANIZATION_USER, AN_OUTSTANDING_INVOICE, AN_OVERDUE_REMINDER, A_BANK_ACCOUNT, A_BANK_ACCOUNT_APPLICATION, A_BANK_ACCOUNT_STATEMENT, A_BANK_ACCOUNT_TRANSACTION, A_BANK_ACCOUNT_TRANSFER, A_BOOK_MONEY_MOVEMENT, A_BUSINESS_DETAILS, A_COMPLETE_BANK_ACCOUNT_APPLICATION, A_COUNTERPART_ADDRESS, A_COUNTERPART_BANK_ACCOUNT, A_CREDIT_CARD, A_CUSTOMER_COUNTERPART, A_DEBIT_CARD, A_DEBIT_CARD_CREDENTIALS, A_DEPARTMENT, A_DISCLOSURES_SET, A_DISCLOSURE_ACCEPTANCE, A_FILE, A_LEDGER_ACCOUNT, A_LOCATION, A_MEASURE_UNIT, A_MERCHANT_CATEGORY_GROUP, A_PAYABLE, A_PAYABLES_MAILBOX, A_PAYMENT_RECORD, A_PAYMENT_REMINDER, A_PAYMENT_TERMS, A_PENDING_CREDIT_CARD, A_PENDING_DEBIT_CARD, A_PRODUCT, A_RECEIPT, A_RECEIPTS_MAILBOX, A_RECEIVABLE_HISTORY_ENTRY, A_RECEIVABLE_MAIL, A_TRANSACTION, A_TRANSACTION_VALIDATION, A_VELOCITY_CONTROL, A_WIDGET_INIT, NO_DISCLOSURES_OWED };