@goodsamsoftware/freshbooks-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +357 -0
- package/dist/auth/config.d.ts +57 -0
- package/dist/auth/config.d.ts.map +1 -0
- package/dist/auth/config.js +118 -0
- package/dist/auth/config.js.map +1 -0
- package/dist/auth/index.d.ts +47 -0
- package/dist/auth/index.d.ts.map +1 -0
- package/dist/auth/index.js +46 -0
- package/dist/auth/index.js.map +1 -0
- package/dist/auth/oauth.d.ts +93 -0
- package/dist/auth/oauth.d.ts.map +1 -0
- package/dist/auth/oauth.js +279 -0
- package/dist/auth/oauth.js.map +1 -0
- package/dist/auth/token-store.d.ts +80 -0
- package/dist/auth/token-store.d.ts.map +1 -0
- package/dist/auth/token-store.js +204 -0
- package/dist/auth/token-store.js.map +1 -0
- package/dist/auth/types.d.ts +76 -0
- package/dist/auth/types.d.ts.map +1 -0
- package/dist/auth/types.js +20 -0
- package/dist/auth/types.js.map +1 -0
- package/dist/client/freshbooks-client.d.ts +99 -0
- package/dist/client/freshbooks-client.d.ts.map +1 -0
- package/dist/client/freshbooks-client.js +283 -0
- package/dist/client/freshbooks-client.js.map +1 -0
- package/dist/client/index.d.ts +5 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +5 -0
- package/dist/client/index.js.map +1 -0
- package/dist/config/index.d.ts +17 -0
- package/dist/config/index.d.ts.map +1 -0
- package/dist/config/index.js +81 -0
- package/dist/config/index.js.map +1 -0
- package/dist/errors/documentation.d.ts +57 -0
- package/dist/errors/documentation.d.ts.map +1 -0
- package/dist/errors/documentation.js +390 -0
- package/dist/errors/documentation.js.map +1 -0
- package/dist/errors/error-codes.d.ts +45 -0
- package/dist/errors/error-codes.d.ts.map +1 -0
- package/dist/errors/error-codes.js +94 -0
- package/dist/errors/error-codes.js.map +1 -0
- package/dist/errors/error-handler.d.ts +127 -0
- package/dist/errors/error-handler.d.ts.map +1 -0
- package/dist/errors/error-handler.js +283 -0
- package/dist/errors/error-handler.js.map +1 -0
- package/dist/errors/error-mapper.d.ts +68 -0
- package/dist/errors/error-mapper.d.ts.map +1 -0
- package/dist/errors/error-mapper.js +449 -0
- package/dist/errors/error-mapper.js.map +1 -0
- package/dist/errors/index.d.ts +37 -0
- package/dist/errors/index.d.ts.map +1 -0
- package/dist/errors/index.js +41 -0
- package/dist/errors/index.js.map +1 -0
- package/dist/errors/response-formatter.d.ts +109 -0
- package/dist/errors/response-formatter.d.ts.map +1 -0
- package/dist/errors/response-formatter.js +232 -0
- package/dist/errors/response-formatter.js.map +1 -0
- package/dist/errors/types.d.ts +194 -0
- package/dist/errors/types.d.ts.map +1 -0
- package/dist/errors/types.js +134 -0
- package/dist/errors/types.js.map +1 -0
- package/dist/server.d.ts +10 -0
- package/dist/server.d.ts.map +1 -0
- package/dist/server.js +263 -0
- package/dist/server.js.map +1 -0
- package/dist/tools/base-tool.d.ts +146 -0
- package/dist/tools/base-tool.d.ts.map +1 -0
- package/dist/tools/base-tool.js +161 -0
- package/dist/tools/base-tool.js.map +1 -0
- package/dist/tools/bill/bill-archive.d.ts +40 -0
- package/dist/tools/bill/bill-archive.d.ts.map +1 -0
- package/dist/tools/bill/bill-archive.js +68 -0
- package/dist/tools/bill/bill-archive.js.map +1 -0
- package/dist/tools/bill/bill-create.d.ts +178 -0
- package/dist/tools/bill/bill-create.d.ts.map +1 -0
- package/dist/tools/bill/bill-create.js +70 -0
- package/dist/tools/bill/bill-create.js.map +1 -0
- package/dist/tools/bill/bill-delete.d.ts +40 -0
- package/dist/tools/bill/bill-delete.d.ts.map +1 -0
- package/dist/tools/bill/bill-delete.js +67 -0
- package/dist/tools/bill/bill-delete.js.map +1 -0
- package/dist/tools/bill/bill-list.d.ts +249 -0
- package/dist/tools/bill/bill-list.d.ts.map +1 -0
- package/dist/tools/bill/bill-list.js +114 -0
- package/dist/tools/bill/bill-list.js.map +1 -0
- package/dist/tools/bill/bill-single.d.ts +142 -0
- package/dist/tools/bill/bill-single.d.ts.map +1 -0
- package/dist/tools/bill/bill-single.js +62 -0
- package/dist/tools/bill/bill-single.js.map +1 -0
- package/dist/tools/bill/index.d.ts +11 -0
- package/dist/tools/bill/index.d.ts.map +1 -0
- package/dist/tools/bill/index.js +13 -0
- package/dist/tools/bill/index.js.map +1 -0
- package/dist/tools/bill/schemas.d.ts +609 -0
- package/dist/tools/bill/schemas.d.ts.map +1 -0
- package/dist/tools/bill/schemas.js +124 -0
- package/dist/tools/bill/schemas.js.map +1 -0
- package/dist/tools/bill-payment/billpayment-create.d.ts +103 -0
- package/dist/tools/bill-payment/billpayment-create.d.ts.map +1 -0
- package/dist/tools/bill-payment/billpayment-create.js +67 -0
- package/dist/tools/bill-payment/billpayment-create.js.map +1 -0
- package/dist/tools/bill-payment/billpayment-delete.d.ts +40 -0
- package/dist/tools/bill-payment/billpayment-delete.d.ts.map +1 -0
- package/dist/tools/bill-payment/billpayment-delete.js +67 -0
- package/dist/tools/bill-payment/billpayment-delete.js.map +1 -0
- package/dist/tools/bill-payment/billpayment-list.d.ts +148 -0
- package/dist/tools/bill-payment/billpayment-list.d.ts.map +1 -0
- package/dist/tools/bill-payment/billpayment-list.js +111 -0
- package/dist/tools/bill-payment/billpayment-list.js.map +1 -0
- package/dist/tools/bill-payment/billpayment-single.d.ts +76 -0
- package/dist/tools/bill-payment/billpayment-single.d.ts.map +1 -0
- package/dist/tools/bill-payment/billpayment-single.js +62 -0
- package/dist/tools/bill-payment/billpayment-single.js.map +1 -0
- package/dist/tools/bill-payment/billpayment-update.d.ts +103 -0
- package/dist/tools/bill-payment/billpayment-update.d.ts.map +1 -0
- package/dist/tools/bill-payment/billpayment-update.js +67 -0
- package/dist/tools/bill-payment/billpayment-update.js.map +1 -0
- package/dist/tools/bill-payment/index.d.ts +11 -0
- package/dist/tools/bill-payment/index.d.ts.map +1 -0
- package/dist/tools/bill-payment/index.js +13 -0
- package/dist/tools/bill-payment/index.js.map +1 -0
- package/dist/tools/bill-payment/schemas.d.ts +381 -0
- package/dist/tools/bill-payment/schemas.d.ts.map +1 -0
- package/dist/tools/bill-payment/schemas.js +113 -0
- package/dist/tools/bill-payment/schemas.js.map +1 -0
- package/dist/tools/bill-vendor/billvendor-create.d.ts +139 -0
- package/dist/tools/bill-vendor/billvendor-create.d.ts.map +1 -0
- package/dist/tools/bill-vendor/billvendor-create.js +72 -0
- package/dist/tools/bill-vendor/billvendor-create.js.map +1 -0
- package/dist/tools/bill-vendor/billvendor-delete.d.ts +40 -0
- package/dist/tools/bill-vendor/billvendor-delete.d.ts.map +1 -0
- package/dist/tools/bill-vendor/billvendor-delete.js +67 -0
- package/dist/tools/bill-vendor/billvendor-delete.js.map +1 -0
- package/dist/tools/bill-vendor/billvendor-list.d.ts +179 -0
- package/dist/tools/bill-vendor/billvendor-list.d.ts.map +1 -0
- package/dist/tools/bill-vendor/billvendor-list.js +109 -0
- package/dist/tools/bill-vendor/billvendor-list.js.map +1 -0
- package/dist/tools/bill-vendor/billvendor-single.d.ts +94 -0
- package/dist/tools/bill-vendor/billvendor-single.d.ts.map +1 -0
- package/dist/tools/bill-vendor/billvendor-single.js +62 -0
- package/dist/tools/bill-vendor/billvendor-single.js.map +1 -0
- package/dist/tools/bill-vendor/billvendor-update.d.ts +142 -0
- package/dist/tools/bill-vendor/billvendor-update.d.ts.map +1 -0
- package/dist/tools/bill-vendor/billvendor-update.js +72 -0
- package/dist/tools/bill-vendor/billvendor-update.js.map +1 -0
- package/dist/tools/bill-vendor/index.d.ts +11 -0
- package/dist/tools/bill-vendor/index.d.ts.map +1 -0
- package/dist/tools/bill-vendor/index.js +13 -0
- package/dist/tools/bill-vendor/index.js.map +1 -0
- package/dist/tools/bill-vendor/schemas.d.ts +483 -0
- package/dist/tools/bill-vendor/schemas.d.ts.map +1 -0
- package/dist/tools/bill-vendor/schemas.js +136 -0
- package/dist/tools/bill-vendor/schemas.js.map +1 -0
- package/dist/tools/callback/callback-create.d.ts +52 -0
- package/dist/tools/callback/callback-create.d.ts.map +1 -0
- package/dist/tools/callback/callback-create.js +73 -0
- package/dist/tools/callback/callback-create.js.map +1 -0
- package/dist/tools/callback/callback-delete.d.ts +37 -0
- package/dist/tools/callback/callback-delete.d.ts.map +1 -0
- package/dist/tools/callback/callback-delete.js +57 -0
- package/dist/tools/callback/callback-delete.js.map +1 -0
- package/dist/tools/callback/callback-list.d.ts +100 -0
- package/dist/tools/callback/callback-list.d.ts.map +1 -0
- package/dist/tools/callback/callback-list.js +84 -0
- package/dist/tools/callback/callback-list.js.map +1 -0
- package/dist/tools/callback/callback-resend-verification.d.ts +49 -0
- package/dist/tools/callback/callback-resend-verification.d.ts.map +1 -0
- package/dist/tools/callback/callback-resend-verification.js +63 -0
- package/dist/tools/callback/callback-resend-verification.js.map +1 -0
- package/dist/tools/callback/callback-single.d.ts +49 -0
- package/dist/tools/callback/callback-single.d.ts.map +1 -0
- package/dist/tools/callback/callback-single.js +53 -0
- package/dist/tools/callback/callback-single.js.map +1 -0
- package/dist/tools/callback/callback-update.d.ts +55 -0
- package/dist/tools/callback/callback-update.d.ts.map +1 -0
- package/dist/tools/callback/callback-update.js +62 -0
- package/dist/tools/callback/callback-update.js.map +1 -0
- package/dist/tools/callback/callback-verify.d.ts +43 -0
- package/dist/tools/callback/callback-verify.d.ts.map +1 -0
- package/dist/tools/callback/callback-verify.js +69 -0
- package/dist/tools/callback/callback-verify.js.map +1 -0
- package/dist/tools/callback/index.d.ts +13 -0
- package/dist/tools/callback/index.d.ts.map +1 -0
- package/dist/tools/callback/index.js +15 -0
- package/dist/tools/callback/index.js.map +1 -0
- package/dist/tools/callback/schemas.d.ts +284 -0
- package/dist/tools/callback/schemas.d.ts.map +1 -0
- package/dist/tools/callback/schemas.js +114 -0
- package/dist/tools/callback/schemas.js.map +1 -0
- package/dist/tools/client/client-create.d.ts +211 -0
- package/dist/tools/client/client-create.d.ts.map +1 -0
- package/dist/tools/client/client-create.js +147 -0
- package/dist/tools/client/client-create.js.map +1 -0
- package/dist/tools/client/client-delete.d.ts +40 -0
- package/dist/tools/client/client-delete.d.ts.map +1 -0
- package/dist/tools/client/client-delete.js +73 -0
- package/dist/tools/client/client-delete.js.map +1 -0
- package/dist/tools/client/client-list.d.ts +264 -0
- package/dist/tools/client/client-list.d.ts.map +1 -0
- package/dist/tools/client/client-list.js +131 -0
- package/dist/tools/client/client-list.js.map +1 -0
- package/dist/tools/client/client-single.d.ts +133 -0
- package/dist/tools/client/client-single.d.ts.map +1 -0
- package/dist/tools/client/client-single.js +67 -0
- package/dist/tools/client/client-single.js.map +1 -0
- package/dist/tools/client/client-update.d.ts +217 -0
- package/dist/tools/client/client-update.d.ts.map +1 -0
- package/dist/tools/client/client-update.js +146 -0
- package/dist/tools/client/client-update.js.map +1 -0
- package/dist/tools/client/index.d.ts +11 -0
- package/dist/tools/client/index.d.ts.map +1 -0
- package/dist/tools/client/index.js +13 -0
- package/dist/tools/client/index.js.map +1 -0
- package/dist/tools/client/schemas.d.ts +759 -0
- package/dist/tools/client/schemas.d.ts.map +1 -0
- package/dist/tools/client/schemas.js +241 -0
- package/dist/tools/client/schemas.js.map +1 -0
- package/dist/tools/credit-note/creditnote-create.d.ts +448 -0
- package/dist/tools/credit-note/creditnote-create.d.ts.map +1 -0
- package/dist/tools/credit-note/creditnote-create.js +88 -0
- package/dist/tools/credit-note/creditnote-create.js.map +1 -0
- package/dist/tools/credit-note/creditnote-delete.d.ts +37 -0
- package/dist/tools/credit-note/creditnote-delete.d.ts.map +1 -0
- package/dist/tools/credit-note/creditnote-delete.js +57 -0
- package/dist/tools/credit-note/creditnote-delete.js.map +1 -0
- package/dist/tools/credit-note/creditnote-list.d.ts +627 -0
- package/dist/tools/credit-note/creditnote-list.d.ts.map +1 -0
- package/dist/tools/credit-note/creditnote-list.js +106 -0
- package/dist/tools/credit-note/creditnote-list.js.map +1 -0
- package/dist/tools/credit-note/creditnote-single.d.ts +358 -0
- package/dist/tools/credit-note/creditnote-single.d.ts.map +1 -0
- package/dist/tools/credit-note/creditnote-single.js +60 -0
- package/dist/tools/credit-note/creditnote-single.js.map +1 -0
- package/dist/tools/credit-note/creditnote-update.d.ts +442 -0
- package/dist/tools/credit-note/creditnote-update.d.ts.map +1 -0
- package/dist/tools/credit-note/creditnote-update.js +82 -0
- package/dist/tools/credit-note/creditnote-update.js.map +1 -0
- package/dist/tools/credit-note/index.d.ts +11 -0
- package/dist/tools/credit-note/index.d.ts.map +1 -0
- package/dist/tools/credit-note/index.js +13 -0
- package/dist/tools/credit-note/index.js.map +1 -0
- package/dist/tools/credit-note/schemas.d.ts +1599 -0
- package/dist/tools/credit-note/schemas.d.ts.map +1 -0
- package/dist/tools/credit-note/schemas.js +196 -0
- package/dist/tools/credit-note/schemas.js.map +1 -0
- package/dist/tools/expense/expense-create.d.ts +196 -0
- package/dist/tools/expense/expense-create.d.ts.map +1 -0
- package/dist/tools/expense/expense-create.js +103 -0
- package/dist/tools/expense/expense-create.js.map +1 -0
- package/dist/tools/expense/expense-delete.d.ts +40 -0
- package/dist/tools/expense/expense-delete.d.ts.map +1 -0
- package/dist/tools/expense/expense-delete.js +73 -0
- package/dist/tools/expense/expense-delete.js.map +1 -0
- package/dist/tools/expense/expense-list.d.ts +264 -0
- package/dist/tools/expense/expense-list.d.ts.map +1 -0
- package/dist/tools/expense/expense-list.js +126 -0
- package/dist/tools/expense/expense-list.js.map +1 -0
- package/dist/tools/expense/expense-single.d.ts +145 -0
- package/dist/tools/expense/expense-single.d.ts.map +1 -0
- package/dist/tools/expense/expense-single.js +63 -0
- package/dist/tools/expense/expense-single.js.map +1 -0
- package/dist/tools/expense/expense-update.d.ts +199 -0
- package/dist/tools/expense/expense-update.d.ts.map +1 -0
- package/dist/tools/expense/expense-update.js +108 -0
- package/dist/tools/expense/expense-update.js.map +1 -0
- package/dist/tools/expense/index.d.ts +11 -0
- package/dist/tools/expense/index.d.ts.map +1 -0
- package/dist/tools/expense/index.js +13 -0
- package/dist/tools/expense/index.js.map +1 -0
- package/dist/tools/expense/schemas.d.ts +667 -0
- package/dist/tools/expense/schemas.d.ts.map +1 -0
- package/dist/tools/expense/schemas.js +142 -0
- package/dist/tools/expense/schemas.js.map +1 -0
- package/dist/tools/expense-category/expensecategory-list.d.ts +113 -0
- package/dist/tools/expense-category/expensecategory-list.d.ts.map +1 -0
- package/dist/tools/expense-category/expensecategory-list.js +113 -0
- package/dist/tools/expense-category/expensecategory-list.js.map +1 -0
- package/dist/tools/expense-category/expensecategory-single.d.ts +58 -0
- package/dist/tools/expense-category/expensecategory-single.d.ts.map +1 -0
- package/dist/tools/expense-category/expensecategory-single.js +66 -0
- package/dist/tools/expense-category/expensecategory-single.js.map +1 -0
- package/dist/tools/expense-category/index.d.ts +9 -0
- package/dist/tools/expense-category/index.d.ts.map +1 -0
- package/dist/tools/expense-category/index.js +11 -0
- package/dist/tools/expense-category/index.js.map +1 -0
- package/dist/tools/expense-category/schemas.d.ts +184 -0
- package/dist/tools/expense-category/schemas.d.ts.map +1 -0
- package/dist/tools/expense-category/schemas.js +58 -0
- package/dist/tools/expense-category/schemas.js.map +1 -0
- package/dist/tools/index.d.ts +53 -0
- package/dist/tools/index.d.ts.map +1 -0
- package/dist/tools/index.js +98 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/invoice/index.d.ts +12 -0
- package/dist/tools/invoice/index.d.ts.map +1 -0
- package/dist/tools/invoice/index.js +14 -0
- package/dist/tools/invoice/index.js.map +1 -0
- package/dist/tools/invoice/invoice-create.d.ts +367 -0
- package/dist/tools/invoice/invoice-create.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-create.js +115 -0
- package/dist/tools/invoice/invoice-create.js.map +1 -0
- package/dist/tools/invoice/invoice-delete.d.ts +40 -0
- package/dist/tools/invoice/invoice-delete.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-delete.js +75 -0
- package/dist/tools/invoice/invoice-delete.js.map +1 -0
- package/dist/tools/invoice/invoice-list.d.ts +439 -0
- package/dist/tools/invoice/invoice-list.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-list.js +126 -0
- package/dist/tools/invoice/invoice-list.js.map +1 -0
- package/dist/tools/invoice/invoice-share-link.d.ts +40 -0
- package/dist/tools/invoice/invoice-share-link.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-share-link.js +89 -0
- package/dist/tools/invoice/invoice-share-link.js.map +1 -0
- package/dist/tools/invoice/invoice-single.d.ts +265 -0
- package/dist/tools/invoice/invoice-single.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-single.js +66 -0
- package/dist/tools/invoice/invoice-single.js.map +1 -0
- package/dist/tools/invoice/invoice-update.d.ts +373 -0
- package/dist/tools/invoice/invoice-update.d.ts.map +1 -0
- package/dist/tools/invoice/invoice-update.js +122 -0
- package/dist/tools/invoice/invoice-update.js.map +1 -0
- package/dist/tools/invoice/schemas.d.ts +1414 -0
- package/dist/tools/invoice/schemas.d.ts.map +1 -0
- package/dist/tools/invoice/schemas.js +269 -0
- package/dist/tools/invoice/schemas.js.map +1 -0
- package/dist/tools/item/index.d.ts +10 -0
- package/dist/tools/item/index.d.ts.map +1 -0
- package/dist/tools/item/index.js +12 -0
- package/dist/tools/item/index.js.map +1 -0
- package/dist/tools/item/item-create.d.ts +136 -0
- package/dist/tools/item/item-create.d.ts.map +1 -0
- package/dist/tools/item/item-create.js +71 -0
- package/dist/tools/item/item-create.js.map +1 -0
- package/dist/tools/item/item-list.d.ts +178 -0
- package/dist/tools/item/item-list.d.ts.map +1 -0
- package/dist/tools/item/item-list.js +112 -0
- package/dist/tools/item/item-list.js.map +1 -0
- package/dist/tools/item/item-single.d.ts +94 -0
- package/dist/tools/item/item-single.d.ts.map +1 -0
- package/dist/tools/item/item-single.js +62 -0
- package/dist/tools/item/item-single.js.map +1 -0
- package/dist/tools/item/item-update.d.ts +139 -0
- package/dist/tools/item/item-update.d.ts.map +1 -0
- package/dist/tools/item/item-update.js +74 -0
- package/dist/tools/item/item-update.js.map +1 -0
- package/dist/tools/item/schemas.d.ts +454 -0
- package/dist/tools/item/schemas.d.ts.map +1 -0
- package/dist/tools/item/schemas.js +116 -0
- package/dist/tools/item/schemas.js.map +1 -0
- package/dist/tools/journal-entry/index.d.ts +7 -0
- package/dist/tools/journal-entry/index.d.ts.map +1 -0
- package/dist/tools/journal-entry/index.js +9 -0
- package/dist/tools/journal-entry/index.js.map +1 -0
- package/dist/tools/journal-entry/journalentry-create.d.ts +114 -0
- package/dist/tools/journal-entry/journalentry-create.d.ts.map +1 -0
- package/dist/tools/journal-entry/journalentry-create.js +98 -0
- package/dist/tools/journal-entry/journalentry-create.js.map +1 -0
- package/dist/tools/journal-entry/schemas.d.ts +182 -0
- package/dist/tools/journal-entry/schemas.d.ts.map +1 -0
- package/dist/tools/journal-entry/schemas.js +43 -0
- package/dist/tools/journal-entry/schemas.js.map +1 -0
- package/dist/tools/journal-entry-account/index.d.ts +7 -0
- package/dist/tools/journal-entry-account/index.d.ts.map +1 -0
- package/dist/tools/journal-entry-account/index.js +9 -0
- package/dist/tools/journal-entry-account/index.js.map +1 -0
- package/dist/tools/journal-entry-account/journalentryaccount-list.d.ts +190 -0
- package/dist/tools/journal-entry-account/journalentryaccount-list.d.ts.map +1 -0
- package/dist/tools/journal-entry-account/journalentryaccount-list.js +102 -0
- package/dist/tools/journal-entry-account/journalentryaccount-list.js.map +1 -0
- package/dist/tools/journal-entry-account/schemas.d.ts +344 -0
- package/dist/tools/journal-entry-account/schemas.d.ts.map +1 -0
- package/dist/tools/journal-entry-account/schemas.js +65 -0
- package/dist/tools/journal-entry-account/schemas.js.map +1 -0
- package/dist/tools/metadata.d.ts +49 -0
- package/dist/tools/metadata.d.ts.map +1 -0
- package/dist/tools/metadata.js +317 -0
- package/dist/tools/metadata.js.map +1 -0
- package/dist/tools/other-income/index.d.ts +11 -0
- package/dist/tools/other-income/index.d.ts.map +1 -0
- package/dist/tools/other-income/index.js +13 -0
- package/dist/tools/other-income/index.js.map +1 -0
- package/dist/tools/other-income/otherincome-create.d.ts +152 -0
- package/dist/tools/other-income/otherincome-create.d.ts.map +1 -0
- package/dist/tools/other-income/otherincome-create.js +89 -0
- package/dist/tools/other-income/otherincome-create.js.map +1 -0
- package/dist/tools/other-income/otherincome-delete.d.ts +37 -0
- package/dist/tools/other-income/otherincome-delete.d.ts.map +1 -0
- package/dist/tools/other-income/otherincome-delete.js +57 -0
- package/dist/tools/other-income/otherincome-delete.js.map +1 -0
- package/dist/tools/other-income/otherincome-list.d.ts +186 -0
- package/dist/tools/other-income/otherincome-list.d.ts.map +1 -0
- package/dist/tools/other-income/otherincome-list.js +107 -0
- package/dist/tools/other-income/otherincome-list.js.map +1 -0
- package/dist/tools/other-income/otherincome-single.d.ts +99 -0
- package/dist/tools/other-income/otherincome-single.d.ts.map +1 -0
- package/dist/tools/other-income/otherincome-single.js +53 -0
- package/dist/tools/other-income/otherincome-single.js.map +1 -0
- package/dist/tools/other-income/otherincome-update.d.ts +155 -0
- package/dist/tools/other-income/otherincome-update.d.ts.map +1 -0
- package/dist/tools/other-income/otherincome-update.js +84 -0
- package/dist/tools/other-income/otherincome-update.js.map +1 -0
- package/dist/tools/other-income/schemas.d.ts +510 -0
- package/dist/tools/other-income/schemas.d.ts.map +1 -0
- package/dist/tools/other-income/schemas.js +141 -0
- package/dist/tools/other-income/schemas.js.map +1 -0
- package/dist/tools/payment/index.d.ts +11 -0
- package/dist/tools/payment/index.d.ts.map +1 -0
- package/dist/tools/payment/index.js +13 -0
- package/dist/tools/payment/index.js.map +1 -0
- package/dist/tools/payment/payment-create.d.ts +127 -0
- package/dist/tools/payment/payment-create.d.ts.map +1 -0
- package/dist/tools/payment/payment-create.js +84 -0
- package/dist/tools/payment/payment-create.js.map +1 -0
- package/dist/tools/payment/payment-delete.d.ts +40 -0
- package/dist/tools/payment/payment-delete.d.ts.map +1 -0
- package/dist/tools/payment/payment-delete.js +67 -0
- package/dist/tools/payment/payment-delete.js.map +1 -0
- package/dist/tools/payment/payment-list.d.ts +186 -0
- package/dist/tools/payment/payment-list.d.ts.map +1 -0
- package/dist/tools/payment/payment-list.js +113 -0
- package/dist/tools/payment/payment-list.js.map +1 -0
- package/dist/tools/payment/payment-single.d.ts +97 -0
- package/dist/tools/payment/payment-single.d.ts.map +1 -0
- package/dist/tools/payment/payment-single.js +62 -0
- package/dist/tools/payment/payment-single.js.map +1 -0
- package/dist/tools/payment/payment-update.d.ts +124 -0
- package/dist/tools/payment/payment-update.d.ts.map +1 -0
- package/dist/tools/payment/payment-update.js +79 -0
- package/dist/tools/payment/payment-update.js.map +1 -0
- package/dist/tools/payment/schemas.d.ts +445 -0
- package/dist/tools/payment/schemas.d.ts.map +1 -0
- package/dist/tools/payment/schemas.js +126 -0
- package/dist/tools/payment/schemas.js.map +1 -0
- package/dist/tools/payment-options/index.d.ts +9 -0
- package/dist/tools/payment-options/index.d.ts.map +1 -0
- package/dist/tools/payment-options/index.js +11 -0
- package/dist/tools/payment-options/index.js.map +1 -0
- package/dist/tools/payment-options/paymentoptions-create.d.ts +91 -0
- package/dist/tools/payment-options/paymentoptions-create.d.ts.map +1 -0
- package/dist/tools/payment-options/paymentoptions-create.js +71 -0
- package/dist/tools/payment-options/paymentoptions-create.js.map +1 -0
- package/dist/tools/payment-options/paymentoptions-default.d.ts +43 -0
- package/dist/tools/payment-options/paymentoptions-default.d.ts.map +1 -0
- package/dist/tools/payment-options/paymentoptions-default.js +64 -0
- package/dist/tools/payment-options/paymentoptions-default.js.map +1 -0
- package/dist/tools/payment-options/paymentoptions-single.d.ts +76 -0
- package/dist/tools/payment-options/paymentoptions-single.d.ts.map +1 -0
- package/dist/tools/payment-options/paymentoptions-single.js +58 -0
- package/dist/tools/payment-options/paymentoptions-single.js.map +1 -0
- package/dist/tools/payment-options/schemas.d.ts +197 -0
- package/dist/tools/payment-options/schemas.d.ts.map +1 -0
- package/dist/tools/payment-options/schemas.js +69 -0
- package/dist/tools/payment-options/schemas.js.map +1 -0
- package/dist/tools/project/index.d.ts +11 -0
- package/dist/tools/project/index.d.ts.map +1 -0
- package/dist/tools/project/index.js +13 -0
- package/dist/tools/project/index.js.map +1 -0
- package/dist/tools/project/project-create.d.ts +142 -0
- package/dist/tools/project/project-create.d.ts.map +1 -0
- package/dist/tools/project/project-create.js +100 -0
- package/dist/tools/project/project-create.js.map +1 -0
- package/dist/tools/project/project-delete.d.ts +44 -0
- package/dist/tools/project/project-delete.d.ts.map +1 -0
- package/dist/tools/project/project-delete.js +80 -0
- package/dist/tools/project/project-delete.js.map +1 -0
- package/dist/tools/project/project-list.d.ts +227 -0
- package/dist/tools/project/project-list.d.ts.map +1 -0
- package/dist/tools/project/project-list.js +118 -0
- package/dist/tools/project/project-list.js.map +1 -0
- package/dist/tools/project/project-single.d.ts +115 -0
- package/dist/tools/project/project-single.d.ts.map +1 -0
- package/dist/tools/project/project-single.js +63 -0
- package/dist/tools/project/project-single.js.map +1 -0
- package/dist/tools/project/project-update.d.ts +151 -0
- package/dist/tools/project/project-update.d.ts.map +1 -0
- package/dist/tools/project/project-update.js +106 -0
- package/dist/tools/project/project-update.js.map +1 -0
- package/dist/tools/project/schemas.d.ts +588 -0
- package/dist/tools/project/schemas.d.ts.map +1 -0
- package/dist/tools/project/schemas.js +196 -0
- package/dist/tools/project/schemas.js.map +1 -0
- package/dist/tools/report/index.d.ts +9 -0
- package/dist/tools/report/index.d.ts.map +1 -0
- package/dist/tools/report/index.js +11 -0
- package/dist/tools/report/index.js.map +1 -0
- package/dist/tools/report/report-payments-collected.d.ts +118 -0
- package/dist/tools/report/report-payments-collected.d.ts.map +1 -0
- package/dist/tools/report/report-payments-collected.js +89 -0
- package/dist/tools/report/report-payments-collected.js.map +1 -0
- package/dist/tools/report/report-profit-loss.d.ts +139 -0
- package/dist/tools/report/report-profit-loss.d.ts.map +1 -0
- package/dist/tools/report/report-profit-loss.js +98 -0
- package/dist/tools/report/report-profit-loss.js.map +1 -0
- package/dist/tools/report/report-tax-summary.d.ts +155 -0
- package/dist/tools/report/report-tax-summary.d.ts.map +1 -0
- package/dist/tools/report/report-tax-summary.js +100 -0
- package/dist/tools/report/report-tax-summary.js.map +1 -0
- package/dist/tools/report/schemas.d.ts +859 -0
- package/dist/tools/report/schemas.d.ts.map +1 -0
- package/dist/tools/report/schemas.js +126 -0
- package/dist/tools/report/schemas.js.map +1 -0
- package/dist/tools/service/index.d.ts +12 -0
- package/dist/tools/service/index.d.ts.map +1 -0
- package/dist/tools/service/index.js +14 -0
- package/dist/tools/service/index.js.map +1 -0
- package/dist/tools/service/schemas.d.ts +159 -0
- package/dist/tools/service/schemas.d.ts.map +1 -0
- package/dist/tools/service/schemas.js +62 -0
- package/dist/tools/service/schemas.js.map +1 -0
- package/dist/tools/service/service-create.d.ts +52 -0
- package/dist/tools/service/service-create.d.ts.map +1 -0
- package/dist/tools/service/service-create.js +82 -0
- package/dist/tools/service/service-create.js.map +1 -0
- package/dist/tools/service/service-list.d.ts +119 -0
- package/dist/tools/service/service-list.d.ts.map +1 -0
- package/dist/tools/service/service-list.js +99 -0
- package/dist/tools/service/service-list.js.map +1 -0
- package/dist/tools/service/service-rate-get.d.ts +63 -0
- package/dist/tools/service/service-rate-get.d.ts.map +1 -0
- package/dist/tools/service/service-rate-get.js +66 -0
- package/dist/tools/service/service-rate-get.js.map +1 -0
- package/dist/tools/service/service-rate-set.d.ts +76 -0
- package/dist/tools/service/service-rate-set.d.ts.map +1 -0
- package/dist/tools/service/service-rate-set.js +91 -0
- package/dist/tools/service/service-rate-set.js.map +1 -0
- package/dist/tools/service/service-single.d.ts +45 -0
- package/dist/tools/service/service-single.d.ts.map +1 -0
- package/dist/tools/service/service-single.js +63 -0
- package/dist/tools/service/service-single.js.map +1 -0
- package/dist/tools/task/index.d.ts +12 -0
- package/dist/tools/task/index.d.ts.map +1 -0
- package/dist/tools/task/index.js +14 -0
- package/dist/tools/task/index.js.map +1 -0
- package/dist/tools/task/schemas.d.ts +299 -0
- package/dist/tools/task/schemas.d.ts.map +1 -0
- package/dist/tools/task/schemas.js +89 -0
- package/dist/tools/task/schemas.js.map +1 -0
- package/dist/tools/task/task-create.d.ts +101 -0
- package/dist/tools/task/task-create.d.ts.map +1 -0
- package/dist/tools/task/task-create.js +77 -0
- package/dist/tools/task/task-create.js.map +1 -0
- package/dist/tools/task/task-delete.d.ts +39 -0
- package/dist/tools/task/task-delete.d.ts.map +1 -0
- package/dist/tools/task/task-delete.js +70 -0
- package/dist/tools/task/task-delete.js.map +1 -0
- package/dist/tools/task/task-list.d.ts +157 -0
- package/dist/tools/task/task-list.d.ts.map +1 -0
- package/dist/tools/task/task-list.js +78 -0
- package/dist/tools/task/task-list.js.map +1 -0
- package/dist/tools/task/task-single.d.ts +77 -0
- package/dist/tools/task/task-single.d.ts.map +1 -0
- package/dist/tools/task/task-single.js +56 -0
- package/dist/tools/task/task-single.js.map +1 -0
- package/dist/tools/task/task-update.d.ts +107 -0
- package/dist/tools/task/task-update.d.ts.map +1 -0
- package/dist/tools/task/task-update.js +87 -0
- package/dist/tools/task/task-update.js.map +1 -0
- package/dist/tools/time-entry/index.d.ts +11 -0
- package/dist/tools/time-entry/index.d.ts.map +1 -0
- package/dist/tools/time-entry/index.js +11 -0
- package/dist/tools/time-entry/index.js.map +1 -0
- package/dist/tools/time-entry/schemas.d.ts +598 -0
- package/dist/tools/time-entry/schemas.d.ts.map +1 -0
- package/dist/tools/time-entry/schemas.js +217 -0
- package/dist/tools/time-entry/schemas.js.map +1 -0
- package/dist/tools/time-entry/timeentry-create.d.ts +142 -0
- package/dist/tools/time-entry/timeentry-create.d.ts.map +1 -0
- package/dist/tools/time-entry/timeentry-create.js +137 -0
- package/dist/tools/time-entry/timeentry-create.js.map +1 -0
- package/dist/tools/time-entry/timeentry-delete.d.ts +43 -0
- package/dist/tools/time-entry/timeentry-delete.d.ts.map +1 -0
- package/dist/tools/time-entry/timeentry-delete.js +93 -0
- package/dist/tools/time-entry/timeentry-delete.js.map +1 -0
- package/dist/tools/time-entry/timeentry-list.d.ts +232 -0
- package/dist/tools/time-entry/timeentry-list.d.ts.map +1 -0
- package/dist/tools/time-entry/timeentry-list.js +154 -0
- package/dist/tools/time-entry/timeentry-list.js.map +1 -0
- package/dist/tools/time-entry/timeentry-single.d.ts +109 -0
- package/dist/tools/time-entry/timeentry-single.d.ts.map +1 -0
- package/dist/tools/time-entry/timeentry-single.js +75 -0
- package/dist/tools/time-entry/timeentry-single.js.map +1 -0
- package/dist/tools/time-entry/timeentry-update.d.ts +145 -0
- package/dist/tools/time-entry/timeentry-update.d.ts.map +1 -0
- package/dist/tools/time-entry/timeentry-update.js +174 -0
- package/dist/tools/time-entry/timeentry-update.js.map +1 -0
- package/dist/tools/timer/index.d.ts +16 -0
- package/dist/tools/timer/index.d.ts.map +1 -0
- package/dist/tools/timer/index.js +19 -0
- package/dist/tools/timer/index.js.map +1 -0
- package/dist/tools/timer/schemas.d.ts +520 -0
- package/dist/tools/timer/schemas.d.ts.map +1 -0
- package/dist/tools/timer/schemas.js +109 -0
- package/dist/tools/timer/schemas.js.map +1 -0
- package/dist/tools/timer/timer-current.d.ts +170 -0
- package/dist/tools/timer/timer-current.d.ts.map +1 -0
- package/dist/tools/timer/timer-current.js +134 -0
- package/dist/tools/timer/timer-current.js.map +1 -0
- package/dist/tools/timer/timer-discard.d.ts +54 -0
- package/dist/tools/timer/timer-discard.d.ts.map +1 -0
- package/dist/tools/timer/timer-discard.js +115 -0
- package/dist/tools/timer/timer-discard.js.map +1 -0
- package/dist/tools/timer/timer-start.d.ts +135 -0
- package/dist/tools/timer/timer-start.d.ts.map +1 -0
- package/dist/tools/timer/timer-start.js +129 -0
- package/dist/tools/timer/timer-start.js.map +1 -0
- package/dist/tools/timer/timer-stop.d.ts +123 -0
- package/dist/tools/timer/timer-stop.d.ts.map +1 -0
- package/dist/tools/timer/timer-stop.js +165 -0
- package/dist/tools/timer/timer-stop.js.map +1 -0
- package/dist/tools/types.d.ts +49 -0
- package/dist/tools/types.d.ts.map +1 -0
- package/dist/tools/types.js +61 -0
- package/dist/tools/types.js.map +1 -0
- package/dist/tools/user/index.d.ts +7 -0
- package/dist/tools/user/index.d.ts.map +1 -0
- package/dist/tools/user/index.js +9 -0
- package/dist/tools/user/index.js.map +1 -0
- package/dist/tools/user/schemas.d.ts +258 -0
- package/dist/tools/user/schemas.d.ts.map +1 -0
- package/dist/tools/user/schemas.js +51 -0
- package/dist/tools/user/schemas.js.map +1 -0
- package/dist/tools/user/user-me.d.ts +129 -0
- package/dist/tools/user/user-me.d.ts.map +1 -0
- package/dist/tools/user/user-me.js +63 -0
- package/dist/tools/user/user-me.js.map +1 -0
- package/dist/types/freshbooks.d.ts +276 -0
- package/dist/types/freshbooks.d.ts.map +1 -0
- package/dist/types/freshbooks.js +6 -0
- package/dist/types/freshbooks.js.map +1 -0
- package/dist/types/index.d.ts +92 -0
- package/dist/types/index.d.ts.map +1 -0
- package/dist/types/index.js +6 -0
- package/dist/types/index.js.map +1 -0
- package/dist/utils/index.d.ts +6 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/index.js +6 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/logger.d.ts +54 -0
- package/dist/utils/logger.d.ts.map +1 -0
- package/dist/utils/logger.js +133 -0
- package/dist/utils/logger.js.map +1 -0
- package/dist/utils/pagination.d.ts +39 -0
- package/dist/utils/pagination.d.ts.map +1 -0
- package/dist/utils/pagination.js +62 -0
- package/dist/utils/pagination.js.map +1 -0
- package/package.json +88 -0
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreditNote List Tool
|
|
3
|
+
*
|
|
4
|
+
* List credit notes with pagination and optional filtering.
|
|
5
|
+
*/
|
|
6
|
+
import { CreditNoteListInputSchema, CreditNoteListOutputSchema } from "./schemas.js";
|
|
7
|
+
import { ErrorHandler } from "../../errors/error-handler.js";
|
|
8
|
+
/**
|
|
9
|
+
* Tool definition for creditnote_list
|
|
10
|
+
*/
|
|
11
|
+
export const creditnoteListTool = {
|
|
12
|
+
name: "creditnote_list",
|
|
13
|
+
description: `List credit notes from FreshBooks with optional filtering and pagination.
|
|
14
|
+
|
|
15
|
+
WHEN TO USE:
|
|
16
|
+
- User asks to "see credit notes", "list credits", "show refunds"
|
|
17
|
+
- User wants to review credit note history
|
|
18
|
+
- User needs to find a credit note for a client
|
|
19
|
+
|
|
20
|
+
FILTERING OPTIONS:
|
|
21
|
+
- clientId: Show credit notes for a specific client
|
|
22
|
+
- status: Filter by status (created, sent, applied, void)
|
|
23
|
+
- dateFrom/dateTo: Filter by creation date range
|
|
24
|
+
|
|
25
|
+
CREDIT NOTE STATUSES:
|
|
26
|
+
- created: Draft credit note, not yet sent
|
|
27
|
+
- sent: Credit note sent to client
|
|
28
|
+
- applied: Credit applied to an invoice
|
|
29
|
+
- void: Credit note voided/cancelled
|
|
30
|
+
|
|
31
|
+
PAGINATION:
|
|
32
|
+
- Use page/perPage for large result sets
|
|
33
|
+
- Default: 30 results per page
|
|
34
|
+
- Maximum: 100 results per page
|
|
35
|
+
|
|
36
|
+
EXAMPLE PROMPTS:
|
|
37
|
+
- "Show me all credit notes"
|
|
38
|
+
- "List applied credit notes from this month"
|
|
39
|
+
- "Show credit notes for client 12345"
|
|
40
|
+
- "What credit notes are pending?"
|
|
41
|
+
|
|
42
|
+
RETURNS:
|
|
43
|
+
Array of credit notes with amounts, clients, status, and line items.
|
|
44
|
+
Includes pagination metadata for navigating large result sets.`,
|
|
45
|
+
inputSchema: CreditNoteListInputSchema,
|
|
46
|
+
outputSchema: CreditNoteListOutputSchema,
|
|
47
|
+
async execute(input, client) {
|
|
48
|
+
const handler = ErrorHandler.wrapHandler('creditnote_list', async (input, _context) => {
|
|
49
|
+
const { accountId, page, perPage, ...filters } = input;
|
|
50
|
+
const result = await client.executeWithRetry('creditnote_list', async (fbClient) => {
|
|
51
|
+
const { PaginationQueryBuilder, SearchQueryBuilder } = await import('@freshbooks/api/dist/models/builders/index.js');
|
|
52
|
+
// Build query builders array
|
|
53
|
+
const queryBuilders = [];
|
|
54
|
+
// Add pagination if specified
|
|
55
|
+
if (page !== undefined || perPage !== undefined) {
|
|
56
|
+
const pagination = new PaginationQueryBuilder();
|
|
57
|
+
if (page !== undefined)
|
|
58
|
+
pagination.page(page);
|
|
59
|
+
if (perPage !== undefined)
|
|
60
|
+
pagination.perPage(perPage);
|
|
61
|
+
queryBuilders.push(pagination);
|
|
62
|
+
}
|
|
63
|
+
// Add search filters if any specified
|
|
64
|
+
if (Object.keys(filters).length > 0) {
|
|
65
|
+
const search = new SearchQueryBuilder();
|
|
66
|
+
if (filters.clientId !== undefined) {
|
|
67
|
+
search.equals("clientid", filters.clientId);
|
|
68
|
+
}
|
|
69
|
+
if (filters.status !== undefined) {
|
|
70
|
+
search.equals("status", filters.status);
|
|
71
|
+
}
|
|
72
|
+
if (filters.dateFrom !== undefined || filters.dateTo !== undefined) {
|
|
73
|
+
const minDate = (filters.dateFrom ?? "1970-01-01");
|
|
74
|
+
const maxDate = (filters.dateTo ?? new Date().toISOString().split('T')[0]);
|
|
75
|
+
search.between("create_date", { min: minDate, max: maxDate });
|
|
76
|
+
}
|
|
77
|
+
queryBuilders.push(search);
|
|
78
|
+
}
|
|
79
|
+
const response = await fbClient.creditNotes.list(accountId, queryBuilders);
|
|
80
|
+
if (!response.ok) {
|
|
81
|
+
throw response.error;
|
|
82
|
+
}
|
|
83
|
+
return response.data;
|
|
84
|
+
});
|
|
85
|
+
// Extract data
|
|
86
|
+
const creditNotes = result.credit_notes || result.creditNotes || [];
|
|
87
|
+
const paginationData = result.pages || {
|
|
88
|
+
page: 1,
|
|
89
|
+
pages: 1,
|
|
90
|
+
total: creditNotes.length,
|
|
91
|
+
per_page: 30,
|
|
92
|
+
};
|
|
93
|
+
return {
|
|
94
|
+
creditNotes,
|
|
95
|
+
pagination: {
|
|
96
|
+
page: paginationData.page,
|
|
97
|
+
pages: paginationData.pages,
|
|
98
|
+
perPage: paginationData.per_page || paginationData.perPage || 30,
|
|
99
|
+
total: paginationData.total,
|
|
100
|
+
},
|
|
101
|
+
};
|
|
102
|
+
});
|
|
103
|
+
return handler(input, { accountId: input.accountId });
|
|
104
|
+
},
|
|
105
|
+
};
|
|
106
|
+
//# sourceMappingURL=creditnote-list.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"creditnote-list.js","sourceRoot":"","sources":["../../../src/tools/credit-note/creditnote-list.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,MAAM,cAAc,CAAC;AACrF,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAI7D;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,IAAI,EAAE,iBAAiB;IACvB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;+DA+BgD;IAE7D,WAAW,EAAE,yBAAyB;IACtC,YAAY,EAAE,0BAA0B;IAExC,KAAK,CAAC,OAAO,CACX,KAAgD,EAChD,MAA+B;QAE/B,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CACtC,iBAAiB,EACjB,KAAK,EAAE,KAAgD,EAAE,QAAqB,EAAE,EAAE;YAChF,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC;YAEvD,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACjF,MAAM,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,GAAG,MAAM,MAAM,CACjE,+CAA+C,CAChD,CAAC;gBAEF,6BAA6B;gBAC7B,MAAM,aAAa,GAAU,EAAE,CAAC;gBAEhC,8BAA8B;gBAC9B,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;oBAChD,MAAM,UAAU,GAAG,IAAI,sBAAsB,EAAE,CAAC;oBAChD,IAAI,IAAI,KAAK,SAAS;wBAAE,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBAC9C,IAAI,OAAO,KAAK,SAAS;wBAAE,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;oBACvD,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;gBACjC,CAAC;gBAED,sCAAsC;gBACtC,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACpC,MAAM,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;oBAExC,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;wBACnC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC9C,CAAC;oBACD,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;wBACjC,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;oBAC1C,CAAC;oBACD,IAAI,OAAO,CAAC,QAAQ,KAAK,SAAS,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;wBACnE,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,IAAI,YAAY,CAAW,CAAC;wBAC7D,MAAM,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAW,CAAC;wBACrF,MAAM,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,CAAC,CAAC;oBAChE,CAAC;oBAED,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC7B,CAAC;gBAED,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,aAAa,CAAC,CAAC;gBAE3E,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,QAAQ,CAAC,KAAK,CAAC;gBACvB,CAAC;gBAED,OAAO,QAAQ,CAAC,IAAI,CAAC;YACvB,CAAC,CAAC,CAAC;YAEH,eAAe;YACf,MAAM,WAAW,GAAI,MAAc,CAAC,YAAY,IAAK,MAAc,CAAC,WAAW,IAAI,EAAE,CAAC;YACtF,MAAM,cAAc,GAAI,MAAc,CAAC,KAAK,IAAI;gBAC9C,IAAI,EAAE,CAAC;gBACP,KAAK,EAAE,CAAC;gBACR,KAAK,EAAE,WAAW,CAAC,MAAM;gBACzB,QAAQ,EAAE,EAAE;aACb,CAAC;YAEF,OAAO;gBACL,WAAW;gBACX,UAAU,EAAE;oBACV,IAAI,EAAE,cAAc,CAAC,IAAI;oBACzB,KAAK,EAAE,cAAc,CAAC,KAAK;oBAC3B,OAAO,EAAE,cAAc,CAAC,QAAQ,IAAI,cAAc,CAAC,OAAO,IAAI,EAAE;oBAChE,KAAK,EAAE,cAAc,CAAC,KAAK;iBAC5B;aACF,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,OAAO,OAAO,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;IACxD,CAAC;CACF,CAAC"}
|
|
@@ -0,0 +1,358 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreditNote Single Tool
|
|
3
|
+
*
|
|
4
|
+
* Retrieve a single credit note by ID.
|
|
5
|
+
*/
|
|
6
|
+
import { z } from "zod";
|
|
7
|
+
import { CreditNoteSingleInputSchema, CreditNoteSingleOutputSchema } from "./schemas.js";
|
|
8
|
+
import { FreshBooksClientWrapper } from "../../client/index.js";
|
|
9
|
+
/**
|
|
10
|
+
* Tool definition for creditnote_single
|
|
11
|
+
*/
|
|
12
|
+
export declare const creditnoteSingleTool: {
|
|
13
|
+
name: string;
|
|
14
|
+
description: string;
|
|
15
|
+
inputSchema: z.ZodObject<{
|
|
16
|
+
accountId: z.ZodString;
|
|
17
|
+
creditNoteId: z.ZodNumber;
|
|
18
|
+
}, "strip", z.ZodTypeAny, {
|
|
19
|
+
accountId: string;
|
|
20
|
+
creditNoteId: number;
|
|
21
|
+
}, {
|
|
22
|
+
accountId: string;
|
|
23
|
+
creditNoteId: number;
|
|
24
|
+
}>;
|
|
25
|
+
outputSchema: z.ZodObject<{
|
|
26
|
+
id: z.ZodOptional<z.ZodNumber>;
|
|
27
|
+
creditId: z.ZodOptional<z.ZodNumber>;
|
|
28
|
+
creditNumber: z.ZodOptional<z.ZodString>;
|
|
29
|
+
creditNoteNumber: z.ZodOptional<z.ZodString>;
|
|
30
|
+
clientId: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
|
|
31
|
+
createDate: z.ZodOptional<z.ZodAny>;
|
|
32
|
+
amount: z.ZodOptional<z.ZodObject<{
|
|
33
|
+
amount: z.ZodString;
|
|
34
|
+
code: z.ZodString;
|
|
35
|
+
}, "strip", z.ZodTypeAny, {
|
|
36
|
+
code: string;
|
|
37
|
+
amount: string;
|
|
38
|
+
}, {
|
|
39
|
+
code: string;
|
|
40
|
+
amount: string;
|
|
41
|
+
}>>;
|
|
42
|
+
currencyCode: z.ZodOptional<z.ZodString>;
|
|
43
|
+
status: z.ZodOptional<z.ZodEnum<["created", "sent", "applied", "void"]>>;
|
|
44
|
+
lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
45
|
+
name: z.ZodString;
|
|
46
|
+
description: z.ZodOptional<z.ZodString>;
|
|
47
|
+
taxName1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
48
|
+
taxAmount1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
49
|
+
taxName2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
50
|
+
taxAmount2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
51
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
52
|
+
unitCost: z.ZodOptional<z.ZodObject<{
|
|
53
|
+
amount: z.ZodString;
|
|
54
|
+
code: z.ZodString;
|
|
55
|
+
}, "strip", z.ZodTypeAny, {
|
|
56
|
+
code: string;
|
|
57
|
+
amount: string;
|
|
58
|
+
}, {
|
|
59
|
+
code: string;
|
|
60
|
+
amount: string;
|
|
61
|
+
}>>;
|
|
62
|
+
amount: z.ZodObject<{
|
|
63
|
+
amount: z.ZodString;
|
|
64
|
+
code: z.ZodString;
|
|
65
|
+
}, "strip", z.ZodTypeAny, {
|
|
66
|
+
code: string;
|
|
67
|
+
amount: string;
|
|
68
|
+
}, {
|
|
69
|
+
code: string;
|
|
70
|
+
amount: string;
|
|
71
|
+
}>;
|
|
72
|
+
}, "strip", z.ZodTypeAny, {
|
|
73
|
+
name: string;
|
|
74
|
+
amount: {
|
|
75
|
+
code: string;
|
|
76
|
+
amount: string;
|
|
77
|
+
};
|
|
78
|
+
description?: string | undefined;
|
|
79
|
+
taxName1?: string | null | undefined;
|
|
80
|
+
taxAmount1?: string | null | undefined;
|
|
81
|
+
taxName2?: string | null | undefined;
|
|
82
|
+
taxAmount2?: string | null | undefined;
|
|
83
|
+
unitCost?: {
|
|
84
|
+
code: string;
|
|
85
|
+
amount: string;
|
|
86
|
+
} | undefined;
|
|
87
|
+
quantity?: number | undefined;
|
|
88
|
+
}, {
|
|
89
|
+
name: string;
|
|
90
|
+
amount: {
|
|
91
|
+
code: string;
|
|
92
|
+
amount: string;
|
|
93
|
+
};
|
|
94
|
+
description?: string | undefined;
|
|
95
|
+
taxName1?: string | null | undefined;
|
|
96
|
+
taxAmount1?: string | null | undefined;
|
|
97
|
+
taxName2?: string | null | undefined;
|
|
98
|
+
taxAmount2?: string | null | undefined;
|
|
99
|
+
unitCost?: {
|
|
100
|
+
code: string;
|
|
101
|
+
amount: string;
|
|
102
|
+
} | undefined;
|
|
103
|
+
quantity?: number | undefined;
|
|
104
|
+
}>, "many">>;
|
|
105
|
+
notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
106
|
+
terms: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
107
|
+
language: z.ZodOptional<z.ZodString>;
|
|
108
|
+
displayStatus: z.ZodOptional<z.ZodString>;
|
|
109
|
+
disputeStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
110
|
+
organization: z.ZodOptional<z.ZodString>;
|
|
111
|
+
currentOrganization: z.ZodOptional<z.ZodString>;
|
|
112
|
+
fName: z.ZodOptional<z.ZodString>;
|
|
113
|
+
lName: z.ZodOptional<z.ZodString>;
|
|
114
|
+
email: z.ZodOptional<z.ZodString>;
|
|
115
|
+
street: z.ZodOptional<z.ZodString>;
|
|
116
|
+
street2: z.ZodOptional<z.ZodString>;
|
|
117
|
+
city: z.ZodOptional<z.ZodString>;
|
|
118
|
+
province: z.ZodOptional<z.ZodString>;
|
|
119
|
+
code: z.ZodOptional<z.ZodString>;
|
|
120
|
+
country: z.ZodOptional<z.ZodString>;
|
|
121
|
+
visState: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
|
|
122
|
+
paid: z.ZodOptional<z.ZodObject<{
|
|
123
|
+
amount: z.ZodString;
|
|
124
|
+
code: z.ZodString;
|
|
125
|
+
}, "strip", z.ZodTypeAny, {
|
|
126
|
+
code: string;
|
|
127
|
+
amount: string;
|
|
128
|
+
}, {
|
|
129
|
+
code: string;
|
|
130
|
+
amount: string;
|
|
131
|
+
}>>;
|
|
132
|
+
paymentStatus: z.ZodOptional<z.ZodString>;
|
|
133
|
+
description: z.ZodOptional<z.ZodString>;
|
|
134
|
+
accountingSystemId: z.ZodOptional<z.ZodString>;
|
|
135
|
+
}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
|
|
136
|
+
id: z.ZodOptional<z.ZodNumber>;
|
|
137
|
+
creditId: z.ZodOptional<z.ZodNumber>;
|
|
138
|
+
creditNumber: z.ZodOptional<z.ZodString>;
|
|
139
|
+
creditNoteNumber: z.ZodOptional<z.ZodString>;
|
|
140
|
+
clientId: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
|
|
141
|
+
createDate: z.ZodOptional<z.ZodAny>;
|
|
142
|
+
amount: z.ZodOptional<z.ZodObject<{
|
|
143
|
+
amount: z.ZodString;
|
|
144
|
+
code: z.ZodString;
|
|
145
|
+
}, "strip", z.ZodTypeAny, {
|
|
146
|
+
code: string;
|
|
147
|
+
amount: string;
|
|
148
|
+
}, {
|
|
149
|
+
code: string;
|
|
150
|
+
amount: string;
|
|
151
|
+
}>>;
|
|
152
|
+
currencyCode: z.ZodOptional<z.ZodString>;
|
|
153
|
+
status: z.ZodOptional<z.ZodEnum<["created", "sent", "applied", "void"]>>;
|
|
154
|
+
lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
155
|
+
name: z.ZodString;
|
|
156
|
+
description: z.ZodOptional<z.ZodString>;
|
|
157
|
+
taxName1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
158
|
+
taxAmount1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
159
|
+
taxName2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
160
|
+
taxAmount2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
161
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
162
|
+
unitCost: z.ZodOptional<z.ZodObject<{
|
|
163
|
+
amount: z.ZodString;
|
|
164
|
+
code: z.ZodString;
|
|
165
|
+
}, "strip", z.ZodTypeAny, {
|
|
166
|
+
code: string;
|
|
167
|
+
amount: string;
|
|
168
|
+
}, {
|
|
169
|
+
code: string;
|
|
170
|
+
amount: string;
|
|
171
|
+
}>>;
|
|
172
|
+
amount: z.ZodObject<{
|
|
173
|
+
amount: z.ZodString;
|
|
174
|
+
code: z.ZodString;
|
|
175
|
+
}, "strip", z.ZodTypeAny, {
|
|
176
|
+
code: string;
|
|
177
|
+
amount: string;
|
|
178
|
+
}, {
|
|
179
|
+
code: string;
|
|
180
|
+
amount: string;
|
|
181
|
+
}>;
|
|
182
|
+
}, "strip", z.ZodTypeAny, {
|
|
183
|
+
name: string;
|
|
184
|
+
amount: {
|
|
185
|
+
code: string;
|
|
186
|
+
amount: string;
|
|
187
|
+
};
|
|
188
|
+
description?: string | undefined;
|
|
189
|
+
taxName1?: string | null | undefined;
|
|
190
|
+
taxAmount1?: string | null | undefined;
|
|
191
|
+
taxName2?: string | null | undefined;
|
|
192
|
+
taxAmount2?: string | null | undefined;
|
|
193
|
+
unitCost?: {
|
|
194
|
+
code: string;
|
|
195
|
+
amount: string;
|
|
196
|
+
} | undefined;
|
|
197
|
+
quantity?: number | undefined;
|
|
198
|
+
}, {
|
|
199
|
+
name: string;
|
|
200
|
+
amount: {
|
|
201
|
+
code: string;
|
|
202
|
+
amount: string;
|
|
203
|
+
};
|
|
204
|
+
description?: string | undefined;
|
|
205
|
+
taxName1?: string | null | undefined;
|
|
206
|
+
taxAmount1?: string | null | undefined;
|
|
207
|
+
taxName2?: string | null | undefined;
|
|
208
|
+
taxAmount2?: string | null | undefined;
|
|
209
|
+
unitCost?: {
|
|
210
|
+
code: string;
|
|
211
|
+
amount: string;
|
|
212
|
+
} | undefined;
|
|
213
|
+
quantity?: number | undefined;
|
|
214
|
+
}>, "many">>;
|
|
215
|
+
notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
216
|
+
terms: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
217
|
+
language: z.ZodOptional<z.ZodString>;
|
|
218
|
+
displayStatus: z.ZodOptional<z.ZodString>;
|
|
219
|
+
disputeStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
220
|
+
organization: z.ZodOptional<z.ZodString>;
|
|
221
|
+
currentOrganization: z.ZodOptional<z.ZodString>;
|
|
222
|
+
fName: z.ZodOptional<z.ZodString>;
|
|
223
|
+
lName: z.ZodOptional<z.ZodString>;
|
|
224
|
+
email: z.ZodOptional<z.ZodString>;
|
|
225
|
+
street: z.ZodOptional<z.ZodString>;
|
|
226
|
+
street2: z.ZodOptional<z.ZodString>;
|
|
227
|
+
city: z.ZodOptional<z.ZodString>;
|
|
228
|
+
province: z.ZodOptional<z.ZodString>;
|
|
229
|
+
code: z.ZodOptional<z.ZodString>;
|
|
230
|
+
country: z.ZodOptional<z.ZodString>;
|
|
231
|
+
visState: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
|
|
232
|
+
paid: z.ZodOptional<z.ZodObject<{
|
|
233
|
+
amount: z.ZodString;
|
|
234
|
+
code: z.ZodString;
|
|
235
|
+
}, "strip", z.ZodTypeAny, {
|
|
236
|
+
code: string;
|
|
237
|
+
amount: string;
|
|
238
|
+
}, {
|
|
239
|
+
code: string;
|
|
240
|
+
amount: string;
|
|
241
|
+
}>>;
|
|
242
|
+
paymentStatus: z.ZodOptional<z.ZodString>;
|
|
243
|
+
description: z.ZodOptional<z.ZodString>;
|
|
244
|
+
accountingSystemId: z.ZodOptional<z.ZodString>;
|
|
245
|
+
}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
|
|
246
|
+
id: z.ZodOptional<z.ZodNumber>;
|
|
247
|
+
creditId: z.ZodOptional<z.ZodNumber>;
|
|
248
|
+
creditNumber: z.ZodOptional<z.ZodString>;
|
|
249
|
+
creditNoteNumber: z.ZodOptional<z.ZodString>;
|
|
250
|
+
clientId: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
|
|
251
|
+
createDate: z.ZodOptional<z.ZodAny>;
|
|
252
|
+
amount: z.ZodOptional<z.ZodObject<{
|
|
253
|
+
amount: z.ZodString;
|
|
254
|
+
code: z.ZodString;
|
|
255
|
+
}, "strip", z.ZodTypeAny, {
|
|
256
|
+
code: string;
|
|
257
|
+
amount: string;
|
|
258
|
+
}, {
|
|
259
|
+
code: string;
|
|
260
|
+
amount: string;
|
|
261
|
+
}>>;
|
|
262
|
+
currencyCode: z.ZodOptional<z.ZodString>;
|
|
263
|
+
status: z.ZodOptional<z.ZodEnum<["created", "sent", "applied", "void"]>>;
|
|
264
|
+
lines: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
265
|
+
name: z.ZodString;
|
|
266
|
+
description: z.ZodOptional<z.ZodString>;
|
|
267
|
+
taxName1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
268
|
+
taxAmount1: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
269
|
+
taxName2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
270
|
+
taxAmount2: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
271
|
+
quantity: z.ZodOptional<z.ZodNumber>;
|
|
272
|
+
unitCost: z.ZodOptional<z.ZodObject<{
|
|
273
|
+
amount: z.ZodString;
|
|
274
|
+
code: z.ZodString;
|
|
275
|
+
}, "strip", z.ZodTypeAny, {
|
|
276
|
+
code: string;
|
|
277
|
+
amount: string;
|
|
278
|
+
}, {
|
|
279
|
+
code: string;
|
|
280
|
+
amount: string;
|
|
281
|
+
}>>;
|
|
282
|
+
amount: z.ZodObject<{
|
|
283
|
+
amount: z.ZodString;
|
|
284
|
+
code: z.ZodString;
|
|
285
|
+
}, "strip", z.ZodTypeAny, {
|
|
286
|
+
code: string;
|
|
287
|
+
amount: string;
|
|
288
|
+
}, {
|
|
289
|
+
code: string;
|
|
290
|
+
amount: string;
|
|
291
|
+
}>;
|
|
292
|
+
}, "strip", z.ZodTypeAny, {
|
|
293
|
+
name: string;
|
|
294
|
+
amount: {
|
|
295
|
+
code: string;
|
|
296
|
+
amount: string;
|
|
297
|
+
};
|
|
298
|
+
description?: string | undefined;
|
|
299
|
+
taxName1?: string | null | undefined;
|
|
300
|
+
taxAmount1?: string | null | undefined;
|
|
301
|
+
taxName2?: string | null | undefined;
|
|
302
|
+
taxAmount2?: string | null | undefined;
|
|
303
|
+
unitCost?: {
|
|
304
|
+
code: string;
|
|
305
|
+
amount: string;
|
|
306
|
+
} | undefined;
|
|
307
|
+
quantity?: number | undefined;
|
|
308
|
+
}, {
|
|
309
|
+
name: string;
|
|
310
|
+
amount: {
|
|
311
|
+
code: string;
|
|
312
|
+
amount: string;
|
|
313
|
+
};
|
|
314
|
+
description?: string | undefined;
|
|
315
|
+
taxName1?: string | null | undefined;
|
|
316
|
+
taxAmount1?: string | null | undefined;
|
|
317
|
+
taxName2?: string | null | undefined;
|
|
318
|
+
taxAmount2?: string | null | undefined;
|
|
319
|
+
unitCost?: {
|
|
320
|
+
code: string;
|
|
321
|
+
amount: string;
|
|
322
|
+
} | undefined;
|
|
323
|
+
quantity?: number | undefined;
|
|
324
|
+
}>, "many">>;
|
|
325
|
+
notes: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
326
|
+
terms: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
327
|
+
language: z.ZodOptional<z.ZodString>;
|
|
328
|
+
displayStatus: z.ZodOptional<z.ZodString>;
|
|
329
|
+
disputeStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
330
|
+
organization: z.ZodOptional<z.ZodString>;
|
|
331
|
+
currentOrganization: z.ZodOptional<z.ZodString>;
|
|
332
|
+
fName: z.ZodOptional<z.ZodString>;
|
|
333
|
+
lName: z.ZodOptional<z.ZodString>;
|
|
334
|
+
email: z.ZodOptional<z.ZodString>;
|
|
335
|
+
street: z.ZodOptional<z.ZodString>;
|
|
336
|
+
street2: z.ZodOptional<z.ZodString>;
|
|
337
|
+
city: z.ZodOptional<z.ZodString>;
|
|
338
|
+
province: z.ZodOptional<z.ZodString>;
|
|
339
|
+
code: z.ZodOptional<z.ZodString>;
|
|
340
|
+
country: z.ZodOptional<z.ZodString>;
|
|
341
|
+
visState: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<0>, z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
|
|
342
|
+
paid: z.ZodOptional<z.ZodObject<{
|
|
343
|
+
amount: z.ZodString;
|
|
344
|
+
code: z.ZodString;
|
|
345
|
+
}, "strip", z.ZodTypeAny, {
|
|
346
|
+
code: string;
|
|
347
|
+
amount: string;
|
|
348
|
+
}, {
|
|
349
|
+
code: string;
|
|
350
|
+
amount: string;
|
|
351
|
+
}>>;
|
|
352
|
+
paymentStatus: z.ZodOptional<z.ZodString>;
|
|
353
|
+
description: z.ZodOptional<z.ZodString>;
|
|
354
|
+
accountingSystemId: z.ZodOptional<z.ZodString>;
|
|
355
|
+
}, z.ZodTypeAny, "passthrough">>;
|
|
356
|
+
execute(input: z.infer<typeof CreditNoteSingleInputSchema>, client: FreshBooksClientWrapper): Promise<z.infer<typeof CreditNoteSingleOutputSchema>>;
|
|
357
|
+
};
|
|
358
|
+
//# sourceMappingURL=creditnote-single.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"creditnote-single.d.ts","sourceRoot":"","sources":["../../../src/tools/credit-note/creditnote-single.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,2BAA2B,EAAE,4BAA4B,EAAE,MAAM,cAAc,CAAC;AAGzF,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAEhE;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBA0BtB,CAAC,CAAC,KAAK,CAAC,OAAO,2BAA2B,CAAC,UAC1C,uBAAuB,GAC9B,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,4BAA4B,CAAC,CAAC;CAuCzD,CAAC"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* CreditNote Single Tool
|
|
3
|
+
*
|
|
4
|
+
* Retrieve a single credit note by ID.
|
|
5
|
+
*/
|
|
6
|
+
import { CreditNoteSingleInputSchema, CreditNoteSingleOutputSchema } from "./schemas.js";
|
|
7
|
+
import { ErrorHandler } from "../../errors/error-handler.js";
|
|
8
|
+
/**
|
|
9
|
+
* Tool definition for creditnote_single
|
|
10
|
+
*/
|
|
11
|
+
export const creditnoteSingleTool = {
|
|
12
|
+
name: "creditnote_single",
|
|
13
|
+
description: `Retrieve a single credit note by ID from FreshBooks.
|
|
14
|
+
|
|
15
|
+
WHEN TO USE:
|
|
16
|
+
- User asks for details about a specific credit note
|
|
17
|
+
- User provides a credit note ID or number
|
|
18
|
+
- User needs to review credit note details before applying or updating
|
|
19
|
+
|
|
20
|
+
REQUIRED INFO:
|
|
21
|
+
- creditNoteId: The credit note identifier
|
|
22
|
+
- accountId: FreshBooks account (get from context)
|
|
23
|
+
|
|
24
|
+
EXAMPLE PROMPTS:
|
|
25
|
+
- "Show me credit note #12345"
|
|
26
|
+
- "Get details for credit note 67890"
|
|
27
|
+
- "What's in credit note ID 555?"
|
|
28
|
+
|
|
29
|
+
RETURNS:
|
|
30
|
+
Complete credit note record including credit amount, client info, status,
|
|
31
|
+
line items, and all other credit note properties.`,
|
|
32
|
+
inputSchema: CreditNoteSingleInputSchema,
|
|
33
|
+
outputSchema: CreditNoteSingleOutputSchema,
|
|
34
|
+
async execute(input, client) {
|
|
35
|
+
const handler = ErrorHandler.wrapHandler('creditnote_single', async (input, _context) => {
|
|
36
|
+
const { accountId, creditNoteId } = input;
|
|
37
|
+
const result = await client.executeWithRetry('creditnote_single', async (fbClient) => {
|
|
38
|
+
// WORKAROUND: SDK has a bug in creditNotes.single() - it extracts 'credit_notes' (plural)
|
|
39
|
+
// from the response when the API returns 'credit_note' (singular).
|
|
40
|
+
// Use list with search filter instead.
|
|
41
|
+
const { SearchQueryBuilder } = await import('@freshbooks/api/dist/models/builders/index.js');
|
|
42
|
+
const search = new SearchQueryBuilder();
|
|
43
|
+
search.equals('creditid', creditNoteId);
|
|
44
|
+
const response = await fbClient.creditNotes.list(accountId, [search]);
|
|
45
|
+
if (!response.ok) {
|
|
46
|
+
throw response.error;
|
|
47
|
+
}
|
|
48
|
+
const data = response.data;
|
|
49
|
+
const creditNotes = data.creditNotes || data.credit_notes || [];
|
|
50
|
+
if (creditNotes.length === 0) {
|
|
51
|
+
throw new Error(`Credit note ${creditNoteId} not found`);
|
|
52
|
+
}
|
|
53
|
+
return creditNotes[0];
|
|
54
|
+
});
|
|
55
|
+
return result;
|
|
56
|
+
});
|
|
57
|
+
return handler(input, { accountId: input.accountId });
|
|
58
|
+
},
|
|
59
|
+
};
|
|
60
|
+
//# sourceMappingURL=creditnote-single.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"creditnote-single.js","sourceRoot":"","sources":["../../../src/tools/credit-note/creditnote-single.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,2BAA2B,EAAE,4BAA4B,EAAE,MAAM,cAAc,CAAC;AACzF,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAI7D;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,IAAI,EAAE,mBAAmB;IACzB,WAAW,EAAE;;;;;;;;;;;;;;;;;;kDAkBmC;IAEhD,WAAW,EAAE,2BAA2B;IACxC,YAAY,EAAE,4BAA4B;IAE1C,KAAK,CAAC,OAAO,CACX,KAAkD,EAClD,MAA+B;QAE/B,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CACtC,mBAAmB,EACnB,KAAK,EAAE,KAAkD,EAAE,QAAqB,EAAE,EAAE;YAClF,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,GAAG,KAAK,CAAC;YAE1C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,gBAAgB,CAAC,mBAAmB,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE;gBACnF,0FAA0F;gBAC1F,mEAAmE;gBACnE,uCAAuC;gBACvC,MAAM,EAAE,kBAAkB,EAAE,GAAG,MAAM,MAAM,CACzC,+CAA+C,CAChD,CAAC;gBAEF,MAAM,MAAM,GAAG,IAAI,kBAAkB,EAAE,CAAC;gBACxC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;gBAExC,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;gBAEtE,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;oBACjB,MAAM,QAAQ,CAAC,KAAK,CAAC;gBACvB,CAAC;gBAED,MAAM,IAAI,GAAG,QAAQ,CAAC,IAA6D,CAAC;gBACpF,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,YAAY,IAAI,EAAE,CAAC;gBAEhE,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBAC7B,MAAM,IAAI,KAAK,CAAC,eAAe,YAAY,YAAY,CAAC,CAAC;gBAC3D,CAAC;gBAED,OAAO,WAAW,CAAC,CAAC,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;YAEH,OAAO,MAAsD,CAAC;QAChE,CAAC,CACF,CAAC;QAEF,OAAO,OAAO,CAAC,KAAK,EAAE,EAAE,SAAS,EAAE,KAAK,CAAC,SAAS,EAAE,CAAC,CAAC;IACxD,CAAC;CACF,CAAC"}
|