creditcardpaymentresponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/quickbooks/json-schema/quickbooks-creditcardpaymentresponse-schema.json",
  "title": "creditcardpaymentresponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/quickbooks-creditcardpayment-api-openapi.yml#/components/schemas/creditcardpaymentresponse",
  "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. This field maps to the Memo field on the Pay down credit card form.",
      "x-intuit-required": "Optional"
    },
    "VendorRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Reference to the vendor for this transaction. Query the Vendor name list resource to determine the appropriate Vendor object for this reference. Use Vendor.Id and Vendor.Name from that object for VendorRef.value and VendorRef.name, respectively.",
      "x-intuit-required": "Optional",
      "x-intuit-filterable": true
    },
    "CreditCardAccountRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Identifies the credit card account to which funds are transfered. Query the Account name list resource to determine the appropriate Account object for this reference.",
      "x-intuit-required": "Required"
    },
    "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.\nSort order is ASC by default.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "Current server date",
      "x-intuit-filterable": true,
      "x-intuit-sortable": true
    },
    "Memo": {
      "type": "string",
      "description": "User entered, organization-private note about the transaction. This field maps to the Memo field on the Pay down credit card form.",
      "x-intuit-required": "Optional"
    },
    "PrintStatus": {
      "type": "string",
      "description": "Printing status of the credit-card-payment.\nValid values:\nNotSet,\nNeedToPrint,\nPrintComplete\n.",
      "x-intuit-required": "Optional",
      "x-intuit-default": "<span class=\"literal\">NotSet</span>"
    },
    "CheckNum": {
      "type": "string",
      "description": "User entered, Check number. This field maps to the Check no. field on the Pay down credit card form.",
      "x-intuit-required": "Optional"
    },
    "Amount": {
      "type": "number",
      "description": "Indicates the total amount of the transaction.",
      "x-intuit-required": "Required"
    },
    "BankAccountRef": {
      "allOf": [
        {
          "$ref": "#/$defs/referencetype"
        }
      ],
      "description": "Identifies the bank account from which funds are transfered. Query the Account name list resource to determine the appropriate Account object for this reference.",
      "x-intuit-required": "Required"
    },
    "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 object. The MetaData values are set by Data Services and are read only for all applications.",
      "x-intuit-required": "Optional"
    }
  },
  "required": [
    "Amount",
    "BankAccountRef",
    "CreditCardAccountRef"
  ],
  "$defs": {
    "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"
      ]
    }
  }
}