> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# BigChange

> How to set up the BigChange connector, plus the actions that are available.

![BigChange](https://stackone-logos.com/api/bigchange/filled/svg)

Previewv1.4.1[See changelog](https://docs.stackone.com/connectors/bigchange/changelog.md)

[144 actions](#actions) · 1 auth method

Accounting
CRM
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/bigchange/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Uses an API key created in the BigChange Developer Portal for one BigChange customer account. The connection has the acc...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/bigchange/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Scopes

Select all
|
Clear

contacts:persons:read

contacts:persons:write

contacts:read

contacts:write

finance:read

finance:write

jobs:read

jobs:write

notes:read

notes:write

resources:read

resources:write

stock:read

stock:write

users:read

users:write

vehicles:read

vehicles:write

worksheets:read

No scopes found

144 actions

ActionDescriptionRequired scopes

List Contacts`bigchange_list_contacts`

Retrieve a paged collection of contacts

`contacts:read`

Get Contact`bigchange_get_contact`

Retrieve the details of a single contact

`contacts:read`

Create Contact`bigchange_create_contact`

Create a new contact

`contacts:write`

Update Contact`bigchange_update_contact`

Update the details of a single contact

`contacts:write`

List Contact Groups`bigchange_list_contact_groups`

Retrieve a paged collection of contact groups

`contacts:read`

Get Contact Group`bigchange_get_contact_group`

Retrieve the details of a single contact group

`contacts:read`

Create Contact Group`bigchange_create_contact_group`

Create a new contact group

`contacts:write`

Update Contact Group`bigchange_update_contact_group`

Update an existing contact group

`contacts:write`

List Department Codes`bigchange_list_department_codes`

Retrieve a paged collection of department codes

`stock:read`

Get Department Code`bigchange_get_department_code`

Retrieve the details of a single department code

`stock:read`

List Invoices`bigchange_list_invoices`

Retrieve a paged collection of invoices

`finance:read`

Get Invoice`bigchange_get_invoice`

Retrieve the details of a single invoice

`finance:read`

Create Invoice`bigchange_create_invoice`

Create a new invoice

`finance:write`

Update Invoice`bigchange_update_invoice`

Update an existing invoice

`finance:write`

Cancel Invoice`bigchange_cancel_invoice`

Mark an invoice as cancelled

`finance:write`

Create Invoice Document`bigchange_create_invoice_document`

Create a PDF document for an invoice

`finance:write`

List Invoice Line Items`bigchange_list_invoice_line_items`

Retrieve a paged list of line items for an invoice

`finance:read`

Get Invoice Line Item`bigchange_get_invoice_line_item`

Retrieve the details of a single invoice line item

`finance:read`

Create Invoice Line Item`bigchange_create_invoice_line_item`

Create a new invoice line item

`finance:write`

Update Invoice Line Item`bigchange_update_invoice_line_item`

Update an existing invoice line item

`finance:write`

Delete Invoice Line Item`bigchange_delete_invoice_line_item`

Delete a line item from an invoice

`finance:write`

Mark Invoice Paid`bigchange_mark_invoice_paid`

Mark an invoice as paid

`finance:write`

Mark Invoice Sent`bigchange_mark_invoice_sent`

Mark an invoice as sent

`finance:write`

List Jobs`bigchange_list_jobs`

Retrieve a paged collection of jobs. At least one of the filters \[Id, Reference] must be set, or at least one of the dat...

`jobs:read`

Get Job`bigchange_get_job`

Retrieve the details of a single job

`jobs:read`

Create Job`bigchange_create_job`

Create a new job

`jobs:write`

Update Job`bigchange_update_job`

Update an existing job

`jobs:write`

Cancel Job`bigchange_cancel_job`

Cancel a specific job. The job cannot be cancelled if it has already been started, suspended or completed.

`jobs:write`

List Job Constraints`bigchange_list_job_constraints`

Retrieve a paged collection of a job's constraints

`jobs:read`

Create Job Constraint`bigchange_create_job_constraint`

Create a new job constraint

`jobs:write`

Delete Job Constraint`bigchange_delete_job_constraint`

Delete a job constraint

`jobs:write`

Set Job Result`bigchange_set_job_result`

Set a job's result

`jobs:write`

List Job Stocks`bigchange_list_job_stocks`

Retrieve a paged collection of job stocks

`jobs:read`

Get Job Stock`bigchange_get_job_stock`

Retrieve the details of a single job stock

`jobs:read`

Create Job Stock`bigchange_create_job_stock`

Create a new job stock

`jobs:write`

Delete Job Stock`bigchange_delete_job_stock`

Permanently delete a job stock

`jobs:write`

List Job Worksheets`bigchange_list_job_worksheets`

Retrieve a paged collection of worksheets for a given job

`jobs:read`

Get Job Worksheet`bigchange_get_job_worksheet`

Retrieve the details of a single job worksheet

`jobs:read`

List Job Groups`bigchange_list_job_groups`

Retrieve a paged collection of job groups

`jobs:read`

Get Job Group`bigchange_get_job_group`

Retrieve the details of a single job group

`jobs:read`

Get Job Group Status History`bigchange_get_job_group_status_history`

Get the status history of a job group showing all status changes over time

`jobs:read`

Create Job Group`bigchange_create_job_group`

Create a new job group

`jobs:write`

Update Job Group`bigchange_update_job_group`

Update an existing job group

`jobs:write`

Complete Job Group`bigchange_complete_job_group`

Mark a job group as complete

`jobs:write`

Complete Job Group Financially`bigchange_complete_job_group_financially`

Mark a job group as financially complete

`jobs:write`

List Job Types`bigchange_list_job_types`

Retrieve a paged collection of job types

`jobs:read`

Get Job Type`bigchange_get_job_type`

Retrieve the details of a single job type

`jobs:read`

List Nominal Codes`bigchange_list_nominal_codes`

Retrieve a paged collection of nominal codes

`stock:read`

Get Nominal Code`bigchange_get_nominal_code`

Retrieve the details of a single nominal code

`stock:read`

List Notes`bigchange_list_notes`

Retrieve a paged collection of notes on contacts, jobs, sales opportunities and other records

`notes:read`

Get Note`bigchange_get_note`

Retrieve the details of a single note

`notes:read`

Create Note`bigchange_create_note`

Create a new note

`notes:write`

Update Note`bigchange_update_note`

Update an existing note

`notes:write`

Update Note Progress`bigchange_update_note_progress`

Update a note's progress percentage

`notes:write`

Get Note Progress History`bigchange_get_note_progress_history`

Get the history of progress updates for a note

`notes:read`

Delete Note`bigchange_delete_note`

Delete a note

`notes:write`

List Note Comments`bigchange_list_note_comments`

Retrieve a paged collection of comments on a note

`notes:read`

Create Note Comment`bigchange_create_note_comment`

Add a comment to a note

`notes:write`

List Note Types`bigchange_list_note_types`

Retrieve a paged collection of note types

`notes:read`

Get Note Type`bigchange_get_note_type`

Retrieve the details of a single note type

`notes:read`

List Persons`bigchange_list_persons`

Retrieve a paged collection of persons

`contacts:persons:read`

Get Person`bigchange_get_person`

Retrieve the details of a single person

`contacts:persons:read`

Create Person`bigchange_create_person`

Create a new person

`contacts:persons:write`

Update Person`bigchange_update_person`

Update an existing person

`contacts:persons:write`

Set Person Data Consent`bigchange_set_person_data_consent`

Set a person's data consent status

`contacts:persons:write`

Get Person Consent History`bigchange_get_person_consent_history`

Get the complete consent history for a person showing all consent changes over time

`contacts:persons:read`

List Purchase Orders`bigchange_list_purchase_orders`

Retrieve a paged collection of purchase orders

`finance:read`

Get Purchase Order`bigchange_get_purchase_order`

Retrieve the details of a single purchase order

`finance:read`

Create Purchase Order`bigchange_create_purchase_order`

Create a new purchase order

`finance:write`

Update Purchase Order`bigchange_update_purchase_order`

Update an existing purchase order

`finance:write`

Mark Purchase Order Sent`bigchange_mark_purchase_order_sent`

Mark a purchase order as sent

`finance:write`

Mark Purchase Order Received`bigchange_mark_purchase_order_received`

Mark a purchase order as received

`finance:write`

Mark Purchase Order Cancelled`bigchange_mark_purchase_order_cancelled`

Mark a purchase order as cancelled

`finance:write`

List Purchase Order Series`bigchange_list_purchase_order_series`

Retrieve a paged collection of purchase order series

`finance:read`

Get Purchase Order Series`bigchange_get_purchase_order_series`

Retrieve the details of a single purchase order series

`finance:read`

List Purchase Order Line Items`bigchange_list_purchase_order_line_items`

Retrieve a paged list of line items for a purchase order

`finance:read`

Get Purchase Order Line Item`bigchange_get_purchase_order_line_item`

Retrieve the details of a single purchase order line item

`finance:read`

Create Purchase Order Line Item`bigchange_create_purchase_order_line_item`

Create a new purchase order line item

`finance:write`

Update Purchase Order Line Item`bigchange_update_purchase_order_line_item`

Update an existing purchase order line item

`finance:write`

Delete Purchase Order Line Item`bigchange_delete_purchase_order_line_item`

Delete a line item from a purchase order

`finance:write`

List Quotes`bigchange_list_quotes`

Retrieve a paged collection of quotes

`finance:read`

Get Quote`bigchange_get_quote`

Retrieve the details of a single quote

`finance:read`

Create Quote`bigchange_create_quote`

Create a new quote

`finance:write`

Update Quote`bigchange_update_quote`

Update an existing quote

`finance:write`

Mark Quote Sent`bigchange_mark_quote_sent`

Mark a quote as sent

`finance:write`

Mark Quote Accepted`bigchange_mark_quote_accepted`

Mark a quote as accepted

`finance:write`

Mark Quote Rejected`bigchange_mark_quote_rejected`

Mark a quote as rejected

`finance:write`

List Quote Line Items`bigchange_list_quote_line_items`

Retrieve a paged list of line items for a quote

`finance:read`

Get Quote Line Item`bigchange_get_quote_line_item`

Retrieve the details of a single quote line item

`finance:read`

Create Quote Line Item`bigchange_create_quote_line_item`

Create a new quote line item

`finance:write`

Update Quote Line Item`bigchange_update_quote_line_item`

Update an existing quote line item

`finance:write`

Delete Quote Line Item`bigchange_delete_quote_line_item`

Delete a line item from a quote

`finance:write`

List Resources`bigchange_list_resources`

Retrieve a paged collection of resources (workforce/employees)

`resources:read`

Get Resource`bigchange_get_resource`

Retrieve the details of a single resource

`resources:read`

Create Resource`bigchange_create_resource`

Create a new resource (workforce/employee)

`resources:write`

Update Resource`bigchange_update_resource`

Update an existing resource

`resources:write`

List Resource Groups`bigchange_list_resource_groups`

Retrieve a paged collection of resource groups for organizing workforce teams

`resources:read`

Get Resource Group`bigchange_get_resource_group`

Retrieve the details of a single resource group

`resources:read`

List Sales Opportunities`bigchange_list_sales_opportunities`

Retrieve a paged collection of sales opportunities

`finance:read`

Get Sales Opportunity`bigchange_get_sales_opportunity`

Retrieve the details of a single sales opportunity

`finance:read`

Create Sales Opportunity`bigchange_create_sales_opportunity`

Create a new sales opportunity

`finance:write`

Update Sales Opportunity`bigchange_update_sales_opportunity`

Update an existing sales opportunity

`finance:write`

List Sales Opportunity Jobs`bigchange_list_sales_opportunity_jobs`

Retrieve a paged list of jobs for a sales opportunity

`finance:read`

List Sales Opportunity Stages`bigchange_list_sales_opportunity_stages`

Retrieve a paged collection of sales opportunity stages

`finance:read`

List Sales Opportunity Probabilities`bigchange_list_sales_opportunity_probabilities`

Retrieve a paged collection of sales opportunity probabilities

`finance:read`

List Sales Opportunity Line Items`bigchange_list_sales_opportunity_line_items`

Retrieve a paged list of line items for a sales opportunity

`finance:read`

Get Sales Opportunity Line Item`bigchange_get_sales_opportunity_line_item`

Retrieve the details of a single sales opportunity line item

`finance:read`

Create Sales Opportunity Line Item`bigchange_create_sales_opportunity_line_item`

Create a new sales opportunity line item

`finance:write`

Update Sales Opportunity Line Item`bigchange_update_sales_opportunity_line_item`

Update an existing sales opportunity line item

`finance:write`

Delete Sales Opportunity Line Item`bigchange_delete_sales_opportunity_line_item`

Delete a line item from a sales opportunity

`finance:write`

List Product Categories`bigchange_list_product_categories`

Retrieve a paged collection of product categories

`stock:read`

Get Product Category`bigchange_get_product_category`

Retrieve the details of a single product category

`stock:read`

List Stock Details`bigchange_list_stock_details`

Retrieve a paged collection of stock details

`stock:read`

Get Stock Details`bigchange_get_stock_details`

Retrieve the details of a single stock details entity

`stock:read`

Create Stock Details`bigchange_create_stock_details`

Create a new stock details entity

`stock:write`

Update Stock Details`bigchange_update_stock_details`

Update an existing stock details entity

`stock:write`

List Stock Suppliers`bigchange_list_stock_suppliers`

Retrieve a paged collection of stock suppliers

`stock:read`

Get Stock Supplier`bigchange_get_stock_supplier`

Retrieve a stock supplier by its ID

`stock:read`

Create Stock Supplier`bigchange_create_stock_supplier`

Create a new stock supplier

`stock:write`

Update Stock Supplier`bigchange_update_stock_supplier`

Update the details of a stock supplier

`stock:write`

List Stock Items`bigchange_list_stock_items`

Retrieve a paged collection of stock items

`stock:read`

Get Stock Item`bigchange_get_stock_item`

Retrieve a single stock item

`stock:read`

Create Stock Item`bigchange_create_stock_item`

Create a new stock item

`stock:write`

Update Stock Item`bigchange_update_stock_item`

Update an existing stock item

`stock:write`

List Stock Movements`bigchange_list_stock_movements`

Retrieve a paged collection of stock movements

`stock:read`

List Users`bigchange_list_users`

Retrieve a paged collection of users

`users:read`

Get User`bigchange_get_user`

Retrieve the details of a single user

`users:read`

Create User`bigchange_create_user`

Create a new user

`users:write`

Update User`bigchange_update_user`

Update an existing user

`users:write`

List Vehicles`bigchange_list_vehicles`

Retrieve a paged collection of vehicles

`vehicles:read`

Get Vehicle`bigchange_get_vehicle`

Retrieve the details of a single vehicle

`vehicles:read`

Create Vehicle`bigchange_create_vehicle`

Create a new vehicle

`vehicles:write`

Update Vehicle`bigchange_update_vehicle`

Update an existing vehicle

`vehicles:write`

List Worksheets`bigchange_list_worksheets`

Retrieve a paged collection of worksheets

`worksheets:read`

Get Worksheet`bigchange_get_worksheet`

Retrieve the details of a single worksheet

`worksheets:read`

List Worksheet Questions`bigchange_list_worksheet_questions`

Retrieve the worksheet questions for a given worksheet

`worksheets:read`

List Worksheet Answers`bigchange_list_worksheet_answers`

Retrieve a paged collection of worksheet answers

`worksheets:read`

List Worksheet Groups`bigchange_list_worksheet_groups`

Retrieve a paged collection of worksheet groups

`worksheets:read`

Get Worksheet Group`bigchange_get_worksheet_group`

Retrieve the details of a single worksheet group

`worksheets:read`

Get Unified Credentials`bigchange_unified_get_me`

Get the current BigChange connection's unified credentials and identity.

`users:read`

List Unified Organizations`bigchange_unified_list_organizations`

List unified organizations in BigChange.

`users:read`

Get Unified Organization`bigchange_unified_get_organization`

Get a unified BigChange organization by ID.

`users:read`

List Unified Users`bigchange_unified_list_users`

List unified users in BigChange.

`users:read`

Get Unified User`bigchange_unified_get_user`

Get a unified BigChange user by ID.

`users:read`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.