Supported Methods

Supported Parameters

GET, POST, PATCH

Id, number, page, pageSize, modTimeStart, modTimeEnd, isDeleted

{
    "ID": "",
    "Number": "",
    "PONumber": "",
    "SubTotal": 0.0,
    "SalesTaxAmount": 0.0,
    "Balance": 0.0,
    "DueDate": "2021-05-05T16:14:25Z",
    "Date": "2021-05-05T16:14:25Z",
    "ToBePrinted": true,
    "ToBeEmailed": true,
    "ShippingMethod": {
        "ID": "",
        "FullName": ""
    },
    "ItemLines": [{
        "Item": {
            "ID": "",
            "FullName": "",
            "Type": ""
        },
        "SalesTaxCode": {
            "ID": "",
            "FullName": ""
        },
        "Amount": 0.0,
        "Quantity": 0.0,
        "Rate": 0.0,
        "RatePercent": 0.0,
        "ServiceDate": "2021-05-05T16:14:25Z",
        "Description": "",
        "FromInventorySite": {
            "ID": "",
            "FullName": ""
        },
        "FromInventorySiteLocation": {
            "ID": "",
            "FullName": ""
        },
        "UnitOfMeasure": {
            "FullName": ""
        },
        "CustomFields": [{
            "FullName": "",
            "Value": ""
        }],
        "SerialNumber": "",
        "LotNumber": "",
        "Class": {
            "FullName": "",
            "ID": ""
        },
        "SubLines": [{
            "Item": {
                "ID": "",
                "FullName": ""
            },
            "Quantity": 0.0,
            "Rate": 0.0,
            "Amount": 0.0,
            "SalesTaxCode": {
                "ID": "",
                "FullName": ""
            },
            "Desc": "",
            "ServiceDate": "2021-05-05T16:14:25Z",
            "ID": ""
        }],
        "ID": "",
        "IsTaxable": true,
        "Account": {
            "ID": ""
        }
    }],
    "Terms": {
        "ID": "",
        "FullName": ""
    },
    "Other": "",
    "Memo": "",
    "Class": {
        "FullName": "",
        "ID": ""
    },
    "SalesRep": {
        "ID": "",
        "FullName": ""
    },
    "ItemSalesTax": {
        "ID": "",
        "FullName": ""
    },
    "Customer": {
        "ID": "",
        "FullName": ""
    },
    "LinkedTransactions": [{
        "Number": "",
        "Type": "",
        "Date": "2021-05-05T16:14:25Z",
        "ID": "",
        "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": ""
    },
    "FOB": "",
    "DateShipped": "2021-05-05T16:14:25Z",
    "Account": {
        "FullName": "",
        "ID": ""
    },
    "Currency": {
        "FullName": "",
        "ID": ""
    },
    "IsPending": true,
    "Template": {
        "ID": "",
        "FullName": ""
    },
    "Message": {
        "ID": "",
        "FullName": ""
    },
    "ExchangeRate": 0.0,
    "CreatedDate": "2021-05-05T16:14:25Z",
    "LastModifiedDate": "2021-05-05T16:14:25Z",
    "AppliedAmount": 0.0,
    "IsPaid": true,
    "DeletedDate": "2021-05-05T16:14:25Z",
    "BalanceRemainingInHomeCurrency": 0.0,
    "SalesTaxPercentage": 0.0,
    "Amount": 0.0,
    "IsVoid": true
}

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

Did this page help you?