Skip to content

Instantly share code, notes, and snippets.

@kinlane

kinlane/QuickBooks Online V3 API OpenAPI.json

Created August 17, 2018 02:18
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 3 You must be signed in to fork a gist
  • Save kinlane/8b67e8bb101500cbc1bce2a7ca49fffc to your computer and use it in GitHub Desktop.
Save kinlane/8b67e8bb101500cbc1bce2a7ca49fffc to your computer and use it in GitHub Desktop.
Download ZIP
QuickBooks Online V3 API OpenAPI
Raw
QuickBooks Online V3 API OpenAPI.json
{
"swagger": "2.0",
"info": {
"version": "1.0",
"title": "QuickBooks Online V3API Collections - OAuth2",
"description": "The QuickBooks Online Accounting API is a RESTful API that is used to access QuickBooks companies.\n\nDocs Ref - https://developer.intuit.com/docs/api/accounting"
},
"host": "DefaultParameterValue",
"basePath": "/v3/company/DefaultParameterValue",
"securityDefinitions": {
"auth": {
"type": "oauth2",
"flow": "implicit",
"authorizationUrl": "http://example.com/auth",
"scopes": {},
"x-skip-client-authentication": false
}
},
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"paths": {
"/cdc": {
"get": {
"description": "Retrive changed Bill and invoice objects since Aug10,2016\nMethod - GET",
"summary": "CDC-Read",
"tags": [
"ChangeDataCapture"
],
"operationId": "CdcGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "entities",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "changedSince",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/cdc?entities=bill,invoice&changedSince=YYYY-MM-DD",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json",
"Content-Type": "application/text"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "CDC-Read",
"x-testDescription": "Retrive changed Bill and invoice objects since Aug10,2016\nMethod - GET"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/query": {
"post": {
"description": "Read all transfer objects using the 'Query' endpoint\nMethod : POST\n",
"summary": "Transfer-ReadAll",
"tags": [
"Transfer"
],
"operationId": "QueryPost32",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/query?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json",
"Content-Type": "application/text"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Transfer-ReadAll",
"x-testDescription": "Read all transfer objects using the 'Query' endpoint\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/estimate/163": {
"get": {
"description": "Read an Estimate object by Id\nMethod : POST\n",
"summary": "Estimate-ReadById",
"tags": [
"Estimate"
],
"operationId": "Estimate163Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/estimate/163?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Estimate-ReadById",
"x-testDescription": "Read an Estimate object by Id\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/invoice": {
"post": {
"description": "Create an invoice object\nMethod : POST\n",
"summary": "Invoice-Create",
"tags": [
"Invoice"
],
"operationId": "InvoicePost4",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/InvoiceCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/invoice?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Line\":[{\"Amount\":100.0,\"DetailType\":\"SalesItemLineDetail\",\"SalesItemLineDetail\":{\"ItemRef\":{\"value\":\"1\",\"name\":\"Services\"}}}],\"CustomerRef\":{\"value\":\"1\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Invoice-Create",
"x-testDescription": "Create an invoice object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/term": {
"post": {
"description": "Update a term object\nMethod : POST\n\nTerm object can't be deleted parmanently. It can only be deactived by setting the 'Active' attribute to false.",
"summary": "Term-Delete",
"tags": [
"Term"
],
"operationId": "TermPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/TermDeleterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/term",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Name\":\"Term1120-Updated\",\"Active\":false,\"Type\":\"STANDARD\",\"DiscountPercent\":0,\"DueDays\":120,\"domain\":\"QBO\",\"sparse\":false,\"Id\":\"8\",\"SyncToken\":\"1\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Term-Delete",
"x-testDescription": "Update a term object\nMethod : POST\n\nTerm object can't be deleted parmanently. It can only be deactived by setting the 'Active' attribute to false."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/preferences": {
"get": {
"description": "Read the preference object\nMethod : POST\n",
"summary": "Preference-Read",
"tags": [
"Preferences"
],
"operationId": "PreferencesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/preferences?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Preference-Read",
"x-testDescription": "Read the preference object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
},
"post": {
"description": "Update the preference object endpoint\nMethod : POST\n",
"summary": "Preference-Update",
"tags": [
"Preferences"
],
"operationId": "PreferencesPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/PreferenceUpdaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/InventoryValuationSummary": {
"get": {
"description": "Report - Inventory Valuation Summary\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/inventory%20valuation\n\n\n\n\n\n\n\n\n",
"summary": "Report-InventoryValuationSummary",
"tags": [
"Reports"
],
"operationId": "ReportsInventoryValuationSummaryGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/InventoryValuationSummary?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-InventoryValuationSummary",
"x-testDescription": "Report - Inventory Valuation Summary\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/inventory%20valuation\n\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/purchase": {
"post": {
"description": "Create a puchase object\nMethod : POST\n",
"summary": "Purchase-Update",
"tags": [
"Purchase"
],
"operationId": "PurchasePost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/PurchaseUpdaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/purchase?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"AccountRef\":{\"value\":\"42\",\"name\":\"Visa\"},\"PaymentType\":\"CreditCard\",\"Credit\":false,\"TotalAmt\":100,\"PurchaseEx\":{\"any\":[{\"name\":\"{http://schema.intuit.com/finance/v3}NameValue\",\"declaredType\":\"com.intuit.schema.finance.v3.NameValue\",\"scope\":\"javax.xml.bind.JAXBElement$GlobalScope\",\"value\":{\"Name\":\"TxnType\",\"Value\":\"54\"},\"nil\":false,\"globalScope\":true,\"typeSubstituted\":false}]},\"domain\":\"QBO\",\"sparse\":false,\"Id\":\"175\",\"SyncToken\":\"0\",\"MetaData\":{\"CreateTime\":\"2016-08-24T05:52:14+00:00\",\"LastUpdatedTime\":\"2016-08-24T05:52:14+00:00\"},\"CustomField\":[],\"TxnDate\":\"2016-08-23\",\"CurrencyRef\":{\"value\":\"USD\",\"name\":\"United States Dollar\"},\"ExchangeRate\":1,\"Line\":[{\"Id\":\"1\",\"Amount\":100,\"DetailType\":\"AccountBasedExpenseLineDetail\",\"AccountBasedExpenseLineDetail\":{\"AccountRef\":{\"value\":\"13\",\"name\":\"Meals and Entertainment\"},\"BillableStatus\":\"NotBillable\",\"TaxCodeRef\":{\"value\":\"NON\"}}}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Purchase-Update",
"x-testDescription": "Create a puchase object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/salesreceipt/181": {
"get": {
"description": "Create an salesreceipt object\nMethod : POST\n",
"summary": "SalesReceipt-ReadByID",
"tags": [
"SalesReceipt"
],
"operationId": "Salesreceipt181Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/salesreceipt/181?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "SalesReceipt-ReadByID",
"x-testDescription": "Create an salesreceipt object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/deposit": {
"post": {
"description": "Update a deposit object\nMethod : POST",
"summary": "Deposit-Update",
"tags": [
"Deposit"
],
"operationId": "DepositPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DepositUpdaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/deposit?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"DepositToAccountRef\":{\"value\":\"35\",\"name\":\"Checking\"},\"TotalAmt\":205,\"domain\":\"QBO\",\"sparse\":false,\"Id\":\"162\",\"SyncToken\":\"0\",\"TxnDate\":\"2016-08-18\",\"CurrencyRef\":{\"value\":\"USD\",\"name\":\"United States Dollar\"},\"ExchangeRate\":1,\"Line\":[{\"Id\":\"1\",\"LineNum\":1,\"Amount\":205,\"DetailType\":\"DepositLineDetail\",\"DepositLineDetail\":{\"AccountRef\":{\"value\":\"87\",\"name\":\"Unapplied Cash Payment Income\"}}}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Deposit-Update",
"x-testDescription": "Update a deposit object\nMethod : POST"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/transfer": {
"post": {
"description": "Create a transfer object\nMethod : POST\n\n",
"summary": "Transfer-Create",
"tags": [
"Transfer"
],
"operationId": "TransferPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/TransferCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/transfer?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"FromAccountRef\":{\"value\":\"35\",\"name\":\"Checking\"},\"ToAccountRef\":{\"value\":\"36\",\"name\":\"Savings\"},\"Amount\":\"120.00\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Transfer-Create",
"x-testDescription": "Create a transfer object\nMethod : POST\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/bill": {
"post": {
"description": "Create a bill\nContent-Type:application/json\nMethod - POST",
"summary": "Bill-Create",
"tags": [
"Bill"
],
"operationId": "BillPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/BillCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/bill?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Line\":[{\"Id\":\"1\",\"Amount\":200.0,\"DetailType\":\"AccountBasedExpenseLineDetail\",\"AccountBasedExpenseLineDetail\":{\"AccountRef\":{\"value\":\"7\"}}}],\"VendorRef\":{\"value\":\"56\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Bill-Create",
"x-testDescription": "Create a bill\nContent-Type:application/json\nMethod - POST"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/account/1": {
"get": {
"description": "Get the Account which has accountId as 1",
"summary": "Account-ReadById",
"tags": [
"Account"
],
"operationId": "Account1Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/account/1?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Account-ReadById",
"x-testDescription": "Get the Account which has accountId as 1"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/invoice/147": {
"get": {
"description": "Read an invoice object by Id\nMethod : POST\n",
"summary": "Invoice-ReadById",
"tags": [
"Invoice"
],
"operationId": "Invoice147Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/invoice/147?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Invoice-ReadById",
"x-testDescription": "Read an invoice object by Id\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/CustomerBalanceDetail": {
"get": {
"description": "Report - CustomerBalance Detail\nMethod : GET\n\nThe information below provides a reference on how to access the Customer Balance Detail report from the QuickBooks Online Report Service.\n\n\n\n\n\n\n\n\n\n",
"summary": "Report-CustomerBalanceDetail",
"tags": [
"Reports"
],
"operationId": "ReportsCustomerBalanceDetailGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/CustomerBalanceDetail?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-CustomerBalanceDetail",
"x-testDescription": "Report - CustomerBalance Detail\nMethod : GET\n\nThe information below provides a reference on how to access the Customer Balance Detail report from the QuickBooks Online Report Service.\n\n\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/payment": {
"post": {
"description": "Create an payment object\nMethod : POST\n",
"summary": "Payment-Create",
"tags": [
"Payment"
],
"operationId": "PaymentPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/PaymentCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/payment?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"CustomerRef\":{\"value\":\"58\",\"name\":\"TEST123\"},\"TotalAmt\":100.0,\"Line\":[{\"Amount\":100.0,\"LinkedTxn\":[{\"TxnId\":\"173\",\"TxnType\":\"Invoice\"}]}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Payment-Create",
"x-testDescription": "Create an payment object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/ProfitAndLossDetail": {
"get": {
"description": "Report - Profit and Loss Detail\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/profit%20and%20loss%20detail\n\n\n\n\n\n\n\n\n",
"summary": "Report-ProfitAndLossDetail",
"tags": [
"Reports"
],
"operationId": "ReportsProfitAndLossDetailGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/ProfitAndLossDetail?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-ProfitAndLossDetail",
"x-testDescription": "Report - Profit and Loss Detail\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/profit%20and%20loss%20detail\n\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/salesreceipt": {
"post": {
"description": "Create an salesreceipt object\nMethod : POST\n",
"summary": "SalesReceipt-Create",
"tags": [
"SalesReceipt"
],
"operationId": "SalesreceiptPost4",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/SalesreceiptCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/salesreceipt?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Line\":[{\"Id\":\"1\",\"LineNum\":1,\"Description\":\"Pest Control Services\",\"Amount\":35.0,\"DetailType\":\"SalesItemLineDetail\",\"SalesItemLineDetail\":{\"ItemRef\":{\"value\":\"10\",\"name\":\"Pest Control\"},\"UnitPrice\":35,\"Qty\":1,\"TaxCodeRef\":{\"value\":\"NON\"}}}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "SalesReceipt-Create",
"x-testDescription": "Create an salesreceipt object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/upload": {
"post": {
"description": "Uploading and linking new attachments\n\nhttps://developer.intuit.com/docs/0100_quickbooks_online/0200_dev_guides/accounting/attachments#Uploading_and_linking_new_attachments\n\nIf the attachment is not in the Attachment list already, it's possible to upload it and link it to the object in one multipart operation.\n\nOperation: POST https://quickbooks.api.intuit.com/v3/company/companyID/upload\nContent type: multipart/form-data\n\nRequest body\n\nThe following sample code shows the multipart request body for uploading a file and its supporting Attachable metatdata object, with the result of it being both added to the Attachment list and added to the object.\n\nThe Attachable object accompanying this request supplies metadata and object information to which the attachment is linked. \nEach part of the multipart request is separated by a boundary. In the sample below, the string --YOjcLaTlykb6OxfYJx4O07j1MweeMFem is used. You can use any random and unique string.\nThe file to be uploaded and its Attachable object are paired together via the name parameter in the part header for each one.\nThe name parameter for the file part is of the form file_content_nn, where nn is a unique index number among the set of files being uploaded.\nThe name parameter for the Attachable object is of the form file_metadata_nn, where nn corresponds to the file index number used with the content .\nThe file or files are stored in the Attachment list with the name specified by the filename parameter.\nIf the data supplied with the Attachable object cannot be validated, an error is returned and the file is not uploaded.",
"summary": "Upload-Attachments",
"tags": [
"Attachable"
],
"operationId": "UploadPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/upload",
"headers": {
"User-Agent": "{{UserAgent}}",
"Content-Type": "multipart/form-data;boundary=37a1965f87babd849241a530ad71e169",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Upload-Attachments",
"x-testDescription": "Uploading and linking new attachments\n\nhttps://developer.intuit.com/docs/0100_quickbooks_online/0200_dev_guides/accounting/attachments#Uploading_and_linking_new_attachments\n\nIf the attachment is not in the Attachment list already, it's possible to upload it and link it to the object in one multipart operation.\n\nOperation: POST https://quickbooks.api.intuit.com/v3/company/companyID/upload\nContent type: multipart/form-data\n\nRequest body\n\nThe following sample code shows the multipart request body for uploading a file and its supporting Attachable metatdata object, with the result of it being both added to the Attachment list and added to the object.\n\nThe Attachable object accompanying this request supplies metadata and object information to which the attachment is linked. \nEach part of the multipart request is separated by a boundary. In the sample below, the string --YOjcLaTlykb6OxfYJx4O07j1MweeMFem is used. You can use any random and unique string.\nThe file to be uploaded and its Attachable object are paired together via the name parameter in the part header for each one.\nThe name parameter for the file part is of the form file_content_nn, where nn is a unique index number among the set of files being uploaded.\nThe name parameter for the Attachable object is of the form file_metadata_nn, where nn corresponds to the file index number used with the content .\nThe file or files are stored in the Attachment list with the name specified by the filename parameter.\nIf the data supplied with the Attachable object cannot be validated, an error is returned and the file is not uploaded."
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/customer": {
"post": {
"description": "Create a customer\nMethod : POST",
"summary": "Customer-Create",
"tags": [
"Customer"
],
"operationId": "CustomerPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CustomerCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/customer?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"BillAddr\":{\"Line1\":\"123 Main Street\",\"City\":\"Mountain View\",\"Country\":\"USA\",\"CountrySubDivisionCode\":\"CA\",\"PostalCode\":\"94042\"},\"Notes\":\"Here are other details.\",\"DisplayName\":\"King's Groceries1\",\"PrimaryPhone\":{\"FreeFormNumber\":\"(555) 555-5555\"},\"PrimaryEmailAddr\":{\"Address\":\"jdrew@myemail.com\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Customer-Create",
"x-testDescription": "Create a customer\nMethod : POST"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/department": {
"post": {
"description": "Create a department object\nMethod : POST",
"summary": "Department-Create",
"tags": [
"Department"
],
"operationId": "DepartmentPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/DepartmentCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/department?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Name\":\"Marketing Department\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Department-Create",
"x-testDescription": "Create a department object\nMethod : POST"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/GeneralLedger": {
"get": {
"description": "Report - General Ledger\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/general%20ledger\n\n\n\n\n\n\n\n\n",
"summary": "Report-GeneralLedger",
"tags": [
"Reports"
],
"operationId": "ReportsGeneralLedgerGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/GeneralLedger?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-GeneralLedger",
"x-testDescription": "Report - General Ledger\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/general%20ledger\n\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/VendorBalance": {
"get": {
"description": "Report - Vendor Balance \nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/vendor%20balance\n\n\n\n\n\n\n",
"summary": "Report-VendorBalance",
"tags": [
"Reports"
],
"operationId": "ReportsVendorBalanceGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/VendorBalance?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-VendorBalance",
"x-testDescription": "Report - Vendor Balance \nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/vendor%20balance\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/purchaseorder/178": {
"get": {
"description": "Read a puchase-order object\nMethod : POST\n",
"summary": "PurchaseOrder-ReadById",
"tags": [
"PurchaseOrder"
],
"operationId": "Purchaseorder178Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/purchaseorder/178?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "PurchaseOrder-ReadById",
"x-testDescription": "Read a puchase-order object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/item": {
"post": {
"description": "Create an item object\nMethod : POST\n",
"summary": "Item-Create",
"tags": [
"Item"
],
"operationId": "ItemPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/ItemCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/item?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Name\":\"Garden Supplies1\",\"IncomeAccountRef\":{\"value\":\"79\",\"name\":\"Sales of Product Income\"},\"ExpenseAccountRef\":{\"value\":\"80\",\"name\":\"Cost of Goods Sold\"},\"AssetAccountRef\":{\"value\":\"81\",\"name\":\"Inventory Asset\"},\"Type\":\"Inventory\",\"TrackQtyOnHand\":true,\"QtyOnHand\":10,\"InvStartDate\":\"2015-01-01\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Item-Create",
"x-testDescription": "Create an item object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/journalentry": {
"post": {
"description": "Create an journalentry object\nMethod : POST\n",
"summary": "JournalEntry-Create",
"tags": [
"JournalEntry"
],
"operationId": "JournalentryPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/JournalentryCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/journalentry?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Line\":[{\"Id\":\"0\",\"Description\":\"nov portion of rider insurance\",\"Amount\":100.0,\"DetailType\":\"JournalEntryLineDetail\",\"JournalEntryLineDetail\":{\"PostingType\":\"Debit\",\"AccountRef\":{\"value\":\"39\",\"name\":\"Opening Bal Equity\"}}},{\"Description\":\"nov portion of rider insurance\",\"Amount\":100.0,\"DetailType\":\"JournalEntryLineDetail\",\"JournalEntryLineDetail\":{\"PostingType\":\"Credit\",\"AccountRef\":{\"value\":\"44\",\"name\":\"Notes Payable\"}}}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "JournalEntry-Create",
"x-testDescription": "Create an journalentry object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/taxservice/taxcode": {
"post": {
"description": "Use TaxService to create taxcode and corresponding taxrates\nMethod : POST\n",
"summary": "TaxService-Create",
"tags": [
"TaxService"
],
"operationId": "TaxserviceTaxcodePost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/TaxserviceCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/taxservice/taxcode?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"TaxCode\":\"MyTaxCodeName\",\"TaxRateDetails\":[{\"TaxRateName\":\"myNewTaxRateName\",\"RateValue\":\"8\",\"TaxAgencyId\":\"1\",\"TaxApplicableOn\":\"Sales\"}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "TaxService-Create",
"x-testDescription": "Use TaxService to create taxcode and corresponding taxrates\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/creditmemo": {
"post": {
"description": "Update a credit memo\nMethod : POST",
"summary": "CreditMemo-Update",
"tags": [
"CreditMemo"
],
"operationId": "CreditmemoPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/CreditmemoUpdaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/creditmemo?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"RemainingCredit\":50,\"domain\":\"QBO\",\"sparse\":false,\"Id\":\"160\",\"SyncToken\":\"0\",\"MetaData\":{\"CreateTime\":\"2016-08-18T20:09:52+00:00\",\"LastUpdatedTime\":\"2016-08-18T20:09:52+00:00\"},\"CustomField\":[{\"DefinitionId\":\"1\",\"Name\":\"Crew #\",\"Type\":\"StringType\"}],\"DocNumber\":\"1040-Updated\",\"TxnDate\":\"2016-08-18\",\"CurrencyRef\":{\"value\":\"USD\",\"name\":\"United States Dollar\"},\"ExchangeRate\":1,\"Line\":[{\"Id\":\"1\",\"LineNum\":1,\"Amount\":50,\"DetailType\":\"SalesItemLineDetail\",\"SalesItemLineDetail\":{\"ItemRef\":{\"value\":\"3\",\"name\":\"Concrete\"},\"TaxCodeRef\":{\"value\":\"NON\"}}},{\"Amount\":50,\"DetailType\":\"SubTotalLineDetail\",\"SubTotalLineDetail\":{}}],\"TxnTaxDetail\":{\"TotalTax\":0},\"CustomerRef\":{\"value\":\"3\",\"name\":\"Cool Cars\"},\"BillAddr\":{\"Id\":\"4\",\"Line1\":\"65 Ocean Dr.\",\"City\":\"Half Moon Bay\",\"CountrySubDivisionCode\":\"CA\",\"PostalCode\":\"94213\",\"Lat\":\"37.4300318\",\"Long\":\"-122.4336537\"},\"ShipAddr\":{\"Id\":\"4\",\"Line1\":\"65 Ocean Dr.\",\"City\":\"Half Moon Bay\",\"CountrySubDivisionCode\":\"CA\",\"PostalCode\":\"94213\",\"Lat\":\"37.4300318\",\"Long\":\"-122.4336537\"},\"TotalAmt\":50,\"HomeTotalAmt\":50,\"ApplyTaxAfterDiscount\":false,\"PrintStatus\":\"NeedToPrint\",\"EmailStatus\":\"NotSet\",\"Balance\":50}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "CreditMemo-Update",
"x-testDescription": "Update a credit memo\nMethod : POST"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/companyinfo/{companyid}": {
"get": {
"description": "Method : GET",
"summary": "CompanyInfo-ReadById",
"tags": [
"CompanyInfo"
],
"operationId": "CompanyinfoByCompanyidGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "companyid",
"in": "path",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/journalentry/8": {
"get": {
"description": "Read an journalentry object by Id\nMethod : POST\n",
"summary": "JournalEntry-ReadById",
"tags": [
"JournalEntry"
],
"operationId": "Journalentry8Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/journalentry/8?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "JournalEntry-ReadById",
"x-testDescription": "Read an journalentry object by Id\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/paymentmethod": {
"post": {
"description": "Update a payment method\nMethod : POST\n",
"summary": "PaymentMethod-Update",
"tags": [
"PaymentMethod"
],
"operationId": "PaymentmethodPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/PaymentmethodUpdaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/paymentmethod?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Name\":\"Business Check-Updated\",\"Active\":true,\"Type\":\"NON_CREDIT_CARD\",\"domain\":\"QBO\",\"sparse\":false,\"Id\":\"8\",\"SyncToken\":\"0\",\"MetaData\":{\"CreateTime\":\"2016-08-24T03:09:50+00:00\",\"LastUpdatedTime\":\"2016-08-24T03:09:50+00:00\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "PaymentMethod-Update",
"x-testDescription": "Update a payment method\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/transfer/184": {
"get": {
"description": "Read a transfer object by Id\nMethod : GET\n\n",
"summary": "Transfer-ReadById",
"tags": [
"Transfer"
],
"operationId": "Transfer184Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/transfer/184?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Transfer-ReadById",
"x-testDescription": "Read a transfer object by Id\nMethod : GET\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/ItemSales": {
"get": {
"description": "Report - Item Sales\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/sales%20by%20product\n\n\n\n\n\n\n\n\n",
"summary": "Report-ItemSales",
"tags": [
"Reports"
],
"operationId": "ReportsItemSalesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/ItemSales?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-ItemSales",
"x-testDescription": "Report - Item Sales\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/sales%20by%20product\n\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/account": {
"post": {
"description": "Create a new Account",
"summary": "Account-Create",
"tags": [
"Account"
],
"operationId": "AccountPost2",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AccountCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/account?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"AccountType\":\"Accounts Receivable\",\"Name\":\"AR4\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Account-Create",
"x-testDescription": "Create a new Account"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/employee": {
"post": {
"description": "Delete an employee object\nMethod : POST\n\nDelete via deactivation (active=false)\n\n",
"summary": "Employee-Delete",
"tags": [
"Employee"
],
"operationId": "EmployeePost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/EmployeeDeleterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/employee",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"SSN\":\"XXX-XX-XXXX\",\"PrimaryAddr\":{\"Id\":\"105\",\"Line1\":\"45 N. Elm Street\",\"City\":\"Middlefield\",\"CountrySubDivisionCode\":\"CA\",\"PostalCode\":\"93242\"},\"BillableTime\":false,\"domain\":\"QBO\",\"sparse\":false,\"Id\":\"68\",\"SyncToken\":\"2\",\"MetaData\":{\"CreateTime\":\"2016-08-18T23:04:16+00:00\",\"LastUpdatedTime\":\"2016-08-18T23:04:16+00:00\"},\"GivenName\":\"John\",\"FamilyName\":\"Meuller\",\"DisplayName\":\"John Meuller - Updated\",\"PrintOnCheckName\":\"John Meuller\",\"Active\":false,\"PrimaryPhone\":{\"FreeFormNumber\":\"408-525-1234\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Employee-Delete",
"x-testDescription": "Delete an employee object\nMethod : POST\n\nDelete via deactivation (active=false)\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/term/8": {
"get": {
"description": "Read a term object by Id\nMethod : Get\n\n",
"summary": "Term-ReadById",
"tags": [
"Term"
],
"operationId": "Term8Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/term/8?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Term-ReadById",
"x-testDescription": "Read a term object by Id\nMethod : Get\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/estimate": {
"post": {
"description": "Update an Estimate object\nMethod : POST\n",
"summary": "Estimate-Update",
"tags": [
"Estimate"
],
"operationId": "EstimatePost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/EstimateUpdaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/timeactivity": {
"post": {
"description": "Create a term object\nMethod : POST\n\n",
"summary": "TimeActivity-Create",
"tags": [
"TimeActivity"
],
"operationId": "TimeactivityPost4",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/TimeactivityCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/timeactivity?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"NameOf\":\"Employee\",\"EmployeeRef\":{\"value\":\"55\",\"name\":\"Emily Platt\"},\"StartTime\":\"2015-07-05T16:00:00+00:00\",\"EndTime\":\"2013-07-06T01:00:00+00:00\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "TimeActivity-Create",
"x-testDescription": "Create a term object\nMethod : POST\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/vendor": {
"post": {
"description": "Update a vendor object\nMethod : POST\n\n",
"summary": "Vendor-Update",
"tags": [
"Vendor"
],
"operationId": "VendorPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/VendorUpdaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/vendor?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"BillAddr\":{\"Id\":\"111\",\"Line1\":\"Dianne's Auto Shop\",\"Line2\":\"Dianne Bradley\",\"Line3\":\"29834 Mustang Ave.\",\"City\":\"Millbrae\",\"Country\":\"U.S.A\",\"CountrySubDivisionCode\":\"CA\",\"PostalCode\":\"94030\"},\"TaxIdentifier\":\"XXXXXX8293\",\"Balance\":0,\"AcctNum\":\"35372649\",\"Vendor1099\":false,\"CurrencyRef\":{\"value\":\"USD\",\"name\":\"United States Dollar\"},\"domain\":\"QBO\",\"sparse\":false,\"Id\":\"70\",\"SyncToken\":\"0\",\"Title\":\"Ms.\",\"GivenName\":\"Dianne\",\"FamilyName\":\"Bradley\",\"Suffix\":\"Sr.\",\"CompanyName\":\"Dianne's Auto Shop\",\"DisplayName\":\"Dianne's Auto Shop-Updated\",\"PrintOnCheckName\":\"Dianne's Auto Shop\",\"Active\":true,\"PrimaryPhone\":{\"FreeFormNumber\":\"(650) 555-2342\"},\"Mobile\":{\"FreeFormNumber\":\"(650) 555-2000\"},\"PrimaryEmailAddr\":{\"Address\":\"dbradley@myemail.com\"},\"WebAddr\":{\"URI\":\"http://DiannesAutoShop.com\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Vendor-Update",
"x-testDescription": "Update a vendor object\nMethod : POST\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/refundreceipt": {
"post": {
"description": "Update a refund-receipt object\nMethod : POST\n",
"summary": "RefundReceipt-Update",
"tags": [
"RefundReceipt"
],
"operationId": "RefundreceiptPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/RefundreceiptUpdaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/refundreceipt?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"domain\":\"QBO\",\"sparse\":false,\"Id\":\"180\",\"SyncToken\":\"0\",\"MetaData\":{\"CreateTime\":\"2016-08-24T06:38:22+00:00\",\"LastUpdatedTime\":\"2016-08-24T06:38:22+00:00\"},\"CustomField\":[{\"DefinitionId\":\"1\",\"Name\":\"Crew #\",\"Type\":\"StringType\"}],\"DocNumber\":\"1044-Updated\",\"TxnDate\":\"2016-08-23\",\"CurrencyRef\":{\"value\":\"USD\",\"name\":\"United States Dollar\"},\"ExchangeRate\":1,\"Line\":[{\"Id\":\"1\",\"LineNum\":1,\"Amount\":420,\"DetailType\":\"SalesItemLineDetail\",\"SalesItemLineDetail\":{\"ItemRef\":{\"value\":\"2\",\"name\":\"Hours\"},\"TaxCodeRef\":{\"value\":\"NON\"}}},{\"Amount\":420,\"DetailType\":\"SubTotalLineDetail\",\"SubTotalLineDetail\":{}}],\"TxnTaxDetail\":{\"TotalTax\":0},\"TotalAmt\":420,\"HomeTotalAmt\":420,\"ApplyTaxAfterDiscount\":false,\"PrintStatus\":\"NeedToPrint\",\"Balance\":0,\"PaymentRefNum\":\"To Print\",\"DepositToAccountRef\":{\"value\":\"35\",\"name\":\"Checking\"}}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "RefundReceipt-Update",
"x-testDescription": "Update a refund-receipt object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/vendorcredit": {
"post": {
"description": "Delete a vendorcredit object by Id\nMethod : POST\n\nSample response body \n\n{\n \"VendorCredit\": {\n \"domain\": \"QBO\",\n \"status\": \"Deleted\",\n \"Id\": \"185\"\n },\n \"time\": \"2016-09-02T03:14:13.909-07:00\"\n}",
"summary": "VendorCredit-Delete",
"tags": [
"VendorCredit"
],
"operationId": "VendorcreditPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "operation",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/VendorcreditDeleterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/vendorcredit?operation=delete",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Id\":\"185\",\"SyncToken\":\"1\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "VendorCredit-Delete",
"x-testDescription": "Delete a vendorcredit object by Id\nMethod : POST\n\nSample response body \n\n{\n \"VendorCredit\": {\n \"domain\": \"QBO\",\n \"status\": \"Deleted\",\n \"Id\": \"185\"\n },\n \"time\": \"2016-09-02T03:14:13.909-07:00\"\n}"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/paymentmethod/8": {
"get": {
"description": "Read a payment method\nMethod : GET\n",
"summary": "PaymentMethod-ReadById",
"tags": [
"PaymentMethod"
],
"operationId": "Paymentmethod8Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/paymentmethod/8?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "PaymentMethod-ReadById",
"x-testDescription": "Read a payment method\nMethod : GET\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/creditmemo/160": {
"get": {
"description": "Read a credit memo by Id\nMethod : GET",
"summary": "CreditMemo-ReadById",
"tags": [
"CreditMemo"
],
"operationId": "Creditmemo160Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/creditmemo/160?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "CreditMemo-ReadById",
"x-testDescription": "Read a credit memo by Id\nMethod : GET"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/VendorExpenses": {
"get": {
"description": "Report - Vendor Expense\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/expenses%20by%20vendor\n\n\n\n\n\n",
"summary": "Report-VendorExpense",
"tags": [
"Reports"
],
"operationId": "ReportsVendorExpensesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/VendorExpenses?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-VendorExpense",
"x-testDescription": "Report - Vendor Expense\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/expenses%20by%20vendor\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/vendor/70": {
"get": {
"description": "Read a vendor object by Id\nMethod : GET\n\n",
"summary": "Vendor-ReadById",
"tags": [
"Vendor"
],
"operationId": "Vendor70Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/vendor/70?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Vendor-ReadById",
"x-testDescription": "Read a vendor object by Id\nMethod : GET\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/class": {
"post": {
"description": "Create a Class object\nMethod - POST",
"summary": "Class-Create",
"tags": [
"Class"
],
"operationId": "ClassPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/ClassCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/class?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Name\":\"France\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Class-Create",
"x-testDescription": "Create a Class object\nMethod - POST"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/purchase/175": {
"get": {
"description": "Read a puchase object by Id\nMethod : POST\n",
"summary": "Purchase-ReadById",
"tags": [
"Purchase"
],
"operationId": "Purchase175Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/purchase/175?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Purchase-ReadById",
"x-testDescription": "Read a puchase object by Id\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/billpayment/118": {
"get": {
"description": "Retrieve BillPayment by Id\nMethod - GET",
"summary": "BillPayment-ReadById",
"tags": [
"BillPayment"
],
"operationId": "Billpayment118Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/billpayment/118?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "BillPayment-ReadById",
"x-testDescription": "Retrieve BillPayment by Id\nMethod - GET"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/purchaseorder": {
"post": {
"description": "Create a puchase-order object\nMethod : POST\n",
"summary": "PurchaseOrder-Create",
"tags": [
"PurchaseOrder"
],
"operationId": "PurchaseorderPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/PurchaseorderCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/purchaseorder?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"Line\":[{\"Amount\":25.0,\"DetailType\":\"ItemBasedExpenseLineDetail\",\"ItemBasedExpenseLineDetail\":{\"CustomerRef\":{\"value\":\"3\",\"name\":\"Cool Cars\"},\"BillableStatus\":\"NotBillable\",\"ItemRef\":{\"value\":\"11\",\"name\":\"Pump\"},\"UnitPrice\":25,\"Qty\":1,\"TaxCodeRef\":{\"value\":\"NON\"}}}],\"VendorRef\":{\"value\":\"41\",\"name\":\"Hicks Hardware\"},\"APAccountRef\":{\"value\":\"33\",\"name\":\"Accounts Payable (A/P)\"},\"TotalAmt\":25.0}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "PurchaseOrder-Create",
"x-testDescription": "Create a puchase-order object\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/DepartmentSales": {
"get": {
"description": "Report - Department Sales\nMethod : GET\n\n\n\n\n\n\n\n\n\n\n",
"summary": "Report-DepartmentSales",
"tags": [
"Reports"
],
"operationId": "ReportsDepartmentSalesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/DepartmentSales?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-DepartmentSales",
"x-testDescription": "Report - Department Sales\nMethod : GET\n\n\n\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/taxagency/3": {
"get": {
"description": "Get a tax-agency object by ID\nMethod : GET\n",
"summary": "TaxAgency-ReadByID",
"tags": [
"TaxAgency"
],
"operationId": "Taxagency3Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/taxagency/3?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "TaxAgency-ReadByID",
"x-testDescription": "Get a tax-agency object by ID\nMethod : GET\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/deposit/162": {
"get": {
"description": "Read a deposit object by Id\nMethod : POST",
"summary": "Deposit-ReadById",
"tags": [
"Deposit"
],
"operationId": "Deposit162Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/deposit/162?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Deposit-ReadById",
"x-testDescription": "Read a deposit object by Id\nMethod : POST"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/AgedPayables": {
"get": {
"description": "Report - AgedPayable aging summary\nMethod : GET\n\nThe information below provides a reference on how to access the AP Aging summary report from the QuickBooks Online Report Service.\n\n\n\n\n",
"summary": "Report-AgedPayables",
"tags": [
"Reports"
],
"operationId": "ReportsAgedPayablesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/AgedPayables?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-AgedPayables",
"x-testDescription": "Report - AgedPayable aging summary\nMethod : GET\n\nThe information below provides a reference on how to access the AP Aging summary report from the QuickBooks Online Report Service.\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/bill/1": {
"get": {
"description": "Retrieve a bill by Id\nAccept:application/json\nMethod - GET",
"summary": "Bill-GetById",
"tags": [
"Bill"
],
"operationId": "Bill1Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/bill/1?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Bill-GetById",
"x-testDescription": "Retrieve a bill by Id\nAccept:application/json\nMethod - GET"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/attachable": {
"post": {
"description": "Create an attachable object\nConent-Type:application/json\nMethod - POST",
"summary": "Attachable-Create",
"tags": [
"Attachable"
],
"operationId": "AttachablePost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/AttachableCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/attachable?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"AttachableRef\":[{\"EntityRef\":{\"value\":\"130\",\"type\":\"Invoice\"},\"IncludeOnSend\":\"false\"}],\"Note\":\"This is an attached note.\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Attachable-Create",
"x-testDescription": "Create an attachable object\nConent-Type:application/json\nMethod - POST"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/taxrate/1": {
"get": {
"description": "Read a taxRate by Id\nMethod : POST\n",
"summary": "TaxRate-ReadById",
"tags": [
"TaxRate"
],
"operationId": "Taxrate1Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/taxrate/1?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "TaxRate-ReadById",
"x-testDescription": "Read a taxRate by Id\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/vendorcredit/185": {
"get": {
"description": "Read a vendorcredit object by Id\nMethod : GET\n\nPlease change the VendorCredit it from 165 to a valid VendorCredit objectId which exists in your QBO account",
"summary": "VendorCredit-ReadById",
"tags": [
"VendorCredit"
],
"operationId": "Vendorcredit185Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/vendorcredit/185?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "VendorCredit-ReadById",
"x-testDescription": "Read a vendorcredit object by Id\nMethod : GET\n\nPlease change the VendorCredit it from 165 to a valid VendorCredit objectId which exists in your QBO account"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/class/5000000000000018727": {
"get": {
"description": "Read a Class object by Id\nMethod - GET",
"summary": "Class-ReadById",
"tags": [
"Class"
],
"operationId": "Class5000000000000018727Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/class/5000000000000018727?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Class-ReadById",
"x-testDescription": "Read a Class object by Id\nMethod - GET"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/taxcode/2": {
"get": {
"description": "Read a taxcode by Id\nMethod : POST\n",
"summary": "TaxCode-ReadById",
"tags": [
"TaxCode"
],
"operationId": "Taxcode2Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/taxcode/2?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json",
"Content-Type": "application/text"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "TaxCode-ReadById",
"x-testDescription": "Read a taxcode by Id\nMethod : POST\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/customer/63": {
"get": {
"description": "Read a customer entry by Id\nMethod : GET",
"summary": "Customer-ReadById",
"tags": [
"Customer"
],
"operationId": "Customer63Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/customer/63?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Customer-ReadById",
"x-testDescription": "Read a customer entry by Id\nMethod : GET"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/batch": {
"post": {
"description": "Multiple operations using batch query\nContent-Type:application/json\nMethod - POST",
"summary": "Batch",
"tags": [
"Batch"
],
"operationId": "BatchPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/BatchRequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/batch?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"BatchItemRequest\":[{\"bId\":\"bid1\",\"operation\":\"create\",\"Vendor\":{\"DisplayName\":\"Smith Family Store\"}},{\"bId\":\"bid2\",\"operation\":\"delete\",\"Invoice\":{\"Id\":\"129\",\"SyncToken\":\"0\"}},{\"bId\":\"bid3\",\"operation\":\"update\",\"SalesReceipt\":{\"domain\":\"QBO\",\"sparse\":true,\"Id\":\"11\",\"SyncToken\":\"0\",\"PrivateNote\":\"A private note.\"}},{\"bId\":\"bid4\",\"Query\":\"select * from SalesReceipt\"}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Batch",
"x-testDescription": "Multiple operations using batch query\nContent-Type:application/json\nMethod - POST"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/AccountList": {
"get": {
"description": "Report - Account list detail\nMethod : GET\n\nThe information below provides a reference on how to access the account list detail report from the QuickBooks Online Report Service.\n\n",
"summary": "Report-AccountList",
"tags": [
"Reports"
],
"operationId": "ReportsAccountListGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/AccountList?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-AccountList",
"x-testDescription": "Report - Account list detail\nMethod : GET\n\nThe information below provides a reference on how to access the account list detail report from the QuickBooks Online Report Service.\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/AgedReceivables": {
"get": {
"description": "Report - AgedReceivable aging summary\nMethod : GET\n\nThe information below provides a reference on how to access the AR Aging Summary report from the QuickBooks Online Report Service.\n\n\n\n\n\n",
"summary": "Report-AgedReceivables",
"tags": [
"Reports"
],
"operationId": "ReportsAgedReceivablesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/AgedReceivables?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-AgedReceivables",
"x-testDescription": "Report - AgedReceivable aging summary\nMethod : GET\n\nThe information below provides a reference on how to access the AR Aging Summary report from the QuickBooks Online Report Service.\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/CashFlow": {
"get": {
"description": "Report - CashFlow\nMethod : GET\n\nThe information below provides a reference on how to access the cash flow report from the QuickBooks Online Report Service.\n\n\n\n\n\n\n",
"summary": "Report-CashFlow",
"tags": [
"Reports"
],
"operationId": "ReportsCashFlowGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/CashFlow?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-CashFlow",
"x-testDescription": "Report - CashFlow\nMethod : GET\n\nThe information below provides a reference on how to access the cash flow report from the QuickBooks Online Report Service.\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/BalanceSheet": {
"get": {
"description": "Report - BalanceSheet\nMethod : GET\n\nThe information below provides a reference on how to query the Balance Sheet report from the QuickBooks Online Report Service.\n\n\n\n\n\n\n",
"summary": "Report-BalanceSheet",
"tags": [
"Reports"
],
"operationId": "ReportsBalanceSheetGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/BalanceSheet?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-BalanceSheet",
"x-testDescription": "Report - BalanceSheet\nMethod : GET\n\nThe information below provides a reference on how to query the Balance Sheet report from the QuickBooks Online Report Service.\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/CustomerIncome": {
"get": {
"description": "Report - Customer Income\nMethod : GET\n\n\n\n\n\n\n\n\n\n\n",
"summary": "Report-CustomerIncome",
"tags": [
"Reports"
],
"operationId": "ReportsCustomerIncomeGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/CustomerIncome?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-CustomerIncome",
"x-testDescription": "Report - Customer Income\nMethod : GET\n\n\n\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/AgedReceivableDetail": {
"get": {
"description": "Report - AgedReceivableDetail aging detail\nMethod : GET\n\nThe information below provides a reference on how to access the AR Aging Detail report from the QuickBooks Online Report Service.\n\n\n\n\n",
"summary": "Report-AgedReceivableDetail",
"tags": [
"Reports"
],
"operationId": "ReportsAgedReceivableDetailGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/AgedReceivableDetail?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-AgedReceivableDetail",
"x-testDescription": "Report - AgedReceivableDetail aging detail\nMethod : GET\n\nThe information below provides a reference on how to access the AR Aging Detail report from the QuickBooks Online Report Service.\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/refundreceipt/66": {
"get": {
"description": "Read a refund-receipt object\nMethod : GET\n",
"summary": "RefundReceipt-ReadById",
"tags": [
"RefundReceipt"
],
"operationId": "Refundreceipt66Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/refundreceipt/66?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "RefundReceipt-ReadById",
"x-testDescription": "Read a refund-receipt object\nMethod : GET\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/CustomerBalance": {
"get": {
"description": "Report - CustomerBalance\nMethod : GET\n\n\n\n\n\n\n\n",
"summary": "Report-CustomerBalance",
"tags": [
"Reports"
],
"operationId": "ReportsCustomerBalanceGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/CustomerBalance?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-CustomerBalance",
"x-testDescription": "Report - CustomerBalance\nMethod : GET\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/billpayment": {
"post": {
"description": "Update a BillPayment\nContent-Type:application/json\nMethod - POST",
"summary": "BillPayment-Update",
"tags": [
"BillPayment"
],
"operationId": "BillpaymentPost3",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/BillpaymentUpdaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/billpayment?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"VendorRef\":{\"value\":\"62\",\"name\":\"Test\"},\"PayType\":\"Check\",\"CheckPayment\":{\"BankAccountRef\":{\"value\":\"35\",\"name\":\"Checking\"}},\"TotalAmt\":100.0,\"PrivateNote\":\"Updated Note\",\"Line\":[{\"Amount\":100.0,\"LinkedTxn\":[{\"TxnId\":\"153\",\"TxnType\":\"Bill\"}]}]}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "BillPayment-Update",
"x-testDescription": "Update a BillPayment\nContent-Type:application/json\nMethod - POST"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/exchangerate": {
"get": {
"description": "Get ExchangeRate\nMethod : GET\n",
"summary": "ExchangeRate - GetDetails",
"tags": [
"ExchangeRate"
],
"operationId": "ExchangerateGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "sourcecurrencycode",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "asofdate",
"in": "query",
"required": true,
"type": "string",
"format": "date-time",
"description": ""
},
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/exchangerate?sourcecurrencycode=USD&asofdate=2017-04-25&minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "ExchangeRate - GetDetails",
"x-testDescription": "Get ExchangeRate\nMethod : GET\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/TransactionList": {
"get": {
"description": "Report - Trial List \nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/transaction%20list\n\n\n\n\n\n\n\n",
"summary": "Report-TransactionList",
"tags": [
"Reports"
],
"operationId": "ReportsTransactionListGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/TransactionList?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-TransactionList",
"x-testDescription": "Report - Trial List \nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/transaction%20list\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/department/1": {
"get": {
"description": "Read a department object\nMethod : GET",
"summary": "Department-ReadById",
"tags": [
"Department"
],
"operationId": "Department1Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/department/1?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Department-ReadById",
"x-testDescription": "Read a department object\nMethod : GET"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/employee/68": {
"get": {
"description": "Retrive an employee object by ID\nMethod : GET\n\n",
"summary": "Employee-ReadById",
"tags": [
"Employee"
],
"operationId": "Employee68Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/employee/68?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Employee-ReadById",
"x-testDescription": "Retrive an employee object by ID\nMethod : GET\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/TrialBalance": {
"get": {
"description": "Report - Trial Balance \nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/trial%20balance\n\n\n\n\n\n\n\n",
"summary": "Report-TrialBalance",
"tags": [
"Reports"
],
"operationId": "ReportsTrialBalanceGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/TrialBalance?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-TrialBalance",
"x-testDescription": "Report - Trial Balance \nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/trial%20balance\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/item/<ID>": {
"get": {
"description": "Read an Item by Id\nMethod : GET\n",
"summary": "Item-ReadById",
"tags": [
"Item"
],
"operationId": "ItemIDGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/item/<ID>?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Item-ReadById",
"x-testDescription": "Read an Item by Id\nMethod : GET\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/CustomerSales": {
"get": {
"description": "Report - Customer Sales\nMethod : GET\n\n\n\n\n\n\n\n\n\n\n",
"summary": "Report-CustomerSales",
"tags": [
"Reports"
],
"operationId": "ReportsCustomerSalesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/CustomerSales?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-CustomerSales",
"x-testDescription": "Report - Customer Sales\nMethod : GET\n\n\n\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/AgedPayableDetail": {
"get": {
"description": "Report - AgedPayable aging detail\nMethod : GET\n\nThe information below provides a reference on how to access the AP Aging summary report from the QuickBooks Online Report Service.\n\n\n\n",
"summary": "Report-AgedPayableDetail",
"tags": [
"Reports"
],
"operationId": "ReportsAgedPayableDetailGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/AgedPayableDetail?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-AgedPayableDetail",
"x-testDescription": "Report - AgedPayable aging detail\nMethod : GET\n\nThe information below provides a reference on how to access the AP Aging summary report from the QuickBooks Online Report Service.\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/attachable/5000000000000029383": {
"get": {
"description": "Retrieve an attachable object by Id\nAccept:application/json\nMethod - GET",
"summary": "Attachable-ReadById",
"tags": [
"Attachable"
],
"operationId": "Attachable5000000000000029383Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/attachable/5000000000000029383?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json",
"Content-Type": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Attachable-ReadById",
"x-testDescription": "Retrieve an attachable object by Id\nAccept:application/json\nMethod - GET"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/ClassSales": {
"get": {
"description": "Report - CashSales\nMethod : GET\n\n\n\n\n\n\n\n",
"summary": "Report-CashSales",
"tags": [
"Reports"
],
"operationId": "ReportsClassSalesGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/ClassSales?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-CashSales",
"x-testDescription": "Report - CashSales\nMethod : GET\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/payment/174": {
"get": {
"description": "Read a payment object by Id\nMethod : GET\n",
"summary": "Payment-ReadByID",
"tags": [
"Payment"
],
"operationId": "Payment174Get",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/payment/174?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Payment-ReadByID",
"x-testDescription": "Read a payment object by Id\nMethod : GET\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/VendorBalanceDetail": {
"get": {
"description": "Report - Vendor Balance Detail\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/vendor%20balance%20detail\n\n\n\n\n\n",
"summary": "Report-VendorBalanceDetail",
"tags": [
"Reports"
],
"operationId": "ReportsVendorBalanceDetailGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/VendorBalanceDetail?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-VendorBalanceDetail",
"x-testDescription": "Report - Vendor Balance Detail\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/vendor%20balance%20detail\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/taxagency": {
"post": {
"description": "Create a tax-agency object\nMethod : POST\n\nSample response payload\n\n{\n \"SalesReceipt\": {\n \"domain\": \"QBO\",\n \"status\": \"Deleted\",\n \"Id\": \"181\"\n },\n \"time\": \"2016-09-02T02:17:24.353-07:00\"\n}",
"summary": "TaxAgency-Create",
"tags": [
"TaxAgency"
],
"operationId": "TaxagencyPost",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Body",
"in": "body",
"required": true,
"description": "",
"schema": {
"$ref": "#/definitions/TaxagencyCreaterequest"
}
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Content-Type",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "POST",
"uri": "/taxagency?minorversion={{minorversion}}",
"headers": {
"Content-Type": "application/json",
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
},
"body": "{\"DisplayName\":\"CityTaxAgency\"}"
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "TaxAgency-Create",
"x-testDescription": "Create a tax-agency object\nMethod : POST\n\nSample response payload\n\n{\n \"SalesReceipt\": {\n \"domain\": \"QBO\",\n \"status\": \"Deleted\",\n \"Id\": \"181\"\n },\n \"time\": \"2016-09-02T02:17:24.353-07:00\"\n}"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
},
"/reports/ProfitAndLoss": {
"get": {
"description": "Report - Profit and Loss\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/profit%20and%20loss\n\n\n\n\n\n\n\n\n",
"summary": "Report-ProfitAndLoss",
"tags": [
"Reports"
],
"operationId": "ReportsProfitAndLossGet",
"produces": [
"application/json"
],
"parameters": [
{
"name": "minorversion",
"in": "query",
"required": true,
"type": "string",
"description": ""
},
{
"name": "User-Agent",
"in": "header",
"required": true,
"type": "string",
"description": ""
},
{
"name": "Accept",
"in": "header",
"required": true,
"type": "string",
"description": ""
}
],
"responses": {
"200": {
"description": ""
}
},
"security": [
{
"auth": []
}
],
"x-unitTests": [
{
"request": {
"method": "GET",
"uri": "/reports/ProfitAndLoss?minorversion={{minorversion}}",
"headers": {
"User-Agent": "{{UserAgent}}",
"Accept": "application/json"
}
},
"expectedResponse": {
"x-allowExtraHeaders": true,
"x-bodyMatchMode": "NONE",
"x-arrayOrderedMatching": false,
"x-arrayCheckCount": false,
"x-matchResponseSchema": true,
"headers": {}
},
"x-testShouldPass": true,
"x-testEnabled": true,
"x-testName": "Report-ProfitAndLoss",
"x-testDescription": "Report - Profit and Loss\nMethod : GET\n\nDocs - https://developer.intuit.com/docs/api/accounting/profit%20and%20loss\n\n\n\n\n\n\n\n\n"
}
],
"x-operation-settings": {
"CollectParameters": false,
"AllowDynamicQueryParameters": false,
"AllowDynamicFormParameters": false,
"IsMultiContentStreaming": false
}
}
}
},
"definitions": {
"InvoiceUpdaterequest": {
"title": "Invoice-UpdateRequest",
"example": {
"Deposit": 0,
"AllowIPNPayment": false,
"AllowOnlinePayment": false,
"AllowOnlineCreditCardPayment": false,
"AllowOnlineACHPayment": false,
"domain": "QBO",
"sparse": false,
"Id": "164",
"SyncToken": "0",
"CustomField": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
}
],
"DocNumber": "1041-Updated",
"TxnDate": "2016-08-18",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1,
"LinkedTxn": [],
"Line": [
{
"Id": "1",
"LineNum": 1,
"Amount": 100,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "1",
"name": "Services"
},
"TaxCodeRef": {
"value": "NON"
}
}
},
{
"Amount": 100,
"DetailType": "SubTotalLineDetail",
"SubTotalLineDetail": {}
}
],
"TxnTaxDetail": {
"TotalTax": 0
},
"CustomerRef": {
"value": "1",
"name": "Amy's Bird Sanctuary"
},
"BillAddr": {
"Id": "2",
"Line1": "4581 Finch St.",
"City": "Bayshore",
"CountrySubDivisionCode": "CA",
"PostalCode": "94326",
"Lat": "INVALID",
"Long": "INVALID"
},
"ShipAddr": {
"Id": "2",
"Line1": "4581 Finch St.",
"City": "Bayshore",
"CountrySubDivisionCode": "CA",
"PostalCode": "94326",
"Lat": "INVALID",
"Long": "INVALID"
},
"DueDate": "2016-09-17",
"TotalAmt": 100,
"HomeTotalAmt": 100,
"ApplyTaxAfterDiscount": false,
"PrintStatus": "NeedToPrint",
"EmailStatus": "NotSet",
"Balance": 100
},
"type": "object",
"properties": {
"Deposit": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"AllowIPNPayment": {
"description": "",
"example": false,
"type": "boolean"
},
"AllowOnlinePayment": {
"description": "",
"example": false,
"type": "boolean"
},
"AllowOnlineCreditCardPayment": {
"description": "",
"example": false,
"type": "boolean"
},
"AllowOnlineACHPayment": {
"description": "",
"example": false,
"type": "boolean"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "164",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"CustomField": {
"description": "",
"example": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/CustomField"
}
},
"DocNumber": {
"description": "",
"example": "1041-Updated",
"type": "string"
},
"TxnDate": {
"description": "",
"example": "2016-08-18",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"LinkedTxn": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"Line": {
"description": "",
"example": [
{
"Id": "1",
"LineNum": 1,
"Amount": 100,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "1",
"name": "Services"
},
"TaxCodeRef": {
"value": "NON"
}
}
},
{
"Amount": 100,
"DetailType": "SubTotalLineDetail",
"SubTotalLineDetail": {}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line"
}
},
"TxnTaxDetail": {
"$ref": "#/definitions/TxnTaxDetail"
},
"CustomerRef": {
"$ref": "#/definitions/CustomerRef"
},
"BillAddr": {
"$ref": "#/definitions/BillAddr"
},
"ShipAddr": {
"$ref": "#/definitions/ShipAddr"
},
"DueDate": {
"description": "",
"example": "2016-09-17",
"type": "string"
},
"TotalAmt": {
"description": "",
"example": 100,
"type": "integer",
"format": "int32"
},
"HomeTotalAmt": {
"description": "",
"example": 100,
"type": "integer",
"format": "int32"
},
"ApplyTaxAfterDiscount": {
"description": "",
"example": false,
"type": "boolean"
},
"PrintStatus": {
"description": "",
"example": "NeedToPrint",
"type": "string"
},
"EmailStatus": {
"description": "",
"example": "NotSet",
"type": "string"
},
"Balance": {
"description": "",
"example": 100,
"type": "integer",
"format": "int32"
}
},
"required": [
"Deposit",
"AllowIPNPayment",
"AllowOnlinePayment",
"AllowOnlineCreditCardPayment",
"AllowOnlineACHPayment",
"domain",
"sparse",
"Id",
"SyncToken",
"CustomField",
"DocNumber",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"LinkedTxn",
"Line",
"TxnTaxDetail",
"CustomerRef",
"BillAddr",
"ShipAddr",
"DueDate",
"TotalAmt",
"HomeTotalAmt",
"ApplyTaxAfterDiscount",
"PrintStatus",
"EmailStatus",
"Balance"
]
},
"CustomField": {
"title": "CustomField",
"example": {
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
},
"type": "object",
"properties": {
"DefinitionId": {
"description": "",
"example": "1",
"type": "string"
},
"Name": {
"description": "",
"example": "Crew #",
"type": "string"
},
"Type": {
"description": "",
"example": "StringType",
"type": "string"
}
},
"required": [
"DefinitionId",
"Name",
"Type"
]
},
"CurrencyRef": {
"title": "CurrencyRef",
"example": {
"value": "USD",
"name": "United States Dollar"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "USD",
"type": "string"
},
"name": {
"description": "",
"example": "United States Dollar",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"Line": {
"title": "Line",
"example": {
"Id": "1",
"LineNum": 1,
"Amount": 100,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "1",
"name": "Services"
},
"TaxCodeRef": {
"value": "NON"
}
}
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 100,
"type": "integer",
"format": "int32"
},
"DetailType": {
"description": "",
"example": "SalesItemLineDetail",
"type": "string"
},
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"LineNum": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"SalesItemLineDetail": {
"$ref": "#/definitions/SalesItemLineDetail"
},
"SubTotalLineDetail": {
"description": "",
"example": {},
"type": "object"
}
},
"required": [
"Amount",
"DetailType"
]
},
"SalesItemLineDetail": {
"title": "SalesItemLineDetail",
"example": {
"ItemRef": {
"value": "1",
"name": "Services"
},
"TaxCodeRef": {
"value": "NON"
}
},
"type": "object",
"properties": {
"ItemRef": {
"$ref": "#/definitions/ItemRef"
},
"TaxCodeRef": {
"$ref": "#/definitions/TaxCodeRef"
}
},
"required": [
"ItemRef",
"TaxCodeRef"
]
},
"ItemRef": {
"title": "ItemRef",
"example": {
"value": "1",
"name": "Services"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "1",
"type": "string"
},
"name": {
"description": "",
"example": "Services",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"TaxCodeRef": {
"title": "TaxCodeRef",
"example": {
"value": "NON"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "NON",
"type": "string"
}
},
"required": [
"value"
]
},
"TxnTaxDetail": {
"title": "TxnTaxDetail",
"example": {
"TotalTax": 0
},
"type": "object",
"properties": {
"TotalTax": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
}
},
"required": [
"TotalTax"
]
},
"CustomerRef": {
"title": "CustomerRef",
"example": {
"value": "1",
"name": "Amy's Bird Sanctuary"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "1",
"type": "string"
},
"name": {
"description": "",
"example": "Amy's Bird Sanctuary",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"BillAddr": {
"title": "BillAddr",
"example": {
"Id": "2",
"Line1": "4581 Finch St.",
"City": "Bayshore",
"CountrySubDivisionCode": "CA",
"PostalCode": "94326",
"Lat": "INVALID",
"Long": "INVALID"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "2",
"type": "string"
},
"Line1": {
"description": "",
"example": "4581 Finch St.",
"type": "string"
},
"City": {
"description": "",
"example": "Bayshore",
"type": "string"
},
"CountrySubDivisionCode": {
"description": "",
"example": "CA",
"type": "string"
},
"PostalCode": {
"description": "",
"example": "94326",
"type": "string"
},
"Lat": {
"description": "",
"example": "INVALID",
"type": "string"
},
"Long": {
"description": "",
"example": "INVALID",
"type": "string"
}
},
"required": [
"Id",
"Line1",
"City",
"CountrySubDivisionCode",
"PostalCode",
"Lat",
"Long"
]
},
"ShipAddr": {
"title": "ShipAddr",
"example": {
"Id": "2",
"Line1": "4581 Finch St.",
"City": "Bayshore",
"CountrySubDivisionCode": "CA",
"PostalCode": "94326",
"Lat": "INVALID",
"Long": "INVALID"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "2",
"type": "string"
},
"Line1": {
"description": "",
"example": "4581 Finch St.",
"type": "string"
},
"City": {
"description": "",
"example": "Bayshore",
"type": "string"
},
"CountrySubDivisionCode": {
"description": "",
"example": "CA",
"type": "string"
},
"PostalCode": {
"description": "",
"example": "94326",
"type": "string"
},
"Lat": {
"description": "",
"example": "INVALID",
"type": "string"
},
"Long": {
"description": "",
"example": "INVALID",
"type": "string"
}
},
"required": [
"Id",
"Line1",
"City",
"CountrySubDivisionCode",
"PostalCode",
"Lat",
"Long"
]
},
"TermUpdaterequest": {
"title": "Term-UpdateRequest",
"example": {
"Name": "Term1120-Updated",
"Active": true,
"Type": "STANDARD",
"DiscountPercent": 0,
"DueDays": 120,
"domain": "QBO",
"sparse": false,
"Id": "8",
"SyncToken": "0"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Term1120-Updated",
"type": "string"
},
"Active": {
"description": "",
"example": true,
"type": "boolean"
},
"Type": {
"description": "",
"example": "STANDARD",
"type": "string"
},
"DiscountPercent": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"DueDays": {
"description": "",
"example": 120,
"type": "integer",
"format": "int32"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "8",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"Name",
"Active",
"Type",
"DiscountPercent",
"DueDays",
"domain",
"sparse",
"Id",
"SyncToken"
]
},
"PreferenceUpdaterequest": {
"title": "Preference-UpdateRequest",
"type": "object",
"properties": {
"AccountingInfoPrefs": {
"$ref": "#/definitions/AccountingInfoPrefs"
},
"ProductAndServicesPrefs": {
"$ref": "#/definitions/ProductAndServicesPrefs"
},
"SalesFormsPrefs": {
"$ref": "#/definitions/SalesFormsPrefs"
},
"EmailMessagesPrefs": {
"$ref": "#/definitions/EmailMessagesPrefs"
},
"VendorAndPurchasesPrefs": {
"$ref": "#/definitions/VendorAndPurchasesPrefs"
},
"TimeTrackingPrefs": {
"$ref": "#/definitions/TimeTrackingPrefs"
},
"TaxPrefs": {
"$ref": "#/definitions/TaxPrefs"
},
"CurrencyPrefs": {
"$ref": "#/definitions/CurrencyPrefs"
},
"ReportPrefs": {
"$ref": "#/definitions/ReportPrefs"
},
"OtherPrefs": {
"$ref": "#/definitions/OtherPrefs"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "4",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"AccountingInfoPrefs",
"ProductAndServicesPrefs",
"SalesFormsPrefs",
"EmailMessagesPrefs",
"VendorAndPurchasesPrefs",
"TimeTrackingPrefs",
"TaxPrefs",
"CurrencyPrefs",
"ReportPrefs",
"OtherPrefs",
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData"
]
},
"AccountingInfoPrefs": {
"title": "AccountingInfoPrefs",
"example": {
"TrackDepartments": true,
"DepartmentTerminology": "Location",
"ClassTrackingPerTxn": false,
"ClassTrackingPerTxnLine": true,
"CustomerTerminology": "Customers"
},
"type": "object",
"properties": {
"TrackDepartments": {
"description": "",
"example": true,
"type": "boolean"
},
"DepartmentTerminology": {
"description": "",
"example": "Location",
"type": "string"
},
"ClassTrackingPerTxn": {
"description": "",
"example": false,
"type": "boolean"
},
"ClassTrackingPerTxnLine": {
"description": "",
"example": true,
"type": "boolean"
},
"CustomerTerminology": {
"description": "",
"example": "Customers",
"type": "string"
}
},
"required": [
"TrackDepartments",
"DepartmentTerminology",
"ClassTrackingPerTxn",
"ClassTrackingPerTxnLine",
"CustomerTerminology"
]
},
"ProductAndServicesPrefs": {
"title": "ProductAndServicesPrefs",
"example": {
"ForSales": true,
"ForPurchase": true,
"QuantityWithPriceAndRate": true,
"QuantityOnHand": true
},
"type": "object",
"properties": {
"ForSales": {
"description": "",
"example": true,
"type": "boolean"
},
"ForPurchase": {
"description": "",
"example": true,
"type": "boolean"
},
"QuantityWithPriceAndRate": {
"description": "",
"example": true,
"type": "boolean"
},
"QuantityOnHand": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"ForSales",
"ForPurchase",
"QuantityWithPriceAndRate",
"QuantityOnHand"
]
},
"SalesFormsPrefs": {
"title": "SalesFormsPrefs",
"type": "object",
"properties": {
"CustomField": {
"description": "",
"type": "array",
"items": {
"$ref": "#/definitions/CustomField16"
}
},
"CustomTxnNumbers": {
"description": "",
"example": false,
"type": "boolean"
},
"AllowDeposit": {
"description": "",
"example": true,
"type": "boolean"
},
"AllowDiscount": {
"description": "",
"example": true,
"type": "boolean"
},
"DefaultDiscountAccount": {
"description": "",
"example": "86",
"type": "string"
},
"AllowEstimates": {
"description": "",
"example": true,
"type": "boolean"
},
"ETransactionEnabledStatus": {
"description": "",
"example": "NotApplicable",
"type": "string"
},
"ETransactionAttachPDF": {
"description": "",
"example": false,
"type": "boolean"
},
"ETransactionPaymentEnabled": {
"description": "",
"example": false,
"type": "boolean"
},
"IPNSupportEnabled": {
"description": "",
"example": false,
"type": "boolean"
},
"AllowServiceDate": {
"description": "",
"example": false,
"type": "boolean"
},
"AllowShipping": {
"description": "",
"example": false,
"type": "boolean"
},
"DefaultTerms": {
"$ref": "#/definitions/DefaultTerms"
},
"DefaultCustomerMessage": {
"description": "",
"example": "Thank you for your business and have a great day!",
"type": "string"
}
},
"required": [
"CustomField",
"CustomTxnNumbers",
"AllowDeposit",
"AllowDiscount",
"DefaultDiscountAccount",
"AllowEstimates",
"ETransactionEnabledStatus",
"ETransactionAttachPDF",
"ETransactionPaymentEnabled",
"IPNSupportEnabled",
"AllowServiceDate",
"AllowShipping",
"DefaultTerms",
"DefaultCustomerMessage"
]
},
"CustomField16": {
"title": "CustomField16",
"type": "object",
"properties": {
"CustomField": {
"description": "",
"example": [
{
"Name": "SalesFormsPrefs.UseSalesCustom3",
"Type": "BooleanType",
"BooleanValue": false
},
{
"Name": "SalesFormsPrefs.UseSalesCustom2",
"Type": "BooleanType",
"BooleanValue": false
},
{
"Name": "SalesFormsPrefs.UseSalesCustom1",
"Type": "BooleanType",
"BooleanValue": true
}
],
"type": "array",
"items": {
"$ref": "#/definitions/CustomField17"
}
}
},
"required": [
"CustomField"
]
},
"CustomField17": {
"title": "CustomField17",
"example": {
"Name": "SalesFormsPrefs.UseSalesCustom3",
"Type": "BooleanType",
"BooleanValue": false
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "SalesFormsPrefs.UseSalesCustom3",
"type": "string"
},
"Type": {
"description": "",
"example": "BooleanType",
"type": "string"
},
"BooleanValue": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"Name",
"Type",
"BooleanValue"
]
},
"DefaultTerms": {
"title": "DefaultTerms",
"example": {
"value": "3"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "3",
"type": "string"
}
},
"required": [
"value"
]
},
"EmailMessagesPrefs": {
"title": "EmailMessagesPrefs",
"example": {
"InvoiceMessage": {
"Subject": "Invoice from Craig's Design and Landscaping Services",
"Message": "Your invoice is attached. Please remit payment at your earliest convenience.\nThank you for your business - we appreciate it very much.\n\nSincerely,\nCraig's Design and Landscaping Services"
},
"EstimateMessage": {
"Subject": "Estimate from Craig's Design and Landscaping Services",
"Message": "Please review the estimate below. Feel free to contact us if you have any questions.\nWe look forward to working with you.\n\nSincerely,\nCraig's Design and Landscaping Services"
},
"SalesReceiptMessage": {
"Subject": "Sales Receipt from Craig's Design and Landscaping Services",
"Message": "Your sales receipt is attached.\nThank you for your business - we appreciate it very much.\n\nSincerely,\nCraig's Design and Landscaping Services"
},
"StatementMessage": {
"Subject": "Statement from Craig's Design and Landscaping Services",
"Message": "Your statement is attached. Please remit payment at your earliest convenience.\nThank you for your business - we appreciate it very much.\n\nSincerely,\nCraig's Design and Landscaping Services"
}
},
"type": "object",
"properties": {
"InvoiceMessage": {
"$ref": "#/definitions/InvoiceMessage"
},
"EstimateMessage": {
"$ref": "#/definitions/EstimateMessage"
},
"SalesReceiptMessage": {
"$ref": "#/definitions/SalesReceiptMessage"
},
"StatementMessage": {
"$ref": "#/definitions/StatementMessage"
}
},
"required": [
"InvoiceMessage",
"EstimateMessage",
"SalesReceiptMessage",
"StatementMessage"
]
},
"InvoiceMessage": {
"title": "InvoiceMessage",
"example": {
"Subject": "Invoice from Craig's Design and Landscaping Services",
"Message": "Your invoice is attached. Please remit payment at your earliest convenience.\nThank you for your business - we appreciate it very much.\n\nSincerely,\nCraig's Design and Landscaping Services"
},
"type": "object",
"properties": {
"Subject": {
"description": "",
"example": "Invoice from Craig's Design and Landscaping Services",
"type": "string"
},
"Message": {
"description": "",
"example": "Your invoice is attached. Please remit payment at your earliest convenience.\nThank you for your business - we appreciate it very much.\n\nSincerely,\nCraig's Design and Landscaping Services",
"type": "string"
}
},
"required": [
"Subject",
"Message"
]
},
"EstimateMessage": {
"title": "EstimateMessage",
"example": {
"Subject": "Estimate from Craig's Design and Landscaping Services",
"Message": "Please review the estimate below. Feel free to contact us if you have any questions.\nWe look forward to working with you.\n\nSincerely,\nCraig's Design and Landscaping Services"
},
"type": "object",
"properties": {
"Subject": {
"description": "",
"example": "Estimate from Craig's Design and Landscaping Services",
"type": "string"
},
"Message": {
"description": "",
"example": "Please review the estimate below. Feel free to contact us if you have any questions.\nWe look forward to working with you.\n\nSincerely,\nCraig's Design and Landscaping Services",
"type": "string"
}
},
"required": [
"Subject",
"Message"
]
},
"SalesReceiptMessage": {
"title": "SalesReceiptMessage",
"example": {
"Subject": "Sales Receipt from Craig's Design and Landscaping Services",
"Message": "Your sales receipt is attached.\nThank you for your business - we appreciate it very much.\n\nSincerely,\nCraig's Design and Landscaping Services"
},
"type": "object",
"properties": {
"Subject": {
"description": "",
"example": "Sales Receipt from Craig's Design and Landscaping Services",
"type": "string"
},
"Message": {
"description": "",
"example": "Your sales receipt is attached.\nThank you for your business - we appreciate it very much.\n\nSincerely,\nCraig's Design and Landscaping Services",
"type": "string"
}
},
"required": [
"Subject",
"Message"
]
},
"StatementMessage": {
"title": "StatementMessage",
"example": {
"Subject": "Statement from Craig's Design and Landscaping Services",
"Message": "Your statement is attached. Please remit payment at your earliest convenience.\nThank you for your business - we appreciate it very much.\n\nSincerely,\nCraig's Design and Landscaping Services"
},
"type": "object",
"properties": {
"Subject": {
"description": "",
"example": "Statement from Craig's Design and Landscaping Services",
"type": "string"
},
"Message": {
"description": "",
"example": "Your statement is attached. Please remit payment at your earliest convenience.\nThank you for your business - we appreciate it very much.\n\nSincerely,\nCraig's Design and Landscaping Services",
"type": "string"
}
},
"required": [
"Subject",
"Message"
]
},
"VendorAndPurchasesPrefs": {
"title": "VendorAndPurchasesPrefs",
"type": "object",
"properties": {
"TrackingByCustomer": {
"description": "",
"example": true,
"type": "boolean"
},
"BillableExpenseTracking": {
"description": "",
"example": true,
"type": "boolean"
},
"POCustomField": {
"description": "",
"type": "array",
"items": {
"$ref": "#/definitions/POCustomField"
}
}
},
"required": [
"TrackingByCustomer",
"BillableExpenseTracking",
"POCustomField"
]
},
"POCustomField": {
"title": "POCustomField",
"type": "object",
"properties": {
"CustomField": {
"description": "",
"example": [
{
"Name": "PurchasePrefs.UsePurchaseCustom3",
"Type": "BooleanType",
"BooleanValue": false
},
{
"Name": "PurchasePrefs.UsePurchaseCustom2",
"Type": "BooleanType",
"BooleanValue": true
},
{
"Name": "PurchasePrefs.UsePurchaseCustom1",
"Type": "BooleanType",
"BooleanValue": true
}
],
"type": "array",
"items": {
"$ref": "#/definitions/CustomField17"
}
}
},
"required": [
"CustomField"
]
},
"TimeTrackingPrefs": {
"title": "TimeTrackingPrefs",
"example": {
"UseServices": true,
"BillCustomers": true,
"ShowBillRateToAll": false,
"WorkWeekStartDate": "Monday",
"MarkTimeEntriesBillable": true
},
"type": "object",
"properties": {
"UseServices": {
"description": "",
"example": true,
"type": "boolean"
},
"BillCustomers": {
"description": "",
"example": true,
"type": "boolean"
},
"ShowBillRateToAll": {
"description": "",
"example": false,
"type": "boolean"
},
"WorkWeekStartDate": {
"description": "",
"example": "Monday",
"type": "string"
},
"MarkTimeEntriesBillable": {
"description": "",
"example": true,
"type": "boolean"
}
},
"required": [
"UseServices",
"BillCustomers",
"ShowBillRateToAll",
"WorkWeekStartDate",
"MarkTimeEntriesBillable"
]
},
"TaxPrefs": {
"title": "TaxPrefs",
"example": {
"UsingSalesTax": true,
"TaxGroupCodeRef": {
"value": "2"
}
},
"type": "object",
"properties": {
"UsingSalesTax": {
"description": "",
"example": true,
"type": "boolean"
},
"TaxGroupCodeRef": {
"$ref": "#/definitions/TaxGroupCodeRef"
}
},
"required": [
"UsingSalesTax",
"TaxGroupCodeRef"
]
},
"TaxGroupCodeRef": {
"title": "TaxGroupCodeRef",
"example": {
"value": "2"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "2",
"type": "string"
}
},
"required": [
"value"
]
},
"CurrencyPrefs": {
"title": "CurrencyPrefs",
"example": {
"MultiCurrencyEnabled": true,
"HomeCurrency": {
"value": "USD"
}
},
"type": "object",
"properties": {
"MultiCurrencyEnabled": {
"description": "",
"example": true,
"type": "boolean"
},
"HomeCurrency": {
"$ref": "#/definitions/HomeCurrency"
}
},
"required": [
"MultiCurrencyEnabled",
"HomeCurrency"
]
},
"HomeCurrency": {
"title": "HomeCurrency",
"example": {
"value": "USD"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "USD",
"type": "string"
}
},
"required": [
"value"
]
},
"ReportPrefs": {
"title": "ReportPrefs",
"example": {
"ReportBasis": "Accrual",
"CalcAgingReportFromTxnDate": false
},
"type": "object",
"properties": {
"ReportBasis": {
"description": "",
"example": "Accrual",
"type": "string"
},
"CalcAgingReportFromTxnDate": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"ReportBasis",
"CalcAgingReportFromTxnDate"
]
},
"OtherPrefs": {
"title": "OtherPrefs",
"example": {
"NameValue": [
{
"Name": "SalesFormsPrefs.DefaultCustomerMessage",
"Value": "Thank you for your business and have a great day!"
},
{
"Name": "SalesFormsPrefs.DefaultItem",
"Value": "1"
},
{
"Name": "DTXCopyMemo",
"Value": "false"
},
{
"Name": "UncategorizedAssetAccountId",
"Value": "32"
},
{
"Name": "UncategorizedIncomeAccountId",
"Value": "30"
},
{
"Name": "UncategorizedExpenseAccountId",
"Value": "31"
},
{
"Name": "MasAccountId",
"Value": "35"
},
{
"Name": "SFCEnabled",
"Value": "true"
}
]
},
"type": "object",
"properties": {
"NameValue": {
"description": "",
"example": [
{
"Name": "SalesFormsPrefs.DefaultCustomerMessage",
"Value": "Thank you for your business and have a great day!"
},
{
"Name": "SalesFormsPrefs.DefaultItem",
"Value": "1"
},
{
"Name": "DTXCopyMemo",
"Value": "false"
},
{
"Name": "UncategorizedAssetAccountId",
"Value": "32"
},
{
"Name": "UncategorizedIncomeAccountId",
"Value": "30"
},
{
"Name": "UncategorizedExpenseAccountId",
"Value": "31"
},
{
"Name": "MasAccountId",
"Value": "35"
},
{
"Name": "SFCEnabled",
"Value": "true"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/NameValue"
}
}
},
"required": [
"NameValue"
]
},
"NameValue": {
"title": "NameValue",
"example": {
"Name": "SalesFormsPrefs.DefaultCustomerMessage",
"Value": "Thank you for your business and have a great day!"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "SalesFormsPrefs.DefaultCustomerMessage",
"type": "string"
},
"Value": {
"description": "",
"example": "Thank you for your business and have a great day!",
"type": "string"
}
},
"required": [
"Name",
"Value"
]
},
"MetaData": {
"title": "MetaData",
"example": {
"CreateTime": "2016-01-13T09:07:08+00:00",
"LastUpdatedTime": "2016-08-24T03:12:45+00:00"
},
"type": "object",
"properties": {
"CreateTime": {
"description": "",
"example": "1/13/2016 9:07:08 AM",
"type": "string"
},
"LastUpdatedTime": {
"description": "",
"example": "8/24/2016 3:12:45 AM",
"type": "string"
}
},
"required": [
"CreateTime",
"LastUpdatedTime"
]
},
"PurchaseCreaterequest": {
"title": "Purchase-CreateRequest",
"example": {
"AccountRef": {
"value": "42",
"name": "Visa"
},
"PaymentType": "CreditCard",
"Line": [
{
"Amount": 10.0,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"name": "Meals and Entertainment",
"value": "13"
}
}
}
]
},
"type": "object",
"properties": {
"AccountRef": {
"$ref": "#/definitions/AccountRef"
},
"PaymentType": {
"description": "",
"example": "CreditCard",
"type": "string"
},
"Line": {
"description": "",
"example": [
{
"Amount": 10.0,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"name": "Meals and Entertainment",
"value": "13"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line38"
}
}
},
"required": [
"AccountRef",
"PaymentType",
"Line"
]
},
"AccountRef": {
"title": "AccountRef",
"example": {
"value": "42",
"name": "Visa"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "42",
"type": "string"
},
"name": {
"description": "",
"example": "Visa",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"Line38": {
"title": "Line38",
"example": {
"Amount": 10.0,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"name": "Meals and Entertainment",
"value": "13"
}
}
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 10,
"type": "number",
"format": "double"
},
"DetailType": {
"description": "",
"example": "AccountBasedExpenseLineDetail",
"type": "string"
},
"AccountBasedExpenseLineDetail": {
"$ref": "#/definitions/AccountBasedExpenseLineDetail"
}
},
"required": [
"Amount",
"DetailType",
"AccountBasedExpenseLineDetail"
]
},
"AccountBasedExpenseLineDetail": {
"title": "AccountBasedExpenseLineDetail",
"example": {
"AccountRef": {
"name": "Meals and Entertainment",
"value": "13"
}
},
"type": "object",
"properties": {
"AccountRef": {
"$ref": "#/definitions/AccountRef"
}
},
"required": [
"AccountRef"
]
},
"DepositCreaterequest": {
"title": "Deposit-CreateRequest",
"example": {
"DepositToAccountRef": {
"value": "35",
"name": "Checking"
},
"Line": [
{
"Amount": 20.0,
"DetailType": "DepositLineDetail",
"DepositLineDetail": {
"AccountRef": {
"value": "87",
"name": "Unapplied Cash Payment Income"
}
}
}
]
},
"type": "object",
"properties": {
"DepositToAccountRef": {
"$ref": "#/definitions/DepositToAccountRef"
},
"Line": {
"description": "",
"example": [
{
"Amount": 20.0,
"DetailType": "DepositLineDetail",
"DepositLineDetail": {
"AccountRef": {
"value": "87",
"name": "Unapplied Cash Payment Income"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line43"
}
}
},
"required": [
"DepositToAccountRef",
"Line"
]
},
"DepositToAccountRef": {
"title": "DepositToAccountRef",
"example": {
"value": "35",
"name": "Checking"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "35",
"type": "string"
},
"name": {
"description": "",
"example": "Checking",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"Line43": {
"title": "Line43",
"example": {
"Amount": 20.0,
"DetailType": "DepositLineDetail",
"DepositLineDetail": {
"AccountRef": {
"value": "87",
"name": "Unapplied Cash Payment Income"
}
}
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 20,
"type": "number",
"format": "double"
},
"DetailType": {
"description": "",
"example": "DepositLineDetail",
"type": "string"
},
"DepositLineDetail": {
"$ref": "#/definitions/DepositLineDetail"
}
},
"required": [
"Amount",
"DetailType",
"DepositLineDetail"
]
},
"DepositLineDetail": {
"title": "DepositLineDetail",
"example": {
"AccountRef": {
"value": "87",
"name": "Unapplied Cash Payment Income"
}
},
"type": "object",
"properties": {
"AccountRef": {
"$ref": "#/definitions/AccountRef"
}
},
"required": [
"AccountRef"
]
},
"TransferUpdaterequest": {
"title": "Transfer-UpdateRequest",
"example": {
"FromAccountRef": {
"value": "35",
"name": "Checking"
},
"ToAccountRef": {
"value": "36",
"name": "Savings"
},
"Amount": 120,
"domain": "QBO",
"sparse": false,
"Id": "183",
"SyncToken": "0",
"TxnDate": "2016-09-03",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1
},
"type": "object",
"properties": {
"FromAccountRef": {
"$ref": "#/definitions/FromAccountRef"
},
"ToAccountRef": {
"$ref": "#/definitions/ToAccountRef"
},
"Amount": {
"description": "",
"example": 120,
"type": "integer",
"format": "int32"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "183",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"TxnDate": {
"description": "",
"example": "2016-09-03",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
}
},
"required": [
"FromAccountRef",
"ToAccountRef",
"Amount",
"domain",
"sparse",
"Id",
"SyncToken",
"TxnDate",
"CurrencyRef",
"ExchangeRate"
]
},
"FromAccountRef": {
"title": "FromAccountRef",
"example": {
"value": "35",
"name": "Checking"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "35",
"type": "string"
},
"name": {
"description": "",
"example": "Checking",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"ToAccountRef": {
"title": "ToAccountRef",
"example": {
"value": "36",
"name": "Savings"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "36",
"type": "string"
},
"name": {
"description": "",
"example": "Savings",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"BillUpdaterequest": {
"title": "Bill-UpdateRequest",
"example": {
"Line": [
{
"Id": "1",
"Amount": 240.67,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"value": "7"
}
}
}
],
"VendorRef": {
"value": "56"
}
},
"type": "object",
"properties": {
"Line": {
"description": "",
"example": [
{
"Id": "1",
"Amount": 240.67,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"value": "7"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line51"
}
},
"VendorRef": {
"$ref": "#/definitions/VendorRef"
}
},
"required": [
"Line",
"VendorRef"
]
},
"Line51": {
"title": "Line51",
"example": {
"Id": "1",
"Amount": 240.67,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"value": "7"
}
}
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"Amount": {
"description": "",
"example": 240.67,
"type": "number",
"format": "double"
},
"DetailType": {
"description": "",
"example": "AccountBasedExpenseLineDetail",
"type": "string"
},
"AccountBasedExpenseLineDetail": {
"$ref": "#/definitions/AccountBasedExpenseLineDetail52"
}
},
"required": [
"Id",
"Amount",
"DetailType",
"AccountBasedExpenseLineDetail"
]
},
"AccountBasedExpenseLineDetail52": {
"title": "AccountBasedExpenseLineDetail52",
"example": {
"AccountRef": {
"value": "7"
}
},
"type": "object",
"properties": {
"AccountRef": {
"$ref": "#/definitions/AccountRef53"
}
},
"required": [
"AccountRef"
]
},
"AccountRef53": {
"title": "AccountRef53",
"example": {
"value": "7"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "7",
"type": "string"
}
},
"required": [
"value"
]
},
"VendorRef": {
"title": "VendorRef",
"example": {
"value": "56"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "56",
"type": "string"
}
},
"required": [
"value"
]
},
"BillDeleterequest": {
"title": "Bill-DeleteRequest",
"example": {
"Id": "149",
"SyncToken": "0"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "149",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"PaymentDeleterequest": {
"title": "Payment-DeleteRequest",
"example": {
"Id": "174",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "174",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"SalesreceiptDeleterequest": {
"title": "SalesReceipt-DeleteRequest",
"example": {
"Id": "181",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "181",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"CustomerDeleterequest": {
"title": "Customer-DeleteRequest",
"example": {
"domain": "QBO",
"sparse": true,
"Id": "67",
"SyncToken": "0",
"Active": false
},
"type": "object",
"properties": {
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": true,
"type": "boolean"
},
"Id": {
"description": "",
"example": "67",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"Active": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"domain",
"sparse",
"Id",
"SyncToken",
"Active"
]
},
"DepartmentDeleterequest": {
"title": "Department-DeleteRequest",
"example": {
"Name": "Marketing Department-Updated",
"SubDepartment": false,
"FullyQualifiedName": "Marketing Department",
"Active": false,
"domain": "QBO",
"sparse": false,
"Id": "1",
"SyncToken": "2"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Marketing Department-Updated",
"type": "string"
},
"SubDepartment": {
"description": "",
"example": false,
"type": "boolean"
},
"FullyQualifiedName": {
"description": "",
"example": "Marketing Department",
"type": "string"
},
"Active": {
"description": "",
"example": false,
"type": "boolean"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "2",
"type": "string"
}
},
"required": [
"Name",
"SubDepartment",
"FullyQualifiedName",
"Active",
"domain",
"sparse",
"Id",
"SyncToken"
]
},
"SalesreceiptVoidrequest": {
"title": "SalesReceipt-VoidRequest",
"example": {
"sparse": true,
"Id": "188",
"SyncToken": "0"
},
"type": "object",
"properties": {
"sparse": {
"description": "",
"example": true,
"type": "boolean"
},
"Id": {
"description": "",
"example": "188",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"sparse",
"Id",
"SyncToken"
]
},
"ItemDeleterequest": {
"title": "Item-DeleteRequest",
"example": {
"Name": "Garden Supplies-Updated",
"Active": false,
"FullyQualifiedName": "Garden Supplies-Updated",
"Taxable": false,
"UnitPrice": 0,
"Type": "Inventory",
"IncomeAccountRef": {
"value": "79",
"name": "Sales of Product Income"
},
"PurchaseCost": 0,
"ExpenseAccountRef": {
"value": "80",
"name": "Cost of Goods Sold"
},
"AssetAccountRef": {
"value": "81",
"name": "Inventory Asset"
},
"TrackQtyOnHand": true,
"QtyOnHand": 10,
"InvStartDate": "2015-01-01",
"domain": "QBO",
"sparse": false,
"Id": "20",
"SyncToken": "0"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Garden Supplies-Updated",
"type": "string"
},
"Active": {
"description": "",
"example": false,
"type": "boolean"
},
"FullyQualifiedName": {
"description": "",
"example": "Garden Supplies-Updated",
"type": "string"
},
"Taxable": {
"description": "",
"example": false,
"type": "boolean"
},
"UnitPrice": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"Type": {
"description": "",
"example": "Inventory",
"type": "string"
},
"IncomeAccountRef": {
"$ref": "#/definitions/IncomeAccountRef"
},
"PurchaseCost": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"ExpenseAccountRef": {
"$ref": "#/definitions/ExpenseAccountRef"
},
"AssetAccountRef": {
"$ref": "#/definitions/AssetAccountRef"
},
"TrackQtyOnHand": {
"description": "",
"example": true,
"type": "boolean"
},
"QtyOnHand": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"InvStartDate": {
"description": "",
"example": "2015-01-01",
"type": "string"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "20",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"Name",
"Active",
"FullyQualifiedName",
"Taxable",
"UnitPrice",
"Type",
"IncomeAccountRef",
"PurchaseCost",
"ExpenseAccountRef",
"AssetAccountRef",
"TrackQtyOnHand",
"QtyOnHand",
"InvStartDate",
"domain",
"sparse",
"Id",
"SyncToken"
]
},
"IncomeAccountRef": {
"title": "IncomeAccountRef",
"example": {
"value": "79",
"name": "Sales of Product Income"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "79",
"type": "string"
},
"name": {
"description": "",
"example": "Sales of Product Income",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"ExpenseAccountRef": {
"title": "ExpenseAccountRef",
"example": {
"value": "80",
"name": "Cost of Goods Sold"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "80",
"type": "string"
},
"name": {
"description": "",
"example": "Cost of Goods Sold",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"AssetAccountRef": {
"title": "AssetAccountRef",
"example": {
"value": "81",
"name": "Inventory Asset"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "81",
"type": "string"
},
"name": {
"description": "",
"example": "Inventory Asset",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"JournalentryUpdaterequest": {
"title": "JournalEntry-UpdateRequest",
"example": {
"Adjustment": false,
"domain": "QBO",
"sparse": false,
"Id": "167",
"SyncToken": "0",
"TxnDate": "2016-08-19",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1,
"Line": [
{
"Id": "0",
"Description": "nov portion of rider insurance-updated",
"Amount": 100,
"DetailType": "JournalEntryLineDetail",
"JournalEntryLineDetail": {
"PostingType": "Debit",
"AccountRef": {
"value": "39",
"name": "Truck:Depreciation"
}
}
},
{
"Id": "1",
"Description": "nov portion of rider insurance-updated",
"Amount": 100,
"DetailType": "JournalEntryLineDetail",
"JournalEntryLineDetail": {
"PostingType": "Credit",
"AccountRef": {
"value": "44",
"name": "Notes Payable"
}
}
}
],
"TxnTaxDetail": {}
},
"type": "object",
"properties": {
"Adjustment": {
"description": "",
"example": false,
"type": "boolean"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "167",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"TxnDate": {
"description": "",
"example": "2016-08-19",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Line": {
"description": "",
"example": [
{
"Id": "0",
"Description": "nov portion of rider insurance-updated",
"Amount": 100,
"DetailType": "JournalEntryLineDetail",
"JournalEntryLineDetail": {
"PostingType": "Debit",
"AccountRef": {
"value": "39",
"name": "Truck:Depreciation"
}
}
},
{
"Id": "1",
"Description": "nov portion of rider insurance-updated",
"Amount": 100,
"DetailType": "JournalEntryLineDetail",
"JournalEntryLineDetail": {
"PostingType": "Credit",
"AccountRef": {
"value": "44",
"name": "Notes Payable"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line67"
}
},
"TxnTaxDetail": {
"description": "",
"example": {},
"type": "object"
}
},
"required": [
"Adjustment",
"domain",
"sparse",
"Id",
"SyncToken",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"Line",
"TxnTaxDetail"
]
},
"Line67": {
"title": "Line67",
"example": {
"Id": "0",
"Description": "nov portion of rider insurance-updated",
"Amount": 100,
"DetailType": "JournalEntryLineDetail",
"JournalEntryLineDetail": {
"PostingType": "Debit",
"AccountRef": {
"value": "39",
"name": "Truck:Depreciation"
}
}
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "0",
"type": "string"
},
"Description": {
"description": "",
"example": "nov portion of rider insurance-updated",
"type": "string"
},
"Amount": {
"description": "",
"example": 100,
"type": "integer",
"format": "int32"
},
"DetailType": {
"description": "",
"example": "JournalEntryLineDetail",
"type": "string"
},
"JournalEntryLineDetail": {
"$ref": "#/definitions/JournalEntryLineDetail"
}
},
"required": [
"Id",
"Description",
"Amount",
"DetailType",
"JournalEntryLineDetail"
]
},
"JournalEntryLineDetail": {
"title": "JournalEntryLineDetail",
"example": {
"PostingType": "Debit",
"AccountRef": {
"value": "39",
"name": "Truck:Depreciation"
}
},
"type": "object",
"properties": {
"PostingType": {
"description": "",
"example": "Debit",
"type": "string"
},
"AccountRef": {
"$ref": "#/definitions/AccountRef"
}
},
"required": [
"PostingType",
"AccountRef"
]
},
"TaxserviceCreaterequest": {
"title": "TaxService-CreateRequest",
"example": {
"TaxCode": "MyTaxCodeName",
"TaxRateDetails": [
{
"TaxRateName": "myNewTaxRateName",
"RateValue": "8",
"TaxAgencyId": "1",
"TaxApplicableOn": "Sales"
}
]
},
"type": "object",
"properties": {
"TaxCode": {
"description": "",
"example": "MyTaxCodeName",
"type": "string"
},
"TaxRateDetails": {
"description": "",
"example": [
{
"TaxRateName": "myNewTaxRateName",
"RateValue": "8",
"TaxAgencyId": "1",
"TaxApplicableOn": "Sales"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/TaxRateDetail"
}
}
},
"required": [
"TaxCode",
"TaxRateDetails"
]
},
"TaxRateDetail": {
"title": "TaxRateDetail",
"example": {
"TaxRateName": "myNewTaxRateName",
"RateValue": "8",
"TaxAgencyId": "1",
"TaxApplicableOn": "Sales"
},
"type": "object",
"properties": {
"TaxRateName": {
"description": "",
"example": "myNewTaxRateName",
"type": "string"
},
"RateValue": {
"description": "",
"example": "8",
"type": "string"
},
"TaxAgencyId": {
"description": "",
"example": "1",
"type": "string"
},
"TaxApplicableOn": {
"description": "",
"example": "Sales",
"type": "string"
}
},
"required": [
"TaxRateName",
"RateValue",
"TaxAgencyId",
"TaxApplicableOn"
]
},
"SalesreceiptUpdaterequest": {
"title": "SalesReceipt-UpdateRequest",
"example": {
"domain": "QBO",
"sparse": false,
"Id": "181",
"SyncToken": "0",
"CustomField": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
}
],
"DocNumber": "1045-Updated",
"TxnDate": "2016-09-02",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1,
"Line": [
{
"Id": "1",
"LineNum": 1,
"Description": "Pest Control Services",
"Amount": 35,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "10",
"name": "Pest Control"
},
"UnitPrice": 35,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
},
{
"Amount": 35,
"DetailType": "SubTotalLineDetail",
"SubTotalLineDetail": {}
}
],
"TxnTaxDetail": {
"TotalTax": 0
},
"TotalAmt": 35,
"HomeTotalAmt": 35,
"ApplyTaxAfterDiscount": false,
"PrintStatus": "NeedToPrint",
"EmailStatus": "NotSet",
"Balance": 0,
"DepositToAccountRef": {
"value": "4",
"name": "Undeposited Funds"
}
},
"type": "object",
"properties": {
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "181",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"CustomField": {
"description": "",
"example": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/CustomField"
}
},
"DocNumber": {
"description": "",
"example": "1045-Updated",
"type": "string"
},
"TxnDate": {
"description": "",
"example": "2016-09-02",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Line": {
"description": "",
"example": [
{
"Id": "1",
"LineNum": 1,
"Description": "Pest Control Services",
"Amount": 35,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "10",
"name": "Pest Control"
},
"UnitPrice": 35,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
},
{
"Amount": 35,
"DetailType": "SubTotalLineDetail",
"SubTotalLineDetail": {}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line75"
}
},
"TxnTaxDetail": {
"$ref": "#/definitions/TxnTaxDetail"
},
"TotalAmt": {
"description": "",
"example": 35,
"type": "integer",
"format": "int32"
},
"HomeTotalAmt": {
"description": "",
"example": 35,
"type": "integer",
"format": "int32"
},
"ApplyTaxAfterDiscount": {
"description": "",
"example": false,
"type": "boolean"
},
"PrintStatus": {
"description": "",
"example": "NeedToPrint",
"type": "string"
},
"EmailStatus": {
"description": "",
"example": "NotSet",
"type": "string"
},
"Balance": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"DepositToAccountRef": {
"$ref": "#/definitions/DepositToAccountRef"
}
},
"required": [
"domain",
"sparse",
"Id",
"SyncToken",
"CustomField",
"DocNumber",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"Line",
"TxnTaxDetail",
"TotalAmt",
"HomeTotalAmt",
"ApplyTaxAfterDiscount",
"PrintStatus",
"EmailStatus",
"Balance",
"DepositToAccountRef"
]
},
"Line75": {
"title": "Line75",
"example": {
"Id": "1",
"LineNum": 1,
"Description": "Pest Control Services",
"Amount": 35,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "10",
"name": "Pest Control"
},
"UnitPrice": 35,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 35,
"type": "integer",
"format": "int32"
},
"DetailType": {
"description": "",
"example": "SalesItemLineDetail",
"type": "string"
},
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"LineNum": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Description": {
"description": "",
"example": "Pest Control Services",
"type": "string"
},
"SalesItemLineDetail": {
"$ref": "#/definitions/SalesItemLineDetail76"
},
"SubTotalLineDetail": {
"description": "",
"example": {},
"type": "object"
}
},
"required": [
"Amount",
"DetailType"
]
},
"SalesItemLineDetail76": {
"title": "SalesItemLineDetail76",
"example": {
"ItemRef": {
"value": "10",
"name": "Pest Control"
},
"UnitPrice": 35,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
},
"type": "object",
"properties": {
"ItemRef": {
"$ref": "#/definitions/ItemRef"
},
"UnitPrice": {
"description": "",
"example": 35,
"type": "integer",
"format": "int32"
},
"Qty": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"TaxCodeRef": {
"$ref": "#/definitions/TaxCodeRef"
}
},
"required": [
"ItemRef",
"UnitPrice",
"Qty",
"TaxCodeRef"
]
},
"CreditmemoCreaterequest": {
"title": "CreditMemo-CreateRequest",
"example": {
"Line": [
{
"Amount": 50,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "3",
"name": "Concrete"
}
}
}
],
"CustomerRef": {
"value": "3",
"name": "CoolCars"
}
},
"type": "object",
"properties": {
"Line": {
"description": "",
"example": [
{
"Amount": 50,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "3",
"name": "Concrete"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line82"
}
},
"CustomerRef": {
"$ref": "#/definitions/CustomerRef"
}
},
"required": [
"Line",
"CustomerRef"
]
},
"Line82": {
"title": "Line82",
"example": {
"Amount": 50,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "3",
"name": "Concrete"
}
}
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 50,
"type": "integer",
"format": "int32"
},
"DetailType": {
"description": "",
"example": "SalesItemLineDetail",
"type": "string"
},
"SalesItemLineDetail": {
"$ref": "#/definitions/SalesItemLineDetail83"
}
},
"required": [
"Amount",
"DetailType",
"SalesItemLineDetail"
]
},
"SalesItemLineDetail83": {
"title": "SalesItemLineDetail83",
"example": {
"ItemRef": {
"value": "3",
"name": "Concrete"
}
},
"type": "object",
"properties": {
"ItemRef": {
"$ref": "#/definitions/ItemRef"
}
},
"required": [
"ItemRef"
]
},
"PaymentmethodCreaterequest": {
"title": "PaymentMethod-CreateRequest",
"example": {
"Name": "Business Check"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Business Check",
"type": "string"
}
},
"required": [
"Name"
]
},
"ItemUpdaterequest": {
"title": "Item-UpdateRequest",
"example": {
"Name": "Garden Supplies-Updated",
"Active": true,
"FullyQualifiedName": "Garden Supplies-Updated",
"Taxable": false,
"UnitPrice": 0,
"Type": "Inventory",
"IncomeAccountRef": {
"value": "79",
"name": "Sales of Product Income"
},
"PurchaseCost": 0,
"ExpenseAccountRef": {
"value": "80",
"name": "Cost of Goods Sold"
},
"AssetAccountRef": {
"value": "81",
"name": "Inventory Asset"
},
"TrackQtyOnHand": true,
"QtyOnHand": 10,
"InvStartDate": "2015-01-01",
"domain": "QBO",
"sparse": false,
"Id": "20",
"SyncToken": "0"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Garden Supplies-Updated",
"type": "string"
},
"Active": {
"description": "",
"example": true,
"type": "boolean"
},
"FullyQualifiedName": {
"description": "",
"example": "Garden Supplies-Updated",
"type": "string"
},
"Taxable": {
"description": "",
"example": false,
"type": "boolean"
},
"UnitPrice": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"Type": {
"description": "",
"example": "Inventory",
"type": "string"
},
"IncomeAccountRef": {
"$ref": "#/definitions/IncomeAccountRef"
},
"PurchaseCost": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"ExpenseAccountRef": {
"$ref": "#/definitions/ExpenseAccountRef"
},
"AssetAccountRef": {
"$ref": "#/definitions/AssetAccountRef"
},
"TrackQtyOnHand": {
"description": "",
"example": true,
"type": "boolean"
},
"QtyOnHand": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"InvStartDate": {
"description": "",
"example": "2015-01-01",
"type": "string"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "20",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"Name",
"Active",
"FullyQualifiedName",
"Taxable",
"UnitPrice",
"Type",
"IncomeAccountRef",
"PurchaseCost",
"ExpenseAccountRef",
"AssetAccountRef",
"TrackQtyOnHand",
"QtyOnHand",
"InvStartDate",
"domain",
"sparse",
"Id",
"SyncToken"
]
},
"CustomerUpdaterequest": {
"title": "Customer-UpdateRequest",
"example": {
"Taxable": true,
"BillAddr": {
"Id": "100",
"Line1": "123 Main Street",
"City": "Mountain View",
"Country": "USA",
"CountrySubDivisionCode": "CA",
"PostalCode": "94042"
},
"Notes": "Here are other details.",
"Job": false,
"BillWithParent": false,
"Balance": 0,
"BalanceWithJobs": 0,
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"PreferredDeliveryMethod": "Print",
"domain": "QBO",
"sparse": false,
"Id": "63",
"SyncToken": "2",
"FullyQualifiedName": "King's Groceries-Updated",
"DisplayName": "King's Groceries-Updated",
"PrintOnCheckName": "King's Groceries1",
"Active": true,
"PrimaryPhone": {
"FreeFormNumber": "(555) 555-5555"
},
"PrimaryEmailAddr": {
"Address": "jdrew@myemail.com"
},
"DefaultTaxCodeRef": {
"value": "2"
}
},
"type": "object",
"properties": {
"Taxable": {
"description": "",
"example": true,
"type": "boolean"
},
"BillAddr": {
"$ref": "#/definitions/BillAddr92"
},
"Notes": {
"description": "",
"example": "Here are other details.",
"type": "string"
},
"Job": {
"description": "",
"example": false,
"type": "boolean"
},
"BillWithParent": {
"description": "",
"example": false,
"type": "boolean"
},
"Balance": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"BalanceWithJobs": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"PreferredDeliveryMethod": {
"description": "",
"example": "Print",
"type": "string"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "63",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "2",
"type": "string"
},
"FullyQualifiedName": {
"description": "",
"example": "King's Groceries-Updated",
"type": "string"
},
"DisplayName": {
"description": "",
"example": "King's Groceries-Updated",
"type": "string"
},
"PrintOnCheckName": {
"description": "",
"example": "King's Groceries1",
"type": "string"
},
"Active": {
"description": "",
"example": true,
"type": "boolean"
},
"PrimaryPhone": {
"$ref": "#/definitions/PrimaryPhone"
},
"PrimaryEmailAddr": {
"$ref": "#/definitions/PrimaryEmailAddr"
},
"DefaultTaxCodeRef": {
"$ref": "#/definitions/DefaultTaxCodeRef"
}
},
"required": [
"Taxable",
"BillAddr",
"Notes",
"Job",
"BillWithParent",
"Balance",
"BalanceWithJobs",
"CurrencyRef",
"PreferredDeliveryMethod",
"domain",
"sparse",
"Id",
"SyncToken",
"FullyQualifiedName",
"DisplayName",
"PrintOnCheckName",
"Active",
"PrimaryPhone",
"PrimaryEmailAddr",
"DefaultTaxCodeRef"
]
},
"BillAddr92": {
"title": "BillAddr92",
"example": {
"Id": "100",
"Line1": "123 Main Street",
"City": "Mountain View",
"Country": "USA",
"CountrySubDivisionCode": "CA",
"PostalCode": "94042"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "100",
"type": "string"
},
"Line1": {
"description": "",
"example": "123 Main Street",
"type": "string"
},
"City": {
"description": "",
"example": "Mountain View",
"type": "string"
},
"Country": {
"description": "",
"example": "USA",
"type": "string"
},
"CountrySubDivisionCode": {
"description": "",
"example": "CA",
"type": "string"
},
"PostalCode": {
"description": "",
"example": "94042",
"type": "string"
}
},
"required": [
"Id",
"Line1",
"City",
"Country",
"CountrySubDivisionCode",
"PostalCode"
]
},
"PrimaryPhone": {
"title": "PrimaryPhone",
"example": {
"FreeFormNumber": "(555) 555-5555"
},
"type": "object",
"properties": {
"FreeFormNumber": {
"description": "",
"example": "(555) 555-5555",
"type": "string"
}
},
"required": [
"FreeFormNumber"
]
},
"PrimaryEmailAddr": {
"title": "PrimaryEmailAddr",
"example": {
"Address": "jdrew@myemail.com"
},
"type": "object",
"properties": {
"Address": {
"description": "",
"example": "jdrew@myemail.com",
"type": "string"
}
},
"required": [
"Address"
]
},
"DefaultTaxCodeRef": {
"title": "DefaultTaxCodeRef",
"example": {
"value": "2"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "2",
"type": "string"
}
},
"required": [
"value"
]
},
"PaymentUpdaterequest": {
"title": "Payment-UpdateRequest",
"example": {
"CustomerRef": {
"value": "58",
"name": "TEST123"
},
"DepositToAccountRef": {
"value": "4"
},
"TotalAmt": 100,
"UnappliedAmt": 0,
"ProcessPayment": false,
"domain": "QBO",
"sparse": false,
"Id": "174",
"SyncToken": "0",
"TxnDate": "2016-08-29",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1,
"Line": [
{
"Amount": 100,
"LinkedTxn": [
{
"TxnId": "173",
"TxnType": "Invoice"
}
],
"LineEx": {
"any": [
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnId",
"Value": "173"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
},
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnOpenBalance",
"Value": "100.00"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
},
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnReferenceNumber",
"Value": "1043"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
}
]
}
}
]
},
"type": "object",
"properties": {
"CustomerRef": {
"$ref": "#/definitions/CustomerRef"
},
"DepositToAccountRef": {
"$ref": "#/definitions/DepositToAccountRef99"
},
"TotalAmt": {
"description": "",
"example": 100,
"type": "integer",
"format": "int32"
},
"UnappliedAmt": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"ProcessPayment": {
"description": "",
"example": false,
"type": "boolean"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "174",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"TxnDate": {
"description": "",
"example": "2016-08-29",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Line": {
"description": "",
"example": [
{
"Amount": 100,
"LinkedTxn": [
{
"TxnId": "173",
"TxnType": "Invoice"
}
],
"LineEx": {
"any": [
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnId",
"Value": "173"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
},
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnOpenBalance",
"Value": "100.00"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
},
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnReferenceNumber",
"Value": "1043"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
}
]
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line101"
}
}
},
"required": [
"CustomerRef",
"DepositToAccountRef",
"TotalAmt",
"UnappliedAmt",
"ProcessPayment",
"domain",
"sparse",
"Id",
"SyncToken",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"Line"
]
},
"DepositToAccountRef99": {
"title": "DepositToAccountRef99",
"example": {
"value": "4"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "4",
"type": "string"
}
},
"required": [
"value"
]
},
"Line101": {
"title": "Line101",
"example": {
"Amount": 100,
"LinkedTxn": [
{
"TxnId": "173",
"TxnType": "Invoice"
}
],
"LineEx": {
"any": [
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnId",
"Value": "173"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
},
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnOpenBalance",
"Value": "100.00"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
},
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnReferenceNumber",
"Value": "1043"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
}
]
}
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 100,
"type": "integer",
"format": "int32"
},
"LinkedTxn": {
"description": "",
"example": [
{
"TxnId": "173",
"TxnType": "Invoice"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/LinkedTxn"
}
},
"LineEx": {
"$ref": "#/definitions/LineEx"
}
},
"required": [
"Amount",
"LinkedTxn",
"LineEx"
]
},
"LinkedTxn": {
"title": "LinkedTxn",
"example": {
"TxnId": "173",
"TxnType": "Invoice"
},
"type": "object",
"properties": {
"TxnId": {
"description": "",
"example": "173",
"type": "string"
},
"TxnType": {
"description": "",
"example": "Invoice",
"type": "string"
}
},
"required": [
"TxnId",
"TxnType"
]
},
"LineEx": {
"title": "LineEx",
"example": {
"any": [
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnId",
"Value": "173"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
},
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnOpenBalance",
"Value": "100.00"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
},
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnReferenceNumber",
"Value": "1043"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
}
]
},
"type": "object",
"properties": {
"any": {
"description": "",
"example": [
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnId",
"Value": "173"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
},
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnOpenBalance",
"Value": "100.00"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
},
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "txnReferenceNumber",
"Value": "1043"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
}
],
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"any"
]
},
"Any": {
"title": "Any",
"type": "object",
"properties": {
"name": {
"description": "",
"example": "{http://schema.intuit.com/finance/v3}NameValue",
"type": "string"
},
"declaredType": {
"description": "",
"example": "com.intuit.schema.finance.v3.NameValue",
"type": "string"
},
"scope": {
"description": "",
"example": "javax.xml.bind.JAXBElement$GlobalScope",
"type": "string"
},
"value": {
"$ref": "#/definitions/Value"
},
"nil": {
"description": "",
"example": false,
"type": "boolean"
},
"globalScope": {
"description": "",
"example": true,
"type": "boolean"
},
"typeSubstituted": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"name",
"declaredType",
"scope",
"value",
"nil",
"globalScope",
"typeSubstituted"
]
},
"Value": {
"title": "Value",
"example": {
"Name": "txnId",
"Value": "173"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "txnId",
"type": "string"
},
"Value": {
"description": "",
"example": "173",
"type": "string"
}
},
"required": [
"Name",
"Value"
]
},
"AccountUpdaterequest": {
"title": "Account-UpdateRequest",
"example": {
"Name": "AR3-Updated111",
"SubAccount": false,
"FullyQualifiedName": "AR3-Updated",
"Active": true,
"Classification": "Asset",
"AccountType": "Accounts Receivable",
"AccountSubType": "AccountsReceivable",
"CurrentBalance": 0,
"CurrentBalanceWithSubAccounts": 0,
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"domain": "QBO",
"sparse": false,
"Id": "94",
"SyncToken": "3"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "AR3-Updated111",
"type": "string"
},
"SubAccount": {
"description": "",
"example": false,
"type": "boolean"
},
"FullyQualifiedName": {
"description": "",
"example": "AR3-Updated",
"type": "string"
},
"Active": {
"description": "",
"example": true,
"type": "boolean"
},
"Classification": {
"description": "",
"example": "Asset",
"type": "string"
},
"AccountType": {
"description": "",
"example": "Accounts Receivable",
"type": "string"
},
"AccountSubType": {
"description": "",
"example": "AccountsReceivable",
"type": "string"
},
"CurrentBalance": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"CurrentBalanceWithSubAccounts": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "94",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "3",
"type": "string"
}
},
"required": [
"Name",
"SubAccount",
"FullyQualifiedName",
"Active",
"Classification",
"AccountType",
"AccountSubType",
"CurrentBalance",
"CurrentBalanceWithSubAccounts",
"CurrencyRef",
"domain",
"sparse",
"Id",
"SyncToken"
]
},
"EmployeeUpdaterequest": {
"title": "Employee-UpdateRequest",
"example": {
"SSN": "XXX-XX-XXXX",
"PrimaryAddr": {
"Id": "105",
"Line1": "45 N. Elm Street",
"City": "Middlefield",
"CountrySubDivisionCode": "CA",
"PostalCode": "93242"
},
"BillableTime": false,
"domain": "QBO",
"sparse": false,
"Id": "68",
"SyncToken": "0",
"MetaData": {
"CreateTime": "2016-08-18T23:04:16+00:00",
"LastUpdatedTime": "2016-08-18T23:04:16+00:00"
},
"GivenName": "John",
"FamilyName": "Meuller",
"DisplayName": "John Meuller - Updated",
"PrintOnCheckName": "John Meuller",
"Active": true,
"PrimaryPhone": {
"FreeFormNumber": "408-525-1234"
}
},
"type": "object",
"properties": {
"SSN": {
"description": "",
"example": "XXX-XX-XXXX",
"type": "string"
},
"PrimaryAddr": {
"$ref": "#/definitions/PrimaryAddr"
},
"BillableTime": {
"description": "",
"example": false,
"type": "boolean"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "68",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
},
"GivenName": {
"description": "",
"example": "John",
"type": "string"
},
"FamilyName": {
"description": "",
"example": "Meuller",
"type": "string"
},
"DisplayName": {
"description": "",
"example": "John Meuller - Updated",
"type": "string"
},
"PrintOnCheckName": {
"description": "",
"example": "John Meuller",
"type": "string"
},
"Active": {
"description": "",
"example": true,
"type": "boolean"
},
"PrimaryPhone": {
"$ref": "#/definitions/PrimaryPhone"
}
},
"required": [
"SSN",
"PrimaryAddr",
"BillableTime",
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData",
"GivenName",
"FamilyName",
"DisplayName",
"PrintOnCheckName",
"Active",
"PrimaryPhone"
]
},
"PrimaryAddr": {
"title": "PrimaryAddr",
"example": {
"Id": "105",
"Line1": "45 N. Elm Street",
"City": "Middlefield",
"CountrySubDivisionCode": "CA",
"PostalCode": "93242"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "105",
"type": "string"
},
"Line1": {
"description": "",
"example": "45 N. Elm Street",
"type": "string"
},
"City": {
"description": "",
"example": "Middlefield",
"type": "string"
},
"CountrySubDivisionCode": {
"description": "",
"example": "CA",
"type": "string"
},
"PostalCode": {
"description": "",
"example": "93242",
"type": "string"
}
},
"required": [
"Id",
"Line1",
"City",
"CountrySubDivisionCode",
"PostalCode"
]
},
"EstimateCreaterequest": {
"title": "Estimate-CreateRequest",
"example": {
"Line": [
{
"Id": "1",
"LineNum": 1,
"Description": "Pest Control Services",
"Amount": 35.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "10",
"name": "Pest Control"
},
"UnitPrice": 35,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
},
{
"Amount": 35.0,
"DetailType": "SubTotalLineDetail",
"SubTotalLineDetail": {}
},
{
"Amount": 3.5,
"DetailType": "DiscountLineDetail",
"DiscountLineDetail": {
"PercentBased": true,
"DiscountPercent": 10,
"DiscountAccountRef": {
"value": "86",
"name": "Discounts given"
}
}
}
],
"TxnTaxDetail": {
"TotalTax": 0
},
"CustomerRef": {
"value": "3",
"name": "Cool Cars"
},
"CustomerMemo": {
"value": "Thank you for your business and have a great day!"
},
"TotalAmt": 31.5,
"ApplyTaxAfterDiscount": false,
"PrintStatus": "NeedToPrint",
"EmailStatus": "NotSet",
"BillEmail": {
"Address": "Cool_Cars@intuit.com"
}
},
"type": "object",
"properties": {
"Line": {
"description": "",
"example": [
{
"Id": "1",
"LineNum": 1,
"Description": "Pest Control Services",
"Amount": 35.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "10",
"name": "Pest Control"
},
"UnitPrice": 35,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
},
{
"Amount": 35.0,
"DetailType": "SubTotalLineDetail",
"SubTotalLineDetail": {}
},
{
"Amount": 3.5,
"DetailType": "DiscountLineDetail",
"DiscountLineDetail": {
"PercentBased": true,
"DiscountPercent": 10,
"DiscountAccountRef": {
"value": "86",
"name": "Discounts given"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line113"
}
},
"TxnTaxDetail": {
"$ref": "#/definitions/TxnTaxDetail"
},
"CustomerRef": {
"$ref": "#/definitions/CustomerRef"
},
"CustomerMemo": {
"$ref": "#/definitions/CustomerMemo"
},
"TotalAmt": {
"description": "",
"example": 31.5,
"type": "number",
"format": "double"
},
"ApplyTaxAfterDiscount": {
"description": "",
"example": false,
"type": "boolean"
},
"PrintStatus": {
"description": "",
"example": "NeedToPrint",
"type": "string"
},
"EmailStatus": {
"description": "",
"example": "NotSet",
"type": "string"
},
"BillEmail": {
"$ref": "#/definitions/BillEmail"
}
},
"required": [
"Line",
"TxnTaxDetail",
"CustomerRef",
"CustomerMemo",
"TotalAmt",
"ApplyTaxAfterDiscount",
"PrintStatus",
"EmailStatus",
"BillEmail"
]
},
"Line113": {
"title": "Line113",
"example": {
"Id": "1",
"LineNum": 1,
"Description": "Pest Control Services",
"Amount": 35.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "10",
"name": "Pest Control"
},
"UnitPrice": 35,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 35,
"type": "number",
"format": "double"
},
"DetailType": {
"description": "",
"example": "SalesItemLineDetail",
"type": "string"
},
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"LineNum": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Description": {
"description": "",
"example": "Pest Control Services",
"type": "string"
},
"SalesItemLineDetail": {
"$ref": "#/definitions/SalesItemLineDetail76"
},
"SubTotalLineDetail": {
"description": "",
"example": {},
"type": "object"
},
"DiscountLineDetail": {
"$ref": "#/definitions/DiscountLineDetail"
}
},
"required": [
"Amount",
"DetailType"
]
},
"DiscountLineDetail": {
"title": "DiscountLineDetail",
"example": {
"PercentBased": true,
"DiscountPercent": 10,
"DiscountAccountRef": {
"value": "86",
"name": "Discounts given"
}
},
"type": "object",
"properties": {
"PercentBased": {
"description": "",
"example": true,
"type": "boolean"
},
"DiscountPercent": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"DiscountAccountRef": {
"$ref": "#/definitions/DiscountAccountRef"
}
},
"required": [
"PercentBased",
"DiscountPercent",
"DiscountAccountRef"
]
},
"DiscountAccountRef": {
"title": "DiscountAccountRef",
"example": {
"value": "86",
"name": "Discounts given"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "86",
"type": "string"
},
"name": {
"description": "",
"example": "Discounts given",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"CustomerMemo": {
"title": "CustomerMemo",
"example": {
"value": "Thank you for your business and have a great day!"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "Thank you for your business and have a great day!",
"type": "string"
}
},
"required": [
"value"
]
},
"BillEmail": {
"title": "BillEmail",
"example": {
"Address": "Cool_Cars@intuit.com"
},
"type": "object",
"properties": {
"Address": {
"description": "",
"example": "Cool_Cars@intuit.com",
"type": "string"
}
},
"required": [
"Address"
]
},
"TimeactivityReadbyidrequest": {
"title": "TimeActivity-ReadByIdRequest",
"example": {
"TxnDate": "2016-09-03",
"NameOf": "Employee",
"EmployeeRef": {
"value": "55",
"name": "Emily Platt"
},
"ItemRef": {
"value": "2",
"name": "Hours"
},
"BillableStatus": "NotBillable",
"Taxable": false,
"HourlyRate": 0,
"StartTime": "2016-09-02T16:00:00+00:00",
"EndTime": "2016-09-03T01:00:00+00:00",
"domain": "QBO",
"sparse": false,
"Id": "6",
"SyncToken": "0"
},
"type": "object",
"properties": {
"TxnDate": {
"description": "",
"example": "2016-09-03",
"type": "string"
},
"NameOf": {
"description": "",
"example": "Employee",
"type": "string"
},
"EmployeeRef": {
"$ref": "#/definitions/EmployeeRef"
},
"ItemRef": {
"$ref": "#/definitions/ItemRef"
},
"BillableStatus": {
"description": "",
"example": "NotBillable",
"type": "string"
},
"Taxable": {
"description": "",
"example": false,
"type": "boolean"
},
"HourlyRate": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"StartTime": {
"description": "",
"example": "9/2/2016 4:00:00 PM",
"type": "string"
},
"EndTime": {
"description": "",
"example": "9/3/2016 1:00:00 AM",
"type": "string"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "6",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"TxnDate",
"NameOf",
"EmployeeRef",
"ItemRef",
"BillableStatus",
"Taxable",
"HourlyRate",
"StartTime",
"EndTime",
"domain",
"sparse",
"Id",
"SyncToken"
]
},
"EmployeeRef": {
"title": "EmployeeRef",
"example": {
"value": "55",
"name": "Emily Platt"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "55",
"type": "string"
},
"name": {
"description": "",
"example": "Emily Platt",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"VendorCreaterequest": {
"title": "Vendor-CreateRequest",
"example": {
"BillAddr": {
"Line1": "Dianne's Auto Shop",
"Line2": "Dianne Bradley",
"Line3": "29834 Mustang Ave.",
"City": "Millbrae",
"Country": "U.S.A",
"CountrySubDivisionCode": "CA",
"PostalCode": "94030"
},
"TaxIdentifier": "99-5688293",
"AcctNum": "35372649",
"Title": "Ms.",
"GivenName": "Dianne",
"FamilyName": "Bradley",
"Suffix": "Sr.",
"CompanyName": "Dianne's Auto Shop",
"DisplayName": "Dianne's Auto Shop",
"PrintOnCheckName": "Dianne's Auto Shop",
"PrimaryPhone": {
"FreeFormNumber": "(650) 555-2342"
},
"Mobile": {
"FreeFormNumber": "(650) 555-2000"
},
"PrimaryEmailAddr": {
"Address": "dbradley@myemail.com"
},
"WebAddr": {
"URI": "http://DiannesAutoShop.com"
}
},
"type": "object",
"properties": {
"BillAddr": {
"$ref": "#/definitions/BillAddr127"
},
"TaxIdentifier": {
"description": "",
"example": "99-5688293",
"type": "string"
},
"AcctNum": {
"description": "",
"example": "35372649",
"type": "string"
},
"Title": {
"description": "",
"example": "Ms.",
"type": "string"
},
"GivenName": {
"description": "",
"example": "Dianne",
"type": "string"
},
"FamilyName": {
"description": "",
"example": "Bradley",
"type": "string"
},
"Suffix": {
"description": "",
"example": "Sr.",
"type": "string"
},
"CompanyName": {
"description": "",
"example": "Dianne's Auto Shop",
"type": "string"
},
"DisplayName": {
"description": "",
"example": "Dianne's Auto Shop",
"type": "string"
},
"PrintOnCheckName": {
"description": "",
"example": "Dianne's Auto Shop",
"type": "string"
},
"PrimaryPhone": {
"$ref": "#/definitions/PrimaryPhone"
},
"Mobile": {
"$ref": "#/definitions/Mobile"
},
"PrimaryEmailAddr": {
"$ref": "#/definitions/PrimaryEmailAddr"
},
"WebAddr": {
"$ref": "#/definitions/WebAddr"
}
},
"required": [
"BillAddr",
"TaxIdentifier",
"AcctNum",
"Title",
"GivenName",
"FamilyName",
"Suffix",
"CompanyName",
"DisplayName",
"PrintOnCheckName",
"PrimaryPhone",
"Mobile",
"PrimaryEmailAddr",
"WebAddr"
]
},
"BillAddr127": {
"title": "BillAddr127",
"example": {
"Line1": "Dianne's Auto Shop",
"Line2": "Dianne Bradley",
"Line3": "29834 Mustang Ave.",
"City": "Millbrae",
"Country": "U.S.A",
"CountrySubDivisionCode": "CA",
"PostalCode": "94030"
},
"type": "object",
"properties": {
"Line1": {
"description": "",
"example": "Dianne's Auto Shop",
"type": "string"
},
"Line2": {
"description": "",
"example": "Dianne Bradley",
"type": "string"
},
"Line3": {
"description": "",
"example": "29834 Mustang Ave.",
"type": "string"
},
"City": {
"description": "",
"example": "Millbrae",
"type": "string"
},
"Country": {
"description": "",
"example": "U.S.A",
"type": "string"
},
"CountrySubDivisionCode": {
"description": "",
"example": "CA",
"type": "string"
},
"PostalCode": {
"description": "",
"example": "94030",
"type": "string"
}
},
"required": [
"Line1",
"Line2",
"Line3",
"City",
"Country",
"CountrySubDivisionCode",
"PostalCode"
]
},
"Mobile": {
"title": "Mobile",
"example": {
"FreeFormNumber": "(650) 555-2000"
},
"type": "object",
"properties": {
"FreeFormNumber": {
"description": "",
"example": "(650) 555-2000",
"type": "string"
}
},
"required": [
"FreeFormNumber"
]
},
"WebAddr": {
"title": "WebAddr",
"example": {
"URI": "http://DiannesAutoShop.com"
},
"type": "object",
"properties": {
"URI": {
"description": "",
"example": "http://DiannesAutoShop.com",
"type": "string"
}
},
"required": [
"URI"
]
},
"RefundreceiptCreaterequest": {
"title": "RefundReceipt-CreateRequest",
"example": {
"Line": [
{
"Amount": 420.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "2"
}
}
}
],
"DepositToAccountRef": {
"value": "35",
"name": "Checking"
}
},
"type": "object",
"properties": {
"Line": {
"description": "",
"example": [
{
"Amount": 420.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "2"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line133"
}
},
"DepositToAccountRef": {
"$ref": "#/definitions/DepositToAccountRef"
}
},
"required": [
"Line",
"DepositToAccountRef"
]
},
"Line133": {
"title": "Line133",
"example": {
"Amount": 420.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "2"
}
}
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 420,
"type": "number",
"format": "double"
},
"DetailType": {
"description": "",
"example": "SalesItemLineDetail",
"type": "string"
},
"SalesItemLineDetail": {
"$ref": "#/definitions/SalesItemLineDetail134"
}
},
"required": [
"Amount",
"DetailType",
"SalesItemLineDetail"
]
},
"SalesItemLineDetail134": {
"title": "SalesItemLineDetail134",
"example": {
"ItemRef": {
"value": "2"
}
},
"type": "object",
"properties": {
"ItemRef": {
"$ref": "#/definitions/ItemRef135"
}
},
"required": [
"ItemRef"
]
},
"ItemRef135": {
"title": "ItemRef135",
"example": {
"value": "2"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "2",
"type": "string"
}
},
"required": [
"value"
]
},
"BillCreaterequest": {
"title": "Bill-CreateRequest",
"example": {
"Line": [
{
"Id": "1",
"Amount": 200.0,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"value": "7"
}
}
}
],
"VendorRef": {
"value": "56"
}
},
"type": "object",
"properties": {
"Line": {
"description": "",
"example": [
{
"Id": "1",
"Amount": 200.0,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"value": "7"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line51"
}
},
"VendorRef": {
"$ref": "#/definitions/VendorRef"
}
},
"required": [
"Line",
"VendorRef"
]
},
"CreditmemoDeleterequest": {
"title": "CreditMemo-DeleteRequest",
"example": {
"Id": "160",
"SyncToken": "2"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "160",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "2",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"ItemCreaterequest": {
"title": "Item-CreateRequest",
"example": {
"Name": "Garden Supplies1",
"IncomeAccountRef": {
"value": "79",
"name": "Sales of Product Income"
},
"ExpenseAccountRef": {
"value": "80",
"name": "Cost of Goods Sold"
},
"AssetAccountRef": {
"value": "81",
"name": "Inventory Asset"
},
"Type": "Inventory",
"TrackQtyOnHand": true,
"QtyOnHand": 10,
"InvStartDate": "2015-01-01"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Garden Supplies1",
"type": "string"
},
"IncomeAccountRef": {
"$ref": "#/definitions/IncomeAccountRef"
},
"ExpenseAccountRef": {
"$ref": "#/definitions/ExpenseAccountRef"
},
"AssetAccountRef": {
"$ref": "#/definitions/AssetAccountRef"
},
"Type": {
"description": "",
"example": "Inventory",
"type": "string"
},
"TrackQtyOnHand": {
"description": "",
"example": true,
"type": "boolean"
},
"QtyOnHand": {
"description": "",
"example": 10,
"type": "integer",
"format": "int32"
},
"InvStartDate": {
"description": "",
"example": "2015-01-01",
"type": "string"
}
},
"required": [
"Name",
"IncomeAccountRef",
"ExpenseAccountRef",
"AssetAccountRef",
"Type",
"TrackQtyOnHand",
"QtyOnHand",
"InvStartDate"
]
},
"ClassDeleterequest": {
"title": "Class-DeleteRequest",
"example": {
"Id": "5000000000000018727",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "5000000000000018727",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"PurchaseorderDeleterequest": {
"title": "PurchaseOrder-DeleteRequest",
"example": {
"Id": "179",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "179",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"DepartmentUpdaterequest": {
"title": "Department-UpdateRequest",
"example": {
"Name": "Marketing Department-Updated",
"SubDepartment": false,
"FullyQualifiedName": "Marketing Department",
"Active": true,
"domain": "QBO",
"sparse": false,
"Id": "1",
"SyncToken": "0"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Marketing Department-Updated",
"type": "string"
},
"SubDepartment": {
"description": "",
"example": false,
"type": "boolean"
},
"FullyQualifiedName": {
"description": "",
"example": "Marketing Department",
"type": "string"
},
"Active": {
"description": "",
"example": true,
"type": "boolean"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"Name",
"SubDepartment",
"FullyQualifiedName",
"Active",
"domain",
"sparse",
"Id",
"SyncToken"
]
},
"JournalentryDeleterequest": {
"title": "JournalEntry-DeleteRequest",
"example": {
"Id": "167",
"SyncToken": "0"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "167",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"ClassUpdaterequest": {
"title": "Class-UpdateRequest",
"example": {
"Name": "France-I",
"SubClass": false,
"FullyQualifiedName": "France",
"Active": true,
"domain": "QBO",
"sparse": false,
"Id": "5000000000000018727",
"SyncToken": "0"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "France-I",
"type": "string"
},
"SubClass": {
"description": "",
"example": false,
"type": "boolean"
},
"FullyQualifiedName": {
"description": "",
"example": "France",
"type": "string"
},
"Active": {
"description": "",
"example": true,
"type": "boolean"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "5000000000000018727",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"Name",
"SubClass",
"FullyQualifiedName",
"Active",
"domain",
"sparse",
"Id",
"SyncToken"
]
},
"TimeactivityUpdaterequest": {
"title": "TimeActivity-UpdateRequest",
"example": {
"TxnDate": "2016-09-03",
"NameOf": "Employee",
"EmployeeRef": {
"value": "55",
"name": "Emily Platt"
},
"ItemRef": {
"value": "2",
"name": "Hours"
},
"BillableStatus": "NotBillable",
"Taxable": false,
"HourlyRate": 0,
"StartTime": "2016-09-02T16:00:00+00:00",
"EndTime": "2016-09-03T01:00:00+00:00",
"domain": "QBO",
"sparse": false,
"Id": "6",
"SyncToken": "0"
},
"type": "object",
"properties": {
"TxnDate": {
"description": "",
"example": "2016-09-03",
"type": "string"
},
"NameOf": {
"description": "",
"example": "Employee",
"type": "string"
},
"EmployeeRef": {
"$ref": "#/definitions/EmployeeRef"
},
"ItemRef": {
"$ref": "#/definitions/ItemRef"
},
"BillableStatus": {
"description": "",
"example": "NotBillable",
"type": "string"
},
"Taxable": {
"description": "",
"example": false,
"type": "boolean"
},
"HourlyRate": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"StartTime": {
"description": "",
"example": "9/2/2016 4:00:00 PM",
"type": "string"
},
"EndTime": {
"description": "",
"example": "9/3/2016 1:00:00 AM",
"type": "string"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "6",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"TxnDate",
"NameOf",
"EmployeeRef",
"ItemRef",
"BillableStatus",
"Taxable",
"HourlyRate",
"StartTime",
"EndTime",
"domain",
"sparse",
"Id",
"SyncToken"
]
},
"AttachableDeleterequest": {
"title": "Attachable-DeleteRequest",
"example": {
"Note": "This is an attached note. Updated1",
"domain": "QBO",
"sparse": false,
"Id": "5000000000000029383",
"SyncToken": "2",
"MetaData": {
"CreateTime": "2016-08-18T07:18:04+00:00",
"LastUpdatedTime": "2016-08-18T07:18:04+00:00"
},
"AttachableRef": [
{
"EntityRef": {
"value": "130",
"type": "Invoice"
},
"IncludeOnSend": false
}
]
},
"type": "object",
"properties": {
"Note": {
"description": "",
"example": "This is an attached note. Updated1",
"type": "string"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "5000000000000029383",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "2",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
},
"AttachableRef": {
"description": "",
"example": [
{
"EntityRef": {
"value": "130",
"type": "Invoice"
},
"IncludeOnSend": false
}
],
"type": "array",
"items": {
"$ref": "#/definitions/AttachableRef"
}
}
},
"required": [
"Note",
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData",
"AttachableRef"
]
},
"AttachableRef": {
"title": "AttachableRef",
"example": {
"EntityRef": {
"value": "130",
"type": "Invoice"
},
"IncludeOnSend": false
},
"type": "object",
"properties": {
"EntityRef": {
"$ref": "#/definitions/EntityRef"
},
"IncludeOnSend": {
"description": "",
"example": false,
"type": "boolean"
}
},
"required": [
"EntityRef",
"IncludeOnSend"
]
},
"EntityRef": {
"title": "EntityRef",
"example": {
"value": "130",
"type": "Invoice"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "130",
"type": "string"
},
"type": {
"description": "",
"example": "Invoice",
"type": "string"
}
},
"required": [
"value",
"type"
]
},
"ClassCreaterequest": {
"title": "Class-CreateRequest",
"example": {
"Name": "France"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "France",
"type": "string"
}
},
"required": [
"Name"
]
},
"InvoiceVoidrequest": {
"title": "Invoice-VoidRequest",
"example": {
"Id": "173",
"SyncToken": "2"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "173",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "2",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"PurchaseDeleterequest": {
"title": "Purchase-DeleteRequest",
"example": {
"Id": "175",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "175",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"VendorcreditUpdaterequest": {
"title": "VendorCredit-UpdateRequest",
"example": {
"domain": "QBO",
"sparse": false,
"Id": "185",
"SyncToken": "0",
"MetaData": {
"CreateTime": "2016-09-02T10:09:34+00:00",
"LastUpdatedTime": "2016-09-02T10:09:34+00:00"
},
"TxnDate": "2014-04-23",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1,
"Line": [
{
"Id": "1",
"Amount": 90,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"CustomerRef": {
"value": "1",
"name": "Amy's Bird Sanctuary"
},
"AccountRef": {
"value": "8",
"name": "Bank Charges"
},
"BillableStatus": "Billable",
"TaxCodeRef": {
"value": "TAX"
}
}
}
],
"VendorRef": {
"value": "30",
"name": "Books by Bessie"
},
"APAccountRef": {
"value": "33",
"name": "Accounts Payable (A/P)"
},
"TotalAmt": 90
},
"type": "object",
"properties": {
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "185",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
},
"TxnDate": {
"description": "",
"example": "2014-04-23",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Line": {
"description": "",
"example": [
{
"Id": "1",
"Amount": 90,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"CustomerRef": {
"value": "1",
"name": "Amy's Bird Sanctuary"
},
"AccountRef": {
"value": "8",
"name": "Bank Charges"
},
"BillableStatus": "Billable",
"TaxCodeRef": {
"value": "TAX"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line165"
}
},
"VendorRef": {
"$ref": "#/definitions/VendorRef170"
},
"APAccountRef": {
"$ref": "#/definitions/APAccountRef"
},
"TotalAmt": {
"description": "",
"example": 90,
"type": "integer",
"format": "int32"
}
},
"required": [
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"Line",
"VendorRef",
"APAccountRef",
"TotalAmt"
]
},
"Line165": {
"title": "Line165",
"example": {
"Id": "1",
"Amount": 90,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"CustomerRef": {
"value": "1",
"name": "Amy's Bird Sanctuary"
},
"AccountRef": {
"value": "8",
"name": "Bank Charges"
},
"BillableStatus": "Billable",
"TaxCodeRef": {
"value": "TAX"
}
}
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"Amount": {
"description": "",
"example": 90,
"type": "integer",
"format": "int32"
},
"DetailType": {
"description": "",
"example": "AccountBasedExpenseLineDetail",
"type": "string"
},
"AccountBasedExpenseLineDetail": {
"$ref": "#/definitions/AccountBasedExpenseLineDetail166"
}
},
"required": [
"Id",
"Amount",
"DetailType",
"AccountBasedExpenseLineDetail"
]
},
"AccountBasedExpenseLineDetail166": {
"title": "AccountBasedExpenseLineDetail166",
"example": {
"CustomerRef": {
"value": "1",
"name": "Amy's Bird Sanctuary"
},
"AccountRef": {
"value": "8",
"name": "Bank Charges"
},
"BillableStatus": "Billable",
"TaxCodeRef": {
"value": "TAX"
}
},
"type": "object",
"properties": {
"CustomerRef": {
"$ref": "#/definitions/CustomerRef"
},
"AccountRef": {
"$ref": "#/definitions/AccountRef"
},
"BillableStatus": {
"description": "",
"example": "Billable",
"type": "string"
},
"TaxCodeRef": {
"$ref": "#/definitions/TaxCodeRef"
}
},
"required": [
"CustomerRef",
"AccountRef",
"BillableStatus",
"TaxCodeRef"
]
},
"VendorRef170": {
"title": "VendorRef170",
"example": {
"value": "30",
"name": "Books by Bessie"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "30",
"type": "string"
},
"name": {
"description": "",
"example": "Books by Bessie",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"APAccountRef": {
"title": "APAccountRef",
"example": {
"value": "33",
"name": "Accounts Payable (A/P)"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "33",
"type": "string"
},
"name": {
"description": "",
"example": "Accounts Payable (A/P)",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"DepartmentCreaterequest": {
"title": "Department-CreateRequest",
"example": {
"Name": "Marketing Department"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Marketing Department",
"type": "string"
}
},
"required": [
"Name"
]
},
"InvoiceDeleterequest": {
"title": "Invoice-DeleteRequest",
"example": {
"Id": "130",
"SyncToken": "10"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "130",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "10",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"JournalentryCreaterequest": {
"title": "JournalEntry-CreateRequest",
"example": {
"Line": [
{
"Id": "0",
"Description": "nov portion of rider insurance",
"Amount": 100.0,
"DetailType": "JournalEntryLineDetail",
"JournalEntryLineDetail": {
"PostingType": "Debit",
"AccountRef": {
"value": "39",
"name": "Opening Bal Equity"
}
}
},
{
"Description": "nov portion of rider insurance",
"Amount": 100.0,
"DetailType": "JournalEntryLineDetail",
"JournalEntryLineDetail": {
"PostingType": "Credit",
"AccountRef": {
"value": "44",
"name": "Notes Payable"
}
}
}
]
},
"type": "object",
"properties": {
"Line": {
"description": "",
"example": [
{
"Id": "0",
"Description": "nov portion of rider insurance",
"Amount": 100.0,
"DetailType": "JournalEntryLineDetail",
"JournalEntryLineDetail": {
"PostingType": "Debit",
"AccountRef": {
"value": "39",
"name": "Opening Bal Equity"
}
}
},
{
"Description": "nov portion of rider insurance",
"Amount": 100.0,
"DetailType": "JournalEntryLineDetail",
"JournalEntryLineDetail": {
"PostingType": "Credit",
"AccountRef": {
"value": "44",
"name": "Notes Payable"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line175"
}
}
},
"required": [
"Line"
]
},
"Line175": {
"title": "Line175",
"example": {
"Id": "0",
"Description": "nov portion of rider insurance",
"Amount": 100.0,
"DetailType": "JournalEntryLineDetail",
"JournalEntryLineDetail": {
"PostingType": "Debit",
"AccountRef": {
"value": "39",
"name": "Opening Bal Equity"
}
}
},
"type": "object",
"properties": {
"Description": {
"description": "",
"example": "nov portion of rider insurance",
"type": "string"
},
"Amount": {
"description": "",
"example": 100,
"type": "number",
"format": "double"
},
"DetailType": {
"description": "",
"example": "JournalEntryLineDetail",
"type": "string"
},
"JournalEntryLineDetail": {
"$ref": "#/definitions/JournalEntryLineDetail"
},
"Id": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"Description",
"Amount",
"DetailType",
"JournalEntryLineDetail"
]
},
"BatchRequest": {
"title": "BatchRequest",
"example": {
"BatchItemRequest": [
{
"bId": "bid1",
"operation": "create",
"Vendor": {
"DisplayName": "Smith Family Store"
}
},
{
"bId": "bid2",
"operation": "delete",
"Invoice": {
"Id": "129",
"SyncToken": "0"
}
},
{
"bId": "bid3",
"operation": "update",
"SalesReceipt": {
"domain": "QBO",
"sparse": true,
"Id": "11",
"SyncToken": "0",
"PrivateNote": "A private note."
}
},
{
"bId": "bid4",
"Query": "select * from SalesReceipt"
}
]
},
"type": "object",
"properties": {
"BatchItemRequest": {
"description": "",
"example": [
{
"bId": "bid1",
"operation": "create",
"Vendor": {
"DisplayName": "Smith Family Store"
}
},
{
"bId": "bid2",
"operation": "delete",
"Invoice": {
"Id": "129",
"SyncToken": "0"
}
},
{
"bId": "bid3",
"operation": "update",
"SalesReceipt": {
"domain": "QBO",
"sparse": true,
"Id": "11",
"SyncToken": "0",
"PrivateNote": "A private note."
}
},
{
"bId": "bid4",
"Query": "select * from SalesReceipt"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/BatchItemRequest"
}
}
},
"required": [
"BatchItemRequest"
]
},
"BatchItemRequest": {
"title": "BatchItemRequest",
"example": {
"bId": "bid1",
"operation": "create",
"Vendor": {
"DisplayName": "Smith Family Store"
}
},
"type": "object",
"properties": {
"bId": {
"description": "",
"example": "bid1",
"type": "string"
},
"operation": {
"description": "",
"example": "create",
"type": "string"
},
"Vendor": {
"$ref": "#/definitions/Vendor"
},
"Invoice": {
"$ref": "#/definitions/Invoice"
},
"SalesReceipt": {
"$ref": "#/definitions/SalesReceipt"
},
"Query": {
"description": "",
"example": "select * from SalesReceipt",
"type": "string"
}
},
"required": [
"bId"
]
},
"Vendor": {
"title": "Vendor",
"example": {
"DisplayName": "Smith Family Store"
},
"type": "object",
"properties": {
"DisplayName": {
"description": "",
"example": "Smith Family Store",
"type": "string"
}
},
"required": [
"DisplayName"
]
},
"Invoice": {
"title": "Invoice",
"example": {
"Id": "129",
"SyncToken": "0"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "129",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"SalesReceipt": {
"title": "SalesReceipt",
"example": {
"domain": "QBO",
"sparse": true,
"Id": "11",
"SyncToken": "0",
"PrivateNote": "A private note."
},
"type": "object",
"properties": {
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": true,
"type": "boolean"
},
"Id": {
"description": "",
"example": "11",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"PrivateNote": {
"description": "",
"example": "A private note.",
"type": "string"
}
},
"required": [
"domain",
"sparse",
"Id",
"SyncToken",
"PrivateNote"
]
},
"EmployeeCreaterequest": {
"title": "Employee-CreateRequest",
"example": {
"SSN": "444-55-6666",
"PrimaryAddr": {
"Id": "50",
"Line1": "45 N. Elm Street",
"City": "Middlefield",
"CountrySubDivisionCode": "CA",
"PostalCode": "93242"
},
"GivenName": "John",
"FamilyName": "Meuller",
"PrimaryPhone": {
"FreeFormNumber": "408-525-1234"
}
},
"type": "object",
"properties": {
"SSN": {
"description": "",
"example": "444-55-6666",
"type": "string"
},
"PrimaryAddr": {
"$ref": "#/definitions/PrimaryAddr"
},
"GivenName": {
"description": "",
"example": "John",
"type": "string"
},
"FamilyName": {
"description": "",
"example": "Meuller",
"type": "string"
},
"PrimaryPhone": {
"$ref": "#/definitions/PrimaryPhone"
}
},
"required": [
"SSN",
"PrimaryAddr",
"GivenName",
"FamilyName",
"PrimaryPhone"
]
},
"AttachableUpdaterequest": {
"title": "Attachable-UpdateRequest",
"example": {
"Note": "This is an attached note. Updated",
"domain": "QBO",
"sparse": false,
"Id": "5000000000000029383",
"SyncToken": "0",
"MetaData": {
"CreateTime": "2016-08-18T07:18:04+00:00",
"LastUpdatedTime": "2016-08-18T07:18:04+00:00"
},
"AttachableRef": [
{
"EntityRef": {
"value": "130",
"type": "Invoice"
},
"IncludeOnSend": false
}
]
},
"type": "object",
"properties": {
"Note": {
"description": "",
"example": "This is an attached note. Updated",
"type": "string"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "5000000000000029383",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
},
"AttachableRef": {
"description": "",
"example": [
{
"EntityRef": {
"value": "130",
"type": "Invoice"
},
"IncludeOnSend": false
}
],
"type": "array",
"items": {
"$ref": "#/definitions/AttachableRef"
}
}
},
"required": [
"Note",
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData",
"AttachableRef"
]
},
"VendorDeleterequest": {
"title": "Vendor-DeleteRequest",
"example": {
"BillAddr": {
"Id": "111",
"Line1": "Dianne's Auto Shop",
"Line2": "Dianne Bradley",
"Line3": "29834 Mustang Ave.",
"City": "Millbrae",
"Country": "U.S.A",
"CountrySubDivisionCode": "CA",
"PostalCode": "94030"
},
"TaxIdentifier": "XXXXXX8293",
"Balance": 0,
"AcctNum": "35372649",
"Vendor1099": false,
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"domain": "QBO",
"sparse": false,
"Id": "70",
"SyncToken": "0",
"Title": "Ms.",
"GivenName": "Dianne",
"FamilyName": "Bradley",
"Suffix": "Sr.",
"CompanyName": "Dianne's Auto Shop",
"DisplayName": "Dianne's Auto Shop-Updated",
"PrintOnCheckName": "Dianne's Auto Shop",
"Active": false,
"PrimaryPhone": {
"FreeFormNumber": "(650) 555-2342"
},
"Mobile": {
"FreeFormNumber": "(650) 555-2000"
},
"PrimaryEmailAddr": {
"Address": "dbradley@myemail.com"
},
"WebAddr": {
"URI": "http://DiannesAutoShop.com"
}
},
"type": "object",
"properties": {
"BillAddr": {
"$ref": "#/definitions/BillAddr191"
},
"TaxIdentifier": {
"description": "",
"example": "XXXXXX8293",
"type": "string"
},
"Balance": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"AcctNum": {
"description": "",
"example": "35372649",
"type": "string"
},
"Vendor1099": {
"description": "",
"example": false,
"type": "boolean"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "70",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"Title": {
"description": "",
"example": "Ms.",
"type": "string"
},
"GivenName": {
"description": "",
"example": "Dianne",
"type": "string"
},
"FamilyName": {
"description": "",
"example": "Bradley",
"type": "string"
},
"Suffix": {
"description": "",
"example": "Sr.",
"type": "string"
},
"CompanyName": {
"description": "",
"example": "Dianne's Auto Shop",
"type": "string"
},
"DisplayName": {
"description": "",
"example": "Dianne's Auto Shop-Updated",
"type": "string"
},
"PrintOnCheckName": {
"description": "",
"example": "Dianne's Auto Shop",
"type": "string"
},
"Active": {
"description": "",
"example": false,
"type": "boolean"
},
"PrimaryPhone": {
"$ref": "#/definitions/PrimaryPhone"
},
"Mobile": {
"$ref": "#/definitions/Mobile"
},
"PrimaryEmailAddr": {
"$ref": "#/definitions/PrimaryEmailAddr"
},
"WebAddr": {
"$ref": "#/definitions/WebAddr"
}
},
"required": [
"BillAddr",
"TaxIdentifier",
"Balance",
"AcctNum",
"Vendor1099",
"CurrencyRef",
"domain",
"sparse",
"Id",
"SyncToken",
"Title",
"GivenName",
"FamilyName",
"Suffix",
"CompanyName",
"DisplayName",
"PrintOnCheckName",
"Active",
"PrimaryPhone",
"Mobile",
"PrimaryEmailAddr",
"WebAddr"
]
},
"BillAddr191": {
"title": "BillAddr191",
"example": {
"Id": "111",
"Line1": "Dianne's Auto Shop",
"Line2": "Dianne Bradley",
"Line3": "29834 Mustang Ave.",
"City": "Millbrae",
"Country": "U.S.A",
"CountrySubDivisionCode": "CA",
"PostalCode": "94030"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "111",
"type": "string"
},
"Line1": {
"description": "",
"example": "Dianne's Auto Shop",
"type": "string"
},
"Line2": {
"description": "",
"example": "Dianne Bradley",
"type": "string"
},
"Line3": {
"description": "",
"example": "29834 Mustang Ave.",
"type": "string"
},
"City": {
"description": "",
"example": "Millbrae",
"type": "string"
},
"Country": {
"description": "",
"example": "U.S.A",
"type": "string"
},
"CountrySubDivisionCode": {
"description": "",
"example": "CA",
"type": "string"
},
"PostalCode": {
"description": "",
"example": "94030",
"type": "string"
}
},
"required": [
"Id",
"Line1",
"Line2",
"Line3",
"City",
"Country",
"CountrySubDivisionCode",
"PostalCode"
]
},
"DepositDeleterequest": {
"title": "Deposit-DeleteRequest",
"example": {
"Id": "162",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "162",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"RefundreceiptDeleterequest": {
"title": "RefundReceipt-DeleteRequest",
"example": {
"Id": "180",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "180",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"VendorUpdaterequest": {
"title": "Vendor-UpdateRequest",
"example": {
"BillAddr": {
"Id": "111",
"Line1": "Dianne's Auto Shop",
"Line2": "Dianne Bradley",
"Line3": "29834 Mustang Ave.",
"City": "Millbrae",
"Country": "U.S.A",
"CountrySubDivisionCode": "CA",
"PostalCode": "94030"
},
"TaxIdentifier": "XXXXXX8293",
"Balance": 0,
"AcctNum": "35372649",
"Vendor1099": false,
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"domain": "QBO",
"sparse": false,
"Id": "70",
"SyncToken": "0",
"Title": "Ms.",
"GivenName": "Dianne",
"FamilyName": "Bradley",
"Suffix": "Sr.",
"CompanyName": "Dianne's Auto Shop",
"DisplayName": "Dianne's Auto Shop-Updated",
"PrintOnCheckName": "Dianne's Auto Shop",
"Active": true,
"PrimaryPhone": {
"FreeFormNumber": "(650) 555-2342"
},
"Mobile": {
"FreeFormNumber": "(650) 555-2000"
},
"PrimaryEmailAddr": {
"Address": "dbradley@myemail.com"
},
"WebAddr": {
"URI": "http://DiannesAutoShop.com"
}
},
"type": "object",
"properties": {
"BillAddr": {
"$ref": "#/definitions/BillAddr191"
},
"TaxIdentifier": {
"description": "",
"example": "XXXXXX8293",
"type": "string"
},
"Balance": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"AcctNum": {
"description": "",
"example": "35372649",
"type": "string"
},
"Vendor1099": {
"description": "",
"example": false,
"type": "boolean"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "70",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"Title": {
"description": "",
"example": "Ms.",
"type": "string"
},
"GivenName": {
"description": "",
"example": "Dianne",
"type": "string"
},
"FamilyName": {
"description": "",
"example": "Bradley",
"type": "string"
},
"Suffix": {
"description": "",
"example": "Sr.",
"type": "string"
},
"CompanyName": {
"description": "",
"example": "Dianne's Auto Shop",
"type": "string"
},
"DisplayName": {
"description": "",
"example": "Dianne's Auto Shop-Updated",
"type": "string"
},
"PrintOnCheckName": {
"description": "",
"example": "Dianne's Auto Shop",
"type": "string"
},
"Active": {
"description": "",
"example": true,
"type": "boolean"
},
"PrimaryPhone": {
"$ref": "#/definitions/PrimaryPhone"
},
"Mobile": {
"$ref": "#/definitions/Mobile"
},
"PrimaryEmailAddr": {
"$ref": "#/definitions/PrimaryEmailAddr"
},
"WebAddr": {
"$ref": "#/definitions/WebAddr"
}
},
"required": [
"BillAddr",
"TaxIdentifier",
"Balance",
"AcctNum",
"Vendor1099",
"CurrencyRef",
"domain",
"sparse",
"Id",
"SyncToken",
"Title",
"GivenName",
"FamilyName",
"Suffix",
"CompanyName",
"DisplayName",
"PrintOnCheckName",
"Active",
"PrimaryPhone",
"Mobile",
"PrimaryEmailAddr",
"WebAddr"
]
},
"AccountCreaterequest": {
"title": "Account-CreateRequest",
"example": {
"AccountType": "Accounts Receivable",
"Name": "AR4"
},
"type": "object",
"properties": {
"AccountType": {
"description": "",
"example": "Accounts Receivable",
"type": "string"
},
"Name": {
"description": "",
"example": "AR4",
"type": "string"
}
},
"required": [
"AccountType",
"Name"
]
},
"PaymentmethodDeleterequest": {
"title": "PaymentMethod-DeleteRequest",
"example": {
"Name": "Business Check-Updated",
"Active": false,
"Type": "NON_CREDIT_CARD",
"domain": "QBO",
"sparse": false,
"Id": "8",
"SyncToken": "0",
"MetaData": {
"CreateTime": "2016-08-24T03:09:50+00:00",
"LastUpdatedTime": "2016-08-24T03:09:50+00:00"
}
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Business Check-Updated",
"type": "string"
},
"Active": {
"description": "",
"example": false,
"type": "boolean"
},
"Type": {
"description": "",
"example": "NON_CREDIT_CARD",
"type": "string"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "8",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Name",
"Active",
"Type",
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData"
]
},
"InvoiceCreaterequest": {
"title": "Invoice-CreateRequest",
"example": {
"Line": [
{
"Amount": 100.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "1",
"name": "Services"
}
}
}
],
"CustomerRef": {
"value": "1"
}
},
"type": "object",
"properties": {
"Line": {
"description": "",
"example": [
{
"Amount": 100.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "1",
"name": "Services"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line210"
}
},
"CustomerRef": {
"$ref": "#/definitions/CustomerRef213"
}
},
"required": [
"Line",
"CustomerRef"
]
},
"Line210": {
"title": "Line210",
"example": {
"Amount": 100.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "1",
"name": "Services"
}
}
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 100,
"type": "number",
"format": "double"
},
"DetailType": {
"description": "",
"example": "SalesItemLineDetail",
"type": "string"
},
"SalesItemLineDetail": {
"$ref": "#/definitions/SalesItemLineDetail83"
}
},
"required": [
"Amount",
"DetailType",
"SalesItemLineDetail"
]
},
"CustomerRef213": {
"title": "CustomerRef213",
"example": {
"value": "1"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"value"
]
},
"TimeactivityDeleterequest": {
"title": "TimeActivity-DeleteRequest",
"example": {
"Id": "6",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "6",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"RefundreceiptUpdaterequest": {
"title": "RefundReceipt-UpdateRequest",
"example": {
"domain": "QBO",
"sparse": false,
"Id": "180",
"SyncToken": "0",
"MetaData": {
"CreateTime": "2016-08-24T06:38:22+00:00",
"LastUpdatedTime": "2016-08-24T06:38:22+00:00"
},
"CustomField": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
}
],
"DocNumber": "1044-Updated",
"TxnDate": "2016-08-23",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1,
"Line": [
{
"Id": "1",
"LineNum": 1,
"Amount": 420,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "2",
"name": "Hours"
},
"TaxCodeRef": {
"value": "NON"
}
}
},
{
"Amount": 420,
"DetailType": "SubTotalLineDetail",
"SubTotalLineDetail": {}
}
],
"TxnTaxDetail": {
"TotalTax": 0
},
"TotalAmt": 420,
"HomeTotalAmt": 420,
"ApplyTaxAfterDiscount": false,
"PrintStatus": "NeedToPrint",
"Balance": 0,
"PaymentRefNum": "To Print",
"DepositToAccountRef": {
"value": "35",
"name": "Checking"
}
},
"type": "object",
"properties": {
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "180",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
},
"CustomField": {
"description": "",
"example": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/CustomField"
}
},
"DocNumber": {
"description": "",
"example": "1044-Updated",
"type": "string"
},
"TxnDate": {
"description": "",
"example": "2016-08-23",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Line": {
"description": "",
"example": [
{
"Id": "1",
"LineNum": 1,
"Amount": 420,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "2",
"name": "Hours"
},
"TaxCodeRef": {
"value": "NON"
}
}
},
{
"Amount": 420,
"DetailType": "SubTotalLineDetail",
"SubTotalLineDetail": {}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line"
}
},
"TxnTaxDetail": {
"$ref": "#/definitions/TxnTaxDetail"
},
"TotalAmt": {
"description": "",
"example": 420,
"type": "integer",
"format": "int32"
},
"HomeTotalAmt": {
"description": "",
"example": 420,
"type": "integer",
"format": "int32"
},
"ApplyTaxAfterDiscount": {
"description": "",
"example": false,
"type": "boolean"
},
"PrintStatus": {
"description": "",
"example": "NeedToPrint",
"type": "string"
},
"Balance": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"PaymentRefNum": {
"description": "",
"example": "To Print",
"type": "string"
},
"DepositToAccountRef": {
"$ref": "#/definitions/DepositToAccountRef"
}
},
"required": [
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData",
"CustomField",
"DocNumber",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"Line",
"TxnTaxDetail",
"TotalAmt",
"HomeTotalAmt",
"ApplyTaxAfterDiscount",
"PrintStatus",
"Balance",
"PaymentRefNum",
"DepositToAccountRef"
]
},
"PaymentmethodUpdaterequest": {
"title": "PaymentMethod-UpdateRequest",
"example": {
"Name": "Business Check-Updated",
"Active": true,
"Type": "NON_CREDIT_CARD",
"domain": "QBO",
"sparse": false,
"Id": "8",
"SyncToken": "0",
"MetaData": {
"CreateTime": "2016-08-24T03:09:50+00:00",
"LastUpdatedTime": "2016-08-24T03:09:50+00:00"
}
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Business Check-Updated",
"type": "string"
},
"Active": {
"description": "",
"example": true,
"type": "boolean"
},
"Type": {
"description": "",
"example": "NON_CREDIT_CARD",
"type": "string"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "8",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
}
},
"required": [
"Name",
"Active",
"Type",
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData"
]
},
"BillpaymentCreaterequest": {
"title": "BillPayment-CreateRequest",
"example": {
"VendorRef": {
"value": "62",
"name": "Test"
},
"PayType": "Check",
"CheckPayment": {
"BankAccountRef": {
"value": "35",
"name": "Checking"
}
},
"TotalAmt": 100.0,
"PrivateNote": "Acct. 1JK90",
"Line": [
{
"Amount": 100.0,
"LinkedTxn": [
{
"TxnId": "153",
"TxnType": "Bill"
}
]
}
]
},
"type": "object",
"properties": {
"VendorRef": {
"$ref": "#/definitions/VendorRef170"
},
"PayType": {
"description": "",
"example": "Check",
"type": "string"
},
"CheckPayment": {
"$ref": "#/definitions/CheckPayment"
},
"TotalAmt": {
"description": "",
"example": 100,
"type": "number",
"format": "double"
},
"PrivateNote": {
"description": "",
"example": "Acct. 1JK90",
"type": "string"
},
"Line": {
"description": "",
"example": [
{
"Amount": 100.0,
"LinkedTxn": [
{
"TxnId": "153",
"TxnType": "Bill"
}
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line231"
}
}
},
"required": [
"VendorRef",
"PayType",
"CheckPayment",
"TotalAmt",
"PrivateNote",
"Line"
]
},
"CheckPayment": {
"title": "CheckPayment",
"example": {
"BankAccountRef": {
"value": "35",
"name": "Checking"
}
},
"type": "object",
"properties": {
"BankAccountRef": {
"$ref": "#/definitions/BankAccountRef"
}
},
"required": [
"BankAccountRef"
]
},
"BankAccountRef": {
"title": "BankAccountRef",
"example": {
"value": "35",
"name": "Checking"
},
"type": "object",
"properties": {
"value": {
"description": "",
"example": "35",
"type": "string"
},
"name": {
"description": "",
"example": "Checking",
"type": "string"
}
},
"required": [
"value",
"name"
]
},
"Line231": {
"title": "Line231",
"example": {
"Amount": 100.0,
"LinkedTxn": [
{
"TxnId": "153",
"TxnType": "Bill"
}
]
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 100,
"type": "number",
"format": "double"
},
"LinkedTxn": {
"description": "",
"example": [
{
"TxnId": "153",
"TxnType": "Bill"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/LinkedTxn"
}
}
},
"required": [
"Amount",
"LinkedTxn"
]
},
"PurchaseorderUpdaterequest": {
"title": "PurchaseOrder-UpdateRequest",
"example": {
"domain": "QBO",
"sparse": false,
"Id": "179",
"SyncToken": "0",
"MetaData": {
"CreateTime": "2016-08-24T06:18:26+00:00",
"LastUpdatedTime": "2016-08-24T06:18:26+00:00"
},
"CustomField": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
},
{
"DefinitionId": "2",
"Name": "Sales Rep",
"Type": "StringType"
}
],
"DocNumber": "1006-Updated",
"TxnDate": "2016-08-23",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1,
"Line": [
{
"Id": "1",
"Amount": 25,
"DetailType": "ItemBasedExpenseLineDetail",
"ItemBasedExpenseLineDetail": {
"CustomerRef": {
"value": "3",
"name": "Cool Cars"
},
"BillableStatus": "NotBillable",
"ItemRef": {
"value": "11",
"name": "Pump"
},
"UnitPrice": 25,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
}
],
"VendorRef": {
"value": "41",
"name": "Hicks Hardware"
},
"APAccountRef": {
"value": "33",
"name": "Accounts Payable (A/P)"
},
"TotalAmt": 25
},
"type": "object",
"properties": {
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "179",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
},
"CustomField": {
"description": "",
"example": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
},
{
"DefinitionId": "2",
"Name": "Sales Rep",
"Type": "StringType"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/CustomField"
}
},
"DocNumber": {
"description": "",
"example": "1006-Updated",
"type": "string"
},
"TxnDate": {
"description": "",
"example": "2016-08-23",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Line": {
"description": "",
"example": [
{
"Id": "1",
"Amount": 25,
"DetailType": "ItemBasedExpenseLineDetail",
"ItemBasedExpenseLineDetail": {
"CustomerRef": {
"value": "3",
"name": "Cool Cars"
},
"BillableStatus": "NotBillable",
"ItemRef": {
"value": "11",
"name": "Pump"
},
"UnitPrice": 25,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line237"
}
},
"VendorRef": {
"$ref": "#/definitions/VendorRef170"
},
"APAccountRef": {
"$ref": "#/definitions/APAccountRef"
},
"TotalAmt": {
"description": "",
"example": 25,
"type": "integer",
"format": "int32"
}
},
"required": [
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData",
"CustomField",
"DocNumber",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"Line",
"VendorRef",
"APAccountRef",
"TotalAmt"
]
},
"Line237": {
"title": "Line237",
"example": {
"Id": "1",
"Amount": 25,
"DetailType": "ItemBasedExpenseLineDetail",
"ItemBasedExpenseLineDetail": {
"CustomerRef": {
"value": "3",
"name": "Cool Cars"
},
"BillableStatus": "NotBillable",
"ItemRef": {
"value": "11",
"name": "Pump"
},
"UnitPrice": 25,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"Amount": {
"description": "",
"example": 25,
"type": "integer",
"format": "int32"
},
"DetailType": {
"description": "",
"example": "ItemBasedExpenseLineDetail",
"type": "string"
},
"ItemBasedExpenseLineDetail": {
"$ref": "#/definitions/ItemBasedExpenseLineDetail"
}
},
"required": [
"Id",
"Amount",
"DetailType",
"ItemBasedExpenseLineDetail"
]
},
"ItemBasedExpenseLineDetail": {
"title": "ItemBasedExpenseLineDetail",
"example": {
"CustomerRef": {
"value": "3",
"name": "Cool Cars"
},
"BillableStatus": "NotBillable",
"ItemRef": {
"value": "11",
"name": "Pump"
},
"UnitPrice": 25,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
},
"type": "object",
"properties": {
"CustomerRef": {
"$ref": "#/definitions/CustomerRef"
},
"BillableStatus": {
"description": "",
"example": "NotBillable",
"type": "string"
},
"ItemRef": {
"$ref": "#/definitions/ItemRef"
},
"UnitPrice": {
"description": "",
"example": 25,
"type": "integer",
"format": "int32"
},
"Qty": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"TaxCodeRef": {
"$ref": "#/definitions/TaxCodeRef"
}
},
"required": [
"CustomerRef",
"BillableStatus",
"ItemRef",
"UnitPrice",
"Qty",
"TaxCodeRef"
]
},
"BillpaymentDeleterequest": {
"title": "BillPayment-DeleteRequest",
"example": {
"Id": "154",
"SyncToken": "0"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "154",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"CustomerCreaterequest": {
"title": "Customer-CreateRequest",
"example": {
"BillAddr": {
"Line1": "123 Main Street",
"City": "Mountain View",
"Country": "USA",
"CountrySubDivisionCode": "CA",
"PostalCode": "94042"
},
"Notes": "Here are other details.",
"DisplayName": "King's Groceries1",
"PrimaryPhone": {
"FreeFormNumber": "(555) 555-5555"
},
"PrimaryEmailAddr": {
"Address": "jdrew@myemail.com"
}
},
"type": "object",
"properties": {
"BillAddr": {
"$ref": "#/definitions/BillAddr246"
},
"Notes": {
"description": "",
"example": "Here are other details.",
"type": "string"
},
"DisplayName": {
"description": "",
"example": "King's Groceries1",
"type": "string"
},
"PrimaryPhone": {
"$ref": "#/definitions/PrimaryPhone"
},
"PrimaryEmailAddr": {
"$ref": "#/definitions/PrimaryEmailAddr"
}
},
"required": [
"BillAddr",
"Notes",
"DisplayName",
"PrimaryPhone",
"PrimaryEmailAddr"
]
},
"BillAddr246": {
"title": "BillAddr246",
"example": {
"Line1": "123 Main Street",
"City": "Mountain View",
"Country": "USA",
"CountrySubDivisionCode": "CA",
"PostalCode": "94042"
},
"type": "object",
"properties": {
"Line1": {
"description": "",
"example": "123 Main Street",
"type": "string"
},
"City": {
"description": "",
"example": "Mountain View",
"type": "string"
},
"Country": {
"description": "",
"example": "USA",
"type": "string"
},
"CountrySubDivisionCode": {
"description": "",
"example": "CA",
"type": "string"
},
"PostalCode": {
"description": "",
"example": "94042",
"type": "string"
}
},
"required": [
"Line1",
"City",
"Country",
"CountrySubDivisionCode",
"PostalCode"
]
},
"CreditmemoUpdaterequest": {
"title": "CreditMemo-UpdateRequest",
"example": {
"RemainingCredit": 50,
"domain": "QBO",
"sparse": false,
"Id": "160",
"SyncToken": "0",
"MetaData": {
"CreateTime": "2016-08-18T20:09:52+00:00",
"LastUpdatedTime": "2016-08-18T20:09:52+00:00"
},
"CustomField": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
}
],
"DocNumber": "1040-Updated",
"TxnDate": "2016-08-18",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1,
"Line": [
{
"Id": "1",
"LineNum": 1,
"Amount": 50,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "3",
"name": "Concrete"
},
"TaxCodeRef": {
"value": "NON"
}
}
},
{
"Amount": 50,
"DetailType": "SubTotalLineDetail",
"SubTotalLineDetail": {}
}
],
"TxnTaxDetail": {
"TotalTax": 0
},
"CustomerRef": {
"value": "3",
"name": "Cool Cars"
},
"BillAddr": {
"Id": "4",
"Line1": "65 Ocean Dr.",
"City": "Half Moon Bay",
"CountrySubDivisionCode": "CA",
"PostalCode": "94213",
"Lat": "37.4300318",
"Long": "-122.4336537"
},
"ShipAddr": {
"Id": "4",
"Line1": "65 Ocean Dr.",
"City": "Half Moon Bay",
"CountrySubDivisionCode": "CA",
"PostalCode": "94213",
"Lat": "37.4300318",
"Long": "-122.4336537"
},
"TotalAmt": 50,
"HomeTotalAmt": 50,
"ApplyTaxAfterDiscount": false,
"PrintStatus": "NeedToPrint",
"EmailStatus": "NotSet",
"Balance": 50
},
"type": "object",
"properties": {
"RemainingCredit": {
"description": "",
"example": 50,
"type": "integer",
"format": "int32"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "160",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
},
"CustomField": {
"description": "",
"example": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/CustomField"
}
},
"DocNumber": {
"description": "",
"example": "1040-Updated",
"type": "string"
},
"TxnDate": {
"description": "",
"example": "2016-08-18",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Line": {
"description": "",
"example": [
{
"Id": "1",
"LineNum": 1,
"Amount": 50,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "3",
"name": "Concrete"
},
"TaxCodeRef": {
"value": "NON"
}
}
},
{
"Amount": 50,
"DetailType": "SubTotalLineDetail",
"SubTotalLineDetail": {}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line"
}
},
"TxnTaxDetail": {
"$ref": "#/definitions/TxnTaxDetail"
},
"CustomerRef": {
"$ref": "#/definitions/CustomerRef"
},
"BillAddr": {
"$ref": "#/definitions/BillAddr"
},
"ShipAddr": {
"$ref": "#/definitions/ShipAddr"
},
"TotalAmt": {
"description": "",
"example": 50,
"type": "integer",
"format": "int32"
},
"HomeTotalAmt": {
"description": "",
"example": 50,
"type": "integer",
"format": "int32"
},
"ApplyTaxAfterDiscount": {
"description": "",
"example": false,
"type": "boolean"
},
"PrintStatus": {
"description": "",
"example": "NeedToPrint",
"type": "string"
},
"EmailStatus": {
"description": "",
"example": "NotSet",
"type": "string"
},
"Balance": {
"description": "",
"example": 50,
"type": "integer",
"format": "int32"
}
},
"required": [
"RemainingCredit",
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData",
"CustomField",
"DocNumber",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"Line",
"TxnTaxDetail",
"CustomerRef",
"BillAddr",
"ShipAddr",
"TotalAmt",
"HomeTotalAmt",
"ApplyTaxAfterDiscount",
"PrintStatus",
"EmailStatus",
"Balance"
]
},
"TimeactivityCreaterequest": {
"title": "TimeActivity-CreateRequest",
"example": {
"NameOf": "Employee",
"EmployeeRef": {
"value": "55",
"name": "Emily Platt"
},
"StartTime": "2015-07-05T16:00:00+00:00",
"EndTime": "2013-07-06T01:00:00+00:00"
},
"type": "object",
"properties": {
"NameOf": {
"description": "",
"example": "Employee",
"type": "string"
},
"EmployeeRef": {
"$ref": "#/definitions/EmployeeRef"
},
"StartTime": {
"description": "",
"example": "7/5/2015 4:00:00 PM",
"type": "string"
},
"EndTime": {
"description": "",
"example": "7/6/2013 1:00:00 AM",
"type": "string"
}
},
"required": [
"NameOf",
"EmployeeRef",
"StartTime",
"EndTime"
]
},
"PurchaseorderCreaterequest": {
"title": "PurchaseOrder-CreateRequest",
"example": {
"Line": [
{
"Amount": 25.0,
"DetailType": "ItemBasedExpenseLineDetail",
"ItemBasedExpenseLineDetail": {
"CustomerRef": {
"value": "3",
"name": "Cool Cars"
},
"BillableStatus": "NotBillable",
"ItemRef": {
"value": "11",
"name": "Pump"
},
"UnitPrice": 25,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
}
],
"VendorRef": {
"value": "41",
"name": "Hicks Hardware"
},
"APAccountRef": {
"value": "33",
"name": "Accounts Payable (A/P)"
},
"TotalAmt": 25.0
},
"type": "object",
"properties": {
"Line": {
"description": "",
"example": [
{
"Amount": 25.0,
"DetailType": "ItemBasedExpenseLineDetail",
"ItemBasedExpenseLineDetail": {
"CustomerRef": {
"value": "3",
"name": "Cool Cars"
},
"BillableStatus": "NotBillable",
"ItemRef": {
"value": "11",
"name": "Pump"
},
"UnitPrice": 25,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line264"
}
},
"VendorRef": {
"$ref": "#/definitions/VendorRef170"
},
"APAccountRef": {
"$ref": "#/definitions/APAccountRef"
},
"TotalAmt": {
"description": "",
"example": 25,
"type": "number",
"format": "double"
}
},
"required": [
"Line",
"VendorRef",
"APAccountRef",
"TotalAmt"
]
},
"Line264": {
"title": "Line264",
"example": {
"Amount": 25.0,
"DetailType": "ItemBasedExpenseLineDetail",
"ItemBasedExpenseLineDetail": {
"CustomerRef": {
"value": "3",
"name": "Cool Cars"
},
"BillableStatus": "NotBillable",
"ItemRef": {
"value": "11",
"name": "Pump"
},
"UnitPrice": 25,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
},
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 25,
"type": "number",
"format": "double"
},
"DetailType": {
"description": "",
"example": "ItemBasedExpenseLineDetail",
"type": "string"
},
"ItemBasedExpenseLineDetail": {
"$ref": "#/definitions/ItemBasedExpenseLineDetail"
}
},
"required": [
"Amount",
"DetailType",
"ItemBasedExpenseLineDetail"
]
},
"SalesreceiptCreaterequest": {
"title": "SalesReceipt-CreateRequest",
"example": {
"Line": [
{
"Id": "1",
"LineNum": 1,
"Description": "Pest Control Services",
"Amount": 35.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "10",
"name": "Pest Control"
},
"UnitPrice": 35,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
}
]
},
"type": "object",
"properties": {
"Line": {
"description": "",
"example": [
{
"Id": "1",
"LineNum": 1,
"Description": "Pest Control Services",
"Amount": 35.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "10",
"name": "Pest Control"
},
"UnitPrice": 35,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line272"
}
}
},
"required": [
"Line"
]
},
"Line272": {
"title": "Line272",
"example": {
"Id": "1",
"LineNum": 1,
"Description": "Pest Control Services",
"Amount": 35.0,
"DetailType": "SalesItemLineDetail",
"SalesItemLineDetail": {
"ItemRef": {
"value": "10",
"name": "Pest Control"
},
"UnitPrice": 35,
"Qty": 1,
"TaxCodeRef": {
"value": "NON"
}
}
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"LineNum": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Description": {
"description": "",
"example": "Pest Control Services",
"type": "string"
},
"Amount": {
"description": "",
"example": 35,
"type": "number",
"format": "double"
},
"DetailType": {
"description": "",
"example": "SalesItemLineDetail",
"type": "string"
},
"SalesItemLineDetail": {
"$ref": "#/definitions/SalesItemLineDetail76"
}
},
"required": [
"Id",
"LineNum",
"Description",
"Amount",
"DetailType",
"SalesItemLineDetail"
]
},
"TransferDeleterequest": {
"title": "Transfer-DeleteRequest",
"example": {
"Id": "183",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "183",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"EstimateDeleterequest": {
"title": "Estimate-DeleteRequest",
"example": {
"Id": "163",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "163",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"TermCreaterequest": {
"title": "Term-CreateRequest",
"example": {
"Name": "Term120",
"DueDays": "120"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Term120",
"type": "string"
},
"DueDays": {
"description": "",
"example": "120",
"type": "string"
}
},
"required": [
"Name",
"DueDays"
]
},
"TermDeleterequest": {
"title": "Term-DeleteRequest",
"example": {
"Name": "Term1120-Updated",
"Active": false,
"Type": "STANDARD",
"DiscountPercent": 0,
"DueDays": 120,
"domain": "QBO",
"sparse": false,
"Id": "8",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Name": {
"description": "",
"example": "Term1120-Updated",
"type": "string"
},
"Active": {
"description": "",
"example": false,
"type": "boolean"
},
"Type": {
"description": "",
"example": "STANDARD",
"type": "string"
},
"DiscountPercent": {
"description": "",
"example": 0,
"type": "integer",
"format": "int32"
},
"DueDays": {
"description": "",
"example": 120,
"type": "integer",
"format": "int32"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "8",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Name",
"Active",
"Type",
"DiscountPercent",
"DueDays",
"domain",
"sparse",
"Id",
"SyncToken"
]
},
"PaymentCreaterequest": {
"title": "Payment-CreateRequest",
"example": {
"CustomerRef": {
"value": "58",
"name": "TEST123"
},
"TotalAmt": 100.0,
"Line": [
{
"Amount": 100.0,
"LinkedTxn": [
{
"TxnId": "173",
"TxnType": "Invoice"
}
]
}
]
},
"type": "object",
"properties": {
"CustomerRef": {
"$ref": "#/definitions/CustomerRef"
},
"TotalAmt": {
"description": "",
"example": 100,
"type": "number",
"format": "double"
},
"Line": {
"description": "",
"example": [
{
"Amount": 100.0,
"LinkedTxn": [
{
"TxnId": "173",
"TxnType": "Invoice"
}
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line231"
}
}
},
"required": [
"CustomerRef",
"TotalAmt",
"Line"
]
},
"DepositUpdaterequest": {
"title": "Deposit-UpdateRequest",
"example": {
"DepositToAccountRef": {
"value": "35",
"name": "Checking"
},
"TotalAmt": 205,
"domain": "QBO",
"sparse": false,
"Id": "162",
"SyncToken": "0",
"TxnDate": "2016-08-18",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1,
"Line": [
{
"Id": "1",
"LineNum": 1,
"Amount": 205,
"DetailType": "DepositLineDetail",
"DepositLineDetail": {
"AccountRef": {
"value": "87",
"name": "Unapplied Cash Payment Income"
}
}
}
]
},
"type": "object",
"properties": {
"DepositToAccountRef": {
"$ref": "#/definitions/DepositToAccountRef"
},
"TotalAmt": {
"description": "",
"example": 205,
"type": "integer",
"format": "int32"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "162",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"TxnDate": {
"description": "",
"example": "2016-08-18",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Line": {
"description": "",
"example": [
{
"Id": "1",
"LineNum": 1,
"Amount": 205,
"DetailType": "DepositLineDetail",
"DepositLineDetail": {
"AccountRef": {
"value": "87",
"name": "Unapplied Cash Payment Income"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line287"
}
}
},
"required": [
"DepositToAccountRef",
"TotalAmt",
"domain",
"sparse",
"Id",
"SyncToken",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"Line"
]
},
"Line287": {
"title": "Line287",
"example": {
"Id": "1",
"LineNum": 1,
"Amount": 205,
"DetailType": "DepositLineDetail",
"DepositLineDetail": {
"AccountRef": {
"value": "87",
"name": "Unapplied Cash Payment Income"
}
}
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"LineNum": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Amount": {
"description": "",
"example": 205,
"type": "integer",
"format": "int32"
},
"DetailType": {
"description": "",
"example": "DepositLineDetail",
"type": "string"
},
"DepositLineDetail": {
"$ref": "#/definitions/DepositLineDetail"
}
},
"required": [
"Id",
"LineNum",
"Amount",
"DetailType",
"DepositLineDetail"
]
},
"EmployeeDeleterequest": {
"title": "Employee-DeleteRequest",
"example": {
"SSN": "XXX-XX-XXXX",
"PrimaryAddr": {
"Id": "105",
"Line1": "45 N. Elm Street",
"City": "Middlefield",
"CountrySubDivisionCode": "CA",
"PostalCode": "93242"
},
"BillableTime": false,
"domain": "QBO",
"sparse": false,
"Id": "68",
"SyncToken": "2",
"MetaData": {
"CreateTime": "2016-08-18T23:04:16+00:00",
"LastUpdatedTime": "2016-08-18T23:04:16+00:00"
},
"GivenName": "John",
"FamilyName": "Meuller",
"DisplayName": "John Meuller - Updated",
"PrintOnCheckName": "John Meuller",
"Active": false,
"PrimaryPhone": {
"FreeFormNumber": "408-525-1234"
}
},
"type": "object",
"properties": {
"SSN": {
"description": "",
"example": "XXX-XX-XXXX",
"type": "string"
},
"PrimaryAddr": {
"$ref": "#/definitions/PrimaryAddr"
},
"BillableTime": {
"description": "",
"example": false,
"type": "boolean"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "68",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "2",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
},
"GivenName": {
"description": "",
"example": "John",
"type": "string"
},
"FamilyName": {
"description": "",
"example": "Meuller",
"type": "string"
},
"DisplayName": {
"description": "",
"example": "John Meuller - Updated",
"type": "string"
},
"PrintOnCheckName": {
"description": "",
"example": "John Meuller",
"type": "string"
},
"Active": {
"description": "",
"example": false,
"type": "boolean"
},
"PrimaryPhone": {
"$ref": "#/definitions/PrimaryPhone"
}
},
"required": [
"SSN",
"PrimaryAddr",
"BillableTime",
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData",
"GivenName",
"FamilyName",
"DisplayName",
"PrintOnCheckName",
"Active",
"PrimaryPhone"
]
},
"EstimateUpdaterequest": {
"title": "Estimate-UpdateRequest",
"type": "object",
"properties": {
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "163",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"CustomField": {
"description": "",
"example": [
{
"DefinitionId": "1",
"Name": "Crew #",
"Type": "StringType"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/CustomField"
}
},
"DocNumber": {
"description": "",
"example": "1001-Updated",
"type": "string"
},
"TxnDate": {
"description": "",
"example": "2016-08-18",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"TxnStatus": {
"description": "",
"example": "Pending",
"type": "string"
},
"Line": {
"description": "",
"type": "array",
"items": {
"$ref": "#/definitions/Line297"
}
},
"TxnTaxDetail": {
"$ref": "#/definitions/TxnTaxDetail"
},
"CustomerRef": {
"$ref": "#/definitions/CustomerRef"
},
"CustomerMemo": {
"$ref": "#/definitions/CustomerMemo"
},
"BillAddr": {
"$ref": "#/definitions/BillAddr"
},
"ShipAddr": {
"$ref": "#/definitions/ShipAddr"
},
"TotalAmt": {
"description": "",
"example": 31.5,
"type": "number",
"format": "double"
},
"HomeTotalAmt": {
"description": "",
"example": 31.5,
"type": "number",
"format": "double"
},
"ApplyTaxAfterDiscount": {
"description": "",
"example": false,
"type": "boolean"
},
"PrintStatus": {
"description": "",
"example": "NeedToPrint",
"type": "string"
},
"EmailStatus": {
"description": "",
"example": "NotSet",
"type": "string"
},
"BillEmail": {
"$ref": "#/definitions/BillEmail"
}
},
"required": [
"domain",
"sparse",
"Id",
"SyncToken",
"CustomField",
"DocNumber",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"TxnStatus",
"Line",
"TxnTaxDetail",
"CustomerRef",
"CustomerMemo",
"BillAddr",
"ShipAddr",
"TotalAmt",
"HomeTotalAmt",
"ApplyTaxAfterDiscount",
"PrintStatus",
"EmailStatus",
"BillEmail"
]
},
"Line297": {
"title": "Line297",
"type": "object",
"properties": {
"Amount": {
"description": "",
"example": 35,
"type": "integer",
"format": "int32"
},
"DetailType": {
"description": "",
"example": "SalesItemLineDetail",
"type": "string"
},
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"LineNum": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Description": {
"description": "",
"example": "Pest Control Services",
"type": "string"
},
"SalesItemLineDetail": {
"$ref": "#/definitions/SalesItemLineDetail76"
},
"SubTotalLineDetail": {
"description": "",
"example": {},
"type": "object"
},
"DiscountLineDetail": {
"$ref": "#/definitions/DiscountLineDetail"
}
},
"required": [
"Amount",
"DetailType"
]
},
"BillpaymentUpdaterequest": {
"title": "BillPayment-UpdateRequest",
"example": {
"VendorRef": {
"value": "62",
"name": "Test"
},
"PayType": "Check",
"CheckPayment": {
"BankAccountRef": {
"value": "35",
"name": "Checking"
}
},
"TotalAmt": 100.0,
"PrivateNote": "Updated Note",
"Line": [
{
"Amount": 100.0,
"LinkedTxn": [
{
"TxnId": "153",
"TxnType": "Bill"
}
]
}
]
},
"type": "object",
"properties": {
"VendorRef": {
"$ref": "#/definitions/VendorRef170"
},
"PayType": {
"description": "",
"example": "Check",
"type": "string"
},
"CheckPayment": {
"$ref": "#/definitions/CheckPayment"
},
"TotalAmt": {
"description": "",
"example": 100,
"type": "number",
"format": "double"
},
"PrivateNote": {
"description": "",
"example": "Updated Note",
"type": "string"
},
"Line": {
"description": "",
"example": [
{
"Amount": 100.0,
"LinkedTxn": [
{
"TxnId": "153",
"TxnType": "Bill"
}
]
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line231"
}
}
},
"required": [
"VendorRef",
"PayType",
"CheckPayment",
"TotalAmt",
"PrivateNote",
"Line"
]
},
"VendorcreditDeleterequest": {
"title": "VendorCredit-DeleteRequest",
"example": {
"Id": "185",
"SyncToken": "1"
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "185",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "1",
"type": "string"
}
},
"required": [
"Id",
"SyncToken"
]
},
"AttachableCreaterequest": {
"title": "Attachable-CreateRequest",
"example": {
"AttachableRef": [
{
"EntityRef": {
"value": "130",
"type": "Invoice"
},
"IncludeOnSend": "false"
}
],
"Note": "This is an attached note."
},
"type": "object",
"properties": {
"AttachableRef": {
"description": "",
"example": [
{
"EntityRef": {
"value": "130",
"type": "Invoice"
},
"IncludeOnSend": "false"
}
],
"type": "array",
"items": {
"$ref": "#/definitions/AttachableRef317"
}
},
"Note": {
"description": "",
"example": "This is an attached note.",
"type": "string"
}
},
"required": [
"AttachableRef",
"Note"
]
},
"AttachableRef317": {
"title": "AttachableRef317",
"example": {
"EntityRef": {
"value": "130",
"type": "Invoice"
},
"IncludeOnSend": "false"
},
"type": "object",
"properties": {
"EntityRef": {
"$ref": "#/definitions/EntityRef"
},
"IncludeOnSend": {
"description": "",
"example": "false",
"type": "string"
}
},
"required": [
"EntityRef",
"IncludeOnSend"
]
},
"PurchaseUpdaterequest": {
"title": "Purchase-UpdateRequest",
"example": {
"AccountRef": {
"value": "42",
"name": "Visa"
},
"PaymentType": "CreditCard",
"Credit": false,
"TotalAmt": 100,
"PurchaseEx": {
"any": [
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "TxnType",
"Value": "54"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
}
]
},
"domain": "QBO",
"sparse": false,
"Id": "175",
"SyncToken": "0",
"MetaData": {
"CreateTime": "2016-08-24T05:52:14+00:00",
"LastUpdatedTime": "2016-08-24T05:52:14+00:00"
},
"CustomField": [],
"TxnDate": "2016-08-23",
"CurrencyRef": {
"value": "USD",
"name": "United States Dollar"
},
"ExchangeRate": 1,
"Line": [
{
"Id": "1",
"Amount": 100,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"value": "13",
"name": "Meals and Entertainment"
},
"BillableStatus": "NotBillable",
"TaxCodeRef": {
"value": "NON"
}
}
}
]
},
"type": "object",
"properties": {
"AccountRef": {
"$ref": "#/definitions/AccountRef"
},
"PaymentType": {
"description": "",
"example": "CreditCard",
"type": "string"
},
"Credit": {
"description": "",
"example": false,
"type": "boolean"
},
"TotalAmt": {
"description": "",
"example": 100,
"type": "integer",
"format": "int32"
},
"PurchaseEx": {
"$ref": "#/definitions/PurchaseEx"
},
"domain": {
"description": "",
"example": "QBO",
"type": "string"
},
"sparse": {
"description": "",
"example": false,
"type": "boolean"
},
"Id": {
"description": "",
"example": "175",
"type": "string"
},
"SyncToken": {
"description": "",
"example": "0",
"type": "string"
},
"MetaData": {
"$ref": "#/definitions/MetaData"
},
"CustomField": {
"description": "",
"example": [],
"type": "array",
"items": {
"type": "string"
}
},
"TxnDate": {
"description": "",
"example": "2016-08-23",
"type": "string"
},
"CurrencyRef": {
"$ref": "#/definitions/CurrencyRef"
},
"ExchangeRate": {
"description": "",
"example": 1,
"type": "integer",
"format": "int32"
},
"Line": {
"description": "",
"example": [
{
"Id": "1",
"Amount": 100,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"value": "13",
"name": "Meals and Entertainment"
},
"BillableStatus": "NotBillable",
"TaxCodeRef": {
"value": "NON"
}
}
}
],
"type": "array",
"items": {
"$ref": "#/definitions/Line326"
}
}
},
"required": [
"AccountRef",
"PaymentType",
"Credit",
"TotalAmt",
"PurchaseEx",
"domain",
"sparse",
"Id",
"SyncToken",
"MetaData",
"CustomField",
"TxnDate",
"CurrencyRef",
"ExchangeRate",
"Line"
]
},
"PurchaseEx": {
"title": "PurchaseEx",
"example": {
"any": [
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "TxnType",
"Value": "54"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
}
]
},
"type": "object",
"properties": {
"any": {
"description": "",
"example": [
{
"name": "{http://schema.intuit.com/finance/v3}NameValue",
"declaredType": "com.intuit.schema.finance.v3.NameValue",
"scope": "javax.xml.bind.JAXBElement$GlobalScope",
"value": {
"Name": "TxnType",
"Value": "54"
},
"nil": false,
"globalScope": true,
"typeSubstituted": false
}
],
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"any"
]
},
"Line326": {
"title": "Line326",
"example": {
"Id": "1",
"Amount": 100,
"DetailType": "AccountBasedExpenseLineDetail",
"AccountBasedExpenseLineDetail": {
"AccountRef": {
"value": "13",
"name": "Meals and Entertainment"
},
"BillableStatus": "NotBillable",
"TaxCodeRef": {
"value": "NON"
}
}
},
"type": "object",
"properties": {
"Id": {
"description": "",
"example": "1",
"type": "string"
},
"Amount": {
"description": "",
"example": 100,
"type": "integer",
"format": "int32"
},
"DetailType": {
"description": "",
"example": "AccountBasedExpenseLineDetail",
"type": "string"
},
"AccountBasedExpenseLineDetail": {
"$ref": "#/definitions/AccountBasedExpenseLineDetail327"
}
},
"required": [
"Id",
"Amount",
"DetailType",
"AccountBasedExpenseLineDetail"
]
},
"AccountBasedExpenseLineDetail327": {
"title": "AccountBasedExpenseLineDetail327",
"example": {
"AccountRef": {
"value": "13",
"name": "Meals and Entertainment"
},
"BillableStatus": "NotBillable",
"TaxCodeRef": {
"value": "NON"
}
},
"type": "object",
"properties": {
"AccountRef": {
"$ref": "#/definitions/AccountRef"
},
"BillableStatus": {
"description": "",
"example": "NotBillable",
"type": "string"
},
"TaxCodeRef": {
"$ref": "#/definitions/TaxCodeRef"
}
},
"required": [
"AccountRef",
"BillableStatus",
"TaxCodeRef"
]
},
"TaxagencyCreaterequest": {
"title": "TaxAgency-CreateRequest",
"example": {
"DisplayName": "CityTaxAgency"
},
"type": "object",
"properties": {
"DisplayName": {
"description": "",
"example": "CityTaxAgency",
"type": "string"
}
},
"required": [
"DisplayName"
]
},
"TransferCreaterequest": {
"title": "Transfer-CreateRequest",
"example": {
"FromAccountRef": {
"value": "35",
"name": "Checking"
},
"ToAccountRef": {
"value": "36",
"name": "Savings"
},
"Amount": "120.00"
},
"type": "object",
"properties": {
"FromAccountRef": {
"$ref": "#/definitions/FromAccountRef"
},
"ToAccountRef": {
"$ref": "#/definitions/ToAccountRef"
},
"Amount": {
"description": "",
"example": "120.00",
"type": "string"
}
},
"required": [
"FromAccountRef",
"ToAccountRef",
"Amount"
]
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment