Skip to content

Instantly share code, notes, and snippets.

@kinlane
Created August 17, 2018 02:18
Show Gist options
  • Save kinlane/8b67e8bb101500cbc1bce2a7ca49fffc to your computer and use it in GitHub Desktop.
Save kinlane/8b67e8bb101500cbc1bce2a7ca49fffc to your computer and use it in GitHub Desktop.
QuickBooks Online V3 API OpenAPI
{
"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}}",