3min

Request

Request Types
Below are the supported actions which can be processed using Breadwinner for QuickBooks Global API.
For each object below, prepend the object name with the supported operation to get the method name.  For example, to read a customer, you would use the action readCustomer.
﻿
read
create
update
Customer
Y
﻿﻿Y
﻿﻿Y
Vendor
Y
Y
Y
Invoice
Y
Y
Y
Sales Receipt
Y
Y
Y
Credit Memo
Y
Y
Y
Payment
Y
Y
Y
Building Requests
Breadwinner accepts requests in the form of a Map<String, Object>. 
These are the supported keys:
Key (String)
Value (Object)
Required
version
1.0
True
action
See the list of available actions.
True
skipDML
Defaults to FALSE if not provided. When set to true, the record will be saved to QuickBooks, but will not be replicated back to Salesforce
False
requestJSON
Pass the data as a JSON string, based on the specified action.
True
qbOrgId
Required, if QuickBooks Multi-Org is enabled in Breadwinner. In the case of a single QuickBooks org, Breadwinner by default selects the connected QuickBooks Org.
Conditional
Examples
See the related objects in the left menu for more examples.

Updated 14 Nov 2022

Did this page help you?

Yes

UP NEXT

Customer

Docs powered by archbee

TABLE OF CONTENTS

Request Types

Building Requests

Examples

	read	create	update
Customer	Y	Y	Y
Vendor	Y	Y	Y
Invoice	Y	Y	Y
Sales Receipt	Y	Y	Y
Credit Memo	Y	Y	Y
Payment	Y	Y	Y

Key (String)	Value (Object)	Required
version	1.0	True
action	See the list of available actions.	True
skipDML	Defaults to FALSE if not provided. When set to true, the record will be saved to QuickBooks, but will not be replicated back to Salesforce	False
requestJSON	Pass the data as a JSON string, based on the specified action.	True
qbOrgId	Required, if QuickBooks Multi-Org is enabled in Breadwinner. In the case of a single QuickBooks org, Breadwinner by default selects the connected QuickBooks Org.	Conditional