Qb Time MCP Server

🚀 QuickBooks Time Card API Documentation

This API provides functionalities to interact with the QuickBooks time card system, enabling data query and manipulation.

✨ Features

• Retrieve and manage user information.
• Operate on work time records.
• Generate payroll and project reports.
• Configure and retrieve custom fields.
• Monitor object modification status.
• Manage notifications and customers.

📚 User-Related Interfaces

get_users

Retrieve information of all users in the system.

Parameters:

{
    "page": number,
    "limit": number
}

Return Value:

{
    "users": [],
    "total_pages": number,
    "current_page": number
}

get_user

Retrieve information of a single user based on the ID.

Parameters:

{
    "id": number
}

Return Value:

{
    "user": {
        "id": number,
        "name": string,
        "email": string,
        "status": string,
        "role": string,
        "time_zone": string,
        "last_login": string,
        "created_at": string,
        "updated_at": string
    }
}

create_user

Create a new user.

Parameters:

{
    "name": string,
    "email": string,
    "password": string,
    "role": string,
    "time_zone": string
}

Return Value:

{
    "user": {
        "id": number,
        "name": string,
        "email": string,
        "status": string,
        "role": string,
        "time_zone": string,
        "last_login": string,
        "created_at": string,
        "updated_at": string
    }
}

update_user

Update user information.

Parameters:

{
    "id": number,
    "name": string,
    "email": string,
    "role": string,
    "time_zone": string
}

Return Value:

{
    "user": {
        "id": number,
        "name": string,
        "email": string,
        "status": string,
        "role": string,
        "time_zone": string,
        "last_login": string,
        "created_at": string,
        "updated_at": string
    }
}

delete_user

Delete a user.

Parameters:

{
    "id": number
}

📚 Time Card-Related Interfaces

get_timecards

Retrieve all time card records.

Parameters:

{
    "user_id": number,
    "start_date": string,
    "end_date": string,
    "status": string,
    "page": number,
    "limit": number
}

Return Value:

{
    "timecards": [],
    "total_pages": number,
    "current_page": number
}

get_timecard

Retrieve a single time card record based on the ID.

Parameters:

{
    "id": number
}

Return Value:

{
    "timecard": {
        "id": number,
        "user_id": number,
        "date": string,
        "start_time": string,
        "end_time": string,
        "duration": number,
        "status": string,
        "notes": string,
        "created_at": string,
        "updated_at": string
    }
}

create_timecard

Create a new time card record.

Parameters:

{
    "user_id": number,
    "date": string,
    "start_time": string,
    "end_time": string,
    "duration": number,
    "status": string,
    "notes": string
}

Return Value:

{
    "timecard": {
        "id": number,
        "user_id": number,
        "date": string,
        "start_time": string,
        "end_time": string,
        "duration": number,
        "status": string,
        "notes": string,
        "created_at": string,
        "updated_at": string
    }
}

update_timecard

Update a time card record.

Parameters:

{
    "id": number,
    "user_id": number,
    "date": string,
    "start_time": string,
    "end_time": string,
    "duration": number,
    "status": string,
    "notes": string
}

Return Value:

{
    "timecard": {
        "id": number,
        "user_id": number,
        "date": string,
        "start_time": string,
        "end_time": string,
        "duration": number,
        "status": string,
        "notes": string,
        "created_at": string,
        "updated_at": string
    }
}

delete_timecard

Delete a time card record.

Parameters:

{
    "id": number
}

📚 Report-Related Interfaces

generate_payroll_report

Generate a payroll report.

Parameters:

{
    "start_date": string,
    "end_date": string,
    "user_id": number,
    "department": string,
    "status": string
}

Return Value:

{
    "report": {
        "id": number,
        "start_date": string,
        "end_date": string,
        "total_hours": number,
        "total_overtime": number,
        "subtotal": number,
        "taxes": number,
        "grand_total": number,
        "created_at": string
    }
}

generate_project_report

Generate a project report.

Parameters:

{
    "project_id": number,
    "start_date": string,
    "end_date": string,
    "user_id": number,
    "status": string
}

Return Value:

{
    "report": {
        "id": number,
        "project_id": number,
        "start_date": string,
        "end_date": string,
        "total_hours": number,
        "subtotal": number,
        "grand_total": number,
        "created_at": string
    }
}

📚 Custom Field-Related Interfaces

get_custom_fields

Retrieve all custom fields.

Parameters:

{
    "page": number,
    "limit": number
}

Return Value:

{
    "custom_fields": [],
    "total_pages": number,
    "current_page": number
}

get_custom_field

Retrieve a single custom field based on the ID.

Parameters:

{
    "id": number
}

Return Value:

{
    "custom_field": {
        "id": number,
        "name": string,
        "type": string,
        "required": boolean,
        "options": array,
        "created_at": string,
        "updated_at": string
    }
}

create_custom_field

Create a new custom field.

Parameters:

{
    "name": string,
    "type": string,
    "required": boolean,
    "options": array
}

Return Value:

{
    "custom_field": {
        "id": number,
        "name": string,
        "type": string,
        "required": boolean,
        "options": array,
        "created_at": string,
        "updated_at": string
    }
}

update_custom_field

Update a custom field.

Parameters:

{
    "id": number,
    "name": string,
    "type": string,
    "required": boolean,
    "options": array
}

Return Value:

{
    "custom_field": {
        "id": number,
        "name": string,
        "type": string,
        "required": boolean,
        "options": array,
        "created_at": string,
        "updated_at": string
    }
}

delete_custom_field

Delete a custom field.

Parameters:

{
    "id": number
}

📚 Object Modification Status-Related Interfaces

get_last_modified

Retrieve the last modification time of a specified object.

Parameters:

{
    "object_type": string,
    "object_id": number
}

Return Value:

{
    "last_modified_at": string
}

📚 System Management-Related Interfaces

backup_system

Back up system data.

No request parameters.

Return Value:

{
    "status": string,
    "message": string
}

restore_system

Restore system data.

No request parameters.

Return Value:

{
    "status": string,
    "message": string
}

🚀 Quick Start

To use this API in your project, follow these steps:

1. Install dependencies:

npm install quickbooks-node

2. Initialize the client:

const QuickBooks = require('quickbooks-node');
const qb = new QuickBooks({
    consumerKey: 'your_consumer_key',
    consumerSecret: 'your_consumer_secret',
    accessToken: 'your_access_token',
    accessTokenSecret: 'your_access_secret'
});

3. Use API methods:

qb.users.get()
  .then(user => {
    console.log('Logged in as:', user.name);
  })
  .catch(err => {
    console.error('Error:', err);
  });

📚 Documentation

For more detailed information, refer to QuickBooks API Documentation.

📄 License

MIT License

👥 Contributors

List of contributors:

• John Doe
• Jane Smith