QuickBooks: Read a change order — response body — Change Order

API reference · Contract 2026-10-20

SDK schema: Read a change order — response body — Change Order

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: allowed
AcceptedBy	string	Optional	Name of the customer or representative who accepted the change order. Populated when TxnStatus is set to Accepted .
AcceptedDate	string	Optional	Date the change order was accepted. Populated when TxnStatus is set to Accepted .
ApplyTaxAfterDiscount	JSON	Optional	If false or null, sales tax is calculated first and then any discount is applied. If true , the discount is subtracted first and then sales tax is calculated.
ApplyTaxAfterDiscount (anyOf 1)	boolean	Alternative
ApplyTaxAfterDiscount (anyOf 2)	string	Alternative	Known values: true, false
BillEmail	Model	Optional	Expand Full update companyinfo — request body — body Email Email address where the change order is sent. Required when EmailStatus is set to NeedToSend . Conditionally required
CustomerMemo	Model	Optional	Expand Read an invoice — response body — Invoice Customer Memo User-entered message to the customer; visible on the Change Order document sent to the customer.
CustomerRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to the customer associated with this change order. Must match the customer on the parent project estimate. Use Customer.Id and Customer.DisplayName from the Customer object for CustomerRef.value and CustomerRef.name , respectively.
DocNumber	string	Optional	Reference number for the change order (for example, CO-001 ). If not provided, the value is null.
EmailStatus	string	Optional	Email status of the change order. Valid values: NotSet , NeedToSend , EmailSent .
ExpirationDate	string	Optional	Date by which the change order must be accepted before it expires.
Id	string	Optional	Unique identifier for this object. Read only: true
Line	array	Optional	Individual line items describing the work being added or removed. Supports SalesItemLineDetail and SubTotalLineDetail line types. Every line must include a LinkedTxn array referencing the parent project estimate with TxnType: “Estimate” . All lines must reference the same parent estimate. The Line array uses full-replace behavior on update — lines omitted from an update request are deleted.
Line[]	JSON	Each item
Line[] (anyOf 1)	Model	Alternative	Expand Read an invoice — response body — Invoice Line item Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Sales Item Line Detail
Line[] (anyOf 2)	Model	Alternative	Expand Read an invoice — response body — Invoice Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail
Line[] (anyOf 3)	Model	Alternative	Expand Read an invoice — response body — Invoice Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num
LinkedTxn	array	Optional	One or more linked transaction references at the header level, reflecting the parent project estimate. Also appears on each line item. Use LinkedTxn.TxnId as the ID in a separate Estimate read request to retrieve details of the linked object. TxnType must always be Estimate .
LinkedTxn[]	Model	Each item	Expand Read a bill — response body — Bill Linked Txn item
MetaData	Model	Optional	Expand Read a bill — response body — Bill Meta Data Descriptive information about the object. The MetaData values are set by Data Services and are read only for all applications.
PrintStatus	string	Optional	Printing status of the change order. Valid values: NotSet , NeedToPrint , PrintComplete .
PrivateNote	string	Optional	Organization-private note about the change order. This note does not appear on documents sent to the customer.
ProjectRef	Model	Optional	Expand Read an item — response body — Item Class Ref Reference to the project this change order belongs to. Must reference an active project. Without a valid ProjectRef , the change order will not appear in the Projects dashboard.
SyncToken	string	Optional	Version number of the object. It is used to lock an object for use by one app at a time. As soon as an application modifies an object, its SyncToken is incremented. Attempts to modify an object specifying an older SyncToken fail. Only the latest version of the object is maintained by QuickBooks Online. Read only: true
TotalAmt	JSON	Optional	Total amount of the transaction including all line charges and taxes. Calculated by QuickBooks business logic from the sum of all line Amount values plus applicable tax. Do not include in create or update request bodies; any value supplied is overwritten. Decimal string Read only: true
TotalAmt (anyOf 1)	JSON	Alternative
TotalAmt (anyOf 1) (anyOf 1)	number	Alternative
TotalAmt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalAmt (anyOf 2)	string	Alternative
TotalCostAmount	JSON	Optional	Total cost amount of the transaction, calculated from the sum of all line CostAmount values. Calculated by QuickBooks business logic; any value supplied is overwritten. Decimal string Read only: true
TotalCostAmount (anyOf 1)	JSON	Alternative
TotalCostAmount (anyOf 1) (anyOf 1)	number	Alternative
TotalCostAmount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
TotalCostAmount (anyOf 2)	string	Alternative
TxnDate	string	Optional	The date entered by the user when this transaction occurred. For posting transactions, this is the posting date that affects the financial statements. If not supplied, the current date on the server is used. Sort order is ASC by default.
TxnStatus	string	Optional	Current status of the change order. Valid values: Pending (default — created but not yet reviewed), Accepted (customer approved; project contracted total increases accordingly), Closed (converted to an Invoice or manually closed), Rejected (customer declined; does not affect project total).
TxnTaxDetail	Model	Optional	Expand Read a bill — response body — Bill Txn Tax Detail Tax details for the transaction. Captures sales taxes calculated based on tax codes referenced by the transaction lines.

Referenced models: Read an invoice — response body — Invoice Line item Amount, Description, Detail Type, Discount Line Detail, Id, Line Num, Full update companyinfo — request body — body Email, Read a bill — response body — Bill Linked Txn item, Read an invoice — response body — Invoice Customer Memo, Read a bill — response body — Bill Meta Data, Read an item — response body — Item Class Ref, Read an invoice — response body — Invoice Line item Amount, Custom Extensions, Description, Detail Type, Id, Line Num, Sales Item Line Detail, Read an invoice — response body — Invoice Line item Amount, Description, Detail Type, Id, Line Num, Sub Total Line Detail, Read a bill — response body — Bill Txn Tax Detail