paymentresponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/quickbooks/json-schema/quickbooks-paymentresponse-schema.json",
  "title": "paymentresponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/quickbooks-payment-api-openapi.yml#/components/schemas/paymentresponse",
  "type": "object",
  "properties": {
    "SyncToken": {
      "type": "string",
      "description": "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 fails. Only the latest version of the object is maintained by QuickBooks Online.",
      "x-intuit-required": "Required for update"
    },
    "PrivateNote": {
      "type": "string",
      "description": "User entered, organization-private note about the transaction.",
      "x-intuit-required": "Optional"
    },
    "PaymentMethodRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to a PaymentMethod associated with this transaction. Query the PaymentMethod name list resource to determine the appropriate PaymentMethod object for this reference. Use PaymentMethod.Id and PaymentMethod.Name from that object for PaymentMethodRef.value and PaymentMethodRef.name, respectively.",
      "x-intuit-required": "Optional"
    },
    "UnappliedAmt": {
      "type": "number",
      "description": "Indicates the amount that has not been applied to pay amounts owed for sales transactions.",
      "x-intuit-required": "Optional"
    },
    "DepositToAccountRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Identifies the account to be used for this payment. Query the Account name list resource to determine the appropriate Account object for this reference, where Account.AccountType is Other Current Asset or Bank. Use Account.Id and Account.Name from that object for DepositToAccountRef.value and DepostiToAccountRef.name, respectively.\n\nIf you do not specify this account, payment is applied to the Undeposited Funds account.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "Undeposited Funds account"
    },
    "CurrencyRef": {
      "type": "object",
      "x-intuit-type": "CurrencyRefType",
      "description": "Reference to the currency in which all amounts on the associated transaction are expressed. This must be defined if multicurrency is enabled for the company.\n\nMulticurrency is enabled for the company if Preferences.MultiCurrencyEnabled is set to true. Read more about multicurrency support here. Required if multicurrency is enabled for the company.",
      "x-intuit-required": "Conditionally required"
    },
    "TotalAmt": {
      "type": "number",
      "description": "Indicates the total amount of the transaction. This includes the total of all the charges, allowances, and taxes. If you process a linked refund transaction against a specific transaction, the \ntotalAmt value won't change. It will remain the same. However, voiding the linked refund will change the \ntotalAmt value to O.",
      "x-intuit-required": "Required"
    },
    "ExchangeRate": {
      "type": "number",
      "description": "The number of home currency units it takes to equal one unit of currency specified by CurrencyRef. Applicable if multicurrency is enabled for the company",
      "x-intuit-required": "Optional",
      "x-intuit-default": "1"
    },
    "Line": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/line"
      },
      "description": "Zero or more transactions accounting for this payment. Values for\nLine.LinkedTxn.TxnTypecan be one of the following:\n\nExpense--Payment is reimbursement for expense paid by cash made on behalf of the customer\n\nCheck--Payment is reimbursement for expense paid by check made on behalf of the customer\n\nCreditCardCredit--Payment is reimbursement for a credit card credit made on behalf of the customer\n\nJournalEntry--Payment is linked to the representative journal entry\n\nCreditMemo--Payment is linked to the credit memo the customer has with the business\n\nInvoice--The invoice to which payment is applied\n\nUse Line.LinkedTxn.TxnId as the ID in a separate read request for the specific resource to retrieve details of the linked object.",
      "x-intuit-required": "Optional"
    },
    "ProjectRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to the Project ID associated with this transaction.",
      "x-intuit-required": "Conditionally required",
      "x-intuit-filterable": true
    },
    "TxnSource": {
      "type": "string",
      "description": "Used internally to specify originating source of a credit card transaction.",
      "x-intuit-required": "Optional"
    },
    "PaymentRefNum": {
      "type": "string",
      "description": "The reference number for the payment received. For example, Check # for a check, envelope # for a cash donation.",
      "x-intuit-required": "Optional",
      "x-intuit-filterable": true,
      "x-intuit-sortable": true
    },
    "TxnDate": {
      "type": "string",
      "format": "date",
      "description": "The date entered by the user when this transaction occurred.\nFor posting transactions, this is the posting date that affects the financial statements. If the date is not supplied, the current date on the server is used.\n\nSort order is ASC by default.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "current server date",
      "x-intuit-filterable": true,
      "x-intuit-sortable": true
    },
    "CreditCardPayment": {
      "allOf": [
        {
          "$ref": "#/$defs/creditcardpayment"
        }
      ],
      "description": "Information about a payment received by credit card. Inject with data only if the payment was transacted through Intuit Payments API.",
      "x-intuit-required": "Optional"
    },
    "TaxExemptionRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to the TaxExepmtion ID associated with this object. Available for companies that have automated sales tax enabled.\nTaxExemptionRef.Name: The Tax Exemption Id for the customer to which this object is associated. This Id is typically issued by the state.\n\nTaxExemptionRef.value: The system-generated Id of the exemption type.\n\nFor internal use only"
    },
    "CustomerRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to a customer or job. Query the Customer name list resource to determine the appropriate Customer object for this reference. Use Customer.Id and Customer.DisplayName from that object for CustomerRef.value and CustomerRef.name, respectively.",
      "x-intuit-required": "Required",
      "x-intuit-filterable": true
    },
    "Id": {
      "type": "string",
      "description": "Unique identifier for this object.",
      "x-intuit-required": "Required for update",
      "x-intuit-filterable": true
    },
    "MetaData": {
      "allOf": [
        {
          "$ref": "#/$defs/modificationmetadata"
        }
      ],
      "description": "Descriptive information about the entity. The MetaData values are set by Data Services and are read only for all applications.",
      "x-intuit-required": "Optional"
    }
  },
  "required": [
    "CustomerRef",
    "TotalAmt"
  ],
  "$defs": {
    "creditcardpayment": {
      "type": "object",
      "title": "creditcardpayment",
      "properties": {
        "CreditChargeResponse": {
          "allOf": [
            {
              "$ref": "#/$defs/creditchargeresponse"
            }
          ],
          "description": "Holds credit-card transaction response information from a merchant account service.",
          "x-intuit-required": "Optional"
        },
        "CreditChargeInfo": {
          "allOf": [
            {
              "$ref": "#/$defs/creditchargeinfo"
            }
          ],
          "description": "Holds creditcard information to request a credit card payment from a merchant account service.",
          "x-intuit-required": "Optional"
        }
      }
    },
    "creditchargeinfo": {
      "type": "object",
      "title": "creditchargeinfo",
      "properties": {
        "CcExpiryMonth": {
          "type": "integer",
          "description": "Expiration Month on card, expressed as a number:\n1=January,\n2=February, etc.",
          "x-intuit-required": "Optional"
        },
        "ProcessPayment": {
          "type": "boolean",
          "description": "-false or no value-Store credit card information only. Do not store QuickBooks Payment transaction information in CreditChargeResponse.\n-true-Store credit card payment transaction information in CreditChargeResponse below. Use this setting when QuickBooks Payments is configured to process credit card charges.",
          "x-intuit-required": "Optional"
        },
        "PostalCode": {
          "type": "string",
          "description": "Credit card holder billing postal code. Five digits in the USA.",
          "x-intuit-required": "Optional"
        },
        "Amount": {
          "type": "number",
          "description": "The amount processed using the credit card.",
          "x-intuit-required": "Optional"
        },
        "NameOnAcct": {
          "type": "string",
          "description": "Account holder name, as printed on the card.",
          "x-intuit-required": "Optional"
        },
        "CcExpiryYear": {
          "type": "integer",
          "description": "Expiration Year on card, expressed as a 4 digit number\n1999, 2003, etc.",
          "x-intuit-required": "Optional",
          "x-intuit-default": "current year"
        },
        "Type": {
          "type": "string",
          "description": "Type of credit card. For example, MasterCard, Visa, Discover, American Express, and so on.",
          "x-intuit-required": "Optional"
        },
        "BillAddrStreet": {
          "type": "string",
          "description": "Credit card holder billing address of record: the street address to which credit card statements are sent.",
          "x-intuit-required": "Optional"
        }
      }
    },
    "creditchargeresponse": {
      "type": "object",
      "title": "creditchargeresponse",
      "properties": {
        "Status": {
          "type": "string",
          "description": "Indicates the status of the payment transaction. Possible values include Completed, Unknown.",
          "x-intuit-required": "Optional"
        },
        "AuthCode": {
          "type": "string",
          "description": "Code returned from the credit card processor to indicate that the charge will be paid by the card issuer.",
          "x-intuit-required": "Optional"
        },
        "TxnAuthorizationTime": {
          "type": "string",
          "format": "date-time",
          "description": "Timestamp indicating the time in which the card processor authorized the transaction.",
          "x-intuit-required": "Optional"
        },
        "CCTransId": {
          "type": "string",
          "description": "Unique identifier of the payment transaction. It can be used to track the status of transactions, or to search transactions.",
          "x-intuit-required": "Optional"
        }
      }
    },
    "line": {
      "type": "object",
      "title": "line",
      "properties": {
        "Received": {
          "type": "string",
          "description": "Supported for Purchase Order only. The amount/quantity received of the line, which depends on the type of the line. It can represent the received amount or received quantity based on the line type detail. Applies to existing and new entities."
        },
        "LinkedTxn": {
          "type": "array",
          "items": {},
          "description": "Transaction to which the current entity is related. For example, an invoice line may link to a sales order or estimate.",
          "x-intuit-required": "Optional"
        },
        "Description": {
          "type": "string",
          "description": "Free form text description of the line item that appears in the printed record.",
          "x-intuit-required": "Optional"
        },
        "ProjectRef": {
          "allOf": [
            {
              "$ref": "#/$defs/referencetype"
            }
          ],
          "description": "Reference to the Project ID associated with this transaction.",
          "x-intuit-required": "Conditionally required"
        },
        "LineNum": {
          "type": "number",
          "description": "Specifies the position of the line in the collection of transaction lines. Positive integer",
          "x-intuit-required": "Optional"
        },
        "Amount": {
          "type": "number",
          "description": "The amount of the line item.",
          "x-intuit-required": "Required"
        },
        "Id": {
          "type": "string",
          "description": "The Id of the line item. Its use in requests is as folllows:\nIf\nIdis greater than zero and exists for the company, the request is considered an update operation for a line item.\n\nIf no\nIdis provided, the\nIdprovided is less than or equal to zero, or the\nIdprovided is greater than zero and does not exist for the company then the request is considered a create operation for a line item.\n\nAvailable in all objects that use lines and support the update operation.",
          "x-intuit-required": "Required for update"
        }
      },
      "required": [
        "Amount"
      ]
    },
    "modificationmetadata": {
      "type": "object",
      "title": "modificationmetadata",
      "properties": {
        "CreateTime": {
          "type": "string",
          "format": "date-time",
          "description": "Time the entity was created in the source domain.",
          "x-intuit-filterable": true,
          "x-intuit-sortable": true
        },
        "LastUpdatedTime": {
          "type": "string",
          "format": "date-time",
          "description": "Time the entity was last updated in the source domain.",
          "x-intuit-filterable": true,
          "x-intuit-sortable": true
        }
      }
    },
    "referencetype": {
      "type": "object",
      "title": "referencetype",
      "properties": {
        "name": {
          "type": "string",
          "description": "An identifying name for the object being referenced by value and is derived from the field that holds the common name of that object. This varies by context and specific type of object referenced. For example, references to a Customer object use Customer.DisplayName to populate this field. Optionally returned in responses, implementation dependent.",
          "x-intuit-required": "Optional"
        },
        "value": {
          "type": "string",
          "description": "The ID for the referenced object as found in the Id field of the object payload. The context is set by the type of reference and is specific to the QuickBooks company file.",
          "x-intuit-required": "Required"
        }
      },
      "required": [
        "value"
      ]
    }
  }
}