Manage fiscal periods (month/quarter/year) and period locks.
\n" }, { "name": "activation", "slug": "activation", "operations": [ { "slug": "get-activation-status", "operation_id": "get_activation_status", "method": "GET", "path": "/api/v1/activation", "summary": "Get activation status", "deprecated": false }, { "slug": "seed-sample-preview", "operation_id": "seed_sample_preview", "method": "POST", "path": "/api/v1/activation/sample-preview", "summary": "Seed an isolated sample-data preview", "deprecated": false }, { "slug": "record-activation-event", "operation_id": "record_activation_event", "method": "POST", "path": "/api/v1/activation/{milestone}", "summary": "Record a client-reported activation milestone", "deprecated": false } ] }, { "name": "advisory-firm-entity-groups", "slug": "advisory-firm-entity-groups", "operations": [ { "slug": "list-entity-groups", "operation_id": "list_entity_groups", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/entity-groups", "summary": "List entity groups", "deprecated": false }, { "slug": "create-entity-group", "operation_id": "create_entity_group", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/entity-groups", "summary": "Create entity group", "deprecated": false }, { "slug": "delete-entity-group", "operation_id": "delete_entity_group", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/entity-groups/{group_id}", "summary": "Delete entity group", "deprecated": false }, { "slug": "get-entity-group", "operation_id": "get_entity_group", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/entity-groups/{group_id}", "summary": "Get entity group", "deprecated": false }, { "slug": "update-entity-group", "operation_id": "update_entity_group", "method": "PATCH", "path": "/api/v1/advisory-firms/{firm_id}/entity-groups/{group_id}", "summary": "Update entity group", "deprecated": false }, { "slug": "add-entity-group-business", "operation_id": "add_entity_group_business", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/entity-groups/{group_id}/businesses", "summary": "Add business to entity group", "deprecated": false }, { "slug": "set-entity-group-businesses", "operation_id": "set_entity_group_businesses", "method": "PUT", "path": "/api/v1/advisory-firms/{firm_id}/entity-groups/{group_id}/businesses", "summary": "Set entity group businesses", "deprecated": false }, { "slug": "remove-entity-group-business", "operation_id": "remove_entity_group_business", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/entity-groups/{group_id}/businesses/{business_id}", "summary": "Remove business from entity group", "deprecated": false } ] }, { "name": "advisory-firm-reports", "slug": "advisory-firm-reports", "operations": [ { "slug": "list-firm-report-types", "operation_id": "list_firm_report_types", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/reports", "summary": "List available firm reports", "deprecated": false }, { "slug": "get-client-open-items", "operation_id": "get_client_open_items", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/reports/client-open-items", "summary": "Get open client items", "deprecated": false }, { "slug": "get-portfolio-overview", "operation_id": "get_portfolio_overview", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/reports/portfolio-overview", "summary": "Get portfolio overview", "deprecated": false }, { "slug": "get-work-queue", "operation_id": "get_work_queue", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/reports/work-queue", "summary": "Get work queue", "deprecated": false }, { "slug": "generate-firm-report", "operation_id": "generate_firm_report", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/reports/{report_name}", "summary": "Generate firm report", "deprecated": false } ], "description": "Cross-client reporting for advisory firms.", "description_html": "Cross-client reporting for advisory firms.
\n" }, { "name": "advisory-firm-teams", "slug": "advisory-firm-teams", "operations": [ { "slug": "list-teams", "operation_id": "list_teams", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/teams", "summary": "List firm teams", "deprecated": false }, { "slug": "create-team", "operation_id": "create_team", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/teams", "summary": "Create team", "deprecated": false }, { "slug": "delete-team", "operation_id": "delete_team", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/teams/{team_id}", "summary": "Delete team", "deprecated": false }, { "slug": "get-team", "operation_id": "get_team", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/teams/{team_id}", "summary": "Get team details", "deprecated": false }, { "slug": "update-team", "operation_id": "update_team", "method": "PATCH", "path": "/api/v1/advisory-firms/{firm_id}/teams/{team_id}", "summary": "Update team", "deprecated": false }, { "slug": "add-team-business", "operation_id": "add_team_business", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/teams/{team_id}/businesses", "summary": "Add business to team", "deprecated": false }, { "slug": "remove-team-business", "operation_id": "remove_team_business", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/teams/{team_id}/businesses/{business_id}", "summary": "Remove business from team", "deprecated": false }, { "slug": "add-team-member", "operation_id": "add_team_member", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/teams/{team_id}/members", "summary": "Add team member", "deprecated": false }, { "slug": "remove-team-member", "operation_id": "remove_team_member", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/teams/{team_id}/members/{user_id}", "summary": "Remove team member", "deprecated": false }, { "slug": "list-accessible-businesses", "operation_id": "list_accessible_businesses", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}/accessible-businesses", "summary": "List accessible businesses", "deprecated": false }, { "slug": "list-assignments", "operation_id": "list_assignments", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}/assignments", "summary": "List staff assignments", "deprecated": false }, { "slug": "create-assignment", "operation_id": "create_assignment", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}/assignments", "summary": "Create staff assignment", "deprecated": false }, { "slug": "bulk-set-assignments", "operation_id": "bulk_set_assignments", "method": "PUT", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}/assignments", "summary": "Bulk set assignments", "deprecated": false }, { "slug": "delete-assignment", "operation_id": "delete_assignment", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}/assignments/{assignment_id}", "summary": "Delete assignment", "deprecated": false }, { "slug": "update-assignment", "operation_id": "update_assignment", "method": "PATCH", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}/assignments/{assignment_id}", "summary": "Update assignment", "deprecated": false } ], "description": "Team management within advisory firms — assign staff to teams and manage client access.", "description_html": "Team management within advisory firms — assign staff to teams and manage client access.
\n" }, { "name": "advisory-firm-templates", "slug": "advisory-firm-templates", "operations": [ { "slug": "list-firm-templates", "operation_id": "list_firm_templates", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/templates", "summary": "List firm templates", "deprecated": false }, { "slug": "create-firm-template", "operation_id": "create_firm_template", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/templates", "summary": "Create a firm template", "deprecated": false }, { "slug": "delete-firm-template", "operation_id": "delete_firm_template", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/templates/{template_id}", "summary": "Delete a firm template", "deprecated": false }, { "slug": "get-firm-template", "operation_id": "get_firm_template", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/templates/{template_id}", "summary": "Get a firm template", "deprecated": false }, { "slug": "update-firm-template", "operation_id": "update_firm_template", "method": "PATCH", "path": "/api/v1/advisory-firms/{firm_id}/templates/{template_id}", "summary": "Update a firm template", "deprecated": false }, { "slug": "deploy-firm-template", "operation_id": "deploy_firm_template", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/templates/{template_id}/deploy", "summary": "Deploy a firm template to selected client businesses", "deprecated": false }, { "slug": "list-firm-template-deployments", "operation_id": "list_firm_template_deployments", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/templates/{template_id}/deployments", "summary": "List deployment history for a template", "deprecated": false } ] }, { "name": "advisory-firms", "slug": "advisory-firms", "operations": [ { "slug": "list-advisory-firms", "operation_id": "list_advisory_firms", "method": "GET", "path": "/api/v1/advisory-firms", "summary": "List advisory firms", "deprecated": false }, { "slug": "create-advisory-firm", "operation_id": "create_advisory_firm", "method": "POST", "path": "/api/v1/advisory-firms", "summary": "Create advisory firm", "deprecated": false }, { "slug": "delete-firm", "operation_id": "delete_firm", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}", "summary": "Delete advisory firm", "deprecated": false }, { "slug": "get-firm", "operation_id": "get_firm", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}", "summary": "Get advisory firm", "deprecated": false }, { "slug": "update-firm", "operation_id": "update_firm", "method": "PUT", "path": "/api/v1/advisory-firms/{firm_id}", "summary": "Update advisory firm", "deprecated": false }, { "slug": "get-firm-ai-insights", "operation_id": "get_firm_ai_insights", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/ai-insights", "summary": "AI cross-client insights", "deprecated": false }, { "slug": "list-firm-businesses", "operation_id": "list_firm_businesses", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/businesses", "summary": "List firm businesses", "deprecated": false }, { "slug": "assign-business-to-firm", "operation_id": "assign_business_to_firm", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/businesses", "summary": "Assign business to firm", "deprecated": false }, { "slug": "set-firm-businesses-accounting-basis", "operation_id": "set_firm_businesses_accounting_basis", "method": "PATCH", "path": "/api/v1/advisory-firms/{firm_id}/businesses/accounting-basis", "summary": "Bulk-set client accounting basis", "deprecated": false }, { "slug": "unassign-business-from-firm", "operation_id": "unassign_business_from_firm", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/businesses/{business_id}", "summary": "Unassign business from firm", "deprecated": false }, { "slug": "invite-client-to-business", "operation_id": "invite_client_to_business", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/businesses/{business_id}/invite-client", "summary": "Invite a client user to a business", "deprecated": false }, { "slug": "get-business-notification-topic-policy", "operation_id": "get_business_notification_topic_policy", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/businesses/{business_id}/preferences/notifications/topics", "summary": "Get a business notification topic policy", "deprecated": false }, { "slug": "update-business-notification-topic-policy", "operation_id": "update_business_notification_topic_policy", "method": "PUT", "path": "/api/v1/advisory-firms/{firm_id}/businesses/{business_id}/preferences/notifications/topics", "summary": "Update a business notification topic policy", "deprecated": false }, { "slug": "list-firm-clients", "operation_id": "list_firm_clients", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/clients", "summary": "List firm clients", "deprecated": false }, { "slug": "list-client-business-access", "operation_id": "list_client_business_access", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/clients/{user_id}/businesses", "summary": "List client business access", "deprecated": false }, { "slug": "grant-client-business-access", "operation_id": "grant_client_business_access", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/clients/{user_id}/businesses", "summary": "Grant client business access", "deprecated": false }, { "slug": "revoke-client-business-access", "operation_id": "revoke_client_business_access", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/clients/{user_id}/businesses/{business_id}", "summary": "Revoke client business access", "deprecated": false }, { "slug": "list-firm-invitations", "operation_id": "list_firm_invitations", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/invitations", "summary": "List pending invitations", "deprecated": false }, { "slug": "cancel-invitation", "operation_id": "cancel_invitation", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/invitations/{invitation_id}", "summary": "Cancel an invitation", "deprecated": false }, { "slug": "resend-invitation", "operation_id": "resend_invitation", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/invitations/{invitation_id}/resend", "summary": "Resend an invitation", "deprecated": false }, { "slug": "get-firm-logo", "operation_id": "get_firm_logo", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/logo", "summary": "Get firm logo download URL", "deprecated": false }, { "slug": "get-firm-notification-topic-policy", "operation_id": "get_firm_notification_topic_policy", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/preferences/notifications/topics", "summary": "Get firm notification topic policy", "deprecated": false }, { "slug": "update-firm-notification-topic-policy", "operation_id": "update_firm_notification_topic_policy", "method": "PUT", "path": "/api/v1/advisory-firms/{firm_id}/preferences/notifications/topics", "summary": "Update firm notification topic policy", "deprecated": false }, { "slug": "save-firm-slack-webhook", "operation_id": "save_firm_slack_webhook", "method": "PUT", "path": "/api/v1/advisory-firms/{firm_id}/slack", "summary": "Save firm Slack webhook", "deprecated": false }, { "slug": "get-firm-slack-status", "operation_id": "get_firm_slack_status", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/slack/status", "summary": "Get firm Slack status", "deprecated": false }, { "slug": "test-firm-slack-webhook-legacy", "operation_id": "test_firm_slack_webhook_legacy", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/slack/test", "summary": "Test Slack webhook", "deprecated": false }, { "slug": "disconnect-firm-slack", "operation_id": "disconnect_firm_slack", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/slack/{webhook_id}", "summary": "Disconnect Slack", "deprecated": false }, { "slug": "update-firm-slack-preferences", "operation_id": "update_firm_slack_preferences", "method": "PUT", "path": "/api/v1/advisory-firms/{firm_id}/slack/{webhook_id}/preferences", "summary": "Update firm Slack notification preferences", "deprecated": false }, { "slug": "test-firm-slack-webhook", "operation_id": "test_firm_slack_webhook", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/slack/{webhook_id}/test", "summary": "Test Slack webhook", "deprecated": false }, { "slug": "update-stripe-customer", "operation_id": "update_stripe_customer", "method": "PUT", "path": "/api/v1/advisory-firms/{firm_id}/stripe-customer", "summary": "Link Stripe customer", "deprecated": false }, { "slug": "list-firm-users", "operation_id": "list_firm_users", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/users", "summary": "List firm users", "deprecated": false }, { "slug": "add-user-to-firm", "operation_id": "add_user_to_firm", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/users", "summary": "Add user to firm", "deprecated": false }, { "slug": "invite-staff-to-firm", "operation_id": "invite_staff_to_firm", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/users/invite", "summary": "Invite a staff member to the firm", "deprecated": false }, { "slug": "remove-user-from-firm", "operation_id": "remove_user_from_firm", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}", "summary": "Remove user from firm", "deprecated": false }, { "slug": "set-firm-user-api-access", "operation_id": "set_firm_user_api_access", "method": "PATCH", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}/api-access", "summary": "Set firm user API access", "deprecated": false }, { "slug": "get-firm-staff-menu", "operation_id": "get_firm_staff_menu", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}/menu", "summary": "Get a firm staff member's sidebar menu", "deprecated": false }, { "slug": "set-firm-staff-menu", "operation_id": "set_firm_staff_menu", "method": "PUT", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}/menu", "summary": "Set a firm staff member's sidebar menu", "deprecated": false }, { "slug": "update-user-role-in-firm", "operation_id": "update_user_role_in_firm", "method": "PUT", "path": "/api/v1/advisory-firms/{firm_id}/users/{user_id}/role", "summary": "Update user role in firm", "deprecated": false } ], "description": "Advisory firm management for multi-tenant accounting.", "description_html": "Advisory firm management for multi-tenant accounting.
\n" }, { "name": "ai-chat-public", "slug": "ai-chat-public", "operations": [ { "slug": "fetch-public-conversation", "operation_id": "fetch_public_conversation", "method": "GET", "path": "/api/v1/share/{token}", "summary": "Public conversation viewer (unauthenticated)", "deprecated": false }, { "slug": "fetch-shared-conversation-as-member", "operation_id": "fetch_shared_conversation_as_member", "method": "GET", "path": "/api/v1/share/{token}/member", "summary": "Shared conversation viewer (authenticated)", "deprecated": false } ] }, { "name": "ai-reporting", "slug": "ai-reporting", "operations": [ { "slug": "list-decks", "operation_id": "list_decks", "method": "GET", "path": "/api/v1/ai-reporting/decks", "summary": "List generated decks", "deprecated": false }, { "slug": "generate-deck", "operation_id": "generate_deck", "method": "POST", "path": "/api/v1/ai-reporting/decks", "summary": "Generate a new AI deck", "deprecated": false }, { "slug": "delete-deck", "operation_id": "delete_deck", "method": "DELETE", "path": "/api/v1/ai-reporting/decks/{deck_id}", "summary": "Delete a deck", "deprecated": false }, { "slug": "get-deck", "operation_id": "get_deck", "method": "GET", "path": "/api/v1/ai-reporting/decks/{deck_id}", "summary": "Get a deck", "deprecated": false }, { "slug": "export-deck", "operation_id": "export_deck", "method": "POST", "path": "/api/v1/ai-reporting/decks/{deck_id}/export", "summary": "Export a deck", "deprecated": false }, { "slug": "refresh-deck", "operation_id": "refresh_deck", "method": "POST", "path": "/api/v1/ai-reporting/decks/{deck_id}/refresh", "summary": "Refresh a deck with live data", "deprecated": false }, { "slug": "create-share", "operation_id": "create_share", "method": "POST", "path": "/api/v1/ai-reporting/decks/{deck_id}/share", "summary": "Create a public share link for a deck", "deprecated": false }, { "slug": "list-shares", "operation_id": "list_shares", "method": "GET", "path": "/api/v1/ai-reporting/decks/{deck_id}/shares", "summary": "List share links for a deck", "deprecated": false }, { "slug": "add-slide", "operation_id": "add_slide", "method": "POST", "path": "/api/v1/ai-reporting/decks/{deck_id}/slides", "summary": "Add a slide to a deck", "deprecated": false }, { "slug": "reorder-slides", "operation_id": "reorder_slides", "method": "POST", "path": "/api/v1/ai-reporting/decks/{deck_id}/slides/reorder", "summary": "Reorder slides", "deprecated": false }, { "slug": "update-slide", "operation_id": "update_slide", "method": "PATCH", "path": "/api/v1/ai-reporting/decks/{deck_id}/slides/{slide_id}", "summary": "Edit a slide", "deprecated": false }, { "slug": "duplicate-slide", "operation_id": "duplicate_slide", "method": "POST", "path": "/api/v1/ai-reporting/decks/{deck_id}/slides/{slide_id}/duplicate", "summary": "Duplicate a slide", "deprecated": false }, { "slug": "refresh-slide", "operation_id": "refresh_slide", "method": "POST", "path": "/api/v1/ai-reporting/decks/{deck_id}/slides/{slide_id}/refresh", "summary": "Refresh a single slide with live data", "deprecated": false }, { "slug": "toggle-slide-hidden", "operation_id": "toggle_slide_hidden", "method": "POST", "path": "/api/v1/ai-reporting/decks/{deck_id}/slides/{slide_id}/toggle-hidden", "summary": "Toggle slide visibility", "deprecated": false }, { "slug": "revoke-share", "operation_id": "revoke_share", "method": "DELETE", "path": "/api/v1/ai-reporting/shares/{share_id}", "summary": "Revoke a share link", "deprecated": false } ] }, { "name": "anomalies", "slug": "anomalies", "operations": [ { "slug": "list-anomalies", "operation_id": "list_anomalies", "method": "GET", "path": "/api/v1/anomalies", "summary": "List transaction anomalies", "deprecated": false }, { "slug": "dismiss-anomaly", "operation_id": "dismiss_anomaly", "method": "POST", "path": "/api/v1/anomalies/dismiss", "summary": "Dismiss an anomaly", "deprecated": false }, { "slug": "bulk-dismiss-all", "operation_id": "bulk_dismiss_all", "method": "POST", "path": "/api/v1/anomalies/dismiss-all", "summary": "Bulk dismiss all active anomalies", "deprecated": false }, { "slug": "bulk-dismiss-by-period", "operation_id": "bulk_dismiss_by_period", "method": "POST", "path": "/api/v1/anomalies/dismiss-by-period", "summary": "Bulk dismiss anomalies in a date range", "deprecated": false }, { "slug": "bulk-dismiss-type", "operation_id": "bulk_dismiss_type", "method": "POST", "path": "/api/v1/anomalies/dismiss-type", "summary": "Bulk dismiss all anomalies of a given type", "deprecated": false }, { "slug": "rescan-anomalies", "operation_id": "rescan_anomalies", "method": "POST", "path": "/api/v1/anomalies/rescan", "summary": "Trigger an on-demand anomaly rescan", "deprecated": false }, { "slug": "restore-anomaly", "operation_id": "restore_anomaly", "method": "POST", "path": "/api/v1/anomalies/restore", "summary": "Restore a dismissed anomaly", "deprecated": false }, { "slug": "get-anomaly-detail", "operation_id": "get_anomaly_detail", "method": "GET", "path": "/api/v1/anomalies/{fingerprint}", "summary": "Get anomaly finding detail", "deprecated": false }, { "slug": "resolve-anomaly", "operation_id": "resolve_anomaly", "method": "POST", "path": "/api/v1/anomalies/{fingerprint}/resolve", "summary": "Execute a recommended action and dismiss the anomaly", "deprecated": false } ], "description": "AI-powered anomaly detection for unusual transactions and patterns.", "description_html": "AI-powered anomaly detection for unusual transactions and patterns.
\n" }, { "name": "ap-approval", "slug": "ap-approval", "operations": [ { "slug": "get-ap-approval-workflow", "operation_id": "get_ap_approval_workflow", "method": "GET", "path": "/api/v1/ap-approval", "summary": "Get AP approval workflow", "deprecated": false }, { "slug": "get-analytics", "operation_id": "get_analytics", "method": "GET", "path": "/api/v1/ap-approval/analytics", "summary": "Approval queue analytics", "deprecated": false }, { "slug": "get-approvers", "operation_id": "get_approvers", "method": "GET", "path": "/api/v1/ap-approval/approvers", "summary": "Get approvers by tier", "deprecated": false }, { "slug": "update-approvers", "operation_id": "update_approvers", "method": "PUT", "path": "/api/v1/ap-approval/approvers/{tier}", "summary": "Update approvers for a tier", "deprecated": false }, { "slug": "batch-approve", "operation_id": "batch_approve", "method": "POST", "path": "/api/v1/ap-approval/batch-approve", "summary": "Batch approve pending items", "deprecated": false }, { "slug": "list-completed-approvals", "operation_id": "list_completed_approvals", "method": "GET", "path": "/api/v1/ap-approval/completed", "summary": "List completed AP approvals", "deprecated": false }, { "slug": "list-pending-approvals", "operation_id": "list_pending_approvals", "method": "GET", "path": "/api/v1/ap-approval/pending", "summary": "List pending AP approvals", "deprecated": false }, { "slug": "provision-ap-approval-workflow", "operation_id": "provision_ap_approval_workflow", "method": "POST", "path": "/api/v1/ap-approval/provision", "summary": "Provision AP approval workflow for firm", "deprecated": false }, { "slug": "score-approval-risk", "operation_id": "score_approval_risk", "method": "POST", "path": "/api/v1/ap-approval/risk-score", "summary": "AI approval risk scores", "deprecated": false }, { "slug": "ap-guard-get-run", "operation_id": "ap_guard_get_run", "method": "GET", "path": "/api/v1/ap-approval/runs/{execution_id}", "summary": "Verify an AP approval run", "deprecated": false }, { "slug": "ap-guard-get-thresholds", "operation_id": "ap_guard_get_thresholds", "method": "GET", "path": "/api/v1/ap-approval/thresholds", "summary": "Get approval thresholds and routing warnings", "deprecated": false }, { "slug": "update-thresholds", "operation_id": "update_thresholds", "method": "PATCH", "path": "/api/v1/ap-approval/thresholds", "summary": "Update approval thresholds", "deprecated": false }, { "slug": "list-vendor-approval-routes", "operation_id": "list_vendor_approval_routes", "method": "GET", "path": "/api/v1/ap-approval/vendor-routes", "summary": "List vendor approval routes", "deprecated": false }, { "slug": "create-vendor-approval-route", "operation_id": "create_vendor_approval_route", "method": "POST", "path": "/api/v1/ap-approval/vendor-routes", "summary": "Create a vendor approval route", "deprecated": false }, { "slug": "delete-vendor-approval-route", "operation_id": "delete_vendor_approval_route", "method": "DELETE", "path": "/api/v1/ap-approval/vendor-routes/{route_id}", "summary": "Delete a vendor approval route", "deprecated": false }, { "slug": "update-vendor-approval-route", "operation_id": "update_vendor_approval_route", "method": "PATCH", "path": "/api/v1/ap-approval/vendor-routes/{route_id}", "summary": "Update a vendor approval route", "deprecated": false }, { "slug": "get-vendor-history", "operation_id": "get_vendor_history", "method": "GET", "path": "/api/v1/ap-approval/vendor/{vendor_id}/history", "summary": "Vendor payment history", "deprecated": false } ], "description": "Accounts payable approval workflows for bill review and authorization.", "description_html": "Accounts payable approval workflows for bill review and authorization.
\n" }, { "name": "api-clients", "slug": "api-clients", "operations": [ { "slug": "list-api-clients", "operation_id": "list_api_clients", "method": "GET", "path": "/api/v1/api-clients", "summary": "List API clients", "deprecated": false }, { "slug": "create-api-client", "operation_id": "create_api_client", "method": "POST", "path": "/api/v1/api-clients", "summary": "Create API client", "deprecated": false }, { "slug": "get-api-client", "operation_id": "get_api_client", "method": "GET", "path": "/api/v1/api-clients/{client_pk}", "summary": "Get API client", "deprecated": false }, { "slug": "update-api-client", "operation_id": "update_api_client", "method": "PATCH", "path": "/api/v1/api-clients/{client_pk}", "summary": "Update API client", "deprecated": false }, { "slug": "disable-api-client", "operation_id": "disable_api_client", "method": "POST", "path": "/api/v1/api-clients/{client_pk}/disable", "summary": "Disable API client", "deprecated": false }, { "slug": "enable-api-client", "operation_id": "enable_api_client", "method": "POST", "path": "/api/v1/api-clients/{client_pk}/enable", "summary": "Enable API client", "deprecated": false }, { "slug": "replace-api-client-jwks", "operation_id": "replace_api_client_jwks", "method": "PUT", "path": "/api/v1/api-clients/{client_pk}/jwks", "summary": "Replace API client JWK set", "deprecated": false }, { "slug": "add-api-client-signing-key", "operation_id": "add_api_client_signing_key", "method": "POST", "path": "/api/v1/api-clients/{client_pk}/signing-keys", "summary": "Add API client signing key", "deprecated": false }, { "slug": "retire-api-client-signing-key", "operation_id": "retire_api_client_signing_key", "method": "POST", "path": "/api/v1/api-clients/{client_pk}/signing-keys/{kid}/retire", "summary": "Retire API client signing key", "deprecated": false } ] }, { "name": "api-tokens", "slug": "api-tokens", "operations": [ { "slug": "list-tokens", "operation_id": "list_tokens", "method": "GET", "path": "/api/v1/tokens", "summary": "List tokens", "deprecated": false }, { "slug": "create-token", "operation_id": "create_token", "method": "POST", "path": "/api/v1/tokens", "summary": "Create token", "deprecated": false }, { "slug": "get-api-access", "operation_id": "get_api_access", "method": "GET", "path": "/api/v1/tokens/access", "summary": "Get API access status", "deprecated": false }, { "slug": "request-api-access", "operation_id": "request_api_access", "method": "POST", "path": "/api/v1/tokens/access-request", "summary": "Request API access", "deprecated": false }, { "slug": "get-client-ip-address", "operation_id": "get_client_ip_address", "method": "GET", "path": "/api/v1/tokens/client-ip", "summary": "Get your current IP", "deprecated": false }, { "slug": "delete-token", "operation_id": "delete_token", "method": "DELETE", "path": "/api/v1/tokens/{token_id}", "summary": "Delete token", "deprecated": false }, { "slug": "revoke-token", "operation_id": "revoke_token", "method": "POST", "path": "/api/v1/tokens/{token_id}/revoke", "summary": "Revoke token", "deprecated": false }, { "slug": "rotate-token", "operation_id": "rotate_token", "method": "POST", "path": "/api/v1/tokens/{token_id}/rotate", "summary": "Rotate token", "deprecated": false } ], "description": "Create, list, and revoke Bearer API tokens.", "description_html": "Create, list, and revoke Bearer API tokens.
\n" }, { "name": "ar-subledgers", "slug": "ar-subledgers", "operations": [ { "slug": "ar-subledgers-customer-cash-receipts", "operation_id": "ar_subledgers_customer_cash_receipts", "method": "GET", "path": "/api/v1/ar/customer-cash-receipts", "summary": "Cash received from customers", "deprecated": false }, { "slug": "ar-subledgers-backfill", "operation_id": "ar_subledgers_backfill", "method": "POST", "path": "/api/v1/ar/subledgers/backfill", "summary": "Backfill customer AR sub-ledgers", "deprecated": false } ] }, { "name": "attention", "slug": "attention", "operations": [ { "slug": "list-attention", "operation_id": "list_attention", "method": "GET", "path": "/api/v1/attention", "summary": "List attention items", "deprecated": false }, { "slug": "clear-dismissals", "operation_id": "clear_dismissals", "method": "POST", "path": "/api/v1/attention/clear-dismissals", "summary": "Restore dismissed live alerts", "deprecated": false }, { "slug": "mark-all-read", "operation_id": "mark_all_read", "method": "POST", "path": "/api/v1/attention/mark-all-read", "summary": "Mark all read + clear dismissals", "deprecated": false }, { "slug": "get-attention-summary", "operation_id": "get_attention_summary", "method": "GET", "path": "/api/v1/attention/summary", "summary": "Attention summary counts", "deprecated": false }, { "slug": "get-attention-item", "operation_id": "get_attention_item", "method": "GET", "path": "/api/v1/attention/{item_id}", "summary": "Get single attention item", "deprecated": false }, { "slug": "mark-item-read", "operation_id": "mark_item_read", "method": "POST", "path": "/api/v1/attention/{item_id}/read", "summary": "Mark item read or dismiss", "deprecated": false } ] }, { "name": "automation-review", "slug": "automation-review", "operations": [ { "slug": "list-counterparty-merge-reviews", "operation_id": "list_counterparty_merge_reviews", "method": "GET", "path": "/api/v1/counterparty-merge-review", "summary": "Counterparty merges waiting for review", "deprecated": false }, { "slug": "decide-counterparty-merge-pairs", "operation_id": "decide_counterparty_merge_pairs", "method": "POST", "path": "/api/v1/counterparty-merge-review/{pending_change_id}/decide", "summary": "Approve or decline counterparty merge pairs", "deprecated": false }, { "slug": "bulk-accept-payment-suggestions", "operation_id": "bulk_accept_payment_suggestions", "method": "POST", "path": "/api/v1/payment-suggestions/bulk-accept", "summary": "Bulk accept payment suggestions", "deprecated": false } ] }, { "name": "automation-runs", "slug": "automation-runs", "operations": [ { "slug": "list-automation-runs", "operation_id": "list_automation_runs", "method": "GET", "path": "/api/v1/automation-runs", "summary": "List recent automation runs", "deprecated": false }, { "slug": "get-automation-run", "operation_id": "get_automation_run", "method": "GET", "path": "/api/v1/automation-runs/{run_id}", "summary": "Get one automation run", "deprecated": false }, { "slug": "undo-automation-run", "operation_id": "undo_automation_run", "method": "POST", "path": "/api/v1/automation-runs/{run_id}/undo", "summary": "Undo an automation run", "deprecated": false } ] }, { "name": "automation-settings", "slug": "automation-settings", "operations": [ { "slug": "get-automation-settings", "operation_id": "get_automation_settings", "method": "GET", "path": "/api/v1/automation-settings", "summary": "Get automation settings", "deprecated": false }, { "slug": "update-automation-settings", "operation_id": "update_automation_settings", "method": "PATCH", "path": "/api/v1/automation-settings", "summary": "Update automation settings", "deprecated": false }, { "slug": "plan-automation-settings", "operation_id": "plan_automation_settings", "method": "POST", "path": "/api/v1/automation-settings/plan", "summary": "Preview an automation settings change", "deprecated": false } ] }, { "name": "bank-deposits", "slug": "bank-deposits", "operations": [ { "slug": "list-bank-deposits", "operation_id": "list_bank_deposits", "method": "GET", "path": "/api/v1/bank-deposits", "summary": "List bank deposits", "deprecated": false }, { "slug": "create-bank-deposit", "operation_id": "create_bank_deposit", "method": "POST", "path": "/api/v1/bank-deposits", "summary": "Create bank deposit", "deprecated": false }, { "slug": "list-undeposited", "operation_id": "list_undeposited", "method": "GET", "path": "/api/v1/bank-deposits/undeposited", "summary": "List undeposited funds", "deprecated": false }, { "slug": "get-bank-deposit", "operation_id": "get_bank_deposit", "method": "GET", "path": "/api/v1/bank-deposits/{deposit_id}", "summary": "Get bank deposit", "deprecated": false }, { "slug": "void-bank-deposit", "operation_id": "void_bank_deposit", "method": "POST", "path": "/api/v1/bank-deposits/{deposit_id}/void", "summary": "Void bank deposit", "deprecated": false } ] }, { "name": "billing", "slug": "billing", "operations": [ { "slug": "toggle-addon", "operation_id": "toggle_addon", "method": "POST", "path": "/api/v1/billing/addon", "summary": "Toggle Addon", "deprecated": false }, { "slug": "preview-addon-change", "operation_id": "preview_addon_change", "method": "POST", "path": "/api/v1/billing/addon/preview", "summary": "Preview Addon Change", "deprecated": false }, { "slug": "get-ai-usage", "operation_id": "get_ai_usage", "method": "GET", "path": "/api/v1/billing/ai-usage", "summary": "Get Ai Usage", "deprecated": false }, { "slug": "get-ai-usage-details", "operation_id": "get_ai_usage_details", "method": "GET", "path": "/api/v1/billing/ai-usage/details", "summary": "Get Ai Usage Details", "deprecated": false }, { "slug": "pause-ai-features", "operation_id": "pause_ai_features", "method": "POST", "path": "/api/v1/billing/ai/pause", "summary": "Pause Ai Features", "deprecated": false }, { "slug": "resume-ai-features", "operation_id": "resume_ai_features", "method": "POST", "path": "/api/v1/billing/ai/resume", "summary": "Resume Ai Features", "deprecated": false }, { "slug": "get-billing-catalog", "operation_id": "get_billing_catalog", "method": "GET", "path": "/api/v1/billing/catalog", "summary": "Get Billing Catalog", "deprecated": false }, { "slug": "change-plan", "operation_id": "change_plan", "method": "POST", "path": "/api/v1/billing/change-plan", "summary": "Change Plan", "deprecated": false }, { "slug": "create-checkout-session", "operation_id": "create_checkout_session", "method": "POST", "path": "/api/v1/billing/checkout", "summary": "Create Checkout Session", "deprecated": false }, { "slug": "change-firm-tier", "operation_id": "change_firm_tier", "method": "POST", "path": "/api/v1/billing/firm/change-tier", "summary": "Change Firm Tier", "deprecated": false }, { "slug": "get-firm-client-usage", "operation_id": "get_firm_client_usage", "method": "GET", "path": "/api/v1/billing/firm/client-usage", "summary": "Get Firm Client Usage", "deprecated": false }, { "slug": "grandfather-business", "operation_id": "grandfather_business", "method": "POST", "path": "/api/v1/billing/grandfather", "summary": "Grandfather the current business (superuser only)", "deprecated": false }, { "slug": "get-grandfathered-summary", "operation_id": "get_grandfathered_summary", "method": "GET", "path": "/api/v1/billing/grandfathered-summary", "summary": "Get Grandfathered Summary", "deprecated": false }, { "slug": "get-invoice-history", "operation_id": "get_invoice_history", "method": "GET", "path": "/api/v1/billing/invoices", "summary": "Get Invoice History", "deprecated": false }, { "slug": "migrate-from-grandfathered", "operation_id": "migrate_from_grandfathered", "method": "POST", "path": "/api/v1/billing/migrate-from-grandfathered", "summary": "Migrate grandfathered account to a paid plan", "deprecated": false }, { "slug": "create-portal-session", "operation_id": "create_portal_session", "method": "POST", "path": "/api/v1/billing/portal", "summary": "Create Portal Session", "deprecated": false }, { "slug": "get-pricing-config", "operation_id": "get_pricing_config", "method": "GET", "path": "/api/v1/billing/pricing-config", "summary": "Get Pricing Config", "deprecated": false }, { "slug": "get-billing-status", "operation_id": "get_billing_status", "method": "GET", "path": "/api/v1/billing/status", "summary": "Get Billing Status", "deprecated": false } ], "description": "Subscription billing, plan management, and usage tracking.", "description_html": "Subscription billing, plan management, and usage tracking.
\n" }, { "name": "bills", "slug": "bills", "operations": [ { "slug": "list-bills", "operation_id": "list_bills", "method": "GET", "path": "/api/v1/bills", "summary": "List bills", "deprecated": false }, { "slug": "create-bill", "operation_id": "create_bill", "method": "POST", "path": "/api/v1/bills", "summary": "Create bill", "deprecated": false }, { "slug": "get-bill-aging", "operation_id": "get_bill_aging", "method": "GET", "path": "/api/v1/bills/aging", "summary": "AP aging summary", "deprecated": false }, { "slug": "ai-create-bill-payload", "operation_id": "ai_create_bill_payload", "method": "POST", "path": "/api/v1/bills/ai-create", "summary": "AI-extract draft bills from documents", "deprecated": false }, { "slug": "create-bulk-bills", "operation_id": "create_bulk_bills", "method": "POST", "path": "/api/v1/bills/bulk", "summary": "Bulk create bills", "deprecated": false }, { "slug": "check-duplicate-bills", "operation_id": "check_duplicate_bills", "method": "GET", "path": "/api/v1/bills/duplicate-check", "summary": "Check for possible duplicate bills", "deprecated": false }, { "slug": "list-expense-candidates", "operation_id": "list_expense_candidates", "method": "GET", "path": "/api/v1/bills/expense-candidates", "summary": "List expense candidates", "deprecated": false }, { "slug": "get-bill-metrics", "operation_id": "get_bill_metrics", "method": "GET", "path": "/api/v1/bills/metrics", "summary": "Get bill metrics", "deprecated": false }, { "slug": "get-bill-pay-plan", "operation_id": "get_bill_pay_plan", "method": "GET", "path": "/api/v1/bills/pay-plan", "summary": "Pay plan: which bills to pay first", "deprecated": false }, { "slug": "build-external-payment-run", "operation_id": "build_external_payment_run", "method": "POST", "path": "/api/v1/bills/payment-run", "summary": "Build the pay list for a run date", "deprecated": false }, { "slug": "list-bill-payment-suggestions", "operation_id": "list_bill_payment_suggestions", "method": "GET", "path": "/api/v1/bills/payment-suggestions", "summary": "List bill payment suggestions", "deprecated": false }, { "slug": "bulk-approve-bill-suggestions", "operation_id": "bulk_approve_bill_suggestions", "method": "POST", "path": "/api/v1/bills/payment-suggestions/bulk-approve", "summary": "Bulk approve bill payment suggestions", "deprecated": false }, { "slug": "trigger-bill-payment-matching", "operation_id": "trigger_bill_payment_matching", "method": "POST", "path": "/api/v1/bills/payment-suggestions/trigger", "summary": "Trigger bill payment matching", "deprecated": false }, { "slug": "accept-bill-payment-suggestion", "operation_id": "accept_bill_payment_suggestion", "method": "POST", "path": "/api/v1/bills/payment-suggestions/{suggestion_id}/accept", "summary": "Accept a bill payment suggestion", "deprecated": false }, { "slug": "reject-bill-payment-suggestion", "operation_id": "reject_bill_payment_suggestion", "method": "POST", "path": "/api/v1/bills/payment-suggestions/{suggestion_id}/reject", "summary": "Reject a bill payment suggestion", "deprecated": false }, { "slug": "create-bill-payments-batch", "operation_id": "create_bill_payments_batch", "method": "POST", "path": "/api/v1/bills/payments/batch", "summary": "Split one transaction across multiple bills", "deprecated": false }, { "slug": "create-bill-received", "operation_id": "create_bill_received", "method": "POST", "path": "/api/v1/bills/received", "summary": "Create bill in received status", "deprecated": false }, { "slug": "suggest-payment-priority", "operation_id": "suggest_payment_priority", "method": "POST", "path": "/api/v1/bills/suggest-payment-priority", "summary": "Payment priority suggestions", "deprecated": false }, { "slug": "tie-out-external-bills", "operation_id": "tie_out_external_bills", "method": "POST", "path": "/api/v1/bills/tie-out", "summary": "Tie bills out against an external bill-pay export", "deprecated": false }, { "slug": "list-upcoming-bills", "operation_id": "list_upcoming_bills", "method": "GET", "path": "/api/v1/bills/upcoming", "summary": "List upcoming (expected) bills", "deprecated": false }, { "slug": "create-upcoming-bill", "operation_id": "create_upcoming_bill", "method": "POST", "path": "/api/v1/bills/upcoming", "summary": "Create an upcoming bill (optionally recurring)", "deprecated": false }, { "slug": "delete-upcoming-bill", "operation_id": "delete_upcoming_bill", "method": "DELETE", "path": "/api/v1/bills/upcoming/{upcoming_bill_id}", "summary": "Delete an upcoming bill", "deprecated": false }, { "slug": "get-upcoming-bill", "operation_id": "get_upcoming_bill", "method": "GET", "path": "/api/v1/bills/upcoming/{upcoming_bill_id}", "summary": "Get one upcoming bill", "deprecated": false }, { "slug": "update-upcoming-bill", "operation_id": "update_upcoming_bill", "method": "PATCH", "path": "/api/v1/bills/upcoming/{upcoming_bill_id}", "summary": "Edit an upcoming bill", "deprecated": false }, { "slug": "convert-upcoming-bill", "operation_id": "convert_upcoming_bill", "method": "POST", "path": "/api/v1/bills/upcoming/{upcoming_bill_id}/convert", "summary": "Push an upcoming bill into a real bill", "deprecated": false }, { "slug": "link-upcoming-bill", "operation_id": "link_upcoming_bill", "method": "POST", "path": "/api/v1/bills/upcoming/{upcoming_bill_id}/link", "summary": "Match an upcoming bill to a bill that arrived", "deprecated": false }, { "slug": "upload-bill-file", "operation_id": "upload_bill_file", "method": "POST", "path": "/api/v1/bills/upload", "summary": "Upload bill document", "deprecated": false }, { "slug": "delete-bill", "operation_id": "delete_bill", "method": "DELETE", "path": "/api/v1/bills/{bill_id}", "summary": "Delete bill", "deprecated": false }, { "slug": "get-bill", "operation_id": "get_bill", "method": "GET", "path": "/api/v1/bills/{bill_id}", "summary": "Get bill", "deprecated": false }, { "slug": "update-bill", "operation_id": "update_bill", "method": "PUT", "path": "/api/v1/bills/{bill_id}", "summary": "Update bill", "deprecated": false }, { "slug": "approve-bill", "operation_id": "approve_bill", "method": "PATCH", "path": "/api/v1/bills/{bill_id}/approval", "summary": "Approve bill", "deprecated": false }, { "slug": "attach-file-to-bill", "operation_id": "attach_file_to_bill", "method": "PATCH", "path": "/api/v1/bills/{bill_id}/attachment", "summary": "Attach file to existing bill", "deprecated": false }, { "slug": "cancel-bill", "operation_id": "cancel_bill", "method": "PATCH", "path": "/api/v1/bills/{bill_id}/cancellation", "summary": "Cancel bill", "deprecated": false }, { "slug": "compare-bill-against-contract", "operation_id": "compare_bill_against_contract", "method": "POST", "path": "/api/v1/bills/{bill_id}/contract-comparison", "summary": "Compare bill against vendor contract", "deprecated": false }, { "slug": "decline-bill", "operation_id": "decline_bill", "method": "POST", "path": "/api/v1/bills/{bill_id}/decline", "summary": "Decline bill", "deprecated": false }, { "slug": "duplicate-bill", "operation_id": "duplicate_bill", "method": "POST", "path": "/api/v1/bills/{bill_id}/duplicate", "summary": "Duplicate bill", "deprecated": false }, { "slug": "bill-hold-place", "operation_id": "bill_hold_place", "method": "POST", "path": "/api/v1/bills/{bill_id}/hold", "summary": "Put a bill on payment hold", "deprecated": false }, { "slug": "generate-bill-journal-entry", "operation_id": "generate_bill_journal_entry", "method": "POST", "path": "/api/v1/bills/{bill_id}/journal-entry", "summary": "Generate bill journal entry", "deprecated": false }, { "slug": "attach-journal-entry-to-bill", "operation_id": "attach_journal_entry_to_bill", "method": "POST", "path": "/api/v1/bills/{bill_id}/journal-entry/link", "summary": "Attach journal entry to bill", "deprecated": false }, { "slug": "unlink-journal-entry-from-bill", "operation_id": "unlink_journal_entry_from_bill", "method": "POST", "path": "/api/v1/bills/{bill_id}/journal-entry/unlink", "summary": "Detach journal entry from bill", "deprecated": false }, { "slug": "set-bill-payment-initiation", "operation_id": "set_bill_payment_initiation", "method": "PATCH", "path": "/api/v1/bills/{bill_id}/payment-initiation", "summary": "Mark or clear bill payment-initiated", "deprecated": false }, { "slug": "list-bill-payments", "operation_id": "list_bill_payments", "method": "GET", "path": "/api/v1/bills/{bill_id}/payments", "summary": "List bill payments", "deprecated": false }, { "slug": "create-bill-payment", "operation_id": "create_bill_payment", "method": "POST", "path": "/api/v1/bills/{bill_id}/payments", "summary": "Add payment to bill", "deprecated": false }, { "slug": "delete-bill-payment", "operation_id": "delete_bill_payment", "method": "DELETE", "path": "/api/v1/bills/{bill_id}/payments/{payment_id}", "summary": "Remove payment from bill", "deprecated": false }, { "slug": "mark-bill-received", "operation_id": "mark_bill_received", "method": "PATCH", "path": "/api/v1/bills/{bill_id}/receipt", "summary": "Mark bill as received", "deprecated": false }, { "slug": "bill-hold-release", "operation_id": "bill_hold_release", "method": "POST", "path": "/api/v1/bills/{bill_id}/release-hold", "summary": "Release a bill's payment hold", "deprecated": false }, { "slug": "resolve-pending-approval", "operation_id": "resolve_pending_approval", "method": "POST", "path": "/api/v1/bills/{bill_id}/resolve-approval", "summary": "Force-resolve a stuck pending-approval bill", "deprecated": false }, { "slug": "revert-bill-to-draft", "operation_id": "revert_bill_to_draft", "method": "POST", "path": "/api/v1/bills/{bill_id}/revert-to-draft", "summary": "Revert bill to draft", "deprecated": false }, { "slug": "submit-bill-for-ap-approval", "operation_id": "submit_bill_for_ap_approval", "method": "POST", "path": "/api/v1/bills/{bill_id}/submit-for-ap-approval", "summary": "Submit bill for AP approval", "deprecated": false }, { "slug": "submit-bill-for-approval", "operation_id": "submit_bill_for_approval", "method": "POST", "path": "/api/v1/bills/{bill_id}/submit-for-approval", "summary": "Send bill for approval", "deprecated": false } ], "description": "Accounts payable — create and manage vendor bills.", "description_html": "Accounts payable — create and manage vendor bills.
\n" }, { "name": "budgets", "slug": "budgets", "operations": [ { "slug": "list-budgets", "operation_id": "list_budgets", "method": "GET", "path": "/api/v1/budgets", "summary": "List budgets", "deprecated": false }, { "slug": "create-budget", "operation_id": "create_budget", "method": "POST", "path": "/api/v1/budgets", "summary": "Create budget", "deprecated": false }, { "slug": "generate-forecast", "operation_id": "generate_forecast", "method": "POST", "path": "/api/v1/budgets/forecast", "summary": "Generate forecast", "deprecated": false }, { "slug": "list-forecast-configs", "operation_id": "list_forecast_configs", "method": "GET", "path": "/api/v1/budgets/forecast/configs", "summary": "List forecast configs", "deprecated": false }, { "slug": "create-forecast-config", "operation_id": "create_forecast_config", "method": "POST", "path": "/api/v1/budgets/forecast/configs", "summary": "Create forecast config", "deprecated": false }, { "slug": "delete-budget", "operation_id": "delete_budget", "method": "DELETE", "path": "/api/v1/budgets/{budget_id}", "summary": "Delete budget", "deprecated": false }, { "slug": "get-budget", "operation_id": "get_budget", "method": "GET", "path": "/api/v1/budgets/{budget_id}", "summary": "Get budget", "deprecated": false }, { "slug": "update-budget", "operation_id": "update_budget", "method": "PATCH", "path": "/api/v1/budgets/{budget_id}", "summary": "Update budget", "deprecated": false }, { "slug": "activate-budget", "operation_id": "activate_budget", "method": "POST", "path": "/api/v1/budgets/{budget_id}/activate", "summary": "Activate budget", "deprecated": false }, { "slug": "copy-budget", "operation_id": "copy_budget", "method": "POST", "path": "/api/v1/budgets/{budget_id}/copy", "summary": "Copy budget", "deprecated": false }, { "slug": "list-budget-lines", "operation_id": "list_budget_lines", "method": "GET", "path": "/api/v1/budgets/{budget_id}/lines", "summary": "List budget lines", "deprecated": false }, { "slug": "add-budget-line", "operation_id": "add_budget_line", "method": "POST", "path": "/api/v1/budgets/{budget_id}/lines", "summary": "Add budget line", "deprecated": false }, { "slug": "delete-budget-line", "operation_id": "delete_budget_line", "method": "DELETE", "path": "/api/v1/budgets/{budget_id}/lines/{line_id}", "summary": "Delete budget line", "deprecated": false }, { "slug": "update-budget-line", "operation_id": "update_budget_line", "method": "PATCH", "path": "/api/v1/budgets/{budget_id}/lines/{line_id}", "summary": "Update budget line", "deprecated": false }, { "slug": "get-budget-vs-actual", "operation_id": "get_budget_vs_actual", "method": "GET", "path": "/api/v1/budgets/{budget_id}/vs-actual", "summary": "Budget vs Actual", "deprecated": false } ], "description": "Financial budgets and forecasts with variance tracking.", "description_html": "Financial budgets and forecasts with variance tracking.
\n" }, { "name": "businesses", "slug": "businesses", "operations": [ { "slug": "list-businesses", "operation_id": "list_businesses", "method": "GET", "path": "/api/v1/businesses", "summary": "List businesses", "deprecated": false }, { "slug": "create-business", "operation_id": "create_business", "method": "POST", "path": "/api/v1/businesses", "summary": "Create business", "deprecated": false }, { "slug": "get-auto-numbering-settings", "operation_id": "get_auto_numbering_settings", "method": "GET", "path": "/api/v1/businesses/auto-numbering", "summary": "Get auto-numbering settings", "deprecated": false }, { "slug": "update-auto-numbering-settings", "operation_id": "update_auto_numbering_settings", "method": "PUT", "path": "/api/v1/businesses/auto-numbering", "summary": "Update auto-numbering settings", "deprecated": false }, { "slug": "preview-auto-numbering", "operation_id": "preview_auto_numbering", "method": "GET", "path": "/api/v1/businesses/auto-numbering/preview", "summary": "Preview next auto-generated numbers", "deprecated": false }, { "slug": "update-entries-start", "operation_id": "update_entries_start", "method": "PUT", "path": "/api/v1/businesses/entries-start", "summary": "Update entries start date", "deprecated": false }, { "slug": "generate-coa-template", "operation_id": "generate_coa_template", "method": "POST", "path": "/api/v1/businesses/generate-coa", "summary": "Generate a COA template using AI", "deprecated": false }, { "slug": "get-invoice-settings", "operation_id": "get_invoice_settings", "method": "GET", "path": "/api/v1/businesses/invoice-settings", "summary": "Get invoice branding settings", "deprecated": false }, { "slug": "update-invoice-settings", "operation_id": "update_invoice_settings", "method": "PATCH", "path": "/api/v1/businesses/invoice-settings", "summary": "Update invoice branding settings", "deprecated": false }, { "slug": "sync-logo-to-stripe", "operation_id": "sync_logo_to_stripe", "method": "POST", "path": "/api/v1/businesses/invoice-settings/sync-logo", "summary": "Sync logo to Stripe branding", "deprecated": false }, { "slug": "check-mailbox-uniqueness", "operation_id": "check_mailbox_uniqueness", "method": "GET", "path": "/api/v1/businesses/mailbox", "summary": "Check mailbox uniqueness", "deprecated": false }, { "slug": "get-nav-preferences", "operation_id": "get_nav_preferences", "method": "GET", "path": "/api/v1/businesses/nav-preferences", "summary": "Get sidebar navigation preferences", "deprecated": false }, { "slug": "update-nav-preferences", "operation_id": "update_nav_preferences", "method": "PUT", "path": "/api/v1/businesses/nav-preferences", "summary": "Update sidebar navigation preferences", "deprecated": false }, { "slug": "suggest-nav-preferences", "operation_id": "suggest_nav_preferences", "method": "POST", "path": "/api/v1/businesses/nav-preferences/suggest", "summary": "AI-suggest which nav items to hide", "deprecated": false }, { "slug": "get-plaid-transaction-settings", "operation_id": "get_plaid_transaction_settings", "method": "GET", "path": "/api/v1/businesses/plaid-transaction-settings", "summary": "Get Plaid pending-transaction settings", "deprecated": false }, { "slug": "update-plaid-transaction-settings", "operation_id": "update_plaid_transaction_settings", "method": "PATCH", "path": "/api/v1/businesses/plaid-transaction-settings", "summary": "Update Plaid pending-transaction settings", "deprecated": false }, { "slug": "save-business-slack-webhook", "operation_id": "save_business_slack_webhook", "method": "PUT", "path": "/api/v1/businesses/slack", "summary": "Save Slack webhook URL", "deprecated": false }, { "slug": "get-slack-status", "operation_id": "get_slack_status", "method": "GET", "path": "/api/v1/businesses/slack/status", "summary": "Get Slack integration status", "deprecated": false }, { "slug": "test-business-slack-webhook-legacy", "operation_id": "test_business_slack_webhook_legacy", "method": "POST", "path": "/api/v1/businesses/slack/test", "summary": "Test Slack webhook", "deprecated": false }, { "slug": "disconnect-business-slack", "operation_id": "disconnect_business_slack", "method": "DELETE", "path": "/api/v1/businesses/slack/{webhook_id}", "summary": "Disconnect Slack", "deprecated": false }, { "slug": "update-slack-notification-preferences", "operation_id": "update_slack_notification_preferences", "method": "PUT", "path": "/api/v1/businesses/slack/{webhook_id}/preferences", "summary": "Update Slack notification preferences", "deprecated": false }, { "slug": "test-business-slack-webhook", "operation_id": "test_business_slack_webhook", "method": "POST", "path": "/api/v1/businesses/slack/{webhook_id}/test", "summary": "Test Slack webhook", "deprecated": false }, { "slug": "get-source-accounts", "operation_id": "get_source_accounts", "method": "GET", "path": "/api/v1/businesses/source-accounts", "summary": "Get source accounts", "deprecated": false }, { "slug": "list-table-views", "operation_id": "list_table_views", "method": "GET", "path": "/api/v1/businesses/user-preferences/table-views", "summary": "List saved table views", "deprecated": false }, { "slug": "patch-table-views", "operation_id": "patch_table_views", "method": "PATCH", "path": "/api/v1/businesses/user-preferences/table-views", "summary": "Merge saved table views", "deprecated": false }, { "slug": "get-table-views", "operation_id": "get_table_views", "method": "GET", "path": "/api/v1/businesses/user-preferences/table-views/{table_key}", "summary": "Get saved views for one table", "deprecated": false }, { "slug": "list-business-users", "operation_id": "list_business_users", "method": "GET", "path": "/api/v1/businesses/users", "summary": "List business users", "deprecated": false }, { "slug": "add-user-to-business", "operation_id": "add_user_to_business", "method": "POST", "path": "/api/v1/businesses/users", "summary": "Add user to business", "deprecated": false }, { "slug": "remove-user-from-business", "operation_id": "remove_user_from_business", "method": "DELETE", "path": "/api/v1/businesses/users/{user_id}", "summary": "Remove user from business", "deprecated": false }, { "slug": "update-user-role-in-business", "operation_id": "update_user_role_in_business", "method": "PUT", "path": "/api/v1/businesses/users/{user_id}", "summary": "Update user role", "deprecated": false }, { "slug": "get-user-role-in-business", "operation_id": "get_user_role_in_business", "method": "GET", "path": "/api/v1/businesses/users/{user_id}/role", "summary": "Get user role", "deprecated": false }, { "slug": "validate-coa-template", "operation_id": "validate_coa_template", "method": "POST", "path": "/api/v1/businesses/validate-coa", "summary": "Validate a custom COA template", "deprecated": false }, { "slug": "delete-business", "operation_id": "delete_business", "method": "DELETE", "path": "/api/v1/businesses/{business_id}", "summary": "Delete business", "deprecated": false }, { "slug": "get-business", "operation_id": "get_business", "method": "GET", "path": "/api/v1/businesses/{business_id}", "summary": "Get business", "deprecated": false }, { "slug": "update-business", "operation_id": "update_business", "method": "PUT", "path": "/api/v1/businesses/{business_id}", "summary": "Update business", "deprecated": false }, { "slug": "get-balance-sheet", "operation_id": "get_balance_sheet", "method": "GET", "path": "/api/v1/businesses/{business_id}/balance-sheet", "summary": "Get balance sheet (sectioned)", "deprecated": false }, { "slug": "analyze-balance-sheet", "operation_id": "analyze_balance_sheet", "method": "POST", "path": "/api/v1/businesses/{business_id}/balance-sheet/analyze", "summary": "AI analysis of balance sheet", "deprecated": false }, { "slug": "get-cash-flow-statement", "operation_id": "get_cash_flow_statement", "method": "GET", "path": "/api/v1/businesses/{business_id}/cash-flow-statement", "summary": "Get cash flow statement", "deprecated": false }, { "slug": "get-cash-flow-outflow-breakdown", "operation_id": "get_cash_flow_outflow_breakdown", "method": "GET", "path": "/api/v1/businesses/{business_id}/cash-flow-statement/outflow-breakdown", "summary": "Top categories and vendors by cash outflow", "deprecated": false }, { "slug": "get-cash-flow-statements-periodic", "operation_id": "get_cash_flow_statements_periodic", "method": "GET", "path": "/api/v1/businesses/{business_id}/cash-flow-statement/periodic", "summary": "Get cash flow statements for multiple periods", "deprecated": false }, { "slug": "analyze-cash-flow", "operation_id": "analyze_cash_flow", "method": "POST", "path": "/api/v1/businesses/{business_id}/cash-flow/analyze", "summary": "AI analysis of cash flow statement", "deprecated": false }, { "slug": "request-business-data-export", "operation_id": "request_business_data_export", "method": "POST", "path": "/api/v1/businesses/{business_id}/data-exports", "summary": "Request full business data export", "deprecated": false }, { "slug": "get-latest-business-data-export", "operation_id": "get_latest_business_data_export", "method": "GET", "path": "/api/v1/businesses/{business_id}/data-exports/latest", "summary": "Get latest business data export", "deprecated": false }, { "slug": "get-business-data-export", "operation_id": "get_business_data_export", "method": "GET", "path": "/api/v1/businesses/{business_id}/data-exports/{export_id}", "summary": "Get business data export", "deprecated": false }, { "slug": "get-business-deletion-schedule", "operation_id": "get_business_deletion_schedule", "method": "GET", "path": "/api/v1/businesses/{business_id}/deletion", "summary": "Get business deletion schedule", "deprecated": false }, { "slug": "cancel-business-deletion", "operation_id": "cancel_business_deletion", "method": "POST", "path": "/api/v1/businesses/{business_id}/deletion/cancel", "summary": "Cancel scheduled business deletion", "deprecated": false }, { "slug": "get-income-statement", "operation_id": "get_income_statement", "method": "GET", "path": "/api/v1/businesses/{business_id}/income-statement", "summary": "Get income statement (sectioned)", "deprecated": false }, { "slug": "get-income-statement-flat", "operation_id": "get_income_statement_flat", "method": "GET", "path": "/api/v1/businesses/{business_id}/income-statement-flat", "summary": "Get income statement (flat)", "deprecated": false }, { "slug": "analyze-income-statement", "operation_id": "analyze_income_statement", "method": "POST", "path": "/api/v1/businesses/{business_id}/income-statement/analyze", "summary": "AI analysis of income statement", "deprecated": false }, { "slug": "get-ledger-statement", "operation_id": "get_ledger_statement", "method": "GET", "path": "/api/v1/businesses/{business_id}/ledger/{ledger_id}/statement", "summary": "Get ledger statement for a date range", "deprecated": false }, { "slug": "get-ledger-vendor-breakdown", "operation_id": "get_ledger_vendor_breakdown", "method": "GET", "path": "/api/v1/businesses/{business_id}/ledger/{ledger_id}/vendor-breakdown", "summary": "Get vendor/counterparty breakdown for a ledger account", "deprecated": false }, { "slug": "get-ledger-vendor-period-matrix", "operation_id": "get_ledger_vendor_period_matrix", "method": "GET", "path": "/api/v1/businesses/{business_id}/ledger/{ledger_id}/vendor-period-matrix", "summary": "Get vendor breakdown across all periods for a ledger", "deprecated": false }, { "slug": "get-ledger-vendor-transactions", "operation_id": "get_ledger_vendor_transactions", "method": "GET", "path": "/api/v1/businesses/{business_id}/ledger/{ledger_id}/vendor-transactions", "summary": "Get individual transactions for a vendor within a ledger", "deprecated": false }, { "slug": "recategorize-line-entries", "operation_id": "recategorize_line_entries", "method": "PATCH", "path": "/api/v1/businesses/{business_id}/line-entries/recategorize", "summary": "Recategorize line entries", "deprecated": false }, { "slug": "provision-business-mailbox", "operation_id": "provision_business_mailbox", "method": "POST", "path": "/api/v1/businesses/{business_id}/mailbox", "summary": "Provision inbound mailbox", "deprecated": false }, { "slug": "get-cash-basis-bridge", "operation_id": "get_cash_basis_bridge", "method": "GET", "path": "/api/v1/businesses/{business_id}/reports/cash-basis/bridge", "summary": "Accrual to cash-basis net income bridge", "deprecated": false }, { "slug": "get-cash-basis-unapplied", "operation_id": "get_cash_basis_unapplied", "method": "GET", "path": "/api/v1/businesses/{business_id}/reports/cash-basis/unapplied", "summary": "List cash-basis unapplied settlements", "deprecated": false }, { "slug": "update-stripe-subscription", "operation_id": "update_stripe_subscription", "method": "PUT", "path": "/api/v1/businesses/{business_id}/stripe-subscription", "summary": "Update Stripe subscription", "deprecated": false }, { "slug": "get-business-sync-status", "operation_id": "get_business_sync_status", "method": "GET", "path": "/api/v1/businesses/{business_id}/sync", "summary": "Get sync status", "deprecated": false }, { "slug": "get-trial-balance", "operation_id": "get_trial_balance", "method": "GET", "path": "/api/v1/businesses/{business_id}/trial-balance", "summary": "Get trial balance", "deprecated": false }, { "slug": "compare-trial-balance-bridge", "operation_id": "compare_trial_balance_bridge", "method": "POST", "path": "/api/v1/businesses/{business_id}/trial-balance/bridge", "summary": "Compare another system's trial balance with ours", "deprecated": false }, { "slug": "get-trial-balance-diff", "operation_id": "get_trial_balance_diff", "method": "GET", "path": "/api/v1/businesses/{business_id}/trial-balance/diff", "summary": "Trial balance movement between two dates", "deprecated": false } ], "description": "Business entities — the core tenant in DayZero.", "description_html": "Business entities — the core tenant in DayZero.
\n" }, { "name": "catalog-items", "slug": "catalog-items", "operations": [ { "slug": "list-catalog-items", "operation_id": "list_catalog_items", "method": "GET", "path": "/api/v1/catalog-items", "summary": "List catalog items", "deprecated": false }, { "slug": "create-catalog-item", "operation_id": "create_catalog_item", "method": "POST", "path": "/api/v1/catalog-items", "summary": "Create catalog item", "deprecated": false }, { "slug": "get-bundle-components", "operation_id": "get_bundle_components", "method": "GET", "path": "/api/v1/catalog-items/{bundle_id}/components", "summary": "List a bundle's components", "deprecated": false }, { "slug": "set-bundle-components", "operation_id": "set_bundle_components", "method": "PUT", "path": "/api/v1/catalog-items/{bundle_id}/components", "summary": "Set a bundle's components", "deprecated": false }, { "slug": "deactivate-catalog-item", "operation_id": "deactivate_catalog_item", "method": "DELETE", "path": "/api/v1/catalog-items/{item_id}", "summary": "Deactivate catalog item", "deprecated": false }, { "slug": "get-catalog-item", "operation_id": "get_catalog_item", "method": "GET", "path": "/api/v1/catalog-items/{item_id}", "summary": "Get catalog item", "deprecated": false }, { "slug": "update-catalog-item", "operation_id": "update_catalog_item", "method": "PUT", "path": "/api/v1/catalog-items/{item_id}", "summary": "Update catalog item", "deprecated": false } ] }, { "name": "categorization-profile", "slug": "categorization-profile", "operations": [ { "slug": "get-profile", "operation_id": "get_profile", "method": "GET", "path": "/api/v1/categorization-profile", "summary": "Get the current business's categorization profile", "deprecated": false }, { "slug": "upsert-profile", "operation_id": "upsert_profile", "method": "PUT", "path": "/api/v1/categorization-profile", "summary": "Upsert the current business's categorization profile", "deprecated": false } ] }, { "name": "cfo-portal", "slug": "cfo-portal", "operations": [ { "slug": "cfo-portal-get-alerts", "operation_id": "cfo_portal_get_alerts", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/alerts", "summary": "Get CFO financial alerts", "deprecated": false }, { "slug": "cfo-portal-get-ap-aging", "operation_id": "cfo_portal_get_ap_aging", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/ap-aging", "summary": "Get CFO AP aging", "deprecated": false }, { "slug": "cfo-portal-get-ar-aging", "operation_id": "cfo_portal_get_ar_aging", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/ar-aging", "summary": "Get CFO AR aging", "deprecated": false }, { "slug": "cfo-portal-ask", "operation_id": "cfo_portal_ask", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/ask", "summary": "Ask Regent a question from the CFO portal", "deprecated": false }, { "slug": "cfo-portal-get-benchmarks", "operation_id": "cfo_portal_get_benchmarks", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/benchmarks", "summary": "Get CFO benchmarks", "deprecated": false }, { "slug": "cfo-portal-get-board-deck", "operation_id": "cfo_portal_get_board_deck", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/board-deck", "summary": "Get CFO board deck summary", "deprecated": false }, { "slug": "cfo-portal-generate-board-memo", "operation_id": "cfo_portal_generate_board_memo", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/board-deck/memo", "summary": "Generate an AI board memo/report from CFO board-deck data", "deprecated": false }, { "slug": "cfo-portal-export-board-memo", "operation_id": "cfo_portal_export_board_memo", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/board-deck/memo/export", "summary": "Export AI board memo as PDF or HTML", "deprecated": false }, { "slug": "cfo-portal-download-board-deck-pdf", "operation_id": "cfo_portal_download_board_deck_pdf", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/board-deck/pdf", "summary": "Download board deck summary as PDF", "deprecated": false }, { "slug": "cfo-portal-list-buckets", "operation_id": "cfo_portal_list_buckets", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/buckets", "summary": "List all managerial buckets (default + custom)", "deprecated": false }, { "slug": "cfo-portal-create-bucket", "operation_id": "cfo_portal_create_bucket", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/buckets", "summary": "Create a custom managerial bucket", "deprecated": false }, { "slug": "cfo-portal-delete-bucket", "operation_id": "cfo_portal_delete_bucket", "method": "DELETE", "path": "/api/v1/businesses/{business_id}/cfo-portal/buckets/{bucket_key}", "summary": "Delete or disable a managerial bucket", "deprecated": false }, { "slug": "cfo-portal-update-bucket", "operation_id": "cfo_portal_update_bucket", "method": "PUT", "path": "/api/v1/businesses/{business_id}/cfo-portal/buckets/{bucket_key}", "summary": "Update a managerial bucket", "deprecated": false }, { "slug": "cfo-portal-get-budget-vs-actual", "operation_id": "cfo_portal_get_budget_vs_actual", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/budget-vs-actual", "summary": "Get CFO budget vs actual", "deprecated": false }, { "slug": "cfo-portal-get-cash-forecast", "operation_id": "cfo_portal_get_cash_forecast", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast", "summary": "Get CFO 13-week cash forecast", "deprecated": false }, { "slug": "cfo-portal-evaluate-demand-plan", "operation_id": "cfo_portal_evaluate_demand_plan", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/demand-plan", "summary": "Evaluate a what-if cash forecast scenario", "deprecated": false }, { "slug": "cfo-portal-list-one-time-items", "operation_id": "cfo_portal_list_one_time_items", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/one-time-items", "summary": "List one-time payment items applied to the cash forecast", "deprecated": false }, { "slug": "cfo-portal-create-one-time-item", "operation_id": "cfo_portal_create_one_time_item", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/one-time-items", "summary": "Create a one-time payment item", "deprecated": false }, { "slug": "cfo-portal-delete-one-time-item", "operation_id": "cfo_portal_delete_one_time_item", "method": "DELETE", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/one-time-items/{item_id}", "summary": "Delete a one-time payment item", "deprecated": false }, { "slug": "cfo-portal-update-one-time-item", "operation_id": "cfo_portal_update_one_time_item", "method": "PATCH", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/one-time-items/{item_id}", "summary": "Update a one-time payment item", "deprecated": false }, { "slug": "cfo-portal-clear-overrides", "operation_id": "cfo_portal_clear_overrides", "method": "DELETE", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/overrides", "summary": "Clear all cash forecast overrides in a scope", "deprecated": false }, { "slug": "cfo-portal-list-overrides", "operation_id": "cfo_portal_list_overrides", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/overrides", "summary": "List cell-level overrides for the cash forecast", "deprecated": false }, { "slug": "cfo-portal-upsert-overrides", "operation_id": "cfo_portal_upsert_overrides", "method": "PUT", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/overrides", "summary": "Replace all cash forecast overrides in a scope", "deprecated": false }, { "slug": "cfo-portal-delete-override", "operation_id": "cfo_portal_delete_override", "method": "DELETE", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/overrides/{override_id}", "summary": "Delete a single cash forecast override row", "deprecated": false }, { "slug": "cfo-portal-update-cash-forecast-settings", "operation_id": "cfo_portal_update_cash_forecast_settings", "method": "PUT", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/settings", "summary": "Update Cash Forecast configuration", "deprecated": false }, { "slug": "cash-forecast-list-ledger-timing", "operation_id": "cash_forecast_list_ledger_timing", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/timing", "summary": "List fixed-cost timing rows (lag and pay days per ledger)", "deprecated": false }, { "slug": "cash-forecast-upsert-ledger-timing", "operation_id": "cash_forecast_upsert_ledger_timing", "method": "PUT", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/timing", "summary": "Set fixed-cost timing rows (lag and pay days per ledger)", "deprecated": false }, { "slug": "cfo-portal-list-versions", "operation_id": "cfo_portal_list_versions", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions", "summary": "List saved cash forecast versions", "deprecated": false }, { "slug": "cfo-portal-create-version", "operation_id": "cfo_portal_create_version", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions", "summary": "Save the current cash forecast configuration as a named version", "deprecated": false }, { "slug": "cfo-portal-delete-version", "operation_id": "cfo_portal_delete_version", "method": "DELETE", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions/{version_id}", "summary": "Delete a saved cash forecast version", "deprecated": false }, { "slug": "cfo-portal-get-version", "operation_id": "cfo_portal_get_version", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions/{version_id}", "summary": "Get a saved cash forecast version", "deprecated": false }, { "slug": "cfo-portal-update-version", "operation_id": "cfo_portal_update_version", "method": "PATCH", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions/{version_id}", "summary": "Rename or describe a saved version", "deprecated": false }, { "slug": "cfo-portal-apply-version", "operation_id": "cfo_portal_apply_version", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/cash-forecast/versions/{version_id}/apply", "summary": "Re-apply a saved version's config to the live forecast", "deprecated": false }, { "slug": "cfo-portal-get-configuration", "operation_id": "cfo_portal_get_configuration", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/configuration", "summary": "Get CFO configuration", "deprecated": false }, { "slug": "cfo-portal-get-debt-schedule", "operation_id": "cfo_portal_get_debt_schedule", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule", "summary": "Get CFO debt schedule", "deprecated": false }, { "slug": "cfo-portal-approve-debt-contract", "operation_id": "cfo_portal_approve_debt_contract", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/approve-contract", "summary": "Approve parsed debt contract and create debt instrument", "deprecated": false }, { "slug": "cfo-portal-delete-debt-covenant", "operation_id": "cfo_portal_delete_debt_covenant", "method": "DELETE", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/covenants/{covenant_id}", "summary": "Delete a debt covenant", "deprecated": false }, { "slug": "cfo-portal-delete-debt-instrument", "operation_id": "cfo_portal_delete_debt_instrument", "method": "DELETE", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}", "summary": "Soft-delete a debt instrument", "deprecated": false }, { "slug": "cfo-portal-update-debt-instrument", "operation_id": "cfo_portal_update_debt_instrument", "method": "PATCH", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}", "summary": "Update a debt instrument", "deprecated": false }, { "slug": "cfo-portal-list-debt-covenants", "operation_id": "cfo_portal_list_debt_covenants", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/covenants", "summary": "List covenants for a debt instrument", "deprecated": false }, { "slug": "cfo-portal-create-debt-covenant", "operation_id": "cfo_portal_create_debt_covenant", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/covenants", "summary": "Add a covenant to a debt instrument", "deprecated": false }, { "slug": "cfo-portal-get-debt-schedule-table", "operation_id": "cfo_portal_get_debt_schedule_table", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/payment-schedule", "summary": "Get a loan's customizable paydown table", "deprecated": false }, { "slug": "cfo-portal-generate-debt-schedule", "operation_id": "cfo_portal_generate_debt_schedule", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/payment-schedule/generate", "summary": "Generate or rebuild a loan's paydown table", "deprecated": false }, { "slug": "cfo-portal-add-debt-schedule-row", "operation_id": "cfo_portal_add_debt_schedule_row", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/payment-schedule/rows", "summary": "Add a row to a loan's paydown table", "deprecated": false }, { "slug": "cfo-portal-record-debt-payment", "operation_id": "cfo_portal_record_debt_payment", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/instruments/{instrument_id}/payments", "summary": "Record a payment against a debt instrument", "deprecated": false }, { "slug": "cfo-portal-parse-debt-contract", "operation_id": "cfo_portal_parse_debt_contract", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/parse-contract", "summary": "Parse debt contract into a draft payment schedule", "deprecated": false }, { "slug": "cfo-portal-delete-debt-schedule-row", "operation_id": "cfo_portal_delete_debt_schedule_row", "method": "DELETE", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/payment-schedule/rows/{row_id}", "summary": "Delete a loan paydown-table row", "deprecated": false }, { "slug": "cfo-portal-update-debt-schedule-row", "operation_id": "cfo_portal_update_debt_schedule_row", "method": "PATCH", "path": "/api/v1/businesses/{business_id}/cfo-portal/debt-schedule/payment-schedule/rows/{row_id}", "summary": "Edit a loan paydown-table row", "deprecated": false }, { "slug": "cfo-portal-get-flux", "operation_id": "cfo_portal_get_flux", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/flux", "summary": "Get CFO flux analysis", "deprecated": false }, { "slug": "cfo-portal-get-landed-cogs", "operation_id": "cfo_portal_get_landed_cogs", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/landed-cogs", "summary": "Get CFO landed COGS", "deprecated": false }, { "slug": "cfo-portal-get-managerial-bs", "operation_id": "cfo_portal_get_managerial_bs", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/managerial-bs", "summary": "Get CFO managerial balance sheet", "deprecated": false }, { "slug": "cfo-portal-get-managerial-pl", "operation_id": "cfo_portal_get_managerial_pl", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/managerial-pl", "summary": "Get CFO managerial P&L", "deprecated": false }, { "slug": "cfo-portal-get-monthly-close", "operation_id": "cfo_portal_get_monthly_close", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/monthly-close", "summary": "Get CFO monthly close status", "deprecated": false }, { "slug": "cfo-portal-po-forecast-settings", "operation_id": "cfo_portal_po_forecast_settings", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/po-forecast-settings", "summary": "List open POs and which forecast column they flow through", "deprecated": false }, { "slug": "get-purchase-orders-handler", "operation_id": "get_purchase_orders_handler", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/purchase-orders", "summary": "Get CFO purchase order pipeline", "deprecated": false }, { "slug": "cfo-portal-get-recipe-book", "operation_id": "cfo_portal_get_recipe_book", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/recipe-book", "summary": "Get CFO recipe book", "deprecated": false }, { "slug": "cfo-portal-auto-assign-ledgers", "operation_id": "cfo_portal_auto_assign_ledgers", "method": "POST", "path": "/api/v1/businesses/{business_id}/cfo-portal/recipe-book/auto-assign", "summary": "AI auto-assign ledgers to managerial buckets", "deprecated": false }, { "slug": "cfo-portal-upsert-managerial-builders", "operation_id": "cfo_portal_upsert_managerial_builders", "method": "PUT", "path": "/api/v1/businesses/{business_id}/cfo-portal/recipe-book/managerial-builders", "summary": "Upsert managerial builder line account selections", "deprecated": false }, { "slug": "cfo-portal-upsert-managerial-mappings", "operation_id": "cfo_portal_upsert_managerial_mappings", "method": "PUT", "path": "/api/v1/businesses/{business_id}/cfo-portal/recipe-book/managerial-mappings", "summary": "Upsert managerial bucket assignments for GL accounts", "deprecated": false }, { "slug": "cfo-portal-get-reports-documents", "operation_id": "cfo_portal_get_reports_documents", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/reports-documents", "summary": "Get CFO reports and documents", "deprecated": false }, { "slug": "cfo-portal-get-shipping-analysis", "operation_id": "cfo_portal_get_shipping_analysis", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/shipping-analysis", "summary": "Get CFO shipping analysis", "deprecated": false }, { "slug": "cfo-portal-get-shopify", "operation_id": "cfo_portal_get_shopify", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/shopify", "summary": "Get CFO Shopify metrics", "deprecated": false }, { "slug": "cfo-portal-get-statements", "operation_id": "cfo_portal_get_statements", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/statements", "summary": "Get CFO statement bundle", "deprecated": false }, { "slug": "cfo-portal-get-summary", "operation_id": "cfo_portal_get_summary", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/summary", "summary": "Get CFO portal summary", "deprecated": false }, { "slug": "cfo-portal-get-unit-economics", "operation_id": "cfo_portal_get_unit_economics", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/unit-economics", "summary": "Get CFO unit economics", "deprecated": false }, { "slug": "cfo-portal-update-unit-economics-settings", "operation_id": "cfo_portal_update_unit_economics_settings", "method": "PUT", "path": "/api/v1/businesses/{business_id}/cfo-portal/unit-economics/settings", "summary": "Update Unit Economics configuration", "deprecated": false }, { "slug": "cfo-portal-get-valuation", "operation_id": "cfo_portal_get_valuation", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/valuation", "summary": "Get CFO valuation inputs", "deprecated": false }, { "slug": "cfo-portal-get-vendor-spend", "operation_id": "cfo_portal_get_vendor_spend", "method": "GET", "path": "/api/v1/businesses/{business_id}/cfo-portal/vendor-spend", "summary": "Get CFO vendor spend", "deprecated": false } ] }, { "name": "cfo-projection", "slug": "cfo-projection", "operations": [ { "slug": "get-actuals", "operation_id": "get_actuals", "method": "GET", "path": "/api/v1/cfo-projection/actuals", "summary": "Get trailing actuals", "deprecated": false }, { "slug": "list-scenarios", "operation_id": "list_scenarios", "method": "GET", "path": "/api/v1/cfo-projection/scenarios", "summary": "List scenarios", "deprecated": false }, { "slug": "create-scenario", "operation_id": "create_scenario", "method": "POST", "path": "/api/v1/cfo-projection/scenarios", "summary": "Create scenario", "deprecated": false }, { "slug": "get-active-scenario", "operation_id": "get_active_scenario", "method": "GET", "path": "/api/v1/cfo-projection/scenarios/active", "summary": "Get active scenario", "deprecated": false }, { "slug": "create-scenario-from-budget", "operation_id": "create_scenario_from_budget", "method": "POST", "path": "/api/v1/cfo-projection/scenarios/from-budget/{budget_id}", "summary": "Create scenario from budget", "deprecated": false }, { "slug": "delete-scenario", "operation_id": "delete_scenario", "method": "DELETE", "path": "/api/v1/cfo-projection/scenarios/{scenario_id}", "summary": "Delete scenario", "deprecated": false }, { "slug": "get-scenario", "operation_id": "get_scenario", "method": "GET", "path": "/api/v1/cfo-projection/scenarios/{scenario_id}", "summary": "Get scenario", "deprecated": false }, { "slug": "update-scenario", "operation_id": "update_scenario", "method": "PATCH", "path": "/api/v1/cfo-projection/scenarios/{scenario_id}", "summary": "Update scenario", "deprecated": false }, { "slug": "compute-projection", "operation_id": "compute_projection", "method": "GET", "path": "/api/v1/cfo-projection/scenarios/{scenario_id}/projection", "summary": "Compute projection", "deprecated": false }, { "slug": "suggest-tax-rate", "operation_id": "suggest_tax_rate", "method": "POST", "path": "/api/v1/cfo-projection/scenarios/{scenario_id}/suggest-tax-rate", "summary": "Suggest tax rates", "deprecated": false } ] }, { "name": "change-orders", "slug": "change-orders", "operations": [ { "slug": "list-change-orders", "operation_id": "list_change_orders", "method": "GET", "path": "/api/v1/change-orders", "summary": "List change orders", "deprecated": false }, { "slug": "create-change-order", "operation_id": "create_change_order", "method": "POST", "path": "/api/v1/change-orders", "summary": "Create change order", "deprecated": false }, { "slug": "delete-change-order", "operation_id": "delete_change_order", "method": "DELETE", "path": "/api/v1/change-orders/{change_order_id}", "summary": "Delete change order", "deprecated": false }, { "slug": "get-change-order", "operation_id": "get_change_order", "method": "GET", "path": "/api/v1/change-orders/{change_order_id}", "summary": "Get change order", "deprecated": false }, { "slug": "update-change-order", "operation_id": "update_change_order", "method": "PUT", "path": "/api/v1/change-orders/{change_order_id}", "summary": "Update change order", "deprecated": false }, { "slug": "countersign-change-order", "operation_id": "countersign_change_order", "method": "POST", "path": "/api/v1/change-orders/{change_order_id}/countersign", "summary": "Countersign change order", "deprecated": false }, { "slug": "revert-change-order-to-draft", "operation_id": "revert_change_order_to_draft", "method": "POST", "path": "/api/v1/change-orders/{change_order_id}/revert-to-draft", "summary": "Revert change order to draft", "deprecated": false }, { "slug": "send-change-order", "operation_id": "send_change_order", "method": "POST", "path": "/api/v1/change-orders/{change_order_id}/send", "summary": "Email change order to customer", "deprecated": false }, { "slug": "sign-change-order", "operation_id": "sign_change_order", "method": "POST", "path": "/api/v1/change-orders/{change_order_id}/sign", "summary": "Mark change order signed", "deprecated": false } ] }, { "name": "client-digest-preview", "slug": "client-digest-preview", "operations": [ { "slug": "preview-client-digest", "operation_id": "preview_client_digest", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/clients/{business_id}/digest-preview", "summary": "Preview a client's financial digest", "deprecated": false }, { "slug": "download-client-digest-pdf", "operation_id": "download_client_digest_pdf", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/clients/{business_id}/digest-preview/pdf", "summary": "Download a client's financial digest PDF", "deprecated": false } ] }, { "name": "client-messages", "slug": "client-messages", "operations": [ { "slug": "list-client-conversations", "operation_id": "list_client_conversations", "method": "GET", "path": "/api/v1/client-messages/conversations", "summary": "List client conversations", "deprecated": false }, { "slug": "create-conversation", "operation_id": "create_conversation", "method": "POST", "path": "/api/v1/client-messages/conversations", "summary": "Create a conversation", "deprecated": false }, { "slug": "get-client-conversation", "operation_id": "get_client_conversation", "method": "GET", "path": "/api/v1/client-messages/conversations/{conversation_id}", "summary": "Get conversation detail", "deprecated": false }, { "slug": "client-reply", "operation_id": "client_reply", "method": "POST", "path": "/api/v1/client-messages/conversations/{conversation_id}/messages", "summary": "Reply to a conversation (client)", "deprecated": false }, { "slug": "list-firm-conversations", "operation_id": "list_firm_conversations", "method": "GET", "path": "/api/v1/client-messages/firm/conversations", "summary": "List client conversations (firm)", "deprecated": false }, { "slug": "get-firm-conversation", "operation_id": "get_firm_conversation", "method": "GET", "path": "/api/v1/client-messages/firm/conversations/{conversation_id}", "summary": "Get conversation detail (firm)", "deprecated": false }, { "slug": "advisor-reply", "operation_id": "advisor_reply", "method": "POST", "path": "/api/v1/client-messages/firm/conversations/{conversation_id}/messages", "summary": "Reply to a conversation (advisor)", "deprecated": false }, { "slug": "update-status", "operation_id": "update_status", "method": "PUT", "path": "/api/v1/client-messages/firm/conversations/{conversation_id}/status", "summary": "Update conversation status", "deprecated": false }, { "slug": "firm-unread-count", "operation_id": "firm_unread_count", "method": "GET", "path": "/api/v1/client-messages/firm/unread-count", "summary": "Unread conversation count (firm)", "deprecated": false }, { "slug": "unread-count", "operation_id": "unread_count", "method": "GET", "path": "/api/v1/client-messages/unread-count", "summary": "Unread conversation count", "deprecated": false } ], "description": "Messaging between advisory firms and their clients.", "description_html": "Messaging between advisory firms and their clients.
\n" }, { "name": "close-verification", "slug": "close-verification", "operations": [ { "slug": "get-close-verification-report", "operation_id": "get_close_verification_report", "method": "GET", "path": "/api/v1/close/verification", "summary": "Close verification report", "deprecated": false }, { "slug": "apply-close-verification-counterparty-defaults", "operation_id": "apply_close_verification_counterparty_defaults", "method": "POST", "path": "/api/v1/close/verification/apply-counterparty-defaults", "summary": "Apply counterparty defaults to categorized transactions", "deprecated": false } ] }, { "name": "consolidated-reports", "slug": "consolidated-reports", "operations": [ { "slug": "get-consolidated-balance-sheet", "operation_id": "get_consolidated_balance_sheet", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/consolidated-reports/balance-sheet", "summary": "Get consolidated balance sheet", "deprecated": false }, { "slug": "get-consolidated-pnl", "operation_id": "get_consolidated_pnl", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/consolidated-reports/pnl", "summary": "Get consolidated P&L", "deprecated": false } ] }, { "name": "contractors", "slug": "contractors", "operations": [ { "slug": "list-contractors", "operation_id": "list_contractors", "method": "GET", "path": "/api/v1/contractors", "summary": "List contractors", "deprecated": false }, { "slug": "report-1099", "operation_id": "report_1099", "method": "GET", "path": "/api/v1/contractors/1099-report", "summary": "1099 year-end report", "deprecated": false }, { "slug": "update-contractor", "operation_id": "update_contractor", "method": "PUT", "path": "/api/v1/contractors/{vendor_id}", "summary": "Update contractor 1099 fields", "deprecated": false } ] }, { "name": "contracts", "slug": "contracts", "operations": [ { "slug": "list-contracts", "operation_id": "list_contracts", "method": "GET", "path": "/api/v1/contracts", "summary": "List contracts", "deprecated": false }, { "slug": "create-contract", "operation_id": "create_contract", "method": "POST", "path": "/api/v1/contracts", "summary": "Create a contract", "deprecated": false }, { "slug": "contract-cash-flow-forecast", "operation_id": "contract_cash_flow_forecast", "method": "GET", "path": "/api/v1/contracts/cash-flow-forecast", "summary": "Weekly cash-inflow forecast", "deprecated": false }, { "slug": "list-all-drawdowns", "operation_id": "list_all_drawdowns", "method": "GET", "path": "/api/v1/contracts/drawdowns", "summary": "List drawdowns (cross-contract queue)", "deprecated": false }, { "slug": "approve-drawdown", "operation_id": "approve_drawdown", "method": "POST", "path": "/api/v1/contracts/drawdowns/{drawdown_id}/approve", "summary": "Approve a drawdown (hours gate)", "deprecated": false }, { "slug": "return-drawdown", "operation_id": "return_drawdown", "method": "POST", "path": "/api/v1/contracts/drawdowns/{drawdown_id}/return", "summary": "Return a drawdown to the submitter", "deprecated": false }, { "slug": "ingest-hours-submission", "operation_id": "ingest_hours_submission", "method": "POST", "path": "/api/v1/contracts/inbound/hours", "summary": "Ingest an inbound hours submission (Slack/email reply)", "deprecated": false }, { "slug": "list-contract-invoices", "operation_id": "list_contract_invoices", "method": "GET", "path": "/api/v1/contracts/invoices", "summary": "Invoice review queue", "deprecated": false }, { "slug": "send-invoice-reminders-batch", "operation_id": "send_invoice_reminders_batch", "method": "POST", "path": "/api/v1/contracts/invoices/reminders", "summary": "Send payment reminders in bulk", "deprecated": false }, { "slug": "update-contract-invoice", "operation_id": "update_contract_invoice", "method": "PATCH", "path": "/api/v1/contracts/invoices/{invoice_id}", "summary": "Edit a draft contract invoice", "deprecated": false }, { "slug": "apply-contract-invoice-payment", "operation_id": "apply_contract_invoice_payment", "method": "POST", "path": "/api/v1/contracts/invoices/{invoice_id}/payments", "summary": "Apply a payment to a contract invoice", "deprecated": false }, { "slug": "send-invoice-reminder", "operation_id": "send_invoice_reminder", "method": "POST", "path": "/api/v1/contracts/invoices/{invoice_id}/reminder", "summary": "Send a payment reminder for a contract invoice", "deprecated": false }, { "slug": "send-contract-invoice", "operation_id": "send_contract_invoice", "method": "POST", "path": "/api/v1/contracts/invoices/{invoice_id}/send", "summary": "Approve & send a contract invoice (invoice gate)", "deprecated": false }, { "slug": "intake-order-pdf", "operation_id": "intake_order_pdf", "method": "POST", "path": "/api/v1/contracts/orders/intake-pdf", "summary": "Intake an order-form PDF into a draft order", "deprecated": false }, { "slug": "download-o2c-report", "operation_id": "download_o2c_report", "method": "GET", "path": "/api/v1/contracts/reports/{report_type}", "summary": "Download an Order-to-Cash report (CSV/XLSX)", "deprecated": false }, { "slug": "get-o2c-settings", "operation_id": "get_o2c_settings", "method": "GET", "path": "/api/v1/contracts/settings", "summary": "Get Order-to-Cash settings", "deprecated": false }, { "slug": "update-o2c-settings", "operation_id": "update_o2c_settings", "method": "PUT", "path": "/api/v1/contracts/settings", "summary": "Update Order-to-Cash settings", "deprecated": false }, { "slug": "contract-portfolio-summary", "operation_id": "contract_portfolio_summary", "method": "GET", "path": "/api/v1/contracts/summary", "summary": "Portfolio summary (dashboard KPIs)", "deprecated": false }, { "slug": "contract-value-by-type", "operation_id": "contract_value_by_type", "method": "GET", "path": "/api/v1/contracts/summary/by-type", "summary": "Contracted value grouped by billing rule", "deprecated": false }, { "slug": "delete-contract", "operation_id": "delete_contract", "method": "DELETE", "path": "/api/v1/contracts/{contract_id}", "summary": "Delete contract", "deprecated": false }, { "slug": "get-contract", "operation_id": "get_contract", "method": "GET", "path": "/api/v1/contracts/{contract_id}", "summary": "Get contract", "deprecated": false }, { "slug": "update-contract", "operation_id": "update_contract", "method": "PATCH", "path": "/api/v1/contracts/{contract_id}", "summary": "Edit contract", "deprecated": false }, { "slug": "get-contract-burndown", "operation_id": "get_contract_burndown", "method": "GET", "path": "/api/v1/contracts/{contract_id}/burndown", "summary": "Per-line hours burndown", "deprecated": false }, { "slug": "check-contract-completion", "operation_id": "check_contract_completion", "method": "POST", "path": "/api/v1/contracts/{contract_id}/check-completion", "summary": "Evaluate auto-completion", "deprecated": false }, { "slug": "issue-contract-credit-memo", "operation_id": "issue_contract_credit_memo", "method": "POST", "path": "/api/v1/contracts/{contract_id}/credit-memo", "summary": "Issue a contract-level credit memo", "deprecated": false }, { "slug": "draft-contract-invoices", "operation_id": "draft_contract_invoices", "method": "POST", "path": "/api/v1/contracts/{contract_id}/draft-invoices", "summary": "Auto-draft invoices (invoice gate)", "deprecated": false }, { "slug": "list-contract-drawdowns", "operation_id": "list_contract_drawdowns", "method": "GET", "path": "/api/v1/contracts/{contract_id}/drawdowns", "summary": "List a contract's drawdowns", "deprecated": false }, { "slug": "record-drawdown", "operation_id": "record_drawdown", "method": "POST", "path": "/api/v1/contracts/{contract_id}/drawdowns", "summary": "Record a drawdown (hours consumed)", "deprecated": false }, { "slug": "generate-period-invoices", "operation_id": "generate_period_invoices", "method": "POST", "path": "/api/v1/contracts/{contract_id}/generate-period-invoices", "summary": "Draft the next period's invoices", "deprecated": false }, { "slug": "update-contract-hours", "operation_id": "update_contract_hours", "method": "PATCH", "path": "/api/v1/contracts/{contract_id}/hours", "summary": "Set the contract's total purchased hours", "deprecated": false }, { "slug": "draft-manual-contract-invoice", "operation_id": "draft_manual_contract_invoice", "method": "POST", "path": "/api/v1/contracts/{contract_id}/invoices", "summary": "Manually draft an additional invoice", "deprecated": false }, { "slug": "pause-contract", "operation_id": "pause_contract", "method": "POST", "path": "/api/v1/contracts/{contract_id}/pause", "summary": "Pause contract", "deprecated": false }, { "slug": "reorder-from-contract", "operation_id": "reorder_from_contract", "method": "POST", "path": "/api/v1/contracts/{contract_id}/reorder", "summary": "Reorder from a contract (follow-on block)", "deprecated": false }, { "slug": "resume-contract", "operation_id": "resume_contract", "method": "POST", "path": "/api/v1/contracts/{contract_id}/resume", "summary": "Resume contract", "deprecated": false }, { "slug": "suggested-contract-invoices", "operation_id": "suggested_contract_invoices", "method": "GET", "path": "/api/v1/contracts/{contract_id}/suggested-invoices", "summary": "Suggested invoices to link", "deprecated": false } ] }, { "name": "counterparty-aliases", "slug": "counterparty-aliases", "operations": [ { "slug": "list-counterparty-aliases", "operation_id": "list_counterparty_aliases", "method": "GET", "path": "/api/v1/counterparty-aliases", "summary": "List counterparty aliases", "deprecated": false }, { "slug": "delete-counterparty-alias", "operation_id": "delete_counterparty_alias", "method": "DELETE", "path": "/api/v1/counterparty-aliases/{alias_id}", "summary": "Delete a counterparty alias", "deprecated": false }, { "slug": "update-counterparty-alias", "operation_id": "update_counterparty_alias", "method": "PATCH", "path": "/api/v1/counterparty-aliases/{alias_id}", "summary": "Update a counterparty alias", "deprecated": false } ] }, { "name": "counterparty-defaults", "slug": "counterparty-defaults", "operations": [ { "slug": "list-counterparty-defaults", "operation_id": "list_counterparty_defaults", "method": "GET", "path": "/api/v1/counterparty-defaults", "summary": "List counterparty defaults", "deprecated": false }, { "slug": "create-counterparty-default", "operation_id": "create_counterparty_default", "method": "POST", "path": "/api/v1/counterparty-defaults", "summary": "Create a counterparty default", "deprecated": false }, { "slug": "bulk-set-counterparty-defaults", "operation_id": "bulk_set_counterparty_defaults", "method": "POST", "path": "/api/v1/counterparty-defaults/bulk", "summary": "Set one default category on many counterparties", "deprecated": false }, { "slug": "get-counterparty-default-conflicts", "operation_id": "get_counterparty_default_conflicts", "method": "GET", "path": "/api/v1/counterparty-defaults/conflicts", "summary": "Pre-check conflicts for a counterparty default", "deprecated": false }, { "slug": "delete-counterparty-default", "operation_id": "delete_counterparty_default", "method": "DELETE", "path": "/api/v1/counterparty-defaults/{default_id}", "summary": "Delete a counterparty default", "deprecated": false }, { "slug": "update-counterparty-default", "operation_id": "update_counterparty_default", "method": "PATCH", "path": "/api/v1/counterparty-defaults/{default_id}", "summary": "Update a counterparty default", "deprecated": false } ] }, { "name": "counterparty-naming", "slug": "counterparty-naming", "operations": [ { "slug": "list-name-inconsistencies", "operation_id": "list_name_inconsistencies", "method": "GET", "path": "/api/v1/counterparty-naming/inconsistencies", "summary": "Find inconsistently named counterparties", "deprecated": false }, { "slug": "merge-counterparties", "operation_id": "merge_counterparties", "method": "POST", "path": "/api/v1/counterparty-naming/merge", "summary": "Merge counterparty groups into one name", "deprecated": false }, { "slug": "list-counterparty-names", "operation_id": "list_counterparty_names", "method": "GET", "path": "/api/v1/counterparty-naming/names", "summary": "List this business's counterparty names", "deprecated": false }, { "slug": "preview-payee-lines", "operation_id": "preview_payee_lines", "method": "GET", "path": "/api/v1/counterparty-naming/payee-lines", "summary": "Preview giving processor lines back to their payees", "deprecated": false }, { "slug": "apply-payee-lines", "operation_id": "apply_payee_lines", "method": "POST", "path": "/api/v1/counterparty-naming/payee-lines/apply", "summary": "Give processor lines back to their payees", "deprecated": false }, { "slug": "counterparty-rename-impact", "operation_id": "counterparty_rename_impact", "method": "GET", "path": "/api/v1/counterparty-naming/rename-impact", "summary": "Preview what a remembered rename would also relabel (deprecated)", "deprecated": true }, { "slug": "counterparty-rename-impact-post", "operation_id": "counterparty_rename_impact_post", "method": "POST", "path": "/api/v1/counterparty-naming/rename-impact", "summary": "Preview what a remembered rename would also relabel", "deprecated": false }, { "slug": "reset-counterparty", "operation_id": "reset_counterparty", "method": "POST", "path": "/api/v1/counterparty-naming/reset", "summary": "Reset a counterparty group to its detected names", "deprecated": false }, { "slug": "list-naming-rules", "operation_id": "list_naming_rules", "method": "GET", "path": "/api/v1/counterparty-naming/rules", "summary": "List counterparty naming rules", "deprecated": false }, { "slug": "create-naming-rule", "operation_id": "create_naming_rule", "method": "POST", "path": "/api/v1/counterparty-naming/rules", "summary": "Create a counterparty naming rule", "deprecated": false }, { "slug": "preview-naming-rule", "operation_id": "preview_naming_rule", "method": "POST", "path": "/api/v1/counterparty-naming/rules/preview", "summary": "Preview which existing transactions a rule would match", "deprecated": false }, { "slug": "delete-naming-rule", "operation_id": "delete_naming_rule", "method": "DELETE", "path": "/api/v1/counterparty-naming/rules/{rule_id}", "summary": "Delete a counterparty naming rule", "deprecated": false }, { "slug": "update-naming-rule", "operation_id": "update_naming_rule", "method": "PATCH", "path": "/api/v1/counterparty-naming/rules/{rule_id}", "summary": "Update a counterparty naming rule", "deprecated": false }, { "slug": "apply-naming-rule", "operation_id": "apply_naming_rule", "method": "POST", "path": "/api/v1/counterparty-naming/rules/{rule_id}/apply", "summary": "Apply a naming rule to existing transactions", "deprecated": false } ] }, { "name": "credit", "slug": "credit", "operations": [ { "slug": "run-accruals", "operation_id": "run_accruals", "method": "POST", "path": "/api/v1/credit/accruals/run", "summary": "Run the daily accrual processor", "deprecated": false }, { "slug": "credit-list-adverse-actions", "operation_id": "credit_list_adverse_actions", "method": "GET", "path": "/api/v1/credit/adverse-actions", "summary": "List adverse actions", "deprecated": false }, { "slug": "credit-get-adverse-action-pdf", "operation_id": "credit_get_adverse_action_pdf", "method": "GET", "path": "/api/v1/credit/adverse-actions/{adverse_action_id}.pdf", "summary": "Download an adverse-action notice", "deprecated": false }, { "slug": "credit-send-adverse-action", "operation_id": "credit_send_adverse_action", "method": "POST", "path": "/api/v1/credit/adverse-actions/{adverse_action_id}/send", "summary": "Send an adverse-action notice", "deprecated": false }, { "slug": "credit-waive-adverse-action", "operation_id": "credit_waive_adverse_action", "method": "POST", "path": "/api/v1/credit/adverse-actions/{adverse_action_id}/waive", "summary": "Waive an adverse-action notice", "deprecated": false }, { "slug": "credit-billing-lapse-risk", "operation_id": "credit_billing_lapse_risk", "method": "GET", "path": "/api/v1/credit/billing-lapse-risk", "summary": "Will this business's API access lapse?", "deprecated": false }, { "slug": "ingest-card-settlements", "operation_id": "ingest_card_settlements", "method": "POST", "path": "/api/v1/credit/card-settlements", "summary": "Ingest cleared card settlements", "deprecated": false }, { "slug": "issue-card", "operation_id": "issue_card", "method": "POST", "path": "/api/v1/credit/cards", "summary": "Issue a card against a credit line", "deprecated": false }, { "slug": "reconcile-settlements", "operation_id": "reconcile_settlements", "method": "POST", "path": "/api/v1/credit/cards/reconcile-settlements", "summary": "Reconcile issuer transactions against settlements", "deprecated": false }, { "slug": "register-card", "operation_id": "register_card", "method": "POST", "path": "/api/v1/credit/cards/register", "summary": "Register a partner-provisioned card", "deprecated": false }, { "slug": "sync-cards", "operation_id": "sync_cards", "method": "POST", "path": "/api/v1/credit/cards/sync", "summary": "Reconcile cards against the issuer", "deprecated": false }, { "slug": "terminate-card", "operation_id": "terminate_card", "method": "DELETE", "path": "/api/v1/credit/cards/{card_id}", "summary": "Terminate a card", "deprecated": false }, { "slug": "get-card-embed-token", "operation_id": "get_card_embed_token", "method": "POST", "path": "/api/v1/credit/cards/{card_id}/embed-token", "summary": "Mint a token to display card credentials", "deprecated": false }, { "slug": "update-card-limits", "operation_id": "update_card_limits", "method": "PATCH", "path": "/api/v1/credit/cards/{card_id}/limits", "summary": "Update card spend controls", "deprecated": false }, { "slug": "unsuspend-card", "operation_id": "unsuspend_card", "method": "DELETE", "path": "/api/v1/credit/cards/{card_id}/suspension", "summary": "Lift a card suspension", "deprecated": false }, { "slug": "suspend-card", "operation_id": "suspend_card", "method": "POST", "path": "/api/v1/credit/cards/{card_id}/suspension", "summary": "Suspend a card", "deprecated": false }, { "slug": "credit-list-held-increases", "operation_id": "credit_list_held_increases", "method": "GET", "path": "/api/v1/credit/compliance/held-increases", "summary": "List held limit increases", "deprecated": false }, { "slug": "credit-list-jurisdiction-gaps", "operation_id": "credit_list_jurisdiction_gaps", "method": "GET", "path": "/api/v1/credit/compliance/jurisdiction-gaps", "summary": "Lines missing the merchant's jurisdiction", "deprecated": false }, { "slug": "credit-list-compliance-templates", "operation_id": "credit_list_compliance_templates", "method": "GET", "path": "/api/v1/credit/compliance/templates", "summary": "List compliance templates", "deprecated": false }, { "slug": "credit-approve-compliance-template", "operation_id": "credit_approve_compliance_template", "method": "POST", "path": "/api/v1/credit/compliance/templates/{template_id}/approve", "summary": "Approve a compliance template", "deprecated": false }, { "slug": "credit-preview-compliance-template", "operation_id": "credit_preview_compliance_template", "method": "GET", "path": "/api/v1/credit/compliance/templates/{template_id}/preview", "summary": "Preview a compliance template", "deprecated": false }, { "slug": "credit-retire-compliance-template", "operation_id": "credit_retire_compliance_template", "method": "POST", "path": "/api/v1/credit/compliance/templates/{template_id}/retire", "summary": "Retire a compliance template", "deprecated": false }, { "slug": "assess-late-cycles", "operation_id": "assess_late_cycles", "method": "POST", "path": "/api/v1/credit/cycles/assess-late", "summary": "Late sweep", "deprecated": false }, { "slug": "close-cycles", "operation_id": "close_cycles", "method": "POST", "path": "/api/v1/credit/cycles/close", "summary": "Month-end close", "deprecated": false }, { "slug": "credit-get-disclosure-pdf", "operation_id": "credit_get_disclosure_pdf", "method": "GET", "path": "/api/v1/credit/disclosures/{disclosure_id}.pdf", "summary": "Download a disclosure", "deprecated": false }, { "slug": "credit-withdraw-held-increase", "operation_id": "credit_withdraw_held_increase", "method": "POST", "path": "/api/v1/credit/disclosures/{disclosure_id}/withdraw", "summary": "Withdraw a held limit increase", "deprecated": false }, { "slug": "resolve-credit-dispute", "operation_id": "resolve_credit_dispute", "method": "POST", "path": "/api/v1/credit/disputes/{dispute_id}/resolution", "summary": "Resolve a dispute", "deprecated": false }, { "slug": "get-environment", "operation_id": "get_environment", "method": "GET", "path": "/api/v1/credit/environment", "summary": "Which book am I on?", "deprecated": false }, { "slug": "list-credit-event-deliveries", "operation_id": "list_credit_event_deliveries", "method": "GET", "path": "/api/v1/credit/event-deliveries", "summary": "Webhook delivery status for a page of credit events", "deprecated": false }, { "slug": "list-credit-events", "operation_id": "list_credit_events", "method": "GET", "path": "/api/v1/credit/events", "summary": "Poll the credit event feed", "deprecated": false }, { "slug": "get-credit-event-deliveries", "operation_id": "get_credit_event_deliveries", "method": "GET", "path": "/api/v1/credit/events/{event_id}/deliveries", "summary": "Webhook deliveries of one credit event", "deprecated": false }, { "slug": "get-borrowing-base", "operation_id": "get_borrowing_base", "method": "GET", "path": "/api/v1/credit/finance/borrowing-base", "summary": "Borrowing base", "deprecated": false }, { "slug": "get-journal", "operation_id": "get_journal", "method": "GET", "path": "/api/v1/credit/finance/journal", "summary": "Credit journal for a month", "deprecated": false }, { "slug": "push-journal", "operation_id": "push_journal", "method": "POST", "path": "/api/v1/credit/finance/journal/push", "summary": "Push the credit journal to QuickBooks", "deprecated": false }, { "slug": "get-ledger-proof", "operation_id": "get_ledger_proof", "method": "GET", "path": "/api/v1/credit/finance/ledger-proof", "summary": "Ledger integrity proof", "deprecated": false }, { "slug": "get-tie-out", "operation_id": "get_tie_out", "method": "GET", "path": "/api/v1/credit/finance/tie-out", "summary": "Tie out outstanding three ways", "deprecated": false }, { "slug": "credit-import-get-batch", "operation_id": "credit_import_get_batch", "method": "GET", "path": "/api/v1/credit/import-batches/{staging_id}", "summary": "A staged loan file's status, totals and run", "deprecated": false }, { "slug": "credit-import-update-mapping", "operation_id": "credit_import_update_mapping", "method": "PUT", "path": "/api/v1/credit/import-batches/{staging_id}/mapping", "summary": "Correct a staged loan file's mapping", "deprecated": false }, { "slug": "credit-import-get-report", "operation_id": "credit_import_get_report", "method": "GET", "path": "/api/v1/credit/import-batches/{staging_id}/report", "summary": "The import report of a loan file's last run", "deprecated": false }, { "slug": "get-interchange-summary", "operation_id": "get_interchange_summary", "method": "GET", "path": "/api/v1/credit/interchange", "summary": "Interchange recognised", "deprecated": false }, { "slug": "ingest-interchange-report", "operation_id": "ingest_interchange_report", "method": "POST", "path": "/api/v1/credit/interchange/report", "summary": "Ingest the issuer's interchange report", "deprecated": false }, { "slug": "list-issuer-card-transactions", "operation_id": "list_issuer_card_transactions", "method": "GET", "path": "/api/v1/credit/issuer/card-transactions", "summary": "List the issuer's card transactions", "deprecated": false }, { "slug": "list-issuer-cardholders", "operation_id": "list_issuer_cardholders", "method": "GET", "path": "/api/v1/credit/issuer/cardholders", "summary": "List spend by cardholder", "deprecated": false }, { "slug": "list-issuer-cards", "operation_id": "list_issuer_cards", "method": "GET", "path": "/api/v1/credit/issuer/cards", "summary": "List the issuer's cards", "deprecated": false }, { "slug": "cancel-limit-change-request", "operation_id": "cancel_limit_change_request", "method": "DELETE", "path": "/api/v1/credit/limit-change-requests/{request_id}", "summary": "Cancel a limit-change request", "deprecated": false }, { "slug": "get-limit-change-request", "operation_id": "get_limit_change_request", "method": "GET", "path": "/api/v1/credit/limit-change-requests/{request_id}", "summary": "Get a limit-change request", "deprecated": false }, { "slug": "decide-limit-change-request", "operation_id": "decide_limit_change_request", "method": "POST", "path": "/api/v1/credit/limit-change-requests/{request_id}/decision", "summary": "Approve or reject a limit-change request", "deprecated": false }, { "slug": "decide-limit-review", "operation_id": "decide_limit_review", "method": "POST", "path": "/api/v1/credit/limit-reviews/{review_id}/decision", "summary": "Apply or dismiss a proposed limit review", "deprecated": false }, { "slug": "list-credit-lines", "operation_id": "list_credit_lines", "method": "GET", "path": "/api/v1/credit/lines", "summary": "List credit lines", "deprecated": false }, { "slug": "create-credit-line", "operation_id": "create_credit_line", "method": "POST", "path": "/api/v1/credit/lines", "summary": "Open a credit line", "deprecated": false }, { "slug": "get-credit-line", "operation_id": "get_credit_line", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}", "summary": "Credit line dashboard", "deprecated": false }, { "slug": "update-credit-line", "operation_id": "update_credit_line", "method": "PATCH", "path": "/api/v1/credit/lines/{credit_line_id}", "summary": "Update a credit line", "deprecated": false }, { "slug": "list-cards", "operation_id": "list_cards", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/cards", "summary": "List cards on a credit line", "deprecated": false }, { "slug": "monitor-cards", "operation_id": "monitor_cards", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/cards/monitor", "summary": "Monitor card spend and controls", "deprecated": false }, { "slug": "push-spend-limits", "operation_id": "push_spend_limits", "method": "POST", "path": "/api/v1/credit/lines/{credit_line_id}/cards/spend-limit-sync", "summary": "Push available credit to the issuer as the card limit", "deprecated": false }, { "slug": "get-credit-line-credit-balance", "operation_id": "get_credit_line_credit_balance", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/credit-balance", "summary": "Where a line's credit balance came from", "deprecated": false }, { "slug": "get-line-disclosure", "operation_id": "get_line_disclosure", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/disclosure", "summary": "Disclosure figures for a loan", "deprecated": false }, { "slug": "credit-list-line-disclosures", "operation_id": "credit_list_line_disclosures", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/disclosures", "summary": "List a line's disclosures", "deprecated": false }, { "slug": "credit-create-line-disclosure", "operation_id": "credit_create_line_disclosure", "method": "POST", "path": "/api/v1/credit/lines/{credit_line_id}/disclosures", "summary": "Generate a disclosure now", "deprecated": false }, { "slug": "list-credit-disputes", "operation_id": "list_credit_disputes", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/disputes", "summary": "List a line's disputes", "deprecated": false }, { "slug": "get-ledger", "operation_id": "get_ledger_credit", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/ledger", "summary": "Credit line ledger register", "deprecated": false }, { "slug": "verify-ledger", "operation_id": "verify_ledger", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/ledger/verify", "summary": "Verify ledger integrity", "deprecated": false }, { "slug": "list-limit-change-requests", "operation_id": "list_limit_change_requests", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/limit-change-requests", "summary": "List a line's limit-change requests", "deprecated": false }, { "slug": "create-limit-change-request", "operation_id": "create_limit_change_request", "method": "POST", "path": "/api/v1/credit/lines/{credit_line_id}/limit-change-requests", "summary": "Request a credit-limit change", "deprecated": false }, { "slug": "list-limit-reviews", "operation_id": "list_limit_reviews", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/limit-reviews", "summary": "List a line's limit reviews", "deprecated": false }, { "slug": "run-limit-review", "operation_id": "run_limit_review", "method": "POST", "path": "/api/v1/credit/lines/{credit_line_id}/limit-reviews/run", "summary": "Review a line's limit now", "deprecated": false }, { "slug": "list-loans", "operation_id": "list_loans", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/loans", "summary": "List loans on a line", "deprecated": false }, { "slug": "import-loans", "operation_id": "import_loans", "method": "POST", "path": "/api/v1/credit/lines/{credit_line_id}/loans/import", "summary": "Import existing loans onto a line", "deprecated": false }, { "slug": "list-line-notices", "operation_id": "list_line_notices", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/notices", "summary": "List notices sent on a line", "deprecated": false }, { "slug": "list-payment-aliases", "operation_id": "list_payment_aliases", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/payment-aliases", "summary": "List a line's payment aliases", "deprecated": false }, { "slug": "create-payment-alias", "operation_id": "create_payment_alias", "method": "POST", "path": "/api/v1/credit/lines/{credit_line_id}/payment-aliases", "summary": "Record a payment alias", "deprecated": false }, { "slug": "list-payment-matches", "operation_id": "list_payment_matches", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/payment-matches", "summary": "List the bank-settlement decisions on a line", "deprecated": false }, { "slug": "list-payments", "operation_id": "list_payments", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/payments", "summary": "List payments on a line", "deprecated": false }, { "slug": "get-payoff-quote", "operation_id": "get_payoff_quote", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/payoff-quote", "summary": "Quote the payoff amount", "deprecated": false }, { "slug": "list-borrower-portal-sessions", "operation_id": "list_borrower_portal_sessions", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/portal-sessions", "summary": "List borrower-portal links", "deprecated": false }, { "slug": "create-borrower-portal-session", "operation_id": "create_borrower_portal_session", "method": "POST", "path": "/api/v1/credit/lines/{credit_line_id}/portal-sessions", "summary": "Mint a borrower-portal link", "deprecated": false }, { "slug": "get-line-schedule", "operation_id": "get_line_schedule", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/schedule", "summary": "Repayment schedule", "deprecated": false }, { "slug": "list-statements", "operation_id": "list_statements", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/statements", "summary": "List statements", "deprecated": false }, { "slug": "get-statement", "operation_id": "get_statement", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/statements/{cycle_id}", "summary": "Get a rendered statement", "deprecated": false }, { "slug": "get-subledger", "operation_id": "get_subledger", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/subledger", "summary": "Transactions tab: summary band, loan rows, period history", "deprecated": false }, { "slug": "export-subledger", "operation_id": "export_subledger", "method": "GET", "path": "/api/v1/credit/lines/{credit_line_id}/subledger/export", "summary": "Export the Transactions tab as CSV", "deprecated": false }, { "slug": "get-loan", "operation_id": "get_loan", "method": "GET", "path": "/api/v1/credit/loans/{loan_id}", "summary": "Get one loan", "deprecated": false }, { "slug": "list-loan-adjustments", "operation_id": "list_loan_adjustments", "method": "GET", "path": "/api/v1/credit/loans/{loan_id}/adjustments", "summary": "List a loan's adjustments", "deprecated": false }, { "slug": "create-loan-adjustment", "operation_id": "create_loan_adjustment", "method": "POST", "path": "/api/v1/credit/loans/{loan_id}/adjustments", "summary": "Adjust a loan", "deprecated": false }, { "slug": "open-credit-dispute", "operation_id": "open_credit_dispute", "method": "POST", "path": "/api/v1/credit/loans/{loan_id}/dispute", "summary": "Open a dispute on a loan", "deprecated": false }, { "slug": "write-off-credit-loan", "operation_id": "write_off_credit_loan", "method": "POST", "path": "/api/v1/credit/loans/{loan_id}/write-off", "summary": "Write off a loan", "deprecated": false }, { "slug": "delete-payment-alias", "operation_id": "delete_payment_alias", "method": "DELETE", "path": "/api/v1/credit/payment-aliases/{alias_id}", "summary": "Delete a payment alias", "deprecated": false }, { "slug": "override-payment-match", "operation_id": "override_payment_match", "method": "POST", "path": "/api/v1/credit/payment-matches/{match_id}/override", "summary": "Confirm or reject a bank-settlement match", "deprecated": false }, { "slug": "record-payment", "operation_id": "record_payment", "method": "POST", "path": "/api/v1/credit/payments", "summary": "Record a payment", "deprecated": false }, { "slug": "preview-payment", "operation_id": "preview_payment", "method": "POST", "path": "/api/v1/credit/payments/preview", "summary": "Preview a payment", "deprecated": false }, { "slug": "resolve-payment", "operation_id": "resolve_payment", "method": "GET", "path": "/api/v1/credit/payments/resolve", "summary": "Resolve an inbound payment to a credit line", "deprecated": false }, { "slug": "reverse-payment", "operation_id": "reverse_payment", "method": "POST", "path": "/api/v1/credit/payments/{payment_id}/reversal", "summary": "Reverse a failed payment", "deprecated": false }, { "slug": "settle-payment", "operation_id": "settle_payment", "method": "POST", "path": "/api/v1/credit/payments/{payment_id}/settlement", "summary": "Confirm a pending payment settled", "deprecated": false }, { "slug": "revoke-borrower-portal-session", "operation_id": "revoke_borrower_portal_session", "method": "DELETE", "path": "/api/v1/credit/portal-sessions/{session_id}", "summary": "Revoke a borrower-portal link", "deprecated": false }, { "slug": "get-portfolio", "operation_id": "get_portfolio", "method": "GET", "path": "/api/v1/credit/portfolio", "summary": "Portfolio, aging, and allowance", "deprecated": false }, { "slug": "get-loan-tape", "operation_id": "get_loan_tape", "method": "GET", "path": "/api/v1/credit/portfolio/loan-tape", "summary": "Loan tape (CSV)", "deprecated": false }, { "slug": "list-programs", "operation_id": "list_programs", "method": "GET", "path": "/api/v1/credit/programs", "summary": "List lending programs", "deprecated": false }, { "slug": "create-program", "operation_id": "create_program", "method": "POST", "path": "/api/v1/credit/programs", "summary": "Create a lending program", "deprecated": false }, { "slug": "get-program", "operation_id": "get_program", "method": "GET", "path": "/api/v1/credit/programs/{program_id}", "summary": "Get a lending program", "deprecated": false }, { "slug": "update-program", "operation_id": "update_program", "method": "PATCH", "path": "/api/v1/credit/programs/{program_id}", "summary": "Update a lending program", "deprecated": false }, { "slug": "credit-switch-card-management", "operation_id": "credit_switch_card_management", "method": "POST", "path": "/api/v1/credit/programs/{program_id}/card-management", "summary": "Switch who manages a program's cards", "deprecated": false }, { "slug": "credit-import-list-batches", "operation_id": "credit_import_list_batches", "method": "GET", "path": "/api/v1/credit/programs/{program_id}/import-batches", "summary": "A program's loan files, newest first", "deprecated": false }, { "slug": "credit-import-run-loans", "operation_id": "credit_import_run_loans", "method": "POST", "path": "/api/v1/credit/programs/{program_id}/loans/import", "summary": "Dry-run or apply a staged loan file across the program", "deprecated": false }, { "slug": "credit-import-parse-loans", "operation_id": "credit_import_parse_loans", "method": "POST", "path": "/api/v1/credit/programs/{program_id}/loans/import/parse", "summary": "Upload a loan file and infer its mapping", "deprecated": false }, { "slug": "credit-mcc-allowlist-apply", "operation_id": "credit_mcc_allowlist_apply", "method": "POST", "path": "/api/v1/credit/programs/{program_id}/mcc-allowlist/apply", "summary": "Apply an MCC allow list", "deprecated": false }, { "slug": "credit-mcc-allowlist-preview", "operation_id": "credit_mcc_allowlist_preview", "method": "POST", "path": "/api/v1/credit/programs/{program_id}/mcc-allowlist/preview", "summary": "Preview an MCC allow list", "deprecated": false }, { "slug": "credit-readiness-get", "operation_id": "credit_readiness_get", "method": "GET", "path": "/api/v1/credit/programs/{program_id}/readiness", "summary": "Launch readiness of a program", "deprecated": false }, { "slug": "credit-readiness-evaluate", "operation_id": "credit_readiness_evaluate", "method": "POST", "path": "/api/v1/credit/programs/{program_id}/readiness/evaluate", "summary": "Evaluate and store a program's launch readiness", "deprecated": false }, { "slug": "list-scorecards", "operation_id": "list_scorecards", "method": "GET", "path": "/api/v1/credit/programs/{program_id}/scorecards", "summary": "List a program's scorecards", "deprecated": false }, { "slug": "create-scorecard", "operation_id": "create_scorecard", "method": "POST", "path": "/api/v1/credit/programs/{program_id}/scorecards", "summary": "Create a scorecard", "deprecated": false }, { "slug": "credit-scorecard-from-seed", "operation_id": "credit_scorecard_from_seed", "method": "POST", "path": "/api/v1/credit/programs/{program_id}/scorecards/from-seed", "summary": "Start the scorecard from a seed", "deprecated": false }, { "slug": "credit-readiness-list", "operation_id": "credit_readiness_list", "method": "GET", "path": "/api/v1/credit/readiness", "summary": "Launch readiness of every program", "deprecated": false }, { "slug": "advance-sandbox", "operation_id": "advance_sandbox", "method": "POST", "path": "/api/v1/credit/sandbox/advance", "summary": "Move the sandbox clock", "deprecated": false }, { "slug": "record-sandbox-card-transaction", "operation_id": "record_sandbox_card_transaction", "method": "POST", "path": "/api/v1/credit/sandbox/card-transactions", "summary": "Clear, void or dispute a card transaction", "deprecated": false }, { "slug": "credit-get-sandbox-job", "operation_id": "credit_get_sandbox_job", "method": "GET", "path": "/api/v1/credit/sandbox/jobs/{job_id}", "summary": "A sandbox job", "deprecated": false }, { "slug": "credit-seed-partner-export", "operation_id": "credit_seed_partner_export", "method": "POST", "path": "/api/v1/credit/sandbox/partner-export", "summary": "Seed the sandbox from a partner export", "deprecated": false }, { "slug": "credit-list-partner-pulls", "operation_id": "credit_list_partner_pulls", "method": "GET", "path": "/api/v1/credit/sandbox/partner-pulls", "summary": "List registered pulls", "deprecated": false }, { "slug": "credit-register-partner-pull", "operation_id": "credit_register_partner_pull", "method": "POST", "path": "/api/v1/credit/sandbox/partner-pulls", "summary": "Register a pull of a partner's data", "deprecated": false }, { "slug": "credit-delete-partner-pull", "operation_id": "credit_delete_partner_pull", "method": "DELETE", "path": "/api/v1/credit/sandbox/partner-pulls/{pull_id}", "summary": "Delete a registered pull", "deprecated": false }, { "slug": "credit-provision-sandbox", "operation_id": "credit_provision_sandbox", "method": "POST", "path": "/api/v1/credit/sandbox/provision", "summary": "Create the paired sandbox", "deprecated": false }, { "slug": "reset-sandbox", "operation_id": "reset_sandbox", "method": "POST", "path": "/api/v1/credit/sandbox/reset", "summary": "Start the sandbox over", "deprecated": false }, { "slug": "seed-appendix-b", "operation_id": "seed_appendix_b", "method": "POST", "path": "/api/v1/credit/sandbox/scenarios/appendix-b", "summary": "Stage the Appendix B book", "deprecated": false }, { "slug": "credit-stage-portfolio-scenario", "operation_id": "credit_stage_portfolio_scenario", "method": "POST", "path": "/api/v1/credit/sandbox/scenarios/portfolio-50", "summary": "Generate a whole sandbox book from a seed", "deprecated": false }, { "slug": "credit-sync-sandbox-config", "operation_id": "credit_sync_sandbox_config", "method": "POST", "path": "/api/v1/credit/sandbox/sync-config", "summary": "Copy program configuration to the sandbox again", "deprecated": false }, { "slug": "record-sandbox-walk", "operation_id": "record_sandbox_walk", "method": "POST", "path": "/api/v1/credit/sandbox/walks", "summary": "Record a walk of Appendix B", "deprecated": false }, { "slug": "get-scorecard-backtest", "operation_id": "get_scorecard_backtest", "method": "GET", "path": "/api/v1/credit/scorecard-backtests/{backtest_id}", "summary": "Get a backtest", "deprecated": false }, { "slug": "export-scorecard-backtest", "operation_id": "export_scorecard_backtest", "method": "GET", "path": "/api/v1/credit/scorecard-backtests/{backtest_id}/export", "summary": "Download a backtest as CSV", "deprecated": false }, { "slug": "credit-list-scorecard-seeds", "operation_id": "credit_list_scorecard_seeds", "method": "GET", "path": "/api/v1/credit/scorecard-seeds", "summary": "The scorecard seeds DayZero ships", "deprecated": false }, { "slug": "diff-scorecard-versions", "operation_id": "diff_scorecard_versions", "method": "GET", "path": "/api/v1/credit/scorecard-versions/{from_version_id}/diff/{to_version_id}", "summary": "Compare two scorecard versions", "deprecated": false }, { "slug": "discard-scorecard-version", "operation_id": "discard_scorecard_version", "method": "DELETE", "path": "/api/v1/credit/scorecard-versions/{version_id}", "summary": "Discard a draft version", "deprecated": false }, { "slug": "get-scorecard-version", "operation_id": "get_scorecard_version", "method": "GET", "path": "/api/v1/credit/scorecard-versions/{version_id}", "summary": "Get a scorecard version", "deprecated": false }, { "slug": "update-scorecard-version", "operation_id": "update_scorecard_version", "method": "PATCH", "path": "/api/v1/credit/scorecard-versions/{version_id}", "summary": "Edit a draft version", "deprecated": false }, { "slug": "activate-scorecard-version", "operation_id": "activate_scorecard_version", "method": "POST", "path": "/api/v1/credit/scorecard-versions/{version_id}/activate", "summary": "Activate an approved version", "deprecated": false }, { "slug": "approve-scorecard-version", "operation_id": "approve_scorecard_version", "method": "POST", "path": "/api/v1/credit/scorecard-versions/{version_id}/approve", "summary": "Record approval of a validated version", "deprecated": false }, { "slug": "backtest-scorecard-version", "operation_id": "backtest_scorecard_version", "method": "POST", "path": "/api/v1/credit/scorecard-versions/{version_id}/backtest", "summary": "Backtest a version over a cohort", "deprecated": false }, { "slug": "list-scorecard-backtests", "operation_id": "list_scorecard_backtests", "method": "GET", "path": "/api/v1/credit/scorecard-versions/{version_id}/backtests", "summary": "List a version's backtests", "deprecated": false }, { "slug": "preview-scorecard-version", "operation_id": "preview_scorecard_version", "method": "POST", "path": "/api/v1/credit/scorecard-versions/{version_id}/preview", "summary": "Test a version against a business", "deprecated": false }, { "slug": "validate-scorecard-version", "operation_id": "validate_scorecard_version", "method": "POST", "path": "/api/v1/credit/scorecard-versions/{version_id}/validate", "summary": "Validate a scorecard version", "deprecated": false }, { "slug": "validate-scorecard", "operation_id": "validate_scorecard", "method": "POST", "path": "/api/v1/credit/scorecards/validate", "summary": "Validate a scorecard before putting it on a program", "deprecated": false }, { "slug": "get-scorecard", "operation_id": "get_scorecard", "method": "GET", "path": "/api/v1/credit/scorecards/{scorecard_id}", "summary": "Get a scorecard", "deprecated": false }, { "slug": "update-scorecard", "operation_id": "update_scorecard", "method": "PATCH", "path": "/api/v1/credit/scorecards/{scorecard_id}", "summary": "Update a scorecard's settings", "deprecated": false }, { "slug": "get-scorecard-audit", "operation_id": "get_scorecard_audit", "method": "GET", "path": "/api/v1/credit/scorecards/{scorecard_id}/audit", "summary": "A scorecard's audit trail", "deprecated": false }, { "slug": "list-scorecard-versions", "operation_id": "list_scorecard_versions", "method": "GET", "path": "/api/v1/credit/scorecards/{scorecard_id}/versions", "summary": "List a scorecard's versions", "deprecated": false }, { "slug": "create-scorecard-draft", "operation_id": "create_scorecard_draft", "method": "POST", "path": "/api/v1/credit/scorecards/{scorecard_id}/versions", "summary": "Start a new draft version", "deprecated": false }, { "slug": "run-daily-sweep", "operation_id": "run_daily_sweep", "method": "POST", "path": "/api/v1/credit/sweeps/daily", "summary": "Run the daily credit sweep", "deprecated": false }, { "slug": "list-sweep-runs", "operation_id": "list_sweep_runs", "method": "GET", "path": "/api/v1/credit/sweeps/runs", "summary": "List daily-sweep runs", "deprecated": false }, { "slug": "get-sweep-run", "operation_id": "get_sweep_run", "method": "GET", "path": "/api/v1/credit/sweeps/runs/{run_id}", "summary": "Get one daily-sweep run", "deprecated": false }, { "slug": "rerun-sweep-step", "operation_id": "rerun_sweep_step", "method": "POST", "path": "/api/v1/credit/sweeps/runs/{run_id}/rerun-step", "summary": "Re-run one step of a daily-sweep run", "deprecated": false }, { "slug": "list-underwriting-assessments", "operation_id": "list_underwriting_assessments", "method": "GET", "path": "/api/v1/credit/underwriting/assessments", "summary": "List underwriting assessments", "deprecated": false }, { "slug": "request-underwriting-assessment", "operation_id": "request_underwriting_assessment", "method": "POST", "path": "/api/v1/credit/underwriting/assessments", "summary": "Request an underwriting assessment", "deprecated": false }, { "slug": "get-underwriting-assessment", "operation_id": "get_underwriting_assessment", "method": "GET", "path": "/api/v1/credit/underwriting/assessments/{assessment_id}", "summary": "Get an underwriting assessment", "deprecated": false }, { "slug": "get-adverse-action", "operation_id": "get_adverse_action", "method": "GET", "path": "/api/v1/credit/underwriting/assessments/{assessment_id}/adverse-action", "summary": "Adverse-action reasons for an assessment", "deprecated": false }, { "slug": "get-assessment-audit", "operation_id": "get_assessment_audit", "method": "GET", "path": "/api/v1/credit/underwriting/assessments/{assessment_id}/audit", "summary": "An assessment's review trail", "deprecated": false }, { "slug": "complete-underwriting-assessment", "operation_id": "complete_underwriting_assessment", "method": "POST", "path": "/api/v1/credit/underwriting/assessments/{assessment_id}/completion", "summary": "Complete an underwriting assessment", "deprecated": false }, { "slug": "attest-manual-check", "operation_id": "attest_manual_check", "method": "POST", "path": "/api/v1/credit/underwriting/assessments/{assessment_id}/manual-checks/{check_id}", "summary": "Attest a manual check", "deprecated": false }, { "slug": "set-assessment-notes", "operation_id": "set_assessment_notes", "method": "PUT", "path": "/api/v1/credit/underwriting/assessments/{assessment_id}/notes", "summary": "Save reviewer notes on an assessment", "deprecated": false }, { "slug": "run-underwriting-assessment", "operation_id": "run_underwriting_assessment", "method": "POST", "path": "/api/v1/credit/underwriting/assessments/{assessment_id}/run", "summary": "Measure and complete an assessment from DayZero data", "deprecated": false }, { "slug": "list-measurers", "operation_id": "list_measurers", "method": "GET", "path": "/api/v1/credit/underwriting/measurers", "summary": "Criterion keys DayZero can measure", "deprecated": false }, { "slug": "get-scorecard-vocabulary", "operation_id": "get_scorecard_vocabulary", "method": "GET", "path": "/api/v1/credit/underwriting/scorecard-vocabulary", "summary": "What a scorecard may be written with", "deprecated": false }, { "slug": "list-subject-businesses", "operation_id": "list_subject_businesses", "method": "GET", "path": "/api/v1/credit/underwriting/subject-businesses", "summary": "Businesses a scorecard can be tested against", "deprecated": false } ], "description": "Partner credit lines — programs, lines, card settlements, loans, daily accrual, statements, payoff quotes, payments, underwriting and versioned scorecards, card issuing, and the credit event feed. DayZero keeps the ledger and measures; the partner moves the money and makes the lending decision.", "description_html": "Partner credit lines — programs, lines, card settlements, loans, daily accrual, statements, payoff quotes, payments, underwriting and versioned scorecards, card issuing, and the credit event feed. DayZero keeps the ledger and measures; the partner moves the money and makes the lending decision.
\n" }, { "name": "credit-memos", "slug": "credit-memos", "operations": [ { "slug": "list-credit-memos", "operation_id": "list_credit_memos", "method": "GET", "path": "/api/v1/credit-memos", "summary": "List credit memos", "deprecated": false }, { "slug": "create-credit-memo", "operation_id": "create_credit_memo", "method": "POST", "path": "/api/v1/credit-memos", "summary": "Create credit memo", "deprecated": false }, { "slug": "get-customer-credits", "operation_id": "get_customer_credits", "method": "GET", "path": "/api/v1/credit-memos/customers/{customer_id}/credits", "summary": "Get customer available credits", "deprecated": false }, { "slug": "suggest-credit-memos", "operation_id": "suggest_credit_memos", "method": "POST", "path": "/api/v1/credit-memos/suggest", "summary": "AI credit memo suggestions", "deprecated": false }, { "slug": "delete-credit-memo", "operation_id": "delete_credit_memo", "method": "DELETE", "path": "/api/v1/credit-memos/{credit_memo_id}", "summary": "Delete credit memo", "deprecated": false }, { "slug": "get-credit-memo", "operation_id": "get_credit_memo", "method": "GET", "path": "/api/v1/credit-memos/{credit_memo_id}", "summary": "Get credit memo", "deprecated": false }, { "slug": "update-credit-memo", "operation_id": "update_credit_memo", "method": "PUT", "path": "/api/v1/credit-memos/{credit_memo_id}", "summary": "Update credit memo", "deprecated": false }, { "slug": "apply-credit-memo", "operation_id": "apply_credit_memo", "method": "POST", "path": "/api/v1/credit-memos/{credit_memo_id}/apply", "summary": "Apply credit memo to invoice", "deprecated": false }, { "slug": "issue-credit-memo", "operation_id": "issue_credit_memo", "method": "POST", "path": "/api/v1/credit-memos/{credit_memo_id}/issue", "summary": "Issue credit memo", "deprecated": false }, { "slug": "unapply-credit-memo", "operation_id": "unapply_credit_memo", "method": "POST", "path": "/api/v1/credit-memos/{credit_memo_id}/unapply", "summary": "Un-apply credit memo from invoice", "deprecated": false }, { "slug": "void-credit-memo", "operation_id": "void_credit_memo", "method": "POST", "path": "/api/v1/credit-memos/{credit_memo_id}/void", "summary": "Void credit memo", "deprecated": false } ], "description": "Customer credits that can be applied to invoices.", "description_html": "Customer credits that can be applied to invoices.
\n" }, { "name": "customer-statements", "slug": "customer-statements", "operations": [ { "slug": "get-customer-statement", "operation_id": "get_customer_statement", "method": "GET", "path": "/api/v1/customer-statements/{customer_id}", "summary": "Get customer statement", "deprecated": false }, { "slug": "send-customer-statement", "operation_id": "send_customer_statement", "method": "POST", "path": "/api/v1/customer-statements/{customer_id}/send", "summary": "Email customer statement", "deprecated": false } ] }, { "name": "customers", "slug": "customers", "operations": [ { "slug": "get-customers", "operation_id": "get_customers", "method": "GET", "path": "/api/v1/customers", "summary": "List customers", "deprecated": false }, { "slug": "create-customer", "operation_id": "create_customer", "method": "POST", "path": "/api/v1/customers", "summary": "Create customer", "deprecated": false }, { "slug": "analyze-payment-behavior", "operation_id": "analyze_payment_behavior", "method": "POST", "path": "/api/v1/customers/analyze-payment-behavior", "summary": "AI payment behavior analysis", "deprecated": false }, { "slug": "auto-categorize-customers", "operation_id": "auto_categorize_customers", "method": "POST", "path": "/api/v1/customers/auto-categorize", "summary": "Bulk AI auto-categorize uncategorized customers", "deprecated": false }, { "slug": "bulk-upload-customers", "operation_id": "bulk_upload_customers", "method": "POST", "path": "/api/v1/customers/bulk-upload", "summary": "Bulk upload customers from CSV", "deprecated": false }, { "slug": "download-customer-bulk-upload-template", "operation_id": "download_customer_bulk_upload_template", "method": "GET", "path": "/api/v1/customers/bulk-upload/template", "summary": "Download bulk customer upload CSV template", "deprecated": false }, { "slug": "categorize-customer", "operation_id": "categorize_customer", "method": "POST", "path": "/api/v1/customers/categorize", "summary": "AI categorize customer", "deprecated": false }, { "slug": "check-duplicates", "operation_id": "check_duplicates_customers", "method": "POST", "path": "/api/v1/customers/check-duplicates", "summary": "Check for duplicate customers", "deprecated": false }, { "slug": "delete-customer", "operation_id": "delete_customer", "method": "DELETE", "path": "/api/v1/customers/{customer_id}", "summary": "Delete customer", "deprecated": false }, { "slug": "get-customer", "operation_id": "get_customer", "method": "GET", "path": "/api/v1/customers/{customer_id}", "summary": "Get customer", "deprecated": false }, { "slug": "update-customer", "operation_id": "update_customer", "method": "PUT", "path": "/api/v1/customers/{customer_id}", "summary": "Update customer", "deprecated": false }, { "slug": "list-contacts", "operation_id": "list_contacts_customers", "method": "GET", "path": "/api/v1/customers/{customer_id}/contacts", "summary": "List customer contacts", "deprecated": false }, { "slug": "create-contact", "operation_id": "create_contact_customers", "method": "POST", "path": "/api/v1/customers/{customer_id}/contacts", "summary": "Create customer contact", "deprecated": false }, { "slug": "delete-contact", "operation_id": "delete_contact_customers", "method": "DELETE", "path": "/api/v1/customers/{customer_id}/contacts/{contact_id}", "summary": "Delete customer contact", "deprecated": false }, { "slug": "get-contact", "operation_id": "get_contact_customers", "method": "GET", "path": "/api/v1/customers/{customer_id}/contacts/{contact_id}", "summary": "Get customer contact", "deprecated": false }, { "slug": "update-contact", "operation_id": "update_contact_customers", "method": "PUT", "path": "/api/v1/customers/{customer_id}/contacts/{contact_id}", "summary": "Update customer contact", "deprecated": false } ], "description": "Customer records for invoicing and AR.", "description_html": "Customer records for invoicing and AR.
\n" }, { "name": "daily-brief", "slug": "daily-brief", "operations": [ { "slug": "get-daily-brief", "operation_id": "get_daily_brief", "method": "GET", "path": "/api/v1/books/daily-brief", "summary": "Regent Daily Brief", "deprecated": false }, { "slug": "get-books-standup", "operation_id": "get_books_standup", "method": "GET", "path": "/api/v1/books/standup", "summary": "Regent proactive morning standup", "deprecated": false } ] }, { "name": "dashboards", "slug": "dashboards", "operations": [ { "slug": "list-dashboards", "operation_id": "list_dashboards", "method": "GET", "path": "/api/v1/dashboards", "summary": "List dashboards", "deprecated": false }, { "slug": "create-dashboard", "operation_id": "create_dashboard", "method": "POST", "path": "/api/v1/dashboards", "summary": "Create a dashboard", "deprecated": false }, { "slug": "list-assignable-users", "operation_id": "list_assignable_users", "method": "GET", "path": "/api/v1/dashboards/assignable-users", "summary": "List assignable users", "deprecated": false }, { "slug": "build-model-from-draft", "operation_id": "build_model_from_draft", "method": "POST", "path": "/api/v1/dashboards/models/build", "summary": "Build an approved model plan", "deprecated": false }, { "slug": "get-model-draft", "operation_id": "get_model_draft", "method": "GET", "path": "/api/v1/dashboards/models/drafts/{draft_id}", "summary": "Read a proposed model in full", "deprecated": false }, { "slug": "revise-model-draft", "operation_id": "revise_model_draft", "method": "PATCH", "path": "/api/v1/dashboards/models/drafts/{draft_id}", "summary": "Edit a proposed model before building it", "deprecated": false }, { "slug": "import-model-workbook", "operation_id": "import_model_workbook", "method": "POST", "path": "/api/v1/dashboards/models/import", "summary": "Import a reference workbook as a model plan", "deprecated": false }, { "slug": "delete-dashboard", "operation_id": "delete_dashboard", "method": "DELETE", "path": "/api/v1/dashboards/{dashboard_id}", "summary": "Delete a dashboard", "deprecated": false }, { "slug": "get-dashboard", "operation_id": "get_dashboard", "method": "GET", "path": "/api/v1/dashboards/{dashboard_id}", "summary": "Get a dashboard", "deprecated": false }, { "slug": "update-dashboard", "operation_id": "update_dashboard", "method": "PATCH", "path": "/api/v1/dashboards/{dashboard_id}", "summary": "Update a dashboard", "deprecated": false }, { "slug": "set-assignments", "operation_id": "set_assignments", "method": "PUT", "path": "/api/v1/dashboards/{dashboard_id}/assignments", "summary": "Set dashboard assignments", "deprecated": false }, { "slug": "export-dashboard", "operation_id": "export_dashboard", "method": "POST", "path": "/api/v1/dashboards/{dashboard_id}/export", "summary": "Export a dashboard to Excel, CSV, or PDF", "deprecated": false }, { "slug": "refresh-model", "operation_id": "refresh_model", "method": "POST", "path": "/api/v1/dashboards/{dashboard_id}/model/refresh", "summary": "Re-derive a model from current ledger data", "deprecated": false }, { "slug": "download-model-workbook", "operation_id": "download_model_workbook", "method": "GET", "path": "/api/v1/dashboards/{dashboard_id}/model/workbook", "summary": "Download a model as a live-formula Excel workbook", "deprecated": false }, { "slug": "refresh-dashboard", "operation_id": "refresh_dashboard", "method": "POST", "path": "/api/v1/dashboards/{dashboard_id}/refresh", "summary": "Refresh a dashboard's widgets now", "deprecated": false }, { "slug": "delete-dashboard-schedule", "operation_id": "delete_dashboard_schedule", "method": "DELETE", "path": "/api/v1/dashboards/{dashboard_id}/schedule", "summary": "Delete the refresh schedule", "deprecated": false }, { "slug": "get-dashboard-schedule", "operation_id": "get_dashboard_schedule", "method": "GET", "path": "/api/v1/dashboards/{dashboard_id}/schedule", "summary": "Get the refresh schedule", "deprecated": false }, { "slug": "update-dashboard-schedule", "operation_id": "update_dashboard_schedule", "method": "PATCH", "path": "/api/v1/dashboards/{dashboard_id}/schedule", "summary": "Update the refresh schedule", "deprecated": false }, { "slug": "create-dashboard-schedule", "operation_id": "create_dashboard_schedule", "method": "POST", "path": "/api/v1/dashboards/{dashboard_id}/schedule", "summary": "Create a refresh schedule", "deprecated": false }, { "slug": "create-dashboard-share", "operation_id": "create_dashboard_share", "method": "POST", "path": "/api/v1/dashboards/{dashboard_id}/share", "summary": "Create a public share link", "deprecated": false }, { "slug": "list-dashboard-shares", "operation_id": "list_dashboard_shares", "method": "GET", "path": "/api/v1/dashboards/{dashboard_id}/shares", "summary": "List share links", "deprecated": false }, { "slug": "revoke-dashboard-share", "operation_id": "revoke_dashboard_share", "method": "DELETE", "path": "/api/v1/dashboards/{dashboard_id}/shares/{share_id}", "summary": "Revoke a share link", "deprecated": false }, { "slug": "list-dashboard-versions", "operation_id": "list_dashboard_versions", "method": "GET", "path": "/api/v1/dashboards/{dashboard_id}/versions", "summary": "List dashboard versions", "deprecated": false }, { "slug": "save-dashboard-version", "operation_id": "save_dashboard_version", "method": "POST", "path": "/api/v1/dashboards/{dashboard_id}/versions", "summary": "Save a dashboard version", "deprecated": false }, { "slug": "get-dashboard-version", "operation_id": "get_dashboard_version", "method": "GET", "path": "/api/v1/dashboards/{dashboard_id}/versions/{version_id}", "summary": "Get a dashboard version", "deprecated": false }, { "slug": "restore-dashboard-version", "operation_id": "restore_dashboard_version", "method": "POST", "path": "/api/v1/dashboards/{dashboard_id}/versions/{version_id}/restore", "summary": "Restore a dashboard version", "deprecated": false }, { "slug": "add-widget", "operation_id": "add_widget", "method": "POST", "path": "/api/v1/dashboards/{dashboard_id}/widgets", "summary": "Add a widget", "deprecated": false }, { "slug": "reorder-widgets", "operation_id": "reorder_widgets", "method": "POST", "path": "/api/v1/dashboards/{dashboard_id}/widgets/reorder", "summary": "Reorder widgets", "deprecated": false }, { "slug": "remove-widget", "operation_id": "remove_widget", "method": "DELETE", "path": "/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}", "summary": "Remove a widget", "deprecated": false }, { "slug": "update-widget", "operation_id": "update_widget", "method": "PATCH", "path": "/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}", "summary": "Update a widget", "deprecated": false }, { "slug": "create-widget-alert", "operation_id": "create_widget_alert", "method": "POST", "path": "/api/v1/dashboards/{dashboard_id}/widgets/{widget_id}/alert", "summary": "Create an alert on a metric widget", "deprecated": false } ] }, { "name": "dashboards-public", "slug": "dashboards-public", "operations": [ { "slug": "fetch-public-dashboard", "operation_id": "fetch_public_dashboard", "method": "GET", "path": "/api/v1/public/dashboards/{token}", "summary": "Public dashboard viewer (unauthenticated)", "deprecated": false } ] }, { "name": "deals", "slug": "deals", "operations": [ { "slug": "list-deals", "operation_id": "list_deals", "method": "GET", "path": "/api/v1/o2c/deals", "summary": "List deals", "deprecated": false }, { "slug": "create-deal", "operation_id": "create_deal", "method": "POST", "path": "/api/v1/o2c/deals", "summary": "Create a deal", "deprecated": false }, { "slug": "bulk-create-deals", "operation_id": "bulk_create_deals", "method": "POST", "path": "/api/v1/o2c/deals/bulk", "summary": "Bulk-create deals", "deprecated": false }, { "slug": "list-deal-owners", "operation_id": "list_deal_owners", "method": "GET", "path": "/api/v1/o2c/deals/owners", "summary": "List sales reps with deals", "deprecated": false }, { "slug": "get-pipeline", "operation_id": "get_pipeline", "method": "GET", "path": "/api/v1/o2c/deals/pipeline", "summary": "Pipeline view: forecast metrics + deals", "deprecated": false }, { "slug": "get-deal", "operation_id": "get_deal", "method": "GET", "path": "/api/v1/o2c/deals/{deal_id}", "summary": "Get deal", "deprecated": false }, { "slug": "update-deal", "operation_id": "update_deal", "method": "PATCH", "path": "/api/v1/o2c/deals/{deal_id}", "summary": "Edit deal", "deprecated": false }, { "slug": "create-order-from-deal", "operation_id": "create_order_from_deal", "method": "POST", "path": "/api/v1/o2c/deals/{deal_id}/create-order", "summary": "Convert a deal into a customer/project/draft order", "deprecated": false }, { "slug": "mark-deal-lost", "operation_id": "mark_deal_lost", "method": "POST", "path": "/api/v1/o2c/deals/{deal_id}/mark-lost", "summary": "Mark a deal lost", "deprecated": false }, { "slug": "reopen-deal", "operation_id": "reopen_deal", "method": "POST", "path": "/api/v1/o2c/deals/{deal_id}/reopen", "summary": "Reopen a lost deal", "deprecated": false } ] }, { "name": "decisions", "slug": "decisions", "operations": [ { "slug": "list-decisions", "operation_id": "list_decisions", "method": "GET", "path": "/api/v1/decisions", "summary": "List decisions", "deprecated": false }, { "slug": "create-decision", "operation_id": "create_decision", "method": "POST", "path": "/api/v1/decisions", "summary": "Record a decision", "deprecated": false }, { "slug": "delete-decision", "operation_id": "delete_decision", "method": "DELETE", "path": "/api/v1/decisions/{decision_id}", "summary": "End a decision", "deprecated": false }, { "slug": "update-decision", "operation_id": "update_decision", "method": "PATCH", "path": "/api/v1/decisions/{decision_id}", "summary": "Update a decision", "deprecated": false } ] }, { "name": "deferred-revenue", "slug": "deferred-revenue", "operations": [ { "slug": "list-deferrals", "operation_id": "list_deferrals", "method": "GET", "path": "/api/v1/deferred-revenue", "summary": "List deferred invoices", "deprecated": false }, { "slug": "get-invoice-deferral-status", "operation_id": "get_invoice_deferral_status", "method": "GET", "path": "/api/v1/deferred-revenue/invoices/{invoice_id}", "summary": "Get an invoice's deferral", "deprecated": false }, { "slug": "defer-invoice", "operation_id": "defer_invoice", "method": "POST", "path": "/api/v1/deferred-revenue/invoices/{invoice_id}", "summary": "Defer an invoice", "deprecated": false }, { "slug": "deferred-revenue-matrix", "operation_id": "deferred_revenue_matrix", "method": "GET", "path": "/api/v1/deferred-revenue/matrix", "summary": "Deferred revenue matrix", "deprecated": false }, { "slug": "run-recognition", "operation_id": "run_recognition_deferred_revenue", "method": "POST", "path": "/api/v1/deferred-revenue/recognize", "summary": "Run recognition", "deprecated": false }, { "slug": "get-recognized-revenue", "operation_id": "get_recognized_revenue", "method": "GET", "path": "/api/v1/deferred-revenue/recognized", "summary": "Recognized revenue", "deprecated": false }, { "slug": "get-deferral", "operation_id": "get_deferral", "method": "GET", "path": "/api/v1/deferred-revenue/{deferral_id}", "summary": "Get a deferral", "deprecated": false }, { "slug": "update-deferral-terms", "operation_id": "update_deferral_terms", "method": "PUT", "path": "/api/v1/deferred-revenue/{deferral_id}", "summary": "Update deferral terms", "deprecated": false }, { "slug": "cancel-deferral", "operation_id": "cancel_deferral", "method": "POST", "path": "/api/v1/deferred-revenue/{deferral_id}/cancel", "summary": "Undo a deferral", "deprecated": false }, { "slug": "set-period-units", "operation_id": "set_period_units", "method": "POST", "path": "/api/v1/deferred-revenue/{deferral_id}/periods/{period_id}", "summary": "Fill in a period's numerator", "deprecated": false } ] }, { "name": "delayed-charges", "slug": "delayed-charges", "operations": [ { "slug": "list-delayed-charges", "operation_id": "list_delayed_charges", "method": "GET", "path": "/api/v1/delayed-charges", "summary": "List delayed charges", "deprecated": false }, { "slug": "create-delayed-charge", "operation_id": "create_delayed_charge", "method": "POST", "path": "/api/v1/delayed-charges", "summary": "Create delayed charge", "deprecated": false }, { "slug": "get-customer-pending-charges", "operation_id": "get_customer_pending_charges", "method": "GET", "path": "/api/v1/delayed-charges/customers/{customer_id}/pending", "summary": "Get customer pending charges", "deprecated": false }, { "slug": "delete-delayed-charge", "operation_id": "delete_delayed_charge", "method": "DELETE", "path": "/api/v1/delayed-charges/{charge_id}", "summary": "Delete delayed charge", "deprecated": false }, { "slug": "get-delayed-charge", "operation_id": "get_delayed_charge", "method": "GET", "path": "/api/v1/delayed-charges/{charge_id}", "summary": "Get delayed charge", "deprecated": false }, { "slug": "update-delayed-charge", "operation_id": "update_delayed_charge", "method": "PUT", "path": "/api/v1/delayed-charges/{charge_id}", "summary": "Update delayed charge", "deprecated": false } ] }, { "name": "document-requests", "slug": "document-requests", "operations": [ { "slug": "list-client-document-requests", "operation_id": "list_client_document_requests", "method": "GET", "path": "/api/v1/document-requests", "summary": "List document requests (client)", "deprecated": false }, { "slug": "client-document-request-count", "operation_id": "client_document_request_count", "method": "GET", "path": "/api/v1/document-requests/count", "summary": "Open document request count (client)", "deprecated": false }, { "slug": "list-firm-document-requests", "operation_id": "list_firm_document_requests", "method": "GET", "path": "/api/v1/document-requests/firm", "summary": "List document requests (firm)", "deprecated": false }, { "slug": "create-document-request", "operation_id": "create_document_request", "method": "POST", "path": "/api/v1/document-requests/firm/businesses/{business_id}", "summary": "Request a document from a client (firm)", "deprecated": false }, { "slug": "firm-document-request-count", "operation_id": "firm_document_request_count", "method": "GET", "path": "/api/v1/document-requests/firm/count", "summary": "Open document request count (firm)", "deprecated": false }, { "slug": "cancel-document-request", "operation_id": "cancel_document_request", "method": "POST", "path": "/api/v1/document-requests/firm/{request_id}/cancel", "summary": "Cancel a document request (firm)", "deprecated": false }, { "slug": "download-firm-document", "operation_id": "download_firm_document", "method": "GET", "path": "/api/v1/document-requests/firm/{request_id}/download", "summary": "Download an uploaded document (firm)", "deprecated": false }, { "slug": "download-client-document", "operation_id": "download_client_document", "method": "GET", "path": "/api/v1/document-requests/{request_id}/download", "summary": "Download an uploaded document (client)", "deprecated": false }, { "slug": "fulfill-document-request", "operation_id": "fulfill_document_request", "method": "POST", "path": "/api/v1/document-requests/{request_id}/fulfill", "summary": "Upload a requested document (client)", "deprecated": false } ] }, { "name": "documents-public", "slug": "documents-public", "operations": [ { "slug": "fetch-public-document", "operation_id": "fetch_public_document", "method": "GET", "path": "/api/v1/public/documents/{token}", "summary": "Public shared-document viewer (unauthenticated)", "deprecated": false } ] }, { "name": "estimates", "slug": "estimates", "operations": [ { "slug": "list-estimates", "operation_id": "list_estimates", "method": "GET", "path": "/api/v1/estimates", "summary": "List estimates", "deprecated": false }, { "slug": "create-estimate", "operation_id": "create_estimate", "method": "POST", "path": "/api/v1/estimates", "summary": "Create estimate", "deprecated": false }, { "slug": "delete-estimate", "operation_id": "delete_estimate", "method": "DELETE", "path": "/api/v1/estimates/{estimate_id}", "summary": "Delete estimate", "deprecated": false }, { "slug": "get-estimate", "operation_id": "get_estimate", "method": "GET", "path": "/api/v1/estimates/{estimate_id}", "summary": "Get estimate", "deprecated": false }, { "slug": "update-estimate", "operation_id": "update_estimate", "method": "PUT", "path": "/api/v1/estimates/{estimate_id}", "summary": "Update estimate", "deprecated": false }, { "slug": "accept-estimate", "operation_id": "accept_estimate", "method": "POST", "path": "/api/v1/estimates/{estimate_id}/accept", "summary": "Accept estimate", "deprecated": false }, { "slug": "convert-estimate", "operation_id": "convert_estimate", "method": "POST", "path": "/api/v1/estimates/{estimate_id}/convert", "summary": "Convert estimate to invoice", "deprecated": false }, { "slug": "decline-estimate", "operation_id": "decline_estimate", "method": "POST", "path": "/api/v1/estimates/{estimate_id}/decline", "summary": "Decline estimate", "deprecated": false }, { "slug": "send-estimate", "operation_id": "send_estimate", "method": "POST", "path": "/api/v1/estimates/{estimate_id}/send", "summary": "Send estimate", "deprecated": false } ] }, { "name": "expense-reports", "slug": "expense-reports", "operations": [ { "slug": "list-expense-reports", "operation_id": "list_expense_reports", "method": "GET", "path": "/api/v1/expense-reports", "summary": "List expense reports", "deprecated": false }, { "slug": "create-expense-report", "operation_id": "create_expense_report", "method": "POST", "path": "/api/v1/expense-reports", "summary": "Create expense report", "deprecated": false }, { "slug": "delete-expense-report", "operation_id": "delete_expense_report", "method": "DELETE", "path": "/api/v1/expense-reports/{report_id}", "summary": "Delete expense report", "deprecated": false }, { "slug": "get-expense-report", "operation_id": "get_expense_report", "method": "GET", "path": "/api/v1/expense-reports/{report_id}", "summary": "Get expense report", "deprecated": false }, { "slug": "update-expense-report", "operation_id": "update_expense_report", "method": "PUT", "path": "/api/v1/expense-reports/{report_id}", "summary": "Update expense report", "deprecated": false }, { "slug": "approve-expense-report", "operation_id": "approve_expense_report", "method": "POST", "path": "/api/v1/expense-reports/{report_id}/approve", "summary": "Approve expense report", "deprecated": false }, { "slug": "reimburse-expense-report", "operation_id": "reimburse_expense_report", "method": "POST", "path": "/api/v1/expense-reports/{report_id}/reimburse", "summary": "Reimburse expense report", "deprecated": false }, { "slug": "list-reimbursement-candidates", "operation_id": "list_reimbursement_candidates", "method": "GET", "path": "/api/v1/expense-reports/{report_id}/reimbursement-candidates", "summary": "List bank transactions that could be the reimbursement", "deprecated": false }, { "slug": "reject-expense-report", "operation_id": "reject_expense_report", "method": "POST", "path": "/api/v1/expense-reports/{report_id}/reject", "summary": "Reject expense report", "deprecated": false }, { "slug": "submit-expense-report", "operation_id": "submit_expense_report", "method": "POST", "path": "/api/v1/expense-reports/{report_id}/submit", "summary": "Submit expense report", "deprecated": false } ] }, { "name": "fixed-assets", "slug": "fixed-assets", "operations": [ { "slug": "list-fixed-assets", "operation_id": "list_fixed_assets", "method": "GET", "path": "/api/v1/fixed-assets", "summary": "List fixed assets", "deprecated": false }, { "slug": "create-fixed-asset", "operation_id": "create_fixed_asset", "method": "POST", "path": "/api/v1/fixed-assets", "summary": "Create fixed asset", "deprecated": false }, { "slug": "list-asset-categories", "operation_id": "list_asset_categories", "method": "GET", "path": "/api/v1/fixed-assets/categories", "summary": "List asset categories", "deprecated": false }, { "slug": "create-asset-category", "operation_id": "create_asset_category", "method": "POST", "path": "/api/v1/fixed-assets/categories", "summary": "Create asset category", "deprecated": false }, { "slug": "seed-default-categories", "operation_id": "seed_default_categories", "method": "POST", "path": "/api/v1/fixed-assets/categories/seed-defaults", "summary": "Seed default categories", "deprecated": false }, { "slug": "delete-asset-category", "operation_id": "delete_asset_category", "method": "DELETE", "path": "/api/v1/fixed-assets/categories/{category_id}", "summary": "Delete asset category", "deprecated": false }, { "slug": "get-asset-category", "operation_id": "get_asset_category", "method": "GET", "path": "/api/v1/fixed-assets/categories/{category_id}", "summary": "Get asset category", "deprecated": false }, { "slug": "update-asset-category", "operation_id": "update_asset_category", "method": "PATCH", "path": "/api/v1/fixed-assets/categories/{category_id}", "summary": "Update asset category", "deprecated": false }, { "slug": "get-depreciation-matrix", "operation_id": "get_depreciation_matrix", "method": "GET", "path": "/api/v1/fixed-assets/depreciation-matrix", "summary": "Depreciation schedule matrix", "deprecated": false }, { "slug": "preview-depreciation", "operation_id": "preview_depreciation", "method": "GET", "path": "/api/v1/fixed-assets/depreciation-preview", "summary": "Preview depreciation", "deprecated": false }, { "slug": "create-asset-from-transactions", "operation_id": "create_asset_from_transactions", "method": "POST", "path": "/api/v1/fixed-assets/from-transactions", "summary": "Create asset from transactions", "deprecated": false }, { "slug": "generate-depreciation-schedules", "operation_id": "generate_depreciation_schedules", "method": "POST", "path": "/api/v1/fixed-assets/generate-schedules", "summary": "Queue depreciation schedules", "deprecated": false }, { "slug": "post-scheduled-depreciation", "operation_id": "post_scheduled_depreciation", "method": "POST", "path": "/api/v1/fixed-assets/post-scheduled-depreciation", "summary": "Post due scheduled depreciation", "deprecated": false }, { "slug": "run-depreciation", "operation_id": "run_depreciation", "method": "POST", "path": "/api/v1/fixed-assets/run-depreciation", "summary": "Run depreciation", "deprecated": false }, { "slug": "list-scheduled-journal-entries", "operation_id": "list_scheduled_journal_entries", "method": "GET", "path": "/api/v1/fixed-assets/scheduled-journal-entries", "summary": "List scheduled journal entries", "deprecated": false }, { "slug": "suggest-capitalization", "operation_id": "suggest_capitalization", "method": "POST", "path": "/api/v1/fixed-assets/suggest-capitalization", "summary": "AI capitalization suggestions", "deprecated": false }, { "slug": "start-suggest-capitalization", "operation_id": "start_suggest_capitalization", "method": "POST", "path": "/api/v1/fixed-assets/suggest-capitalization/start", "summary": "Start AI capitalization suggestions as a background job", "deprecated": false }, { "slug": "delete-fixed-asset", "operation_id": "delete_fixed_asset", "method": "DELETE", "path": "/api/v1/fixed-assets/{asset_id}", "summary": "Delete fixed asset", "deprecated": false }, { "slug": "get-fixed-asset", "operation_id": "get_fixed_asset", "method": "GET", "path": "/api/v1/fixed-assets/{asset_id}", "summary": "Get fixed asset", "deprecated": false }, { "slug": "update-fixed-asset", "operation_id": "update_fixed_asset", "method": "PATCH", "path": "/api/v1/fixed-assets/{asset_id}", "summary": "Update fixed asset", "deprecated": false }, { "slug": "get-depreciation-entries", "operation_id": "get_depreciation_entries", "method": "GET", "path": "/api/v1/fixed-assets/{asset_id}/depreciation-entries", "summary": "Get depreciation entries", "deprecated": false }, { "slug": "get-depreciation-schedule", "operation_id": "get_depreciation_schedule", "method": "GET", "path": "/api/v1/fixed-assets/{asset_id}/depreciation-schedule", "summary": "Get depreciation schedule", "deprecated": false }, { "slug": "dispose-asset", "operation_id": "dispose_asset", "method": "POST", "path": "/api/v1/fixed-assets/{asset_id}/dispose", "summary": "Dispose asset", "deprecated": false }, { "slug": "place-asset-in-service", "operation_id": "place_asset_in_service", "method": "POST", "path": "/api/v1/fixed-assets/{asset_id}/place-in-service", "summary": "Place asset in service", "deprecated": false } ], "description": "Asset tracking, depreciation schedules, and disposal.", "description_html": "Asset tracking, depreciation schedules, and disposal.
\n" }, { "name": "fx-rates", "slug": "fx-rates", "operations": [ { "slug": "fx-exposure", "operation_id": "fx_exposure", "method": "GET", "path": "/api/v1/fx/exposure", "summary": "FX exposure preview", "deprecated": false }, { "slug": "list-fx-rates", "operation_id": "list_fx_rates", "method": "GET", "path": "/api/v1/fx/rates", "summary": "List FX rates", "deprecated": false }, { "slug": "upsert-fx-rate", "operation_id": "upsert_fx_rate", "method": "POST", "path": "/api/v1/fx/rates", "summary": "Upsert FX rate", "deprecated": false }, { "slug": "fx-revalue", "operation_id": "fx_revalue", "method": "POST", "path": "/api/v1/fx/revalue", "summary": "Post FX revaluation", "deprecated": false } ] }, { "name": "gmail", "slug": "gmail", "operations": [ { "slug": "get-connect-url", "operation_id": "get_connect_url_gmail", "method": "GET", "path": "/api/v1/gmail/connect-url", "summary": "Get Gmail OAuth connect URL", "deprecated": false }, { "slug": "disconnect", "operation_id": "disconnect_gmail", "method": "DELETE", "path": "/api/v1/gmail/disconnect", "summary": "Disconnect Gmail", "deprecated": false }, { "slug": "gmail-oauth-callback", "operation_id": "gmail_oauth_callback", "method": "GET", "path": "/api/v1/gmail/oauth/callback", "summary": "Gmail OAuth callback", "deprecated": false }, { "slug": "get-connection-status", "operation_id": "get_connection_status_gmail", "method": "GET", "path": "/api/v1/gmail/status", "summary": "Gmail connection status", "deprecated": false } ] }, { "name": "intents", "slug": "intents", "operations": [ { "slug": "route-intent", "operation_id": "route_intent", "method": "POST", "path": "/api/v1/intents/route", "summary": "Route user intent", "deprecated": false } ] }, { "name": "intercompany-cleanup", "slug": "intercompany-cleanup", "operations": [ { "slug": "list-access-requests", "operation_id": "list_access_requests", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/access-requests", "summary": "List aggregated parent-side access requests", "deprecated": false }, { "slug": "get-account-map", "operation_id": "get_account_map", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/account-map", "summary": "Get the firm Account Master Map", "deprecated": false }, { "slug": "create-account-map-entry", "operation_id": "create_account_map_entry", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/account-map", "summary": "Add an external account stub to the map", "deprecated": false }, { "slug": "delete-account-map-entry", "operation_id": "delete_account_map_entry", "method": "DELETE", "path": "/api/v1/advisory-firms/{firm_id}/account-map/{entry_id}", "summary": "Delete an external account map entry", "deprecated": false }, { "slug": "update-account-map-entry", "operation_id": "update_account_map_entry", "method": "PATCH", "path": "/api/v1/advisory-firms/{firm_id}/account-map/{entry_id}", "summary": "Update an account map entry", "deprecated": false }, { "slug": "bulk-resolve-candidates", "operation_id": "bulk_resolve_candidates", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/candidates/bulk-resolve", "summary": "Confirm or reject match candidates", "deprecated": false }, { "slug": "get-candidate-context", "operation_id": "get_candidate_context", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/candidates/{candidate_id}/context", "summary": "Drill-in context for one match candidate", "deprecated": false }, { "slug": "get-cleanup-badge", "operation_id": "get_cleanup_badge", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/cleanup-badge", "summary": "Open intercompany review-queue count", "deprecated": false }, { "slug": "list-cleanup-sessions", "operation_id": "list_cleanup_sessions", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/cleanup-sessions", "summary": "List cleanup sessions for a firm", "deprecated": false }, { "slug": "create-cleanup-session", "operation_id": "create_cleanup_session", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/cleanup-sessions", "summary": "Start a historical cleanup session", "deprecated": false }, { "slug": "get-cleanup-session", "operation_id": "get_cleanup_session", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/cleanup-sessions/{session_id}", "summary": "Get a cleanup session with progress counters", "deprecated": false }, { "slug": "list-session-candidates", "operation_id": "list_session_candidates", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/cleanup-sessions/{session_id}/candidates", "summary": "List match candidates for a session", "deprecated": false }, { "slug": "rerun-cleanup-session", "operation_id": "rerun_cleanup_session", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/cleanup-sessions/{session_id}/run", "summary": "Re-run matching for a session (iterative clearing)", "deprecated": false }, { "slug": "download-cleanup-workpaper", "operation_id": "download_cleanup_workpaper", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/cleanup-sessions/{session_id}/workpaper", "summary": "Download the cleanup session workpaper (PDF)", "deprecated": false }, { "slug": "get-intercompany-balances", "operation_id": "get_intercompany_balances", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/intercompany-balances", "summary": "Standing due-to / due-from balances per entity", "deprecated": false }, { "slug": "list-resolution-history", "operation_id": "list_resolution_history", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/resolutions", "summary": "List resolution batches (history)", "deprecated": false }, { "slug": "undo-resolution-batch", "operation_id": "undo_resolution_batch", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/resolutions/{batch_id}/undo", "summary": "Undo a resolution batch", "deprecated": false }, { "slug": "get-settlement-proposals", "operation_id": "get_settlement_proposals", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/settlement-proposals", "summary": "Pairwise net intercompany positions ready to settle", "deprecated": false }, { "slug": "record-settlement", "operation_id": "record_settlement", "method": "POST", "path": "/api/v1/advisory-firms/{firm_id}/settlements", "summary": "Record an intercompany settlement (netting entry)", "deprecated": false }, { "slug": "list-tracker-candidates", "operation_id": "list_tracker_candidates", "method": "GET", "path": "/api/v1/advisory-firms/{firm_id}/tracker-candidates", "summary": "List match candidates found outside any session", "deprecated": false } ] }, { "name": "inventory:accounts_payable", "slug": "inventory-accounts-payable", "operations": [ { "slug": "list-inventory-ap-bills", "operation_id": "list_inventory_ap_bills", "method": "GET", "path": "/api/v1/inventory/accounts-payable", "summary": "List Inventory AP bills", "deprecated": false }, { "slug": "recompute-three-way-match", "operation_id": "recompute_three_way_match", "method": "POST", "path": "/api/v1/inventory/accounts-payable/{bill_id}/three-way-match", "summary": "Recompute the three-way match for a bill", "deprecated": false } ] }, { "name": "inventory:activity", "slug": "inventory-activity", "operations": [ { "slug": "list-inventory-activity", "operation_id": "list_inventory_activity", "method": "GET", "path": "/api/v1/inventory/activity", "summary": "List inventory activity", "deprecated": false } ] }, { "name": "inventory:adjustments", "slug": "inventory-adjustments", "operations": [ { "slug": "create-inventory-adjustment", "operation_id": "create_inventory_adjustment", "method": "POST", "path": "/api/v1/inventory/adjustments", "summary": "Create manual inventory adjustment", "deprecated": false } ], "description": "Inventory quantity and value adjustments.", "description_html": "Inventory quantity and value adjustments.
\n" }, { "name": "inventory:cost_history", "slug": "inventory-cost-history", "operations": [ { "slug": "get-cost-history", "operation_id": "get_cost_history", "method": "GET", "path": "/api/v1/inventory/cost-history", "summary": "Landed COGS history", "deprecated": false } ] }, { "name": "inventory:counts", "slug": "inventory-counts", "operations": [ { "slug": "list-counts", "operation_id": "list_counts", "method": "GET", "path": "/api/v1/inventory/counts", "summary": "List cycle counts", "deprecated": false }, { "slug": "start-count", "operation_id": "start_count", "method": "POST", "path": "/api/v1/inventory/counts", "summary": "Start a cycle count", "deprecated": false }, { "slug": "get-count", "operation_id": "get_count", "method": "GET", "path": "/api/v1/inventory/counts/{count_id}", "summary": "Get a cycle count", "deprecated": false }, { "slug": "cancel-count", "operation_id": "cancel_count", "method": "POST", "path": "/api/v1/inventory/counts/{count_id}/cancel", "summary": "Cancel a cycle count", "deprecated": false }, { "slug": "add-count-line", "operation_id": "add_count_line", "method": "POST", "path": "/api/v1/inventory/counts/{count_id}/lines", "summary": "Add or scan a line", "deprecated": false }, { "slug": "submit-count-line", "operation_id": "submit_count_line", "method": "PUT", "path": "/api/v1/inventory/counts/{count_id}/lines/{line_id}", "summary": "Record a counted quantity", "deprecated": false }, { "slug": "post-count", "operation_id": "post_count", "method": "POST", "path": "/api/v1/inventory/counts/{count_id}/post", "summary": "Post a cycle count", "deprecated": false }, { "slug": "inventory-gl-preview-post-count", "operation_id": "inventory_gl_preview_post_count", "method": "POST", "path": "/api/v1/inventory/counts/{count_id}/preview-post", "summary": "Preview posting a cycle count", "deprecated": false } ] }, { "name": "inventory:forecast", "slug": "inventory-forecast", "operations": [ { "slug": "recompute-sku-forecasts", "operation_id": "recompute_sku_forecasts", "method": "POST", "path": "/api/v1/inventory/forecast/recompute", "summary": "Recompute SKU demand forecasts", "deprecated": false }, { "slug": "list-sku-forecasts", "operation_id": "list_sku_forecasts", "method": "GET", "path": "/api/v1/inventory/forecast/skus", "summary": "List per-SKU demand forecasts", "deprecated": false }, { "slug": "get-sku-forecast-detail", "operation_id": "get_sku_forecast_detail", "method": "GET", "path": "/api/v1/inventory/forecast/skus/{variant_id}", "summary": "Get one SKU's demand forecast detail", "deprecated": false } ] }, { "name": "inventory:import", "slug": "inventory-import", "operations": [ { "slug": "analyze-spreadsheet", "operation_id": "analyze_spreadsheet", "method": "POST", "path": "/api/v1/inventory/import/analyze", "summary": "Analyze spreadsheet (async)", "deprecated": false }, { "slug": "get-analyze-status", "operation_id": "get_analyze_status", "method": "GET", "path": "/api/v1/inventory/import/analyze/{task_id}", "summary": "Poll analysis status", "deprecated": false }, { "slug": "apply-import", "operation_id": "apply_import", "method": "POST", "path": "/api/v1/inventory/import/apply", "summary": "Apply import", "deprecated": false }, { "slug": "preview-import", "operation_id": "preview_import", "method": "POST", "path": "/api/v1/inventory/import/preview", "summary": "Preview import", "deprecated": false } ], "description": "Bulk import inventory data from CSV or external systems.", "description_html": "Bulk import inventory data from CSV or external systems.
\n" }, { "name": "inventory:landed_cost_allocations", "slug": "inventory-landed-cost-allocations", "operations": [ { "slug": "list-allocatable-orders", "operation_id": "list_allocatable_orders", "method": "GET", "path": "/api/v1/inventory/landed-cost-allocations/orders", "summary": "List allocatable purchase orders", "deprecated": false }, { "slug": "list-allocations", "operation_id": "list_allocations", "method": "GET", "path": "/api/v1/inventory/landed-cost-allocations/{bill_id}", "summary": "List a bill's landed cost allocations", "deprecated": false }, { "slug": "replace-allocations", "operation_id": "replace_allocations", "method": "PUT", "path": "/api/v1/inventory/landed-cost-allocations/{bill_id}", "summary": "Replace a bill's landed cost allocations", "deprecated": false }, { "slug": "delete-allocation", "operation_id": "delete_allocation", "method": "DELETE", "path": "/api/v1/inventory/landed-cost-allocations/{bill_id}/{allocation_id}", "summary": "Remove a landed cost allocation", "deprecated": false } ] }, { "name": "inventory:ledger_settings", "slug": "inventory-ledger-settings", "operations": [ { "slug": "inventory-gl-get-ledger-settings", "operation_id": "inventory_gl_get_ledger_settings", "method": "GET", "path": "/api/v1/inventory/ledger-settings", "summary": "Get inventory ledger settings", "deprecated": false }, { "slug": "inventory-gl-update-ledger-settings", "operation_id": "inventory_gl_update_ledger_settings", "method": "PUT", "path": "/api/v1/inventory/ledger-settings", "summary": "Update inventory ledger settings", "deprecated": false } ] }, { "name": "inventory:locations", "slug": "inventory-locations", "operations": [ { "slug": "list-locations", "operation_id": "list_locations", "method": "GET", "path": "/api/v1/inventory/locations", "summary": "List inventory locations", "deprecated": false }, { "slug": "create-location", "operation_id": "create_location", "method": "POST", "path": "/api/v1/inventory/locations", "summary": "Create location", "deprecated": false }, { "slug": "get-default-location", "operation_id": "get_default_location", "method": "GET", "path": "/api/v1/inventory/locations/default", "summary": "Get default location", "deprecated": false }, { "slug": "get-location-summaries", "operation_id": "get_location_summaries", "method": "GET", "path": "/api/v1/inventory/locations/summaries", "summary": "Get inventory summaries for all locations", "deprecated": false }, { "slug": "delete-location", "operation_id": "delete_location", "method": "DELETE", "path": "/api/v1/inventory/locations/{location_id}", "summary": "Delete location", "deprecated": false }, { "slug": "get-location", "operation_id": "get_location", "method": "GET", "path": "/api/v1/inventory/locations/{location_id}", "summary": "Get location", "deprecated": false }, { "slug": "update-location", "operation_id": "update_location", "method": "PUT", "path": "/api/v1/inventory/locations/{location_id}", "summary": "Update location", "deprecated": false }, { "slug": "archive-location", "operation_id": "archive_location", "method": "POST", "path": "/api/v1/inventory/locations/{location_id}/archive", "summary": "Archive location", "deprecated": false }, { "slug": "get-location-inventory", "operation_id": "get_location_inventory", "method": "GET", "path": "/api/v1/inventory/locations/{location_id}/inventory", "summary": "Get inventory at location", "deprecated": false }, { "slug": "set-default-location", "operation_id": "set_default_location", "method": "POST", "path": "/api/v1/inventory/locations/{location_id}/set-default", "summary": "Set as default location", "deprecated": false }, { "slug": "get-location-summary", "operation_id": "get_location_summary", "method": "GET", "path": "/api/v1/inventory/locations/{location_id}/summary", "summary": "Get location inventory summary", "deprecated": false } ], "description": "Warehouse and storage location management.", "description_html": "Warehouse and storage location management.
\n" }, { "name": "inventory:lots", "slug": "inventory-lots", "operations": [ { "slug": "list-expiring-lots", "operation_id": "list_expiring_lots", "method": "GET", "path": "/api/v1/inventory/lots/expiring", "summary": "List expiring cost lots", "deprecated": false } ] }, { "name": "inventory:payments", "slug": "inventory-payments", "operations": [ { "slug": "get-payments", "operation_id": "get_payments", "method": "GET", "path": "/api/v1/inventory/payments", "summary": "List inventory payments", "deprecated": false } ], "description": "Payments linked to inventory orders.", "description_html": "Payments linked to inventory orders.
\n" }, { "name": "inventory:po_import", "slug": "inventory-po-import", "operations": [ { "slug": "analyze-po-spreadsheet", "operation_id": "analyze_po_spreadsheet", "method": "POST", "path": "/api/v1/inventory/po-import/analyze", "summary": "Analyze manufacturer PO spreadsheet (async)", "deprecated": false }, { "slug": "get-po-analyze-status", "operation_id": "get_po_analyze_status", "method": "GET", "path": "/api/v1/inventory/po-import/analyze/{task_id}", "summary": "Poll PO analysis status", "deprecated": false }, { "slug": "apply-po-import", "operation_id": "apply_po_import", "method": "POST", "path": "/api/v1/inventory/po-import/apply", "summary": "Create purchase order from import", "deprecated": false }, { "slug": "preview-po-import", "operation_id": "preview_po_import", "method": "POST", "path": "/api/v1/inventory/po-import/preview", "summary": "Preview PO import with SKU matching", "deprecated": false } ] }, { "name": "inventory:production", "slug": "inventory-production", "operations": [ { "slug": "list-recipes", "operation_id": "list_recipes", "method": "GET", "path": "/api/v1/inventory/production/recipes", "summary": "List recipes", "deprecated": false }, { "slug": "create-recipe", "operation_id": "create_recipe", "method": "POST", "path": "/api/v1/inventory/production/recipes", "summary": "Create recipe", "deprecated": false }, { "slug": "delete-recipe", "operation_id": "delete_recipe", "method": "DELETE", "path": "/api/v1/inventory/production/recipes/{recipe_id}", "summary": "Delete recipe", "deprecated": false }, { "slug": "get-recipe", "operation_id": "get_recipe", "method": "GET", "path": "/api/v1/inventory/production/recipes/{recipe_id}", "summary": "Get recipe", "deprecated": false }, { "slug": "update-recipe", "operation_id": "update_recipe", "method": "PUT", "path": "/api/v1/inventory/production/recipes/{recipe_id}", "summary": "Update recipe", "deprecated": false }, { "slug": "duplicate-recipe", "operation_id": "duplicate_recipe", "method": "POST", "path": "/api/v1/inventory/production/recipes/{recipe_id}/duplicate", "summary": "Duplicate recipe", "deprecated": false }, { "slug": "list-runs", "operation_id": "list_runs", "method": "GET", "path": "/api/v1/inventory/production/runs", "summary": "List production runs", "deprecated": false }, { "slug": "create-run", "operation_id": "create_run", "method": "POST", "path": "/api/v1/inventory/production/runs", "summary": "Create production run", "deprecated": false }, { "slug": "get-run", "operation_id": "get_run", "method": "GET", "path": "/api/v1/inventory/production/runs/{run_id}", "summary": "Get production run", "deprecated": false }, { "slug": "update-run", "operation_id": "update_run", "method": "PUT", "path": "/api/v1/inventory/production/runs/{run_id}", "summary": "Update production run", "deprecated": false }, { "slug": "calculate-run", "operation_id": "calculate_run", "method": "POST", "path": "/api/v1/inventory/production/runs/{run_id}/calculate", "summary": "What-if calculation", "deprecated": false }, { "slug": "cancel-run", "operation_id": "cancel_run", "method": "POST", "path": "/api/v1/inventory/production/runs/{run_id}/cancel", "summary": "Cancel production run", "deprecated": false }, { "slug": "complete-run", "operation_id": "complete_run", "method": "POST", "path": "/api/v1/inventory/production/runs/{run_id}/complete", "summary": "Complete production run", "deprecated": false } ], "description": "Production orders and bill-of-materials management.", "description_html": "Production orders and bill-of-materials management.
\n" }, { "name": "inventory:products", "slug": "inventory-products", "operations": [ { "slug": "list-products", "operation_id": "list_products", "method": "GET", "path": "/api/v1/inventory/products", "summary": "List products", "deprecated": false }, { "slug": "create-product", "operation_id": "create_product", "method": "POST", "path": "/api/v1/inventory/products", "summary": "Create product", "deprecated": false }, { "slug": "lookup-variant", "operation_id": "lookup_variant", "method": "GET", "path": "/api/v1/inventory/products/lookup", "summary": "Lookup variant by barcode or SKU", "deprecated": false }, { "slug": "apply-unit-cost-bulk-update", "operation_id": "apply_unit_cost_bulk_update", "method": "POST", "path": "/api/v1/inventory/products/unit-costs/apply", "summary": "Apply unit cost bulk update", "deprecated": false }, { "slug": "export-unit-costs-csv", "operation_id": "export_unit_costs_csv", "method": "GET", "path": "/api/v1/inventory/products/unit-costs/export", "summary": "Export unit costs CSV", "deprecated": false }, { "slug": "preview-unit-cost-bulk-update", "operation_id": "preview_unit_cost_bulk_update", "method": "POST", "path": "/api/v1/inventory/products/unit-costs/preview", "summary": "Preview unit cost bulk update", "deprecated": false }, { "slug": "list-variants", "operation_id": "list_variants", "method": "GET", "path": "/api/v1/inventory/products/variants", "summary": "List product variants", "deprecated": false }, { "slug": "create-variant", "operation_id": "create_variant", "method": "POST", "path": "/api/v1/inventory/products/variants", "summary": "Create product variant", "deprecated": false }, { "slug": "delete-variant", "operation_id": "delete_variant", "method": "DELETE", "path": "/api/v1/inventory/products/variants/{id}", "summary": "Delete product variant", "deprecated": false }, { "slug": "get-variant", "operation_id": "get_variant", "method": "GET", "path": "/api/v1/inventory/products/variants/{id}", "summary": "Get product variant", "deprecated": false }, { "slug": "update-variant", "operation_id": "update_variant", "method": "PUT", "path": "/api/v1/inventory/products/variants/{id}", "summary": "Update product variant", "deprecated": false }, { "slug": "set-variant-location-quantities", "operation_id": "set_variant_location_quantities", "method": "PUT", "path": "/api/v1/inventory/products/variants/{id}/location-quantities", "summary": "Set variant location opening quantities", "deprecated": false }, { "slug": "update-reorder-settings", "operation_id": "update_reorder_settings", "method": "PATCH", "path": "/api/v1/inventory/products/variants/{variant_id}/locations/{location_id}/reorder-settings", "summary": "Update variant reorder settings at a location", "deprecated": false }, { "slug": "delete-product", "operation_id": "delete_product", "method": "DELETE", "path": "/api/v1/inventory/products/{id}", "summary": "Delete product", "deprecated": false }, { "slug": "get-product", "operation_id": "get_product", "method": "GET", "path": "/api/v1/inventory/products/{id}", "summary": "Get product", "deprecated": false }, { "slug": "update-product", "operation_id": "update_product", "method": "PUT", "path": "/api/v1/inventory/products/{id}", "summary": "Update product", "deprecated": false }, { "slug": "convert-product-to-variant", "operation_id": "convert_product_to_variant", "method": "POST", "path": "/api/v1/inventory/products/{id}/convert-to-variant", "summary": "Convert product to variant", "deprecated": false } ], "description": "Product catalog with SKUs, costs, and variants.", "description_html": "Product catalog with SKUs, costs, and variants.
\n" }, { "name": "inventory:reorder", "slug": "inventory-reorder", "operations": [ { "slug": "reorder-cash-impact", "operation_id": "reorder_cash_impact", "method": "POST", "path": "/api/v1/inventory/reorder/cash-impact", "summary": "Preview the cash impact of a reorder", "deprecated": false }, { "slug": "create-draft-reorders", "operation_id": "create_draft_reorders", "method": "POST", "path": "/api/v1/inventory/reorder/draft", "summary": "Draft purchase orders from reorder suggestions", "deprecated": false }, { "slug": "list-reorder-suggestions", "operation_id": "list_reorder_suggestions", "method": "GET", "path": "/api/v1/inventory/reorder/suggestions", "summary": "Suggest reorders from reorder points", "deprecated": false } ] }, { "name": "inventory:reports", "slug": "inventory-reports", "operations": [ { "slug": "get-adjustment-reasons", "operation_id": "get_adjustment_reasons", "method": "GET", "path": "/api/v1/inventory/reports/adjustment-reasons", "summary": "Adjustments grouped by reason", "deprecated": false }, { "slug": "get-aging", "operation_id": "get_aging", "method": "GET", "path": "/api/v1/inventory/reports/aging", "summary": "Inventory aging report", "deprecated": false }, { "slug": "get-margin-by-sku", "operation_id": "get_margin_by_sku", "method": "GET", "path": "/api/v1/inventory/reports/margin-by-sku", "summary": "Margin-by-SKU report (landed cost + sales velocity)", "deprecated": false }, { "slug": "get-valuation", "operation_id": "get_valuation", "method": "GET", "path": "/api/v1/inventory/reports/valuation", "summary": "Current inventory valuation", "deprecated": false } ] }, { "name": "inventory:shipments", "slug": "inventory-shipments", "operations": [ { "slug": "get-shipments", "operation_id": "get_shipments", "method": "GET", "path": "/api/v1/inventory/shipments", "summary": "List shipments", "deprecated": false }, { "slug": "create-shipment", "operation_id": "create_shipment", "method": "POST", "path": "/api/v1/inventory/shipments", "summary": "Create shipment", "deprecated": false }, { "slug": "delete-shipment", "operation_id": "delete_shipment", "method": "DELETE", "path": "/api/v1/inventory/shipments/{id}", "summary": "Delete shipment", "deprecated": false }, { "slug": "get-shipment", "operation_id": "get_shipment", "method": "GET", "path": "/api/v1/inventory/shipments/{id}", "summary": "Get shipment", "deprecated": false }, { "slug": "update-shipment", "operation_id": "update_shipment", "method": "PUT", "path": "/api/v1/inventory/shipments/{id}", "summary": "Update shipment", "deprecated": false } ], "description": "Inbound and outbound shipment tracking.", "description_html": "Inbound and outbound shipment tracking.
\n" }, { "name": "inventory:standard_costs", "slug": "inventory-standard-costs", "operations": [ { "slug": "standard-cost-list", "operation_id": "standard_cost_list", "method": "GET", "path": "/api/v1/inventory/cogs/standard", "summary": "List standard costs", "deprecated": false }, { "slug": "standard-cost-set", "operation_id": "standard_cost_set", "method": "PUT", "path": "/api/v1/inventory/cogs/standard", "summary": "Set standard costs", "deprecated": false }, { "slug": "standard-cogs-apply", "operation_id": "standard_cogs_apply", "method": "POST", "path": "/api/v1/inventory/cogs/standard/apply", "summary": "Draft the standard-cost COGS adjustment", "deprecated": false }, { "slug": "standard-cogs-preview", "operation_id": "standard_cogs_preview", "method": "POST", "path": "/api/v1/inventory/cogs/standard/preview", "summary": "Preview the standard-cost COGS re-rate", "deprecated": false } ] }, { "name": "inventory:supply_chain", "slug": "inventory-supply-chain", "operations": [ { "slug": "get-supply-chain-map", "operation_id": "get_supply_chain_map", "method": "GET", "path": "/api/v1/inventory/supply-chain", "summary": "Get inventory supply chain map", "deprecated": false } ] }, { "name": "inventory:transfer_suggestions", "slug": "inventory-transfer-suggestions", "operations": [ { "slug": "list-transfer-suggestions", "operation_id": "list_transfer_suggestions", "method": "GET", "path": "/api/v1/inventory/transfer-suggestions/suggestions", "summary": "Suggest site-to-site transfers", "deprecated": false } ] }, { "name": "inventory:transfers", "slug": "inventory-transfers", "operations": [ { "slug": "list-transfers", "operation_id": "list_transfers", "method": "GET", "path": "/api/v1/inventory/transfers", "summary": "List inventory transfers", "deprecated": false }, { "slug": "create-transfer", "operation_id": "create_transfer", "method": "POST", "path": "/api/v1/inventory/transfers", "summary": "Create transfer", "deprecated": false }, { "slug": "list-in-transit-transfers", "operation_id": "list_in_transit_transfers", "method": "GET", "path": "/api/v1/inventory/transfers/in-transit", "summary": "List in-transit transfers", "deprecated": false }, { "slug": "list-pending-transfers", "operation_id": "list_pending_transfers", "method": "GET", "path": "/api/v1/inventory/transfers/pending", "summary": "List pending transfers", "deprecated": false }, { "slug": "get-transfer-summary", "operation_id": "get_transfer_summary", "method": "GET", "path": "/api/v1/inventory/transfers/summary", "summary": "Get transfer summary", "deprecated": false }, { "slug": "delete-transfer", "operation_id": "delete_transfer", "method": "DELETE", "path": "/api/v1/inventory/transfers/{transfer_id}", "summary": "Delete transfer", "deprecated": false }, { "slug": "get-transfer", "operation_id": "get_transfer", "method": "GET", "path": "/api/v1/inventory/transfers/{transfer_id}", "summary": "Get transfer", "deprecated": false }, { "slug": "update-transfer", "operation_id": "update_transfer", "method": "PUT", "path": "/api/v1/inventory/transfers/{transfer_id}", "summary": "Update transfer", "deprecated": false }, { "slug": "cancel-transfer", "operation_id": "cancel_transfer", "method": "POST", "path": "/api/v1/inventory/transfers/{transfer_id}/cancel", "summary": "Cancel transfer", "deprecated": false }, { "slug": "add-transfer-item", "operation_id": "add_transfer_item", "method": "POST", "path": "/api/v1/inventory/transfers/{transfer_id}/items", "summary": "Add item to transfer", "deprecated": false }, { "slug": "remove-transfer-item", "operation_id": "remove_transfer_item", "method": "DELETE", "path": "/api/v1/inventory/transfers/{transfer_id}/items/{item_id}", "summary": "Remove item from transfer", "deprecated": false }, { "slug": "receive-transfer", "operation_id": "receive_transfer", "method": "POST", "path": "/api/v1/inventory/transfers/{transfer_id}/receive", "summary": "Receive transfer", "deprecated": false }, { "slug": "ship-transfer", "operation_id": "ship_transfer", "method": "POST", "path": "/api/v1/inventory/transfers/{transfer_id}/ship", "summary": "Ship transfer", "deprecated": false } ], "description": "Inter-location inventory transfers.", "description_html": "Inter-location inventory transfers.
\n" }, { "name": "invitations", "slug": "invitations", "operations": [ { "slug": "accept-invitation", "operation_id": "accept_invitation", "method": "POST", "path": "/api/v1/invitations/{token}/accept", "summary": "Accept a pending invitation", "deprecated": false }, { "slug": "preview-invitation", "operation_id": "preview_invitation", "method": "GET", "path": "/api/v1/invitations/{token}/preview", "summary": "Preview invitation details (public)", "deprecated": false } ] }, { "name": "invoices", "slug": "invoices", "operations": [ { "slug": "get-invoices", "operation_id": "get_invoices", "method": "GET", "path": "/api/v1/invoices", "summary": "List invoices", "deprecated": false }, { "slug": "create-invoice", "operation_id": "create_invoice", "method": "POST", "path": "/api/v1/invoices", "summary": "Create invoice", "deprecated": false }, { "slug": "get-invoice-aging", "operation_id": "get_invoice_aging", "method": "GET", "path": "/api/v1/invoices/aging", "summary": "AR aging summary", "deprecated": false }, { "slug": "ai-create-invoice-payload", "operation_id": "ai_create_invoice_payload", "method": "POST", "path": "/api/v1/invoices/ai-create", "summary": "AI-extract draft invoices from documents", "deprecated": false }, { "slug": "create-batch-invoices", "operation_id": "create_batch_invoices", "method": "POST", "path": "/api/v1/invoices/batch", "summary": "Batch create invoices", "deprecated": false }, { "slug": "get-bulk-invoices", "operation_id": "get_bulk_invoices", "method": "GET", "path": "/api/v1/invoices/bulk", "summary": "List all invoices (bulk)", "deprecated": false }, { "slug": "create-bulk-invoices", "operation_id": "create_bulk_invoices", "method": "POST", "path": "/api/v1/invoices/bulk", "summary": "Bulk create invoices", "deprecated": false }, { "slug": "bulk-mark-invoices-paid", "operation_id": "bulk_mark_invoices_paid", "method": "POST", "path": "/api/v1/invoices/bulk-payments", "summary": "Bulk mark invoices paid", "deprecated": false }, { "slug": "get-cash-receipts", "operation_id": "get_cash_receipts", "method": "GET", "path": "/api/v1/invoices/cash-receipts", "summary": "Weekly cash receipts reconciliation", "deprecated": false }, { "slug": "dismiss-cash-receipt", "operation_id": "dismiss_cash_receipt", "method": "POST", "path": "/api/v1/invoices/cash-receipts/dismiss", "summary": "Dismiss a transaction from cash receipts", "deprecated": false }, { "slug": "restore-cash-receipt", "operation_id": "restore_cash_receipt", "method": "POST", "path": "/api/v1/invoices/cash-receipts/restore", "summary": "Restore a dismissed cash receipt", "deprecated": false }, { "slug": "get-cash-receipts-week-detail", "operation_id": "get_cash_receipts_week_detail", "method": "GET", "path": "/api/v1/invoices/cash-receipts/week-detail", "summary": "Cash receipts week detail", "deprecated": false }, { "slug": "get-invoice-collections", "operation_id": "get_invoice_collections", "method": "GET", "path": "/api/v1/invoices/collections", "summary": "AR collections dashboard", "deprecated": false }, { "slug": "update-collection-settings", "operation_id": "update_collection_settings", "method": "PATCH", "path": "/api/v1/invoices/collections/settings", "summary": "Update collections settings", "deprecated": false }, { "slug": "list-deposit-candidates", "operation_id": "list_deposit_candidates", "method": "GET", "path": "/api/v1/invoices/deposit-candidates", "summary": "List deposit candidates", "deprecated": false }, { "slug": "bulk-delete-draft-invoices", "operation_id": "bulk_delete_draft_invoices", "method": "POST", "path": "/api/v1/invoices/drafts/bulk-delete", "summary": "Bulk delete draft invoices", "deprecated": false }, { "slug": "trigger-matching", "operation_id": "trigger_matching", "method": "POST", "path": "/api/v1/invoices/match", "summary": "Trigger payment matching", "deprecated": false }, { "slug": "get-invoice-metrics", "operation_id": "get_invoice_metrics", "method": "GET", "path": "/api/v1/invoices/metrics", "summary": "Get invoice metrics", "deprecated": false }, { "slug": "get-scheduled-invoices", "operation_id": "get_scheduled_invoices", "method": "GET", "path": "/api/v1/invoices/scheduled", "summary": "Upcoming scheduled invoices", "deprecated": false }, { "slug": "list-suggestions", "operation_id": "list_suggestions", "method": "GET", "path": "/api/v1/invoices/suggestions", "summary": "List payment suggestions", "deprecated": false }, { "slug": "accept-suggestion", "operation_id": "accept_suggestion", "method": "POST", "path": "/api/v1/invoices/suggestions/{suggestion_id}/accept", "summary": "Accept payment suggestion", "deprecated": false }, { "slug": "reject-suggestion", "operation_id": "reject_suggestion", "method": "POST", "path": "/api/v1/invoices/suggestions/{suggestion_id}/reject", "summary": "Reject payment suggestion", "deprecated": false }, { "slug": "delete-invoice", "operation_id": "delete_invoice", "method": "DELETE", "path": "/api/v1/invoices/{invoice_id}", "summary": "Delete invoice", "deprecated": false }, { "slug": "get-invoice", "operation_id": "get_invoice", "method": "GET", "path": "/api/v1/invoices/{invoice_id}", "summary": "Get invoice", "deprecated": false }, { "slug": "update-invoice", "operation_id": "update_invoice", "method": "PUT", "path": "/api/v1/invoices/{invoice_id}", "summary": "Update invoice", "deprecated": false }, { "slug": "mark-invoice-delivered", "operation_id": "mark_invoice_delivered", "method": "PUT", "path": "/api/v1/invoices/{invoice_id}/delivered", "summary": "Mark Invoice Delivered", "deprecated": false }, { "slug": "finalize-invoice", "operation_id": "finalize_invoice", "method": "PUT", "path": "/api/v1/invoices/{invoice_id}/finalize", "summary": "Finalize invoice", "deprecated": false }, { "slug": "generate-invoice-journal-entry", "operation_id": "generate_invoice_journal_entry", "method": "POST", "path": "/api/v1/invoices/{invoice_id}/journal-entry", "summary": "Generate invoice journal entry", "deprecated": false }, { "slug": "attach-journal-entry-to-invoice", "operation_id": "attach_journal_entry_to_invoice", "method": "POST", "path": "/api/v1/invoices/{invoice_id}/journal-entry/link", "summary": "Attach journal entry to invoice", "deprecated": false }, { "slug": "mark-invoice-paid", "operation_id": "mark_invoice_paid", "method": "PUT", "path": "/api/v1/invoices/{invoice_id}/paid", "summary": "Mark Invoice Paid", "deprecated": false }, { "slug": "get-invoice-payment-link", "operation_id": "get_invoice_payment_link", "method": "GET", "path": "/api/v1/invoices/{invoice_id}/payment-link", "summary": "Get invoice payment link", "deprecated": false }, { "slug": "list-invoice-payments", "operation_id": "list_invoice_payments", "method": "GET", "path": "/api/v1/invoices/{invoice_id}/payments", "summary": "List invoice payments", "deprecated": false }, { "slug": "create-invoice-payment", "operation_id": "create_invoice_payment", "method": "POST", "path": "/api/v1/invoices/{invoice_id}/payments", "summary": "Add payment to invoice", "deprecated": false }, { "slug": "delete-invoice-payment", "operation_id": "delete_invoice_payment", "method": "DELETE", "path": "/api/v1/invoices/{invoice_id}/payments/{payment_id}", "summary": "Remove payment from invoice", "deprecated": false }, { "slug": "update-invoice-payment", "operation_id": "update_invoice_payment", "method": "PATCH", "path": "/api/v1/invoices/{invoice_id}/payments/{payment_id}", "summary": "Update payment on invoice", "deprecated": false }, { "slug": "move-invoice-payment", "operation_id": "move_invoice_payment", "method": "POST", "path": "/api/v1/invoices/{invoice_id}/payments/{payment_id}/move", "summary": "Move payment to another invoice", "deprecated": false }, { "slug": "get-invoice-pdf-url", "operation_id": "get_invoice_pdf_url", "method": "GET", "path": "/api/v1/invoices/{invoice_id}/pdf", "summary": "Get fresh invoice PDF URL", "deprecated": false }, { "slug": "download-internal-invoice-pdf", "operation_id": "download_internal_invoice_pdf", "method": "GET", "path": "/api/v1/invoices/{invoice_id}/pdf/internal", "summary": "Download DayZero-generated invoice PDF", "deprecated": false }, { "slug": "send-invoice-email", "operation_id": "send_invoice_email", "method": "POST", "path": "/api/v1/invoices/{invoice_id}/send", "summary": "Send invoice via email", "deprecated": false }, { "slug": "sync-invoice-from-stripe", "operation_id": "sync_invoice_from_stripe", "method": "POST", "path": "/api/v1/invoices/{invoice_id}/stripe/sync", "summary": "Check invoice payment in Stripe", "deprecated": false }, { "slug": "list-invoice-suggestions", "operation_id": "list_invoice_suggestions", "method": "GET", "path": "/api/v1/invoices/{invoice_id}/suggestions", "summary": "List suggestions for invoice", "deprecated": false }, { "slug": "mark-invoice-uncollectible", "operation_id": "mark_invoice_uncollectible", "method": "PUT", "path": "/api/v1/invoices/{invoice_id}/uncollectible", "summary": "Mark invoice uncollectible", "deprecated": false }, { "slug": "mark-invoice-unpaid", "operation_id": "mark_invoice_unpaid", "method": "PUT", "path": "/api/v1/invoices/{invoice_id}/unpaid", "summary": "Mark Invoice Unpaid", "deprecated": false }, { "slug": "void-invoice", "operation_id": "void_invoice", "method": "PUT", "path": "/api/v1/invoices/{invoice_id}/void", "summary": "Void invoice", "deprecated": false } ], "description": "Accounts receivable — create, finalize, and track invoice payments.", "description_html": "Accounts receivable — create, finalize, and track invoice payments.
\n" }, { "name": "journal-entries", "slug": "journal-entries", "operations": [ { "slug": "get-journal-entries", "operation_id": "get_journal_entries", "method": "GET", "path": "/api/v1/journal-entries", "summary": "List journal entries", "deprecated": false }, { "slug": "create-journal-entry", "operation_id": "create_journal_entry", "method": "POST", "path": "/api/v1/journal-entries", "summary": "Create journal entry", "deprecated": false }, { "slug": "post-bulk-je-upload", "operation_id": "post_bulk_je_upload", "method": "POST", "path": "/api/v1/journal-entries/bulk-upload/post", "summary": "Post bulk journal entries", "deprecated": false }, { "slug": "preview-bulk-je-upload", "operation_id": "preview_bulk_je_upload", "method": "POST", "path": "/api/v1/journal-entries/bulk-upload/preview", "summary": "Preview bulk journal entry upload", "deprecated": false }, { "slug": "download-bulk-je-upload-template", "operation_id": "download_bulk_je_upload_template", "method": "GET", "path": "/api/v1/journal-entries/bulk-upload/template", "summary": "Download bulk JE upload template", "deprecated": false }, { "slug": "delete-journal-entry", "operation_id": "delete_journal_entry", "method": "DELETE", "path": "/api/v1/journal-entries/{journal_entry_id}", "summary": "Delete journal entry", "deprecated": false }, { "slug": "get-journal-entry", "operation_id": "get_journal_entry", "method": "GET", "path": "/api/v1/journal-entries/{journal_entry_id}", "summary": "Get journal entry", "deprecated": false }, { "slug": "update-journal-entry", "operation_id": "update_journal_entry", "method": "PUT", "path": "/api/v1/journal-entries/{journal_entry_id}", "summary": "Update journal entry", "deprecated": false }, { "slug": "attach-file-to-journal-entry", "operation_id": "attach_file_to_journal_entry", "method": "PATCH", "path": "/api/v1/journal-entries/{journal_entry_id}/attachment", "summary": "Attach file to journal entry", "deprecated": false }, { "slug": "reverse-journal-entry", "operation_id": "reverse_journal_entry", "method": "POST", "path": "/api/v1/journal-entries/{journal_entry_id}/reverse", "summary": "Reverse journal entry", "deprecated": false } ], "description": "Double-entry bookkeeping with balanced debit/credit lines.", "description_html": "Double-entry bookkeeping with balanced debit/credit lines.
\n" }, { "name": "ledgers", "slug": "ledgers", "operations": [ { "slug": "get-ledgers", "operation_id": "get_ledgers", "method": "GET", "path": "/api/v1/ledgers", "summary": "List ledgers", "deprecated": false }, { "slug": "create-ledger", "operation_id": "create_ledger", "method": "POST", "path": "/api/v1/ledgers", "summary": "Create ledger", "deprecated": false }, { "slug": "apply-coa", "operation_id": "apply_coa", "method": "POST", "path": "/api/v1/ledgers/apply-coa", "summary": "Apply AI-generated COA", "deprecated": false }, { "slug": "bulk-update-ledgers", "operation_id": "bulk_update_ledgers", "method": "POST", "path": "/api/v1/ledgers/bulk-update", "summary": "Bulk update ledgers", "deprecated": false }, { "slug": "get-ledger-deletion-status", "operation_id": "get_ledger_deletion_status", "method": "GET", "path": "/api/v1/ledgers/deletion-status/{workflow_id}", "summary": "Get ledger deletion status", "deprecated": false }, { "slug": "merge-ledgers", "operation_id": "merge_ledgers", "method": "POST", "path": "/api/v1/ledgers/merge", "summary": "Merge ledgers", "deprecated": false }, { "slug": "suggest-cash-flow", "operation_id": "suggest_cash_flow", "method": "POST", "path": "/api/v1/ledgers/suggest-cash-flow", "summary": "Suggest cash flow classifications", "deprecated": false }, { "slug": "suggest-cleanup", "operation_id": "suggest_cleanup", "method": "POST", "path": "/api/v1/ledgers/suggest-cleanup", "summary": "AI account cleanup suggestions", "deprecated": false }, { "slug": "delete-ledger", "operation_id": "delete_ledger", "method": "DELETE", "path": "/api/v1/ledgers/{ledger_id}", "summary": "Delete ledger", "deprecated": false }, { "slug": "get-ledger", "operation_id": "get_ledger_ledgers", "method": "GET", "path": "/api/v1/ledgers/{ledger_id}", "summary": "Get ledger", "deprecated": false }, { "slug": "update-ledger", "operation_id": "update_ledger", "method": "PUT", "path": "/api/v1/ledgers/{ledger_id}", "summary": "Update ledger", "deprecated": false }, { "slug": "cascade-delete-ledger", "operation_id": "cascade_delete_ledger", "method": "DELETE", "path": "/api/v1/ledgers/{ledger_id}/cascade", "summary": "Cascade delete ledger", "deprecated": false }, { "slug": "preview-ledger-cascade-delete", "operation_id": "preview_ledger_cascade_delete", "method": "GET", "path": "/api/v1/ledgers/{ledger_id}/cascade-preview", "summary": "Preview ledger cascade delete", "deprecated": false } ], "description": "Chart of accounts — asset, liability, equity, revenue, and expense accounts.", "description_html": "Chart of accounts — asset, liability, equity, revenue, and expense accounts.
\n" }, { "name": "loans", "slug": "loans", "operations": [ { "slug": "run-loan-interest-accruals", "operation_id": "run_loan_interest_accruals", "method": "POST", "path": "/api/v1/loans/accrue-interest", "summary": "Run interest accrual across all active loans", "deprecated": false }, { "slug": "get-loan-subledger-summary", "operation_id": "get_loan_subledger_summary", "method": "GET", "path": "/api/v1/loans/subledger", "summary": "Loan subledger summary grouped by counterparty", "deprecated": false }, { "slug": "accrue-loan-interest", "operation_id": "accrue_loan_interest", "method": "POST", "path": "/api/v1/loans/{instrument_id}/accrue-interest", "summary": "Accrue interest on one loan", "deprecated": false }, { "slug": "update-loan-counterparty", "operation_id": "update_loan_counterparty", "method": "PATCH", "path": "/api/v1/loans/{instrument_id}/counterparty", "summary": "Re-tag a loan's counterparty type", "deprecated": false }, { "slug": "record-loan-disbursement", "operation_id": "record_loan_disbursement", "method": "POST", "path": "/api/v1/loans/{instrument_id}/disbursements", "summary": "Record an additional loan disbursement", "deprecated": false }, { "slug": "get-loan-register", "operation_id": "get_loan_register", "method": "GET", "path": "/api/v1/loans/{instrument_id}/subledger", "summary": "Get a loan's subledger register", "deprecated": false }, { "slug": "write-off-loan", "operation_id": "write_off_loan", "method": "POST", "path": "/api/v1/loans/{instrument_id}/write-off", "summary": "Write off a loan", "deprecated": false } ] }, { "name": "managerial-key-mappings", "slug": "managerial-key-mappings", "operations": [ { "slug": "get-managerial-key-mapping-table", "operation_id": "get_managerial_key_mapping_table", "method": "GET", "path": "/api/v1/businesses/{business_id}/managerial-key-mappings", "summary": "Get the managerial key mapping table", "deprecated": false }, { "slug": "upsert-managerial-key-mappings", "operation_id": "upsert_managerial_key_mappings", "method": "PUT", "path": "/api/v1/businesses/{business_id}/managerial-key-mappings", "summary": "Bulk upsert managerial key mappings", "deprecated": false }, { "slug": "export-managerial-key-mappings-csv", "operation_id": "export_managerial_key_mappings_csv", "method": "GET", "path": "/api/v1/businesses/{business_id}/managerial-key-mappings/export.csv", "summary": "Export the managerial key mapping table as CSV", "deprecated": false }, { "slug": "list-managerial-key-types", "operation_id": "list_managerial_key_types", "method": "GET", "path": "/api/v1/businesses/{business_id}/managerial-key-mappings/key-types", "summary": "List managerial key types", "deprecated": false }, { "slug": "create-managerial-key-type", "operation_id": "create_managerial_key_type", "method": "POST", "path": "/api/v1/businesses/{business_id}/managerial-key-mappings/key-types", "summary": "Create a managerial key type", "deprecated": false }, { "slug": "delete-managerial-key-type", "operation_id": "delete_managerial_key_type", "method": "DELETE", "path": "/api/v1/businesses/{business_id}/managerial-key-mappings/key-types/{key}", "summary": "Delete a managerial key type", "deprecated": false }, { "slug": "update-managerial-key-type", "operation_id": "update_managerial_key_type", "method": "PUT", "path": "/api/v1/businesses/{business_id}/managerial-key-mappings/key-types/{key}", "summary": "Update a managerial key type", "deprecated": false } ] }, { "name": "mcp-approvals", "slug": "mcp-approvals", "operations": [ { "slug": "get-mcp-approval", "operation_id": "get_mcp_approval", "method": "GET", "path": "/api/v1/mcp-approvals/{approval_id}", "summary": "Get a waiting MCP write", "deprecated": false }, { "slug": "decide-mcp-approval", "operation_id": "decide_mcp_approval", "method": "POST", "path": "/api/v1/mcp-approvals/{approval_id}/decision", "summary": "Approve or decline a waiting MCP write", "deprecated": false } ] }, { "name": "mcp-connections", "slug": "mcp-connections", "operations": [ { "slug": "list-mcp-connections", "operation_id": "list_mcp_connections", "method": "GET", "path": "/api/v1/mcp-connections/connections", "summary": "List MCP connections", "deprecated": false }, { "slug": "create-mcp-connection", "operation_id": "create_mcp_connection", "method": "POST", "path": "/api/v1/mcp-connections/connections", "summary": "Connect an MCP server", "deprecated": false }, { "slug": "delete-mcp-connection", "operation_id": "delete_mcp_connection", "method": "DELETE", "path": "/api/v1/mcp-connections/connections/{connection_id}", "summary": "Disconnect an MCP server", "deprecated": false }, { "slug": "get-mcp-connection", "operation_id": "get_mcp_connection", "method": "GET", "path": "/api/v1/mcp-connections/connections/{connection_id}", "summary": "Get an MCP connection", "deprecated": false }, { "slug": "update-mcp-connection", "operation_id": "update_mcp_connection", "method": "PATCH", "path": "/api/v1/mcp-connections/connections/{connection_id}", "summary": "Update an MCP connection", "deprecated": false }, { "slug": "refresh-mcp-connection-tools", "operation_id": "refresh_mcp_connection_tools", "method": "POST", "path": "/api/v1/mcp-connections/connections/{connection_id}/refresh-tools", "summary": "Refresh an MCP server's tool list", "deprecated": false }, { "slug": "mcp-oauth-callback", "operation_id": "mcp_oauth_callback", "method": "GET", "path": "/api/v1/mcp-connections/oauth/callback", "summary": "External MCP OAuth callback", "deprecated": false }, { "slug": "start-mcp-oauth", "operation_id": "start_mcp_oauth", "method": "POST", "path": "/api/v1/mcp-connections/oauth/start", "summary": "Start OAuth for an MCP server", "deprecated": false } ] }, { "name": "meta-ads", "slug": "meta-ads", "operations": [ { "slug": "meta-ads-list-accounts", "operation_id": "meta_ads_list_accounts", "method": "GET", "path": "/api/v1/meta-ads/accounts", "summary": "List Meta ad accounts", "deprecated": false }, { "slug": "meta-ads-refresh-accounts", "operation_id": "meta_ads_refresh_accounts", "method": "POST", "path": "/api/v1/meta-ads/accounts/refresh", "summary": "Re-list Meta ad accounts", "deprecated": false }, { "slug": "meta-ads-update-account", "operation_id": "meta_ads_update_account", "method": "PATCH", "path": "/api/v1/meta-ads/accounts/{account_id}", "summary": "Update a Meta ad account's sync setting", "deprecated": false }, { "slug": "meta-ads-connect-url", "operation_id": "meta_ads_connect_url", "method": "GET", "path": "/api/v1/meta-ads/connect-url", "summary": "Get Meta Ads connect URL", "deprecated": false }, { "slug": "meta-ads-disconnect", "operation_id": "meta_ads_disconnect", "method": "DELETE", "path": "/api/v1/meta-ads/disconnect", "summary": "Disconnect Meta Ads", "deprecated": false }, { "slug": "meta-ads-oauth-callback", "operation_id": "meta_ads_oauth_callback", "method": "GET", "path": "/api/v1/meta-ads/oauth/callback", "summary": "Meta Ads OAuth callback", "deprecated": false }, { "slug": "meta-ads-update-settings", "operation_id": "meta_ads_update_settings", "method": "PATCH", "path": "/api/v1/meta-ads/settings", "summary": "Update Meta Ads sync settings", "deprecated": false }, { "slug": "meta-ads-spend", "operation_id": "meta_ads_spend", "method": "GET", "path": "/api/v1/meta-ads/spend", "summary": "Meta ad spend", "deprecated": false }, { "slug": "meta-ads-status", "operation_id": "meta_ads_status", "method": "GET", "path": "/api/v1/meta-ads/status", "summary": "Meta Ads connection status", "deprecated": false }, { "slug": "meta-ads-sync", "operation_id": "meta_ads_sync", "method": "POST", "path": "/api/v1/meta-ads/sync", "summary": "Pull Meta ad spend", "deprecated": false } ] }, { "name": "mileage", "slug": "mileage", "operations": [ { "slug": "list-mileage-trips", "operation_id": "list_mileage_trips", "method": "GET", "path": "/api/v1/mileage", "summary": "List mileage trips", "deprecated": false }, { "slug": "create-mileage-trip", "operation_id": "create_mileage_trip", "method": "POST", "path": "/api/v1/mileage", "summary": "Create mileage trip", "deprecated": false }, { "slug": "add-trips-to-expense-report", "operation_id": "add_trips_to_expense_report", "method": "POST", "path": "/api/v1/mileage/add-to-expense-report", "summary": "Add trips to an expense report", "deprecated": false }, { "slug": "export-mileage-csv", "operation_id": "export_mileage_csv", "method": "GET", "path": "/api/v1/mileage/export", "summary": "Export trips as CSV", "deprecated": false }, { "slug": "post-mileage-trips", "operation_id": "post_mileage_trips", "method": "POST", "path": "/api/v1/mileage/post", "summary": "Post trips as expense journal entries", "deprecated": false }, { "slug": "list-mileage-rates", "operation_id": "list_mileage_rates", "method": "GET", "path": "/api/v1/mileage/rates", "summary": "List mileage rates", "deprecated": false }, { "slug": "delete-mileage-rate", "operation_id": "delete_mileage_rate", "method": "DELETE", "path": "/api/v1/mileage/rates/{year}", "summary": "Remove mileage rate for a year", "deprecated": false }, { "slug": "get-mileage-rate", "operation_id": "get_mileage_rate", "method": "GET", "path": "/api/v1/mileage/rates/{year}", "summary": "Get mileage rate for a year", "deprecated": false }, { "slug": "set-mileage-rate", "operation_id": "set_mileage_rate", "method": "PUT", "path": "/api/v1/mileage/rates/{year}", "summary": "Set mileage rate for a year", "deprecated": false }, { "slug": "delete-mileage-trip", "operation_id": "delete_mileage_trip", "method": "DELETE", "path": "/api/v1/mileage/{trip_id}", "summary": "Delete mileage trip", "deprecated": false }, { "slug": "get-mileage-trip", "operation_id": "get_mileage_trip", "method": "GET", "path": "/api/v1/mileage/{trip_id}", "summary": "Get mileage trip", "deprecated": false }, { "slug": "update-mileage-trip", "operation_id": "update_mileage_trip", "method": "PUT", "path": "/api/v1/mileage/{trip_id}", "summary": "Update mileage trip", "deprecated": false } ] }, { "name": "month-end-packages", "slug": "month-end-packages", "operations": [ { "slug": "list-packages", "operation_id": "list_packages", "method": "GET", "path": "/api/v1/month-end-packages", "summary": "List month-end packages", "deprecated": false }, { "slug": "create-package", "operation_id": "create_package", "method": "POST", "path": "/api/v1/month-end-packages", "summary": "Queue a month-end package build", "deprecated": false }, { "slug": "get-package", "operation_id": "get_package", "method": "GET", "path": "/api/v1/month-end-packages/{package_id}", "summary": "Get month-end package", "deprecated": false }, { "slug": "get-download-url", "operation_id": "get_download_url", "method": "GET", "path": "/api/v1/month-end-packages/{package_id}/download", "summary": "Get download URL", "deprecated": false } ] }, { "name": "notes", "slug": "notes", "operations": [ { "slug": "list-notes", "operation_id": "list_notes", "method": "GET", "path": "/api/v1/notes", "summary": "List notes for a business", "deprecated": false }, { "slug": "create-note", "operation_id": "create_note", "method": "POST", "path": "/api/v1/notes", "summary": "Create a note", "deprecated": false }, { "slug": "create-notes-bulk", "operation_id": "create_notes_bulk", "method": "POST", "path": "/api/v1/notes/bulk", "summary": "Bulk-create notes (localStorage migration)", "deprecated": false }, { "slug": "delete-reminder", "operation_id": "delete_reminder", "method": "DELETE", "path": "/api/v1/notes/reminders/{reminder_id}", "summary": "Cancel a reminder", "deprecated": false }, { "slug": "delete-note", "operation_id": "delete_note", "method": "DELETE", "path": "/api/v1/notes/{note_id}", "summary": "Delete a note", "deprecated": false }, { "slug": "get-note", "operation_id": "get_note", "method": "GET", "path": "/api/v1/notes/{note_id}", "summary": "Get a single note", "deprecated": false }, { "slug": "update-note", "operation_id": "update_note", "method": "PATCH", "path": "/api/v1/notes/{note_id}", "summary": "Update a note", "deprecated": false }, { "slug": "create-attachment", "operation_id": "create_attachment", "method": "POST", "path": "/api/v1/notes/{note_id}/attachments", "summary": "Register note attachment", "deprecated": false }, { "slug": "get-attachment-upload-url", "operation_id": "get_attachment_upload_url", "method": "POST", "path": "/api/v1/notes/{note_id}/attachments/upload-url", "summary": "Get upload URL for note attachment", "deprecated": false }, { "slug": "delete-attachment", "operation_id": "delete_attachment", "method": "DELETE", "path": "/api/v1/notes/{note_id}/attachments/{attachment_id}", "summary": "Delete note attachment", "deprecated": false }, { "slug": "get-attachment-download-url", "operation_id": "get_attachment_download_url", "method": "GET", "path": "/api/v1/notes/{note_id}/attachments/{attachment_id}/download-url", "summary": "Get download URL for note attachment", "deprecated": false }, { "slug": "notify-business", "operation_id": "notify_business", "method": "POST", "path": "/api/v1/notes/{note_id}/notify", "summary": "Notify business users about a note", "deprecated": false }, { "slug": "list-reminders", "operation_id": "list_reminders", "method": "GET", "path": "/api/v1/notes/{note_id}/reminders", "summary": "List reminders for a note", "deprecated": false }, { "slug": "create-reminder", "operation_id": "create_reminder", "method": "POST", "path": "/api/v1/notes/{note_id}/reminders", "summary": "Schedule a reminder for a note", "deprecated": false }, { "slug": "rewrite-note", "operation_id": "rewrite_note", "method": "POST", "path": "/api/v1/notes/{note_id}/rewrite", "summary": "AI rewrite of note body", "deprecated": false } ], "description": "Internal notes attached to businesses and entities.", "description_html": "Internal notes attached to businesses and entities.
\n" }, { "name": "notification-preferences", "slug": "notification-preferences", "operations": [ { "slug": "get-topic-overrides-endpoint", "operation_id": "get_topic_overrides_endpoint", "method": "GET", "path": "/api/v1/preferences/notifications/topics", "summary": "Get Topic Overrides Endpoint", "deprecated": false }, { "slug": "update-topic-overrides-endpoint", "operation_id": "update_topic_overrides_endpoint", "method": "PUT", "path": "/api/v1/preferences/notifications/topics", "summary": "Update Topic Overrides Endpoint", "deprecated": false } ], "description": "Manage email and in-app notification settings.", "description_html": "Manage email and in-app notification settings.
\n" }, { "name": "notifications", "slug": "notifications", "operations": [ { "slug": "list-notifications", "operation_id": "list_notifications", "method": "GET", "path": "/api/v1/notifications", "summary": "List notifications", "deprecated": false }, { "slug": "bulk-dismiss", "operation_id": "bulk_dismiss", "method": "POST", "path": "/api/v1/notifications/bulk/dismiss", "summary": "Bulk dismiss", "deprecated": false }, { "slug": "bulk-mark-seen", "operation_id": "bulk_mark_seen", "method": "POST", "path": "/api/v1/notifications/bulk/seen", "summary": "Bulk mark seen", "deprecated": false }, { "slug": "open-count", "operation_id": "open_count", "method": "GET", "path": "/api/v1/notifications/count", "summary": "Notification count", "deprecated": false }, { "slug": "dismiss-all", "operation_id": "dismiss_all", "method": "POST", "path": "/api/v1/notifications/dismiss-all", "summary": "Dismiss all matching notifications", "deprecated": false }, { "slug": "mark-all-seen", "operation_id": "mark_all_seen", "method": "POST", "path": "/api/v1/notifications/mark-all-seen", "summary": "Mark all matching notifications seen", "deprecated": false }, { "slug": "stream-notifications", "operation_id": "stream_notifications", "method": "GET", "path": "/api/v1/notifications/stream", "summary": "Stream notifications (SSE)", "deprecated": false }, { "slug": "topic-counts", "operation_id": "topic_counts", "method": "GET", "path": "/api/v1/notifications/topic-counts", "summary": "Per-topic notification counts", "deprecated": false }, { "slug": "get-notification", "operation_id": "get_notification", "method": "GET", "path": "/api/v1/notifications/{notification_id}", "summary": "Get a single notification", "deprecated": false }, { "slug": "dismiss", "operation_id": "dismiss", "method": "POST", "path": "/api/v1/notifications/{notification_id}/dismiss", "summary": "Dismiss a notification", "deprecated": false }, { "slug": "set-pinned", "operation_id": "set_pinned", "method": "PUT", "path": "/api/v1/notifications/{notification_id}/pin", "summary": "Pin or unpin a notification", "deprecated": false }, { "slug": "resolve", "operation_id": "resolve", "method": "POST", "path": "/api/v1/notifications/{notification_id}/resolve", "summary": "Resolve a notification", "deprecated": false }, { "slug": "mark-seen", "operation_id": "mark_seen", "method": "POST", "path": "/api/v1/notifications/{notification_id}/seen", "summary": "Mark notification as seen", "deprecated": false }, { "slug": "snooze", "operation_id": "snooze", "method": "POST", "path": "/api/v1/notifications/{notification_id}/snooze", "summary": "Snooze a notification", "deprecated": false } ] }, { "name": "o2c-webhooks", "slug": "o2c-webhooks", "operations": [ { "slug": "list-webhook-endpoints", "operation_id": "list_webhook_endpoints", "method": "GET", "path": "/api/v1/webhooks/o2c", "summary": "List outbound webhook endpoints", "deprecated": false }, { "slug": "create-webhook-endpoint", "operation_id": "create_webhook_endpoint", "method": "POST", "path": "/api/v1/webhooks/o2c", "summary": "Register an outbound webhook endpoint", "deprecated": false }, { "slug": "list-webhook-event-types", "operation_id": "list_webhook_event_types", "method": "GET", "path": "/api/v1/webhooks/o2c/event-types", "summary": "List subscribable webhook event types", "deprecated": false }, { "slug": "delete-webhook-endpoint", "operation_id": "delete_webhook_endpoint", "method": "DELETE", "path": "/api/v1/webhooks/o2c/{endpoint_id}", "summary": "Delete a webhook endpoint", "deprecated": false }, { "slug": "get-webhook-endpoint", "operation_id": "get_webhook_endpoint", "method": "GET", "path": "/api/v1/webhooks/o2c/{endpoint_id}", "summary": "Get a webhook endpoint", "deprecated": false }, { "slug": "update-webhook-endpoint", "operation_id": "update_webhook_endpoint", "method": "PATCH", "path": "/api/v1/webhooks/o2c/{endpoint_id}", "summary": "Change a webhook endpoint", "deprecated": false }, { "slug": "list-webhook-deliveries", "operation_id": "list_webhook_deliveries", "method": "GET", "path": "/api/v1/webhooks/o2c/{endpoint_id}/deliveries", "summary": "List an endpoint's delivery history", "deprecated": false }, { "slug": "redeliver-webhook-delivery", "operation_id": "redeliver_webhook_delivery", "method": "POST", "path": "/api/v1/webhooks/o2c/{endpoint_id}/deliveries/{delivery_id}/redeliver", "summary": "Redeliver a webhook delivery", "deprecated": false }, { "slug": "rotate-webhook-secret", "operation_id": "rotate_webhook_secret", "method": "POST", "path": "/api/v1/webhooks/o2c/{endpoint_id}/rotate-secret", "summary": "Rotate an endpoint's signing secret", "deprecated": false }, { "slug": "test-fire-webhook", "operation_id": "test_fire_webhook", "method": "POST", "path": "/api/v1/webhooks/o2c/{endpoint_id}/test-fire", "summary": "Fire a test event", "deprecated": false }, { "slug": "slack-o2c-hours-webhook", "operation_id": "slack_o2c_hours_webhook", "method": "POST", "path": "/api/v1/webhooks/slack/o2c-hours", "summary": "Slack webhook: inbound O2C hours submission", "deprecated": false } ] }, { "name": "oauth", "slug": "oauth", "operations": [ { "slug": "exchange-code", "operation_id": "exchange_code", "method": "POST", "path": "/api/v1/oauth2/exchange", "summary": "Exchange Code", "deprecated": false }, { "slug": "issue-partner-token", "operation_id": "issue_partner_token", "method": "POST", "path": "/api/v1/oauth2/partner/token", "summary": "Partner client-credentials token", "deprecated": false }, { "slug": "refresh-token", "operation_id": "refresh_token", "method": "POST", "path": "/api/v1/oauth2/refresh", "summary": "Refresh Token", "deprecated": false }, { "slug": "get-token", "operation_id": "get_token", "method": "POST", "path": "/api/v1/oauth2/token", "summary": "Get Token", "deprecated": false } ], "description": "OAuth 2.0 authorization code flow for third-party integrations.", "description_html": "OAuth 2.0 authorization code flow for third-party integrations.
\n" }, { "name": "oauth-grants", "slug": "oauth-grants", "operations": [ { "slug": "list-oauth-grants", "operation_id": "list_oauth_grants", "method": "GET", "path": "/api/v1/oauth/grants", "summary": "List connected apps", "deprecated": false }, { "slug": "revoke-oauth-grant", "operation_id": "revoke_oauth_grant", "method": "DELETE", "path": "/api/v1/oauth/grants/{grant_id}", "summary": "Revoke connected app", "deprecated": false }, { "slug": "revoke-oauth-grant-post", "operation_id": "revoke_oauth_grant_post", "method": "POST", "path": "/api/v1/oauth/grants/{grant_id}/revoke", "summary": "Revoke connected app", "deprecated": false } ] }, { "name": "onboarding", "slug": "onboarding", "operations": [ { "slug": "ai-discover", "operation_id": "ai_discover", "method": "POST", "path": "/api/v1/onboarding/ai-discover", "summary": "Get next AI discovery question", "deprecated": false }, { "slug": "ai-recommend", "operation_id": "ai_recommend", "method": "POST", "path": "/api/v1/onboarding/ai-recommend", "summary": "Generate personalised add-on recommendations", "deprecated": false }, { "slug": "complete-onboarding", "operation_id": "complete_onboarding", "method": "POST", "path": "/api/v1/onboarding/complete", "summary": "Complete onboarding after Stripe Checkout", "deprecated": false }, { "slug": "prepare-checkout", "operation_id": "prepare_checkout", "method": "POST", "path": "/api/v1/onboarding/prepare-checkout", "summary": "Create Stripe Checkout session for onboarding", "deprecated": false }, { "slug": "get-onboarding-profile", "operation_id": "get_onboarding_profile", "method": "GET", "path": "/api/v1/onboarding/profile", "summary": "Resume in-progress onboarding", "deprecated": false }, { "slug": "get-onboarding-upload-url", "operation_id": "get_onboarding_upload_url", "method": "POST", "path": "/api/v1/onboarding/upload-url", "summary": "Get pre-signed upload URL for onboarding assets", "deprecated": false } ], "description": "User and business onboarding workflows.", "description_html": "User and business onboarding workflows.
\n" }, { "name": "orders", "slug": "orders", "operations": [ { "slug": "list-orders", "operation_id": "list_orders", "method": "GET", "path": "/api/v1/orders", "summary": "List orders", "deprecated": false }, { "slug": "create-order", "operation_id": "create_order_orders", "method": "POST", "path": "/api/v1/orders", "summary": "Create order", "deprecated": false }, { "slug": "create-order-from-estimate", "operation_id": "create_order_from_estimate", "method": "POST", "path": "/api/v1/orders/from-estimate/{estimate_id}", "summary": "Create order from estimate", "deprecated": false }, { "slug": "delete-order", "operation_id": "delete_order_orders", "method": "DELETE", "path": "/api/v1/orders/{order_id}", "summary": "Delete order", "deprecated": false }, { "slug": "get-order", "operation_id": "get_order_orders", "method": "GET", "path": "/api/v1/orders/{order_id}", "summary": "Get order", "deprecated": false }, { "slug": "update-order", "operation_id": "update_order_orders", "method": "PUT", "path": "/api/v1/orders/{order_id}", "summary": "Update order", "deprecated": false }, { "slug": "attach-contract-file", "operation_id": "attach_contract_file", "method": "POST", "path": "/api/v1/orders/{order_id}/attach-contract-file", "summary": "Attach the executed contract file", "deprecated": false }, { "slug": "countersign-order", "operation_id": "countersign_order", "method": "POST", "path": "/api/v1/orders/{order_id}/countersign", "summary": "Countersign order", "deprecated": false }, { "slug": "mark-order-sent", "operation_id": "mark_order_sent", "method": "POST", "path": "/api/v1/orders/{order_id}/mark-sent", "summary": "Mark order sent (no email)", "deprecated": false }, { "slug": "remind-signer", "operation_id": "remind_signer", "method": "POST", "path": "/api/v1/orders/{order_id}/remind-signer", "summary": "Remind the customer to sign", "deprecated": false }, { "slug": "revert-order-to-draft", "operation_id": "revert_order_to_draft", "method": "POST", "path": "/api/v1/orders/{order_id}/revert-to-draft", "summary": "Revert order to draft", "deprecated": false }, { "slug": "send-order", "operation_id": "send_order", "method": "POST", "path": "/api/v1/orders/{order_id}/send", "summary": "Send order for signature", "deprecated": false }, { "slug": "sign-order", "operation_id": "sign_order", "method": "POST", "path": "/api/v1/orders/{order_id}/sign", "summary": "Mark order signed", "deprecated": false } ] }, { "name": "orders-esign", "slug": "orders-esign", "operations": [ { "slug": "get-order-esign-status", "operation_id": "get_order_esign_status", "method": "GET", "path": "/api/v1/orders/{order_id}/esign", "summary": "Get an order's e-signature status", "deprecated": false }, { "slug": "send-order-for-esign", "operation_id": "send_order_for_esign", "method": "POST", "path": "/api/v1/orders/{order_id}/esign/send", "summary": "Send an order for e-signature", "deprecated": false }, { "slug": "esign-webhook", "operation_id": "esign_webhook", "method": "POST", "path": "/api/v1/webhooks/esign", "summary": "E-signature provider webhook", "deprecated": false } ] }, { "name": "payment-advisory", "slug": "payment-advisory", "operations": [ { "slug": "get-firm-ap-summary", "operation_id": "get_firm_ap_summary", "method": "GET", "path": "/api/v1/payment-advisory/firm-summary", "summary": "Get consolidated AP summary for firm", "deprecated": false }, { "slug": "get-payment-recommendations", "operation_id": "get_payment_recommendations", "method": "GET", "path": "/api/v1/payment-advisory/recommendations", "summary": "Get payment recommendations", "deprecated": false } ], "description": "AI-powered payment recommendations and cash flow optimization.", "description_html": "AI-powered payment recommendations and cash flow optimization.
\n" }, { "name": "payment-terms", "slug": "payment-terms", "operations": [ { "slug": "list-payment-terms", "operation_id": "list_payment_terms", "method": "GET", "path": "/api/v1/payment-terms", "summary": "List payment terms", "deprecated": false }, { "slug": "create-payment-term", "operation_id": "create_payment_term", "method": "POST", "path": "/api/v1/payment-terms", "summary": "Create payment term", "deprecated": false }, { "slug": "get-default-payment-term", "operation_id": "get_default_payment_term", "method": "GET", "path": "/api/v1/payment-terms/default", "summary": "Get default payment term", "deprecated": false }, { "slug": "seed-default-terms", "operation_id": "seed_default_terms", "method": "POST", "path": "/api/v1/payment-terms/seed-defaults", "summary": "Seed default payment terms", "deprecated": false }, { "slug": "deactivate-payment-term", "operation_id": "deactivate_payment_term", "method": "DELETE", "path": "/api/v1/payment-terms/{term_id}", "summary": "Deactivate payment term", "deprecated": false }, { "slug": "get-payment-term", "operation_id": "get_payment_term", "method": "GET", "path": "/api/v1/payment-terms/{term_id}", "summary": "Get payment term", "deprecated": false }, { "slug": "update-payment-term", "operation_id": "update_payment_term", "method": "PUT", "path": "/api/v1/payment-terms/{term_id}", "summary": "Update payment term", "deprecated": false } ], "description": "Net payment terms (Net 30, Due on Receipt, etc.).", "description_html": "Net payment terms (Net 30, Due on Receipt, etc.).
\n" }, { "name": "payroll", "slug": "payroll", "operations": [ { "slug": "gusto-list-lines", "operation_id": "gusto_list_lines", "method": "GET", "path": "/api/v1/payroll/gusto/lines", "summary": "List Gusto bank lines, classified", "deprecated": false }, { "slug": "gusto-reconcile-apply", "operation_id": "gusto_reconcile_apply", "method": "POST", "path": "/api/v1/payroll/gusto/reconcile/apply", "summary": "Apply the Gusto payroll reconciliation", "deprecated": false }, { "slug": "gusto-reconcile-preview", "operation_id": "gusto_reconcile_preview", "method": "POST", "path": "/api/v1/payroll/gusto/reconcile/preview", "summary": "Preview the Gusto payroll reconciliation", "deprecated": false } ] }, { "name": "pending-change-rounds", "slug": "pending-change-rounds", "operations": [ { "slug": "list-approval-rounds", "operation_id": "list_approval_rounds", "method": "GET", "path": "/api/v1/pending-change-rounds", "summary": "List approval rounds", "deprecated": false }, { "slug": "open-approval-round", "operation_id": "open_approval_round", "method": "POST", "path": "/api/v1/pending-change-rounds", "summary": "Open an approval round", "deprecated": false }, { "slug": "get-approval-round", "operation_id": "get_approval_round", "method": "GET", "path": "/api/v1/pending-change-rounds/{round_id}", "summary": "Get an approval round", "deprecated": false }, { "slug": "approve-approval-round", "operation_id": "approve_approval_round", "method": "POST", "path": "/api/v1/pending-change-rounds/{round_id}/approve", "summary": "Approve a round, all except", "deprecated": false }, { "slug": "reject-approval-round", "operation_id": "reject_approval_round", "method": "POST", "path": "/api/v1/pending-change-rounds/{round_id}/reject", "summary": "Reject a round", "deprecated": false }, { "slug": "submit-approval-round", "operation_id": "submit_approval_round", "method": "POST", "path": "/api/v1/pending-change-rounds/{round_id}/submit", "summary": "Submit an approval round", "deprecated": false } ] }, { "name": "pending-changes", "slug": "pending-changes", "operations": [ { "slug": "list-pending-changes", "operation_id": "list_pending_changes", "method": "GET", "path": "/api/v1/pending-changes", "summary": "List proposed changes", "deprecated": false }, { "slug": "create-pending-change", "operation_id": "create_pending_change", "method": "POST", "path": "/api/v1/pending-changes", "summary": "Propose a change", "deprecated": false }, { "slug": "get-approval-settings", "operation_id": "get_approval_settings", "method": "GET", "path": "/api/v1/pending-changes/settings", "summary": "Get approval settings", "deprecated": false }, { "slug": "update-approval-settings", "operation_id": "update_approval_settings", "method": "PATCH", "path": "/api/v1/pending-changes/settings", "summary": "Change approval settings", "deprecated": false }, { "slug": "get-pending-change-stats", "operation_id": "get_pending_change_stats", "method": "GET", "path": "/api/v1/pending-changes/stats", "summary": "Approval statistics", "deprecated": false }, { "slug": "get-pending-change", "operation_id": "get_pending_change", "method": "GET", "path": "/api/v1/pending-changes/{change_id}", "summary": "Get a proposed change", "deprecated": false }, { "slug": "approve-pending-change", "operation_id": "approve_pending_change", "method": "POST", "path": "/api/v1/pending-changes/{change_id}/approve", "summary": "Approve a proposed change", "deprecated": false }, { "slug": "reject-pending-change", "operation_id": "reject_pending_change", "method": "POST", "path": "/api/v1/pending-changes/{change_id}/reject", "summary": "Reject a proposed change", "deprecated": false } ] }, { "name": "people", "slug": "people", "operations": [ { "slug": "list-people", "operation_id": "list_people", "method": "GET", "path": "/api/v1/people", "summary": "List people", "deprecated": false }, { "slug": "create-person", "operation_id": "create_person", "method": "POST", "path": "/api/v1/people", "summary": "Add a person", "deprecated": false }, { "slug": "get-people-access", "operation_id": "get_people_access", "method": "GET", "path": "/api/v1/people/access", "summary": "Your access to People", "deprecated": false }, { "slug": "update-people-access", "operation_id": "update_people_access", "method": "PUT", "path": "/api/v1/people/access", "summary": "Choose who else sees People", "deprecated": false }, { "slug": "people-import-apply", "operation_id": "people_import_apply", "method": "POST", "path": "/api/v1/people/import/apply", "summary": "Apply a previewed roster import", "deprecated": false }, { "slug": "people-import-preview", "operation_id": "people_import_preview", "method": "POST", "path": "/api/v1/people/import/preview", "summary": "Preview a roster import", "deprecated": false }, { "slug": "people-import-template", "operation_id": "people_import_template", "method": "GET", "path": "/api/v1/people/import/template", "summary": "Roster import template", "deprecated": false }, { "slug": "people-org-chart", "operation_id": "people_org_chart", "method": "GET", "path": "/api/v1/people/org-chart", "summary": "Org chart", "deprecated": false }, { "slug": "people-payments", "operation_id": "people_payments", "method": "GET", "path": "/api/v1/people/payments", "summary": "What the books paid each person, by month", "deprecated": false }, { "slug": "delete-person", "operation_id": "delete_person", "method": "DELETE", "path": "/api/v1/people/{person_id}", "summary": "Remove a person", "deprecated": false }, { "slug": "get-person", "operation_id": "get_person", "method": "GET", "path": "/api/v1/people/{person_id}", "summary": "Get a person", "deprecated": false }, { "slug": "update-person", "operation_id": "update_person", "method": "PUT", "path": "/api/v1/people/{person_id}", "summary": "Update a person", "deprecated": false }, { "slug": "person-ledger", "operation_id": "person_ledger", "method": "GET", "path": "/api/v1/people/{person_id}/ledger", "summary": "One person's ledger", "deprecated": false } ] }, { "name": "posting-defaults", "slug": "posting-defaults", "operations": [ { "slug": "get-posting-defaults", "operation_id": "get_posting_defaults", "method": "GET", "path": "/api/v1/posting-defaults", "summary": "Get invoice posting defaults", "deprecated": false }, { "slug": "update-posting-defaults", "operation_id": "update_posting_defaults", "method": "PUT", "path": "/api/v1/posting-defaults", "summary": "Update invoice posting defaults", "deprecated": false }, { "slug": "preview-posting-defaults", "operation_id": "preview_posting_defaults", "method": "GET", "path": "/api/v1/posting-defaults/preview", "summary": "Preview invoice posting defaults", "deprecated": false } ] }, { "name": "projects", "slug": "projects", "operations": [ { "slug": "list-projects", "operation_id": "list_projects", "method": "GET", "path": "/api/v1/projects", "summary": "List projects", "deprecated": false }, { "slug": "create-project", "operation_id": "create_project", "method": "POST", "path": "/api/v1/projects", "summary": "Create project", "deprecated": false }, { "slug": "bulk-create-projects", "operation_id": "bulk_create_projects", "method": "POST", "path": "/api/v1/projects/bulk", "summary": "Bulk create projects", "deprecated": false }, { "slug": "project-profitability", "operation_id": "project_profitability", "method": "GET", "path": "/api/v1/projects/profitability", "summary": "Project profitability", "deprecated": false }, { "slug": "deactivate-project", "operation_id": "deactivate_project", "method": "DELETE", "path": "/api/v1/projects/{project_id}", "summary": "Deactivate project", "deprecated": false }, { "slug": "get-project", "operation_id": "get_project", "method": "GET", "path": "/api/v1/projects/{project_id}", "summary": "Get project", "deprecated": false }, { "slug": "update-project", "operation_id": "update_project", "method": "PUT", "path": "/api/v1/projects/{project_id}", "summary": "Update project", "deprecated": false }, { "slug": "delete-project-permanently", "operation_id": "delete_project_permanently", "method": "DELETE", "path": "/api/v1/projects/{project_id}/permanent", "summary": "Delete project permanently", "deprecated": false }, { "slug": "single-project-profitability", "operation_id": "single_project_profitability", "method": "GET", "path": "/api/v1/projects/{project_id}/profitability", "summary": "Single project profitability", "deprecated": false } ] }, { "name": "purchase-orders", "slug": "purchase-orders", "operations": [ { "slug": "get-orders", "operation_id": "get_orders", "method": "GET", "path": "/api/v1/purchase-orders", "summary": "List inventory orders", "deprecated": false }, { "slug": "create-order", "operation_id": "create_order_purchase_orders", "method": "POST", "path": "/api/v1/purchase-orders", "summary": "Create inventory order", "deprecated": false }, { "slug": "get-order-pdfs", "operation_id": "get_order_pdfs", "method": "GET", "path": "/api/v1/purchase-orders/pdf", "summary": "Get order PDFs", "deprecated": false }, { "slug": "delete-order", "operation_id": "delete_order_purchase_orders", "method": "DELETE", "path": "/api/v1/purchase-orders/{id}", "summary": "Delete inventory order", "deprecated": false }, { "slug": "get-order", "operation_id": "get_order_purchase_orders", "method": "GET", "path": "/api/v1/purchase-orders/{id}", "summary": "Get inventory order", "deprecated": false }, { "slug": "update-order", "operation_id": "update_order_purchase_orders", "method": "PUT", "path": "/api/v1/purchase-orders/{id}", "summary": "Update inventory order", "deprecated": false }, { "slug": "cancel-order", "operation_id": "cancel_order", "method": "POST", "path": "/api/v1/purchase-orders/{id}/cancel", "summary": "Cancel purchase order", "deprecated": false }, { "slug": "mark-in-production", "operation_id": "mark_in_production", "method": "POST", "path": "/api/v1/purchase-orders/{id}/mark-in-production", "summary": "Mark purchase order in production", "deprecated": false }, { "slug": "mark-partially-received", "operation_id": "mark_partially_received", "method": "POST", "path": "/api/v1/purchase-orders/{id}/mark-partially-received", "summary": "Mark purchase order partially received", "deprecated": false }, { "slug": "mark-ready", "operation_id": "mark_ready", "method": "POST", "path": "/api/v1/purchase-orders/{id}/mark-ready", "summary": "Mark purchase order ready", "deprecated": false }, { "slug": "mark-shipped", "operation_id": "mark_shipped", "method": "POST", "path": "/api/v1/purchase-orders/{id}/mark-shipped", "summary": "Mark purchase order shipped", "deprecated": false }, { "slug": "record-order-payment", "operation_id": "record_order_payment", "method": "POST", "path": "/api/v1/purchase-orders/{id}/payments", "summary": "Record payment for purchase order", "deprecated": false }, { "slug": "recalculate-order-totals", "operation_id": "recalculate_order_totals", "method": "POST", "path": "/api/v1/purchase-orders/{id}/recalculate-totals", "summary": "Recalculate order totals", "deprecated": false }, { "slug": "receive-order", "operation_id": "receive_order", "method": "POST", "path": "/api/v1/purchase-orders/{id}/receive", "summary": "Receive purchase order", "deprecated": false }, { "slug": "submit-order", "operation_id": "submit_order", "method": "POST", "path": "/api/v1/purchase-orders/{id}/submit", "summary": "Submit purchase order", "deprecated": false }, { "slug": "generate-order-pdf", "operation_id": "generate_order_pdf", "method": "POST", "path": "/api/v1/purchase-orders/{order_id}/pdf", "summary": "Generate order PDF", "deprecated": false } ] }, { "name": "purchase-requisitions", "slug": "purchase-requisitions", "operations": [ { "slug": "list-purchase-requisitions", "operation_id": "list_purchase_requisitions", "method": "GET", "path": "/api/v1/purchase-requisitions", "summary": "List purchase requisitions", "deprecated": false }, { "slug": "create-purchase-requisition", "operation_id": "create_purchase_requisition", "method": "POST", "path": "/api/v1/purchase-requisitions", "summary": "Create purchase requisition", "deprecated": false }, { "slug": "delete-purchase-requisition", "operation_id": "delete_purchase_requisition", "method": "DELETE", "path": "/api/v1/purchase-requisitions/{requisition_id}", "summary": "Delete purchase requisition", "deprecated": false }, { "slug": "get-purchase-requisition", "operation_id": "get_purchase_requisition", "method": "GET", "path": "/api/v1/purchase-requisitions/{requisition_id}", "summary": "Get purchase requisition", "deprecated": false }, { "slug": "update-purchase-requisition", "operation_id": "update_purchase_requisition", "method": "PUT", "path": "/api/v1/purchase-requisitions/{requisition_id}", "summary": "Update purchase requisition", "deprecated": false }, { "slug": "approve-purchase-requisition", "operation_id": "approve_purchase_requisition", "method": "POST", "path": "/api/v1/purchase-requisitions/{requisition_id}/approve", "summary": "Approve purchase requisition", "deprecated": false }, { "slug": "convert-purchase-requisition", "operation_id": "convert_purchase_requisition", "method": "POST", "path": "/api/v1/purchase-requisitions/{requisition_id}/convert", "summary": "Convert purchase requisition", "deprecated": false }, { "slug": "reject-purchase-requisition", "operation_id": "reject_purchase_requisition", "method": "POST", "path": "/api/v1/purchase-requisitions/{requisition_id}/reject", "summary": "Reject purchase requisition", "deprecated": false }, { "slug": "submit-purchase-requisition", "operation_id": "submit_purchase_requisition", "method": "POST", "path": "/api/v1/purchase-requisitions/{requisition_id}/submit", "summary": "Submit purchase requisition", "deprecated": false } ] }, { "name": "quickbooks", "slug": "quickbooks", "operations": [ { "slug": "get-connect-url", "operation_id": "get_connect_url_quickbooks", "method": "GET", "path": "/api/v1/quickbooks/connect-url", "summary": "Get QuickBooks OAuth connect URL", "deprecated": false }, { "slug": "get-coverage-report", "operation_id": "get_coverage_report", "method": "GET", "path": "/api/v1/quickbooks/coverage-report", "summary": "QuickBooks import coverage report", "deprecated": false }, { "slug": "disconnect", "operation_id": "disconnect_quickbooks", "method": "DELETE", "path": "/api/v1/quickbooks/disconnect", "summary": "Disconnect QuickBooks", "deprecated": false }, { "slug": "quickbooks-disconnected", "operation_id": "quickbooks_disconnected", "method": "GET", "path": "/api/v1/quickbooks/disconnected", "summary": "QuickBooks disconnect landing (Intuit Disconnect URL)", "deprecated": false }, { "slug": "start-import", "operation_id": "start_import", "method": "POST", "path": "/api/v1/quickbooks/import", "summary": "Start QuickBooks migration import", "deprecated": false }, { "slug": "cancel-import", "operation_id": "cancel_import", "method": "POST", "path": "/api/v1/quickbooks/import/cancel", "summary": "Cancel the running QuickBooks migration import", "deprecated": false }, { "slug": "get-migration-report", "operation_id": "get_migration_report", "method": "GET", "path": "/api/v1/quickbooks/migration-report", "summary": "QuickBooks migration QA report", "deprecated": false }, { "slug": "quickbooks-oauth-callback", "operation_id": "quickbooks_oauth_callback", "method": "GET", "path": "/api/v1/quickbooks/oauth/callback", "summary": "QuickBooks OAuth callback", "deprecated": false }, { "slug": "get-connection-status", "operation_id": "get_connection_status_quickbooks", "method": "GET", "path": "/api/v1/quickbooks/status", "summary": "QuickBooks connection status", "deprecated": false } ] }, { "name": "reconciliations", "slug": "reconciliations", "operations": [ { "slug": "list-reconciliations", "operation_id": "list_reconciliations", "method": "GET", "path": "/api/v1/reconciliations", "summary": "List reconciliations", "deprecated": false }, { "slug": "create-reconciliation", "operation_id": "create_reconciliation", "method": "POST", "path": "/api/v1/reconciliations", "summary": "Create reconciliation", "deprecated": false }, { "slug": "create-reconciliation-with-upload", "operation_id": "create_reconciliation_with_upload", "method": "POST", "path": "/api/v1/reconciliations/upload", "summary": "Create reconciliation with upload", "deprecated": false }, { "slug": "get-reconciliation", "operation_id": "get_reconciliation", "method": "GET", "path": "/api/v1/reconciliations/{reconciliation_id}", "summary": "Get reconciliation", "deprecated": false }, { "slug": "get-balance-validation", "operation_id": "get_balance_validation", "method": "GET", "path": "/api/v1/reconciliations/{reconciliation_id}/balance", "summary": "Get balance validation", "deprecated": false }, { "slug": "get-reconciliation-balance-report", "operation_id": "get_reconciliation_balance_report", "method": "GET", "path": "/api/v1/reconciliations/{reconciliation_id}/balance-report", "summary": "Get statement-vs-books balance report", "deprecated": false }, { "slug": "complete-reconciliation", "operation_id": "complete_reconciliation", "method": "POST", "path": "/api/v1/reconciliations/{reconciliation_id}/complete", "summary": "Complete reconciliation", "deprecated": false }, { "slug": "explain-matches", "operation_id": "explain_matches", "method": "POST", "path": "/api/v1/reconciliations/{reconciliation_id}/explain-matches", "summary": "AI match explanations", "deprecated": false }, { "slug": "approve-match", "operation_id": "approve_match", "method": "POST", "path": "/api/v1/reconciliations/{reconciliation_id}/matches/approve", "summary": "Approve match", "deprecated": false }, { "slug": "bulk-approve-matches", "operation_id": "bulk_approve_matches", "method": "POST", "path": "/api/v1/reconciliations/{reconciliation_id}/matches/bulk-approve", "summary": "Bulk approve matches", "deprecated": false }, { "slug": "bulk-reject-matches", "operation_id": "bulk_reject_matches", "method": "POST", "path": "/api/v1/reconciliations/{reconciliation_id}/matches/bulk-reject", "summary": "Bulk reject matches", "deprecated": false }, { "slug": "reject-match", "operation_id": "reject_match", "method": "POST", "path": "/api/v1/reconciliations/{reconciliation_id}/matches/reject", "summary": "Reject match", "deprecated": false }, { "slug": "download-reconciliation-pdf", "operation_id": "download_reconciliation_pdf", "method": "GET", "path": "/api/v1/reconciliations/{reconciliation_id}/pdf", "summary": "Download reconciliation PDF", "deprecated": false }, { "slug": "start-reconciliation-processing", "operation_id": "start_reconciliation_processing", "method": "POST", "path": "/api/v1/reconciliations/{reconciliation_id}/start", "summary": "Start reconciliation processing", "deprecated": false } ], "description": "Bank statement reconciliation with AI-assisted matching.", "description_html": "Bank statement reconciliation with AI-assisted matching.
\n" }, { "name": "recurring", "slug": "recurring", "operations": [ { "slug": "list-recurring-templates", "operation_id": "list_recurring_templates", "method": "GET", "path": "/api/v1/recurring", "summary": "List recurring templates", "deprecated": false }, { "slug": "create-recurring-template", "operation_id": "create_recurring_template", "method": "POST", "path": "/api/v1/recurring", "summary": "Create recurring template", "deprecated": false }, { "slug": "list-recurring-bill-templates", "operation_id": "list_recurring_bill_templates", "method": "GET", "path": "/api/v1/recurring/bills", "summary": "List recurring bill templates", "deprecated": false }, { "slug": "list-recurring-invoice-templates", "operation_id": "list_recurring_invoice_templates", "method": "GET", "path": "/api/v1/recurring/invoices", "summary": "List recurring invoice templates", "deprecated": false }, { "slug": "suggest-templates", "operation_id": "suggest_templates", "method": "POST", "path": "/api/v1/recurring/suggest-templates", "summary": "AI recurring template suggestions", "deprecated": false }, { "slug": "delete-recurring-template", "operation_id": "delete_recurring_template", "method": "DELETE", "path": "/api/v1/recurring/{template_id}", "summary": "Delete recurring template", "deprecated": false }, { "slug": "get-recurring-template", "operation_id": "get_recurring_template", "method": "GET", "path": "/api/v1/recurring/{template_id}", "summary": "Get recurring template", "deprecated": false }, { "slug": "update-recurring-template", "operation_id": "update_recurring_template", "method": "PUT", "path": "/api/v1/recurring/{template_id}", "summary": "Update recurring template", "deprecated": false }, { "slug": "cancel-recurring-template", "operation_id": "cancel_recurring_template", "method": "POST", "path": "/api/v1/recurring/{template_id}/cancel", "summary": "Cancel recurring template", "deprecated": false }, { "slug": "clone-recurring-template", "operation_id": "clone_recurring_template", "method": "POST", "path": "/api/v1/recurring/{template_id}/clone", "summary": "Clone recurring template", "deprecated": false }, { "slug": "get-recurring-template-history", "operation_id": "get_recurring_template_history", "method": "GET", "path": "/api/v1/recurring/{template_id}/history", "summary": "Get recurring template history", "deprecated": false }, { "slug": "pause-recurring-template", "operation_id": "pause_recurring_template", "method": "POST", "path": "/api/v1/recurring/{template_id}/pause", "summary": "Pause recurring template", "deprecated": false }, { "slug": "resume-recurring-template", "operation_id": "resume_recurring_template", "method": "POST", "path": "/api/v1/recurring/{template_id}/resume", "summary": "Resume recurring template", "deprecated": false }, { "slug": "skip-recurring-template-occurrence", "operation_id": "skip_recurring_template_occurrence", "method": "POST", "path": "/api/v1/recurring/{template_id}/skip", "summary": "Skip next occurrence", "deprecated": false } ], "description": "Recurring invoice and bill templates with auto-generation.", "description_html": "Recurring invoice and bill templates with auto-generation.
\n" }, { "name": "regent-slack", "slug": "regent-slack", "operations": [ { "slug": "regent-slack-events", "operation_id": "regent_slack_events", "method": "POST", "path": "/api/v1/regent-slack/events", "summary": "Slack Events API", "deprecated": false }, { "slug": "regent-slack-install-url", "operation_id": "regent_slack_install_url", "method": "GET", "path": "/api/v1/regent-slack/install-url", "summary": "Get the Add Regent to Slack URL", "deprecated": false }, { "slug": "regent-slack-disconnect", "operation_id": "regent_slack_disconnect", "method": "DELETE", "path": "/api/v1/regent-slack/installation", "summary": "Disconnect Regent from Slack", "deprecated": false }, { "slug": "regent-slack-installation", "operation_id": "regent_slack_installation", "method": "GET", "path": "/api/v1/regent-slack/installation", "summary": "Regent in Slack status", "deprecated": false }, { "slug": "regent-slack-interactions", "operation_id": "regent_slack_interactions", "method": "POST", "path": "/api/v1/regent-slack/interactions", "summary": "Slack interactivity", "deprecated": false }, { "slug": "regent-slack-link-url", "operation_id": "regent_slack_link_url", "method": "GET", "path": "/api/v1/regent-slack/link-url", "summary": "Get the Sign in with Slack URL", "deprecated": false }, { "slug": "regent-slack-link-callback", "operation_id": "regent_slack_link_callback", "method": "GET", "path": "/api/v1/regent-slack/link/callback", "summary": "Sign in with Slack callback", "deprecated": false }, { "slug": "regent-slack-links", "operation_id": "regent_slack_links", "method": "GET", "path": "/api/v1/regent-slack/links", "summary": "Your linked Slack accounts", "deprecated": false }, { "slug": "regent-slack-unlink", "operation_id": "regent_slack_unlink", "method": "DELETE", "path": "/api/v1/regent-slack/links/{link_id}", "summary": "Unlink a Slack account", "deprecated": false }, { "slug": "regent-slack-install-callback", "operation_id": "regent_slack_install_callback", "method": "GET", "path": "/api/v1/regent-slack/oauth/callback", "summary": "Add to Slack callback", "deprecated": false } ] }, { "name": "reports", "slug": "reports", "operations": [ { "slug": "list-reports", "operation_id": "list_reports", "method": "GET", "path": "/api/v1/reports", "summary": "List reports", "deprecated": false }, { "slug": "generate-report", "operation_id": "generate_report", "method": "POST", "path": "/api/v1/reports", "summary": "Generate report", "deprecated": false }, { "slug": "download-report", "operation_id": "download_report", "method": "GET", "path": "/api/v1/reports/download", "summary": "Download report (proxy)", "deprecated": false }, { "slug": "list-import-templates", "operation_id": "list_import_templates", "method": "GET", "path": "/api/v1/reports/import-templates", "summary": "List import templates", "deprecated": false }, { "slug": "download-import-templates-zip", "operation_id": "download_import_templates_zip", "method": "GET", "path": "/api/v1/reports/import-templates.zip", "summary": "Download all import templates as a ZIP", "deprecated": false }, { "slug": "download-import-template-csv", "operation_id": "download_import_template_csv", "method": "GET", "path": "/api/v1/reports/import-templates/{template_key}.csv", "summary": "Download one import template CSV", "deprecated": false }, { "slug": "download-import-template-readme", "operation_id": "download_import_template_readme", "method": "GET", "path": "/api/v1/reports/import-templates/{template_key}.md", "summary": "Download one import template README", "deprecated": false }, { "slug": "get-report-preview-info", "operation_id": "get_report_preview_info", "method": "GET", "path": "/api/v1/reports/preview-info", "summary": "Report preview availability", "deprecated": false }, { "slug": "get-report-preview-page", "operation_id": "get_report_preview_page", "method": "GET", "path": "/api/v1/reports/preview-page", "summary": "Report preview page image", "deprecated": false }, { "slug": "get-subledger-gl-reconciliation", "operation_id": "get_subledger_gl_reconciliation", "method": "GET", "path": "/api/v1/reports/subledger-gl-reconciliation", "summary": "Sub-ledger to GL reconciliation", "deprecated": false }, { "slug": "suggest-reports", "operation_id": "suggest_reports", "method": "POST", "path": "/api/v1/reports/suggest", "summary": "AI report suggestions", "deprecated": false }, { "slug": "get-report-types", "operation_id": "get_report_types", "method": "GET", "path": "/api/v1/reports/types", "summary": "Get supported report types", "deprecated": false }, { "slug": "delete-report", "operation_id": "delete_report", "method": "DELETE", "path": "/api/v1/reports/{report_id}", "summary": "Delete report", "deprecated": false }, { "slug": "get-report", "operation_id": "get_report", "method": "GET", "path": "/api/v1/reports/{report_id}", "summary": "Get report", "deprecated": false } ], "description": "Financial report generation (P&L, Balance Sheet, Trial Balance, etc.).", "description_html": "Financial report generation (P&L, Balance Sheet, Trial Balance, etc.).
\n" }, { "name": "revenue-schedules", "slug": "revenue-schedules", "operations": [ { "slug": "list-revenue-schedules", "operation_id": "list_revenue_schedules", "method": "GET", "path": "/api/v1/revenue-schedules", "summary": "List revenue schedules", "deprecated": false }, { "slug": "book-preorder", "operation_id": "book_preorder", "method": "POST", "path": "/api/v1/revenue-schedules/preorders", "summary": "Book a pre-order", "deprecated": false }, { "slug": "fulfill-preorder", "operation_id": "fulfill_preorder", "method": "POST", "path": "/api/v1/revenue-schedules/preorders/fulfill", "summary": "Recognize a pre-order on fulfillment", "deprecated": false }, { "slug": "run-recognition", "operation_id": "run_recognition_revenue_schedules", "method": "POST", "path": "/api/v1/revenue-schedules/recognize", "summary": "Run recognition", "deprecated": false }, { "slug": "revenue-waterfall", "operation_id": "revenue_waterfall", "method": "GET", "path": "/api/v1/revenue-schedules/waterfall", "summary": "Deferred-revenue waterfall", "deprecated": false } ] }, { "name": "sales-receipts", "slug": "sales-receipts", "operations": [ { "slug": "list-sales-receipts", "operation_id": "list_sales_receipts", "method": "GET", "path": "/api/v1/sales-receipts", "summary": "List sales receipts", "deprecated": false }, { "slug": "create-sales-receipt", "operation_id": "create_sales_receipt", "method": "POST", "path": "/api/v1/sales-receipts", "summary": "Create sales receipt", "deprecated": false }, { "slug": "get-sales-receipt", "operation_id": "get_sales_receipt", "method": "GET", "path": "/api/v1/sales-receipts/{receipt_id}", "summary": "Get sales receipt", "deprecated": false }, { "slug": "void-sales-receipt", "operation_id": "void_sales_receipt", "method": "POST", "path": "/api/v1/sales-receipts/{receipt_id}/void", "summary": "Void sales receipt", "deprecated": false } ] }, { "name": "search", "slug": "search", "operations": [ { "slug": "search-entities", "operation_id": "search_entities", "method": "GET", "path": "/api/v1/search", "summary": "Global search", "deprecated": false }, { "slug": "natural-language-search", "operation_id": "natural_language_search", "method": "POST", "path": "/api/v1/search/natural", "summary": "AI natural language search", "deprecated": false } ], "description": "Full-text search across transactions, contacts, and entities.", "description_html": "Full-text search across transactions, contacts, and entities.
\n" }, { "name": "subscriptions", "slug": "subscriptions", "operations": [ { "slug": "list-subscriptions", "operation_id": "list_subscriptions", "method": "GET", "path": "/api/v1/subscriptions/", "summary": "List detected recurring transactions", "deprecated": false }, { "slug": "update-subscription", "operation_id": "update_subscription", "method": "PUT", "path": "/api/v1/subscriptions/", "summary": "Update a detected recurring transaction", "deprecated": false }, { "slug": "analyze-subscriptions", "operation_id": "analyze_subscriptions", "method": "POST", "path": "/api/v1/subscriptions/analyze", "summary": "AI subscription analysis", "deprecated": false }, { "slug": "create-templates-from-detection", "operation_id": "create_templates_from_detection", "method": "POST", "path": "/api/v1/subscriptions/create-templates", "summary": "Create recurring bill templates from detected patterns", "deprecated": false }, { "slug": "dismiss-subscription", "operation_id": "dismiss_subscription", "method": "POST", "path": "/api/v1/subscriptions/dismiss", "summary": "Dismiss a detected recurring transaction", "deprecated": false }, { "slug": "get-spend-history", "operation_id": "get_spend_history", "method": "GET", "path": "/api/v1/subscriptions/history", "summary": "Monthly spend history for recurring transactions", "deprecated": false }, { "slug": "restore-subscription", "operation_id": "restore_subscription", "method": "POST", "path": "/api/v1/subscriptions/restore", "summary": "Restore a dismissed recurring transaction", "deprecated": false }, { "slug": "get-settings", "operation_id": "get_settings", "method": "GET", "path": "/api/v1/subscriptions/settings", "summary": "Get recurring transaction budget settings", "deprecated": false }, { "slug": "update-settings", "operation_id": "update_settings", "method": "PUT", "path": "/api/v1/subscriptions/settings", "summary": "Set monthly recurring transaction limit", "deprecated": false }, { "slug": "get-summary", "operation_id": "get_summary", "method": "GET", "path": "/api/v1/subscriptions/summary", "summary": "Recurring transactions summary for dashboard", "deprecated": false } ], "description": "Manage recurring subscription billing for customers.", "description_html": "Manage recurring subscription billing for customers.
\n" }, { "name": "tags", "slug": "tags", "operations": [ { "slug": "attach-tag", "operation_id": "attach_tag", "method": "POST", "path": "/api/v1/entity-tags", "summary": "Attach tag to entity", "deprecated": false }, { "slug": "get-entity-tags-batch", "operation_id": "get_entity_tags_batch", "method": "POST", "path": "/api/v1/entity-tags/batch", "summary": "Batch fetch tags for multiple entities", "deprecated": false }, { "slug": "bulk-attach-tags", "operation_id": "bulk_attach_tags", "method": "POST", "path": "/api/v1/entity-tags/bulk-attach", "summary": "Bulk attach tags to an entity", "deprecated": false }, { "slug": "bulk-attach-tags-to-entities", "operation_id": "bulk_attach_tags_to_entities", "method": "POST", "path": "/api/v1/entity-tags/bulk-attach-many", "summary": "Bulk attach tags to many entities", "deprecated": false }, { "slug": "bulk-detach-tags", "operation_id": "bulk_detach_tags", "method": "POST", "path": "/api/v1/entity-tags/bulk-detach", "summary": "Bulk detach tags from an entity", "deprecated": false }, { "slug": "get-entity-tags", "operation_id": "get_entity_tags", "method": "GET", "path": "/api/v1/entity-tags/{model_type}/{model_id}", "summary": "Get tags for an entity", "deprecated": false }, { "slug": "detach-tag", "operation_id": "detach_tag", "method": "DELETE", "path": "/api/v1/entity-tags/{tag_id}/{model_type}/{model_id}", "summary": "Detach tag from entity", "deprecated": false }, { "slug": "list-tag-groups", "operation_id": "list_tag_groups", "method": "GET", "path": "/api/v1/tag-groups", "summary": "List tag groups", "deprecated": false }, { "slug": "create-tag-group", "operation_id": "create_tag_group", "method": "POST", "path": "/api/v1/tag-groups", "summary": "Create tag group", "deprecated": false }, { "slug": "delete-tag-group", "operation_id": "delete_tag_group", "method": "DELETE", "path": "/api/v1/tag-groups/{tag_group_id}", "summary": "Delete tag group", "deprecated": false }, { "slug": "get-tag-group", "operation_id": "get_tag_group", "method": "GET", "path": "/api/v1/tag-groups/{tag_group_id}", "summary": "Get tag group", "deprecated": false }, { "slug": "update-tag-group", "operation_id": "update_tag_group", "method": "PUT", "path": "/api/v1/tag-groups/{tag_group_id}", "summary": "Update tag group", "deprecated": false }, { "slug": "list-tags", "operation_id": "list_tags", "method": "GET", "path": "/api/v1/tags", "summary": "List tags", "deprecated": false }, { "slug": "create-tag", "operation_id": "create_tag", "method": "POST", "path": "/api/v1/tags", "summary": "Create tag", "deprecated": false }, { "slug": "suggest-tags", "operation_id": "suggest_tags", "method": "POST", "path": "/api/v1/tags/suggest", "summary": "AI tag suggestions", "deprecated": false }, { "slug": "delete-tag", "operation_id": "delete_tag", "method": "DELETE", "path": "/api/v1/tags/{tag_id}", "summary": "Delete tag", "deprecated": false }, { "slug": "get-tag", "operation_id": "get_tag", "method": "GET", "path": "/api/v1/tags/{tag_id}", "summary": "Get tag", "deprecated": false }, { "slug": "update-tag", "operation_id": "update_tag", "method": "PUT", "path": "/api/v1/tags/{tag_id}", "summary": "Update tag", "deprecated": false }, { "slug": "get-tagged-entities", "operation_id": "get_tagged_entities", "method": "GET", "path": "/api/v1/tags/{tag_id}/entities/{model_type}", "summary": "Get entities with a tag", "deprecated": false } ], "description": "Custom tag groups and tags for categorizing entities.", "description_html": "Custom tag groups and tags for categorizing entities.
\n" }, { "name": "tax", "slug": "tax", "operations": [ { "slug": "list-tax-codes", "operation_id": "list_tax_codes", "method": "GET", "path": "/api/v1/tax/codes", "summary": "List tax codes", "deprecated": false }, { "slug": "create-tax-code", "operation_id": "create_tax_code", "method": "POST", "path": "/api/v1/tax/codes", "summary": "Create tax code", "deprecated": false }, { "slug": "seed-default-codes", "operation_id": "seed_default_codes", "method": "POST", "path": "/api/v1/tax/codes/seed-defaults", "summary": "Seed default tax codes", "deprecated": false }, { "slug": "deactivate-tax-code", "operation_id": "deactivate_tax_code", "method": "DELETE", "path": "/api/v1/tax/codes/{code_id}", "summary": "Deactivate tax code", "deprecated": false }, { "slug": "get-tax-code", "operation_id": "get_tax_code", "method": "GET", "path": "/api/v1/tax/codes/{code_id}", "summary": "Get tax code", "deprecated": false }, { "slug": "update-tax-code", "operation_id": "update_tax_code", "method": "PUT", "path": "/api/v1/tax/codes/{code_id}", "summary": "Update tax code", "deprecated": false }, { "slug": "dedupe-imported-tax", "operation_id": "dedupe_imported_tax", "method": "POST", "path": "/api/v1/tax/dedupe-imported", "summary": "Dedupe imported tax data", "deprecated": false }, { "slug": "list-tax-rates", "operation_id": "list_tax_rates", "method": "GET", "path": "/api/v1/tax/rates", "summary": "List tax rates", "deprecated": false }, { "slug": "create-tax-rate", "operation_id": "create_tax_rate", "method": "POST", "path": "/api/v1/tax/rates", "summary": "Create tax rate", "deprecated": false }, { "slug": "get-default-tax-rate", "operation_id": "get_default_tax_rate", "method": "GET", "path": "/api/v1/tax/rates/default", "summary": "Get default tax rate", "deprecated": false }, { "slug": "deactivate-tax-rate", "operation_id": "deactivate_tax_rate", "method": "DELETE", "path": "/api/v1/tax/rates/{rate_id}", "summary": "Deactivate tax rate", "deprecated": false }, { "slug": "get-tax-rate", "operation_id": "get_tax_rate", "method": "GET", "path": "/api/v1/tax/rates/{rate_id}", "summary": "Get tax rate", "deprecated": false }, { "slug": "update-tax-rate", "operation_id": "update_tax_rate", "method": "PUT", "path": "/api/v1/tax/rates/{rate_id}", "summary": "Update tax rate", "deprecated": false }, { "slug": "suggest-rates", "operation_id": "suggest_rates", "method": "POST", "path": "/api/v1/tax/suggest-rates", "summary": "AI tax rate suggestions", "deprecated": false } ], "description": "Tax rate configuration and tax calculations.", "description_html": "Tax rate configuration and tax calculations.
\n" }, { "name": "tax-deadlines", "slug": "tax-deadlines", "operations": [ { "slug": "get-tax-deadlines", "operation_id": "get_tax_deadlines", "method": "GET", "path": "/api/v1/books/tax-deadlines", "summary": "Upcoming tax and filing deadlines", "deprecated": false }, { "slug": "sync-tax-deadline-todos", "operation_id": "sync_tax_deadline_todos", "method": "POST", "path": "/api/v1/books/tax-deadlines/sync-todos", "summary": "Add upcoming deadlines to my to-dos", "deprecated": false } ] }, { "name": "time-entries", "slug": "time-entries", "operations": [ { "slug": "list-time-entries", "operation_id": "list_time_entries", "method": "GET", "path": "/api/v1/time-entries", "summary": "List time entries", "deprecated": false }, { "slug": "create-time-entry", "operation_id": "create_time_entry", "method": "POST", "path": "/api/v1/time-entries", "summary": "Create time entry", "deprecated": false }, { "slug": "add-expenses-to-invoice", "operation_id": "add_expenses_to_invoice", "method": "POST", "path": "/api/v1/time-entries/add-expenses-to-invoice", "summary": "Add expenses to invoice", "deprecated": false }, { "slug": "add-to-invoice", "operation_id": "add_to_invoice", "method": "POST", "path": "/api/v1/time-entries/add-to-invoice", "summary": "Add time to invoice", "deprecated": false }, { "slug": "list-billable", "operation_id": "list_billable", "method": "GET", "path": "/api/v1/time-entries/billable", "summary": "List billable time", "deprecated": false }, { "slug": "list-billable-expenses", "operation_id": "list_billable_expenses", "method": "GET", "path": "/api/v1/time-entries/billable-expenses", "summary": "List billable expenses", "deprecated": false }, { "slug": "delete-time-entry", "operation_id": "delete_time_entry", "method": "DELETE", "path": "/api/v1/time-entries/{time_entry_id}", "summary": "Delete time entry", "deprecated": false }, { "slug": "get-time-entry", "operation_id": "get_time_entry", "method": "GET", "path": "/api/v1/time-entries/{time_entry_id}", "summary": "Get time entry", "deprecated": false }, { "slug": "update-time-entry", "operation_id": "update_time_entry", "method": "PUT", "path": "/api/v1/time-entries/{time_entry_id}", "summary": "Update time entry", "deprecated": false } ] }, { "name": "todos", "slug": "todos", "operations": [ { "slug": "list-todos", "operation_id": "list_todos", "method": "GET", "path": "/api/v1/todos", "summary": "List user todos", "deprecated": false }, { "slug": "create-todo", "operation_id": "create_todo", "method": "POST", "path": "/api/v1/todos", "summary": "Create a todo", "deprecated": false }, { "slug": "delete-todo", "operation_id": "delete_todo", "method": "DELETE", "path": "/api/v1/todos/{todo_id}", "summary": "Delete a todo", "deprecated": false }, { "slug": "get-todo", "operation_id": "get_todo", "method": "GET", "path": "/api/v1/todos/{todo_id}", "summary": "Get a todo", "deprecated": false }, { "slug": "update-todo", "operation_id": "update_todo", "method": "PATCH", "path": "/api/v1/todos/{todo_id}", "summary": "Update a todo", "deprecated": false }, { "slug": "complete-todo", "operation_id": "complete_todo", "method": "POST", "path": "/api/v1/todos/{todo_id}/complete", "summary": "Complete a todo", "deprecated": false }, { "slug": "uncomplete-todo", "operation_id": "uncomplete_todo", "method": "POST", "path": "/api/v1/todos/{todo_id}/uncomplete", "summary": "Uncomplete a todo", "deprecated": false } ] }, { "name": "transaction-clarifications", "slug": "transaction-clarifications", "operations": [ { "slug": "list-client-clarifications", "operation_id": "list_client_clarifications", "method": "GET", "path": "/api/v1/transaction-clarifications", "summary": "List transaction clarifications (client)", "deprecated": false }, { "slug": "client-clarification-count", "operation_id": "client_clarification_count", "method": "GET", "path": "/api/v1/transaction-clarifications/count", "summary": "Open clarification count (client)", "deprecated": false }, { "slug": "list-firm-clarifications", "operation_id": "list_firm_clarifications", "method": "GET", "path": "/api/v1/transaction-clarifications/firm", "summary": "List clarifications (firm)", "deprecated": false }, { "slug": "firm-clarification-count", "operation_id": "firm_clarification_count", "method": "GET", "path": "/api/v1/transaction-clarifications/firm/count", "summary": "Open clarification count (firm)", "deprecated": false }, { "slug": "create-clarification", "operation_id": "create_clarification", "method": "POST", "path": "/api/v1/transaction-clarifications/firm/transactions/{transaction_id}", "summary": "Ask the client about a transaction (firm)", "deprecated": false }, { "slug": "resolve-clarification", "operation_id": "resolve_clarification", "method": "POST", "path": "/api/v1/transaction-clarifications/firm/{clarification_id}/resolve", "summary": "Resolve a clarification (firm)", "deprecated": false }, { "slug": "answer-clarification", "operation_id": "answer_clarification", "method": "POST", "path": "/api/v1/transaction-clarifications/{clarification_id}/answer", "summary": "Answer a clarification (client)", "deprecated": false }, { "slug": "attach-clarification-receipt", "operation_id": "attach_clarification_receipt", "method": "POST", "path": "/api/v1/transaction-clarifications/{clarification_id}/receipt", "summary": "Attach a receipt to a clarification (client)", "deprecated": false } ] }, { "name": "transactions", "slug": "transactions", "operations": [ { "slug": "list-transactions", "operation_id": "list_transactions", "method": "GET", "path": "/api/v1/transactions", "summary": "List transactions", "deprecated": false }, { "slug": "create-transaction", "operation_id": "create_transaction", "method": "POST", "path": "/api/v1/transactions", "summary": "Create transaction", "deprecated": false }, { "slug": "bulk-edit-transactions", "operation_id": "bulk_edit_transactions", "method": "PATCH", "path": "/api/v1/transactions/batch", "summary": "Edit many transactions, a different change per row", "deprecated": false }, { "slug": "update-transactions-category", "operation_id": "update_transactions_category", "method": "PATCH", "path": "/api/v1/transactions/batch/category", "summary": "Batch update category", "deprecated": false }, { "slug": "update-transactions-counterparty", "operation_id": "update_transactions_counterparty", "method": "PATCH", "path": "/api/v1/transactions/batch/counterparty", "summary": "Batch update counterparty", "deprecated": false }, { "slug": "bulk-delete-transactions", "operation_id": "bulk_delete_transactions", "method": "POST", "path": "/api/v1/transactions/batch/delete", "summary": "Delete selected transactions", "deprecated": false }, { "slug": "mark-transactions-reviewed-by-filter", "operation_id": "mark_transactions_reviewed_by_filter", "method": "POST", "path": "/api/v1/transactions/batch/mark-reviewed-by-filter", "summary": "Mark machine-categorized transactions reviewed by filter", "deprecated": false }, { "slug": "mark-period-transactions-reviewed", "operation_id": "mark_period_transactions_reviewed", "method": "POST", "path": "/api/v1/transactions/batch/mark-reviewed-by-period", "summary": "Mark all unreviewed transactions in a period as reviewed", "deprecated": false }, { "slug": "update-transactions-receipt-exempt", "operation_id": "update_transactions_receipt_exempt", "method": "PATCH", "path": "/api/v1/transactions/batch/receipt-exempt", "summary": "Mark transactions as not needing a receipt", "deprecated": false }, { "slug": "request-transaction-receipts", "operation_id": "request_transaction_receipts", "method": "POST", "path": "/api/v1/transactions/batch/receipt-requests", "summary": "Request receipts from the client", "deprecated": false }, { "slug": "update-transactions-reconciliation-status", "operation_id": "update_transactions_reconciliation_status", "method": "PATCH", "path": "/api/v1/transactions/batch/reconciliation-status", "summary": "Batch update reconciliation status", "deprecated": false }, { "slug": "update-transactions-review-status", "operation_id": "update_transactions_review_status", "method": "PATCH", "path": "/api/v1/transactions/batch/review-status", "summary": "Batch update review status", "deprecated": false }, { "slug": "create-bulk-transactions", "operation_id": "create_bulk_transactions", "method": "POST", "path": "/api/v1/transactions/bulk", "summary": "Bulk create transactions", "deprecated": false }, { "slug": "bulk-upload-transactions", "operation_id": "bulk_upload_transactions", "method": "POST", "path": "/api/v1/transactions/bulk-upload", "summary": "Bulk upload transactions to new source account", "deprecated": false }, { "slug": "ledger-diff-bulk-upload-export", "operation_id": "ledger_diff_bulk_upload_export", "method": "POST", "path": "/api/v1/transactions/bulk-upload/diff", "summary": "Compare a bank/card export with a ledger", "deprecated": false }, { "slug": "statement-ingest-extract-from-statement", "operation_id": "statement_ingest_extract_from_statement", "method": "POST", "path": "/api/v1/transactions/bulk-upload/from-statement", "summary": "Extract transactions from a statement", "deprecated": false }, { "slug": "get-bulk-upload-headers", "operation_id": "get_bulk_upload_headers", "method": "POST", "path": "/api/v1/transactions/bulk-upload/headers", "summary": "Get CSV/Excel column headers for mapping", "deprecated": false }, { "slug": "paste-transaction-text", "operation_id": "paste_transaction_text", "method": "POST", "path": "/api/v1/transactions/bulk-upload/paste", "summary": "Upload pasted transaction text", "deprecated": false }, { "slug": "preview-bulk-transaction-upload", "operation_id": "preview_bulk_transaction_upload", "method": "POST", "path": "/api/v1/transactions/bulk-upload/preview", "summary": "Preview bulk transaction upload", "deprecated": false }, { "slug": "download-bulk-upload-template", "operation_id": "download_bulk_upload_template", "method": "GET", "path": "/api/v1/transactions/bulk-upload/template", "summary": "Download bulk transaction upload CSV template", "deprecated": false }, { "slug": "delete-transactions-by-date-range", "operation_id": "delete_transactions_by_date_range", "method": "DELETE", "path": "/api/v1/transactions/by-date-range", "summary": "Delete transactions by date range", "deprecated": false }, { "slug": "preview-delete-transactions-by-date-range", "operation_id": "preview_delete_transactions_by_date_range", "method": "GET", "path": "/api/v1/transactions/by-date-range/preview", "summary": "Preview a delete-by-date-range", "deprecated": false }, { "slug": "list-transaction-card-holders", "operation_id": "list_transaction_card_holders", "method": "GET", "path": "/api/v1/transactions/card-holders", "summary": "Cardholders", "deprecated": false }, { "slug": "categorize-all", "operation_id": "categorize_all", "method": "POST", "path": "/api/v1/transactions/categorize-all", "summary": "AI-categorize all uncategorized transactions", "deprecated": false }, { "slug": "statement-ingest-enrich-from-export", "operation_id": "statement_ingest_enrich_from_export", "method": "POST", "path": "/api/v1/transactions/enrich-from-export", "summary": "Enrich transactions from a detailed bank export", "deprecated": false }, { "slug": "recategorize-by-counterparty", "operation_id": "recategorize_by_counterparty", "method": "POST", "path": "/api/v1/transactions/recategorize-by-counterparty", "summary": "Recategorize all transactions for a counterparty", "deprecated": false }, { "slug": "get-receipt-coverage", "operation_id": "get_receipt_coverage", "method": "GET", "path": "/api/v1/transactions/receipt-coverage", "summary": "Receipt coverage", "deprecated": false }, { "slug": "get-receipt-policy", "operation_id": "get_receipt_policy", "method": "GET", "path": "/api/v1/transactions/receipt-policy", "summary": "Get receipt tracking policy", "deprecated": false }, { "slug": "update-receipt-policy", "operation_id": "update_receipt_policy", "method": "PATCH", "path": "/api/v1/transactions/receipt-policy", "summary": "Update receipt tracking policy", "deprecated": false }, { "slug": "list-transaction-sources", "operation_id": "list_transaction_sources", "method": "GET", "path": "/api/v1/transactions/sources", "summary": "Transaction sources in use", "deprecated": false }, { "slug": "suggest-categories", "operation_id": "suggest_categories", "method": "POST", "path": "/api/v1/transactions/suggest-categories", "summary": "Category suggestions", "deprecated": false }, { "slug": "get-bulk-suggested-matches", "operation_id": "get_bulk_suggested_matches", "method": "POST", "path": "/api/v1/transactions/suggested-matches/batch", "summary": "Suggested matches for a batch of transactions", "deprecated": false }, { "slug": "dismiss-suggested-match", "operation_id": "dismiss_suggested_match", "method": "POST", "path": "/api/v1/transactions/suggested-matches/dismiss", "summary": "Dismiss a suggested match", "deprecated": false }, { "slug": "delete-transaction", "operation_id": "delete_transaction", "method": "DELETE", "path": "/api/v1/transactions/{transaction_id}", "summary": "Delete or hide transaction", "deprecated": false }, { "slug": "get-transaction", "operation_id": "get_transaction", "method": "GET", "path": "/api/v1/transactions/{transaction_id}", "summary": "Get transaction", "deprecated": false }, { "slug": "update-transaction", "operation_id": "update_transaction", "method": "PUT", "path": "/api/v1/transactions/{transaction_id}", "summary": "Update transaction", "deprecated": false }, { "slug": "get-transaction-allocations", "operation_id": "get_transaction_allocations", "method": "GET", "path": "/api/v1/transactions/{transaction_id}/allocations", "summary": "Get transaction allocations", "deprecated": false }, { "slug": "attach-file-to-transaction", "operation_id": "attach_file_to_transaction", "method": "PATCH", "path": "/api/v1/transactions/{transaction_id}/attachment", "summary": "Attach file to transaction", "deprecated": false }, { "slug": "import-ramp-receipts", "operation_id": "import_ramp_receipts", "method": "POST", "path": "/api/v1/transactions/{transaction_id}/attachments/import-ramp", "summary": "Import receipts from Ramp", "deprecated": false }, { "slug": "remove-transaction-attachment", "operation_id": "remove_transaction_attachment", "method": "DELETE", "path": "/api/v1/transactions/{transaction_id}/attachments/{attachment_id}", "summary": "Remove attachment from transaction", "deprecated": false }, { "slug": "extract-transaction-attachment", "operation_id": "extract_transaction_attachment", "method": "POST", "path": "/api/v1/transactions/{transaction_id}/attachments/{attachment_id}/extract", "summary": "Read receipt details from an attachment", "deprecated": false }, { "slug": "restore-transaction", "operation_id": "restore_transaction", "method": "POST", "path": "/api/v1/transactions/{transaction_id}/restore", "summary": "Restore a hidden transaction", "deprecated": false }, { "slug": "split-transaction", "operation_id": "split_transaction", "method": "PATCH", "path": "/api/v1/transactions/{transaction_id}/split", "summary": "Split a transaction across categories", "deprecated": false }, { "slug": "get-transaction-suggested-matches", "operation_id": "get_transaction_suggested_matches", "method": "GET", "path": "/api/v1/transactions/{transaction_id}/suggested-matches", "summary": "Suggested matches for a transaction", "deprecated": false } ], "description": "Bank transactions — sync, categorize, review, and reconcile.", "description_html": "Bank transactions — sync, categorize, review, and reconcile.
\n" }, { "name": "user", "slug": "user", "operations": [ { "slug": "list-users", "operation_id": "list_users", "method": "GET", "path": "/api/v1/users", "summary": "List users", "deprecated": false }, { "slug": "create-user", "operation_id": "create_user", "method": "POST", "path": "/api/v1/users", "summary": "Create user", "deprecated": false }, { "slug": "get-last-business", "operation_id": "get_last_business", "method": "GET", "path": "/api/v1/users/me/last-business", "summary": "Get last-selected business", "deprecated": false }, { "slug": "set-last-business", "operation_id": "set_last_business", "method": "PUT", "path": "/api/v1/users/me/last-business", "summary": "Set last-selected business", "deprecated": false }, { "slug": "get-mfa-status", "operation_id": "get_mfa_status", "method": "GET", "path": "/api/v1/users/me/mfa-status", "summary": "Get MFA enforcement status", "deprecated": false }, { "slug": "delete-user", "operation_id": "delete_user", "method": "DELETE", "path": "/api/v1/users/{user_id}", "summary": "Delete user", "deprecated": false }, { "slug": "get-user", "operation_id": "get_user", "method": "GET", "path": "/api/v1/users/{user_id}", "summary": "Get user", "deprecated": false }, { "slug": "update-user", "operation_id": "update_user", "method": "PUT", "path": "/api/v1/users/{user_id}", "summary": "Update user", "deprecated": false } ], "description": "User profile and preferences.", "description_html": "User profile and preferences.
\n" }, { "name": "vendor-bill-requests", "slug": "vendor-bill-requests", "operations": [ { "slug": "list-vendor-bill-request-links", "operation_id": "list_vendor_bill_request_links", "method": "GET", "path": "/api/v1/vendor-bill-requests", "summary": "List vendor bill-request links", "deprecated": false }, { "slug": "create-vendor-bill-request-link", "operation_id": "create_vendor_bill_request_link", "method": "POST", "path": "/api/v1/vendor-bill-requests", "summary": "Create a vendor bill-request link", "deprecated": false }, { "slug": "revoke-vendor-bill-request-link", "operation_id": "revoke_vendor_bill_request_link", "method": "DELETE", "path": "/api/v1/vendor-bill-requests/{link_id}", "summary": "Revoke a vendor bill-request link", "deprecated": false } ] }, { "name": "vendor-bill-requests-public", "slug": "vendor-bill-requests-public", "operations": [ { "slug": "fetch-public-bill-request", "operation_id": "fetch_public_bill_request", "method": "GET", "path": "/api/v1/public/bill-requests/{token}", "summary": "Vendor bill-request form metadata (unauthenticated)", "deprecated": false }, { "slug": "submit-public-bill-request", "operation_id": "submit_public_bill_request", "method": "POST", "path": "/api/v1/public/bill-requests/{token}", "summary": "Submit a bill through a bill-request link (unauthenticated)", "deprecated": false } ] }, { "name": "vendor-contracts", "slug": "vendor-contracts", "operations": [ { "slug": "list-vendor-contracts", "operation_id": "list_vendor_contracts", "method": "GET", "path": "/api/v1/vendor-contracts", "summary": "List vendor contracts", "deprecated": false }, { "slug": "create-vendor-contract", "operation_id": "create_vendor_contract", "method": "POST", "path": "/api/v1/vendor-contracts", "summary": "Create vendor contract", "deprecated": false }, { "slug": "analyze-contracts", "operation_id": "analyze_contracts", "method": "POST", "path": "/api/v1/vendor-contracts/analyze", "summary": "AI contract analysis", "deprecated": false }, { "slug": "delete-vendor-contract", "operation_id": "delete_vendor_contract", "method": "DELETE", "path": "/api/v1/vendor-contracts/{contract_id}", "summary": "Delete vendor contract", "deprecated": false }, { "slug": "get-vendor-contract", "operation_id": "get_vendor_contract", "method": "GET", "path": "/api/v1/vendor-contracts/{contract_id}", "summary": "Get vendor contract", "deprecated": false }, { "slug": "update-vendor-contract", "operation_id": "update_vendor_contract", "method": "PUT", "path": "/api/v1/vendor-contracts/{contract_id}", "summary": "Update vendor contract", "deprecated": false } ], "description": "Vendor contract tracking with renewal alerts and spend analysis.", "description_html": "Vendor contract tracking with renewal alerts and spend analysis.
\n" }, { "name": "vendor-credits", "slug": "vendor-credits", "operations": [ { "slug": "list-vendor-credits", "operation_id": "list_vendor_credits", "method": "GET", "path": "/api/v1/vendor-credits", "summary": "List vendor credits", "deprecated": false }, { "slug": "create-vendor-credit", "operation_id": "create_vendor_credit", "method": "POST", "path": "/api/v1/vendor-credits", "summary": "Create vendor credit", "deprecated": false }, { "slug": "get-vendor-credits-summary", "operation_id": "get_vendor_credits_summary", "method": "GET", "path": "/api/v1/vendor-credits/vendors/{vendor_id}/credits", "summary": "Get vendor available credits", "deprecated": false }, { "slug": "delete-vendor-credit", "operation_id": "delete_vendor_credit", "method": "DELETE", "path": "/api/v1/vendor-credits/{vendor_credit_id}", "summary": "Delete vendor credit", "deprecated": false }, { "slug": "get-vendor-credit", "operation_id": "get_vendor_credit", "method": "GET", "path": "/api/v1/vendor-credits/{vendor_credit_id}", "summary": "Get vendor credit", "deprecated": false }, { "slug": "update-vendor-credit", "operation_id": "update_vendor_credit", "method": "PUT", "path": "/api/v1/vendor-credits/{vendor_credit_id}", "summary": "Update vendor credit", "deprecated": false }, { "slug": "apply-vendor-credit", "operation_id": "apply_vendor_credit", "method": "POST", "path": "/api/v1/vendor-credits/{vendor_credit_id}/apply", "summary": "Apply vendor credit to bill", "deprecated": false }, { "slug": "issue-vendor-credit", "operation_id": "issue_vendor_credit", "method": "POST", "path": "/api/v1/vendor-credits/{vendor_credit_id}/issue", "summary": "Issue vendor credit", "deprecated": false }, { "slug": "generate-vendor-credit-journal-entry", "operation_id": "generate_vendor_credit_journal_entry", "method": "POST", "path": "/api/v1/vendor-credits/{vendor_credit_id}/journal-entry", "summary": "Generate vendor credit journal entry", "deprecated": false }, { "slug": "attach-vendor-credit-journal-entry", "operation_id": "attach_vendor_credit_journal_entry", "method": "POST", "path": "/api/v1/vendor-credits/{vendor_credit_id}/journal-entry/link", "summary": "Attach journal entry to vendor credit", "deprecated": false }, { "slug": "unapply-vendor-credit", "operation_id": "unapply_vendor_credit", "method": "POST", "path": "/api/v1/vendor-credits/{vendor_credit_id}/unapply", "summary": "Un-apply vendor credit from bill", "deprecated": false }, { "slug": "void-vendor-credit", "operation_id": "void_vendor_credit", "method": "POST", "path": "/api/v1/vendor-credits/{vendor_credit_id}/void", "summary": "Void vendor credit", "deprecated": false } ] }, { "name": "vendors", "slug": "vendors", "operations": [ { "slug": "list-vendors", "operation_id": "list_vendors", "method": "GET", "path": "/api/v1/vendors", "summary": "List vendors", "deprecated": false }, { "slug": "create-vendor", "operation_id": "create_vendor", "method": "POST", "path": "/api/v1/vendors", "summary": "Create vendor", "deprecated": false }, { "slug": "bulk-upload-vendors", "operation_id": "bulk_upload_vendors", "method": "POST", "path": "/api/v1/vendors/bulk-upload", "summary": "Bulk upload vendors from CSV", "deprecated": false }, { "slug": "download-vendor-bulk-upload-template", "operation_id": "download_vendor_bulk_upload_template", "method": "GET", "path": "/api/v1/vendors/bulk-upload/template", "summary": "Download bulk vendor upload CSV template", "deprecated": false }, { "slug": "check-duplicates", "operation_id": "check_duplicates_vendors", "method": "GET", "path": "/api/v1/vendors/check-duplicates", "summary": "Check for duplicate vendors", "deprecated": false }, { "slug": "delete-vendor", "operation_id": "delete_vendor", "method": "DELETE", "path": "/api/v1/vendors/{id}", "summary": "Delete vendor", "deprecated": false }, { "slug": "get-vendor", "operation_id": "get_vendor", "method": "GET", "path": "/api/v1/vendors/{id}", "summary": "Get vendor", "deprecated": false }, { "slug": "update-vendor", "operation_id": "update_vendor", "method": "PUT", "path": "/api/v1/vendors/{id}", "summary": "Update vendor", "deprecated": false }, { "slug": "list-contacts", "operation_id": "list_contacts_vendors", "method": "GET", "path": "/api/v1/vendors/{vendor_id}/contacts", "summary": "List vendor contacts", "deprecated": false }, { "slug": "create-contact", "operation_id": "create_contact_vendors", "method": "POST", "path": "/api/v1/vendors/{vendor_id}/contacts", "summary": "Create vendor contact", "deprecated": false }, { "slug": "delete-contact", "operation_id": "delete_contact_vendors", "method": "DELETE", "path": "/api/v1/vendors/{vendor_id}/contacts/{contact_id}", "summary": "Delete vendor contact", "deprecated": false }, { "slug": "get-contact", "operation_id": "get_contact_vendors", "method": "GET", "path": "/api/v1/vendors/{vendor_id}/contacts/{contact_id}", "summary": "Get vendor contact", "deprecated": false }, { "slug": "update-contact", "operation_id": "update_contact_vendors", "method": "PUT", "path": "/api/v1/vendors/{vendor_id}/contacts/{contact_id}", "summary": "Update vendor contact", "deprecated": false } ], "description": "Vendor management — accounts payable counterparties.", "description_html": "Vendor management — accounts payable counterparties.
\n" } ] }