Supported MethodsSupported Parameters
GET, POST, PATCHId, number, page, pageSize, modTimeStart, modTimeEnd, isDeleted
{
	"ID": "",
	"Number": "",
	"SubTotal": 0.0,
	"SalesTaxAmount": 0.0,
	"Amount": 0.0,
	"Balance": 0.0,
	"DueDate": "2023-01-09T16:29:10Z",
	"Date": "2023-01-09T16:29:10Z",
	"ToBePrinted": true,
	"ToBeEmailed": true,
	"ShippingMethod": {
		"FullName": "",
		"ID": ""
	},
	"ItemLines": [{
		"Item": {
			"ID": "",
			"FullName": "",
			"Type": ""
		},
		"Amount": 0.0,
		"Quantity": 0.0,
		"Rate": 0.0,
		"ServiceDate": "2023-01-09T16:29:10Z",
		"IsTaxable": true,
		"Description": "",
		"SalesTaxCode": {
			"ID": "",
			"FullName": ""
		},
		"RatePercent": 0.0,
		"FromInventorySite": {
			"ID": "",
			"FullName": ""
		},
		"FromInventorySiteLocation": {
			"ID": "",
			"FullName": ""
		},
		"UnitOfMeasure": {
			"FullName": ""
		},
		"CustomFields": [{
			"FullName": "",
			"Value": ""
		}],
		"SerialNumber": "",
		"LotNumber": "",
		"Class": {
			"FullName": "",
			"ID": ""
		},
		"ID": "",
		"Other1": "",
		"Other2": "",
		"SubLines": [{
			"Item": {
				"ID": "",
				"FullName": ""
			},
			"Quantity": 0.0,
			"Rate": 0.0,
			"Amount": 0.0,
			"SalesTaxCode": {
				"ID": "",
				"FullName": ""
			},
			"Desc": "",
			"ServiceDate": "2023-01-09T16:29:10Z",
			"ID": ""
		}],
		"UnitOfMeasureSet": {
			"ID": "",
			"FullName": ""
		},
		"Account": {
			"ID": ""
		}
	}],
	"Terms": {
		"ID": "",
		"FullName": ""
	},
	"Memo": "",
	"Class": {
		"FullName": "",
		"ID": ""
	},
	"ItemSalesTax": {
		"ID": "",
		"FullName": ""
	},
	"Customer": {
		"ID": "",
		"FullName": ""
	},
	"LinkedTransactions": [{
		"ID": "",
		"Type": "",
		"Number": "",
		"Date": "2023-01-09T16:29:10Z",
		"Amount": 0.0
	}],
	"CustomFields": [{
		"FullName": "",
		"Value": ""
	}],
	"BillingAddress": {
		"Line1": "",
		"Line2": "",
		"Line3": "",
		"Line4": "",
		"Line5": "",
		"City": "",
		"State": "",
		"PostalCode": "",
		"Notes": "",
		"Country": ""
	},
	"ShippingAddress": {
		"Line1": "",
		"Line2": "",
		"Line3": "",
		"Line4": "",
		"Line5": "",
		"City": "",
		"State": "",
		"PostalCode": "",
		"Country": "",
		"Notes": ""
	},
	"Currency": {
		"FullName": "",
		"ID": ""
	},
	"IsVoid": true,
	"IsPaid": true,
	"PONumber": "",
	"Other": "",
	"SalesRep": {
		"ID": "",
		"FullName": ""
	},
	"FOB": "",
	"DateShipped": "2023-01-09T16:29:10Z",
	"Account": {
		"FullName": "",
		"ID": ""
	},
	"IsPending": true,
	"Template": {
		"ID": "",
		"FullName": ""
	},
	"Message": {
		"ID": "",
		"FullName": ""
	},
	"ExchangeRate": 0.0,
	"CreatedDate": "2023-01-09T16:29:10Z",
	"LastModifiedDate": "2023-01-09T16:29:10Z",
	"AppliedAmount": 0.0,
	"DeletedDate": "2023-01-09T16:29:10Z",
	"BalanceRemainingInHomeCurrency": 0.0,
	"SalesTaxPercentage": 0.0
}

Important Notes

ItemLines.Item.Type

  • The "Type" field is only for available on a POST when inserting Group Items and does not reference the actual type of item

SubLines

  • "Type": "Group" needs to be included in the ItemLines.Item data
  • SubLines cannot be modified as this is not allowed through the QB SDK