Create sales receipt
create_sales_receiptAdds a sales receipt: a sale paid in full when it was made, by cash, check or card. If the customer pays later, add an invoice instead and record the payment when it arrives. The money goes to deposit_to_account_ref. customer_ref is optional. Card details sent in credit_card_txn_info come back in the answer only if the app may see sensitive data.
The sales_receipt_add wrapper from qbXML is also accepted. Returns the v2 request to send, and the webhook payload QuickBooks' answer arrives in (this operation's response_json: its data shape and the status codes to handle).
Possible errors (error.code / error.type; the call result explains each): 1030 unsupported_request, 3000 invalid_object_id, 3040 invalid_amount, 3070 string_too_long, 3120 object_not_found, 3140 invalid_reference, 3150 missing_element, 3175 in_use, 3176 locked, 3180 cannot_save, 3210 invalid_value, 3220 not_authorized, 3231 request_not_processed, 3250 feature_not_enabled, 3260 insufficient_permission, 3261 personal_data_access_denied, 3262 payroll_subscription_required, 3263 read_only_access, 3264 merchant_services_subscription_required, 3270 missing_posting_account
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "create_sales_receipt"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fob | No | QuickBooks uses the term FOB, “freight on board,” to indicate the place from which the product is shipped. The FOB has no accounting implications. | |
| memo | No | Message that appears in reports, but not on the sales receipt. | |
| other | No | Other, Other1, and Other2 are built-in transaction custom fields. Other is transaction-level; Other1 and Other2 are line-level. | |
| due_date | No | A sales receipt doesn’t ordinarily include a due date, because sales receipts are generally used for point-of-sale payments, where full payment is received at the time of purchase. | |
| txn_date | No | The date of the sales receipt. In some cases, if you leave `txn_date` out of an -Add message, QuickBooks will prefill `txn_date` with the date of the last-saved transaction of the same type. | |
| class_ref | No | Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. | |
| def_macro | No | `def_macro` lets you assign a reusable name to a returned `txn_id` or `txn_line_id` so later requests can reference it with `useMacro`. This feature requires SDK 2.0+. | |
| ship_date | No | The date when the product was, or will be, shipped. | |
| is_pending | No | If `is_pending` is set to true, the sales receipt hasn’t been completed. | |
| ref_number | No | `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. | |
| request_id | No | Your own label for the request, sent to QuickBooks as its qbXML `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's webhook already carries the request's `id`. | |
| bill_address | No | This aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only). | |
| check_number | No | The check number of a check that a QuickBooks user writes or receives from someone else. | |
| customer_ref | No | `customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. | |
| ship_address | No | This aggregate supports at most five address lines. You can provide a structured address (Addr1-Addr3 plus City/State/`postal_code`/etc.) or use block mode (Addr1-Addr5 only). | |
| template_ref | No | QuickBooks templates specify how to print certain transactions. A template query returns the names of all templates that have been defined in QuickBooks. | |
| exchange_rate | No | `exchange_rate` is the rate from this currency to the company’s home currency at AsOfDate. You can supply a rate when adding transactions, but QuickBooks does not provide rates through the SDK. | |
| external_guid | No | Allows for the attachment of a user defined GUID value. | |
| include_qbxml | No | Also return the qbXML this compiles to, for debugging. Not part of the v2 request. | |
| sales_rep_ref | No | A sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. | |
| is_tax_included | No | For future use with international versions of QuickBooks. | |
| ship_method_ref | No | A shipping method, for example, standard mail or overnight delivery. A `ship_method_ref` aggregate refers to an item on the ShipMethod list. | |
| customer_msg_ref | No | A standard message such as “Thank you for your business,” or “Please sign and return this estimate to indicate your approval.” A customer message can be included at the bottom of a form. | |
| is_to_be_emailed | No | When enabled, QuickBooks validates the customer email at runtime before sending. If no valid email is available, the request fails. | |
| is_to_be_printed | No | If `is_to_be_printed` is true, QuickBooks queues the form for later printing. It does not print immediately; printing is still a user action in QuickBooks. | |
| discount_line_add | No | ||
| shipping_line_add | No | ||
| item_sales_tax_ref | No | An ItemSalesTax entry represents one tax rate paid to one tax agency. Use it when a transaction needs a single tax calculation. For multi-rate scenarios, use a sales-tax group instead. | |
| payment_method_ref | No | `payment_method_ref` identifies how a payment is made (for example, cash, check, or card type). If both `full_name` and `list_id` are provided, `full_name` is ignored. | |
| sales_tax_line_add | No | ||
| include_ret_element | No | ||
| credit_card_txn_info | No | Contains data from the credit card transaction used in the payment. This data originates from a previous qbmsXML credit card transaction. | |
| deposit_to_account_ref | No | Refers to the account where these funds will be (or have been) deposited. In a ReceivePaymentAdd request, the default is Undeposited Funds if this isn’t included in the request. | |
| sales_receipt_line_add | No | One line of the sales receipt. Compare with SalesReceiptLineGroup, which represents a previously defined group of lines in the sales receipt. At least one entry is required across `sales_receipt_line_add` and `sales_receipt_line_group_add`; they combine, any number of each. QuickBooks receives them in that order: every `sales_receipt_line_add`, then every `sales_receipt_line_group_add`. | |
| customer_sales_tax_code_ref | No | Refers to the sales-tax code for sales related to this customer. (That is, it refers to a member of the SalesTaxCode list.) | |
| sales_receipt_line_group_add | No | Represents a previously defined group of lines in the sales receipt. Compare with SalesReceiptLine, which represents just one line in the sales receipt. At least one entry is required across `sales_receipt_line_add` and `sales_receipt_line_group_add`; they combine, any number of each. QuickBooks receives them in that order: every `sales_receipt_line_add`, then every `sales_receipt_line_group_add`. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | Replace {connection_id} with the customer's connection. | |
| body | Yes | The JSON body: the arguments you passed. | |
| qbxml | No | The qbXML it compiles to. Only with include_qbxml. | |
| method | Yes | ||
| headers | Yes | Send with the request. Resent unchanged when no 201 came back, it answers with the request already queued. | |
| webhook | Yes | JSON Schema of the payload POSTed to webhook_url once QuickBooks answers, with this operation's response_json (data shape and status codes). |