Skip to content

Commit e18559c

Browse files
monikakusterivicac
monikakuster
authored and
ivicac
committed
684 - docs - generated
1 parent 8b9d713 commit e18559c

File tree

1 file changed

+160
-23
lines changed

1 file changed

+160
-23
lines changed

‎docs/src/content/docs/reference/components/quickbooks.md‎

Lines changed: 160 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@ Version: 1
2828

2929
| Name | Type | Control Type | Description |
3030
|:--------------:|:------------:|:--------------------:|:-------------------:|
31+
| Base | STRING | SELECT | The base URL for Quickbooks. |
32+
| Company Id | STRING | TEXT | To get the company id, go to your dashboard. On the top right corner press the gear logo and click Additional information. There you will see your company ID. |
3133
| Client Id | STRING | TEXT | |
3234
| Client Secret | STRING | TEXT | |
33-
| Company Id | STRING | TEXT | To get the company id, go to your dashboard. On the top right corner press the gear logo and click Additional information. There you will see your company ID |
3435

3536

3637

@@ -46,13 +47,13 @@ Version: 1
4647

4748

4849
### Create Category
49-
Has conditionally required parameters.
50+
Creates a new category.
5051

5152
#### Properties
5253

5354
| Name | Type | Control Type | Description |
5455
|:--------------:|:------------:|:--------------------:|:-------------------:|
55-
| Name | STRING | TEXT | Name of the category |
56+
| Name | STRING | TEXT | Name of the category. |
5657

5758

5859
### Output
@@ -66,26 +67,26 @@ Type: OBJECT
6667

6768
| Type | Control Type |
6869
|:------------:|:--------------------:|
69-
| {STRING\(id), STRING\(domain), STRING\(Name), STRING\(Level), STRING\(Subitem), STRING\(FullyQualifiedName)} | OBJECT_BUILDER |
70+
| {STRING\(domain), STRING\(Id), STRING\(Name), STRING\(Active), STRING\(FullyQualifiedName), STRING\(Type)} | OBJECT_BUILDER |
7071

7172

7273

7374

7475

7576

7677
### Create Customer
77-
Has conditionally required parameters.
78+
Creates a new customer.
7879

7980
#### Properties
8081

8182
| Name | Type | Control Type | Description |
8283
|:--------------:|:------------:|:--------------------:|:-------------------:|
83-
| Display Name | STRING | TEXT | The name of the person or organization as displayed. Must be unique across all Customer, Vendor, and Employee objects. Cannot be removed with sparse update. If not supplied, the system generates DisplayName by concatenating customer name components supplied in the request from the following list: Title, GivenName, MiddleName, FamilyName, and Suffix. |
84-
| Suffix | STRING | TEXT | Suffix of the name. For example, Jr. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create. |
85-
| Title | STRING | TEXT | Title of the person. This tag supports i18n, all locales. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, Suffix, or FullyQualifiedName attributes are required during create. |
86-
| Middle Name | STRING | TEXT | Middle name of the person. The person can have zero or more middle names. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create. |
87-
| Last/Family Name | STRING | TEXT | Family name or the last name of the person. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create. |
88-
| First/Given Name | STRING | TEXT | Given name or first name of a person. The DisplayName attribute or at least one of Title, GivenName, MiddleName, FamilyName, or Suffix attributes is required for object create. |
84+
| Display Name | STRING | TEXT | The name of the person or organization as displayed. |
85+
| First Name | STRING | TEXT | Given name or first name of a person. |
86+
| Last Name | STRING | TEXT | Family name or the last name of the person. |
87+
| Suffix | STRING | TEXT | Suffix of the name. |
88+
| Title | STRING | TEXT | Title of the person. |
89+
| Middle Name | STRING | TEXT | Middle name of the person. |
8990

9091

9192
### Output
@@ -99,12 +100,7 @@ Type: OBJECT
99100

100101
| Type | Control Type |
101102
|:------------:|:--------------------:|
102-
| ID | STRING | TEXT | |
103-
| Contact name | STRING | TEXT | |
104-
| Credit card | {STRING\(number), STRING\(nameOnAcct), INTEGER\(ccExpiryMonth), INTEGER\(ccExpiryYear), STRING\(billAddrStreet), STRING\(postalCode), NUMBER\(amount)} | OBJECT_BUILDER | |
105-
| Balance | NUMBER | NUMBER | |
106-
| Account number | STRING | TEXT | |
107-
| Business number | STRING | TEXT | |
103+
| {STRING\(domain), STRING\(Id), STRING\(Title), STRING\(GivenName), STRING\(MiddleName), STRING\(FamilyName), STRING\(Suffix), STRING\(FullyQualifiedName), STRING\(DisplayName), STRING\(Active)} | OBJECT_BUILDER |
108104

109105

110106

@@ -118,8 +114,11 @@ Creates a new item.
118114

