Operations (sample payloads)
Main operationsCopy
Create accountCopy
Create an account.
Sample Input
1{2"access_token": "your_access_token_here",3"realm_id": "your_realm_id_here",4"name": "Marketing Expenses",5"account_number": "6000",6"tax_code_reference": "TAX",7"taxable": {8"account_type": "Expense - Expense"9}10}
Sample Output
1{2"Account": {3"Name": "Marketing Expenses",4"SubAccount": false,5"FullyQualifiedName": "Marketing Expenses",6"Active": true,7"Classification": "Expense",8"AccountType": "Expense",9"AccountSubType": "AdvertisingPromotional",10"AcctNum": "6000",11"CurrentBalance": 0,12"CurrentBalanceWithSubAccounts": 0,13"CurrencyRef": {14"value": "USD",15"name": "United States Dollar"16},17"TaxCodeRef": {18"value": "TAX"19},20"domain": "QBO",21"sparse": false,22"Id": "123",23"SyncToken": "0",24"MetaData": {25"CreateTime": "2023-04-20T10:30:00Z",26"LastUpdatedTime": "2023-04-20T10:30:00Z"27}28},29"time": "2023-04-20T10:30:00.123Z"30}
Create billCopy
Create a bill.
Sample Input
1{2"vendor_ref": {3"value": "56",4"name": "ABC Office Supplies"5},6"lines": [7{8"amount": 250,9"account_ref": {10"value": "72",11"name": "Office Supplies Expense"12},13"description": "Paper and ink cartridges",14"billable_status": "NotBillable"15},16{17"amount": 100,18"account_ref": {19"value": "73",20"name": "Postage Expense"21},22"description": "Shipping costs",23"billable_status": "Billable",24"customer_ref": {25"value": "34",26"name": "XYZ Corp"27}28}29],30"txn_date": "2023-06-15T00:00:00Z",31"currency_ref": {32"value": "USD",33"name": "United States Dollar"34}35}
Sample Output
1{2"Bill": {3"DueDate": "2023-07-15",4"Balance": 350,5"domain": "QBO",6"sparse": false,7"Id": "1234",8"SyncToken": "0",9"MetaData": {10"CreateTime": "2023-06-15T14:30:25-07:00",11"LastUpdatedTime": "2023-06-15T14:30:25-07:00"12},13"TxnDate": "2023-06-15",14"CurrencyRef": {15"value": "USD",16"name": "United States Dollar"17},18"Line": [19{20"Id": "1",21"LineNum": 1,22"Amount": 250,23"DetailType": "AccountBasedExpenseLineDetail",24"AccountBasedExpenseLineDetail": {25"AccountRef": {26"value": "72",27"name": "Office Supplies Expense"28},29"BillableStatus": "NotBillable",30"TaxCodeRef": {31"value": "NON"32}33}34},35{36"Id": "2",37"LineNum": 2,38"Amount": 100,39"DetailType": "AccountBasedExpenseLineDetail",40"AccountBasedExpenseLineDetail": {41"AccountRef": {42"value": "73",43"name": "Postage Expense"44},45"BillableStatus": "Billable",46"TaxCodeRef": {47"value": "NON"48}49}50}51],52"VendorRef": {53"value": "56",54"name": "ABC Office Supplies"55},56"APAccountRef": {57"value": "33",58"name": "Accounts Payable"59},60"TotalAmt": 35061},62"time": "2023-06-15T14:30:25-07:00"63}
Create customerCopy
Create a customer.
Sample Input
1{2"access_token": "YOUR_ACCESS_TOKEN",3"realm_id": "YOUR_REALM_ID",4"identifier": {5"display_name": "John Doe",6"given_name": "John",7"family_name": "Doe"8},9"company_name": "Doe Enterprises",10"primary_phone": "555-123-4567",11"primary_email_addr": "john.doe@example.com",12"bill_addr": {13"line_1": "123 Main St",14"city": "Anytown",15"country": "USA",16"postal_code": "12345"17},18"taxable": {19"default_tax_code_ref": "TAX"20},21"preferred_delivery_method": "Email"22}
Sample Output
1{2"Customer": {3"Id": "68",4"DisplayName": "John Doe",5"PrintOnCheckName": "John Doe",6"GivenName": "John",7"FamilyName": "Doe",8"FullyQualifiedName": "John Doe",9"CompanyName": "Doe Enterprises",10"Taxable": true,11"BillAddr": {12"Id": "69",13"Line1": "123 Main St",14"City": "Anytown",15"Country": "USA",16"PostalCode": "12345"17},18"Job": false,19"BillWithParent": false,20"Level": 0,21"Balance": 0,22"BalanceWithJobs": 0,23"CurrencyRef": {24"value": "USD",25"name": "United States Dollar"26},27"PreferredDeliveryMethod": "Email",28"domain": "QBO",29"sparse": false,30"SyncToken": "0",31"MetaData": {32"CreateTime": "2023-04-15T10:30:00-07:00",33"LastUpdatedTime": "2023-04-15T10:30:00-07:00"34},35"Active": true,36"PrimaryPhone": {37"FreeFormNumber": "555-123-4567"38},39"PrimaryEmailAddr": {40"Address": "john.doe@example.com"41},42"DefaultTaxCodeRef": {43"value": "TAX"44}45},46"time": "2023-04-15T10:30:00.123-07:00"47}
Create employeeCopy
Create an employee.
Sample Input
1{2"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",3"realm_id": "1234567890",4"display_name": "John Doe",5"title": "Software Engineer",6"given_name": "John",7"middle_name": "Michael",8"family_name": "Doe",9"suffix": "Jr",10"primary_addr": {11"line_1": "123 Main St",12"line_2": "Apt 4B",13"city": "San Francisco",14"country": "USA",15"country_sub_division_code": "CA",16"postal_code": "94105"17},18"primary_email_addr": "john.doe@example.com",19"hired_date": "2023-05-01T09:00:00Z",20"billable_time": true,21"gender": "Male",22"bill_rate": 75.5,23"active": true,24"primary_phone": "555-123-4567",25"mobile": "555-987-6543",26"birth_date": "1990-01-15T00:00:00Z",27"s_s_n": "123-45-6789",28"employee_number": "EMP001",29"print_on_check_name": "John M. Doe Jr"30}
Sample Output
1{2"Employee": {3"EmployeeNumber": "EMP001",4"SSN": "123-45-6789",5"PrimaryAddr": {6"Id": "1",7"Line1": "123 Main St",8"Line2": "Apt 4B",9"City": "San Francisco",10"Country": "USA",11"CountrySubDivisionCode": "CA",12"PostalCode": "94105"13},14"BillableTime": true,15"BillRate": 75.5,16"BirthDate": "1990-01-15",17"Gender": "Male",18"HiredDate": "2023-05-01",19"domain": "QBO",20"sparse": false,21"Id": "123",22"SyncToken": "0",23"MetaData": {24"CreateTime": "2023-05-01T09:15:23-07:00",25"LastUpdatedTime": "2023-05-01T09:15:23-07:00"26},27"Title": "Software Engineer",28"GivenName": "John",29"MiddleName": "Michael",30"FamilyName": "Doe",31"Suffix": "Jr",32"DisplayName": "John Doe",33"PrintOnCheckName": "John M. Doe Jr",34"Active": true,35"PrimaryPhone": {36"FreeFormNumber": "555-123-4567"37},38"Mobile": {39"FreeFormNumber": "555-987-6543"40},41"PrimaryEmailAddr": {42"Address": "john.doe@example.com"43}44},45"time": "2023-05-01T09:15:23-07:00"46}
Create invoiceCopy
Create an invoice.
Sample Input
1{2"access_token": "your_access_token_here",3"realm_id": "your_realm_id_here",4"line": [5{6"sales_item_line_detail": {7"amount": 100,8"description": "Web Design Services",9"item_ref": "1",10"unit_price": 100,11"qty": 112}13}14],15"customer_ref": {16"value": "1",17"name": "John Doe"18},19"currency_ref": "USD - US Dollar",20"doc_number": "INV-001",21"txn_date": "2023-06-15",22"due_date": "2023-07-15",23"bill_addr": {24"line_1": "123 Main St",25"city": "Anytown",26"country": "USA",27"postal_code": "12345"28},29"private_note": "Internal note for this invoice",30"customer_memo": "Thank you for your business!"31}
Sample Output
1{2"Invoice": {3"Id": "123",4"SyncToken": "0",5"MetaData": {6"CreateTime": "2023-06-15T10:00:00-07:00",7"LastUpdatedTime": "2023-06-15T10:00:00-07:00"8},9"DocNumber": "INV-001",10"TxnDate": "2023-06-15",11"CurrencyRef": {12"value": "USD",13"name": "United States Dollar"14},15"PrivateNote": "Internal note for this invoice",16"Line": [17{18"Id": "1",19"LineNum": 1,20"Description": "Web Design Services",21"Amount": 100,22"DetailType": "SalesItemLineDetail",23"SalesItemLineDetail": {24"ItemRef": {25"value": "1",26"name": "Web Design"27},28"UnitPrice": 100,29"Qty": 130}31}32],33"CustomerRef": {34"value": "1",35"name": "John Doe"36},37"CustomerMemo": {38"value": "Thank you for your business!"39},40"BillAddr": {41"Line1": "123 Main St",42"City": "Anytown",43"Country": "USA",44"PostalCode": "12345"45},46"DueDate": "2023-07-15",47"TotalAmt": 100,48"Balance": 10049},50"time": "2023-06-15T10:00:00.000-07:00"51}
Create purchaseCopy
Create a purchase.
Sample Input
1{2"payment_type": "Check",3"account_ref": {4"value": "35",5"name": "Checking Account"6},7"lines": [8{9"amount": 250,10"account_ref": {11"value": "52",12"name": "Office Supplies"13},14"description": "Printer paper and ink cartridges",15"billable_status": "NotBillable"16},17{18"amount": 75.5,19"account_ref": {20"value": "54",21"name": "Utilities"22},23"description": "Internet service",24"billable_status": "None"25}26],27"currency_ref": {28"value": "USD",29"name": "United States Dollar"30}31}
Sample Output
1{2"Purchase": {3"AccountRef": {4"value": "35",5"name": "Checking Account"6},7"PaymentType": "Check",8"Credit": false,9"TotalAmt": 325.5,10"domain": "QBO",11"sparse": false,12"Id": "1234",13"SyncToken": "0",14"MetaData": {15"CreateTime": "2023-04-15T14:30:25-07:00",16"LastUpdatedTime": "2023-04-15T14:30:25-07:00"17},18"TxnDate": "2023-04-15",19"CurrencyRef": {20"value": "USD",21"name": "United States Dollar"22},23"Line": [24{25"Id": "1",26"Amount": 250,27"DetailType": "AccountBasedExpenseLineDetail",28"AccountBasedExpenseLineDetail": {29"AccountRef": {30"value": "52",31"name": "Office Supplies"32},33"BillableStatus": "NotBillable"34}35},36{37"Id": "2",38"Amount": 75.5,39"DetailType": "AccountBasedExpenseLineDetail",40"AccountBasedExpenseLineDetail": {41"AccountRef": {42"value": "54",43"name": "Utilities"44},45"BillableStatus": "None"46}47}48]49},50"time": "2023-04-15T14:30:25-07:00"51}
Create time activityCopy
Create a time activity
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "123456789",4"name_of": {5"employee_id": "55",6"name": "John Doe"7},8"time": {9"start_time": {10"hour": "09",11"minute": "00"12},13"end_time": {14"hour": "17",15"minute": "30"16}17},18"break_hours": 1,19"break_minutes": 0,20"billable_status": {21"taxable": true,22"hourly_rate": 75.523},24"txn_date": "2023-05-15T00:00:00Z",25"description": "Project development and client meeting",26"customer_ref": {27"value": "68",28"name": "Acme Corp"29},30"item_ref": {31"value": "37",32"name": "Software Development"33},34"class_ref": {35"value": "42",36"name": "IT Department"37},38"department_ref": {39"value": "15",40"name": "Engineering"41}42}
Sample Output
1{2"TimeActivity": {3"TxnDate": "2023-05-15",4"NameOf": "Employee",5"EmployeeRef": {6"value": "55",7"name": "John Doe"8},9"CustomerRef": {10"value": "68",11"name": "Acme Corp"12},13"ItemRef": {14"value": "37",15"name": "Software Development"16},17"DepartmentRef": {18"value": "15",19"name": "Engineering"20},21"ClassRef": {22"value": "42",23"name": "IT Department"24},25"BillableStatus": "Billable",26"Taxable": true,27"HourlyRate": 75.5,28"BreakHours": 1,29"BreakMinutes": 0,30"StartTime": "2023-05-15T09:00:00-07:00",31"EndTime": "2023-05-15T17:30:00-07:00",32"Description": "Project development and client meeting",33"domain": "QBO",34"sparse": false,35"Id": "123",36"SyncToken": "0",37"MetaData": {38"CreateTime": "2023-05-15T18:00:00-07:00",39"LastUpdatedTime": "2023-05-15T18:00:00-07:00"40}41},42"time": "2023-05-15T18:00:00.000Z"43}
Create vendorCopy
Create a vendor
Sample Input
1{2"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",3"realm_id": "1234567890",4"identifier": {5"display_name": "Acme Supplies Inc.",6"given_name": "John",7"family_name": "Doe",8"title": "Mr."9},10"bill_addr": {11"line_1": "123 Main St",12"city": "Anytown",13"country": "USA",14"country_sub_division_code": "CA",15"postal_code": "12345"16},17"currency_ref": "USD - US Dollar",18"term_ref": {19"value": "3",20"name": "Net 30"21},22"active": true,23"primary_phone": "555-123-4567",24"primary_email_addr": "john.doe@acmesupplies.com",25"web_addr": "https://www.acmesupplies.com",26"vendor_1099": true,27"company_name": "Acme Supplies Inc.",28"tax_identifier": "12-3456789",29"acct_num": "V-001",30"print_on_check_name": "Acme Supplies Inc."31}
Sample Output
1{2"Vendor": {3"MiddleName": null,4"sparse": false,5"Mobile": null,6"CurrencyRef": {7"value": "USD",8"name": "United States Dollar"9},10"TermRef": {11"value": "3",12"name": "Net 30"13},14"domain": "QBO",15"WebAddr": {16"URI": "https://www.acmesupplies.com"17},18"Active": true,19"Vendor1099": true,20"PrintOnCheckName": "Acme Supplies Inc.",21"CompanyName": "Acme Supplies Inc.",22"GivenName": "John",23"PrimaryEmailAddr": {24"Address": "john.doe@acmesupplies.com"25},26"PrimaryPhone": {27"FreeFormNumber": "555-123-4567"28},29"DisplayName": "Acme Supplies Inc.",30"FamilyName": "Doe",31"MetaData": {32"CreateTime": "2023-04-15T10:30:00Z",33"LastUpdatedTime": "2023-04-15T10:30:00Z"34},35"Suffix": null,36"AcctNum": "V-001",37"AlternatePhone": null,38"TaxIdentifier": "12-3456789",39"BillAddr": {40"Line1": "123 Main St",41"City": "Anytown",42"Country": "USA",43"CountrySubDivisionCode": "CA",44"PostalCode": "12345",45"Id": "1"46},47"Title": "Mr.",48"Id": "123",49"Balance": 0,50"Fax": null,51"SyncToken": "0"52},53"time": "2023-04-15T10:30:00.000Z"54}
Delete purchaseCopy
Delete a purchase.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"purchase_id": "123",5"sync_token": "0"6}
Sample Output
1{2"Purchase": {3"domain": "QBO",4"status": "Deleted",5"Id": "123",6"CustomField": []7},8"time": "2023-04-15T14:30:45.123Z"9}
Delete time activityCopy
Delete a Time Activity.
Sample Input
1{2"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",3"realm_id": "1234567890",4"time_activity_id": "TA123",5"sync_token": "1"6}
Sample Output
1{2"TimeActivity": {3"domain": "QBO",4"status": "Deleted",5"Id": "TA123"6},7"time": "2023-04-15T14:30:00Z"8}
Delete transferCopy
Delete a transfer.
Sample Input
1{2"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",3"realm_id": "1234567890",4"transfer_id": "TR-123456"5}
Sample Output
1{2"Transfer": {3"domain": "QBO",4"status": "Deleted",5"Id": "TR-123456"6},7"time": "2023-06-15T14:30:45Z"8}
Get accountCopy
Get account details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"account_id": "75"5}
Sample Output
1{2"Account": {3"Name": "Checking Account",4"SubAccount": false,5"FullyQualifiedName": "Checking Account",6"Active": true,7"Classification": "Asset",8"AccountType": "Bank",9"AccountSubType": "Checking",10"CurrentBalance": 5000,11"CurrentBalanceWithSubAccounts": 5000,12"CurrencyRef": {13"value": "USD",14"name": "United States Dollar"15},16"domain": "QBO",17"sparse": false,18"Id": "75",19"SyncToken": "0",20"MetaData": {21"CreateTime": "2023-04-15T09:00:00-07:00",22"LastUpdatedTime": "2023-04-15T09:00:00-07:00"23}24},25"time": "2023-04-15T10:30:00-07:00"26}
Get billCopy
Get bill details by ID.
Sample Input
1{2"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",3"realm_id": "1234567890",4"bill_id": "123"5}
Sample Output
1{2"Bill": {3"DueDate": "2023-06-30",4"Balance": 500,5"domain": "QBO",6"sparse": false,7"Id": "123",8"SyncToken": "0",9"MetaData": {10"CreateTime": "2023-05-15T09:00:00-07:00",11"LastUpdatedTime": "2023-05-15T09:00:00-07:00"12},13"TxnDate": "2023-05-15",14"CurrencyRef": {15"value": "USD",16"name": "United States Dollar"17},18"Line": [19{20"Id": "1",21"LineNum": 1,22"Description": "Office Supplies",23"Amount": 250,24"DetailType": "ItemBasedExpenseLineDetail",25"ItemBasedExpenseLineDetail": {26"BillableStatus": "NotBillable",27"ItemRef": {28"value": "5",29"name": "Office Supplies"30},31"UnitPrice": 25,32"Qty": 10,33"TaxCodeRef": {34"value": "TAX"35}36}37},38{39"Id": "2",40"LineNum": 2,41"Description": "Cleaning Services",42"Amount": 250,43"DetailType": "ItemBasedExpenseLineDetail",44"ItemBasedExpenseLineDetail": {45"BillableStatus": "NotBillable",46"ItemRef": {47"value": "6",48"name": "Cleaning Services"49},50"UnitPrice": 250,51"Qty": 1,52"TaxCodeRef": {53"value": "NON"54}55}56}57],58"VendorRef": {59"value": "56",60"name": "Office Depot"61},62"APAccountRef": {63"value": "33",64"name": "Accounts Payable"65},66"TotalAmt": 50067},68"time": "2023-05-15T09:05:00-07:00"69}
Get classCopy
Get class details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"class_id": "5000000000000123456"5}
Sample Output
1{2"Class": {3"Name": "Marketing",4"SubClass": false,5"FullyQualifiedName": "Marketing",6"Active": true,7"domain": "QBO",8"sparse": false,9"Id": "5000000000000123456",10"SyncToken": "0",11"MetaData": {12"CreateTime": "2023-04-15T09:30:00-07:00",13"LastUpdatedTime": "2023-04-15T09:30:00-07:00"14}15},16"time": "2023-04-15T10:15:30-07:00"17}
Get credit memoCopy
Get credit memo details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"credit_memo_id": "CM-1001"5}
Sample Output
1{2"CreditMemo": {3"RemainingCredit": 100,4"domain": "QBO",5"sparse": false,6"Id": "CM-1001",7"SyncToken": "0",8"MetaData": {9"CreateTime": "2023-04-15T09:00:00-07:00",10"LastUpdatedTime": "2023-04-15T09:00:00-07:00"11},12"CustomField": [],13"DocNumber": "1001",14"TxnDate": "2023-04-15",15"DepartmentRef": {16"value": "1",17"name": "Sales"18},19"CurrencyRef": {20"value": "USD",21"name": "United States Dollar"22},23"ExchangeRate": 1,24"PrivateNote": "Customer overpayment",25"Line": [26{27"Id": "1",28"LineNum": 1,29"Description": "Product return",30"Amount": 100,31"DetailType": "SalesItemLineDetail",32"SalesItemLineDetail": {33"ItemRef": {34"value": "1",35"name": "Product A"36},37"ClassRef": {38"value": "1",39"name": "Retail"40},41"UnitPrice": 50,42"Qty": 2,43"TaxCodeRef": {44"value": "TAX"45}46}47}48],49"TxnTaxDetail": {50"TotalTax": 8,51"TaxLine": [52{53"Amount": 8,54"DetailType": "TaxLineDetail",55"TaxLineDetail": {56"TaxRateRef": {57"value": "1"58},59"PercentBased": true,60"TaxPercent": 8,61"NetAmountTaxable": 10062}63}64]65},66"CustomerRef": {67"value": "1",68"name": "John Doe"69},70"CustomerMemo": {71"value": "Credit for returned items"72},73"GlobalTaxCalculation": "TaxExcluded",74"TotalAmt": 108,75"HomeTotalAmt": 108,76"PrintStatus": "NeedToPrint",77"EmailStatus": "NotSet",78"BillEmail": {79"Address": "john.doe@example.com"80},81"Balance": 0,82"DeliveryInfo": {83"DeliveryType": "Email",84"DeliveryTime": "2023-04-15T09:05:00-07:00"85}86},87"time": "2023-04-15T09:10:00-07:00"88}
Get credit memo as PDFCopy
Get a credit memo as a PDF document.
Sample Input
1{2"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",3"realm_id": "1234567890",4"credit_memo_id": "CM-12345"5}
Sample Output
1{2"name": "CreditMemo_CM-12345.pdf",3"url": "https://quickbooks.api.intuit.com/v3/company/1234567890/creditMemo/CM-12345/pdf",4"mime_type": "application/pdf",5"expires": 16234567896}
Get customerCopy
Get customer details by ID.
Sample Input
1{2"customer_id": "123456"3}
Sample Output
1{2"Customer": {3"Taxable": true,4"BillAddr": {5"Id": "1",6"Line1": "123 Main St",7"City": "Anytown",8"PostalCode": "12345",9"Lat": "37.7749",10"Long": "-122.4194"11},12"ShipAddr": {13"Id": "2",14"Line1": "456 Oak Ave",15"City": "Somewhere",16"PostalCode": "67890",17"Lat": "40.7128",18"Long": "-74.0060"19},20"Job": false,21"BillWithParent": false,22"ParentRef": {23"value": "789"24},25"Level": 0,26"Balance": 1000,27"BalanceWithJobs": 1000,28"CurrencyRef": {29"value": "USD",30"name": "United States Dollar"31},32"PreferredDeliveryMethod": "Email",33"domain": "QBO",34"sparse": false,35"Id": "123456",36"SyncToken": "0",37"MetaData": {38"CreateTime": "2023-05-01T10:00:00-07:00",39"LastUpdatedTime": "2023-05-15T14:30:00-07:00"40},41"FullyQualifiedName": "Sample Company",42"CompanyName": "Sample Company Inc.",43"DisplayName": "Sample Company",44"PrintOnCheckName": "Sample Company Inc.",45"Active": true46},47"time": "2023-05-15T14:35:00-07:00"48}
Get departmentCopy
Get department details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"department_id": "1"5}
Sample Output
1{2"Department": {3"Name": "Sales",4"SubDepartment": false,5"FullyQualifiedName": "Sales",6"Active": true,7"domain": "QBO",8"sparse": false,9"Id": "1",10"SyncToken": "0",11"MetaData": {12"CreateTime": "2023-04-15T09:00:00-07:00",13"LastUpdatedTime": "2023-04-15T09:00:00-07:00"14}15},16"time": "2023-04-15T16:30:45.123Z"17}
Get employeeCopy
Get employee details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "4620816365177742688",4"employee_id": "55"5}
Sample Output
1{2"Employee": {3"EmployeeNumber": "EMP001",4"SSN": "123-45-6789",5"PrimaryAddr": {6"Id": "1",7"Line1": "123 Main St",8"Line2": "Apt 4B",9"City": "Anytown",10"Country": "USA",11"PostalCode": "12345"12},13"BillableTime": true,14"BillRate": 75,15"BirthDate": "1985-06-15",16"Gender": "Female",17"HiredDate": "2020-03-01",18"domain": "QBO",19"sparse": false,20"Id": "55",21"SyncToken": "0",22"MetaData": {23"CreateTime": "2020-03-01T09:00:00-08:00",24"LastUpdatedTime": "2023-05-15T14:30:00-08:00"25},26"Title": "Senior Developer",27"GivenName": "Jane",28"MiddleName": "Marie",29"FamilyName": "Doe",30"DisplayName": "Jane Doe",31"PrintOnCheckName": "Jane M. Doe",32"Active": true,33"PrimaryPhone": {34"FreeFormNumber": "(555) 123-4567"35},36"Mobile": {37"FreeFormNumber": "(555) 987-6543"38},39"PrimaryEmailAddr": {40"Address": "jane.doe@example.com"41}42},43"time": "2023-05-15T14:35:22-08:00"44}
Get invoiceCopy
Get invoice details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"invoice_id": "1001"5}
Sample Output
1{2"Invoice": {3"Id": "1001",4"Deposit": 0,5"AllowIPNPayment": true,6"AllowOnlinePayment": true,7"AllowOnlineCreditCardPayment": true,8"AllowOnlineACHPayment": false,9"domain": "QBO",10"sparse": false,11"SyncToken": "0",12"MetaData": {13"CreateTime": "2023-05-15T09:30:00-07:00",14"LastUpdatedTime": "2023-05-15T09:30:00-07:00"15},16"CustomField": [],17"DocNumber": "INV-1001",18"TxnDate": "2023-05-15",19"CurrencyRef": {20"value": "USD",21"name": "United States Dollar"22},23"ExchangeRate": 1,24"LinkedTxn": [],25"Line": [26{27"Id": "1",28"LineNum": 1,29"Description": "Web Design Services",30"Amount": 1000,31"DetailType": "SalesItemLineDetail",32"SalesItemLineDetail": {33"ItemRef": {34"value": "1",35"name": "Web Design"36},37"UnitPrice": 100,38"Qty": 10,39"TaxCodeRef": {40"value": "TAX"41}42}43},44{45"Id": "2",46"LineNum": 2,47"Description": "Subtotal",48"Amount": 1000,49"DetailType": "SubTotalLineDetail",50"SubTotalLineDetail": {}51}52],53"TxnTaxDetail": {54"TotalTax": 80,55"TaxLine": [56{57"Amount": 80,58"DetailType": "TaxLineDetail",59"TaxLineDetail": {60"TaxRateRef": {61"value": "2"62},63"PercentBased": true,64"TaxPercent": 8,65"NetAmountTaxable": 100066}67}68]69},70"CustomerRef": {71"value": "1",72"name": "John Doe"73},74"BillAddr": {75"Id": "2",76"Line1": "123 Main St",77"City": "Anytown",78"PostalCode": "12345",79"Lat": "37.4275",80"Long": "-122.1697"81},82"ShipAddr": {83"Id": "2",84"Line1": "123 Main St",85"City": "Anytown",86"PostalCode": "12345",87"Lat": "37.4275",88"Long": "-122.1697"89},90"SalesTermRef": {91"value": "3"92},93"DueDate": "2023-06-14",94"GlobalTaxCalculation": "TaxExcluded",95"TotalAmt": 1080,96"HomeTotalAmt": 1080,97"PrintStatus": "NeedToPrint",98"EmailStatus": "NotSet",99"Balance": 1080100},101"time": "2023-05-15T10:00:00-07:00"102}
Get paymentCopy
Get a payment by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"payment_id": "123"5}
Sample Output
1{2"CustomerRef": {3"value": "45",4"name": "John Doe"5},6"DepositToAccountRef": {7"value": "35"8},9"PaymentMethodRef": {10"value": "3"11},12"PaymentRefNum": "1001",13"TotalAmt": 500,14"UnappliedAmt": 0,15"ProcessPayment": true,16"domain": "QBO",17"sparse": false,18"Id": "123",19"SyncToken": "0",20"MetaData": {21"CreateTime": "2023-04-15T09:00:00-07:00",22"LastUpdatedTime": "2023-04-15T09:00:00-07:00"23},24"TxnDate": "2023-04-15",25"CurrencyRef": {26"value": "USD",27"name": "United States Dollar"28},29"LinkedTxn": [30{31"TxnId": "456",32"TxnType": "Invoice"33}34],35"Line": [36{37"Amount": 500,38"LinkedTxn": [39{40"TxnId": "456",41"TxnType": "Invoice"42}43],44"LineEx": {45"any": [46{47"name": "TxnLineDetail",48"declaredType": "com.intuit.schema.finance.v3.IPPPaymentLineDetail",49"scope": "javax.xml.bind.JAXBElement$GlobalScope",50"value": {51"Name": "PaymentLineDetail",52"Value": "Details"53},54"nil": false,55"globalScope": true,56"typeSubstituted": false57}58]59}60}61]62}
Get payment methodCopy
Get payment method details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"payment_method_id": "5"5}
Sample Output
1{2"PaymentMethod": {3"Name": "Credit Card",4"Active": true,5"Type": "CREDIT_CARD",6"domain": "QBO",7"sparse": false,8"Id": "5",9"SyncToken": "0",10"MetaData": {11"CreateTime": "2023-04-15T09:30:00-07:00",12"LastUpdatedTime": "2023-04-15T09:30:00-07:00"13}14},15"time": "2023-04-15T10:15:33.456-07:00"16}
Get purchaseCopy
Get purchase details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"purchase_id": "123"5}
Sample Output
1{2"Purchase": {3"AccountRef": {4"value": "42",5"name": "Checking Account"6},7"PaymentType": "Check",8"Credit": false,9"TotalAmt": 500,10"PurchaseEx": {11"any": [12{13"name": "CustomField",14"declaredType": "com.intuit.schema.finance.v3.CustomField",15"scope": "com.intuit.schema.finance.v3",16"value": {17"Name": "Project",18"Value": "Website Redesign"19},20"nil": false,21"globalScope": true,22"typeSubstituted": false23}24]25},26"domain": "QBO",27"sparse": false,28"Id": "123",29"SyncToken": "0",30"MetaData": {31"CreateTime": "2023-04-15T09:00:00-07:00",32"LastUpdatedTime": "2023-04-15T09:00:00-07:00"33},34"CustomField": [],35"TxnDate": "2023-04-15",36"CurrencyRef": {37"value": "USD",38"name": "United States Dollar"39},40"Line": [41{42"Id": "1",43"Amount": 500,44"DetailType": "AccountBasedExpenseLineDetail",45"AccountBasedExpenseLineDetail": {46"AccountRef": {47"value": "60",48"name": "Advertising"49},50"BillableStatus": "NotBillable",51"TaxCodeRef": {52"value": "NON"53}54}55}56],57"time": "2023-04-15T09:00:00-07:00"58}59}
Get tax codeCopy
Get tax code details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"tax_code_id": "TAX_CODE_1"5}
Sample Output
1{2"TaxCode": {3"Name": "Sales Tax",4"Description": "Standard sales tax for goods and services",5"Active": true,6"Taxable": true,7"TaxGroup": false,8"SalesTaxRateList": {9"TaxRateDetail": [10{11"TaxRateRef": {12"value": "RATE_1",13"name": "State Tax"14},15"TaxTypeApplicable": "Sales",16"TaxOrder": 117},18{19"TaxRateRef": {20"value": "RATE_2",21"name": "County Tax"22},23"TaxTypeApplicable": "Sales",24"TaxOrder": 225}26]27},28"PurchaseTaxRateList": {29"TaxRateDetail": []30},31"domain": "QBO",32"sparse": false,33"Id": "TAX_CODE_1",34"SyncToken": "0",35"MetaData": {36"CreateTime": "2023-04-15T09:00:00-07:00",37"LastUpdatedTime": "2023-04-15T09:00:00-07:00"38}39},40"time": "2023-04-15T10:30:00-07:00"41}
Get termCopy
Get term details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"term_id": "75"5}
Sample Output
1{2"Term": {3"Name": "Net 30",4"Active": true,5"Type": "STANDARD",6"DueDays": 30,7"DiscountDays": 10,8"domain": "QBO",9"sparse": false,10"Id": "75",11"SyncToken": "0",12"MetaData": {13"CreateTime": "2023-04-15T09:30:00-07:00",14"LastUpdatedTime": "2023-04-15T09:30:00-07:00"15}16},17"time": "2023-04-20T14:22:35.279Z"18}
Get time activityCopy
Get time activity details by ID.
Sample Input
1{2"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",3"realm_id": "1234567890",4"time_activity_id": "TA-000001"5}
Sample Output
1{2"TimeActivity": {3"TxnDate": "2023-05-15",4"NameOf": "Employee",5"EmployeeRef": {6"value": "55",7"name": "John Doe"8},9"CustomerRef": {10"value": "23",11"name": "Acme Corp"12},13"ItemRef": {14"value": "1",15"name": "Web Development"16},17"BillableStatus": "Billable",18"Taxable": true,19"HourlyRate": 75,20"BreakHours": 0,21"BreakMinutes": 30,22"StartTime": "2023-05-15T09:00:00-07:00",23"EndTime": "2023-05-15T17:30:00-07:00",24"Description": "Worked on client website redesign",25"domain": "QBO",26"sparse": false,27"Id": "TA-000001",28"SyncToken": "0",29"MetaData": {30"CreateTime": "2023-05-15T18:00:00-07:00",31"LastUpdatedTime": "2023-05-15T18:00:00-07:00"32}33},34"time": "2023-05-16T10:30:00-07:00"35}
Get transferCopy
Get transfer details by ID.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"transfer_id": "123"5}
Sample Output
1{2"Transfer": {3"FromAccountRef": {4"value": "35",5"name": "Checking Account"6},7"ToAccountRef": {8"value": "36",9"name": "Savings Account"10},11"Amount": 1000,12"domain": "QBO",13"sparse": false,14"Id": "123",15"SyncToken": "0",16"MetaData": {17"CreateTime": "2023-04-15T09:00:00-07:00",18"LastUpdatedTime": "2023-04-15T09:00:00-07:00"19},20"TxnDate": "2023-04-15",21"CurrencyRef": {22"value": "USD",23"name": "United States Dollar"24}25},26"time": "2023-04-15T09:05:00-07:00"27}
Get vendorCopy
Get vendor details by ID.
Sample Input
1{2"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",3"realm_id": "1234567890",4"vendor_id": "56"5}
Sample Output
1{2"Vendor": {3"BillAddr": {4"Id": "23",5"Line1": "123 Main St",6"Line2": "Suite 100",7"City": "San Francisco",8"Country": "USA",9"PostalCode": "94105"10},11"TaxIdentifier": "12-3456789",12"TermRef": {13"value": "3"14},15"Balance": 1500.75,16"AcctNum": "V-1001",17"Vendor1099": true,18"CurrencyRef": {19"value": "USD",20"name": "United States Dollar"21},22"domain": "QBO",23"sparse": false,24"Id": "56",25"SyncToken": "2",26"MetaData": {27"CreateTime": "2023-04-15T09:00:00-07:00",28"LastUpdatedTime": "2023-05-01T14:30:00-07:00"29},30"CompanyName": "ABC Supplies Inc.",31"DisplayName": "ABC Supplies",32"PrintOnCheckName": "ABC Supplies Inc.",33"Active": true,34"PrimaryPhone": {35"FreeFormNumber": "(555) 123-4567"36},37"AlternatePhone": {38"FreeFormNumber": "(555) 987-6543"39},40"Mobile": {41"FreeFormNumber": "(555) 555-5555"42},43"Fax": {44"FreeFormNumber": "(555) 111-2222"45},46"PrimaryEmailAddr": {47"Address": "contact@abcsupplies.com"48},49"WebAddr": {50"URI": "https://www.abcsupplies.com"51}52},53"time": "2023-05-10T08:45:30-07:00"54}
List accountsCopy
List all accounts in your company.
Sample Input
1{2"access_token": "eyJlbmMiOiJBMTI4Q0JDLUhTMjU2IiwiYWxnIjoiZGlyIn0...",3"realm_id": "1234567890",4"name": "Bank",5"where": [6{7"entity": "AccountType",8"operator": "=",9"value": "Bank"10}11],12"order_by": {13"value": "Name",14"direction": "ASC"15},16"start_position": 1,17"max_results": 1018}
Sample Output
1{2"QueryResponse": {3"Account": [4{5"Name": "Checking Account",6"SubAccount": false,7"Description": "Main business checking account",8"FullyQualifiedName": "Checking Account",9"Active": true,10"Classification": "Asset",11"AccountType": "Bank",12"AccountSubType": "Checking",13"CurrentBalance": 15000.5,14"CurrentBalanceWithSubAccounts": 15000.5,15"CurrencyRef": {16"value": "USD",17"name": "United States Dollar"18},19"domain": "QBO",20"sparse": false,21"Id": "1",22"SyncToken": "0",23"MetaData": {24"CreateTime": "2023-05-01T09:00:00-07:00",25"LastUpdatedTime": "2023-05-15T14:30:00-07:00"26}27},28{29"Name": "Savings Account",30"SubAccount": false,31"Description": "Business savings account",32"FullyQualifiedName": "Savings Account",33"Active": true,34"Classification": "Asset",35"AccountType": "Bank",36"AccountSubType": "Savings",37"CurrentBalance": 50000,38"CurrentBalanceWithSubAccounts": 50000,39"CurrencyRef": {40"value": "USD",41"name": "United States Dollar"42},43"domain": "QBO",44"sparse": false,45"Id": "2",46"SyncToken": "0",47"MetaData": {48"CreateTime": "2023-05-01T09:15:00-07:00",49"LastUpdatedTime": "2023-05-15T14:45:00-07:00"50}51}52],53"startPosition": 1,54"maxResults": 1055},56"time": "2023-05-15T15:00:00-07:00"57}
List classesCopy
List all classes in your company.
Sample Input
1{2"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",3"realm_id": "1234567890",4"where": [5{6"entity": "Name",7"operator": "LIKE",