> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# quickbooks
> QuickBooks Online accounting and financial management
**Server path:** `/quickbooks` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| [`quickbooks_create_account`](#quickbooks_create_account) | Create a new account in QuickBooks Online |
| [`quickbooks_create_attachable`](#quickbooks_create_attachable) | Create a new Attachable in QuickBooks Online |
| [`quickbooks_create_bill`](#quickbooks_create_bill) | Create a new bill in QuickBooks Online |
| [`quickbooks_create_billpayment`](#quickbooks_create_billpayment) | Create a new bill payment in QuickBooks Online |
| [`quickbooks_create_class`](#quickbooks_create_class) | Create a new Class in QuickBooks Online |
| [`quickbooks_create_credit_memo`](#quickbooks_create_credit_memo) | Create a new credit memo in QuickBooks Online |
| [`quickbooks_create_customer`](#quickbooks_create_customer) | Create a new customer in QuickBooks Online |
| [`quickbooks_create_department`](#quickbooks_create_department) | Create a new Department in QuickBooks Online |
| [`quickbooks_create_deposit`](#quickbooks_create_deposit) | Create a new Deposit in QuickBooks Online |
| [`quickbooks_create_employee`](#quickbooks_create_employee) | Create a new employee in QuickBooks Online |
| [`quickbooks_create_estimate`](#quickbooks_create_estimate) | Create a new estimate in QuickBooks Online |
| [`quickbooks_create_invoice`](#quickbooks_create_invoice) | Create a new invoice in QuickBooks Online |
| [`quickbooks_create_item`](#quickbooks_create_item) | Create a new item in QuickBooks Online |
| [`quickbooks_create_journal_entry`](#quickbooks_create_journal_entry) | Create a new JournalEntry in QuickBooks Online |
| [`quickbooks_create_payment`](#quickbooks_create_payment) | Create a new payment in QuickBooks Online |
| [`quickbooks_create_payment_method`](#quickbooks_create_payment_method) | Create a new PaymentMethod in QuickBooks Online |
| [`quickbooks_create_purchase`](#quickbooks_create_purchase) | Create a new purchase in QuickBooks Online |
| [`quickbooks_create_purchase_order`](#quickbooks_create_purchase_order) | Create a new purchase order in QuickBooks Online |
| [`quickbooks_create_refund_receipt`](#quickbooks_create_refund_receipt) | Create a new refund receipt in QuickBooks Online |
| [`quickbooks_create_sales_receipt`](#quickbooks_create_sales_receipt) | Create a new sales receipt in QuickBooks Online |
| [`quickbooks_create_term`](#quickbooks_create_term) | Create a new Term in QuickBooks Online |
| [`quickbooks_create_time_activity`](#quickbooks_create_time_activity) | Create a new TimeActivity in QuickBooks Online |
| [`quickbooks_create_transfer`](#quickbooks_create_transfer) | Create a new Transfer in QuickBooks Online |
| [`quickbooks_create_vendor`](#quickbooks_create_vendor) | Create a new vendor in QuickBooks Online |
| [`quickbooks_create_vendor_credit`](#quickbooks_create_vendor_credit) | Create a new vendor credit in QuickBooks Online |
| [`quickbooks_delete_attachable`](#quickbooks_delete_attachable) | Delete a Attachable from QuickBooks Online |
| [`quickbooks_delete_bill`](#quickbooks_delete_bill) | Delete a bill from QuickBooks Online |
| [`quickbooks_delete_billpayment`](#quickbooks_delete_billpayment) | Delete a bill payment from QuickBooks Online |
| [`quickbooks_delete_credit_memo`](#quickbooks_delete_credit_memo) | Delete a credit memo from QuickBooks Online |
| [`quickbooks_delete_customer`](#quickbooks_delete_customer) | Deactivate (soft-delete) a customer in QuickBooks Online by setting Active: false. QuickBooks does not support hard-deletion of customers. |
| [`quickbooks_delete_deposit`](#quickbooks_delete_deposit) | Delete a Deposit from QuickBooks Online |
| [`quickbooks_delete_employee`](#quickbooks_delete_employee) | Deactivate (soft-delete) an employee in QuickBooks Online by setting Active: false. QuickBooks does not support hard-deletion of employees. |
| [`quickbooks_delete_estimate`](#quickbooks_delete_estimate) | Delete an estimate from QuickBooks Online |
| [`quickbooks_delete_invoice`](#quickbooks_delete_invoice) | Delete an invoice from QuickBooks Online |
| [`quickbooks_delete_item`](#quickbooks_delete_item) | Deactivate (soft-delete) an item in QuickBooks Online by setting Active: false. QuickBooks does not support hard-deletion of items. |
| [`quickbooks_delete_journal_entry`](#quickbooks_delete_journal_entry) | Delete a JournalEntry from QuickBooks Online |
| [`quickbooks_delete_payment`](#quickbooks_delete_payment) | Delete a payment from QuickBooks Online |
| [`quickbooks_delete_purchase`](#quickbooks_delete_purchase) | Delete a purchase from QuickBooks Online |
| [`quickbooks_delete_purchase_order`](#quickbooks_delete_purchase_order) | Delete a purchase order from QuickBooks Online |
| [`quickbooks_delete_refund_receipt`](#quickbooks_delete_refund_receipt) | Delete a refund receipt from QuickBooks Online |
| [`quickbooks_delete_sales_receipt`](#quickbooks_delete_sales_receipt) | Delete a sales receipt from QuickBooks Online |
| [`quickbooks_delete_time_activity`](#quickbooks_delete_time_activity) | Delete a TimeActivity from QuickBooks Online |
| [`quickbooks_delete_transfer`](#quickbooks_delete_transfer) | Delete a Transfer from QuickBooks Online |
| [`quickbooks_delete_vendor`](#quickbooks_delete_vendor) | Deactivate (soft-delete) a vendor in QuickBooks Online by setting Active: false. QuickBooks does not support hard-deletion of vendors. |
| [`quickbooks_delete_vendor_credit`](#quickbooks_delete_vendor_credit) | Delete a vendor credit from QuickBooks Online |
| [`quickbooks_get_account`](#quickbooks_get_account) | Get an account by ID from QuickBooks Online |
| [`quickbooks_get_aged_payables_report`](#quickbooks_get_aged_payables_report) | Generate an Aged Payables (A/P Aging Summary) report from QuickBooks Online |
| [`quickbooks_get_aged_receivable_detail_report`](#quickbooks_get_aged_receivable_detail_report) | Generate an Aged Receivable Detail report from QuickBooks Online |
| [`quickbooks_get_aged_receivables_report`](#quickbooks_get_aged_receivables_report) | Generate an Aged Receivables (A/R Aging Summary) report from QuickBooks Online |
| [`quickbooks_get_attachable`](#quickbooks_get_attachable) | Get a Attachable by ID from QuickBooks Online |
| [`quickbooks_get_balance_sheet_report`](#quickbooks_get_balance_sheet_report) | Generate a Balance Sheet report from QuickBooks Online |
| [`quickbooks_get_bill`](#quickbooks_get_bill) | Get a bill by ID from QuickBooks Online |
| [`quickbooks_get_billpayment`](#quickbooks_get_billpayment) | Get a bill payment by ID from QuickBooks Online |
| [`quickbooks_get_cash_flow_report`](#quickbooks_get_cash_flow_report) | Generate a Statement of Cash Flows report from QuickBooks Online |
| [`quickbooks_get_class`](#quickbooks_get_class) | Get a Class by ID from QuickBooks Online |
| [`quickbooks_get_company_info`](#quickbooks_get_company_info) | Get company information from QuickBooks Online |
| [`quickbooks_get_credit_memo`](#quickbooks_get_credit_memo) | Get a credit memo by ID from QuickBooks Online |
| [`quickbooks_get_customer`](#quickbooks_get_customer) | Get a customer by ID from QuickBooks Online |
| [`quickbooks_get_customer_balance_report`](#quickbooks_get_customer_balance_report) | Generate a Customer Balance Summary report from QuickBooks Online |
| [`quickbooks_get_customer_sales_report`](#quickbooks_get_customer_sales_report) | Generate a Sales by Customer Summary report from QuickBooks Online |
| [`quickbooks_get_department`](#quickbooks_get_department) | Get a Department by ID from QuickBooks Online |
| [`quickbooks_get_deposit`](#quickbooks_get_deposit) | Get a Deposit by ID from QuickBooks Online |
| [`quickbooks_get_employee`](#quickbooks_get_employee) | Get an employee by ID from QuickBooks Online |
| [`quickbooks_get_estimate`](#quickbooks_get_estimate) | Get an estimate by ID from QuickBooks Online |
| [`quickbooks_get_general_ledger_report`](#quickbooks_get_general_ledger_report) | Generate a General Ledger report from QuickBooks Online |
| [`quickbooks_get_invoice`](#quickbooks_get_invoice) | Get an invoice by ID from QuickBooks Online |
| [`quickbooks_get_item`](#quickbooks_get_item) | Get an item by ID from QuickBooks Online |
| [`quickbooks_get_journal_entry`](#quickbooks_get_journal_entry) | Get a JournalEntry by ID from QuickBooks Online |
| [`quickbooks_get_payment`](#quickbooks_get_payment) | Get a payment by ID from QuickBooks Online |
| [`quickbooks_get_payment_method`](#quickbooks_get_payment_method) | Get a PaymentMethod by ID from QuickBooks Online |
| [`quickbooks_get_profit_and_loss_report`](#quickbooks_get_profit_and_loss_report) | Generate a Profit and Loss (Income Statement) report from QuickBooks Online |
| [`quickbooks_get_purchase`](#quickbooks_get_purchase) | Get a purchase by ID from QuickBooks Online |
| [`quickbooks_get_purchase_order`](#quickbooks_get_purchase_order) | Get a purchase order by ID from QuickBooks Online |
| [`quickbooks_get_refund_receipt`](#quickbooks_get_refund_receipt) | Get a refund receipt by ID from QuickBooks Online |
| [`quickbooks_get_sales_receipt`](#quickbooks_get_sales_receipt) | Get a sales receipt by ID from QuickBooks Online |
| [`quickbooks_get_tax_agency`](#quickbooks_get_tax_agency) | Get a TaxAgency by ID from QuickBooks Online |
| [`quickbooks_get_tax_code`](#quickbooks_get_tax_code) | Get a TaxCode by ID from QuickBooks Online |
| [`quickbooks_get_tax_rate`](#quickbooks_get_tax_rate) | Get a TaxRate by ID from QuickBooks Online |
| [`quickbooks_get_term`](#quickbooks_get_term) | Get a Term by ID from QuickBooks Online |
| [`quickbooks_get_time_activity`](#quickbooks_get_time_activity) | Get a TimeActivity by ID from QuickBooks Online |
| [`quickbooks_get_transfer`](#quickbooks_get_transfer) | Get a Transfer by ID from QuickBooks Online |
| [`quickbooks_get_trial_balance_report`](#quickbooks_get_trial_balance_report) | Generate a Trial Balance report from QuickBooks Online |
| [`quickbooks_get_vendor`](#quickbooks_get_vendor) | Get a vendor by ID from QuickBooks Online |
| [`quickbooks_get_vendor_credit`](#quickbooks_get_vendor_credit) | Get a vendor credit by ID from QuickBooks Online |
| [`quickbooks_get_vendor_expenses_report`](#quickbooks_get_vendor_expenses_report) | Generate a Vendor Expenses report from QuickBooks Online |
| [`quickbooks_query_account`](#quickbooks_query_account) | Query accounts in QuickBooks Online using SQL-like syntax |
| [`quickbooks_query_attachables`](#quickbooks_query_attachables) | Query attachables in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_billpayments`](#quickbooks_query_billpayments) | Query bill payments in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_bills`](#quickbooks_query_bills) | Query bills in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_classes`](#quickbooks_query_classes) | Query classes in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_credit_memo`](#quickbooks_query_credit_memo) | Query credit memos in QuickBooks Online using SQL-like syntax |
| [`quickbooks_query_customers`](#quickbooks_query_customers) | Query customers in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_departments`](#quickbooks_query_departments) | Query departments in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_deposits`](#quickbooks_query_deposits) | Query deposits in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_employees`](#quickbooks_query_employees) | Query employees in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_estimates`](#quickbooks_query_estimates) | Query estimates in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_invoices`](#quickbooks_query_invoices) | Query invoices in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_item`](#quickbooks_query_item) | Query items in QuickBooks Online using SQL-like syntax |
| [`quickbooks_query_journal_entries`](#quickbooks_query_journal_entries) | Query journal entries in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_payment_methods`](#quickbooks_query_payment_methods) | Query payment methods in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_payments`](#quickbooks_query_payments) | Query payments in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_purchase`](#quickbooks_query_purchase) | Query purchases in QuickBooks Online using SQL-like syntax |
| [`quickbooks_query_purchase_order`](#quickbooks_query_purchase_order) | Query purchase orders in QuickBooks Online using SQL-like syntax |
| [`quickbooks_query_refund_receipt`](#quickbooks_query_refund_receipt) | Query refund receipts in QuickBooks Online using SQL-like syntax |
| [`quickbooks_query_sales_receipt`](#quickbooks_query_sales_receipt) | Query sales receipts in QuickBooks Online using SQL-like syntax |
| [`quickbooks_query_tax_agencies`](#quickbooks_query_tax_agencies) | Query tax agencies in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_tax_codes`](#quickbooks_query_tax_codes) | Query tax codes in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_tax_rates`](#quickbooks_query_tax_rates) | Query tax rates in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_terms`](#quickbooks_query_terms) | Query terms in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_time_activities`](#quickbooks_query_time_activities) | Query time activities in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_transfers`](#quickbooks_query_transfers) | Query transfers in QuickBooks Online using a SQL-like query string |
| [`quickbooks_query_vendor_credit`](#quickbooks_query_vendor_credit) | Query vendor credits in QuickBooks Online using SQL-like syntax |
| [`quickbooks_query_vendors`](#quickbooks_query_vendors) | Query vendors in QuickBooks Online using a SQL-like query string |
| [`quickbooks_update_account`](#quickbooks_update_account) | Update an existing account in QuickBooks Online |
| [`quickbooks_update_attachable`](#quickbooks_update_attachable) | Update an existing Attachable in QuickBooks Online. The full Attachable object including Id and SyncToken must be provided. |
| [`quickbooks_update_bill`](#quickbooks_update_bill) | Update an existing bill in QuickBooks Online. The full bill object including Id and SyncToken must be provided. |
| [`quickbooks_update_billpayment`](#quickbooks_update_billpayment) | Update an existing bill payment in QuickBooks Online. The full bill payment object including Id and SyncToken must be provided. |
| [`quickbooks_update_class`](#quickbooks_update_class) | Update an existing Class in QuickBooks Online. The full Class object including Id and SyncToken must be provided. |
| [`quickbooks_update_company_info`](#quickbooks_update_company_info) | Update company information in QuickBooks Online. The full CompanyInfo object including Id and SyncToken must be provided. |
| [`quickbooks_update_credit_memo`](#quickbooks_update_credit_memo) | Update an existing credit memo in QuickBooks Online |
| [`quickbooks_update_customer`](#quickbooks_update_customer) | Update an existing customer in QuickBooks Online. The full customer object including Id and SyncToken must be provided. |
| [`quickbooks_update_department`](#quickbooks_update_department) | Update an existing Department in QuickBooks Online. The full Department object including Id and SyncToken must be provided. |
| [`quickbooks_update_deposit`](#quickbooks_update_deposit) | Update an existing Deposit in QuickBooks Online. The full Deposit object including Id and SyncToken must be provided. |
| [`quickbooks_update_employee`](#quickbooks_update_employee) | Update an existing employee in QuickBooks Online. The full employee object including Id and SyncToken must be provided. |
| [`quickbooks_update_estimate`](#quickbooks_update_estimate) | Update an existing estimate in QuickBooks Online. The full estimate object including Id and SyncToken must be provided. |
| [`quickbooks_update_invoice`](#quickbooks_update_invoice) | Update an existing invoice in QuickBooks Online. The full invoice object including Id and SyncToken must be provided. |
| [`quickbooks_update_item`](#quickbooks_update_item) | Update an existing item in QuickBooks Online |
| [`quickbooks_update_journal_entry`](#quickbooks_update_journal_entry) | Update an existing JournalEntry in QuickBooks Online. The full JournalEntry object including Id and SyncToken must be provided. |
| [`quickbooks_update_payment`](#quickbooks_update_payment) | Update an existing payment in QuickBooks Online. The full payment object including Id and SyncToken must be provided. |
| [`quickbooks_update_payment_method`](#quickbooks_update_payment_method) | Update an existing PaymentMethod in QuickBooks Online. The full PaymentMethod object including Id and SyncToken must be provided. |
| [`quickbooks_update_purchase`](#quickbooks_update_purchase) | Update an existing purchase in QuickBooks Online |
| [`quickbooks_update_purchase_order`](#quickbooks_update_purchase_order) | Update an existing purchase order in QuickBooks Online |
| [`quickbooks_update_refund_receipt`](#quickbooks_update_refund_receipt) | Update an existing refund receipt in QuickBooks Online |
| [`quickbooks_update_sales_receipt`](#quickbooks_update_sales_receipt) | Update an existing sales receipt in QuickBooks Online |
| [`quickbooks_update_term`](#quickbooks_update_term) | Update an existing Term in QuickBooks Online. The full Term object including Id and SyncToken must be provided. |
| [`quickbooks_update_time_activity`](#quickbooks_update_time_activity) | Update an existing TimeActivity in QuickBooks Online. The full TimeActivity object including Id and SyncToken must be provided. |
| [`quickbooks_update_transfer`](#quickbooks_update_transfer) | Update an existing Transfer in QuickBooks Online. The full Transfer object including Id and SyncToken must be provided. |
| [`quickbooks_update_vendor`](#quickbooks_update_vendor) | Update an existing vendor in QuickBooks Online. The full vendor object including Id and SyncToken must be provided. |
| [`quickbooks_update_vendor_credit`](#quickbooks_update_vendor_credit) | Update an existing vendor credit in QuickBooks Online |
***
## quickbooks\_create\_account
Create a new account in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `account` | object | Yes | — | Account object. Required: Name, AccountType. Optional: AccountSubType, Description. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"account": {
"type": "object",
"description": "Account object. Required: Name, AccountType. Optional: AccountSubType, Description."
}
},
"required": [
"PCID",
"realmId",
"account"
]
}
```
***
## quickbooks\_create\_attachable
Create a new Attachable in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | --------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `attachable` | object | Yes | — | Attachable metadata object. Optional: FileName, ContentType, AttachableRef. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"attachable": {
"type": "object",
"description": "Attachable metadata object. Optional: FileName, ContentType, AttachableRef."
}
},
"required": [
"PCID",
"realmId",
"attachable"
]
}
```
***
## quickbooks\_create\_bill
Create a new bill in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `bill` | object | Yes | — | Bill object. Required fields: VendorRef, Line (array of line items). Optional: DueDate, TxnDate, APAccountRef, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"bill": {
"type": "object",
"description": "Bill object. Required fields: VendorRef, Line (array of line items). Optional: DueDate, TxnDate, APAccountRef, etc."
}
},
"required": [
"PCID",
"realmId",
"bill"
]
}
```
***
## quickbooks\_create\_billpayment
Create a new bill payment in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `billPayment` | object | Yes | — | BillPayment object. Required fields: VendorRef, TotalAmt, PayType, Line (linked bills). Optional: CheckPayment or CreditCardPayment details, TxnDate, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"billPayment": {
"type": "object",
"description": "BillPayment object. Required fields: VendorRef, TotalAmt, PayType, Line (linked bills). Optional: CheckPayment or CreditCardPayment details, TxnDate, etc."
}
},
"required": [
"PCID",
"realmId",
"billPayment"
]
}
```
***
## quickbooks\_create\_class
Create a new Class in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `class` | object | Yes | — | Class object. Required: Name. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"class": {
"type": "object",
"description": "Class object. Required: Name."
}
},
"required": [
"PCID",
"realmId",
"class"
]
}
```
***
## quickbooks\_create\_credit\_memo
Create a new credit memo in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `creditMemo` | object | Yes | — | Credit memo object. Required: CustomerRef, Line array. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"creditMemo": {
"type": "object",
"description": "Credit memo object. Required: CustomerRef, Line array."
}
},
"required": [
"PCID",
"realmId",
"creditMemo"
]
}
```
***
## quickbooks\_create\_customer
Create a new customer in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `customer` | object | Yes | — | Customer object. Required fields: DisplayName. Optional: PrimaryEmailAddr, PrimaryPhone, CompanyName, BillAddr, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"customer": {
"type": "object",
"description": "Customer object. Required fields: DisplayName. Optional: PrimaryEmailAddr, PrimaryPhone, CompanyName, BillAddr, etc."
}
},
"required": [
"PCID",
"realmId",
"customer"
]
}
```
***
## quickbooks\_create\_department
Create a new Department in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `department` | object | Yes | — | Department object. Required: Name. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"department": {
"type": "object",
"description": "Department object. Required: Name."
}
},
"required": [
"PCID",
"realmId",
"department"
]
}
```
***
## quickbooks\_create\_deposit
Create a new Deposit in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `deposit` | object | Yes | — | Deposit object. Required: DepositToAccountRef, Line array. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"deposit": {
"type": "object",
"description": "Deposit object. Required: DepositToAccountRef, Line array."
}
},
"required": [
"PCID",
"realmId",
"deposit"
]
}
```
***
## quickbooks\_create\_employee
Create a new employee in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `employee` | object | Yes | — | Employee object. Required fields: GivenName, FamilyName. Optional: PrimaryEmailAddr, PrimaryPhone, DisplayName, SSN, BillAddr, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"employee": {
"type": "object",
"description": "Employee object. Required fields: GivenName, FamilyName. Optional: PrimaryEmailAddr, PrimaryPhone, DisplayName, SSN, BillAddr, etc."
}
},
"required": [
"PCID",
"realmId",
"employee"
]
}
```
***
## quickbooks\_create\_estimate
Create a new estimate in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `estimate` | object | Yes | — | Estimate object. Required fields: CustomerRef, Line (array of line items). Optional: TxnDate, ExpirationDate, BillEmail, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"estimate": {
"type": "object",
"description": "Estimate object. Required fields: CustomerRef, Line (array of line items). Optional: TxnDate, ExpirationDate, BillEmail, etc."
}
},
"required": [
"PCID",
"realmId",
"estimate"
]
}
```
***
## quickbooks\_create\_invoice
Create a new invoice in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `invoice` | object | Yes | — | Invoice object. Required fields: CustomerRef, Line (array of line items). Optional: DueDate, TxnDate, BillEmail, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"invoice": {
"type": "object",
"description": "Invoice object. Required fields: CustomerRef, Line (array of line items). Optional: DueDate, TxnDate, BillEmail, etc."
}
},
"required": [
"PCID",
"realmId",
"invoice"
]
}
```
***
## quickbooks\_create\_item
Create a new item in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `item` | object | Yes | — | Item object. Required: Name, Type (Inventory/Service/NonInventory). For Inventory: IncomeAccountRef, ExpenseAccountRef, AssetAccountRef, QtyOnHand, InvStartDate required. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"item": {
"type": "object",
"description": "Item object. Required: Name, Type (Inventory/Service/NonInventory). For Inventory: IncomeAccountRef, ExpenseAccountRef, AssetAccountRef, QtyOnHand, InvStartDate required."
}
},
"required": [
"PCID",
"realmId",
"item"
]
}
```
***
## quickbooks\_create\_journal\_entry
Create a new JournalEntry in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ----------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `journal_entry` | object | Yes | — | Journal entry object. Required: Line array with JournalEntryLineDetail. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"journal_entry": {
"type": "object",
"description": "Journal entry object. Required: Line array with JournalEntryLineDetail."
}
},
"required": [
"PCID",
"realmId",
"journal_entry"
]
}
```
***
## quickbooks\_create\_payment
Create a new payment in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `payment` | object | Yes | — | Payment object. Required fields: CustomerRef, TotalAmt. Optional: PaymentMethodRef, DepositToAccountRef, Line (linked transactions), TxnDate, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"payment": {
"type": "object",
"description": "Payment object. Required fields: CustomerRef, TotalAmt. Optional: PaymentMethodRef, DepositToAccountRef, Line (linked transactions), TxnDate, etc."
}
},
"required": [
"PCID",
"realmId",
"payment"
]
}
```
***
## quickbooks\_create\_payment\_method
Create a new PaymentMethod in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `payment_method` | object | Yes | — | Payment method object. Required: Name. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"payment_method": {
"type": "object",
"description": "Payment method object. Required: Name."
}
},
"required": [
"PCID",
"realmId",
"payment_method"
]
}
```
***
## quickbooks\_create\_purchase
Create a new purchase in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | --------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `purchase` | object | Yes | — | Purchase object. Required: PaymentType (Cash/Check/CreditCard), AccountRef, Line array. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"purchase": {
"type": "object",
"description": "Purchase object. Required: PaymentType (Cash/Check/CreditCard), AccountRef, Line array."
}
},
"required": [
"PCID",
"realmId",
"purchase"
]
}
```
***
## quickbooks\_create\_purchase\_order
Create a new purchase order in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | --------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `purchaseOrder` | object | Yes | — | Purchase order object. Required: VendorRef, Line array, APAccountRef. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"purchaseOrder": {
"type": "object",
"description": "Purchase order object. Required: VendorRef, Line array, APAccountRef."
}
},
"required": [
"PCID",
"realmId",
"purchaseOrder"
]
}
```
***
## quickbooks\_create\_refund\_receipt
Create a new refund receipt in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `refundReceipt` | object | Yes | — | Refund receipt object. Required: Line array. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"refundReceipt": {
"type": "object",
"description": "Refund receipt object. Required: Line array."
}
},
"required": [
"PCID",
"realmId",
"refundReceipt"
]
}
```
***
## quickbooks\_create\_sales\_receipt
Create a new sales receipt in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ----------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `salesReceipt` | object | Yes | — | Sales receipt object. Required: Line array with at least one line item. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"salesReceipt": {
"type": "object",
"description": "Sales receipt object. Required: Line array with at least one line item."
}
},
"required": [
"PCID",
"realmId",
"salesReceipt"
]
}
```
***
## quickbooks\_create\_term
Create a new Term in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `term` | object | Yes | — | Term object. Required: Name, DueDays. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"term": {
"type": "object",
"description": "Term object. Required: Name, DueDays."
}
},
"required": [
"PCID",
"realmId",
"term"
]
}
```
***
## quickbooks\_create\_time\_activity
Create a new TimeActivity in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ----------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `time_activity` | object | Yes | — | Time activity object. Required: NameOf (Employee/Vendor), ActivityType. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"time_activity": {
"type": "object",
"description": "Time activity object. Required: NameOf (Employee/Vendor), ActivityType."
}
},
"required": [
"PCID",
"realmId",
"time_activity"
]
}
```
***
## quickbooks\_create\_transfer
Create a new Transfer in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ---------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `transfer` | object | Yes | — | Transfer object. Required: FromAccountRef, ToAccountRef, Amount. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"transfer": {
"type": "object",
"description": "Transfer object. Required: FromAccountRef, ToAccountRef, Amount."
}
},
"required": [
"PCID",
"realmId",
"transfer"
]
}
```
***
## quickbooks\_create\_vendor
Create a new vendor in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `vendor` | object | Yes | — | Vendor object. Required fields: DisplayName. Optional: PrimaryEmailAddr, PrimaryPhone, CompanyName, BillAddr, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"vendor": {
"type": "object",
"description": "Vendor object. Required fields: DisplayName. Optional: PrimaryEmailAddr, PrimaryPhone, CompanyName, BillAddr, etc."
}
},
"required": [
"PCID",
"realmId",
"vendor"
]
}
```
***
## quickbooks\_create\_vendor\_credit
Create a new vendor credit in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `vendorCredit` | object | Yes | — | Vendor credit object. Required: VendorRef, Line array. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"vendorCredit": {
"type": "object",
"description": "Vendor credit object. Required: VendorRef, Line array."
}
},
"required": [
"PCID",
"realmId",
"vendorCredit"
]
}
```
***
## quickbooks\_delete\_attachable
Delete a Attachable from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The Attachable ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The Attachable ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_bill
Delete a bill from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The bill ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The bill ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_billpayment
Delete a bill payment from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The bill payment ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The bill payment ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_credit\_memo
Delete a credit memo from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The credit memo ID to delete |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The credit memo ID to delete"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_customer
Deactivate (soft-delete) a customer in QuickBooks Online by setting Active: false. QuickBooks does not support hard-deletion of customers.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The customer ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
| `displayName` | string | Yes | — | The customer display name (required by QuickBooks update API) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The customer ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
},
"displayName": {
"type": "string",
"description": "The customer display name (required by QuickBooks update API)"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken",
"displayName"
]
}
```
***
## quickbooks\_delete\_deposit
Delete a Deposit from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The Deposit ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The Deposit ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_employee
Deactivate (soft-delete) an employee in QuickBooks Online by setting Active: false. QuickBooks does not support hard-deletion of employees.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The employee ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
| `displayName` | string | Yes | — | The employee display name (required by QuickBooks update API) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The employee ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
},
"displayName": {
"type": "string",
"description": "The employee display name (required by QuickBooks update API)"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken",
"displayName"
]
}
```
***
## quickbooks\_delete\_estimate
Delete an estimate from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The estimate ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The estimate ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_invoice
Delete an invoice from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The invoice ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The invoice ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_item
Deactivate (soft-delete) an item in QuickBooks Online by setting Active: false. QuickBooks does not support hard-deletion of items.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | ------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The item ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
| `name` | string | Yes | — | The item name (required by QuickBooks update API) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The item ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
},
"name": {
"type": "string",
"description": "The item name (required by QuickBooks update API)"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken",
"name"
]
}
```
***
## quickbooks\_delete\_journal\_entry
Delete a JournalEntry from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The JournalEntry ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The JournalEntry ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_payment
Delete a payment from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The payment ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The payment ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_purchase
Delete a purchase from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The purchase ID to delete |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The purchase ID to delete"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_purchase\_order
Delete a purchase order from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The purchase order ID to delete |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The purchase order ID to delete"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_refund\_receipt
Delete a refund receipt from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The refund receipt ID to delete |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The refund receipt ID to delete"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_sales\_receipt
Delete a sales receipt from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The sales receipt ID to delete |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The sales receipt ID to delete"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_time\_activity
Delete a TimeActivity from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The TimeActivity ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The TimeActivity ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_transfer
Delete a Transfer from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The Transfer ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The Transfer ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_delete\_vendor
Deactivate (soft-delete) a vendor in QuickBooks Online by setting Active: false. QuickBooks does not support hard-deletion of vendors.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ----------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The vendor ID |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
| `displayName` | string | Yes | — | The vendor display name (required by QuickBooks update API) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The vendor ID"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
},
"displayName": {
"type": "string",
"description": "The vendor display name (required by QuickBooks update API)"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken",
"displayName"
]
}
```
***
## quickbooks\_delete\_vendor\_credit
Delete a vendor credit from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `id` | string | Yes | — | The vendor credit ID to delete |
| `syncToken` | string | Yes | — | The sync token for concurrency control |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"id": {
"type": "string",
"description": "The vendor credit ID to delete"
},
"syncToken": {
"type": "string",
"description": "The sync token for concurrency control"
}
},
"required": [
"PCID",
"realmId",
"id",
"syncToken"
]
}
```
***
## quickbooks\_get\_account
Get an account by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `accountId` | string | Yes | — | The account ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"accountId": {
"type": "string",
"description": "The account ID"
}
},
"required": [
"PCID",
"realmId",
"accountId"
]
}
```
***
## quickbooks\_get\_aged\_payables\_report
Generate an Aged Payables (A/P Aging Summary) report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `report_date` | string | No | — | As-of date in YYYY-MM-DD format |
| `vendor` | string | No | — | Filter by vendor ID |
| `aging_method` | string | No | — | Aging method |
| `days_per_aging_period` | integer | No | — | Number of days per aging period |
| `num_periods` | integer | No | — | Number of aging periods |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"report_date": {
"type": "string",
"description": "As-of date in YYYY-MM-DD format"
},
"vendor": {
"type": "string",
"description": "Filter by vendor ID"
},
"aging_method": {
"type": "string",
"description": "Aging method",
"enum": [
"Current",
"Report_Date"
]
},
"days_per_aging_period": {
"type": "integer",
"description": "Number of days per aging period"
},
"num_periods": {
"type": "integer",
"description": "Number of aging periods"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_aged\_receivable\_detail\_report
Generate an Aged Receivable Detail report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `report_date` | string | No | — | As-of date in YYYY-MM-DD format |
| `customer` | string | No | — | Filter by customer ID |
| `aging_method` | string | No | — | Aging method |
| `days_per_aging_period` | integer | No | — | Number of days per aging period |
| `num_periods` | integer | No | — | Number of aging periods |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"report_date": {
"type": "string",
"description": "As-of date in YYYY-MM-DD format"
},
"customer": {
"type": "string",
"description": "Filter by customer ID"
},
"aging_method": {
"type": "string",
"description": "Aging method",
"enum": [
"Current",
"Report_Date"
]
},
"days_per_aging_period": {
"type": "integer",
"description": "Number of days per aging period"
},
"num_periods": {
"type": "integer",
"description": "Number of aging periods"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_aged\_receivables\_report
Generate an Aged Receivables (A/R Aging Summary) report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------- | ------- | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `report_date` | string | No | — | As-of date in YYYY-MM-DD format |
| `customer` | string | No | — | Filter by customer ID |
| `aging_method` | string | No | — | Aging method |
| `days_per_aging_period` | integer | No | — | Number of days per aging period |
| `num_periods` | integer | No | — | Number of aging periods |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"report_date": {
"type": "string",
"description": "As-of date in YYYY-MM-DD format"
},
"customer": {
"type": "string",
"description": "Filter by customer ID"
},
"aging_method": {
"type": "string",
"description": "Aging method",
"enum": [
"Current",
"Report_Date"
]
},
"days_per_aging_period": {
"type": "integer",
"description": "Number of days per aging period"
},
"num_periods": {
"type": "integer",
"description": "Number of aging periods"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_attachable
Get a Attachable by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `attachableId` | string | Yes | — | The Attachable ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"attachableId": {
"type": "string",
"description": "The Attachable ID"
}
},
"required": [
"PCID",
"realmId",
"attachableId"
]
}
```
***
## quickbooks\_get\_balance\_sheet\_report
Generate a Balance Sheet report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `start_date` | string | No | — | Start date in YYYY-MM-DD format |
| `end_date` | string | No | — | End date in YYYY-MM-DD format |
| `accounting_method` | string | No | — | Accounting method |
| `summarize_column_by` | string | No | — | Summarize columns by period |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"start_date": {
"type": "string",
"description": "Start date in YYYY-MM-DD format"
},
"end_date": {
"type": "string",
"description": "End date in YYYY-MM-DD format"
},
"accounting_method": {
"type": "string",
"description": "Accounting method",
"enum": [
"Cash",
"Accrual"
]
},
"summarize_column_by": {
"type": "string",
"description": "Summarize columns by period",
"enum": [
"Total",
"Month",
"Quarter",
"Year",
"Days"
]
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_bill
Get a bill by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `billId` | string | Yes | — | The bill ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"billId": {
"type": "string",
"description": "The bill ID"
}
},
"required": [
"PCID",
"realmId",
"billId"
]
}
```
***
## quickbooks\_get\_billpayment
Get a bill payment by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `billPaymentId` | string | Yes | — | The bill payment ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"billPaymentId": {
"type": "string",
"description": "The bill payment ID"
}
},
"required": [
"PCID",
"realmId",
"billPaymentId"
]
}
```
***
## quickbooks\_get\_cash\_flow\_report
Generate a Statement of Cash Flows report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `start_date` | string | No | — | Start date in YYYY-MM-DD format |
| `end_date` | string | No | — | End date in YYYY-MM-DD format |
| `accounting_method` | string | No | — | Accounting method |
| `summarize_column_by` | string | No | — | Summarize columns by period |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"start_date": {
"type": "string",
"description": "Start date in YYYY-MM-DD format"
},
"end_date": {
"type": "string",
"description": "End date in YYYY-MM-DD format"
},
"accounting_method": {
"type": "string",
"description": "Accounting method",
"enum": [
"Cash",
"Accrual"
]
},
"summarize_column_by": {
"type": "string",
"description": "Summarize columns by period",
"enum": [
"Total",
"Month",
"Quarter",
"Year",
"Days"
]
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_class
Get a Class by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `classId` | string | Yes | — | The Class ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"classId": {
"type": "string",
"description": "The Class ID"
}
},
"required": [
"PCID",
"realmId",
"classId"
]
}
```
***
## quickbooks\_get\_company\_info
Get company information from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_credit\_memo
Get a credit memo by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `creditMemoId` | string | Yes | — | The credit memo ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"creditMemoId": {
"type": "string",
"description": "The credit memo ID"
}
},
"required": [
"PCID",
"realmId",
"creditMemoId"
]
}
```
***
## quickbooks\_get\_customer
Get a customer by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `customerId` | string | Yes | — | The customer ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"customerId": {
"type": "string",
"description": "The customer ID"
}
},
"required": [
"PCID",
"realmId",
"customerId"
]
}
```
***
## quickbooks\_get\_customer\_balance\_report
Generate a Customer Balance Summary report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `report_date` | string | No | — | As-of date in YYYY-MM-DD format |
| `customer` | string | No | — | Filter by customer ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"report_date": {
"type": "string",
"description": "As-of date in YYYY-MM-DD format"
},
"customer": {
"type": "string",
"description": "Filter by customer ID"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_customer\_sales\_report
Generate a Sales by Customer Summary report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `start_date` | string | No | — | Start date in YYYY-MM-DD format |
| `end_date` | string | No | — | End date in YYYY-MM-DD format |
| `customer` | string | No | — | Filter by customer ID |
| `summarize_column_by` | string | No | — | Summarize columns by period |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"start_date": {
"type": "string",
"description": "Start date in YYYY-MM-DD format"
},
"end_date": {
"type": "string",
"description": "End date in YYYY-MM-DD format"
},
"customer": {
"type": "string",
"description": "Filter by customer ID"
},
"summarize_column_by": {
"type": "string",
"description": "Summarize columns by period",
"enum": [
"Total",
"Month",
"Quarter",
"Year",
"Days"
]
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_department
Get a Department by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `departmentId` | string | Yes | — | The Department ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"departmentId": {
"type": "string",
"description": "The Department ID"
}
},
"required": [
"PCID",
"realmId",
"departmentId"
]
}
```
***
## quickbooks\_get\_deposit
Get a Deposit by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `depositId` | string | Yes | — | The Deposit ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"depositId": {
"type": "string",
"description": "The Deposit ID"
}
},
"required": [
"PCID",
"realmId",
"depositId"
]
}
```
***
## quickbooks\_get\_employee
Get an employee by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `employeeId` | string | Yes | — | The employee ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"employeeId": {
"type": "string",
"description": "The employee ID"
}
},
"required": [
"PCID",
"realmId",
"employeeId"
]
}
```
***
## quickbooks\_get\_estimate
Get an estimate by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `estimateId` | string | Yes | — | The estimate ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"estimateId": {
"type": "string",
"description": "The estimate ID"
}
},
"required": [
"PCID",
"realmId",
"estimateId"
]
}
```
***
## quickbooks\_get\_general\_ledger\_report
Generate a General Ledger report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | ----------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `start_date` | string | No | — | Start date in YYYY-MM-DD format |
| `end_date` | string | No | — | End date in YYYY-MM-DD format |
| `accounting_method` | string | No | — | Accounting method |
| `summarize_column_by` | string | No | — | Summarize columns by period |
| `columns` | string | No | — | Comma-separated column names to include in the report |
| `sort_by` | string | No | — | Column to sort the report by |
| `sort_order` | string | No | — | Sort order |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"start_date": {
"type": "string",
"description": "Start date in YYYY-MM-DD format"
},
"end_date": {
"type": "string",
"description": "End date in YYYY-MM-DD format"
},
"accounting_method": {
"type": "string",
"description": "Accounting method",
"enum": [
"Cash",
"Accrual"
]
},
"summarize_column_by": {
"type": "string",
"description": "Summarize columns by period",
"enum": [
"Total",
"Month",
"Quarter",
"Year",
"Days"
]
},
"columns": {
"type": "string",
"description": "Comma-separated column names to include in the report"
},
"sort_by": {
"type": "string",
"description": "Column to sort the report by"
},
"sort_order": {
"type": "string",
"description": "Sort order",
"enum": [
"ascend",
"descend"
]
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_invoice
Get an invoice by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `invoiceId` | string | Yes | — | The invoice ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"invoiceId": {
"type": "string",
"description": "The invoice ID"
}
},
"required": [
"PCID",
"realmId",
"invoiceId"
]
}
```
***
## quickbooks\_get\_item
Get an item by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `itemId` | string | Yes | — | The item ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"itemId": {
"type": "string",
"description": "The item ID"
}
},
"required": [
"PCID",
"realmId",
"itemId"
]
}
```
***
## quickbooks\_get\_journal\_entry
Get a JournalEntry by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `journal_entryId` | string | Yes | — | The JournalEntry ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"journal_entryId": {
"type": "string",
"description": "The JournalEntry ID"
}
},
"required": [
"PCID",
"realmId",
"journal_entryId"
]
}
```
***
## quickbooks\_get\_payment
Get a payment by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `paymentId` | string | Yes | — | The payment ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"paymentId": {
"type": "string",
"description": "The payment ID"
}
},
"required": [
"PCID",
"realmId",
"paymentId"
]
}
```
***
## quickbooks\_get\_payment\_method
Get a PaymentMethod by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------ | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `payment_methodId` | string | Yes | — | The PaymentMethod ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"payment_methodId": {
"type": "string",
"description": "The PaymentMethod ID"
}
},
"required": [
"PCID",
"realmId",
"payment_methodId"
]
}
```
***
## quickbooks\_get\_profit\_and\_loss\_report
Generate a Profit and Loss (Income Statement) report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `start_date` | string | No | — | Start date in YYYY-MM-DD format |
| `end_date` | string | No | — | End date in YYYY-MM-DD format |
| `accounting_method` | string | No | — | Accounting method |
| `summarize_column_by` | string | No | — | Summarize columns by period |
| `customer` | string | No | — | Filter by customer ID |
| `department` | string | No | — | Filter by department |
| `class` | string | No | — | Filter by class |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"start_date": {
"type": "string",
"description": "Start date in YYYY-MM-DD format"
},
"end_date": {
"type": "string",
"description": "End date in YYYY-MM-DD format"
},
"accounting_method": {
"type": "string",
"description": "Accounting method",
"enum": [
"Cash",
"Accrual"
]
},
"summarize_column_by": {
"type": "string",
"description": "Summarize columns by period",
"enum": [
"Total",
"Month",
"Quarter",
"Year",
"Days"
]
},
"customer": {
"type": "string",
"description": "Filter by customer ID"
},
"department": {
"type": "string",
"description": "Filter by department"
},
"class": {
"type": "string",
"description": "Filter by class"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_purchase
Get a purchase by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `purchaseId` | string | Yes | — | The purchase ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"purchaseId": {
"type": "string",
"description": "The purchase ID"
}
},
"required": [
"PCID",
"realmId",
"purchaseId"
]
}
```
***
## quickbooks\_get\_purchase\_order
Get a purchase order by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `purchaseOrderId` | string | Yes | — | The purchase order ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"purchaseOrderId": {
"type": "string",
"description": "The purchase order ID"
}
},
"required": [
"PCID",
"realmId",
"purchaseOrderId"
]
}
```
***
## quickbooks\_get\_refund\_receipt
Get a refund receipt by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `refundReceiptId` | string | Yes | — | The refund receipt ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"refundReceiptId": {
"type": "string",
"description": "The refund receipt ID"
}
},
"required": [
"PCID",
"realmId",
"refundReceiptId"
]
}
```
***
## quickbooks\_get\_sales\_receipt
Get a sales receipt by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `salesReceiptId` | string | Yes | — | The sales receipt ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"salesReceiptId": {
"type": "string",
"description": "The sales receipt ID"
}
},
"required": [
"PCID",
"realmId",
"salesReceiptId"
]
}
```
***
## quickbooks\_get\_tax\_agency
Get a TaxAgency by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `tax_agencyId` | string | Yes | — | The TaxAgency ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"tax_agencyId": {
"type": "string",
"description": "The TaxAgency ID"
}
},
"required": [
"PCID",
"realmId",
"tax_agencyId"
]
}
```
***
## quickbooks\_get\_tax\_code
Get a TaxCode by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `tax_codeId` | string | Yes | — | The TaxCode ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"tax_codeId": {
"type": "string",
"description": "The TaxCode ID"
}
},
"required": [
"PCID",
"realmId",
"tax_codeId"
]
}
```
***
## quickbooks\_get\_tax\_rate
Get a TaxRate by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `tax_rateId` | string | Yes | — | The TaxRate ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"tax_rateId": {
"type": "string",
"description": "The TaxRate ID"
}
},
"required": [
"PCID",
"realmId",
"tax_rateId"
]
}
```
***
## quickbooks\_get\_term
Get a Term by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `termId` | string | Yes | — | The Term ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"termId": {
"type": "string",
"description": "The Term ID"
}
},
"required": [
"PCID",
"realmId",
"termId"
]
}
```
***
## quickbooks\_get\_time\_activity
Get a TimeActivity by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `time_activityId` | string | Yes | — | The TimeActivity ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"time_activityId": {
"type": "string",
"description": "The TimeActivity ID"
}
},
"required": [
"PCID",
"realmId",
"time_activityId"
]
}
```
***
## quickbooks\_get\_transfer
Get a Transfer by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `transferId` | string | Yes | — | The Transfer ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"transferId": {
"type": "string",
"description": "The Transfer ID"
}
},
"required": [
"PCID",
"realmId",
"transferId"
]
}
```
***
## quickbooks\_get\_trial\_balance\_report
Generate a Trial Balance report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `start_date` | string | No | — | Start date in YYYY-MM-DD format |
| `end_date` | string | No | — | End date in YYYY-MM-DD format |
| `accounting_method` | string | No | — | Accounting method |
| `summarize_column_by` | string | No | — | Summarize columns by period |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"start_date": {
"type": "string",
"description": "Start date in YYYY-MM-DD format"
},
"end_date": {
"type": "string",
"description": "End date in YYYY-MM-DD format"
},
"accounting_method": {
"type": "string",
"description": "Accounting method",
"enum": [
"Cash",
"Accrual"
]
},
"summarize_column_by": {
"type": "string",
"description": "Summarize columns by period",
"enum": [
"Total",
"Month",
"Quarter",
"Year",
"Days"
]
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_get\_vendor
Get a vendor by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `vendorId` | string | Yes | — | The vendor ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"vendorId": {
"type": "string",
"description": "The vendor ID"
}
},
"required": [
"PCID",
"realmId",
"vendorId"
]
}
```
***
## quickbooks\_get\_vendor\_credit
Get a vendor credit by ID from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `vendorCreditId` | string | Yes | — | The vendor credit ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"vendorCreditId": {
"type": "string",
"description": "The vendor credit ID"
}
},
"required": [
"PCID",
"realmId",
"vendorCreditId"
]
}
```
***
## quickbooks\_get\_vendor\_expenses\_report
Generate a Vendor Expenses report from QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | -------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `start_date` | string | No | — | Start date in YYYY-MM-DD format |
| `end_date` | string | No | — | End date in YYYY-MM-DD format |
| `vendor` | string | No | — | Filter by vendor ID |
| `summarize_column_by` | string | No | — | Summarize columns by period |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"start_date": {
"type": "string",
"description": "Start date in YYYY-MM-DD format"
},
"end_date": {
"type": "string",
"description": "End date in YYYY-MM-DD format"
},
"vendor": {
"type": "string",
"description": "Filter by vendor ID"
},
"summarize_column_by": {
"type": "string",
"description": "Summarize columns by period",
"enum": [
"Total",
"Month",
"Quarter",
"Year",
"Days"
]
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_account
Query accounts in QuickBooks Online using SQL-like syntax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g. "SELECT \* FROM Account WHERE AccountType = 'Bank'"). Defaults to "SELECT \* FROM Account" if not provided. |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g. \"SELECT * FROM Account WHERE AccountType = 'Bank'\"). Defaults to \"SELECT * FROM Account\" if not provided."
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_attachables
Query attachables in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Attachable WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Attachable WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_billpayments
Query bill payments in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM BillPayment WHERE TotalAmt > '100.00'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM BillPayment WHERE TotalAmt > '100.00'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_bills
Query bills in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Bill WHERE TotalAmt > '100.00'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Bill WHERE TotalAmt > '100.00'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_classes
Query classes in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Class WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Class WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_credit\_memo
Query credit memos in QuickBooks Online using SQL-like syntax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g. "SELECT \* FROM CreditMemo WHERE TotalAmt > '50'"). Defaults to "SELECT \* FROM CreditMemo" if not provided. |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g. \"SELECT * FROM CreditMemo WHERE TotalAmt > '50'\"). Defaults to \"SELECT * FROM CreditMemo\" if not provided."
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_customers
Query customers in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Customer WHERE DisplayName = 'John'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Customer WHERE DisplayName = 'John'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_departments
Query departments in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Department WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Department WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_deposits
Query deposits in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Deposit WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Deposit WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_employees
Query employees in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Employee WHERE FamilyName = 'Smith'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Employee WHERE FamilyName = 'Smith'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_estimates
Query estimates in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Estimate WHERE TotalAmt > '500.00'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Estimate WHERE TotalAmt > '500.00'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_invoices
Query invoices in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Invoice WHERE TotalAmt > '100.00'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Invoice WHERE TotalAmt > '100.00'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_item
Query items in QuickBooks Online using SQL-like syntax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g. "SELECT \* FROM Item WHERE Name = 'Widget'"). Defaults to "SELECT \* FROM Item" if not provided. |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g. \"SELECT * FROM Item WHERE Name = 'Widget'\"). Defaults to \"SELECT * FROM Item\" if not provided."
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_journal\_entries
Query journal entries in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM JournalEntry WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM JournalEntry WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_payment\_methods
Query payment methods in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM PaymentMethod WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM PaymentMethod WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_payments
Query payments in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Payment WHERE TotalAmt > '50.00'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Payment WHERE TotalAmt > '50.00'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_purchase
Query purchases in QuickBooks Online using SQL-like syntax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g. "SELECT \* FROM Purchase WHERE PaymentType = 'Cash'"). Defaults to "SELECT \* FROM Purchase" if not provided. |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g. \"SELECT * FROM Purchase WHERE PaymentType = 'Cash'\"). Defaults to \"SELECT * FROM Purchase\" if not provided."
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_purchase\_order
Query purchase orders in QuickBooks Online using SQL-like syntax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g. "SELECT \* FROM PurchaseOrder WHERE TotalAmt > '100'"). Defaults to "SELECT \* FROM PurchaseOrder" if not provided. |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g. \"SELECT * FROM PurchaseOrder WHERE TotalAmt > '100'\"). Defaults to \"SELECT * FROM PurchaseOrder\" if not provided."
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_refund\_receipt
Query refund receipts in QuickBooks Online using SQL-like syntax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g. "SELECT \* FROM RefundReceipt WHERE TotalAmt > '50'"). Defaults to "SELECT \* FROM RefundReceipt" if not provided. |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g. \"SELECT * FROM RefundReceipt WHERE TotalAmt > '50'\"). Defaults to \"SELECT * FROM RefundReceipt\" if not provided."
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_sales\_receipt
Query sales receipts in QuickBooks Online using SQL-like syntax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g. "SELECT \* FROM SalesReceipt WHERE TotalAmt > '100'"). Defaults to "SELECT \* FROM SalesReceipt" if not provided. |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g. \"SELECT * FROM SalesReceipt WHERE TotalAmt > '100'\"). Defaults to \"SELECT * FROM SalesReceipt\" if not provided."
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_tax\_agencies
Query tax agencies in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ----------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM TaxAgency WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM TaxAgency WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_tax\_codes
Query tax codes in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM TaxCode WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM TaxCode WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_tax\_rates
Query tax rates in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | --------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM TaxRate WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM TaxRate WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_terms
Query terms in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ------------------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Term WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Term WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_time\_activities
Query time activities in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM TimeActivity WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM TimeActivity WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_transfers
Query transfers in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | ---------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Transfer WHERE Id = '1'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Transfer WHERE Id = '1'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_vendor\_credit
Query vendor credits in QuickBooks Online using SQL-like syntax
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g. "SELECT \* FROM VendorCredit WHERE TotalAmt > '50'"). Defaults to "SELECT \* FROM VendorCredit" if not provided. |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g. \"SELECT * FROM VendorCredit WHERE TotalAmt > '50'\"). Defaults to \"SELECT * FROM VendorCredit\" if not provided."
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_query\_vendors
Query vendors in QuickBooks Online using a SQL-like query string
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `query` | string | No | — | SQL-like query string (e.g., "SELECT \* FROM Vendor WHERE DisplayName = 'Acme'") |
| `maxResults` | integer | No | — | Maximum number of results to return |
| `startPosition` | integer | No | — | Starting position for pagination (1-based) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"query": {
"type": "string",
"description": "SQL-like query string (e.g., \"SELECT * FROM Vendor WHERE DisplayName = 'Acme'\")"
},
"maxResults": {
"type": "integer",
"description": "Maximum number of results to return"
},
"startPosition": {
"type": "integer",
"description": "Starting position for pagination (1-based)"
}
},
"required": [
"PCID",
"realmId"
]
}
```
***
## quickbooks\_update\_account
Update an existing account in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `account` | object | Yes | — | Account object with updated fields. Must include Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"account": {
"type": "object",
"description": "Account object with updated fields. Must include Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"account"
]
}
```
***
## quickbooks\_update\_attachable
Update an existing Attachable in QuickBooks Online. The full Attachable object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `attachable` | object | Yes | — | Full Attachable object including Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"attachable": {
"type": "object",
"description": "Full Attachable object including Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"attachable"
]
}
```
***
## quickbooks\_update\_bill
Update an existing bill in QuickBooks Online. The full bill object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `bill` | object | Yes | — | Full bill object including Id and SyncToken. Required fields: Id, SyncToken, VendorRef, Line. Optional: DueDate, TxnDate, APAccountRef, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"bill": {
"type": "object",
"description": "Full bill object including Id and SyncToken. Required fields: Id, SyncToken, VendorRef, Line. Optional: DueDate, TxnDate, APAccountRef, etc."
}
},
"required": [
"PCID",
"realmId",
"bill"
]
}
```
***
## quickbooks\_update\_billpayment
Update an existing bill payment in QuickBooks Online. The full bill payment object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `billPayment` | object | Yes | — | Full bill payment object including Id and SyncToken. Required fields: Id, SyncToken, VendorRef, TotalAmt, PayType, Line. Optional: CheckPayment or CreditCardPayment details, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"billPayment": {
"type": "object",
"description": "Full bill payment object including Id and SyncToken. Required fields: Id, SyncToken, VendorRef, TotalAmt, PayType, Line. Optional: CheckPayment or CreditCardPayment details, etc."
}
},
"required": [
"PCID",
"realmId",
"billPayment"
]
}
```
***
## quickbooks\_update\_class
Update an existing Class in QuickBooks Online. The full Class object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `class` | object | Yes | — | Full Class object including Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"class": {
"type": "object",
"description": "Full Class object including Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"class"
]
}
```
***
## quickbooks\_update\_company\_info
Update company information in QuickBooks Online. The full CompanyInfo object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------- | ------ | -------- | ------- | --------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `companyInfo` | object | Yes | — | Full CompanyInfo object including Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"companyInfo": {
"type": "object",
"description": "Full CompanyInfo object including Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"companyInfo"
]
}
```
***
## quickbooks\_update\_credit\_memo
Update an existing credit memo in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | ---------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `creditMemo` | object | Yes | — | Credit memo object with updated fields. Must include Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"creditMemo": {
"type": "object",
"description": "Credit memo object with updated fields. Must include Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"creditMemo"
]
}
```
***
## quickbooks\_update\_customer
Update an existing customer in QuickBooks Online. The full customer object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `customer` | object | Yes | — | Full customer object including Id and SyncToken. Required fields: Id, SyncToken, DisplayName. Optional: PrimaryEmailAddr, PrimaryPhone, CompanyName, BillAddr, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"customer": {
"type": "object",
"description": "Full customer object including Id and SyncToken. Required fields: Id, SyncToken, DisplayName. Optional: PrimaryEmailAddr, PrimaryPhone, CompanyName, BillAddr, etc."
}
},
"required": [
"PCID",
"realmId",
"customer"
]
}
```
***
## quickbooks\_update\_department
Update an existing Department in QuickBooks Online. The full Department object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------ | ------ | -------- | ------- | -------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `department` | object | Yes | — | Full Department object including Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"department": {
"type": "object",
"description": "Full Department object including Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"department"
]
}
```
***
## quickbooks\_update\_deposit
Update an existing Deposit in QuickBooks Online. The full Deposit object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `deposit` | object | Yes | — | Full Deposit object including Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"deposit": {
"type": "object",
"description": "Full Deposit object including Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"deposit"
]
}
```
***
## quickbooks\_update\_employee
Update an existing employee in QuickBooks Online. The full employee object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `employee` | object | Yes | — | Full employee object including Id and SyncToken. Required fields: Id, SyncToken, GivenName, FamilyName. Optional: PrimaryEmailAddr, PrimaryPhone, DisplayName, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"employee": {
"type": "object",
"description": "Full employee object including Id and SyncToken. Required fields: Id, SyncToken, GivenName, FamilyName. Optional: PrimaryEmailAddr, PrimaryPhone, DisplayName, etc."
}
},
"required": [
"PCID",
"realmId",
"employee"
]
}
```
***
## quickbooks\_update\_estimate
Update an existing estimate in QuickBooks Online. The full estimate object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `estimate` | object | Yes | — | Full estimate object including Id and SyncToken. Required fields: Id, SyncToken, CustomerRef, Line. Optional: TxnDate, ExpirationDate, BillEmail, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"estimate": {
"type": "object",
"description": "Full estimate object including Id and SyncToken. Required fields: Id, SyncToken, CustomerRef, Line. Optional: TxnDate, ExpirationDate, BillEmail, etc."
}
},
"required": [
"PCID",
"realmId",
"estimate"
]
}
```
***
## quickbooks\_update\_invoice
Update an existing invoice in QuickBooks Online. The full invoice object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `invoice` | object | Yes | — | Full invoice object including Id and SyncToken. Required fields: Id, SyncToken, CustomerRef, Line. Optional: DueDate, TxnDate, BillEmail, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"invoice": {
"type": "object",
"description": "Full invoice object including Id and SyncToken. Required fields: Id, SyncToken, CustomerRef, Line. Optional: DueDate, TxnDate, BillEmail, etc."
}
},
"required": [
"PCID",
"realmId",
"invoice"
]
}
```
***
## quickbooks\_update\_item
Update an existing item in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | --------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `item` | object | Yes | — | Item object with updated fields. Must include Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"item": {
"type": "object",
"description": "Item object with updated fields. Must include Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"item"
]
}
```
***
## quickbooks\_update\_journal\_entry
Update an existing JournalEntry in QuickBooks Online. The full JournalEntry object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `journal_entry` | object | Yes | — | Full JournalEntry object including Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"journal_entry": {
"type": "object",
"description": "Full JournalEntry object including Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"journal_entry"
]
}
```
***
## quickbooks\_update\_payment
Update an existing payment in QuickBooks Online. The full payment object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `payment` | object | Yes | — | Full payment object including Id and SyncToken. Required fields: Id, SyncToken, CustomerRef, TotalAmt. Optional: PaymentMethodRef, DepositToAccountRef, Line, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"payment": {
"type": "object",
"description": "Full payment object including Id and SyncToken. Required fields: Id, SyncToken, CustomerRef, TotalAmt. Optional: PaymentMethodRef, DepositToAccountRef, Line, etc."
}
},
"required": [
"PCID",
"realmId",
"payment"
]
}
```
***
## quickbooks\_update\_payment\_method
Update an existing PaymentMethod in QuickBooks Online. The full PaymentMethod object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------- | ------ | -------- | ------- | ----------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `payment_method` | object | Yes | — | Full PaymentMethod object including Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"payment_method": {
"type": "object",
"description": "Full PaymentMethod object including Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"payment_method"
]
}
```
***
## quickbooks\_update\_purchase
Update an existing purchase in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `purchase` | object | Yes | — | Purchase object with updated fields. Must include Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"purchase": {
"type": "object",
"description": "Purchase object with updated fields. Must include Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"purchase"
]
}
```
***
## quickbooks\_update\_purchase\_order
Update an existing purchase order in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `purchaseOrder` | object | Yes | — | Purchase order object with updated fields. Must include Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"purchaseOrder": {
"type": "object",
"description": "Purchase order object with updated fields. Must include Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"purchaseOrder"
]
}
```
***
## quickbooks\_update\_refund\_receipt
Update an existing refund receipt in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `refundReceipt` | object | Yes | — | Refund receipt object with updated fields. Must include Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"refundReceipt": {
"type": "object",
"description": "Refund receipt object with updated fields. Must include Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"refundReceipt"
]
}
```
***
## quickbooks\_update\_sales\_receipt
Update an existing sales receipt in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `salesReceipt` | object | Yes | — | Sales receipt object with updated fields. Must include Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"salesReceipt": {
"type": "object",
"description": "Sales receipt object with updated fields. Must include Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"salesReceipt"
]
}
```
***
## quickbooks\_update\_term
Update an existing Term in QuickBooks Online. The full Term object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | -------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `term` | object | Yes | — | Full Term object including Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"term": {
"type": "object",
"description": "Full Term object including Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"term"
]
}
```
***
## quickbooks\_update\_time\_activity
Update an existing TimeActivity in QuickBooks Online. The full TimeActivity object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------- | ------ | -------- | ------- | ---------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `time_activity` | object | Yes | — | Full TimeActivity object including Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"time_activity": {
"type": "object",
"description": "Full TimeActivity object including Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"time_activity"
]
}
```
***
## quickbooks\_update\_transfer
Update an existing Transfer in QuickBooks Online. The full Transfer object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | ------ | -------- | ------- | ------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `transfer` | object | Yes | — | Full Transfer object including Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"transfer": {
"type": "object",
"description": "Full Transfer object including Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"transfer"
]
}
```
***
## quickbooks\_update\_vendor
Update an existing vendor in QuickBooks Online. The full vendor object including Id and SyncToken must be provided.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------- | ------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `vendor` | object | Yes | — | Full vendor object including Id and SyncToken. Required fields: Id, SyncToken, DisplayName. Optional: PrimaryEmailAddr, PrimaryPhone, CompanyName, BillAddr, etc. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"vendor": {
"type": "object",
"description": "Full vendor object including Id and SyncToken. Required fields: Id, SyncToken, DisplayName. Optional: PrimaryEmailAddr, PrimaryPhone, CompanyName, BillAddr, etc."
}
},
"required": [
"PCID",
"realmId",
"vendor"
]
}
```
***
## quickbooks\_update\_vendor\_credit
Update an existing vendor credit in QuickBooks Online
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | ------ | -------- | ------- | ------------------------------------------------------------------------ |
| `realmId` | string | Yes | — | QuickBooks company ID (realm ID) |
| `vendorCredit` | object | Yes | — | Vendor credit object with updated fields. Must include Id and SyncToken. |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"realmId": {
"type": "string",
"description": "QuickBooks company ID (realm ID)"
},
"vendorCredit": {
"type": "object",
"description": "Vendor credit object with updated fields. Must include Id and SyncToken."
}
},
"required": [
"PCID",
"realmId",
"vendorCredit"
]
}
```