@nightsquawktech/invoiceninja-mcp-server 0.0.1
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/COMMERCIAL.md +35 -0
- package/LICENSE +661 -0
- package/README.md +128 -0
- package/dist/catalog/endpoint-spec.js +36 -0
- package/dist/catalog/endpoints/action_invoice.json +41 -0
- package/dist/catalog/endpoints/action_payment.json +41 -0
- package/dist/catalog/endpoints/action_purchase_order.json +41 -0
- package/dist/catalog/endpoints/action_quote.json +41 -0
- package/dist/catalog/endpoints/action_recurring_invoice.json +41 -0
- package/dist/catalog/endpoints/action_recurring_quote.json +41 -0
- package/dist/catalog/endpoints/bulk_bank_integrations.json +26 -0
- package/dist/catalog/endpoints/bulk_bank_transaction_rules.json +26 -0
- package/dist/catalog/endpoints/bulk_bank_transactions.json +26 -0
- package/dist/catalog/endpoints/bulk_clients.json +46 -0
- package/dist/catalog/endpoints/bulk_company_gateways.json +27 -0
- package/dist/catalog/endpoints/bulk_credits.json +26 -0
- package/dist/catalog/endpoints/bulk_designs.json +27 -0
- package/dist/catalog/endpoints/bulk_expense_categorys.json +27 -0
- package/dist/catalog/endpoints/bulk_expenses.json +27 -0
- package/dist/catalog/endpoints/bulk_group_settings.json +26 -0
- package/dist/catalog/endpoints/bulk_invoices.json +44 -0
- package/dist/catalog/endpoints/bulk_locations.json +40 -0
- package/dist/catalog/endpoints/bulk_payment_terms.json +27 -0
- package/dist/catalog/endpoints/bulk_payments.json +27 -0
- package/dist/catalog/endpoints/bulk_products.json +46 -0
- package/dist/catalog/endpoints/bulk_projects.json +27 -0
- package/dist/catalog/endpoints/bulk_purchase_orderss.json +26 -0
- package/dist/catalog/endpoints/bulk_quotes.json +39 -0
- package/dist/catalog/endpoints/bulk_recurring_expenses.json +27 -0
- package/dist/catalog/endpoints/bulk_recurring_invoices.json +39 -0
- package/dist/catalog/endpoints/bulk_recurring_quotes.json +27 -0
- package/dist/catalog/endpoints/bulk_subscriptions.json +27 -0
- package/dist/catalog/endpoints/bulk_tags.json +51 -0
- package/dist/catalog/endpoints/bulk_task_scheduler_actions.json +27 -0
- package/dist/catalog/endpoints/bulk_task_statuss.json +27 -0
- package/dist/catalog/endpoints/bulk_tasks.json +27 -0
- package/dist/catalog/endpoints/bulk_tax_rates.json +27 -0
- package/dist/catalog/endpoints/bulk_tokens.json +27 -0
- package/dist/catalog/endpoints/bulk_users.json +27 -0
- package/dist/catalog/endpoints/bulk_vendors.json +27 -0
- package/dist/catalog/endpoints/bulk_webhooks.json +27 -0
- package/dist/catalog/endpoints/client_statement.json +77 -0
- package/dist/catalog/endpoints/confirm_apple_purchase.json +23 -0
- package/dist/catalog/endpoints/create_task_scheduler.json +81 -0
- package/dist/catalog/endpoints/delete_bank_integration.json +32 -0
- package/dist/catalog/endpoints/delete_bank_transaction.json +32 -0
- package/dist/catalog/endpoints/delete_bank_transaction_rule.json +32 -0
- package/dist/catalog/endpoints/delete_client.json +38 -0
- package/dist/catalog/endpoints/delete_client_gateway_token.json +32 -0
- package/dist/catalog/endpoints/delete_company.json +32 -0
- package/dist/catalog/endpoints/delete_company_gateway.json +32 -0
- package/dist/catalog/endpoints/delete_credit.json +32 -0
- package/dist/catalog/endpoints/delete_design.json +32 -0
- package/dist/catalog/endpoints/delete_expense.json +32 -0
- package/dist/catalog/endpoints/delete_expense_category.json +24 -0
- package/dist/catalog/endpoints/delete_group_setting.json +32 -0
- package/dist/catalog/endpoints/delete_invoice.json +32 -0
- package/dist/catalog/endpoints/delete_location.json +24 -0
- package/dist/catalog/endpoints/delete_payment.json +32 -0
- package/dist/catalog/endpoints/delete_payment_term.json +32 -0
- package/dist/catalog/endpoints/delete_product.json +32 -0
- package/dist/catalog/endpoints/delete_project.json +32 -0
- package/dist/catalog/endpoints/delete_purchase_order.json +32 -0
- package/dist/catalog/endpoints/delete_quote.json +32 -0
- package/dist/catalog/endpoints/delete_recurring_expense.json +32 -0
- package/dist/catalog/endpoints/delete_recurring_invoice.json +32 -0
- package/dist/catalog/endpoints/delete_recurring_quote.json +32 -0
- package/dist/catalog/endpoints/delete_settings_passkey.json +22 -0
- package/dist/catalog/endpoints/delete_subscription.json +32 -0
- package/dist/catalog/endpoints/delete_tag.json +24 -0
- package/dist/catalog/endpoints/delete_task.json +32 -0
- package/dist/catalog/endpoints/delete_task_status.json +32 -0
- package/dist/catalog/endpoints/delete_tax_rate.json +24 -0
- package/dist/catalog/endpoints/delete_token.json +32 -0
- package/dist/catalog/endpoints/delete_user.json +40 -0
- package/dist/catalog/endpoints/delete_vendor.json +32 -0
- package/dist/catalog/endpoints/delete_webhook.json +32 -0
- package/dist/catalog/endpoints/destroy_task_scheduler.json +24 -0
- package/dist/catalog/endpoints/detach_user.json +32 -0
- package/dist/catalog/endpoints/download_credit.json +32 -0
- package/dist/catalog/endpoints/download_invoice_by_invitation.json +32 -0
- package/dist/catalog/endpoints/download_purchase_order.json +32 -0
- package/dist/catalog/endpoints/download_quote.json +32 -0
- package/dist/catalog/endpoints/download_recurring_invoice.json +32 -0
- package/dist/catalog/endpoints/edit_bank_integration.json +33 -0
- package/dist/catalog/endpoints/edit_bank_transaction.json +33 -0
- package/dist/catalog/endpoints/edit_bank_transaction_rule.json +33 -0
- package/dist/catalog/endpoints/edit_client.json +39 -0
- package/dist/catalog/endpoints/edit_client_gateway_token.json +33 -0
- package/dist/catalog/endpoints/edit_company.json +33 -0
- package/dist/catalog/endpoints/edit_company_gateway.json +33 -0
- package/dist/catalog/endpoints/edit_credit.json +33 -0
- package/dist/catalog/endpoints/edit_design.json +33 -0
- package/dist/catalog/endpoints/edit_expense.json +33 -0
- package/dist/catalog/endpoints/edit_expense_category.json +25 -0
- package/dist/catalog/endpoints/edit_group_setting.json +33 -0
- package/dist/catalog/endpoints/edit_invoice.json +33 -0
- package/dist/catalog/endpoints/edit_payment.json +33 -0
- package/dist/catalog/endpoints/edit_payment_terms.json +33 -0
- package/dist/catalog/endpoints/edit_product.json +33 -0
- package/dist/catalog/endpoints/edit_project.json +33 -0
- package/dist/catalog/endpoints/edit_purchase_order.json +33 -0
- package/dist/catalog/endpoints/edit_quote.json +33 -0
- package/dist/catalog/endpoints/edit_recurring_expense.json +33 -0
- package/dist/catalog/endpoints/edit_recurring_invoice.json +33 -0
- package/dist/catalog/endpoints/edit_recurring_quote.json +33 -0
- package/dist/catalog/endpoints/edit_subscription.json +33 -0
- package/dist/catalog/endpoints/edit_tag.json +24 -0
- package/dist/catalog/endpoints/edit_task.json +33 -0
- package/dist/catalog/endpoints/edit_task_statuss.json +33 -0
- package/dist/catalog/endpoints/edit_tax_rate.json +25 -0
- package/dist/catalog/endpoints/edit_token.json +33 -0
- package/dist/catalog/endpoints/edit_user.json +33 -0
- package/dist/catalog/endpoints/edit_vendor.json +33 -0
- package/dist/catalog/endpoints/edit_webhook.json +33 -0
- package/dist/catalog/endpoints/get_account_transactions.json +24 -0
- package/dist/catalog/endpoints/get_activities.json +44 -0
- package/dist/catalog/endpoints/get_activity_historical_entity_pdf.json +31 -0
- package/dist/catalog/endpoints/get_activity_report.json +49 -0
- package/dist/catalog/endpoints/get_ardetail_report.json +49 -0
- package/dist/catalog/endpoints/get_arsummary_report.json +49 -0
- package/dist/catalog/endpoints/get_bank_integrations.json +61 -0
- package/dist/catalog/endpoints/get_bank_integrations_create.json +24 -0
- package/dist/catalog/endpoints/get_bank_transaction_rules.json +62 -0
- package/dist/catalog/endpoints/get_bank_transaction_rules_create.json +24 -0
- package/dist/catalog/endpoints/get_bank_transactions.json +63 -0
- package/dist/catalog/endpoints/get_bank_transactions_create.json +24 -0
- package/dist/catalog/endpoints/get_chart_calculated_fields.json +18 -0
- package/dist/catalog/endpoints/get_chart_summary_v2.json +18 -0
- package/dist/catalog/endpoints/get_chart_totals.json +38 -0
- package/dist/catalog/endpoints/get_chart_totals_v2.json +18 -0
- package/dist/catalog/endpoints/get_claim_license.json +32 -0
- package/dist/catalog/endpoints/get_client_balance_report.json +49 -0
- package/dist/catalog/endpoints/get_client_contact_report.json +49 -0
- package/dist/catalog/endpoints/get_client_gateway_tokens.json +45 -0
- package/dist/catalog/endpoints/get_client_gateway_tokens_create.json +24 -0
- package/dist/catalog/endpoints/get_client_report.json +64 -0
- package/dist/catalog/endpoints/get_client_sales_report.json +49 -0
- package/dist/catalog/endpoints/get_clients.json +152 -0
- package/dist/catalog/endpoints/get_clients_create.json +30 -0
- package/dist/catalog/endpoints/get_companies.json +38 -0
- package/dist/catalog/endpoints/get_companies_create.json +24 -0
- package/dist/catalog/endpoints/get_company_gateways.json +47 -0
- package/dist/catalog/endpoints/get_company_gateways_create.json +24 -0
- package/dist/catalog/endpoints/get_company_ledger.json +24 -0
- package/dist/catalog/endpoints/get_contact_report.json +64 -0
- package/dist/catalog/endpoints/get_credit_report.json +49 -0
- package/dist/catalog/endpoints/get_credits.json +55 -0
- package/dist/catalog/endpoints/get_credits_create.json +24 -0
- package/dist/catalog/endpoints/get_designs.json +54 -0
- package/dist/catalog/endpoints/get_designs_create.json +24 -0
- package/dist/catalog/endpoints/get_document_report.json +64 -0
- package/dist/catalog/endpoints/get_documents.json +54 -0
- package/dist/catalog/endpoints/get_expense_category_create.json +16 -0
- package/dist/catalog/endpoints/get_expense_categorys.json +47 -0
- package/dist/catalog/endpoints/get_expense_report.json +49 -0
- package/dist/catalog/endpoints/get_expenses.json +55 -0
- package/dist/catalog/endpoints/get_expenses_create.json +24 -0
- package/dist/catalog/endpoints/get_export.json +15 -0
- package/dist/catalog/endpoints/get_export_preview.json +25 -0
- package/dist/catalog/endpoints/get_group_settings.json +47 -0
- package/dist/catalog/endpoints/get_group_settings_create.json +24 -0
- package/dist/catalog/endpoints/get_health_check.json +15 -0
- package/dist/catalog/endpoints/get_import_json.json +15 -0
- package/dist/catalog/endpoints/get_invoice_create.json +16 -0
- package/dist/catalog/endpoints/get_invoice_delivery_note.json +32 -0
- package/dist/catalog/endpoints/get_invoice_item_report.json +64 -0
- package/dist/catalog/endpoints/get_invoice_report.json +64 -0
- package/dist/catalog/endpoints/get_invoices.json +174 -0
- package/dist/catalog/endpoints/get_last_error.json +15 -0
- package/dist/catalog/endpoints/get_locations.json +54 -0
- package/dist/catalog/endpoints/get_locations_create.json +24 -0
- package/dist/catalog/endpoints/get_logout.json +30 -0
- package/dist/catalog/endpoints/get_payment_report.json +64 -0
- package/dist/catalog/endpoints/get_payment_terms.json +54 -0
- package/dist/catalog/endpoints/get_payment_terms_create.json +24 -0
- package/dist/catalog/endpoints/get_payments.json +118 -0
- package/dist/catalog/endpoints/get_payments_create.json +24 -0
- package/dist/catalog/endpoints/get_ping.json +15 -0
- package/dist/catalog/endpoints/get_preview.json +15 -0
- package/dist/catalog/endpoints/get_preview_purchase_order.json +15 -0
- package/dist/catalog/endpoints/get_product_report.json +64 -0
- package/dist/catalog/endpoints/get_product_sales_report.json +64 -0
- package/dist/catalog/endpoints/get_products.json +118 -0
- package/dist/catalog/endpoints/get_products_create.json +24 -0
- package/dist/catalog/endpoints/get_profit_loss_report.json +64 -0
- package/dist/catalog/endpoints/get_project_report.json +49 -0
- package/dist/catalog/endpoints/get_projects.json +55 -0
- package/dist/catalog/endpoints/get_projects_create.json +24 -0
- package/dist/catalog/endpoints/get_purchase_order_create.json +24 -0
- package/dist/catalog/endpoints/get_purchase_orders.json +55 -0
- package/dist/catalog/endpoints/get_quote_item_report.json +64 -0
- package/dist/catalog/endpoints/get_quote_report.json +64 -0
- package/dist/catalog/endpoints/get_quotes.json +125 -0
- package/dist/catalog/endpoints/get_quotes_create.json +24 -0
- package/dist/catalog/endpoints/get_recurring_expenses.json +54 -0
- package/dist/catalog/endpoints/get_recurring_expenses_create.json +24 -0
- package/dist/catalog/endpoints/get_recurring_invoice_report.json +64 -0
- package/dist/catalog/endpoints/get_recurring_invoices.json +139 -0
- package/dist/catalog/endpoints/get_recurring_invoices_create.json +24 -0
- package/dist/catalog/endpoints/get_recurring_quotes.json +47 -0
- package/dist/catalog/endpoints/get_recurring_quotes_create.json +24 -0
- package/dist/catalog/endpoints/get_refresh_accounts.json +24 -0
- package/dist/catalog/endpoints/get_remove_account.json +24 -0
- package/dist/catalog/endpoints/get_report_preview.json +25 -0
- package/dist/catalog/endpoints/get_scheduler.json +15 -0
- package/dist/catalog/endpoints/get_settings_passkeys.json +15 -0
- package/dist/catalog/endpoints/get_show_template.json +47 -0
- package/dist/catalog/endpoints/get_statics.json +23 -0
- package/dist/catalog/endpoints/get_subscriptions.json +47 -0
- package/dist/catalog/endpoints/get_subscriptions_create.json +24 -0
- package/dist/catalog/endpoints/get_system_logs.json +47 -0
- package/dist/catalog/endpoints/get_tags.json +63 -0
- package/dist/catalog/endpoints/get_tags_create.json +16 -0
- package/dist/catalog/endpoints/get_task_report.json +64 -0
- package/dist/catalog/endpoints/get_task_scheduler.json +38 -0
- package/dist/catalog/endpoints/get_task_schedulers.json +15 -0
- package/dist/catalog/endpoints/get_task_statuses.json +54 -0
- package/dist/catalog/endpoints/get_task_statuss_create.json +24 -0
- package/dist/catalog/endpoints/get_tasks.json +55 -0
- package/dist/catalog/endpoints/get_tasks_create.json +24 -0
- package/dist/catalog/endpoints/get_tax_period_report.json +49 -0
- package/dist/catalog/endpoints/get_tax_rate_create.json +16 -0
- package/dist/catalog/endpoints/get_tax_rates.json +47 -0
- package/dist/catalog/endpoints/get_tax_summary_report.json +49 -0
- package/dist/catalog/endpoints/get_template_preview.json +25 -0
- package/dist/catalog/endpoints/get_tokens.json +54 -0
- package/dist/catalog/endpoints/get_tokens_create.json +24 -0
- package/dist/catalog/endpoints/get_user_sales_report.json +49 -0
- package/dist/catalog/endpoints/get_users.json +48 -0
- package/dist/catalog/endpoints/get_users_create.json +24 -0
- package/dist/catalog/endpoints/get_vendors.json +55 -0
- package/dist/catalog/endpoints/get_vendors_create.json +24 -0
- package/dist/catalog/endpoints/get_webcron.json +15 -0
- package/dist/catalog/endpoints/get_webhooks.json +54 -0
- package/dist/catalog/endpoints/get_webhooks_create.json +24 -0
- package/dist/catalog/endpoints/invite_user.json +32 -0
- package/dist/catalog/endpoints/invite_user_reconfirm.json +32 -0
- package/dist/catalog/endpoints/match_bank_transactions.json +26 -0
- package/dist/catalog/endpoints/merge_client.json +54 -0
- package/dist/catalog/endpoints/post_activities_entity.json +18 -0
- package/dist/catalog/endpoints/post_activities_notes.json +18 -0
- package/dist/catalog/endpoints/post_connected_account.json +38 -0
- package/dist/catalog/endpoints/post_import.json +51 -0
- package/dist/catalog/endpoints/post_login.json +79 -0
- package/dist/catalog/endpoints/post_one_time_token.json +15 -0
- package/dist/catalog/endpoints/post_passkey_login_options.json +24 -0
- package/dist/catalog/endpoints/post_purge_company.json +24 -0
- package/dist/catalog/endpoints/post_purge_company_save_settings.json +24 -0
- package/dist/catalog/endpoints/post_refresh.json +46 -0
- package/dist/catalog/endpoints/post_search.json +18 -0
- package/dist/catalog/endpoints/post_settings_passkeys.json +34 -0
- package/dist/catalog/endpoints/post_settings_passkeys_options.json +15 -0
- package/dist/catalog/endpoints/post_start_migration.json +31 -0
- package/dist/catalog/endpoints/postmark_webhook.json +24 -0
- package/dist/catalog/endpoints/preimport.json +69 -0
- package/dist/catalog/endpoints/process_apple_webhook.json +23 -0
- package/dist/catalog/endpoints/purge_client.json +32 -0
- package/dist/catalog/endpoints/reactivate_email.json +38 -0
- package/dist/catalog/endpoints/self_update.json +31 -0
- package/dist/catalog/endpoints/self_update_check_version.json +15 -0
- package/dist/catalog/endpoints/send_email_template.json +73 -0
- package/dist/catalog/endpoints/set_default_company.json +33 -0
- package/dist/catalog/endpoints/show_bank_integration.json +33 -0
- package/dist/catalog/endpoints/show_bank_transaction.json +33 -0
- package/dist/catalog/endpoints/show_bank_transaction_rule.json +33 -0
- package/dist/catalog/endpoints/show_client.json +39 -0
- package/dist/catalog/endpoints/show_client_gateway_token.json +33 -0
- package/dist/catalog/endpoints/show_company.json +33 -0
- package/dist/catalog/endpoints/show_company_gateway.json +33 -0
- package/dist/catalog/endpoints/show_credit.json +33 -0
- package/dist/catalog/endpoints/show_current_company.json +24 -0
- package/dist/catalog/endpoints/show_design.json +33 -0
- package/dist/catalog/endpoints/show_expense.json +33 -0
- package/dist/catalog/endpoints/show_expense_category.json +25 -0
- package/dist/catalog/endpoints/show_group_setting.json +33 -0
- package/dist/catalog/endpoints/show_invoice.json +33 -0
- package/dist/catalog/endpoints/show_location.json +33 -0
- package/dist/catalog/endpoints/show_payment.json +33 -0
- package/dist/catalog/endpoints/show_payment_term.json +33 -0
- package/dist/catalog/endpoints/show_product.json +33 -0
- package/dist/catalog/endpoints/show_project.json +33 -0
- package/dist/catalog/endpoints/show_purchase_order.json +33 -0
- package/dist/catalog/endpoints/show_quote.json +33 -0
- package/dist/catalog/endpoints/show_recurring_expense.json +33 -0
- package/dist/catalog/endpoints/show_recurring_invoice.json +33 -0
- package/dist/catalog/endpoints/show_recurring_quote.json +33 -0
- package/dist/catalog/endpoints/show_subscription.json +33 -0
- package/dist/catalog/endpoints/show_system_logs.json +33 -0
- package/dist/catalog/endpoints/show_tag.json +24 -0
- package/dist/catalog/endpoints/show_task.json +33 -0
- package/dist/catalog/endpoints/show_task_scheduler.json +24 -0
- package/dist/catalog/endpoints/show_task_status.json +33 -0
- package/dist/catalog/endpoints/show_tax_rate.json +25 -0
- package/dist/catalog/endpoints/show_token.json +33 -0
- package/dist/catalog/endpoints/show_user.json +33 -0
- package/dist/catalog/endpoints/show_vendor.json +33 -0
- package/dist/catalog/endpoints/show_webhook.json +33 -0
- package/dist/catalog/endpoints/sort_tasks.json +46 -0
- package/dist/catalog/endpoints/store_bank_integration.json +24 -0
- package/dist/catalog/endpoints/store_bank_transaction.json +24 -0
- package/dist/catalog/endpoints/store_bank_transaction_rule.json +24 -0
- package/dist/catalog/endpoints/store_client.json +237 -0
- package/dist/catalog/endpoints/store_client_gateway_token.json +24 -0
- package/dist/catalog/endpoints/store_company.json +24 -0
- package/dist/catalog/endpoints/store_company_gateway.json +24 -0
- package/dist/catalog/endpoints/store_credit.json +251 -0
- package/dist/catalog/endpoints/store_design.json +24 -0
- package/dist/catalog/endpoints/store_expense.json +24 -0
- package/dist/catalog/endpoints/store_expense_category.json +24 -0
- package/dist/catalog/endpoints/store_group_setting.json +24 -0
- package/dist/catalog/endpoints/store_invoice.json +257 -0
- package/dist/catalog/endpoints/store_location.json +119 -0
- package/dist/catalog/endpoints/store_payment.json +140 -0
- package/dist/catalog/endpoints/store_payment_term.json +59 -0
- package/dist/catalog/endpoints/store_product.json +179 -0
- package/dist/catalog/endpoints/store_project.json +113 -0
- package/dist/catalog/endpoints/store_purchase_order.json +89 -0
- package/dist/catalog/endpoints/store_quote.json +89 -0
- package/dist/catalog/endpoints/store_recurring_expense.json +24 -0
- package/dist/catalog/endpoints/store_recurring_invoice.json +101 -0
- package/dist/catalog/endpoints/store_recurring_quote.json +24 -0
- package/dist/catalog/endpoints/store_refund.json +235 -0
- package/dist/catalog/endpoints/store_subscription.json +24 -0
- package/dist/catalog/endpoints/store_tag.json +43 -0
- package/dist/catalog/endpoints/store_task.json +113 -0
- package/dist/catalog/endpoints/store_task_status.json +77 -0
- package/dist/catalog/endpoints/store_token.json +24 -0
- package/dist/catalog/endpoints/store_user.json +24 -0
- package/dist/catalog/endpoints/store_vendor.json +131 -0
- package/dist/catalog/endpoints/store_webhook.json +24 -0
- package/dist/catalog/endpoints/support_message.json +25 -0
- package/dist/catalog/endpoints/update_bank_integration.json +33 -0
- package/dist/catalog/endpoints/update_bank_transaction.json +33 -0
- package/dist/catalog/endpoints/update_bank_transaction_rule.json +33 -0
- package/dist/catalog/endpoints/update_client.json +246 -0
- package/dist/catalog/endpoints/update_client_gateway_token.json +33 -0
- package/dist/catalog/endpoints/update_client_tax_data.json +38 -0
- package/dist/catalog/endpoints/update_company.json +33 -0
- package/dist/catalog/endpoints/update_company_gateway.json +33 -0
- package/dist/catalog/endpoints/update_company_user.json +16 -0
- package/dist/catalog/endpoints/update_credit.json +33 -0
- package/dist/catalog/endpoints/update_design.json +33 -0
- package/dist/catalog/endpoints/update_expense.json +33 -0
- package/dist/catalog/endpoints/update_expense_category.json +25 -0
- package/dist/catalog/endpoints/update_group_setting.json +33 -0
- package/dist/catalog/endpoints/update_invoice.json +33 -0
- package/dist/catalog/endpoints/update_location.json +128 -0
- package/dist/catalog/endpoints/update_payment.json +33 -0
- package/dist/catalog/endpoints/update_payment_term.json +33 -0
- package/dist/catalog/endpoints/update_product.json +188 -0
- package/dist/catalog/endpoints/update_project.json +122 -0
- package/dist/catalog/endpoints/update_purchase_order.json +98 -0
- package/dist/catalog/endpoints/update_quote.json +98 -0
- package/dist/catalog/endpoints/update_recurring_expense.json +33 -0
- package/dist/catalog/endpoints/update_recurring_invoice.json +33 -0
- package/dist/catalog/endpoints/update_recurring_quote.json +33 -0
- package/dist/catalog/endpoints/update_subscription.json +33 -0
- package/dist/catalog/endpoints/update_tag.json +38 -0
- package/dist/catalog/endpoints/update_task.json +122 -0
- package/dist/catalog/endpoints/update_task_scheduler.json +90 -0
- package/dist/catalog/endpoints/update_task_status.json +33 -0
- package/dist/catalog/endpoints/update_tax_rate.json +25 -0
- package/dist/catalog/endpoints/update_token.json +33 -0
- package/dist/catalog/endpoints/update_user.json +33 -0
- package/dist/catalog/endpoints/update_vendor.json +140 -0
- package/dist/catalog/endpoints/update_webhook.json +33 -0
- package/dist/catalog/endpoints/upload_client.json +54 -0
- package/dist/catalog/endpoints/upload_companies.json +47 -0
- package/dist/catalog/endpoints/upload_credits.json +47 -0
- package/dist/catalog/endpoints/upload_expense.json +47 -0
- package/dist/catalog/endpoints/upload_group_setting.json +47 -0
- package/dist/catalog/endpoints/upload_invoice_document.json +47 -0
- package/dist/catalog/endpoints/upload_payment.json +47 -0
- package/dist/catalog/endpoints/upload_product.json +46 -0
- package/dist/catalog/endpoints/upload_project.json +47 -0
- package/dist/catalog/endpoints/upload_purchase_order.json +47 -0
- package/dist/catalog/endpoints/upload_quote.json +47 -0
- package/dist/catalog/endpoints/upload_recurring_expense.json +47 -0
- package/dist/catalog/endpoints/upload_recurring_invoice.json +47 -0
- package/dist/catalog/endpoints/upload_task.json +47 -0
- package/dist/catalog/endpoints/upload_vendor.json +47 -0
- package/dist/catalog/endpoints/yodlee_refresh_webhook.json +16 -0
- package/dist/catalog/index.json +4428 -0
- package/dist/clients/invoiceninja-client.js +205 -0
- package/dist/helpers/register-endpoint-tools.js +27 -0
- package/dist/index.js +8 -0
- package/dist/server/invoiceninja-mcp-server.js +18 -0
- package/dist/tools/call-endpoint.js +153 -0
- package/dist/tools/describe-endpoint.js +60 -0
- package/dist/tools/list-endpoints.js +77 -0
- package/dist/types/tool-response.js +1 -0
- package/package.json +52 -0
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_purchase_order",
|
|
3
|
+
"operationId": "updatePurchaseOrder",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/purchase_orders/{id}",
|
|
6
|
+
"name": "Update purchase order",
|
|
7
|
+
"category": "purchase_orders",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Handles the updating of a purchase order by id",
|
|
10
|
+
"whenToUse": "Modify an existing purchase order by its hashed id, updating vendor, dates, or line items on a record that already exists (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The purchase order Hashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [
|
|
22
|
+
{
|
|
23
|
+
"name": "include",
|
|
24
|
+
"type": "string",
|
|
25
|
+
"required": false,
|
|
26
|
+
"description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
|
|
27
|
+
"example": "first_load"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"headerParameters": [],
|
|
31
|
+
"requestBody": {
|
|
32
|
+
"contentType": "application/json",
|
|
33
|
+
"fields": [
|
|
34
|
+
{
|
|
35
|
+
"name": "vendor_id",
|
|
36
|
+
"type": "string",
|
|
37
|
+
"required": true,
|
|
38
|
+
"description": "The hashed ID of the vendor"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"name": "date",
|
|
42
|
+
"type": "string",
|
|
43
|
+
"required": true,
|
|
44
|
+
"description": "Purchase order date"
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "due_date",
|
|
48
|
+
"type": "string",
|
|
49
|
+
"required": true,
|
|
50
|
+
"description": "Due date for the purchase order"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "private_notes",
|
|
54
|
+
"type": "string",
|
|
55
|
+
"required": false,
|
|
56
|
+
"description": "Private notes for the purchase order"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "public_notes",
|
|
60
|
+
"type": "string",
|
|
61
|
+
"required": false,
|
|
62
|
+
"description": "Public notes for the purchase order"
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "custom_value1",
|
|
66
|
+
"type": "string",
|
|
67
|
+
"required": false,
|
|
68
|
+
"description": "Custom field value 1"
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"name": "custom_value2",
|
|
72
|
+
"type": "string",
|
|
73
|
+
"required": false,
|
|
74
|
+
"description": "Custom field value 2"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"name": "custom_value3",
|
|
78
|
+
"type": "string",
|
|
79
|
+
"required": false,
|
|
80
|
+
"description": "Custom field value 3"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"name": "custom_value4",
|
|
84
|
+
"type": "string",
|
|
85
|
+
"required": false,
|
|
86
|
+
"description": "Custom field value 4"
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"name": "line_items",
|
|
90
|
+
"type": "array",
|
|
91
|
+
"required": false,
|
|
92
|
+
"description": "Array of line items for the purchase order"
|
|
93
|
+
}
|
|
94
|
+
],
|
|
95
|
+
"schemaRef": "PurchaseOrderRequest"
|
|
96
|
+
},
|
|
97
|
+
"responseSchema": "PurchaseOrder"
|
|
98
|
+
}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_quote",
|
|
3
|
+
"operationId": "updateQuote",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/quotes/{id}",
|
|
6
|
+
"name": "Update quote",
|
|
7
|
+
"category": "quotes",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "## PUT /api/v1/quotes/{id}\n\nHandles the updating of an Quote by id.\n\nTriggered actions are available when updating or creating an quote.\n\nThese are query parameters that can be chained in order to perform additional actions on the entity, these include:\n\n```\n?send_email=true [Saves and sends the quote]\n?mark_sent=true [Saves and marks the quote as sent]\n?approve=true [Saves and approves the quote]\n?convert=true [Saves and converts the quote to an invoice]\n?save_default_footer=true [Saves the current footer as the default footer]\n?save_default_terms=true [Saves the current terms as the default terms]\n\n```",
|
|
10
|
+
"whenToUse": "Modify an existing quote by id, changing client, dates, notes, or line items; use to save edits to a known quote (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The Quote Hashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [
|
|
22
|
+
{
|
|
23
|
+
"name": "include",
|
|
24
|
+
"type": "string",
|
|
25
|
+
"required": false,
|
|
26
|
+
"description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
|
|
27
|
+
"example": "first_load"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"headerParameters": [],
|
|
31
|
+
"requestBody": {
|
|
32
|
+
"contentType": "application/json",
|
|
33
|
+
"fields": [
|
|
34
|
+
{
|
|
35
|
+
"name": "client_id",
|
|
36
|
+
"type": "string",
|
|
37
|
+
"required": true,
|
|
38
|
+
"description": "The hashed ID of the client"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"name": "date",
|
|
42
|
+
"type": "string",
|
|
43
|
+
"required": true,
|
|
44
|
+
"description": "Quote date"
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "due_date",
|
|
48
|
+
"type": "string",
|
|
49
|
+
"required": true,
|
|
50
|
+
"description": "Due date for the quote"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "private_notes",
|
|
54
|
+
"type": "string",
|
|
55
|
+
"required": false,
|
|
56
|
+
"description": "Private notes for the quote"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "public_notes",
|
|
60
|
+
"type": "string",
|
|
61
|
+
"required": false,
|
|
62
|
+
"description": "Public notes for the quote"
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "custom_value1",
|
|
66
|
+
"type": "string",
|
|
67
|
+
"required": false,
|
|
68
|
+
"description": "Custom field value 1"
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"name": "custom_value2",
|
|
72
|
+
"type": "string",
|
|
73
|
+
"required": false,
|
|
74
|
+
"description": "Custom field value 2"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"name": "custom_value3",
|
|
78
|
+
"type": "string",
|
|
79
|
+
"required": false,
|
|
80
|
+
"description": "Custom field value 3"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"name": "custom_value4",
|
|
84
|
+
"type": "string",
|
|
85
|
+
"required": false,
|
|
86
|
+
"description": "Custom field value 4"
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"name": "line_items",
|
|
90
|
+
"type": "array",
|
|
91
|
+
"required": false,
|
|
92
|
+
"description": "An array of objects which define the line items of the quote"
|
|
93
|
+
}
|
|
94
|
+
],
|
|
95
|
+
"schemaRef": "QuoteRequest"
|
|
96
|
+
},
|
|
97
|
+
"responseSchema": "Quote"
|
|
98
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_recurring_expense",
|
|
3
|
+
"operationId": "updateRecurringExpense",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/recurring_expenses/{id}",
|
|
6
|
+
"name": "Updates a recurring expense",
|
|
7
|
+
"category": "recurring_expenses",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Handles the updating of a recurring expense by id",
|
|
10
|
+
"whenToUse": "Modify an existing recurring expense by its hashed id to change amount, schedule, or other fields (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The RecurringExpense Hashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [
|
|
22
|
+
{
|
|
23
|
+
"name": "include",
|
|
24
|
+
"type": "string",
|
|
25
|
+
"required": false,
|
|
26
|
+
"description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
|
|
27
|
+
"example": "first_load"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"headerParameters": [],
|
|
31
|
+
"requestBody": null,
|
|
32
|
+
"responseSchema": "RecurringExpense"
|
|
33
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_recurring_invoice",
|
|
3
|
+
"operationId": "updateRecurringInvoice",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/recurring_invoices/{id}",
|
|
6
|
+
"name": "Update recurring invoice",
|
|
7
|
+
"category": "recurring_invoices",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Handles the updating of an RecurringInvoice by id",
|
|
10
|
+
"whenToUse": "Modify an existing recurring invoice by id (dates, frequency, line items); use to change an established schedule (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The RecurringInvoice Hashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [
|
|
22
|
+
{
|
|
23
|
+
"name": "include",
|
|
24
|
+
"type": "string",
|
|
25
|
+
"required": false,
|
|
26
|
+
"description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
|
|
27
|
+
"example": "first_load"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"headerParameters": [],
|
|
31
|
+
"requestBody": null,
|
|
32
|
+
"responseSchema": "RecurringInvoice"
|
|
33
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_recurring_quote",
|
|
3
|
+
"operationId": "updateRecurringQuote",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/recurring_quotes/{id}",
|
|
6
|
+
"name": "Updates an RecurringQuote",
|
|
7
|
+
"category": "recurring_quotes",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Handles the updating of an RecurringQuote by id",
|
|
10
|
+
"whenToUse": "Modify an existing recurring quote by id with new field values; use to change a recurring quote you already have, not to create one (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The RecurringQuote Hashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [
|
|
22
|
+
{
|
|
23
|
+
"name": "include",
|
|
24
|
+
"type": "string",
|
|
25
|
+
"required": false,
|
|
26
|
+
"description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
|
|
27
|
+
"example": "first_load"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"headerParameters": [],
|
|
31
|
+
"requestBody": null,
|
|
32
|
+
"responseSchema": "RecurringQuote"
|
|
33
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_subscription",
|
|
3
|
+
"operationId": "updateSubscription",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/subscriptions/{id}",
|
|
6
|
+
"name": "Updates an subscriptions",
|
|
7
|
+
"category": "subscriptions",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Handles the updating of an subscriptions by id",
|
|
10
|
+
"whenToUse": "Modify an existing subscription by its hashed id to change its plan settings or fields (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The Subscription Hashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [
|
|
22
|
+
{
|
|
23
|
+
"name": "include",
|
|
24
|
+
"type": "string",
|
|
25
|
+
"required": false,
|
|
26
|
+
"description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
|
|
27
|
+
"example": "first_load"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"headerParameters": [],
|
|
31
|
+
"requestBody": null,
|
|
32
|
+
"responseSchema": "Subscription"
|
|
33
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_tag",
|
|
3
|
+
"operationId": "updateTag",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/tags/{id}",
|
|
6
|
+
"name": "Update tag",
|
|
7
|
+
"category": "tags",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Updates a tag name or color. `entity_type` is immutable and should not be sent.",
|
|
10
|
+
"whenToUse": "Modify an existing tag's name or color by its hashed id; entity_type is immutable and not sent (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The tag hashed ID",
|
|
17
|
+
"example": "Opnel5aKBz"
|
|
18
|
+
}
|
|
19
|
+
],
|
|
20
|
+
"queryParameters": [],
|
|
21
|
+
"headerParameters": [],
|
|
22
|
+
"requestBody": {
|
|
23
|
+
"contentType": "application/json",
|
|
24
|
+
"fields": [
|
|
25
|
+
{
|
|
26
|
+
"name": "name",
|
|
27
|
+
"type": "string",
|
|
28
|
+
"required": false
|
|
29
|
+
},
|
|
30
|
+
{
|
|
31
|
+
"name": "color",
|
|
32
|
+
"type": "string",
|
|
33
|
+
"required": false
|
|
34
|
+
}
|
|
35
|
+
]
|
|
36
|
+
},
|
|
37
|
+
"responseSchema": "Tag"
|
|
38
|
+
}
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_task",
|
|
3
|
+
"operationId": "updateTask",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/tasks/{id}",
|
|
6
|
+
"name": "Update task",
|
|
7
|
+
"category": "tasks",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Handles the updating of a task by id",
|
|
10
|
+
"whenToUse": "Modify fields on an existing task identified by id; use to change an already-created task such as status or time log (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The task Hashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [
|
|
22
|
+
{
|
|
23
|
+
"name": "include",
|
|
24
|
+
"type": "string",
|
|
25
|
+
"required": false,
|
|
26
|
+
"description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
|
|
27
|
+
"example": "first_load"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"headerParameters": [],
|
|
31
|
+
"requestBody": {
|
|
32
|
+
"contentType": "application/json",
|
|
33
|
+
"fields": [
|
|
34
|
+
{
|
|
35
|
+
"name": "description",
|
|
36
|
+
"type": "string",
|
|
37
|
+
"required": true,
|
|
38
|
+
"description": "Task description"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"name": "client_id",
|
|
42
|
+
"type": "string",
|
|
43
|
+
"required": false,
|
|
44
|
+
"description": "The hashed ID of the client"
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "project_id",
|
|
48
|
+
"type": "string",
|
|
49
|
+
"required": false,
|
|
50
|
+
"description": "The hashed ID of the project"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "time_log",
|
|
54
|
+
"type": "string",
|
|
55
|
+
"required": false,
|
|
56
|
+
"description": "Time logged for the task"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "status_id",
|
|
60
|
+
"type": "integer",
|
|
61
|
+
"required": false,
|
|
62
|
+
"description": "Status ID of the task"
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "custom_value1",
|
|
66
|
+
"type": "string",
|
|
67
|
+
"required": false,
|
|
68
|
+
"description": "Custom field value 1"
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"name": "custom_value2",
|
|
72
|
+
"type": "string",
|
|
73
|
+
"required": false,
|
|
74
|
+
"description": "Custom field value 2"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"name": "custom_value3",
|
|
78
|
+
"type": "string",
|
|
79
|
+
"required": false,
|
|
80
|
+
"description": "Custom field value 3"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"name": "custom_value4",
|
|
84
|
+
"type": "string",
|
|
85
|
+
"required": false,
|
|
86
|
+
"description": "Custom field value 4"
|
|
87
|
+
},
|
|
88
|
+
{
|
|
89
|
+
"name": "is_deleted",
|
|
90
|
+
"type": "boolean",
|
|
91
|
+
"required": false,
|
|
92
|
+
"description": "Whether the task is deleted"
|
|
93
|
+
},
|
|
94
|
+
{
|
|
95
|
+
"name": "archived_at",
|
|
96
|
+
"type": "integer",
|
|
97
|
+
"required": false,
|
|
98
|
+
"description": "Timestamp when task was archived"
|
|
99
|
+
},
|
|
100
|
+
{
|
|
101
|
+
"name": "due_date",
|
|
102
|
+
"type": "string",
|
|
103
|
+
"required": false,
|
|
104
|
+
"description": "Due date for the task"
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
"name": "priority",
|
|
108
|
+
"type": "integer",
|
|
109
|
+
"required": false,
|
|
110
|
+
"description": "Priority level of the task"
|
|
111
|
+
},
|
|
112
|
+
{
|
|
113
|
+
"name": "tags",
|
|
114
|
+
"type": "array",
|
|
115
|
+
"required": false,
|
|
116
|
+
"description": "Full sync array of hashed tag IDs. Omit to leave existing tags unchanged; send [] to detach all tags."
|
|
117
|
+
}
|
|
118
|
+
],
|
|
119
|
+
"schemaRef": "TaskRequest"
|
|
120
|
+
},
|
|
121
|
+
"responseSchema": "Task"
|
|
122
|
+
}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_task_scheduler",
|
|
3
|
+
"operationId": "updateTaskScheduler",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/task_schedulers/{id}",
|
|
6
|
+
"name": "Update task scheduler",
|
|
7
|
+
"category": "task_schedulers",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Update task scheduler",
|
|
10
|
+
"whenToUse": "Modify an existing task scheduler by hashed id, changing pause state, interval, job, or dates (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The Scheduler Hashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [],
|
|
22
|
+
"headerParameters": [
|
|
23
|
+
{
|
|
24
|
+
"name": "X-API-SECRET",
|
|
25
|
+
"type": "string",
|
|
26
|
+
"required": false,
|
|
27
|
+
"description": "The API secret as defined by the .env variable API_SECRET. Only needed for self hosted users, and only applicable on the login route.",
|
|
28
|
+
"example": "password"
|
|
29
|
+
}
|
|
30
|
+
],
|
|
31
|
+
"requestBody": {
|
|
32
|
+
"contentType": "application/json",
|
|
33
|
+
"fields": [
|
|
34
|
+
{
|
|
35
|
+
"name": "paused",
|
|
36
|
+
"type": "boolean",
|
|
37
|
+
"required": false,
|
|
38
|
+
"description": "The scheduler paused state"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"name": "repeat_every",
|
|
42
|
+
"type": "string",
|
|
43
|
+
"required": false,
|
|
44
|
+
"description": "Accepted values (DAY,WEEK,MONTH,3MONTHS,YEAR)"
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
"name": "start_from",
|
|
48
|
+
"type": "integer",
|
|
49
|
+
"required": false,
|
|
50
|
+
"description": "Timestamp when we should start the scheduler, default is today"
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
"name": "job",
|
|
54
|
+
"type": "string",
|
|
55
|
+
"required": false,
|
|
56
|
+
"description": "Job, we can find list of available jobs in Scheduler model"
|
|
57
|
+
},
|
|
58
|
+
{
|
|
59
|
+
"name": "date_range",
|
|
60
|
+
"type": "string",
|
|
61
|
+
"required": false,
|
|
62
|
+
"description": "The string representation of the date range of data to be returned"
|
|
63
|
+
},
|
|
64
|
+
{
|
|
65
|
+
"name": "date_key",
|
|
66
|
+
"type": "string",
|
|
67
|
+
"required": false,
|
|
68
|
+
"description": "The date column to search between."
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"name": "start_date",
|
|
72
|
+
"type": "string",
|
|
73
|
+
"required": false,
|
|
74
|
+
"description": "The start date to search between"
|
|
75
|
+
},
|
|
76
|
+
{
|
|
77
|
+
"name": "end_date",
|
|
78
|
+
"type": "string",
|
|
79
|
+
"required": false,
|
|
80
|
+
"description": "The end date to search between"
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"name": "report_keys",
|
|
84
|
+
"type": "array",
|
|
85
|
+
"required": false
|
|
86
|
+
}
|
|
87
|
+
],
|
|
88
|
+
"schemaRef": "TaskSchedulerSchema"
|
|
89
|
+
}
|
|
90
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_task_status",
|
|
3
|
+
"operationId": "updateTaskStatus",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/task_statuses/{id}",
|
|
6
|
+
"name": "Updates a TaskStatus Term",
|
|
7
|
+
"category": "task_status",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Handles the updating of an TaskStatus Termby id",
|
|
10
|
+
"whenToUse": "Modify an existing task status by its hashed id to change its name, color, or order (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The TaskStatusHashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [
|
|
22
|
+
{
|
|
23
|
+
"name": "include",
|
|
24
|
+
"type": "string",
|
|
25
|
+
"required": false,
|
|
26
|
+
"description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
|
|
27
|
+
"example": "first_load"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"headerParameters": [],
|
|
31
|
+
"requestBody": null,
|
|
32
|
+
"responseSchema": "TaskStatus"
|
|
33
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_tax_rate",
|
|
3
|
+
"operationId": "updateTaxRate",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/tax_rates/{id}",
|
|
6
|
+
"name": "Updates a tax rate",
|
|
7
|
+
"category": "tax_rates",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Handles the updating of a tax rate by id",
|
|
10
|
+
"whenToUse": "Modify an existing tax rate by its hashed id to change its name or rate value (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The TaxRate Hashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [],
|
|
22
|
+
"headerParameters": [],
|
|
23
|
+
"requestBody": null,
|
|
24
|
+
"responseSchema": "TaxRate"
|
|
25
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
{
|
|
2
|
+
"slug": "update_token",
|
|
3
|
+
"operationId": "updateToken",
|
|
4
|
+
"method": "PUT",
|
|
5
|
+
"path": "/api/v1/tokens/{id}",
|
|
6
|
+
"name": "Updates a token",
|
|
7
|
+
"category": "tokens",
|
|
8
|
+
"mutating": true,
|
|
9
|
+
"description": "Handles the updating of a token by id",
|
|
10
|
+
"whenToUse": "Modify an existing company API token by its hashed id to change its settings (mutating).",
|
|
11
|
+
"pathParameters": [
|
|
12
|
+
{
|
|
13
|
+
"name": "id",
|
|
14
|
+
"type": "string",
|
|
15
|
+
"required": true,
|
|
16
|
+
"description": "The Token Hashed ID",
|
|
17
|
+
"format": "string",
|
|
18
|
+
"example": "D2J234DFA"
|
|
19
|
+
}
|
|
20
|
+
],
|
|
21
|
+
"queryParameters": [
|
|
22
|
+
{
|
|
23
|
+
"name": "include",
|
|
24
|
+
"type": "string",
|
|
25
|
+
"required": false,
|
|
26
|
+
"description": "Includes child relationships in the response, format is comma separated. Check each model for the list of associated includes",
|
|
27
|
+
"example": "first_load"
|
|
28
|
+
}
|
|
29
|
+
],
|
|
30
|
+
"headerParameters": [],
|
|
31
|
+
"requestBody": null,
|
|
32
|
+
"responseSchema": "CompanyToken"
|
|
33
|
+
}
|