119115
| Name | Type | Control Type | Description |
120116
|:--------------:|:------------:|:--------------------:|:-------------------:|
121-
| Name | STRING | TEXT | Name of the item. This value must be unique. Required for create. |
122-
| Quantity on Hand | NUMBER | NUMBER | Current quantity of the Inventory items available for sale. Not used for Service or NonInventory type items.Required for Inventory type items. |
117+
| Name | STRING | TEXT | Name of the item. |
118+
| Type | STRING | SELECT | Type of item. |
119+
| DYNAMIC_PROPERTIES | null |
120+
| Expense Account | STRING | SELECT | |
121+
| Quantity on Hand | NUMBER | NUMBER | Current quantity of the inventory items available for sale. |
123122

124123

125124
### Output
@@ -133,10 +132,148 @@ Type: OBJECT
133132

134133
| Type | Control Type |
135134
|:------------:|:--------------------:|
136-
| ID | STRING | TEXT | |
137-
| Name | STRING | TEXT | |
138-
| Description | STRING | TEXT | |
139-
| Unit price | NUMBER | NUMBER | |
135+
| {STRING\(domain), STRING\(Id), STRING\(Name), STRING\(Active), STRING\(FullyQualifiedName), STRING\(Type), {STRING\(name)}\(IncomeAccountRef), {STRING\(name)}\(AssetAccountRef), {STRING\(name)}\(ExpenseAccountRef)} | OBJECT_BUILDER |
136+
137+
138+
139+
140+
141+
142+
### Create Payment
143+
Creates a new payment.
144+
145+
#### Properties
146+
147+
| Name | Type | Control Type | Description |
148+
|:--------------:|:------------:|:--------------------:|:-------------------:|
149+
| Customer | STRING | SELECT | |
150+
| Total Amount | NUMBER | NUMBER | Total amount of the transaction. |
151+
152+
153+
### Output
154+
155+
156+
157+
Type: OBJECT
158+
159+
160+
#### Properties
161+
162+
| Type | Control Type |
163+
|:------------:|:--------------------:|
164+
| {STRING\(domain), STRING\(Id), {STRING\(name)}\(CurrencyRef), {STRING\(name)}\(CustomerRef), STRING\(TotalAmt)} | OBJECT_BUILDER |
165+
166+
167+
168+
169+
170+
171+
### Get Customer
172+
Gets details about a specific customer.
173+
174+
#### Properties
175+
176+
| Name | Type | Control Type | Description |
177+
|:--------------:|:------------:|:--------------------:|:-------------------:|
178+
| Customer | STRING | SELECT | Customer to get. |
179+
180+
181+
### Output
182+
183+
184+
185+
Type: OBJECT
186+
187+
188+
#### Properties
189+
190+
| Type | Control Type |
191+
|:------------:|:--------------------:|
192+
| {STRING\(domain), STRING\(Id), STRING\(Title), STRING\(GivenName), STRING\(MiddleName), STRING\(FamilyName), STRING\(Suffix), STRING\(FullyQualifiedName), STRING\(DisplayName), STRING\(Active)} | OBJECT_BUILDER |
193+
194+
195+
196+
197+
198+
199+
### Get Invoice
200+
Gets details about a specific invoice.
201+
202+
#### Properties
203+
204+
| Name | Type | Control Type | Description |
205+
|:--------------:|:------------:|:--------------------:|:-------------------:|
206+
| Invoice | STRING | SELECT | Invoice to get. |
207+
208+
209+
### Output
210+
211+
212+
213+
Type: OBJECT
214+
215+
216+
#### Properties
217+
218+
| Type | Control Type |
219+
|:------------:|:--------------------:|
220+
| {STRING\(domain), STRING\(Id), STRING\(DocNumber), {STRING\(name)}\(CustomerRef), STRING\(Balance)} | OBJECT_BUILDER |
221+
222+
223+
224+
225+
226+
227+
### Get Item
228+
Gets details about a specific item.
229+
230+
#### Properties
231+
232+
| Name | Type | Control Type | Description |
233+
|:--------------:|:------------:|:--------------------:|:-------------------:|
234+
| Item | STRING | SELECT | Item to get. |
235+
236+
237+
### Output
238+
239+
240+
241+
Type: OBJECT
242+
243+
244+
#### Properties
245+
246+
| Type | Control Type |
247+
|:------------:|:--------------------:|
248+
| {STRING\(domain), STRING\(Id), STRING\(Name), STRING\(Active), STRING\(FullyQualifiedName), STRING\(Type), {STRING\(name)}\(IncomeAccountRef), {STRING\(name)}\(AssetAccountRef), {STRING\(name)}\(ExpenseAccountRef)} | OBJECT_BUILDER |
249+
250+
251+
252+
253+
254+
255+
### Get Payment
256+
Gets details about a specific payment.
257+
258+
#### Properties
259+
260+
| Name | Type | Control Type | Description |
261+
|:--------------:|:------------:|:--------------------:|:-------------------:|
262+
| Payment | STRING | SELECT | Payment to get. |
263+
264+
265+
### Output
266+
267+
268+
269+
Type: OBJECT
270+
271+
272+
#### Properties
273+
274+
| Type | Control Type |
275+
|:------------:|:--------------------:|
276+
| {STRING\(domain), STRING\(Id), {STRING\(name)}\(CurrencyRef), {STRING\(name)}\(CustomerRef), STRING\(TotalAmt)} | OBJECT_BUILDER |
140277

141278

142279

0 commit comments

Comments
 (0)