ActionCancelReasonBUYERCANCELED captures enum value "BUYER_CANCELED".

ActionCancelReasonSELLERCANCELED captures enum value "SELLER_CANCELED".

ActionCancelReasonTIMEDOUT captures enum value "TIMED_OUT".

BankAccountStatusDISABLED captures enum value "DISABLED".

BankAccountStatusVERIFICATIONINPROGRESS captures enum value "VERIFICATION_IN_PROGRESS".

BankAccountStatusVERIFIED captures enum value "VERIFIED".

BankAccountTypeBUSINESSCHECKING captures enum value "BUSINESS_CHECKING".

BankAccountTypeCHECKING captures enum value "CHECKING".

BankAccountTypeINVESTMENT captures enum value "INVESTMENT".

BankAccountTypeOTHER captures enum value "OTHER".

BankAccountTypeSAVINGS captures enum value "SAVINGS".

BookingStatusACCEPTED captures enum value "ACCEPTED".

BookingStatusCANCELLEDBYCUSTOMER captures enum value "CANCELLED_BY_CUSTOMER".

BookingStatusCANCELLEDBYSELLER captures enum value "CANCELLED_BY_SELLER".

BookingStatusDECLINED captures enum value "DECLINED".

BookingStatusNOSHOW captures enum value "NO_SHOW".

BookingStatusPENDING captures enum value "PENDING".

BusinessAppointmentSettingsAlignmentTimeHALFHOURLY captures enum value "HALF_HOURLY".

BusinessAppointmentSettingsAlignmentTimeHOURLY captures enum value "HOURLY".

BusinessAppointmentSettingsAlignmentTimeQUARTERHOURLY captures enum value "QUARTER_HOURLY".

BusinessAppointmentSettingsAlignmentTimeSERVICEDURATION captures enum value "SERVICE_DURATION".

BusinessAppointmentSettingsBookingLocationTypeBUSINESSLOCATION captures enum value "BUSINESS_LOCATION".

BusinessAppointmentSettingsBookingLocationTypeCUSTOMERLOCATION captures enum value "CUSTOMER_LOCATION".

BusinessAppointmentSettingsBookingLocationTypePHONE captures enum value "PHONE".

BusinessAppointmentSettingsCancellationPolicyCANCELLATIONTREATEDASNOSHOW captures enum value "CANCELLATION_TREATED_AS_NO_SHOW".

BusinessAppointmentSettingsCancellationPolicyCUSTOMPOLICY captures enum value "CUSTOM_POLICY".

BusinessAppointmentSettingsMaxAppointmentsPerDayLimitTypePERLOCATION captures enum value "PER_LOCATION".

BusinessAppointmentSettingsMaxAppointmentsPerDayLimitTypePERTEAMMEMBER captures enum value "PER_TEAM_MEMBER".

BusinessBookingProfileBookingPolicyACCEPTALL captures enum value "ACCEPT_ALL".

BusinessBookingProfileBookingPolicyREQUIRESACCEPTANCE captures enum value "REQUIRES_ACCEPTANCE".

BusinessBookingProfileCustomerTimezoneChoiceBUSINESSLOCATIONTIMEZONE captures enum value "BUSINESS_LOCATION_TIMEZONE".

BusinessBookingProfileCustomerTimezoneChoiceCUSTOMERCHOICE captures enum value "CUSTOMER_CHOICE".

CardBrandAMERICANEXPRESS captures enum value "AMERICAN_EXPRESS".

CardBrandCHINAUNIONPAY captures enum value "CHINA_UNIONPAY".

CardBrandDISCOVER captures enum value "DISCOVER".

CardBrandDISCOVERDINERS captures enum value "DISCOVER_DINERS".

CardBrandEFTPOS captures enum value "EFTPOS".

CardBrandFELICA captures enum value "FELICA".

CardBrandINTERAC captures enum value "INTERAC".

CardBrandJCB captures enum value "JCB".

CardBrandMASTERCARD captures enum value "MASTERCARD".

CardBrandOTHERBRAND captures enum value "OTHER_BRAND".

CardBrandSQUARECAPITALCARD captures enum value "SQUARE_CAPITAL_CARD".

CardBrandSQUAREGIFTCARD captures enum value "SQUARE_GIFT_CARD".

CardBrandVISA captures enum value "VISA".

CardPrepaidTypeNOTPREPAID captures enum value "NOT_PREPAID".

CardPrepaidTypePREPAID captures enum value "PREPAID".

CardPrepaidTypeUNKNOWNPREPAIDTYPE captures enum value "UNKNOWN_PREPAID_TYPE".

CardSquareProductBUYERDASHBOARD captures enum value "BUYER_DASHBOARD".

CardSquareProductCONNECTAPI captures enum value "CONNECT_API".

CardSquareProductDASHBOARD captures enum value "DASHBOARD".

CardSquareProductGIFTCARD captures enum value "GIFT_CARD".

CardSquareProductINVOICES captures enum value "INVOICES".

CardSquareProductREADERSDK captures enum value "READER_SDK".

CardSquareProductREGISTERCLIENT captures enum value "REGISTER_CLIENT".

CardSquareProductUNKNOWNSQUAREPRODUCT captures enum value "UNKNOWN_SQUARE_PRODUCT".

CardSquareProductVIRTUALTERMINAL captures enum value "VIRTUAL_TERMINAL".

CardSquareProductWEB captures enum value "WEB".

CardTypeCREDIT captures enum value "CREDIT".

CardTypeDEBIT captures enum value "DEBIT".

CardTypeUNKNOWNCARDTYPE captures enum value "UNKNOWN_CARD_TYPE".

CashDrawerEventTypeCASHTENDERCANCELLEDPAYMENT captures enum value "CASH_TENDER_CANCELLED_PAYMENT".

CashDrawerEventTypeCASHTENDERPAYMENT captures enum value "CASH_TENDER_PAYMENT".

CashDrawerEventTypeCASHTENDERREFUND captures enum value "CASH_TENDER_REFUND".

CashDrawerEventTypeNOSALE captures enum value "NO_SALE".

CashDrawerEventTypeOTHERTENDERCANCELLEDPAYMENT captures enum value "OTHER_TENDER_CANCELLED_PAYMENT".

CashDrawerEventTypeOTHERTENDERPAYMENT captures enum value "OTHER_TENDER_PAYMENT".

CashDrawerEventTypeOTHERTENDERREFUND captures enum value "OTHER_TENDER_REFUND".

CashDrawerEventTypePAIDIN captures enum value "PAID_IN".

CashDrawerEventTypePAIDOUT captures enum value "PAID_OUT".

CashDrawerShiftStateCLOSED captures enum value "CLOSED".

CashDrawerShiftStateENDED captures enum value "ENDED".

CashDrawerShiftStateOPEN captures enum value "OPEN".

CatalogCustomAttributeDefinitionAppVisibilityAPPVISIBILITYHIDDEN captures enum value "APP_VISIBILITY_HIDDEN".

CatalogCustomAttributeDefinitionAppVisibilityAPPVISIBILITYREADONLY captures enum value "APP_VISIBILITY_READ_ONLY".

CatalogCustomAttributeDefinitionAppVisibilityAPPVISIBILITYREADWRITEVALUES captures enum value "APP_VISIBILITY_READ_WRITE_VALUES".

CatalogCustomAttributeDefinitionSellerVisibilitySELLERVISIBILITYHIDDEN captures enum value "SELLER_VISIBILITY_HIDDEN".

CatalogCustomAttributeDefinitionSellerVisibilitySELLERVISIBILITYREADWRITEVALUES captures enum value "SELLER_VISIBILITY_READ_WRITE_VALUES".

CatalogCustomAttributeDefinitionTypeBOOLEAN captures enum value "BOOLEAN".

CatalogCustomAttributeDefinitionTypeNUMBER captures enum value "NUMBER".

CatalogCustomAttributeDefinitionTypeSELECTION captures enum value "SELECTION".

CatalogCustomAttributeDefinitionTypeSTRING captures enum value "STRING".

CatalogDiscountModifyTaxBasisDONOTMODIFYTAXBASIS captures enum value "DO_NOT_MODIFY_TAX_BASIS".

CatalogDiscountModifyTaxBasisMODIFYTAXBASIS captures enum value "MODIFY_TAX_BASIS".

CatalogDiscountTypeFIXEDAMOUNT captures enum value "FIXED_AMOUNT".

CatalogDiscountTypeFIXEDPERCENTAGE captures enum value "FIXED_PERCENTAGE".

CatalogDiscountTypeVARIABLEAMOUNT captures enum value "VARIABLE_AMOUNT".

CatalogDiscountTypeVARIABLEPERCENTAGE captures enum value "VARIABLE_PERCENTAGE".

CatalogItemProductTypeAPPOINTMENTSSERVICE captures enum value "APPOINTMENTS_SERVICE".

CatalogItemProductTypeGIFTCARD captures enum value "GIFT_CARD".

CatalogItemProductTypeREGULAR captures enum value "REGULAR".

CatalogModifierListSelectionTypeMULTIPLE captures enum value "MULTIPLE".

CatalogModifierListSelectionTypeSINGLE captures enum value "SINGLE".

CatalogObjectTypeCATEGORY captures enum value "CATEGORY".

CatalogObjectTypeCUSTOMATTRIBUTEDEFINITION captures enum value "CUSTOM_ATTRIBUTE_DEFINITION".

CatalogObjectTypeDISCOUNT captures enum value "DISCOUNT".

CatalogObjectTypeIMAGE captures enum value "IMAGE".

CatalogObjectTypeITEM captures enum value "ITEM".

CatalogObjectTypeITEMOPTION captures enum value "ITEM_OPTION".

CatalogObjectTypeITEMOPTIONVAL captures enum value "ITEM_OPTION_VAL".

CatalogObjectTypeITEMVARIATION captures enum value "ITEM_VARIATION".

CatalogObjectTypeMEASUREMENTUNIT captures enum value "MEASUREMENT_UNIT".

CatalogObjectTypeMODIFIER captures enum value "MODIFIER".

CatalogObjectTypeMODIFIERLIST captures enum value "MODIFIER_LIST".

CatalogObjectTypePRICINGRULE captures enum value "PRICING_RULE".

CatalogObjectTypePRODUCTSET captures enum value "PRODUCT_SET".

CatalogObjectTypeQUICKAMOUNTSSETTINGS captures enum value "QUICK_AMOUNTS_SETTINGS".

CatalogObjectTypeSUBSCRIPTIONPLAN captures enum value "SUBSCRIPTION_PLAN".

CatalogObjectTypeTAX captures enum value "TAX".

CatalogObjectTypeTIMEPERIOD captures enum value "TIME_PERIOD".

CatalogPricingTypeFIXEDPRICING captures enum value "FIXED_PRICING".

CatalogPricingTypeVARIABLEPRICING captures enum value "VARIABLE_PRICING".

CatalogQuickAmountsSettingsOptionAUTO captures enum value "AUTO".

CatalogQuickAmountsSettingsOptionDISABLED captures enum value "DISABLED".

CatalogQuickAmountsSettingsOptionMANUAL captures enum value "MANUAL".

CatalogQuickAmountTypeQUICKAMOUNTTYPEAUTO captures enum value "QUICK_AMOUNT_TYPE_AUTO".

CatalogQuickAmountTypeQUICKAMOUNTTYPEMANUAL captures enum value "QUICK_AMOUNT_TYPE_MANUAL".

CountryAD captures enum value "AD".

CountryAE captures enum value "AE".

CountryAF captures enum value "AF".

CountryAG captures enum value "AG".

CountryAI captures enum value "AI".

CountryAL captures enum value "AL".

CountryAM captures enum value "AM".

CountryAO captures enum value "AO".

CountryAQ captures enum value "AQ".

CountryAR captures enum value "AR".

CountryAS captures enum value "AS".

CountryAT captures enum value "AT".

CountryAU captures enum value "AU".

CountryAW captures enum value "AW".

CountryAX captures enum value "AX".

CountryAZ captures enum value "AZ".

CountryBA captures enum value "BA".

CountryBB captures enum value "BB".

CountryBD captures enum value "BD".

CountryBE captures enum value "BE".

CountryBF captures enum value "BF".

CountryBG captures enum value "BG".

CountryBH captures enum value "BH".

CountryBI captures enum value "BI".

CountryBJ captures enum value "BJ".

CountryBL captures enum value "BL".

CountryBM captures enum value "BM".

CountryBN captures enum value "BN".

CountryBO captures enum value "BO".

CountryBQ captures enum value "BQ".

CountryBR captures enum value "BR".

CountryBS captures enum value "BS".

CountryBT captures enum value "BT".

CountryBV captures enum value "BV".

CountryBW captures enum value "BW".

CountryBY captures enum value "BY".

CountryBZ captures enum value "BZ".

CountryCA captures enum value "CA".

CountryCC captures enum value "CC".

CountryCD captures enum value "CD".

CountryCF captures enum value "CF".

CountryCG captures enum value "CG".

CountryCH captures enum value "CH".

CountryCI captures enum value "CI".

CountryCK captures enum value "CK".

CountryCL captures enum value "CL".

CountryCM captures enum value "CM".

CountryCN captures enum value "CN".

CountryCO captures enum value "CO".

CountryCR captures enum value "CR".

CountryCU captures enum value "CU".

CountryCV captures enum value "CV".

CountryCW captures enum value "CW".

CountryCX captures enum value "CX".

CountryCY captures enum value "CY".

CountryCZ captures enum value "CZ".

CountryDE captures enum value "DE".

CountryDJ captures enum value "DJ".

CountryDK captures enum value "DK".

CountryDM captures enum value "DM".

CountryDO captures enum value "DO".

CountryDZ captures enum value "DZ".

CountryEC captures enum value "EC".

CountryEE captures enum value "EE".

CountryEG captures enum value "EG".

CountryEH captures enum value "EH".

CountryER captures enum value "ER".

CountryES captures enum value "ES".

CountryET captures enum value "ET".

CountryFI captures enum value "FI".

CountryFJ captures enum value "FJ".

CountryFK captures enum value "FK".

CountryFM captures enum value "FM".

CountryFO captures enum value "FO".

CountryFR captures enum value "FR".

CountryGA captures enum value "GA".

CountryGB captures enum value "GB".

CountryGD captures enum value "GD".

CountryGE captures enum value "GE".

CountryGF captures enum value "GF".

CountryGG captures enum value "GG".

CountryGH captures enum value "GH".

CountryGI captures enum value "GI".

CountryGL captures enum value "GL".

CountryGM captures enum value "GM".

CountryGN captures enum value "GN".

CountryGP captures enum value "GP".

CountryGQ captures enum value "GQ".

CountryGR captures enum value "GR".

CountryGS captures enum value "GS".

CountryGT captures enum value "GT".

CountryGU captures enum value "GU".

CountryGW captures enum value "GW".

CountryGY captures enum value "GY".

CountryHK captures enum value "HK".

CountryHM captures enum value "HM".

CountryHN captures enum value "HN".

CountryHR captures enum value "HR".

CountryHT captures enum value "HT".

CountryHU captures enum value "HU".

CountryID captures enum value "ID".

CountryIE captures enum value "IE".

CountryIL captures enum value "IL".

CountryIM captures enum value "IM".

CountryIN captures enum value "IN".

CountryIO captures enum value "IO".

CountryIQ captures enum value "IQ".

CountryIR captures enum value "IR".

CountryIS captures enum value "IS".

CountryIT captures enum value "IT".

CountryJE captures enum value "JE".

CountryJM captures enum value "JM".

CountryJO captures enum value "JO".

CountryJP captures enum value "JP".

CountryKE captures enum value "KE".

CountryKG captures enum value "KG".

CountryKH captures enum value "KH".

CountryKI captures enum value "KI".

CountryKM captures enum value "KM".

CountryKN captures enum value "KN".

CountryKP captures enum value "KP".

CountryKR captures enum value "KR".

CountryKW captures enum value "KW".

CountryKY captures enum value "KY".

CountryKZ captures enum value "KZ".

CountryLA captures enum value "LA".

CountryLB captures enum value "LB".

CountryLC captures enum value "LC".

CountryLI captures enum value "LI".

CountryLK captures enum value "LK".

CountryLR captures enum value "LR".

CountryLS captures enum value "LS".

CountryLT captures enum value "LT".

CountryLU captures enum value "LU".

CountryLV captures enum value "LV".

CountryLY captures enum value "LY".

CountryMA captures enum value "MA".

CountryMC captures enum value "MC".

CountryMD captures enum value "MD".

CountryME captures enum value "ME".

CountryMF captures enum value "MF".

CountryMG captures enum value "MG".

CountryMH captures enum value "MH".

CountryMK captures enum value "MK".

CountryML captures enum value "ML".

CountryMM captures enum value "MM".

CountryMN captures enum value "MN".

CountryMO captures enum value "MO".

CountryMP captures enum value "MP".

CountryMQ captures enum value "MQ".

CountryMR captures enum value "MR".

CountryMS captures enum value "MS".

CountryMT captures enum value "MT".

CountryMU captures enum value "MU".

CountryMV captures enum value "MV".

CountryMW captures enum value "MW".

CountryMX captures enum value "MX".

CountryMY captures enum value "MY".

CountryMZ captures enum value "MZ".

CountryNA captures enum value "NA".

CountryNC captures enum value "NC".

CountryNE captures enum value "NE".

CountryNF captures enum value "NF".

CountryNG captures enum value "NG".

CountryNI captures enum value "NI".

CountryNL captures enum value "NL".

CountryNO captures enum value "NO".

CountryNP captures enum value "NP".

CountryNR captures enum value "NR".

CountryNU captures enum value "NU".

CountryNZ captures enum value "NZ".

CountryOM captures enum value "OM".

CountryPA captures enum value "PA".

CountryPE captures enum value "PE".

CountryPF captures enum value "PF".

CountryPG captures enum value "PG".

CountryPH captures enum value "PH".

CountryPK captures enum value "PK".

CountryPL captures enum value "PL".

CountryPM captures enum value "PM".

CountryPN captures enum value "PN".

CountryPR captures enum value "PR".

CountryPS captures enum value "PS".

CountryPT captures enum value "PT".

CountryPW captures enum value "PW".

CountryPY captures enum value "PY".

CountryQA captures enum value "QA".

CountryRE captures enum value "RE".

CountryRO captures enum value "RO".

CountryRS captures enum value "RS".

CountryRU captures enum value "RU".

CountryRW captures enum value "RW".

CountrySA captures enum value "SA".

CountrySB captures enum value "SB".

CountrySC captures enum value "SC".

CountrySD captures enum value "SD".

CountrySE captures enum value "SE".

CountrySG captures enum value "SG".

CountrySH captures enum value "SH".

CountrySI captures enum value "SI".

CountrySJ captures enum value "SJ".

CountrySK captures enum value "SK".

CountrySL captures enum value "SL".

CountrySM captures enum value "SM".

CountrySN captures enum value "SN".

CountrySO captures enum value "SO".

CountrySR captures enum value "SR".

CountrySS captures enum value "SS".

CountryST captures enum value "ST".

CountrySV captures enum value "SV".

CountrySX captures enum value "SX".

CountrySY captures enum value "SY".

CountrySZ captures enum value "SZ".

CountryTC captures enum value "TC".

CountryTD captures enum value "TD".

CountryTF captures enum value "TF".

CountryTG captures enum value "TG".

CountryTH captures enum value "TH".

CountryTJ captures enum value "TJ".

CountryTK captures enum value "TK".

CountryTL captures enum value "TL".

CountryTM captures enum value "TM".

CountryTN captures enum value "TN".

CountryTO captures enum value "TO".

CountryTR captures enum value "TR".

CountryTT captures enum value "TT".

CountryTV captures enum value "TV".

CountryTW captures enum value "TW".

CountryTZ captures enum value "TZ".

CountryUA captures enum value "UA".

CountryUG captures enum value "UG".

CountryUM captures enum value "UM".

CountryUS captures enum value "US".

CountryUY captures enum value "UY".

CountryUZ captures enum value "UZ".

CountryVA captures enum value "VA".

CountryVC captures enum value "VC".

CountryVE captures enum value "VE".

CountryVG captures enum value "VG".

CountryVI captures enum value "VI".

CountryVN captures enum value "VN".

CountryVU captures enum value "VU".

CountryWF captures enum value "WF".

CountryWS captures enum value "WS".

CountryYE captures enum value "YE".

CountryYT captures enum value "YT".

CountryZA captures enum value "ZA".

CountryZM captures enum value "ZM".

CountryZW captures enum value "ZW".

CountryZZ captures enum value "ZZ".

CurrencyAED captures enum value "AED".

CurrencyAFN captures enum value "AFN".

CurrencyALL captures enum value "ALL".

CurrencyAMD captures enum value "AMD".

CurrencyANG captures enum value "ANG".

CurrencyAOA captures enum value "AOA".

CurrencyARS captures enum value "ARS".

CurrencyAUD captures enum value "AUD".

CurrencyAWG captures enum value "AWG".

CurrencyAZN captures enum value "AZN".

CurrencyBAM captures enum value "BAM".

CurrencyBBD captures enum value "BBD".

CurrencyBDT captures enum value "BDT".

CurrencyBGN captures enum value "BGN".

CurrencyBHD captures enum value "BHD".

CurrencyBIF captures enum value "BIF".

CurrencyBMD captures enum value "BMD".

CurrencyBND captures enum value "BND".

CurrencyBOB captures enum value "BOB".

CurrencyBOV captures enum value "BOV".

CurrencyBRL captures enum value "BRL".

CurrencyBSD captures enum value "BSD".

CurrencyBTC captures enum value "BTC".

CurrencyBTN captures enum value "BTN".

CurrencyBWP captures enum value "BWP".

CurrencyBYR captures enum value "BYR".

CurrencyBZD captures enum value "BZD".

CurrencyCAD captures enum value "CAD".

CurrencyCDF captures enum value "CDF".

CurrencyCHE captures enum value "CHE".

CurrencyCHF captures enum value "CHF".

CurrencyCHW captures enum value "CHW".

CurrencyCLF captures enum value "CLF".

CurrencyCLP captures enum value "CLP".

CurrencyCNY captures enum value "CNY".

CurrencyCOP captures enum value "COP".

CurrencyCOU captures enum value "COU".

CurrencyCRC captures enum value "CRC".

CurrencyCUC captures enum value "CUC".

CurrencyCUP captures enum value "CUP".

CurrencyCVE captures enum value "CVE".

CurrencyCZK captures enum value "CZK".

CurrencyDJF captures enum value "DJF".

CurrencyDKK captures enum value "DKK".

CurrencyDOP captures enum value "DOP".

CurrencyDZD captures enum value "DZD".

CurrencyEGP captures enum value "EGP".

CurrencyERN captures enum value "ERN".

CurrencyETB captures enum value "ETB".

CurrencyEUR captures enum value "EUR".

CurrencyFJD captures enum value "FJD".

CurrencyFKP captures enum value "FKP".

CurrencyGBP captures enum value "GBP".

CurrencyGEL captures enum value "GEL".

CurrencyGHS captures enum value "GHS".

CurrencyGIP captures enum value "GIP".

CurrencyGMD captures enum value "GMD".

CurrencyGNF captures enum value "GNF".

CurrencyGTQ captures enum value "GTQ".

CurrencyGYD captures enum value "GYD".

CurrencyHKD captures enum value "HKD".

CurrencyHNL captures enum value "HNL".

CurrencyHRK captures enum value "HRK".

CurrencyHTG captures enum value "HTG".

CurrencyHUF captures enum value "HUF".

CurrencyIDR captures enum value "IDR".

CurrencyILS captures enum value "ILS".

CurrencyINR captures enum value "INR".

CurrencyIQD captures enum value "IQD".

CurrencyIRR captures enum value "IRR".

CurrencyISK captures enum value "ISK".

CurrencyJMD captures enum value "JMD".

CurrencyJOD captures enum value "JOD".

CurrencyJPY captures enum value "JPY".

CurrencyKES captures enum value "KES".

CurrencyKGS captures enum value "KGS".

CurrencyKHR captures enum value "KHR".

CurrencyKMF captures enum value "KMF".

CurrencyKPW captures enum value "KPW".

CurrencyKRW captures enum value "KRW".

CurrencyKWD captures enum value "KWD".

CurrencyKYD captures enum value "KYD".

CurrencyKZT captures enum value "KZT".

CurrencyLAK captures enum value "LAK".

CurrencyLBP captures enum value "LBP".

CurrencyLKR captures enum value "LKR".

CurrencyLRD captures enum value "LRD".

CurrencyLSL captures enum value "LSL".

CurrencyLTL captures enum value "LTL".

CurrencyLVL captures enum value "LVL".

CurrencyLYD captures enum value "LYD".

CurrencyMAD captures enum value "MAD".

CurrencyMDL captures enum value "MDL".

CurrencyMGA captures enum value "MGA".

CurrencyMKD captures enum value "MKD".

CurrencyMMK captures enum value "MMK".

CurrencyMNT captures enum value "MNT".

CurrencyMOP captures enum value "MOP".

CurrencyMRO captures enum value "MRO".

CurrencyMUR captures enum value "MUR".

CurrencyMVR captures enum value "MVR".

CurrencyMWK captures enum value "MWK".

CurrencyMXN captures enum value "MXN".

CurrencyMXV captures enum value "MXV".

CurrencyMYR captures enum value "MYR".

CurrencyMZN captures enum value "MZN".

CurrencyNAD captures enum value "NAD".

CurrencyNGN captures enum value "NGN".

CurrencyNIO captures enum value "NIO".

CurrencyNOK captures enum value "NOK".

CurrencyNPR captures enum value "NPR".

CurrencyNZD captures enum value "NZD".

CurrencyOMR captures enum value "OMR".

CurrencyPAB captures enum value "PAB".

CurrencyPEN captures enum value "PEN".

CurrencyPGK captures enum value "PGK".

CurrencyPHP captures enum value "PHP".

CurrencyPKR captures enum value "PKR".

CurrencyPLN captures enum value "PLN".

CurrencyPYG captures enum value "PYG".

CurrencyQAR captures enum value "QAR".

CurrencyRON captures enum value "RON".

CurrencyRSD captures enum value "RSD".

CurrencyRUB captures enum value "RUB".

CurrencyRWF captures enum value "RWF".

CurrencySAR captures enum value "SAR".

CurrencySBD captures enum value "SBD".

CurrencySCR captures enum value "SCR".

CurrencySDG captures enum value "SDG".

CurrencySEK captures enum value "SEK".

CurrencySGD captures enum value "SGD".

CurrencySHP captures enum value "SHP".

CurrencySLL captures enum value "SLL".

CurrencySOS captures enum value "SOS".

CurrencySRD captures enum value "SRD".

CurrencySSP captures enum value "SSP".

CurrencySTD captures enum value "STD".

CurrencySVC captures enum value "SVC".

CurrencySYP captures enum value "SYP".

CurrencySZL captures enum value "SZL".

CurrencyTHB captures enum value "THB".

CurrencyTJS captures enum value "TJS".

CurrencyTMT captures enum value "TMT".

CurrencyTND captures enum value "TND".

CurrencyTOP captures enum value "TOP".

CurrencyTRY captures enum value "TRY".

CurrencyTTD captures enum value "TTD".

CurrencyTWD captures enum value "TWD".

CurrencyTZS captures enum value "TZS".

CurrencyUAH captures enum value "UAH".

CurrencyUGX captures enum value "UGX".

CurrencyUNKNOWNCURRENCY captures enum value "UNKNOWN_CURRENCY".

CurrencyUSD captures enum value "USD".

CurrencyUSN captures enum value "USN".

CurrencyUSS captures enum value "USS".

CurrencyUYI captures enum value "UYI".

CurrencyUYU captures enum value "UYU".

CurrencyUZS captures enum value "UZS".

CurrencyVEF captures enum value "VEF".

CurrencyVND captures enum value "VND".

CurrencyVUV captures enum value "VUV".

CurrencyWST captures enum value "WST".

CurrencyXAF captures enum value "XAF".

CurrencyXAG captures enum value "XAG".

CurrencyXAU captures enum value "XAU".

CurrencyXBA captures enum value "XBA".

CurrencyXBB captures enum value "XBB".

CurrencyXBC captures enum value "XBC".

CurrencyXBD captures enum value "XBD".

CurrencyXCD captures enum value "XCD".

CurrencyXDR captures enum value "XDR".

CurrencyXOF captures enum value "XOF".

CurrencyXPD captures enum value "XPD".

CurrencyXPF captures enum value "XPF".

CurrencyXPT captures enum value "XPT".

CurrencyXTS captures enum value "XTS".

CurrencyXXX captures enum value "XXX".

CurrencyYER captures enum value "YER".

CurrencyZAR captures enum value "ZAR".

CurrencyZMK captures enum value "ZMK".

CurrencyZMW captures enum value "ZMW".

CustomerCreationSourceAPPOINTMENTS captures enum value "APPOINTMENTS".

CustomerCreationSourceCOUPON captures enum value "COUPON".

CustomerCreationSourceDELETIONRECOVERY captures enum value "DELETION_RECOVERY".

CustomerCreationSourceDIRECTORY captures enum value "DIRECTORY".

CustomerCreationSourceEGIFTING captures enum value "EGIFTING".

CustomerCreationSourceEMAILCOLLECTION captures enum value "EMAIL_COLLECTION".

CustomerCreationSourceFEEDBACK captures enum value "FEEDBACK".

CustomerCreationSourceIMPORT captures enum value "IMPORT".

CustomerCreationSourceINSTANTPROFILE captures enum value "INSTANT_PROFILE".

CustomerCreationSourceINVOICES captures enum value "INVOICES".

CustomerCreationSourceLOYALTY captures enum value "LOYALTY".

CustomerCreationSourceMARKETING captures enum value "MARKETING".

CustomerCreationSourceMERGE captures enum value "MERGE".

CustomerCreationSourceONLINESTORE captures enum value "ONLINE_STORE".

CustomerCreationSourceOTHER captures enum value "OTHER".

CustomerCreationSourceTERMINAL captures enum value "TERMINAL".

CustomerCreationSourceTHIRDPARTY captures enum value "THIRD_PARTY".

CustomerCreationSourceTHIRDPARTYIMPORT captures enum value "THIRD_PARTY_IMPORT".

CustomerCreationSourceUNMERGERECOVERY captures enum value "UNMERGE_RECOVERY".

CustomerInclusionExclusionEXCLUDE captures enum value "EXCLUDE".

CustomerInclusionExclusionINCLUDE captures enum value "INCLUDE".

CustomerSortFieldCREATEDAT captures enum value "CREATED_AT".

CustomerSortFieldDEFAULT captures enum value "DEFAULT".

DayOfWeekFRI captures enum value "FRI".

DayOfWeekMON captures enum value "MON".

DayOfWeekSAT captures enum value "SAT".

DayOfWeekSUN captures enum value "SUN".

DayOfWeekTHU captures enum value "THU".

DayOfWeekTUE captures enum value "TUE".

DayOfWeekWED captures enum value "WED".

DeviceCodeStatusEXPIRED captures enum value "EXPIRED".

DeviceCodeStatusPAIRED captures enum value "PAIRED".

DeviceCodeStatusUNKNOWN captures enum value "UNKNOWN".

DeviceCodeStatusUNPAIRED captures enum value "UNPAIRED".

DisputeEvidenceTypeAUTHORIZATIONDOCUMENTATION captures enum value "AUTHORIZATION_DOCUMENTATION".

DisputeEvidenceTypeCANCELLATIONORREFUNDDOCUMENTATION captures enum value "CANCELLATION_OR_REFUND_DOCUMENTATION".

DisputeEvidenceTypeCARDHOLDERCOMMUNICATION captures enum value "CARDHOLDER_COMMUNICATION".

DisputeEvidenceTypeCARDHOLDERINFORMATION captures enum value "CARDHOLDER_INFORMATION".

DisputeEvidenceTypeDUPLICATECHARGEDOCUMENTATION captures enum value "DUPLICATE_CHARGE_DOCUMENTATION".

DisputeEvidenceTypeGENERICEVIDENCE captures enum value "GENERIC_EVIDENCE".

DisputeEvidenceTypeONLINEORAPPACCESSLOG captures enum value "ONLINE_OR_APP_ACCESS_LOG".

DisputeEvidenceTypePRODUCTORSERVICEDESCRIPTION captures enum value "PRODUCT_OR_SERVICE_DESCRIPTION".

DisputeEvidenceTypePROOFOFDELIVERYDOCUMENTATION captures enum value "PROOF_OF_DELIVERY_DOCUMENTATION".

DisputeEvidenceTypePURCHASEACKNOWLEDGEMENT captures enum value "PURCHASE_ACKNOWLEDGEMENT".

DisputeEvidenceTypeREBUTTALEXPLANATION captures enum value "REBUTTAL_EXPLANATION".

DisputeEvidenceTypeRECEIPT captures enum value "RECEIPT".

DisputeEvidenceTypeRELATEDTRANSACTIONDOCUMENTATION captures enum value "RELATED_TRANSACTION_DOCUMENTATION".

DisputeEvidenceTypeSERVICERECEIVEDDOCUMENTATION captures enum value "SERVICE_RECEIVED_DOCUMENTATION".

DisputeEvidenceTypeTRACKINGNUMBER captures enum value "TRACKING_NUMBER".

DisputeReasonAMOUNTDIFFERS captures enum value "AMOUNT_DIFFERS".

DisputeReasonCANCELLED captures enum value "CANCELLED".

DisputeReasonCUSTOMERREQUESTSCREDIT captures enum value "CUSTOMER_REQUESTS_CREDIT".

DisputeReasonDUPLICATE captures enum value "DUPLICATE".

DisputeReasonEMVLIABILITYSHIFT captures enum value "EMV_LIABILITY_SHIFT".

DisputeReasonNOKNOWLEDGE captures enum value "NO_KNOWLEDGE".

DisputeReasonNOTASDESCRIBED captures enum value "NOT_AS_DESCRIBED".

DisputeReasonNOTRECEIVED captures enum value "NOT_RECEIVED".

DisputeReasonPAIDBYOTHERMEANS captures enum value "PAID_BY_OTHER_MEANS".

DisputeStateACCEPTED captures enum value "ACCEPTED".

DisputeStateEVIDENCEREQUIRED captures enum value "EVIDENCE_REQUIRED".

DisputeStateINQUIRYCLOSED captures enum value "INQUIRY_CLOSED".

DisputeStateINQUIRYEVIDENCEREQUIRED captures enum value "INQUIRY_EVIDENCE_REQUIRED".

DisputeStateINQUIRYPROCESSING captures enum value "INQUIRY_PROCESSING".

DisputeStateLOST captures enum value "LOST".

DisputeStatePROCESSING captures enum value "PROCESSING".

DisputeStateUNKNOWNSTATE captures enum value "UNKNOWN_STATE".

DisputeStateWAITINGTHIRDPARTY captures enum value "WAITING_THIRD_PARTY".

DisputeStateWON captures enum value "WON".

EcomVisibilityHIDDEN captures enum value "HIDDEN".

EcomVisibilityUNAVAILABLE captures enum value "UNAVAILABLE".

EcomVisibilityUNINDEXED captures enum value "UNINDEXED".

EcomVisibilityVISIBLE captures enum value "VISIBLE".

EmployeeStatusACTIVE captures enum value "ACTIVE".

EmployeeStatusINACTIVE captures enum value "INACTIVE".

ErrorCategoryAPIERROR captures enum value "API_ERROR".

ErrorCategoryAUTHENTICATIONERROR captures enum value "AUTHENTICATION_ERROR".

ErrorCategoryINVALIDREQUESTERROR captures enum value "INVALID_REQUEST_ERROR".

ErrorCategoryPAYMENTMETHODERROR captures enum value "PAYMENT_METHOD_ERROR".

ErrorCategoryRATELIMITERROR captures enum value "RATE_LIMIT_ERROR".

ErrorCategoryREFUNDERROR captures enum value "REFUND_ERROR".

ErrorCodeACCESSTOKENEXPIRED captures enum value "ACCESS_TOKEN_EXPIRED".

ErrorCodeACCESSTOKENREVOKED captures enum value "ACCESS_TOKEN_REVOKED".

ErrorCodeADDRESSVERIFICATIONFAILURE captures enum value "ADDRESS_VERIFICATION_FAILURE".

ErrorCodeALLOWABLEPINTRIESEXCEEDED captures enum value "ALLOWABLE_PIN_TRIES_EXCEEDED".

ErrorCodeAMOUNTTOOHIGH captures enum value "AMOUNT_TOO_HIGH".

ErrorCodeAPIVERSIONINCOMPATIBLE captures enum value "API_VERSION_INCOMPATIBLE".

ErrorCodeAPPLEPAYMENTPROCESSINGCERTIFICATEHASHNOTFOUND captures enum value "APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND".

ErrorCodeAPPLICATIONDISABLED captures enum value "APPLICATION_DISABLED".

ErrorCodeARRAYEMPTY captures enum value "ARRAY_EMPTY".

ErrorCodeARRAYLENGTHTOOLONG captures enum value "ARRAY_LENGTH_TOO_LONG".

ErrorCodeARRAYLENGTHTOOSHORT captures enum value "ARRAY_LENGTH_TOO_SHORT".

ErrorCodeBADCERTIFICATE captures enum value "BAD_CERTIFICATE".

ErrorCodeBADEXPIRATION captures enum value "BAD_EXPIRATION".

ErrorCodeBADGATEWAY captures enum value "BAD_GATEWAY".

ErrorCodeBADREQUEST captures enum value "BAD_REQUEST".

ErrorCodeCARDDECLINED captures enum value "CARD_DECLINED".

ErrorCodeCARDDECLINEDCALLISSUER captures enum value "CARD_DECLINED_CALL_ISSUER".

ErrorCodeCARDDECLINEDVERIFICATIONREQUIRED captures enum value "CARD_DECLINED_VERIFICATION_REQUIRED".

ErrorCodeCARDEXPIRED captures enum value "CARD_EXPIRED".

ErrorCodeCARDHOLDERINSUFFICIENTPERMISSIONS captures enum value "CARDHOLDER_INSUFFICIENT_PERMISSIONS".

ErrorCodeCARDNOTSUPPORTED captures enum value "CARD_NOT_SUPPORTED".

ErrorCodeCARDPROCESSINGNOTENABLED captures enum value "CARD_PROCESSING_NOT_ENABLED".

ErrorCodeCARDTOKENEXPIRED captures enum value "CARD_TOKEN_EXPIRED".

ErrorCodeCARDTOKENUSED captures enum value "CARD_TOKEN_USED".

ErrorCodeCHECKOUTEXPIRED captures enum value "CHECKOUT_EXPIRED".

ErrorCodeCHIPINSERTIONREQUIRED captures enum value "CHIP_INSERTION_REQUIRED".

ErrorCodeCLIENTDISABLED captures enum value "CLIENT_DISABLED".

ErrorCodeCONFLICT captures enum value "CONFLICT".

ErrorCodeCONFLICTINGPARAMETERS captures enum value "CONFLICTING_PARAMETERS".

ErrorCodeCURRENCYMISMATCH captures enum value "CURRENCY_MISMATCH".

ErrorCodeCUSTOMERNOTFOUND captures enum value "CUSTOMER_NOT_FOUND".

ErrorCodeCVVFAILURE captures enum value "CVV_FAILURE".

ErrorCodeDELAYEDTRANSACTIONCANCELED captures enum value "DELAYED_TRANSACTION_CANCELED".

ErrorCodeDELAYEDTRANSACTIONCAPTURED captures enum value "DELAYED_TRANSACTION_CAPTURED".

ErrorCodeDELAYEDTRANSACTIONEXPIRED captures enum value "DELAYED_TRANSACTION_EXPIRED".

ErrorCodeDELAYEDTRANSACTIONFAILED captures enum value "DELAYED_TRANSACTION_FAILED".

ErrorCodeEXPECTEDARRAY captures enum value "EXPECTED_ARRAY".

ErrorCodeEXPECTEDBASE64ENCODEDBYTEARRAY captures enum value "EXPECTED_BASE64_ENCODED_BYTE_ARRAY".

ErrorCodeEXPECTEDBOOLEAN captures enum value "EXPECTED_BOOLEAN".

ErrorCodeEXPECTEDFLOAT captures enum value "EXPECTED_FLOAT".

ErrorCodeEXPECTEDINTEGER captures enum value "EXPECTED_INTEGER".

ErrorCodeEXPECTEDJSONBODY captures enum value "EXPECTED_JSON_BODY".

ErrorCodeEXPECTEDMAP captures enum value "EXPECTED_MAP".

ErrorCodeEXPECTEDOBJECT captures enum value "EXPECTED_OBJECT".

ErrorCodeEXPECTEDSTRING captures enum value "EXPECTED_STRING".

ErrorCodeEXPIRATIONFAILURE captures enum value "EXPIRATION_FAILURE".

ErrorCodeFORBIDDEN captures enum value "FORBIDDEN".

ErrorCodeGATEWAYTIMEOUT captures enum value "GATEWAY_TIMEOUT".

ErrorCodeGENERICDECLINE captures enum value "GENERIC_DECLINE".

ErrorCodeGIFTCARDAVAILABLEAMOUNT captures enum value "GIFT_CARD_AVAILABLE_AMOUNT".

ErrorCodeGONE captures enum value "GONE".

ErrorCodeIDEMPOTENCYKEYREUSED captures enum value "IDEMPOTENCY_KEY_REUSED".

ErrorCodeINCORRECTTYPE captures enum value "INCORRECT_TYPE".

ErrorCodeINSUFFICIENTFUNDS captures enum value "INSUFFICIENT_FUNDS".

ErrorCodeINSUFFICIENTPERMISSIONS captures enum value "INSUFFICIENT_PERMISSIONS".

ErrorCodeINSUFFICIENTSCOPES captures enum value "INSUFFICIENT_SCOPES".

ErrorCodeINTERNALSERVERERROR captures enum value "INTERNAL_SERVER_ERROR".

ErrorCodeINVALIDACCOUNT captures enum value "INVALID_ACCOUNT".

ErrorCodeINVALIDARRAYVALUE captures enum value "INVALID_ARRAY_VALUE".

ErrorCodeINVALIDCARD captures enum value "INVALID_CARD".

ErrorCodeINVALIDCARDDATA captures enum value "INVALID_CARD_DATA".

ErrorCodeINVALIDCONTENTTYPE captures enum value "INVALID_CONTENT_TYPE".

ErrorCodeINVALIDCURSOR captures enum value "INVALID_CURSOR".

ErrorCodeINVALIDEMAILADDRESS captures enum value "INVALID_EMAIL_ADDRESS".

ErrorCodeINVALIDENCRYPTEDCARD captures enum value "INVALID_ENCRYPTED_CARD".

ErrorCodeINVALIDENUMVALUE captures enum value "INVALID_ENUM_VALUE".

ErrorCodeINVALIDEXPIRATION captures enum value "INVALID_EXPIRATION".

ErrorCodeINVALIDEXPIRATIONDATE captures enum value "INVALID_EXPIRATION_DATE".

ErrorCodeINVALIDEXPIRATIONYEAR captures enum value "INVALID_EXPIRATION_YEAR".

ErrorCodeINVALIDFEES captures enum value "INVALID_FEES".

ErrorCodeINVALIDFORMVALUE captures enum value "INVALID_FORM_VALUE".

ErrorCodeINVALIDLOCATION captures enum value "INVALID_LOCATION".

ErrorCodeINVALIDPHONENUMBER captures enum value "INVALID_PHONE_NUMBER".

ErrorCodeINVALIDPIN captures enum value "INVALID_PIN".

ErrorCodeINVALIDPOSTALCODE captures enum value "INVALID_POSTAL_CODE".

ErrorCodeINVALIDSORTORDER captures enum value "INVALID_SORT_ORDER".

ErrorCodeINVALIDSQUAREVERSIONFORMAT captures enum value "INVALID_SQUARE_VERSION_FORMAT".

ErrorCodeINVALIDTIME captures enum value "INVALID_TIME".

ErrorCodeINVALIDTIMERANGE captures enum value "INVALID_TIME_RANGE".

ErrorCodeINVALIDVALUE captures enum value "INVALID_VALUE".

ErrorCodeLOCATIONMISMATCH captures enum value "LOCATION_MISMATCH".

ErrorCodeMANUALLYENTEREDPAYMENTNOTSUPPORTED captures enum value "MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED".

ErrorCodeMAPKEYLENGTHTOOLONG captures enum value "MAP_KEY_LENGTH_TOO_LONG".

ErrorCodeMAPKEYLENGTHTOOSHORT captures enum value "MAP_KEY_LENGTH_TOO_SHORT".

ErrorCodeMETHODNOTALLOWED captures enum value "METHOD_NOT_ALLOWED".

ErrorCodeMISSINGREQUIREDPARAMETER captures enum value "MISSING_REQUIRED_PARAMETER".

ErrorCodeNOFIELDSSET captures enum value "NO_FIELDS_SET".

ErrorCodeNOTACCEPTABLE captures enum value "NOT_ACCEPTABLE".

ErrorCodeNOTFOUND captures enum value "NOT_FOUND".

ErrorCodeNOTIMPLEMENTED captures enum value "NOT_IMPLEMENTED".

ErrorCodeONEINSTRUMENTEXPECTED captures enum value "ONE_INSTRUMENT_EXPECTED".

ErrorCodePANFAILURE captures enum value "PAN_FAILURE".

ErrorCodePAYMENTLIMITEXCEEDED captures enum value "PAYMENT_LIMIT_EXCEEDED".

ErrorCodePAYMENTNOTREFUNDABLE captures enum value "PAYMENT_NOT_REFUNDABLE".

ErrorCodeRATELIMITED captures enum value "RATE_LIMITED".

ErrorCodeREFUNDALREADYPENDING captures enum value "REFUND_ALREADY_PENDING".

ErrorCodeREFUNDAMOUNTINVALID captures enum value "REFUND_AMOUNT_INVALID".

ErrorCodeREFUNDDECLINED captures enum value "REFUND_DECLINED".

ErrorCodeREQUESTENTITYTOOLARGE captures enum value "REQUEST_ENTITY_TOO_LARGE".

ErrorCodeREQUESTTIMEOUT captures enum value "REQUEST_TIMEOUT".

ErrorCodeRESERVATIONDECLINED captures enum value "RESERVATION_DECLINED".

ErrorCodeSANDBOXNOTSUPPORTED captures enum value "SANDBOX_NOT_SUPPORTED".

ErrorCodeSERVICEUNAVAILABLE captures enum value "SERVICE_UNAVAILABLE".

ErrorCodeSOURCEEXPIRED captures enum value "SOURCE_EXPIRED".

ErrorCodeSOURCEUSED captures enum value "SOURCE_USED".

ErrorCodeTEMPORARYERROR captures enum value "TEMPORARY_ERROR".

ErrorCodeTOOMANYMAPENTRIES captures enum value "TOO_MANY_MAP_ENTRIES".

ErrorCodeTRANSACTIONLIMIT captures enum value "TRANSACTION_LIMIT".

ErrorCodeUNAUTHORIZED captures enum value "UNAUTHORIZED".

ErrorCodeUNEXPECTEDVALUE captures enum value "UNEXPECTED_VALUE".

ErrorCodeUNKNOWNQUERYPARAMETER captures enum value "UNKNOWN_QUERY_PARAMETER".

ErrorCodeUNPROCESSABLEENTITY captures enum value "UNPROCESSABLE_ENTITY".

ErrorCodeUNSUPPORTEDCARDBRAND captures enum value "UNSUPPORTED_CARD_BRAND".

ErrorCodeUNSUPPORTEDENTRYMETHOD captures enum value "UNSUPPORTED_ENTRY_METHOD".

ErrorCodeUNSUPPORTEDINSTRUMENTTYPE captures enum value "UNSUPPORTED_INSTRUMENT_TYPE".

ErrorCodeUNSUPPORTEDLOYALTYREWARDTIER captures enum value "UNSUPPORTED_LOYALTY_REWARD_TIER".

ErrorCodeUNSUPPORTEDMEDIATYPE captures enum value "UNSUPPORTED_MEDIA_TYPE".

ErrorCodeV1ACCESSTOKEN captures enum value "V1_ACCESS_TOKEN".

ErrorCodeV1APPLICATION captures enum value "V1_APPLICATION".

ErrorCodeVALUEEMPTY captures enum value "VALUE_EMPTY".

ErrorCodeVALUEREGEXMISMATCH captures enum value "VALUE_REGEX_MISMATCH".

ErrorCodeVALUETOOHIGH captures enum value "VALUE_TOO_HIGH".

ErrorCodeVALUETOOLONG captures enum value "VALUE_TOO_LONG".

ErrorCodeVALUETOOLOW captures enum value "VALUE_TOO_LOW".

ErrorCodeVALUETOOSHORT captures enum value "VALUE_TOO_SHORT".

ErrorCodeVERIFYAVSFAILURE captures enum value "VERIFY_AVS_FAILURE".

ErrorCodeVERIFYCVVFAILURE captures enum value "VERIFY_CVV_FAILURE".

ErrorCodeVOICEFAILURE captures enum value "VOICE_FAILURE".

ExcludeStrategyLEASTEXPENSIVE captures enum value "LEAST_EXPENSIVE".

ExcludeStrategyMOSTEXPENSIVE captures enum value "MOST_EXPENSIVE".

InlineTypesINLINEALL captures enum value "INLINE_ALL".

InlineTypesINLINENONE captures enum value "INLINE_NONE".

InlineTypesINLINEVARIATIONS captures enum value "INLINE_VARIATIONS".

InventoryAlertTypeLOWQUANTITY captures enum value "LOW_QUANTITY".

InventoryAlertTypeNONE captures enum value "NONE".

InventoryChangeTypeADJUSTMENT captures enum value "ADJUSTMENT".

InventoryChangeTypePHYSICALCOUNT captures enum value "PHYSICAL_COUNT".

InventoryChangeTypeTRANSFER captures enum value "TRANSFER".

InventoryStateCUSTOM captures enum value "CUSTOM".

InventoryStateINSTOCK captures enum value "IN_STOCK".

InventoryStateINTRANSITTO captures enum value "IN_TRANSIT_TO".

InventoryStateNONE captures enum value "NONE".

InventoryStateORDEREDFROMVENDOR captures enum value "ORDERED_FROM_VENDOR".

InventoryStateRECEIVEDFROMVENDOR captures enum value "RECEIVED_FROM_VENDOR".

InventoryStateRESERVEDFORSALE captures enum value "RESERVED_FOR_SALE".

InventoryStateRETURNEDBYCUSTOMER captures enum value "RETURNED_BY_CUSTOMER".

InventoryStateSOLD captures enum value "SOLD".

InventoryStateSOLDONLINE captures enum value "SOLD_ONLINE".

InventoryStateUNLINKEDRETURN captures enum value "UNLINKED_RETURN".

InventoryStateWASTE captures enum value "WASTE".

InvoiceAutomaticPaymentSourceBANKONFILE captures enum value "BANK_ON_FILE".

InvoiceAutomaticPaymentSourceCARDONFILE captures enum value "CARD_ON_FILE".

InvoiceAutomaticPaymentSourceNONE captures enum value "NONE".

InvoiceCustomFieldPlacementABOVELINEITEMS captures enum value "ABOVE_LINE_ITEMS".

InvoiceCustomFieldPlacementBELOWLINEITEMS captures enum value "BELOW_LINE_ITEMS".

InvoiceDeliveryMethodEMAIL captures enum value "EMAIL".

InvoiceDeliveryMethodSHAREMANUALLY captures enum value "SHARE_MANUALLY".

InvoicePaymentReminderStatusNOTAPPLICABLE captures enum value "NOT_APPLICABLE".

InvoicePaymentReminderStatusPENDING captures enum value "PENDING".

InvoicePaymentReminderStatusSENT captures enum value "SENT".

InvoiceRequestMethodCHARGEBANKONFILE captures enum value "CHARGE_BANK_ON_FILE".

InvoiceRequestMethodCHARGECARDONFILE captures enum value "CHARGE_CARD_ON_FILE".

InvoiceRequestMethodEMAIL captures enum value "EMAIL".

InvoiceRequestMethodSHAREMANUALLY captures enum value "SHARE_MANUALLY".

InvoiceRequestTypeBALANCE captures enum value "BALANCE".

InvoiceRequestTypeDEPOSIT captures enum value "DEPOSIT".

InvoiceRequestTypeINSTALLMENT captures enum value "INSTALLMENT".

InvoiceSortFieldINVOICESORTDATE captures enum value "INVOICE_SORT_DATE".

InvoiceStatusCANCELED captures enum value "CANCELED".

InvoiceStatusDRAFT captures enum value "DRAFT".

InvoiceStatusFAILED captures enum value "FAILED".

InvoiceStatusPAID captures enum value "PAID".

InvoiceStatusPARTIALLYPAID captures enum value "PARTIALLY_PAID".

InvoiceStatusPARTIALLYREFUNDED captures enum value "PARTIALLY_REFUNDED".

InvoiceStatusPAYMENTPENDING captures enum value "PAYMENT_PENDING".

InvoiceStatusREFUNDED captures enum value "REFUNDED".

InvoiceStatusSCHEDULED captures enum value "SCHEDULED".

InvoiceStatusUNPAID captures enum value "UNPAID".

JobAssignmentPayTypeHOURLY captures enum value "HOURLY".

JobAssignmentPayTypeNONE captures enum value "NONE".

JobAssignmentPayTypeSALARY captures enum value "SALARY".

LocationCapabilityCREDITCARDPROCESSING captures enum value "CREDIT_CARD_PROCESSING".

LocationStatusACTIVE captures enum value "ACTIVE".

LocationStatusINACTIVE captures enum value "INACTIVE".

LocationTypeMOBILE captures enum value "MOBILE".

LocationTypePHYSICAL captures enum value "PHYSICAL".

LoyaltyAccountMappingTypePHONE captures enum value "PHONE".

LoyaltyEventSourceLOYALTYAPI captures enum value "LOYALTY_API".

LoyaltyEventSourceSQUARE captures enum value "SQUARE".

LoyaltyEventTypeACCUMULATEPOINTS captures enum value "ACCUMULATE_POINTS".

LoyaltyEventTypeADJUSTPOINTS captures enum value "ADJUST_POINTS".

LoyaltyEventTypeCREATEREWARD captures enum value "CREATE_REWARD".

LoyaltyEventTypeDELETEREWARD captures enum value "DELETE_REWARD".

LoyaltyEventTypeEXPIREPOINTS captures enum value "EXPIRE_POINTS".

LoyaltyEventTypeOTHER captures enum value "OTHER".

LoyaltyEventTypeREDEEMREWARD captures enum value "REDEEM_REWARD".

LoyaltyProgramAccrualRuleTypeCATEGORY captures enum value "CATEGORY".

LoyaltyProgramAccrualRuleTypeITEMVARIATION captures enum value "ITEM_VARIATION".

LoyaltyProgramAccrualRuleTypeSPEND captures enum value "SPEND".

LoyaltyProgramAccrualRuleTypeVISIT captures enum value "VISIT".

LoyaltyProgramRewardDefinitionScopeCATEGORY captures enum value "CATEGORY".

LoyaltyProgramRewardDefinitionScopeITEMVARIATION captures enum value "ITEM_VARIATION".

LoyaltyProgramRewardDefinitionScopeORDER captures enum value "ORDER".

LoyaltyProgramRewardDefinitionTypeFIXEDAMOUNT captures enum value "FIXED_AMOUNT".

LoyaltyProgramRewardDefinitionTypeFIXEDPERCENTAGE captures enum value "FIXED_PERCENTAGE".

LoyaltyProgramStatusACTIVE captures enum value "ACTIVE".

LoyaltyProgramStatusINACTIVE captures enum value "INACTIVE".

LoyaltyRewardStatusDELETED captures enum value "DELETED".

LoyaltyRewardStatusISSUED captures enum value "ISSUED".

LoyaltyRewardStatusREDEEMED captures enum value "REDEEMED".

MeasurementUnitAreaIMPERIALACRE captures enum value "IMPERIAL_ACRE".

MeasurementUnitAreaIMPERIALSQUAREFOOT captures enum value "IMPERIAL_SQUARE_FOOT".

MeasurementUnitAreaIMPERIALSQUAREINCH captures enum value "IMPERIAL_SQUARE_INCH".

MeasurementUnitAreaIMPERIALSQUAREMILE captures enum value "IMPERIAL_SQUARE_MILE".

MeasurementUnitAreaIMPERIALSQUAREYARD captures enum value "IMPERIAL_SQUARE_YARD".

MeasurementUnitAreaMETRICSQUARECENTIMETER captures enum value "METRIC_SQUARE_CENTIMETER".

MeasurementUnitAreaMETRICSQUAREKILOMETER captures enum value "METRIC_SQUARE_KILOMETER".

MeasurementUnitAreaMETRICSQUAREMETER captures enum value "METRIC_SQUARE_METER".

MeasurementUnitGenericUNIT captures enum value "UNIT".

MeasurementUnitLengthIMPERIALFOOT captures enum value "IMPERIAL_FOOT".

MeasurementUnitLengthIMPERIALINCH captures enum value "IMPERIAL_INCH".

MeasurementUnitLengthIMPERIALMILE captures enum value "IMPERIAL_MILE".

MeasurementUnitLengthIMPERIALYARD captures enum value "IMPERIAL_YARD".

MeasurementUnitLengthMETRICCENTIMETER captures enum value "METRIC_CENTIMETER".

MeasurementUnitLengthMETRICKILOMETER captures enum value "METRIC_KILOMETER".

MeasurementUnitLengthMETRICMETER captures enum value "METRIC_METER".

MeasurementUnitLengthMETRICMILLIMETER captures enum value "METRIC_MILLIMETER".

MeasurementUnitTimeGENERICDAY captures enum value "GENERIC_DAY".

MeasurementUnitTimeGENERICHOUR captures enum value "GENERIC_HOUR".

MeasurementUnitTimeGENERICMILLISECOND captures enum value "GENERIC_MILLISECOND".

MeasurementUnitTimeGENERICMINUTE captures enum value "GENERIC_MINUTE".

MeasurementUnitTimeGENERICSECOND captures enum value "GENERIC_SECOND".

MeasurementUnitUnitTypeTYPEAREA captures enum value "TYPE_AREA".

MeasurementUnitUnitTypeTYPECUSTOM captures enum value "TYPE_CUSTOM".

MeasurementUnitUnitTypeTYPEGENERIC captures enum value "TYPE_GENERIC".

MeasurementUnitUnitTypeTYPELENGTH captures enum value "TYPE_LENGTH".

MeasurementUnitUnitTypeTYPEVOLUME captures enum value "TYPE_VOLUME".

MeasurementUnitUnitTypeTYPEWEIGHT captures enum value "TYPE_WEIGHT".

MeasurementUnitVolumeGENERICCUP captures enum value "GENERIC_CUP".

MeasurementUnitVolumeGENERICFLUIDOUNCE captures enum value "GENERIC_FLUID_OUNCE".

MeasurementUnitVolumeGENERICGALLON captures enum value "GENERIC_GALLON".

MeasurementUnitVolumeGENERICPINT captures enum value "GENERIC_PINT".

MeasurementUnitVolumeGENERICQUART captures enum value "GENERIC_QUART".

MeasurementUnitVolumeGENERICSHOT captures enum value "GENERIC_SHOT".

MeasurementUnitVolumeIMPERIALCUBICFOOT captures enum value "IMPERIAL_CUBIC_FOOT".

MeasurementUnitVolumeIMPERIALCUBICINCH captures enum value "IMPERIAL_CUBIC_INCH".

MeasurementUnitVolumeIMPERIALCUBICYARD captures enum value "IMPERIAL_CUBIC_YARD".

MeasurementUnitVolumeMETRICLITER captures enum value "METRIC_LITER".

MeasurementUnitVolumeMETRICMILLILITER captures enum value "METRIC_MILLILITER".

MeasurementUnitWeightIMPERIALPOUND captures enum value "IMPERIAL_POUND".

MeasurementUnitWeightIMPERIALSTONE captures enum value "IMPERIAL_STONE".

MeasurementUnitWeightIMPERIALWEIGHTOUNCE captures enum value "IMPERIAL_WEIGHT_OUNCE".

MeasurementUnitWeightMETRICGRAM captures enum value "METRIC_GRAM".

MeasurementUnitWeightMETRICKILOGRAM captures enum value "METRIC_KILOGRAM".

MeasurementUnitWeightMETRICMILLIGRAM captures enum value "METRIC_MILLIGRAM".

MerchantStatusACTIVE captures enum value "ACTIVE".

MerchantStatusINACTIVE captures enum value "INACTIVE".

OrderFulfillmentPickupDetailsScheduleTypeASAP captures enum value "ASAP".

OrderFulfillmentPickupDetailsScheduleTypeSCHEDULED captures enum value "SCHEDULED".

OrderFulfillmentStateCANCELED captures enum value "CANCELED".

OrderFulfillmentStateCOMPLETED captures enum value "COMPLETED".

OrderFulfillmentStateFAILED captures enum value "FAILED".

OrderFulfillmentStatePREPARED captures enum value "PREPARED".

OrderFulfillmentStatePROPOSED captures enum value "PROPOSED".

OrderFulfillmentStateRESERVED captures enum value "RESERVED".

OrderFulfillmentTypePICKUP captures enum value "PICKUP".

OrderFulfillmentTypeSHIPMENT captures enum value "SHIPMENT".

OrderLineItemDiscountScopeLINEITEM captures enum value "LINE_ITEM".

OrderLineItemDiscountScopeORDER captures enum value "ORDER".

OrderLineItemDiscountScopeOTHERDISCOUNTSCOPE captures enum value "OTHER_DISCOUNT_SCOPE".

OrderLineItemDiscountTypeFIXEDAMOUNT captures enum value "FIXED_AMOUNT".

OrderLineItemDiscountTypeFIXEDPERCENTAGE captures enum value "FIXED_PERCENTAGE".

OrderLineItemDiscountTypeUNKNOWNDISCOUNT captures enum value "UNKNOWN_DISCOUNT".

OrderLineItemDiscountTypeVARIABLEAMOUNT captures enum value "VARIABLE_AMOUNT".

OrderLineItemDiscountTypeVARIABLEPERCENTAGE captures enum value "VARIABLE_PERCENTAGE".

OrderLineItemTaxScopeLINEITEM captures enum value "LINE_ITEM".

OrderLineItemTaxScopeORDER captures enum value "ORDER".

OrderLineItemTaxScopeOTHERTAXSCOPE captures enum value "OTHER_TAX_SCOPE".

OrderLineItemTaxTypeADDITIVE captures enum value "ADDITIVE".

OrderLineItemTaxTypeINCLUSIVE captures enum value "INCLUSIVE".

OrderLineItemTaxTypeUNKNOWNTAX captures enum value "UNKNOWN_TAX".

OrderServiceChargeCalculationPhaseSUBTOTALPHASE captures enum value "SUBTOTAL_PHASE".

OrderServiceChargeCalculationPhaseTOTALPHASE captures enum value "TOTAL_PHASE".

OrderStateCANCELED captures enum value "CANCELED".

OrderStateCOMPLETED captures enum value "COMPLETED".

OrderStateOPEN captures enum value "OPEN".

ProductAPPOINTMENTS captures enum value "APPOINTMENTS".

ProductBILLING captures enum value "BILLING".

ProductDASHBOARD captures enum value "DASHBOARD".

ProductEXTERNALAPI captures enum value "EXTERNAL_API".

ProductINVOICES captures enum value "INVOICES".

ProductITEMLIBRARYIMPORT captures enum value "ITEM_LIBRARY_IMPORT".

ProductONLINESTORE captures enum value "ONLINE_STORE".

ProductOTHER captures enum value "OTHER".

ProductPAYROLL captures enum value "PAYROLL".

ProductSQUAREPOS captures enum value "SQUARE_POS".

ProductTypeTERMINALAPI captures enum value "TERMINAL_API".

RefundStatusAPPROVED captures enum value "APPROVED".

RefundStatusFAILED captures enum value "FAILED".

RefundStatusPENDING captures enum value "PENDING".

RefundStatusREJECTED captures enum value "REJECTED".

RegisterDomainResponseStatusPENDING captures enum value "PENDING".

RegisterDomainResponseStatusVERIFIED captures enum value "VERIFIED".

RiskEvaluationRiskLevelHIGH captures enum value "HIGH".

RiskEvaluationRiskLevelMODERATE captures enum value "MODERATE".

RiskEvaluationRiskLevelNORMAL captures enum value "NORMAL".

RiskEvaluationRiskLevelPENDING captures enum value "PENDING".

SearchCatalogItemsRequestStockLevelLOW captures enum value "LOW".

SearchCatalogItemsRequestStockLevelOUT captures enum value "OUT".

SearchOrdersSortFieldCLOSEDAT captures enum value "CLOSED_AT".

SearchOrdersSortFieldCREATEDAT captures enum value "CREATED_AT".

SearchOrdersSortFieldUPDATEDAT captures enum value "UPDATED_AT".

ShiftFilterStatusCLOSED captures enum value "CLOSED".

ShiftFilterStatusOPEN captures enum value "OPEN".

ShiftSortFieldCREATEDAT captures enum value "CREATED_AT".

ShiftSortFieldENDAT captures enum value "END_AT".

ShiftSortFieldSTARTAT captures enum value "START_AT".

ShiftSortFieldUPDATEDAT captures enum value "UPDATED_AT".

ShiftStatusCLOSED captures enum value "CLOSED".

ShiftStatusOPEN captures enum value "OPEN".

ShiftWorkdayMatcherENDAT captures enum value "END_AT".

ShiftWorkdayMatcherINTERSECTION captures enum value "INTERSECTION".

ShiftWorkdayMatcherSTARTAT captures enum value "START_AT".

SortOrderASC captures enum value "ASC".

SortOrderDESC captures enum value "DESC".

SubscriptionCadenceANNUAL captures enum value "ANNUAL".

SubscriptionCadenceDAILY captures enum value "DAILY".

SubscriptionCadenceEVERYFOURMONTHS captures enum value "EVERY_FOUR_MONTHS".

SubscriptionCadenceEVERYSIXMONTHS captures enum value "EVERY_SIX_MONTHS".

SubscriptionCadenceEVERYTWOMONTHS captures enum value "EVERY_TWO_MONTHS".

SubscriptionCadenceEVERYTWOWEEKS captures enum value "EVERY_TWO_WEEKS".

SubscriptionCadenceEVERYTWOYEARS captures enum value "EVERY_TWO_YEARS".

SubscriptionCadenceMONTHLY captures enum value "MONTHLY".

SubscriptionCadenceNINETYDAYS captures enum value "NINETY_DAYS".

SubscriptionCadenceQUARTERLY captures enum value "QUARTERLY".

SubscriptionCadenceSIXTYDAYS captures enum value "SIXTY_DAYS".

SubscriptionCadenceTHIRTYDAYS captures enum value "THIRTY_DAYS".

SubscriptionCadenceWEEKLY captures enum value "WEEKLY".

SubscriptionEventSubscriptionEventTypePLANCHANGE captures enum value "PLAN_CHANGE".

SubscriptionEventSubscriptionEventTypeSTARTSUBSCRIPTION captures enum value "START_SUBSCRIPTION".

SubscriptionEventSubscriptionEventTypeSTOPSUBSCRIPTION captures enum value "STOP_SUBSCRIPTION".

SubscriptionStatusACTIVE captures enum value "ACTIVE".

SubscriptionStatusCANCELED captures enum value "CANCELED".

SubscriptionStatusPENDING captures enum value "PENDING".

TaxCalculationPhaseTAXSUBTOTALPHASE captures enum value "TAX_SUBTOTAL_PHASE".

TaxCalculationPhaseTAXTOTALPHASE captures enum value "TAX_TOTAL_PHASE".

TaxInclusionTypeADDITIVE captures enum value "ADDITIVE".

TaxInclusionTypeINCLUSIVE captures enum value "INCLUSIVE".

TeamMemberAssignedLocationsAssignmentTypeALLCURRENTANDFUTURELOCATIONS captures enum value "ALL_CURRENT_AND_FUTURE_LOCATIONS".

TeamMemberAssignedLocationsAssignmentTypeEXPLICITLOCATIONS captures enum value "EXPLICIT_LOCATIONS".

TeamMemberStatusACTIVE captures enum value "ACTIVE".

TeamMemberStatusINACTIVE captures enum value "INACTIVE".

TenderCardDetailsEntryMethodCONTACTLESS captures enum value "CONTACTLESS".

TenderCardDetailsEntryMethodEMV captures enum value "EMV".

TenderCardDetailsEntryMethodKEYED captures enum value "KEYED".

TenderCardDetailsEntryMethodONFILE captures enum value "ON_FILE".

TenderCardDetailsEntryMethodSWIPED captures enum value "SWIPED".

TenderCardDetailsStatusAUTHORIZED captures enum value "AUTHORIZED".

TenderCardDetailsStatusCAPTURED captures enum value "CAPTURED".

TenderCardDetailsStatusFAILED captures enum value "FAILED".

TenderCardDetailsStatusVOIDED captures enum value "VOIDED".

TenderTypeCARD captures enum value "CARD".

TenderTypeCASH captures enum value "CASH".

TenderTypeNOSALE captures enum value "NO_SALE".

TenderTypeOTHER captures enum value "OTHER".

TenderTypeSQUAREGIFTCARD captures enum value "SQUARE_GIFT_CARD".

TenderTypeTHIRDPARTYCARD captures enum value "THIRD_PARTY_CARD".

TenderTypeWALLET captures enum value "WALLET".

TransactionProductAPPOINTMENTS captures enum value "APPOINTMENTS".

TransactionProductBILLING captures enum value "BILLING".

TransactionProductEXTERNALAPI captures enum value "EXTERNAL_API".

TransactionProductINVOICES captures enum value "INVOICES".

TransactionProductONLINESTORE captures enum value "ONLINE_STORE".

TransactionProductOTHER captures enum value "OTHER".

TransactionProductPAYROLL captures enum value "PAYROLL".

TransactionProductREGISTER captures enum value "REGISTER".

TransactionTypeCREDIT captures enum value "CREDIT".

TransactionTypeDEBIT captures enum value "DEBIT".

WeekdayFRI captures enum value "FRI".

WeekdayMON captures enum value "MON".

WeekdaySAT captures enum value "SAT".

WeekdaySUN captures enum value "SUN".

WeekdayTHU captures enum value "THU".

WeekdayTUE captures enum value "TUE".

WeekdayWED captures enum value "WED".

AcceptDisputeResponse Defines the fields in an `AcceptDispute` response.

AccumulateLoyaltyPointsRequest A request to accumulate points for a purchase.

AccumulateLoyaltyPointsResponse A response containing the resulting loyalty event.

AddGroupToCustomerResponse Defines the fields that are included in the response body of a request to the [AddGroupToCustomer](#endpoint-addgrouptocustomer) endpoint.

AdditionalRecipient Represents an additional recipient (other than the merchant) receiving a portion of this tender.

Address Represents a physical address.

AdjustLoyaltyPointsRequest A request to adjust (add or subtract) points manually.

AdjustLoyaltyPointsResponse A response that includes the loyalty event that resulted from the successful API call.

AppointmentSegment Defines an appointment segment of a booking.

Availability Describes a slot available for booking, encapsulating appointment segments, the location and starting time.

BalancePaymentDetails Reflects the current status of a balance payment.

BankAccount Represents a bank account.

BatchChangeInventoryRequest batch change inventory request Example: {"request_body":{"changes":[{"physical_count":{"catalog_object_id":"W62UWFY35CWMYGVWK6TWJDNI","employee_id":"LRK57NSQ5X7PUD05","location_id":"C6W5YS5QM06F5","occurred_at":"2016-11-16T22:25:24.878Z","quantity":"53","reference_id":"1536bfbf-efed-48bf-b17d-a197141b2a92","state":"IN_STOCK"},"type":"PHYSICAL_COUNT"}],"idempotency_key":"8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe","ignore_unchanged_counts":true}} swagger:model BatchChangeInventoryRequest.

BatchChangeInventoryResponse batch change inventory response Example: {"counts":[{"calculated_at":"2016-11-16T22:28:01.223Z","catalog_object_id":"W62UWFY35CWMYGVWK6TWJDNI","catalog_object_type":"ITEM_VARIATION","location_id":"C6W5YS5QM06F5","quantity":"53","state":"IN_STOCK"}],"errors":[]} swagger:model BatchChangeInventoryResponse.

BatchDeleteCatalogObjectsRequest batch delete catalog objects request Example: {"request_body":{"object_ids":["W62UWFY35CWMYGVWK6TWJDNI","AA27W3M2GGTF3H6AVPNB77CK"]}} swagger:model BatchDeleteCatalogObjectsRequest.

BatchDeleteCatalogObjectsResponse batch delete catalog objects response Example: {"deleted_at":"2016-11-16T22:25:24.878Z","deleted_object_ids":["W62UWFY35CWMYGVWK6TWJDNI","AA27W3M2GGTF3H6AVPNB77CK"]} swagger:model BatchDeleteCatalogObjectsResponse.

BatchRetrieveCatalogObjectsRequest batch retrieve catalog objects request Example: {"request_body":{"include_related_objects":true,"object_ids":["W62UWFY35CWMYGVWK6TWJDNI","AA27W3M2GGTF3H6AVPNB77CK"]}} swagger:model BatchRetrieveCatalogObjectsRequest.

BatchRetrieveCatalogObjectsResponse batch retrieve catalog objects response Example: {"objects":[{"id":"W62UWFY35CWMYGVWK6TWJDNI","is_deleted":false,"item_data":{"category_id":"BJNQCF2FJ6S6UIDT65ABHLRX","description":"Hot Leaf Juice","name":"Tea","tax_ids":["HURXQOOAIC4IZSI2BEXQRYFY"],"variations":[{"id":"2TZFAOHWGG7PAK2QEXWYPZSP","is_deleted":false,"item_variation_data":{"item_id":"W62UWFY35CWMYGVWK6TWJDNI","name":"Mug","ordinal":0,"price_money":{"amount":150,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878}]},"present_at_all_locations":true,"type":"ITEM","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878},{"id":"AA27W3M2GGTF3H6AVPNB77CK","is_deleted":false,"item_data":{"category_id":"BJNQCF2FJ6S6UIDT65ABHLRX","description":"Hot Bean Juice","name":"Coffee","tax_ids":["HURXQOOAIC4IZSI2BEXQRYFY"],"variations":[{"id":"LBTYIHNHU52WOIHWT7SNRIYH","is_deleted":false,"item_variation_data":{"item_id":"AA27W3M2GGTF3H6AVPNB77CK","name":"Regular","ordinal":0,"price_money":{"amount":250,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878},{"id":"PKYIC7HGGKW5CYVSCVDEIMHY","is_deleted":false,"item_variation_data":{"item_id":"AA27W3M2GGTF3H6AVPNB77CK","name":"Large","ordinal":1,"price_money":{"amount":350,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878}]},"present_at_all_locations":true,"type":"ITEM","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878}],"related_objects":[{"category_data":{"name":"Beverages"},"id":"BJNQCF2FJ6S6UIDT65ABHLRX","is_deleted":false,"present_at_all_locations":true,"type":"CATEGORY","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878},{"id":"HURXQOOAIC4IZSI2BEXQRYFY","is_deleted":false,"present_at_all_locations":true,"tax_data":{"calculation_phase":"TAX_SUBTOTAL_PHASE","enabled":true,"inclusion_type":"ADDITIVE","name":"Sales Tax","percentage":"5.0"},"type":"TAX","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878}]} swagger:model BatchRetrieveCatalogObjectsResponse.

BatchRetrieveInventoryChangesRequest batch retrieve inventory changes request Example: {"request_body":{"catalog_object_ids":["W62UWFY35CWMYGVWK6TWJDNI"],"location_ids":["C6W5YS5QM06F5"],"states":["IN_STOCK"],"types":["PHYSICAL_COUNT"],"updated_after":"2016-11-01T00:00:00.000Z","updated_before":"2016-12-01T00:00:00.000Z"}} swagger:model BatchRetrieveInventoryChangesRequest.

BatchRetrieveInventoryChangesResponse batch retrieve inventory changes response Example: {"changes":[{"physical_count":{"catalog_object_id":"W62UWFY35CWMYGVWK6TWJDNI","catalog_object_type":"ITEM_VARIATION","created_at":"2016-11-16T22:25:24.878Z","employee_id":"LRK57NSQ5X7PUD05","id":"46YDTW253DWGGK9HMAE6XCAO","location_id":"C6W5YS5QM06F5","occurred_at":"2016-11-16T22:24:49.028Z","quantity":"86","reference_id":"22c07cf4-5626-4224-89f9-691112019399","source":{"application_id":"416ff29c-86c4-4feb-b58c-9705f21f3ea0","name":"Square Point of Sale 4.37","product":"SQUARE_POS"},"state":"IN_STOCK"},"type":"PHYSICAL_COUNT"}],"errors":[]} swagger:model BatchRetrieveInventoryChangesResponse.

BatchRetrieveInventoryCountsRequest batch retrieve inventory counts request Example: {"request_body":{"catalog_object_ids":["W62UWFY35CWMYGVWK6TWJDNI"],"location_ids":["59TNP9SA8VGDA"],"updated_after":"2016-11-16T00:00:00.000Z"}} swagger:model BatchRetrieveInventoryCountsRequest.

BatchRetrieveInventoryCountsResponse batch retrieve inventory counts response Example: {"counts":[{"calculated_at":"2016-11-16T22:28:01.223Z","catalog_object_id":"W62UWFY35CWMYGVWK6TWJDNI","catalog_object_type":"ITEM_VARIATION","location_id":"59TNP9SA8VGDA","quantity":"79","state":"IN_STOCK"}],"errors":[]} swagger:model BatchRetrieveInventoryCountsResponse.

BatchRetrieveOrdersRequest Defines the fields that are included in requests to the BatchRetrieveOrders endpoint.

BatchRetrieveOrdersResponse Defines the fields that are included in the response body of a request to the BatchRetrieveOrders endpoint.

BatchUpsertCatalogObjectsRequest batch upsert catalog objects request Example: {"request_body":{"batches":[{"objects":[{"id":"#Tea","item_data":{"category_id":"#Beverages","description":"Hot Leaf Juice","name":"Tea","tax_ids":["#SalesTax"],"variations":[{"id":"#Tea_Mug","item_variation_data":{"item_id":"#Tea","name":"Mug","price_money":{"amount":150,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION"}]},"present_at_all_locations":true,"type":"ITEM"},{"id":"#Coffee","item_data":{"category_id":"#Beverages","description":"Hot Bean Juice","name":"Coffee","tax_ids":["#SalesTax"],"variations":[{"id":"#Coffee_Regular","item_variation_data":{"item_id":"#Coffee","name":"Regular","price_money":{"amount":250,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION"},{"id":"#Coffee_Large","item_variation_data":{"item_id":"#Coffee","name":"Large","price_money":{"amount":350,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION"}]},"present_at_all_locations":true,"type":"ITEM"},{"category_data":{"name":"Beverages"},"id":"#Beverages","present_at_all_locations":true,"type":"CATEGORY"},{"id":"#SalesTax","present_at_all_locations":true,"tax_data":{"applies_to_custom_amounts":true,"calculation_phase":"TAX_SUBTOTAL_PHASE","enabled":true,"inclusion_type":"ADDITIVE","name":"Sales Tax","percentage":"5.0"},"type":"TAX"}]}],"idempotency_key":"789ff020-f723-43a9-b4b5-43b5dc1fa3dc"}} swagger:model BatchUpsertCatalogObjectsRequest.

BatchUpsertCatalogObjectsResponse batch upsert catalog objects response Example: {"id_mappings":[{"client_object_id":"#Tea","object_id":"ZSDZN34NAXDLC6D5ZQMNSOUM"},{"client_object_id":"#Coffee","object_id":"PJMCEBHHUS3OKDB6PYUHLCPP"},{"client_object_id":"#Beverages","object_id":"LYT72K3WGJFFCIMB63XARP3I"},{"client_object_id":"#SalesTax","object_id":"XHSHLHNWSI3HVI4BW5ZUZXI3"},{"client_object_id":"#Tea_Mug","object_id":"NAYHET5R52MIYCEF34ZMAHFM"},{"client_object_id":"#Coffee_Regular","object_id":"OTYDX45SPG7LJQUVCBZI4INH"},{"client_object_id":"#Coffee_Large","object_id":"GZDA3JB37FYVOPI4AOEBOITI"}],"objects":[{"id":"ZSDZN34NAXDLC6D5ZQMNSOUM","is_deleted":false,"item_data":{"category_id":"LYT72K3WGJFFCIMB63XARP3I","description":"Hot Leaf Juice","name":"Tea","tax_ids":["XHSHLHNWSI3HVI4BW5ZUZXI3"],"variations":[{"id":"NAYHET5R52MIYCEF34ZMAHFM","is_deleted":false,"item_variation_data":{"item_id":"ZSDZN34NAXDLC6D5ZQMNSOUM","name":"Mug","ordinal":0,"price_money":{"amount":150,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION","updated_at":"2017-05-10T18:48:39.798Z","version":1494442119798}]},"present_at_all_locations":true,"type":"ITEM","updated_at":"2017-05-10T18:48:39.798Z","version":1494442119798},{"id":"PJMCEBHHUS3OKDB6PYUHLCPP","is_deleted":false,"item_data":{"category_id":"LYT72K3WGJFFCIMB63XARP3I","description":"Hot Bean Juice","name":"Coffee","tax_ids":["XHSHLHNWSI3HVI4BW5ZUZXI3"],"variations":[{"id":"OTYDX45SPG7LJQUVCBZI4INH","is_deleted":false,"item_variation_data":{"item_id":"PJMCEBHHUS3OKDB6PYUHLCPP","name":"Regular","ordinal":0,"price_money":{"amount":250,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION","updated_at":"2017-05-10T18:48:39.798Z","version":1494442119798},{"id":"GZDA3JB37FYVOPI4AOEBOITI","is_deleted":false,"item_variation_data":{"item_id":"PJMCEBHHUS3OKDB6PYUHLCPP","name":"Large","ordinal":1,"price_money":{"amount":350,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION","updated_at":"2017-05-10T18:48:39.798Z","version":1494442119798}]},"present_at_all_locations":true,"type":"ITEM","updated_at":"2017-05-10T18:48:39.798Z","version":1494442119798},{"category_data":{"name":"Beverages"},"id":"LYT72K3WGJFFCIMB63XARP3I","is_deleted":false,"present_at_all_locations":true,"type":"CATEGORY","updated_at":"2017-05-10T18:48:39.798Z","version":1494442119798},{"id":"XHSHLHNWSI3HVI4BW5ZUZXI3","is_deleted":false,"present_at_all_locations":true,"tax_data":{"applies_to_custom_amounts":true,"calculation_phase":"TAX_SUBTOTAL_PHASE","enabled":true,"inclusion_type":"ADDITIVE","name":"Sales Tax","percentage":"5.0"},"type":"TAX","updated_at":"2017-05-10T18:48:39.798Z","version":1494442119798}]} swagger:model BatchUpsertCatalogObjectsResponse.

Booking Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service at a given location to a requesting customer in one or more appointment segments.

Break A record of an employee's break during a shift.

BreakType A defined break template that sets an expectation for possible `Break` instances on a `Shift`.

BulkCreateTeamMembersRequest Represents a bulk create request for `TeamMember` objects.

BulkCreateTeamMembersResponse Represents a response from a bulk create request, containing the created `TeamMember` objects or error messages.

BulkUpdateTeamMembersRequest Represents a bulk update request for `TeamMember` objects.

BulkUpdateTeamMembersResponse Represents a response from a bulk update request, containing the updated `TeamMember` objects or error messages.

BusinessAppointmentSettings The service appointment settings, including where and how the service is provided.

BusinessBookingProfile business booking profile swagger:model BusinessBookingProfile.

BusinessHours Represents the hours of operation for a business location.

BusinessHoursPeriod Represents a period of time during which a business location is open.

CalculateLoyaltyPointsRequest A request to calculate the points that a buyer can earn from a specified purchase.

CalculateLoyaltyPointsResponse A response that includes the points that the buyer can earn from a specified purchase.

CalculateOrderRequest calculate order request Example: {"request_body":{"idempotency_key":"b3e98fe3-b8de-471c-82f1-545f371e637c","order":{"discounts":[{"name":"50% Off","percentage":"50","scope":"ORDER"}],"line_items":[{"base_price_money":{"amount":500,"currency":"USD"},"name":"Item 1","quantity":"1"},{"base_price_money":{"amount":300,"currency":"USD"},"name":"Item 2","quantity":"2"}],"location_id":"D7AVYMEAPJ3A3"}}} swagger:model CalculateOrderRequest.

CalculateOrderResponse calculate order response Example: {"order":{"created_at":"2020-05-18T16:30:49.614Z","discounts":[{"applied_money":{"amount":550,"currency":"USD"},"name":"50% Off","percentage":"50","scope":"ORDER","type":"FIXED_PERCENTAGE","uid":"zGsRZP69aqSSR9lq9euSPB"}],"line_items":[{"applied_discounts":[{"applied_money":{"amount":250,"currency":"USD"},"discount_uid":"zGsRZP69aqSSR9lq9euSPB","uid":"9zr9S4dxvPAixvn0lpa1VC"}],"base_price_money":{"amount":500,"currency":"USD"},"gross_sales_money":{"amount":500,"currency":"USD"},"name":"Item 1","quantity":"1","total_discount_money":{"amount":250,"currency":"USD"},"total_money":{"amount":250,"currency":"USD"},"total_tax_money":{"amount":0,"currency":"USD"},"uid":"ULkg0tQTRK2bkU9fNv3IJD","variation_total_price_money":{"amount":500,"currency":"USD"}},{"applied_discounts":[{"applied_money":{"amount":300,"currency":"USD"},"discount_uid":"zGsRZP69aqSSR9lq9euSPB","uid":"qa8LwwZK82FgSEkQc2HYVC"}],"base_price_money":{"amount":300,"currency":"USD"},"gross_sales_money":{"amount":600,"currency":"USD"},"name":"Item 2","quantity":"2","total_discount_money":{"amount":300,"currency":"USD"},"total_money":{"amount":300,"currency":"USD"},"total_tax_money":{"amount":0,"currency":"USD"},"uid":"mumY8Nun4BC5aKe2yyx5a","variation_total_price_money":{"amount":600,"currency":"USD"}}],"location_id":"D7AVYMEAPJ3A3","net_amounts":{"discount_money":{"amount":550,"currency":"USD"},"service_charge_money":{"amount":0,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"tip_money":{"amount":0,"currency":"USD"},"total_money":{"amount":550,"currency":"USD"}},"state":"OPEN","total_discount_money":{"amount":550,"currency":"USD"},"total_money":{"amount":550,"currency":"USD"},"total_service_charge_money":{"amount":0,"currency":"USD"},"total_tax_money":{"amount":0,"currency":"USD"},"total_tip_money":{"amount":0,"currency":"USD"},"updated_at":"2020-05-18T16:30:49.614Z","version":1}} swagger:model CalculateOrderResponse.

CancelBookingRequest cancel booking request Example: {"booking_version":1} swagger:model CancelBookingRequest.

CancelBookingResponse cancel booking response Example: {"booking":{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"created_at":"2020-10-28T15:47:41Z","customer_id":"EX2QSVGTZN4K1E5QE1CBFNVQ8M","customer_note":"","id":"zkras0xv0xwswx","location_id":"LEQHH0YY8B42M","seller_note":"","start_at":"2020-11-26T13:00:00Z","status":"CANCELLED_BY_CUSTOMER","updated_at":"2020-10-28T15:49:25Z","version":1},"errors":[]} swagger:model CancelBookingResponse.

CancelInvoiceRequest Describes a `CancelInvoice` request.

CancelInvoiceResponse The response returned by the `CancelInvoice` request.

CancelPaymentByIdempotencyKeyRequest Specifies the idempotency key of a payment to cancel.

CancelPaymentByIdempotencyKeyResponse The return value from the [CancelPaymentByIdempotencyKey](#endpoint-payments-cancelpaymentbyidempotencykey) endpoint.

CancelPaymentResponse The return value from the [CancelPayment](#endpoint-payments-cancelpayment) endpoint.

CancelSubscriptionResponse Defines fields that are included in a [CancelSubscription](#endpoint-subscriptions-cancelsubscription) response.

CancelTerminalCheckoutResponse cancel terminal checkout response Example: {"checkout":{"amount_money":{"amount":123,"currency":"USD"},"app_id":"APP_ID","cancel_reason":"SELLER_CANCELED","created_at":"2020-03-16T15:31:19.934Z","deadline_duration":"PT10M","device_options":{"device_id":"dbb5d83a-7838-11ea-bc55-0242ac130003","skip_receipt_screen":true,"tip_settings":{"allow_tipping":true}},"id":"S1yDlPQx7slqO","reference_id":"id36815","status":"CANCELED","updated_at":"2020-03-16T15:31:45.787Z"}} swagger:model CancelTerminalCheckoutResponse.

CancelTerminalRefundResponse cancel terminal refund response Example: {"refund":{"amount_money":{"amount":100,"currency":"CAD"},"app_id":"sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ","cancel_reason":"SELLER_CANCELED","card":{"bin":"411111","card_brand":"INTERAC","card_type":"CREDIT","exp_month":1,"exp_year":2022,"fingerprint":"sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw","last_4":"1111"},"created_at":"2020-10-21T22:47:23.241Z","deadline_duration":"PT5M","device_id":"42690809-faa2-4701-a24b-19d3d34c9aaa","id":"g6ycb6HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY","location_id":"76C9W6K8CNNQ5","order_id":"kcuKDKreRaI4gF4TjmEgZjHk8Z7YY","payment_id":"5O5OvgkcNUhl7JBuINflcjKqUzXZY","reason":"reason","status":"CANCELED","updated_at":"2020-10-21T22:47:30.096Z"}} swagger:model CancelTerminalRefundResponse.

CaptureTransactionResponse Defines the fields that are included in the response body of a request to the [CaptureTransaction](#endpoint-capturetransaction) endpoint.

Card Represents the payment details of a card to be used for payments.

CardPaymentDetails Reflects the current status of a card payment.

CardPaymentTimeline The timeline for card payments.

CashDrawerDevice cash drawer device swagger:model CashDrawerDevice.

CashDrawerShift This model gives the details of a cash drawer shift.

CashDrawerShiftEvent cash drawer shift event swagger:model CashDrawerShiftEvent.

CashDrawerShiftSummary The summary of a closed cash drawer shift.

CatalogCategory A category to which a `CatalogItem` instance belongs.

CatalogCustomAttributeDefinition Contains information defining a custom attribute.

CatalogCustomAttributeDefinitionNumberConfig catalog custom attribute definition number config swagger:model CatalogCustomAttributeDefinitionNumberConfig.

CatalogCustomAttributeDefinitionSelectionConfig Configuration associated with `SELECTION`-type custom attribute definitions.

CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection A named selection for this `SELECTION`-type custom attribute definition.

CatalogCustomAttributeDefinitionStringConfig Configuration associated with Custom Attribute Definitions of type `STRING`.

CatalogCustomAttributeValue An instance of a custom attribute.

CatalogDiscount A discount applicable to items.

CatalogIDMapping A mapping between a temporary client-supplied ID and a permanent server-generated ID.

CatalogImage An image file to use in Square catalogs.

CatalogInfoResponse catalog info response Example: {"limits":{"batch_delete_max_object_ids":200,"batch_retrieve_max_object_ids":1000,"batch_upsert_max_objects_per_batch":1000,"batch_upsert_max_total_objects":10000,"search_max_page_limit":1000,"update_item_modifier_lists_max_item_ids":1000,"update_item_modifier_lists_max_modifier_lists_to_disable":1000,"update_item_modifier_lists_max_modifier_lists_to_enable":1000,"update_item_taxes_max_item_ids":1000,"update_item_taxes_max_taxes_to_disable":1000,"update_item_taxes_max_taxes_to_enable":1000}} swagger:model CatalogInfoResponse.

CatalogInfoResponseLimits catalog info response limits swagger:model CatalogInfoResponseLimits.

CatalogItem A [CatalogObject](#type-CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.

CatalogItemModifierListInfo Options to control the properties of a `CatalogModifierList` applied to a `CatalogItem` instance.

CatalogItemOption A group of variations for a `CatalogItem`.

CatalogItemOptionForItem An option that can be assigned to an item.

CatalogItemOptionValue An enumerated value that can link a `CatalogItemVariation` to an item option as one of its item option values.

CatalogItemOptionValueForItemVariation A `CatalogItemOptionValue` links an item variation to an item option as an item option value.

CatalogItemVariation An item variation (i.e., product) in the Catalog object model.

CatalogMeasurementUnit Represents the unit used to measure a `CatalogItemVariation` and specifies the precision for decimal quantities.

CatalogModifier A modifier applicable to items at the time of sale.

CatalogModifierList A list of modifiers applicable to items at the time of sale.

CatalogModifierOverride Options to control how to override the default behavior of the specified modifier.

CatalogObject The wrapper object for the Catalog entries of a given object type.

CatalogObjectBatch A batch of catalog objects.

CatalogObjectReference A reference to a Catalog object at a specific version.

CatalogPricingRule Defines how discounts are automatically applied to a set of items that match the pricing rule during the active time period.

CatalogProductSet Represents a collection of catalog objects for the purpose of applying a `PricingRule`.

CatalogQuery A query composed of one or more different types of filters to narrow the scope of targeted objects when calling the `SearchCatalogObjects` endpoint.

CatalogQueryExact The query filter to return the search result by exact match of the specified attribute name and value.

CatalogQueryItemsForItemOptions The query filter to return the items containing the specified item option IDs.

CatalogQueryItemsForModifierList The query filter to return the items containing the specified modifier list IDs.

CatalogQueryItemsForTax The query filter to return the items containing the specified tax IDs.

CatalogQueryItemVariationsForItemOptionValues The query filter to return the item variations containing the specified item option value IDs.

CatalogQueryPrefix The query filter to return the search result whose named attribute values are prefixed by the specified attribute value.

CatalogQueryRange The query filter to return the search result whose named attribute values fall between the specified range.

CatalogQuerySet The query filter to return the search result(s) by exact match of the specified `attribute_name` and any of the `attribute_values`.

CatalogQuerySortedAttribute The query expression to specify the key to sort search results.

CatalogQueryText The query filter to return the search result whose searchable attribute values contain all of the specified keywords or tokens, independent of the token order or case.

CatalogQuickAmount Represents a Quick Amount in the Catalog.

CatalogQuickAmountsSettings A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts.

CatalogSubscriptionPlan Describes a subscription plan.

CatalogTax A tax applicable to an item.

CatalogTimePeriod Represents a time period - either a single period or a repeating period.

CatalogV1ID A Square API V1 identifier of an item, including the object ID and its associated location ID.

ChargeRequest Defines the parameters that can be included in the body of a request to the [Charge](#endpoint-charge) endpoint.

ChargeRequestAdditionalRecipient Represents an additional recipient (other than the merchant) entitled to a portion of the tender.

ChargeResponse Defines the fields that are included in the response body of a request to the [Charge](#endpoint-charge) endpoint.

CheckAppointmentsOnboardedResponse check appointments onboarded response swagger:model CheckAppointmentsOnboardedResponse.

Checkout Square Checkout lets merchants accept online payments for supported payment types using a checkout workflow hosted on squareup.com.

CompletePaymentResponse The return value from a [CompletePayment](#endpoint-payments-completepayment) call.

Coordinates Latitude and longitude coordinates.

CreateBookingRequest create booking request Example: {"booking":{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"customer_id":"EX2QSVGTZN4K1E5QE1CBFNVQ8M","location_id":"LEQHH0YY8B42M","start_at":"2020-11-26T13:00:00Z"}} swagger:model CreateBookingRequest.

CreateBookingResponse create booking response Example: {"booking":{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"created_at":"2020-10-28T15:47:41Z","customer_id":"EX2QSVGTZN4K1E5QE1CBFNVQ8M","customer_note":"","id":"zkras0xv0xwswx","location_id":"LEQHH0YY8B42M","seller_note":"","start_at":"2020-11-26T13:00:00Z","status":"ACCEPTED","updated_at":"2020-10-28T15:47:41Z","version":0},"errors":[]} swagger:model CreateBookingResponse.

CreateBreakTypeRequest A request to create a new `BreakType` Example: {"request_body":{"break_type":{"break_name":"Lunch Break","expected_duration":"PT30M","is_paid":true,"location_id":"CGJN03P1D08GF"},"idempotency_key":"PAD3NG5KSN2GL"}} swagger:model CreateBreakTypeRequest.

CreateBreakTypeResponse The response to the request to create a `BreakType`.

CreateCheckoutRequest Defines the parameters that can be included in the body of a request to the __CreateCheckout__ endpoint.

CreateCheckoutResponse Defines the fields that are included in the response body of a request to the __CreateCheckout__ endpoint.

CreateCustomerCardRequest Defines the fields that are included in the request body of a request to the CreateCustomerCard endpoint.

CreateCustomerCardResponse Defines the fields that are included in the response body of a request to the CreateCustomerCard endpoint.

CreateCustomerGroupRequest Defines the body parameters that can be provided in a request to the [CreateCustomerGroup](#endpoint-createcustomegroup) endpoint.

CreateCustomerGroupResponse Defines the fields that are included in the response body of a request to the [CreateCustomerGroup](#endpoint-createcustomergroup) endpoint.

CreateCustomerRequest Defines the body parameters that can be provided in a request to the CreateCustomer endpoint.

CreateCustomerResponse Defines the fields that are included in the response body of a request to the CreateCustomer endpoint.

CreateDeviceCodeRequest create device code request Example: {"request_body":{"device_code":{"location_id":"B5E4484SHHNYH","name":"Counter 1","product_type":"TERMINAL_API"},"idempotency_key":"01bb00a6-0c86-4770-94ed-f5fca973cd56"}} swagger:model CreateDeviceCodeRequest.

CreateDeviceCodeResponse create device code response Example: {"device_code":{"code":"EBCARJ","created_at":"2020-02-06T18:44:33.000Z","id":"B3Z6NAMYQSMTM","location_id":"B5E4484SHHNYH","name":"Counter 1","pair_by":"2020-02-06T18:49:33.000Z","product_type":"TERMINAL_API","status":"UNPAIRED","status_changed_at":"2020-02-06T18:44:33.000Z"}} swagger:model CreateDeviceCodeResponse.

CreateDisputeEvidenceTextRequest Defines the parameters for a `CreateDisputeEvidenceText` request.

CreateDisputeEvidenceTextResponse Defines the fields in a `CreateDisputeEvidenceText` response.

CreateInvoiceRequest Describes a `CreateInvoice` request.

CreateInvoiceResponse The response returned by the `CreateInvoice` request.

CreateLocationRequest Request object for the [CreateLocation](#endpoint-createlocation) endpoint.

CreateLocationResponse Response object returned by the [CreateLocation](#endpoint-createlocation) endpoint.

CreateLoyaltyAccountRequest A request to create a new loyalty account.

CreateLoyaltyAccountResponse A response that includes loyalty account created.

CreateLoyaltyRewardRequest A request to create a loyalty reward.

CreateLoyaltyRewardResponse A response that includes the loyalty reward created.

CreateMobileAuthorizationCodeRequest Defines the body parameters that can be provided in a request to the __CreateMobileAuthorizationCode__ endpoint.

CreateMobileAuthorizationCodeResponse Defines the fields that are included in the response body of a request to the __CreateMobileAuthorizationCode__ endpoint.

CreateOrderRequest create order request Example: {"request_body":{"idempotency_key":"8193148c-9586-11e6-99f9-28cfe92138cf","order":{"discounts":[{"name":"Labor Day Sale","percentage":"5","scope":"ORDER","uid":"labor-day-sale"},{"catalog_object_id":"DB7L55ZH2BGWI4H23ULIWOQ7","scope":"ORDER","uid":"membership-discount"},{"amount_money":{"amount":100,"currency":"USD"},"name":"Sale - $1.00 off","scope":"LINE_ITEM","uid":"one-dollar-off"}],"line_items":[{"base_price_money":{"amount":1599,"currency":"USD"},"name":"New York Strip Steak","quantity":"1"},{"applied_discounts":[{"discount_uid":"one-dollar-off"}],"catalog_object_id":"BEMYCSMIJL46OCDV4KYIKXIB","modifiers":[{"catalog_object_id":"CHQX7Y4KY6N5KINJKZCFURPZ"}],"quantity":"2"}],"location_id":"057P5VYJ4A5X1","reference_id":"my-order-001","taxes":[{"name":"State Sales Tax","percentage":"9","scope":"ORDER","uid":"state-sales-tax"}]}}} swagger:model CreateOrderRequest.

CreateOrderResponse Defines the fields that are included in the response body of a request to the CreateOrder endpoint.

CreatePaymentRequest Creates a payment from a provided source (such as a nonce or a card on file).

CreatePaymentResponse Defines the fields that are included in the response body of a request to the [CreatePayment](#endpoint-payments-createpayment) endpoint.

CreateRefundRequest Defines the body parameters that can be included in a request to the [CreateRefund](#endpoint-createrefund) endpoint.

CreateRefundResponse Defines the fields that are included in the response body of a request to the [CreateRefund](#endpoint-createrefund) endpoint.

CreateShiftRequest Represents a request to create a `Shift` Example: {"request_body":{"idempotency_key":"HIDSNG5KS478L","shift":{"breaks":[{"break_type_id":"REGS1EQR1TPZ5","end_at":"2019-01-25T06:16:00-05:00","expected_duration":"PT5M","is_paid":true,"name":"Tea Break","start_at":"2019-01-25T06:11:00-05:00"}],"end_at":"2019-01-25T13:11:00-05:00","location_id":"PAA1RJZZKXBFG","start_at":"2019-01-25T03:11:00-05:00","team_member_id":"ormj0jJJZ5OZIzxrZYJI","wage":{"hourly_rate":{"amount":1100,"currency":"USD"},"title":"Barista"}}}} swagger:model CreateShiftRequest.

CreateShiftResponse The response to the request to create a `Shift`.

CreateSubscriptionRequest Defines parameters in a [CreateSubscription](#endpoint-subscriptions-createsubscription) endpoint request.

CreateSubscriptionResponse Defines the fields that are included in the response from the [CreateSubscription](#endpoint-subscriptions-createsubscription) endpoint.

CreateTeamMemberRequest Represents a create request for a `TeamMember` object.

CreateTeamMemberResponse Represents a response from a create request, containing the created `TeamMember` object or error messages.

CreateTerminalCheckoutRequest create terminal checkout request Example: {"request_body":{"checkout":{"amount_money":{"amount":2610,"currency":"USD"},"device_options":{"device_id":"dbb5d83a-7838-11ea-bc55-0242ac130003"},"note":"A brief note","reference_id":"id11572"},"idempotency_key":"28a0c3bc-7839-11ea-bc55-0242ac130003"}} swagger:model CreateTerminalCheckoutRequest.

CreateTerminalCheckoutResponse create terminal checkout response Example: {"checkout":{"amount_money":{"amount":2610,"currency":"USD"},"app_id":"APP_ID","created_at":"2020-04-06T16:39:32.545Z","deadline_duration":"PT10M","device_options":{"device_id":"dbb5d83a-7838-11ea-bc55-0242ac130003","skip_receipt_screen":false,"tip_settings":{"allow_tipping":false}},"id":"08YceKh7B3ZqO","note":"A brief note","reference_id":"id11572","status":"PENDING","updated_at":"2020-04-06T16:39:32.545Z"}} swagger:model CreateTerminalCheckoutResponse.

CreateTerminalRefundRequest create terminal refund request Example: {"request_body":{"idempotency_key":"402a640b-b26f-401f-b406-46f839590c04","refund":{"amount_money":{"amount":111,"currency":"CAD"},"device_id":"f72dfb8e-4d65-4e56-aade-ec3fb8d33291","payment_id":"5O5OvgkcNUhl7JBuINflcjKqUzXZY","reason":"Returning items"}}} swagger:model CreateTerminalRefundRequest.

CreateTerminalRefundResponse create terminal refund response Example: {"refund":{"amount_money":{"amount":111,"currency":"CAD"},"app_id":"sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ","card":{"bin":"411111","card_brand":"INTERAC","card_type":"CREDIT","exp_month":1,"exp_year":2022,"fingerprint":"sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw","last_4":"1111"},"created_at":"2020-09-29T15:21:46.771Z","deadline_duration":"PT5M","device_id":"f72dfb8e-4d65-4e56-aade-ec3fb8d33291","id":"009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY","location_id":"76C9W6K8CNNQ5","order_id":"kcuKDKreRaI4gF4TjmEgZjHk8Z7YY","payment_id":"5O5OvgkcNUhl7JBuINflcjKqUzXZY","reason":"Returning items","status":"PENDING","updated_at":"2020-09-29T15:21:46.771Z"}} swagger:model CreateTerminalRefundResponse.

CustomAttributeFilter Supported custom attribute query expressions for calling the [SearchCatalogItems](#endpoint-Catalog-SearchCatalogItems) endpoint to search for items or item variations.

Customer Represents a Square customer profile, which can have one or more cards on file associated with it.

CustomerCreationSourceFilter Creation source filter.

CustomerFilter Represents a set of `CustomerQuery` filters used to limit the set of `Customers` returned by `SearchCustomers`.

CustomerGroup Represents a group of customer profiles.

CustomerGroupInfo Contains some brief information about a Customer Group with its identifier included.

CustomerPreferences Represents communication preferences for the customer profile.

CustomerQuery Represents a query (including filtering criteria, sorting criteria, or both) used to search for customer profiles.

CustomerSegment Represents a group of customer profiles that match one or more predefined filter criteria.

CustomerSort Specifies how searched customers profiles are sorted, including the sort key and sort order.

CustomerTextFilter A filter to select customers based on exact or fuzzy matching of customer attributes against a specified query.

DateRange A range defined by two dates.

DeleteBreakTypeResponse The response to a request to delete a `BreakType`.

DeleteCatalogObjectResponse delete catalog object response Example: {"deleted_at":"2016-11-16T22:25:24.878Z","deleted_object_ids":["7SB3ZQYJ5GDMVFL7JK46JCHT","KQLFFHA6K6J3YQAQAWDQAL57"]} swagger:model DeleteCatalogObjectResponse.

DeleteCustomerCardResponse Defines the fields that are included in the response body of a request to the DeleteCustomerCard endpoint.

DeleteCustomerGroupResponse Defines the fields that are included in the response body of a request to the [DeleteCustomerGroup](#endpoint-deletecustomergroup) endpoint.

DeleteCustomerResponse Defines the fields that are included in the response body of a request to the DeleteCustomer endpoint.

DeleteInvoiceRequest Describes a `DeleteInvoice` request.

DeleteInvoiceResponse Describes a `DeleteInvoice` response.

DeleteLoyaltyRewardResponse A response returned by the API call.

DeleteShiftResponse The response to a request to delete a `Shift`.

Device device swagger:model Device.

DeviceCheckoutOptions device checkout options swagger:model DeviceCheckoutOptions.

DeviceCode device code swagger:model DeviceCode.

DeviceDetails Details about the device that took the payment.

Dispute Represents a dispute a cardholder initiated with their bank.

DisputedPayment The payment the cardholder disputed.

DisputeEvidence dispute evidence swagger:model DisputeEvidence.

DisputeEvidenceFile A file to be uploaded as dispute evidence.

Employee An employee object that is used by the external API.

EmployeeWage The hourly wage rate that an employee will earn on a `Shift` for doing the job specified by the `title` property of this object.

Error Represents an error encountered during a request to the Connect API.

FilterValue A filter to select resources based on an exact field value.

GetBankAccountByV1IDResponse Response object returned by GetBankAccountByV1Id.

GetBankAccountResponse Response object returned by `GetBankAccount`.

GetBreakTypeResponse The response to a request to get a `BreakType`.

GetDeviceCodeResponse get device code response Example: {"device_code":{"code":"EBCARJ","created_at":"2020-02-06T18:44:33.000Z","device_id":"907CS13101300122","id":"B3Z6NAMYQSMTM","location_id":"B5E4484SHHNYH","name":"Counter 1","pair_by":"2020-02-06T18:49:33.000Z","product_type":"TERMINAL_API","status":"PAIRED","status_changed_at":"2020-02-06T18:47:28.000Z"}} swagger:model GetDeviceCodeResponse.

GetEmployeeWageResponse A response to a request to get an `EmployeeWage`.

GetInvoiceResponse Describes a `GetInvoice` response.

GetPaymentRefundResponse Defines the fields that are included in the response body of a request to the [GetRefund](#endpoint-refunds-getpaymentrefund) endpoint.

GetPaymentResponse Defines the fields that are included in the response body of a request to the [GetPayment](#endpoint-payments-getpayment) endpoint.

GetShiftResponse A response to request to get a `Shift`.

GetTeamMemberWageResponse A response to a request to get a `TeamMemberWage`.

GetTerminalCheckoutResponse get terminal checkout response Example: {"checkout":{"amount_money":{"amount":2610,"currency":"USD"},"app_id":"APP_ID","created_at":"2020-04-06T16:39:32.545Z","deadline_duration":"PT10M","device_options":{"device_id":"dbb5d83a-7838-11ea-bc55-0242ac130003","skip_receipt_screen":false,"tip_settings":{"allow_tipping":false}},"id":"08YceKh7B3ZqO","note":"A brief note","reference_id":"id11572","status":"IN_PROGRESS","updated_at":"2020-04-06T16:39:323.001Z"}} swagger:model GetTerminalCheckoutResponse.

GetTerminalRefundResponse get terminal refund response Example: {"refund":{"amount_money":{"amount":111,"currency":"CAD"},"app_id":"sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ","card":{"bin":"411111","card_brand":"INTERAC","card_type":"CREDIT","exp_month":1,"exp_year":2022,"fingerprint":"sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw","last_4":"1111"},"created_at":"2020-09-29T15:21:46.771Z","deadline_duration":"PT5M","device_id":"f72dfb8e-4d65-4e56-aade-ec3fb8d33291","id":"009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY","location_id":"76C9W6K8CNNQ5","order_id":"kcuKDKreRaI4gF4TjmEgZjHk8Z7YY","payment_id":"5O5OvgkcNUhl7JBuINflcjKqUzXZY","reason":"Returning item","refund_id":"5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb","status":"COMPLETED","updated_at":"2020-09-29T15:21:48.675Z"}} swagger:model GetTerminalRefundResponse.

InventoryAdjustment Represents a change in state or quantity of product inventory at a particular time and location.

InventoryChange Represents a single physical count, inventory, adjustment, or transfer that is part of the history of inventory changes for a particular `CatalogObject`.

InventoryCount Represents Square's estimated quantity of items in a particular state at a particular location based on the known history of physical counts and inventory adjustments.

InventoryPhysicalCount Represents the quantity of an item variation that is physically present at a specific location, verified by a seller or a seller's employee.

InventoryTransfer Represents the transfer of a quantity of product inventory at a particular time from one location to another.

Invoice Stores information about an invoice.

InvoiceCustomField An additional seller-defined and customer-facing field to include on the invoice.

InvoiceFilter Describes query filters to apply.

InvoicePaymentReminder Describes a payment request reminder (automatic notification) that Square sends to the customer.

InvoicePaymentRequest Represents a payment request for an [invoice](#type-Invoice).

InvoiceQuery Describes query criteria for searching invoices.

InvoiceRecipient Provides customer data that Square uses to deliver an invoice.

InvoiceSort Identifies the sort field and sort order.

ItemVariationLocationOverrides Price and inventory alerting overrides for a `CatalogItemVariation` at a specific `Location`.

JobAssignment An object describing a job that a team member is assigned to.

ListBankAccountsRequest Request object for fetching all `BankAccount` objects linked to a account.

ListBankAccountsResponse Response object returned by ListBankAccounts.

ListBreakTypesRequest A request for a filtered set of `BreakType` objects Example: {"request_params":"?location_id=PAA1RJZZKXBFG\u0026limit=2\u0026cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED"} swagger:model ListBreakTypesRequest.

ListBreakTypesResponse The response to a request for a set of `BreakTypes`.

ListCashDrawerShiftEventsRequest list cash drawer shift events request Example: {"request_body":{}} swagger:model ListCashDrawerShiftEventsRequest.

ListCashDrawerShiftEventsResponse list cash drawer shift events response Example: {"events":[{"created_at":"2019-11-22T00:43:02.000Z","description":"","event_money":{"amount":100,"currency":"USD"},"event_type":"CASH_TENDER_PAYMENT","id":"9F07DB01-D85A-4B77-88C3-D5C64CEB5155"},{"created_at":"2019-11-22T00:43:12.000Z","description":"","event_money":{"amount":250,"currency":"USD"},"event_type":"CASH_TENDER_PAYMENT","id":"B2854CEA-A781-49B3-8F31-C64558231F48"},{"created_at":"2019-11-22T00:43:23.000Z","description":"","event_money":{"amount":250,"currency":"USD"},"event_type":"CASH_TENDER_CANCELLED_PAYMENT","id":"B5FB7F72-95CD-44A3-974D-26C41064D042"},{"created_at":"2019-11-22T00:43:46.000Z","description":"","event_money":{"amount":100,"currency":"USD"},"event_type":"CASH_TENDER_REFUND","id":"0B425480-8504-40B4-A867-37B23543931B"},{"created_at":"2019-11-22T00:44:18.000Z","description":"Transfer from another drawer","event_money":{"amount":10000,"currency":"USD"},"event_type":"PAID_IN","id":"8C66E60E-FDCF-4EEF-A98D-3B14B7ED5CBE"},{"created_at":"2019-11-22T00:44:29.000Z","description":"Transfer out to another drawer","event_money":{"amount":10000,"currency":"USD"},"event_type":"PAID_OUT","id":"D5ACA7FE-C64D-4ADA-8BC8-82118A2DAE4F"}]} swagger:model ListCashDrawerShiftEventsResponse.

ListCashDrawerShiftsRequest list cash drawer shifts request Example: {"request_body":{}} swagger:model ListCashDrawerShiftsRequest.

ListCashDrawerShiftsResponse list cash drawer shifts response Example: {"items":[{"closed_at":"2019-11-22T00:44:49.000Z","closed_cash_money":{"amount":9970,"currency":"USD"},"description":"Misplaced some change","ended_at":"2019-11-22T00:44:49.000Z","expected_cash_money":{"amount":10000,"currency":"USD"},"id":"DCC99978-09A6-4926-849F-300BE9C5793A","opened_at":"2019-11-22T00:42:54.000Z","opened_cash_money":{"amount":10000,"currency":"USD"},"state":"CLOSED"}]} swagger:model ListCashDrawerShiftsResponse.

ListCatalogRequest list catalog request Example: {"request_params":"?types=category,tax"} swagger:model ListCatalogRequest.

ListCatalogResponse list catalog response Example: {"objects":[{"category_data":{"name":"Beverages"},"id":"5ZYQZZ2IECPVJ2IJ5KQPRDC3","is_deleted":false,"present_at_all_locations":true,"type":"CATEGORY","updated_at":"2017-02-21T14:50:26.495Z","version":1487688626495},{"id":"L5R47DGBZOOVKCAFIXC56AEN","is_deleted":false,"present_at_all_locations":true,"tax_data":{"calculation_phase":"TAX_SUBTOTAL_PHASE","enabled":true,"inclusion_type":"ADDITIVE","name":"Sales Tax","percentage":"5.0"},"type":"TAX","updated_at":"2017-02-21T14:50:26.495Z","version":1487688626495}]} swagger:model ListCatalogResponse.

ListCustomerGroupsRequest Defines the query parameters that can be provided in a request to the [ListCustomerGroups](#endpoint-listcustomergroups) endpoint.

ListCustomerGroupsResponse Defines the fields that are included in the response body of a request to the [ListCustomerGroups](#endpoint-listcustomergroups) endpoint.

ListCustomerSegmentsRequest Defines the valid parameters for requests to __ListCustomerSegments__.

ListCustomerSegmentsResponse Defines the fields included in the response body for requests to __ListCustomerSegments__.

ListCustomersRequest Defines the query parameters that can be provided in a request to the ListCustomers endpoint.

ListCustomersResponse Defines the fields that are included in the response body of a request to the ListCustomers endpoint.

ListDeviceCodesRequest list device codes request Example: {"request_body":{}} swagger:model ListDeviceCodesRequest.

ListDeviceCodesResponse list device codes response Example: {"device_codes":[{"code":"EBCARJ","created_at":"2020-02-06T18:44:33.000Z","device_id":"907CS13101300122","id":"B3Z6NAMYQSMTM","location_id":"B5E4484SHHNYH","name":"Counter 1","pair_by":"2020-02-06T18:49:33.000Z","product_type":"TERMINAL_API","status":"PAIRED","status_changed_at":"2020-02-06T18:47:28.000Z"},{"code":"GVXNYN","created_at":"2020-02-07T19:55:04.000Z","id":"YKGMJMYK8H4PQ","location_id":"A6SYFRSV4WAFW","name":"Unused device code","pair_by":"2020-02-07T20:00:04.000Z","product_type":"TERMINAL_API","status":"UNPAIRED","status_changed_at":"2020-02-07T19:55:04.000Z"}]} swagger:model ListDeviceCodesResponse.

ListDisputeEvidenceResponse Defines the fields in a `ListDisputeEvidence` response.

ListDisputesRequest Defines the request parameters for the `ListDisputes` endpoint.

ListDisputesResponse Defines fields in a `ListDisputes` response.

ListEmployeesRequest list employees request swagger:model ListEmployeesRequest.

ListEmployeesResponse list employees response swagger:model ListEmployeesResponse.

ListEmployeeWagesRequest A request for a set of `EmployeeWage` objects Example: {"request_params":"?employee_id=33fJchumvVdJwxV0H6L9\u0026limit=4\u0026cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED"} swagger:model ListEmployeeWagesRequest.

ListEmployeeWagesResponse The response to a request for a set of `EmployeeWage` objects.

ListInvoicesRequest Describes a `ListInvoice` request.

ListInvoicesResponse Describes a `ListInvoice` response.

ListLocationsResponse Defines the fields that are included in the response body of a request to the __ListLocations__ endpoint.

ListLoyaltyProgramsResponse A response that contains all loyalty programs.

ListMerchantsRequest Request object for the [ListMerchant](#endpoint-listmerchant) endpoint.

ListMerchantsResponse The response object returned by the [ListMerchant](#endpoint-listmerchant) endpoint.

ListPaymentRefundsRequest Retrieves a list of refunds for the account making the request.

ListPaymentRefundsResponse Defines the fields that are included in the response body of a request to the [ListPaymentRefunds](#endpoint-refunds-listpaymentrefunds) endpoint.

ListPaymentsRequest Retrieves a list of payments taken by the account making the request.

ListPaymentsResponse Defines the fields that are included in the response body of a request to the [ListPayments](#endpoint-payments-listpayments) endpoint.

ListRefundsRequest Defines the query parameters that can be included in a request to the [ListRefunds](#endpoint-listrefunds) endpoint.

ListRefundsResponse Defines the fields that are included in the response body of a request to the [ListRefunds](#endpoint-listrefunds) endpoint.

ListSubscriptionEventsRequest Defines parameters in a [ListSubscriptionEvents](#endpoint-subscriptions-listsubscriptionevents) endpoint request.

ListSubscriptionEventsResponse Defines the fields that are included in the response from the [ListSubscriptionEvents](#endpoint-subscriptions-listsubscriptionevents) endpoint.

ListTeamMemberBookingProfilesRequest list team member booking profiles request swagger:model ListTeamMemberBookingProfilesRequest.

ListTeamMemberBookingProfilesResponse list team member booking profiles response Example: {"errors":[],"team_member_booking_profiles":[{"display_name":"Sandbox Seller","is_bookable":true,"team_member_id":"TMXUrsBWWcHTt79t"},{"display_name":"Sandbox Staff","is_bookable":true,"team_member_id":"TMaJcbiRqPIGZuS9"}]} swagger:model ListTeamMemberBookingProfilesResponse.

ListTeamMemberWagesRequest A request for a set of `TeamMemberWage` objects Example: {"request_params":"?team_member_id=33fJchumvVdJwxV0H6L9\u0026limit=4\u0026cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED"} swagger:model ListTeamMemberWagesRequest.

ListTeamMemberWagesResponse The response to a request for a set of `TeamMemberWage` objects.

ListTransactionsRequest Defines the query parameters that can be included in a request to the [ListTransactions](#endpoint-listtransactions) endpoint.

ListTransactionsResponse Defines the fields that are included in the response body of a request to the [ListTransactions](#endpoint-listtransactions) endpoint.

ListWorkweekConfigsRequest A request for a set of `WorkweekConfig` objects Example: {"request_params":"?limit=1\u0026cursor=s4R0Z6ecFTzTC4jz8sUDBQTudX3KE313OT9fCt3VUgsXM4sMgED"} swagger:model ListWorkweekConfigsRequest.

ListWorkweekConfigsResponse The response to a request for a set of `WorkweekConfig` objects.

Location location swagger:model Location.

LoyaltyAccount Describes a loyalty account.

LoyaltyAccountMapping Associates a loyalty account with the buyer's phone number.

LoyaltyEvent Provides information about a loyalty event.

LoyaltyEventAccumulatePoints Provides metadata when the event `type` is `ACCUMULATE_POINTS`.

LoyaltyEventAdjustPoints Provides metadata when the event `type` is `ADJUST_POINTS`.

LoyaltyEventCreateReward Provides metadata when the event `type` is `CREATE_REWARD`.

LoyaltyEventDateTimeFilter Filter events by date time range.

LoyaltyEventDeleteReward Provides metadata when the event `type` is `DELETE_REWARD`.

LoyaltyEventExpirePoints Provides metadata when the event `type` is `EXPIRE_POINTS`.

LoyaltyEventFilter The filtering criteria.

LoyaltyEventLocationFilter Filter events by location.

LoyaltyEventLoyaltyAccountFilter Filter events by loyalty account.

LoyaltyEventOrderFilter Filter events by the order associated with the event.

LoyaltyEventOther Provides metadata when the event `type` is `OTHER`.

LoyaltyEventQuery Represents a query used to search for loyalty events.

LoyaltyEventRedeemReward Provides metadata when the event `type` is `REDEEM_REWARD`.

LoyaltyEventTypeFilter Filter events by event type.

LoyaltyProgram loyalty program swagger:model LoyaltyProgram.

LoyaltyProgramAccrualRule Defines an accrual rule, which is how buyers can earn points.

LoyaltyProgramExpirationPolicy Describes when the loyalty program expires.

LoyaltyProgramRewardDefinition Provides details about the reward tier discount.

LoyaltyProgramRewardTier Describes a loyalty program reward tier.

LoyaltyProgramTerminology loyalty program terminology swagger:model LoyaltyProgramTerminology.

LoyaltyReward loyalty reward swagger:model LoyaltyReward.

MeasurementUnit Represents a unit of measurement to use with a quantity, such as ounces or inches.

MeasurementUnitCustom The information needed to define a custom unit, provided by the seller.

Merchant Represents a Square seller.

Money Represents an amount of money.

ObtainTokenRequest obtain token request Example: {"request_body":{"client_id":"APPLICATION_ID","client_secret":"APPLICATION_SECRET","code":"CODE_FROM_AUTHORIZE","grant_type":"authorization_code"}} swagger:model ObtainTokenRequest.

ObtainTokenResponse obtain token response Example: {"access_token":"ACCESS_TOKEN","expires_at":"2006-01-02T15:04:05Z","merchant_id":"MERCHANT_ID","refresh_token":"REFRESH_TOKEN","token_type":"bearer"} swagger:model ObtainTokenResponse.

OnboardAppointmentsResponse onboard appointments response swagger:model OnboardAppointmentsResponse.

Order Contains all information related to a single order to process with Square, including line items that specify the products to purchase.

OrderCreated order created swagger:model OrderCreated.

OrderCreatedObject order created object swagger:model OrderCreatedObject.

OrderEntry A lightweight description of an [Order](#type-order) that is returned when `returned_entries` is true on a [SearchOrderRequest](#type-searchorderrequest) swagger:model OrderEntry.

OrderFulfillment Contains details on how to fulfill this order.

OrderFulfillmentPickupDetails Contains details necessary to fulfill a pickup order.

OrderFulfillmentPickupDetailsCurbsidePickupDetails Specific details for curbside pickup.

OrderFulfillmentRecipient Contains information on the recipient of a fulfillment.

OrderFulfillmentShipmentDetails Contains details necessary to fulfill a shipment order.

OrderFulfillmentUpdated order fulfillment updated swagger:model OrderFulfillmentUpdated.

OrderFulfillmentUpdatedObject order fulfillment updated object swagger:model OrderFulfillmentUpdatedObject.

OrderFulfillmentUpdatedUpdate Information about fulfillment updates.

OrderLineItem Represents a line item in an order.

OrderLineItemAppliedDiscount Represents an applied portion of a discount to a line item in an order.

OrderLineItemAppliedTax Represents an applied portion of a tax to a line item in an order.

OrderLineItemDiscount Represents a discount that applies to one or more line items in an order.

OrderLineItemModifier A [CatalogModifier](#type-catalogmodifier).

OrderLineItemPricingBlocklists Describes pricing adjustments that are blocked from manual and automatic application to a line item.

OrderLineItemPricingBlocklistsBlockedDiscount A discount to block from applying to a line item.

OrderLineItemPricingBlocklistsBlockedTax A tax to block from applying to a line item.

OrderLineItemTax Represents a tax that applies to one or more line item in the order.

OrderMoneyAmounts A collection of various money amounts.

OrderPricingOptions Pricing options for an order.

OrderQuantityUnit Contains the measurement unit for a quantity and a precision which specifies the number of digits after the decimal point for decimal quantities.

OrderReturn The set of line items, service charges, taxes, discounts, tips, etc.

OrderReturnDiscount Represents a discount being returned that applies to one or more return line items in an order.

OrderReturnLineItem The line item being returned in an Order.

OrderReturnLineItemModifier A line item modifier being returned.

OrderReturnServiceCharge Represents the service charge applied to the original order.

OrderReturnTax Represents a tax being returned that applies to one or more return line items in an order.

OrderReward Represents a reward that may be applied to an order if the necessary reward tier criteria are met.

OrderRoundingAdjustment A rounding adjustment of the money being returned.

OrderServiceCharge Represents a service charge applied to an order.

OrderSource Represents the origination details of an order.

OrderUpdated order updated swagger:model OrderUpdated.

OrderUpdatedObject order updated object swagger:model OrderUpdatedObject.

Payment Represents a payment processed by the Square API.

PaymentOptions payment options swagger:model PaymentOptions.

PaymentRefund Represents a refund of a payment made using Square.

PayOrderRequest Defines the fields that are included in requests to the [PayOrder](#endpoint-payorder) endpoint.

PayOrderResponse Defines the fields that are included in the response body of a request to the [PayOrder](#endpoint-payorder) endpoint.

ProcessingFee Represents the Square processing fee.

PublishInvoiceRequest Describes a `PublishInvoice` request.

PublishInvoiceResponse Describes a `PublishInvoice` response.

Range The range of a number value between the specified lower and upper bounds.

RedeemLoyaltyRewardRequest A request to redeem a loyalty reward.

RedeemLoyaltyRewardResponse A response that includes the `LoyaltyEvent` published for redeeming the reward.

Refund Represents a refund processed for a Square transaction.

RefundPaymentRequest Refunds a payment.

RefundPaymentResponse Defines the fields that are included in the response body of a request to the [RefundPayment](#endpoint-refunds-refundpayment) endpoint.

RegisterDomainRequest Defines the parameters that can be included in the body of a request to the [RegisterDomain](#endpoint-registerdomain) endpoint.

RegisterDomainResponse Defines the fields that are included in the response body of a request to the [RegisterDomain](#endpoint-registerdomain) endpoint.

RemoveDisputeEvidenceResponse Defines the fields in a `RemoveDisputeEvidence` response.

RemoveGroupFromCustomerResponse Defines the fields that are included in the response body of a request to the [RemoveGroupFromCustomer](#endpoint-removegroupfromcustomer) endpoint.

RenewTokenRequest renew token request Example: {"request_body":{"access_token":"ACCESS_TOKEN"}} swagger:model RenewTokenRequest.

RenewTokenResponse renew token response Example: {"access_token":"ACCESS_TOKEN","expires_at":"2006-01-02T15:04:05Z","merchant_id":"MERCHANT_ID","token_type":"bearer"} swagger:model RenewTokenResponse.

RetrieveBookingResponse retrieve booking response Example: {"booking":{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"created_at":"2020-10-28T15:47:41Z","customer_id":"EX2QSVGTZN4K1E5QE1CBFNVQ8M","customer_note":"","id":"zkras0xv0xwswx","location_id":"LEQHH0YY8B42M","seller_note":"","start_at":"2020-11-26T13:00:00Z","status":"ACCEPTED","updated_at":"2020-10-28T15:49:25Z","version":1},"errors":[]} swagger:model RetrieveBookingResponse.

RetrieveBusinessBookingProfileResponse retrieve business booking profile response Example: {"business_booking_profile":{"allow_user_cancel":true,"booking_enabled":true,"booking_policy":"ACCEPT_ALL","business_appointment_settings":{"alignment_time":"HALF_HOURLY","any_team_member_booking_enabled":true,"cancellation_fee_money":{"currency":"USD"},"cancellation_policy":"CUSTOM_POLICY","location_types":["BUSINESS_LOCATION"],"max_booking_lead_time_seconds":31536000,"min_booking_lead_time_seconds":0,"multiple_service_booking_enabled":true,"skip_booking_flow_staff_selection":false},"created_at":"2020-09-10T21:40:38Z","customer_timezone_choice":"CUSTOMER_CHOICE","seller_id":"MLJQYZZRM0D3Y"},"errors":[]} swagger:model RetrieveBusinessBookingProfileResponse.

RetrieveCashDrawerShiftRequest retrieve cash drawer shift request Example: {"request_body":{}} swagger:model RetrieveCashDrawerShiftRequest.

RetrieveCashDrawerShiftResponse retrieve cash drawer shift response Example: {"cash_drawer_shift":{"cash_paid_in_money":{"amount":10000,"currency":"USD"},"cash_paid_out_money":{"amount":-10000,"currency":"USD"},"cash_payment_money":{"amount":100,"currency":"USD"},"cash_refunds_money":{"amount":-100,"currency":"USD"},"closed_at":"2019-11-22T00:44:49.000Z","closed_cash_money":{"amount":9970,"currency":"USD"},"closing_employee_id":"","description":"Misplaced some change","device":{"name":"My iPad"},"ended_at":"2019-11-22T00:44:49.000Z","ending_employee_id":"","expected_cash_money":{"amount":10000,"currency":"USD"},"id":"DCC99978-09A6-4926-849F-300BE9C5793A","opened_at":"2019-11-22T00:42:54.000Z","opened_cash_money":{"amount":10000,"currency":"USD"},"opening_employee_id":"","state":"CLOSED"}} swagger:model RetrieveCashDrawerShiftResponse.

RetrieveCatalogObjectRequest retrieve catalog object request Example: {"request_params":"?include_related_objects=true"} swagger:model RetrieveCatalogObjectRequest.

RetrieveCatalogObjectResponse retrieve catalog object response Example: {"object":{"id":"W62UWFY35CWMYGVWK6TWJDNI","is_deleted":false,"item_data":{"category_id":"BJNQCF2FJ6S6UIDT65ABHLRX","description":"Hot Leaf Juice","name":"Tea","tax_ids":["HURXQOOAIC4IZSI2BEXQRYFY"],"variations":[{"id":"2TZFAOHWGG7PAK2QEXWYPZSP","is_deleted":false,"item_variation_data":{"item_id":"W62UWFY35CWMYGVWK6TWJDNI","name":"Mug","ordinal":0,"price_money":{"amount":150,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878}]},"present_at_all_locations":true,"type":"ITEM","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878},"related_objects":[{"category_data":{"name":"Beverages"},"id":"BJNQCF2FJ6S6UIDT65ABHLRX","is_deleted":false,"present_at_all_locations":true,"type":"CATEGORY","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878},{"id":"HURXQOOAIC4IZSI2BEXQRYFY","is_deleted":false,"present_at_all_locations":true,"tax_data":{"calculation_phase":"TAX_SUBTOTAL_PHASE","enabled":true,"inclusion_type":"ADDITIVE","name":"Sales Tax","percentage":"5.0"},"type":"TAX","updated_at":"2016-11-16T22:25:24.878Z","version":1479335124878}]} swagger:model RetrieveCatalogObjectResponse.

RetrieveCustomerGroupResponse Defines the fields that are included in the response body of a request to the [RetrieveCustomerGroup](#endpoint-retrievecustomergroup) endpoint.

RetrieveCustomerResponse Defines the fields that are included in the response body of a request to the RetrieveCustomer endpoint.

RetrieveCustomerSegmentResponse Defines the fields included in the response body for requests to __RetrieveCustomerSegment__.

RetrieveDisputeEvidenceResponse Defines the fields in a `RetrieveDisputeEvidence` response.

RetrieveDisputeResponse Defines fields in a `RetrieveDispute` response.

RetrieveEmployeeResponse retrieve employee response swagger:model RetrieveEmployeeResponse.

RetrieveInventoryAdjustmentResponse retrieve inventory adjustment response Example: {"adjustment":{"catalog_object_id":"W62UWFY35CWMYGVWK6TWJDNI","catalog_object_type":"ITEM_VARIATION","created_at":"2016-11-17T13:02:15.142Z","employee_id":"LRK57NSQ5X7PUD05","from_state":"IN_STOCK","id":"UDMOEO78BG6GYWA2XDRYX3KB","location_id":"C6W5YS5QM06F5","occurred_at":"2016-11-16T25:44:22.837Z","quantity":"7","reference_id":"4a366069-4096-47a2-99a5-0084ac879509","source":{"application_id":"416ff29c-86c4-4feb-b58c-9705f21f3ea0","name":"Square Point of Sale 4.37","product":"SQUARE_POS"},"to_state":"SOLD","total_price_money":{"amount":4550,"currency":"USD"}},"errors":[]} swagger:model RetrieveInventoryAdjustmentResponse.

RetrieveInventoryChangesRequest retrieve inventory changes request Example: {"request_params":"?location_ids=\u0026cursor="} swagger:model RetrieveInventoryChangesRequest.

RetrieveInventoryChangesResponse retrieve inventory changes response Example: {"changes":[{"adjustment":{"catalog_object_id":"W62UWFY35CWMYGVWK6TWJDNI","catalog_object_type":"ITEM_VARIATION","created_at":"2016-11-16T22:25:24.878Z","employee_id":"AV7YRCGI2H1J5NQ8E1XIZCNA","from_state":"IN_STOCK","id":"OJKJIUANKLMLQANZADNPLKAD","location_id":"C6W5YS5QM06F5","occurred_at":"2016-11-16T22:25:24.878Z","quantity":"3","reference_id":"d8207693-168f-4b44-a2fd-a7ff533ddd26","source":{"application_id":"416ff29c-86c4-4feb-b58c-9705f21f3ea0","name":"Square Point of Sale 4.37","product":"SQUARE_POS"},"to_state":"SOLD","total_price_money":{"amount":5000,"currency":"USD"},"transaction_id":"5APV6JYK1SNCZD11AND2RX1Z"},"type":"ADJUSTMENT"}],"errors":[]} swagger:model RetrieveInventoryChangesResponse.

RetrieveInventoryCountRequest retrieve inventory count request Example: {"request_params":"?location_ids=C6W5YS5QM06F5\u0026cursor="} swagger:model RetrieveInventoryCountRequest.

RetrieveInventoryCountResponse retrieve inventory count response Example: {"counts":[{"calculated_at":"2016-11-16T22:28:01.223Z","catalog_object_id":"W62UWFY35CWMYGVWK6TWJDNI","catalog_object_type":"ITEM_VARIATION","location_id":"C6W5YS5QM06F5","quantity":"22","state":"IN_STOCK"}],"errors":[]} swagger:model RetrieveInventoryCountResponse.

RetrieveInventoryPhysicalCountResponse retrieve inventory physical count response Example: {"count":{"catalog_object_id":"W62UWFY35CWMYGVWK6TWJDNI","catalog_object_type":"ITEM_VARIATION","created_at":"2016-11-16T22:25:24.878Z","employee_id":"LRK57NSQ5X7PUD05","id":"ANZADNPLKADOJKJIUANKLMLQ","location_id":"C6W5YS5QM06F5","occurred_at":"2016-11-16T22:25:24.878Z","quantity":"15","reference_id":"f857ec37-f9a0-4458-8e23-5b5e0bea4e53","source":{"application_id":"416ff29c-86c4-4feb-b58c-9705f21f3ea0","name":"Square Point of Sale 4.37","product":"SQUARE_POS"},"state":"IN_STOCK"},"errors":[]} swagger:model RetrieveInventoryPhysicalCountResponse.

RetrieveLocationResponse Defines the fields that the [RetrieveLocation](#endpoint-retrievelocation) endpoint returns in a response.

RetrieveLoyaltyAccountResponse A response that includes the loyalty account.

RetrieveLoyaltyRewardResponse A response that includes the loyalty reward.

RetrieveMerchantResponse The response object returned by the [RetrieveMerchant](#endpoint-retrieveMerchant) endpoint.

RetrieveObsMigrationProfileResponse retrieve obs migration profile response swagger:model RetrieveObsMigrationProfileResponse.

RetrieveOrderResponse retrieve order response Example: {"order":{"created_at":"2020-05-18T16:30:49.614Z","discounts":[{"applied_money":{"amount":550,"currency":"USD"},"name":"50% Off","percentage":"50","scope":"ORDER","type":"FIXED_PERCENTAGE","uid":"zGsRZP69aqSSR9lq9euSPB"}],"id":"CAISENgvlJ6jLWAzERDzjyHVybY","line_items":[{"applied_discounts":[{"applied_money":{"amount":250,"currency":"USD"},"discount_uid":"zGsRZP69aqSSR9lq9euSPB","uid":"9zr9S4dxvPAixvn0lpa1VC"}],"base_price_money":{"amount":500,"currency":"USD"},"gross_sales_money":{"amount":500,"currency":"USD"},"name":"Item 1","quantity":"1","total_discount_money":{"amount":250,"currency":"USD"},"total_money":{"amount":250,"currency":"USD"},"total_tax_money":{"amount":0,"currency":"USD"},"uid":"ULkg0tQTRK2bkU9fNv3IJD","variation_total_price_money":{"amount":500,"currency":"USD"}},{"applied_discounts":[{"applied_money":{"amount":300,"currency":"USD"},"discount_uid":"zGsRZP69aqSSR9lq9euSPB","uid":"qa8LwwZK82FgSEkQc2HYVC"}],"base_price_money":{"amount":300,"currency":"USD"},"gross_sales_money":{"amount":600,"currency":"USD"},"name":"Item 2","quantity":"2","total_discount_money":{"amount":300,"currency":"USD"},"total_money":{"amount":300,"currency":"USD"},"total_tax_money":{"amount":0,"currency":"USD"},"uid":"mumY8Nun4BC5aKe2yyx5a","variation_total_price_money":{"amount":600,"currency":"USD"}}],"location_id":"D7AVYMEAPJ3A3","net_amounts":{"discount_money":{"amount":550,"currency":"USD"},"service_charge_money":{"amount":0,"currency":"USD"},"tax_money":{"amount":0,"currency":"USD"},"tip_money":{"amount":0,"currency":"USD"},"total_money":{"amount":550,"currency":"USD"}},"state":"OPEN","total_discount_money":{"amount":550,"currency":"USD"},"total_money":{"amount":550,"currency":"USD"},"total_service_charge_money":{"amount":0,"currency":"USD"},"total_tax_money":{"amount":0,"currency":"USD"},"total_tip_money":{"amount":0,"currency":"USD"},"updated_at":"2020-05-18T16:30:49.614Z","version":1}} swagger:model RetrieveOrderResponse.

RetrieveSubscriptionResponse Defines the fields that are included in the response from the [RetrieveSubscription](#endpoint-subscriptions-retrievesubscription) endpoint.

RetrieveTeamMemberBookingProfileResponse retrieve team member booking profile response Example: {"errors":[],"team_member_booking_profile":{"display_name":"Sandbox Staff","is_bookable":true,"team_member_id":"TMaJcbiRqPIGZuS9"}} swagger:model RetrieveTeamMemberBookingProfileResponse.

RetrieveTeamMemberResponse Represents a response from a retrieve request, containing a `TeamMember` object or error messages.

RetrieveTransactionResponse Defines the fields that are included in the response body of a request to the [RetrieveTransaction](#endpont-retrievetransaction) endpoint.

RetrieveWageSettingResponse Represents a response from a retrieve request, containing the specified `WageSetting` object or error messages.

RevokeTokenRequest revoke token request Example: {"request_body":{"access_token":"ACCESS_TOKEN","client_id":"CLIENT_ID"}} swagger:model RevokeTokenRequest.

RevokeTokenResponse revoke token response Example: {"success":true} swagger:model RevokeTokenResponse.

RiskEvaluation Represents fraud risk information for the associated payment.

SearchAvailabilityFilter A query filter to search for availabilities by.

SearchAvailabilityQuery Query conditions to search for availabilities of bookings.

SearchAvailabilityRequest search availability request Example: {"query":{"filter":{"location_id":"LEQHH0YY8B42M","segment_filters":[{"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","team_member_id_filter":{"any":["TMXUrsBWWcHTt79t","TMaJcbiRqPIGZuS9"]}}],"start_at_range":{"end_at":"2020-11-27T13:00:00Z","start_at":"2020-11-26T13:00:00Z"}}}} swagger:model SearchAvailabilityRequest.

SearchAvailabilityResponse search availability response Example: {"availabilities":[{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-26T13:00:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-26T13:30:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMaJcbiRqPIGZuS9"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-26T14:00:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMaJcbiRqPIGZuS9"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-26T14:30:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMaJcbiRqPIGZuS9"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-26T15:00:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMaJcbiRqPIGZuS9"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-26T15:30:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMaJcbiRqPIGZuS9"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-26T16:00:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T09:00:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMaJcbiRqPIGZuS9"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T09:30:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T10:00:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T10:30:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T11:00:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMaJcbiRqPIGZuS9"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T11:30:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMaJcbiRqPIGZuS9"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T12:00:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMaJcbiRqPIGZuS9"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T12:30:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T13:00:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T13:30:00Z"},{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMaJcbiRqPIGZuS9"}],"location_id":"LEQHH0YY8B42M","start_at":"2020-11-27T14:00:00Z"}],"errors":[]} swagger:model SearchAvailabilityResponse.

SearchCatalogItemsRequest Defines the request body for the [SearchCatalogItems](#endpoint-Catalog-SearchCatalogItems) endpoint.

SearchCatalogItemsResponse Defines the response body returned from the [SearchCatalogItems](#endpoint-Catalog-SearchCatalogItems) endpoint.

SearchCatalogObjectsRequest search catalog objects request Example: {"request_body":{"limit":100,"object_types":["ITEM"],"query":{"prefix_query":{"attribute_name":"name","attribute_prefix":"tea"}}}} swagger:model SearchCatalogObjectsRequest.

SearchCatalogObjectsResponse search catalog objects response Example: {"objects":[{"id":"X5DZ5NWWAQ44CKBLKIFQGOWK","is_deleted":false,"item_data":{"category_id":"E7CLE5RZZ744BHWVQQEAHI2C","description":"A delicious blend of black tea.","name":"Tea - Black","product_type":"REGULAR","tax_ids":["ZXITPM6RWHZ7GZ7EIP3YKECM"],"variations":[{"id":"5GSZPX6EU7MM75S57OONG3V5","is_deleted":false,"item_variation_data":{"item_id":"X5DZ5NWWAQ44CKBLKIFQGOWK","name":"Regular","ordinal":1,"price_money":{"amount":150,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION","updated_at":"2017-10-26T15:27:31.626Z","version":1509031651626},{"id":"XVLBN7DU6JTWHJTG5F265B43","is_deleted":false,"item_variation_data":{"item_id":"X5DZ5NWWAQ44CKBLKIFQGOWK","name":"Large","ordinal":2,"price_money":{"amount":225,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION","updated_at":"2017-10-26T15:27:31.626Z","version":1509031651626}],"visibility":"PRIVATE"},"present_at_all_locations":true,"type":"ITEM","updated_at":"2017-10-26T15:41:32.337Z","version":1509032492337},{"id":"NNNEM3LA656Q46NXLWCNI7S5","is_deleted":false,"item_data":{"category_id":"E7CLE5RZZ744BHWVQQEAHI2C","description":"Relaxing green herbal tea.","name":"Tea - Green","product_type":"REGULAR","tax_ids":["ZXITPM6RWHZ7GZ7EIP3YKECM"],"variations":[{"id":"FHYBVIA6NVBCSOVETA62WEA4","is_deleted":false,"item_variation_data":{"item_id":"NNNEM3LA656Q46NXLWCNI7S5","name":"Regular","ordinal":1,"price_money":{"amount":150,"currency":"USD"},"pricing_type":"FIXED_PRICING"},"present_at_all_locations":true,"type":"ITEM_VARIATION","updated_at":"2017-10-26T15:29:00.524Z","version":1509031740524}],"visibility":"PRIVATE"},"present_at_all_locations":true,"type":"ITEM","updated_at":"2017-10-26T15:41:23.232Z","version":1509032483232}]} swagger:model SearchCatalogObjectsResponse.

SearchCustomersRequest Defines the fields included in the request body for the SearchCustomers endpoint.

SearchCustomersResponse Defines the fields that are included in the response body of a request to the SearchCustomers endpoint.

SearchInvoicesRequest Describes a `SearchInvoices` request.

SearchInvoicesResponse Describes a `SearchInvoices` response.

SearchLoyaltyAccountsRequest A request to search for loyalty accounts.

SearchLoyaltyAccountsRequestLoyaltyAccountQuery The search criteria for the loyalty accounts.

SearchLoyaltyAccountsResponse A response that includes loyalty accounts that satisfy the search criteria.

SearchLoyaltyEventsRequest A request to search for loyalty events.

SearchLoyaltyEventsResponse A response that contains loyalty events that satisfy the search criteria, in order by the `created_at` date.

SearchLoyaltyRewardsRequest A request to search for loyalty rewards.

SearchLoyaltyRewardsRequestLoyaltyRewardQuery The set of search requirements.

SearchLoyaltyRewardsResponse A response that includes the loyalty rewards satisfying the search criteria.

SearchOrdersCustomerFilter Filter based on Order `customer_id` and any Tender `customer_id` associated with the Order.

SearchOrdersDateTimeFilter Filter for `Order` objects based on whether their `CREATED_AT`, `CLOSED_AT` or `UPDATED_AT` timestamps fall within a specified time range.

SearchOrdersFilter Filtering criteria to use for a SearchOrders request.

SearchOrdersFulfillmentFilter Filter based on [Order Fulfillment](#type-orderfulfillment) information.

SearchOrdersQuery Contains query criteria for the search.

SearchOrdersRequest The request does not have any required fields.

SearchOrdersResponse Only one of `order_entries` or `orders` fields will be set, depending on whether `return_entries` was set on the [SearchOrdersRequest](#type-searchorderrequest).

SearchOrdersSort Sorting criteria for a SearchOrders request.

SearchOrdersSourceFilter Filter based on order `source` information.

SearchOrdersStateFilter Filter by current Order `state`.

SearchShiftsRequest A request for a filtered and sorted set of `Shift` objects.

SearchShiftsResponse The response to a request for `Shift` objects.

SearchSubscriptionsFilter Represents a set of SearchSubscriptionsQuery filters used to limit the set of Subscriptions returned by SearchSubscriptions.

SearchSubscriptionsQuery Represents a query (including filtering criteria) used to search for subscriptions.

SearchSubscriptionsRequest Defines parameters in a [SearchSubscriptions](#endpoint-subscriptions-searchsubscriptions) endpoint request.

SearchSubscriptionsResponse Defines the fields that are included in the response from the [SearchSubscriptions](#endpoint-subscriptions-searchsubscriptions) endpoint.

SearchTeamMembersFilter Represents a filter used in a search for `TeamMember` objects.

SearchTeamMembersQuery Represents the parameters in a search for `TeamMember` objects.

SearchTeamMembersRequest Represents a search request for a filtered list of `TeamMember` objects.

SearchTeamMembersResponse Represents a response from a search request, containing a filtered list of `TeamMember` objects.

SearchTerminalCheckoutsRequest search terminal checkouts request Example: {"request_body":{"limit":2,"query":{"filter":{"status":"COMPLETED"}}}} swagger:model SearchTerminalCheckoutsRequest.

SearchTerminalCheckoutsResponse search terminal checkouts response Example: {"checkouts":[{"amount_money":{"amount":2610,"currency":"USD"},"app_id":"APP_ID","created_at":"2020-03-31T18:13:15.921Z","deadline_duration":"PT10M","device_options":{"device_id":"dbb5d83a-7838-11ea-bc55-0242ac130003","skip_receipt_screen":false,"tip_settings":{"allow_tipping":false}},"id":"tsQPvzwBpMqqO","note":"A brief note","payment_ids":["rXnhZzywrEk4vR6pw76fPZfgvaB"],"reference_id":"id14467","status":"COMPLETED","updated_at":"2020-03-31T18:13:52.725Z"},{"amount_money":{"amount":2610,"currency":"USD"},"app_id":"APP_ID","created_at":"2020-03-31T18:08:31.882Z","deadline_duration":"PT10M","device_options":{"device_id":"dbb5d83a-7838-11ea-bc55-0242ac130003","skip_receipt_screen":true,"tip_settings":{"allow_tipping":false}},"id":"XlOPTgcEhrbqO","note":"A brief note","payment_ids":["VYBF861PaoKPP7Pih0TlbZiNvaB"],"reference_id":"id41623","status":"COMPLETED","updated_at":"2020-03-31T18:08:41.635Z"}],"cursor":"RiTJqBoTuXlbLmmrPvEkX9iG7XnQ4W4RjGnH"} swagger:model SearchTerminalCheckoutsResponse.

SearchTerminalRefundsRequest search terminal refunds request Example: {"request_body":{"limit":1,"query":{"filter":{"status":"COMPLETED"}}}} swagger:model SearchTerminalRefundsRequest.

SearchTerminalRefundsResponse search terminal refunds response Example: {"refunds":[{"amount_money":{"amount":111,"currency":"CAD"},"app_id":"sandbox-sq0idb-c2OuYt13YaCAeJq_2cd8OQ","card":{"bin":"411111","card_brand":"INTERAC","card_type":"CREDIT","exp_month":1,"exp_year":2022,"fingerprint":"sq-1-B1fP9MNNmZgVVaPKRND6oDKYbz25S2cTvg9Mzwg3RMTK1zT1PiGRT-AE3nTA8vSmmw","last_4":"1111"},"created_at":"2020-09-29T15:21:46.771Z","deadline_duration":"PT5M","device_id":"f72dfb8e-4d65-4e56-aade-ec3fb8d33291","id":"009DP5HD-5O5OvgkcNUhl7JBuINflcjKqUzXZY","location_id":"76C9W6K8CNNQ5","order_id":"kcuKDKreRaI4gF4TjmEgZjHk8Z7YY","payment_id":"5O5OvgkcNUhl7JBuINflcjKqUzXZY","reason":"Returning item","refund_id":"5O5OvgkcNUhl7JBuINflcjKqUzXZY_43Q4iGp7sNeATiWrUruA1EYeMRUXaddXXlDDJ1EQLvb","status":"COMPLETED","updated_at":"2020-09-29T15:21:48.675Z"}]} swagger:model SearchTerminalRefundsResponse.

SegmentFilter A query filter to search for appointment segments by.

Shift A record of the hourly rate, start, and end times for a single work shift for an employee.

ShiftFilter Defines a filter used in a search for `Shift` records.

ShiftQuery The parameters of a `Shift` search query.

ShiftSort Sets the sort order of search results.

ShiftWage The hourly wage rate used to compensate an employee for this shift.

ShiftWorkday A `Shift` search query filter parameter that sets a range of days that a `Shift` must start or end in before passing the filter condition.

SourceApplication Provides information about the application used to generate a change.

StandardUnitDescription Contains the name and abbreviation for standard measurement unit.

StandardUnitDescriptionGroup Group of standard measurement units.

SubmitEvidenceResponse Defines the fields in a `SubmitEvidence` response.

Subscription Represents a customer subscription to a subscription plan.

SubscriptionEvent Describes changes to subscription and billing states.

SubscriptionPhase Describes a phase in a subscription plan.

TeamMember A record representing an individual team member for a business.

TeamMemberAssignedLocations An object that represents a team member's assignment to locations.

TeamMemberBookingProfile The booking profile of a seller's team member, including the team member's ID, display name, description and whether the team member can be booked as a service provider.

TeamMemberWage The hourly wage rate that a team member will earn on a `Shift` for doing the job specified by the `title` property of this object.

Tender Represents a tender (i.e., a method of payment) used in a Square transaction.

TenderCardDetails Represents additional details of a tender with `type` `CARD` or `SQUARE_GIFT_CARD` swagger:model TenderCardDetails.

TenderCashDetails Represents the details of a tender with `type` `CASH`.

TerminalCheckout terminal checkout swagger:model TerminalCheckout.

TerminalCheckoutQuery terminal checkout query swagger:model TerminalCheckoutQuery.

TerminalCheckoutQueryFilter terminal checkout query filter swagger:model TerminalCheckoutQueryFilter.

TerminalCheckoutQuerySort terminal checkout query sort swagger:model TerminalCheckoutQuerySort.

TerminalRefund terminal refund swagger:model TerminalRefund.

TerminalRefundQuery terminal refund query swagger:model TerminalRefundQuery.

TerminalRefundQueryFilter terminal refund query filter swagger:model TerminalRefundQueryFilter.

TerminalRefundQuerySort terminal refund query sort swagger:model TerminalRefundQuerySort.

TimeRange Represents a generic time range.

TipSettings tip settings swagger:model TipSettings.

Transaction Represents a transaction processed with Square, either with the Connect API or with Square Point of Sale.

UpdateBookingRequest update booking request Example: {"booking":{"customer_note":"I would like to sit near the window please","version":1}} swagger:model UpdateBookingRequest.

UpdateBookingResponse update booking response Example: {"booking":{"appointment_segments":[{"duration_minutes":60,"service_variation_id":"RU3PBTZTK7DXZDQFCJHOK2MC","service_variation_version":1599775456731,"team_member_id":"TMXUrsBWWcHTt79t"}],"created_at":"2020-10-28T15:47:41Z","customer_id":"EX2QSVGTZN4K1E5QE1CBFNVQ8M","customer_note":"I would like to sit near the window please","id":"zkras0xv0xwswx","location_id":"LEQHH0YY8B42M","seller_note":"","start_at":"2020-11-26T13:00:00Z","status":"ACCEPTED","updated_at":"2020-10-28T15:49:25Z","version":2},"errors":[]} swagger:model UpdateBookingResponse.

UpdateBreakTypeRequest A request to update a `BreakType` Example: {"request_body":{"break_type":{"break_name":"Lunch","expected_duration":"PT50M","is_paid":true,"location_id":"26M7H24AZ9N6R","version":1}}} swagger:model UpdateBreakTypeRequest.

UpdateBreakTypeResponse A response to a request to update a `BreakType`.

UpdateCustomerGroupRequest Defines the body parameters that can be provided in a request to the [UpdateCustomerGroup](#endpoint-updatecustomergroup) endpoint.

UpdateCustomerGroupResponse Defines the fields that are included in the response body of a request to the [UpdateCustomerGroup](#endpoint-updatecustomergroup) endpoint.

UpdateCustomerRequest Defines the body parameters that can be provided in a request to the UpdateCustomer endpoint.

UpdateCustomerResponse Defines the fields that are included in the response body of a request to the UpdateCustomer endpoint.

UpdateInvoiceRequest Describes a `UpdateInvoice` request.

UpdateInvoiceResponse Describes a `UpdateInvoice` response.

UpdateItemModifierListsRequest update item modifier lists request Example: {"request_body":{"item_ids":["H42BRLUJ5KTZTTMPVSLFAACQ","2JXOBJIHCWBQ4NZ3RIXQGJA6"],"modifier_lists_to_disable":["7WRC16CJZDVLSNDQ35PP6YAD"],"modifier_lists_to_enable":["H42BRLUJ5KTZTTMPVSLFAACQ","2JXOBJIHCWBQ4NZ3RIXQGJA6"]}} swagger:model UpdateItemModifierListsRequest.

UpdateItemModifierListsResponse update item modifier lists response Example: {"updated_at":"2016-11-16T22:25:24.878Z"} swagger:model UpdateItemModifierListsResponse.

UpdateItemTaxesRequest update item taxes request Example: {"request_body":{"item_ids":["H42BRLUJ5KTZTTMPVSLFAACQ","2JXOBJIHCWBQ4NZ3RIXQGJA6"],"taxes_to_disable":["AQCEGCEBBQONINDOHRGZISEX"],"taxes_to_enable":["4WRCNHCJZDVLSNDQ35PP6YAD"]}} swagger:model UpdateItemTaxesRequest.

UpdateItemTaxesResponse update item taxes response Example: {"updated_at":"2016-11-16T22:25:24.878Z"} swagger:model UpdateItemTaxesResponse.

UpdateLocationRequest Request object for the [UpdateLocation](#endpoint-updatelocation) endpoint.

UpdateLocationResponse Response object returned by the [UpdateLocation](#endpoint-updatelocation) endpoint.

UpdateOrderRequest Defines the fields that are included in requests to the [UpdateOrder](#endpoint-orders-updateorder) endpoint.

UpdateOrderResponse Defines the fields that are included in the response body of a request to the [UpdateOrder](#endpoint-orders-updateorder) endpoint.

UpdateShiftRequest A request to update a `Shift` object.

UpdateShiftResponse The response to a request to update a `Shift`.

UpdateSubscriptionRequest Defines parameters in a [UpdateSubscription](#endpoint-subscriptions-updatesubscription) endpoint request.

UpdateSubscriptionResponse Defines the fields that are included in the response from the [UpdateSubscription](#endpoint-subscriptions-updatesubscription) endpoint.

UpdateTeamMemberRequest Represents an update request for a `TeamMember` object.

UpdateTeamMemberResponse Represents a response from an update request, containing the updated `TeamMember` object or error messages.

UpdateWageSettingRequest Represents an update request for the `WageSetting` object describing a `TeamMember`.

UpdateWageSettingResponse Represents a response from an update request, containing the updated `WageSetting` object or error messages.

UpdateWorkweekConfigRequest A request to update a `WorkweekConfig` object Example: {"request_body":{"workweek_config":{"start_of_day_local_time":"10:00","start_of_week":"MON","version":10}}} swagger:model UpdateWorkweekConfigRequest.

UpdateWorkweekConfigResponse The response to a request to update a `WorkweekConfig` object.

UpsertCatalogObjectRequest upsert catalog object request Example: {"request_body":{"idempotency_key":"af3d1afc-7212-4300-b463-0bfc5314a5ae","object":{"id":"#Cocoa","item_data":{"abbreviation":"Ch","description":"Hot chocolate","name":"Cocoa"},"type":"ITEM"}}} swagger:model UpsertCatalogObjectRequest.

UpsertCatalogObjectResponse upsert catalog object response Example: {"catalog_object":{"id":"7SB3ZQYJ5GDMVFL7JK46JCHT","is_deleted":false,"item_data":{"abbreviation":"Ch","description":"Hot chocolate","name":"Cocoa"},"type":"ITEM","updated_at":"2016-11-16T22:32:42.996Z","version":1479335562996},"id_mappings":[{"client_object_id":"#Cocoa","object_id":"7SB3ZQYJ5GDMVFL7JK46JCHT"}]} swagger:model UpsertCatalogObjectResponse.

VoidTransactionResponse Defines the fields that are included in the response body of a request to the [VoidTransaction](#endpoint-voidtransaction) endpoint.

WageSetting An object representing a team member's wage information.

WorkweekConfig Sets the Day of the week and hour of the day that a business starts a work week.

AcceptDisputeRequest Defines the request parameters for the `AcceptDispute` endpoint.

AddGroupToCustomerRequest Defines the fields that are included in the request body of a request to the [AddGroupToCustomer](#endpoint-addgrouptocustomer) endpoint.

CancelPaymentRequest Cancels (voids) a payment before it has been completed.

CancelSubscriptionRequest Defines parameters in a [CancelSubscription](#endpoint-subscriptions-cancelsubscription) endpoint request.

CancelTerminalCheckoutRequest cancel terminal checkout request Example: {"request_body":{}} swagger:model CancelTerminalCheckoutRequest.

CancelTerminalRefundRequest cancel terminal refund request Example: {"request_body":{}} swagger:model CancelTerminalRefundRequest.

CaptureTransactionRequest capture transaction request Example: {} swagger:model CaptureTransactionRequest.

CatalogInfoRequest catalog info request Example: {} swagger:model CatalogInfoRequest.

CheckAppointmentsOnboardedRequest check appointments onboarded request swagger:model CheckAppointmentsOnboardedRequest.

CompletePaymentRequest Completes (captures) a payment.

DeleteBreakTypeRequest A request to delete a `BreakType` Example: {} swagger:model DeleteBreakTypeRequest.

DeleteCatalogObjectRequest delete catalog object request Example: {} swagger:model DeleteCatalogObjectRequest.

DeleteCustomerCardRequest Defines the fields that are included in requests to the DeleteCustomerCard endpoint.

DeleteCustomerGroupRequest Defines the fields that can be provided in a request to the [DeleteCustomerGroup](#endpoint-deletecustomergroup) endpoint.

DeleteCustomerRequest Defines the fields that are included in a request to the DeleteCustomer endpoint.

DeleteLoyaltyRewardRequest A request to delete a loyalty reward.

DeleteShiftRequest A request to delete a `Shift` Example: {} swagger:model DeleteShiftRequest.

GetBankAccountByV1IDRequest Request object for fetching a specific `BankAccount` by the object ID.

GetBankAccountRequest Request object to fetch a specific `BankAccount` by the object ID.

GetBreakTypeRequest A request to GET a `BreakType` by ID Example: {} swagger:model GetBreakTypeRequest.

GetDeviceCodeRequest get device code request Example: {"request_body":{}} swagger:model GetDeviceCodeRequest.

GetEmployeeWageRequest A request to get an `EmployeeWage` Example: {} swagger:model GetEmployeeWageRequest.

GetInvoiceRequest Describes a `GetInvoice` request.

GetPaymentRefundRequest Retrieves a specific `Refund` using the `refund_id`.

GetPaymentRequest Retrieve details for a specific payment.

GetShiftRequest A request to get a `Shift` by ID Example: {} swagger:model GetShiftRequest.

GetTeamMemberWageRequest A request to get an `TeamMemberWage` Example: {} swagger:model GetTeamMemberWageRequest.

GetTerminalCheckoutRequest get terminal checkout request Example: {"request_body":{}} swagger:model GetTerminalCheckoutRequest.

GetTerminalRefundRequest get terminal refund request Example: {"request_body":{}} swagger:model GetTerminalRefundRequest.

ListDisputeEvidenceRequest Defines the parameters for a `ListDisputeEvidence` request.

ListLocationsRequest Defines the fields that are included in requests to the __ListLocations__ endpoint.

ListLoyaltyProgramsRequest A request to list `LoyaltyProgram`.

OnboardAppointmentsRequest onboard appointments request swagger:model OnboardAppointmentsRequest.

RemoveDisputeEvidenceRequest Defines the parameters for a `RemoveDisputeEvidence` request.

RemoveGroupFromCustomerRequest Defines the fields that are included in the request body of a request to the [RemoveGroupFromCustomer](#endpoint-removegroupfromcustomer) endpoint.

RetrieveBookingRequest retrieve booking request swagger:model RetrieveBookingRequest.

RetrieveBusinessBookingProfileRequest retrieve business booking profile request swagger:model RetrieveBusinessBookingProfileRequest.

RetrieveCustomerGroupRequest Defines the fields that can be provided in a request to the [RetrieveCustomerGroup](#endpoint-retrievecustomergroup) endpoint.

RetrieveCustomerRequest Defines the fields that are included in requests to the RetrieveCustomer endpoint.

RetrieveCustomerSegmentRequest Defines the valid parameters for requests to __RetrieveCustomerSegmentRequest__.

RetrieveDisputeEvidenceRequest Defines the parameters for a `RetrieveDisputeEvidence` request.

RetrieveDisputeRequest Defines the request parameters for the `RetrieveDispute` endpoint.

RetrieveEmployeeRequest retrieve employee request swagger:model RetrieveEmployeeRequest.

RetrieveInventoryAdjustmentRequest retrieve inventory adjustment request Example: {} swagger:model RetrieveInventoryAdjustmentRequest.

RetrieveInventoryPhysicalCountRequest retrieve inventory physical count request Example: {} swagger:model RetrieveInventoryPhysicalCountRequest.

RetrieveLocationRequest Defines the fields that are included in the request body for the __RetrieveLocation__ endpoint.

RetrieveLoyaltyAccountRequest A request to retrieve a loyalty account.

RetrieveLoyaltyRewardRequest A request to retrieve a loyalty reward.

RetrieveMerchantRequest Request object for the [RetrieveMerchant](#endpoint-retrievemerchant) endpoint.

RetrieveObsMigrationProfileRequest retrieve obs migration profile request swagger:model RetrieveObsMigrationProfileRequest.

RetrieveOrderRequest retrieve order request Example: {"request_body":{}} swagger:model RetrieveOrderRequest.

RetrieveSubscriptionRequest Defines parameters in a [RetrieveSubscription](#endpoint-subscriptions-retrievesubscription) endpoint request.

RetrieveTeamMemberBookingProfileRequest retrieve team member booking profile request swagger:model RetrieveTeamMemberBookingProfileRequest.

RetrieveTeamMemberRequest Represents a retrieve request for a `TeamMember` object.

RetrieveTransactionRequest retrieve transaction request Example: {} swagger:model RetrieveTransactionRequest.

RetrieveWageSettingRequest Represents a retrieve request for the wage setting of a team member Example: {"request_body":{}} swagger:model RetrieveWageSettingRequest.

SubmitEvidenceRequest Defines the parameters for a `SubmitEvidence` request.

VoidTransactionRequest void transaction request Example: {} swagger:model VoidTransactionRequest.

ActionCancelReason action cancel reason swagger:model ActionCancelReason.

BankAccountStatus Indicates the current verification status of a `BankAccount` object.

BankAccountType Indicates the financial purpose of the bank account.

BookingStatus Supported booking statuses.

BusinessAppointmentSettingsAlignmentTime Time units of a service duration for bookings.

BusinessAppointmentSettingsBookingLocationType Types of location where service is provided.

BusinessAppointmentSettingsCancellationPolicy The category of the seller’s cancellation policy.

BusinessAppointmentSettingsMaxAppointmentsPerDayLimitType Types of daily appointment limits.

BusinessBookingProfileBookingPolicy Policies for accepting bookings.

BusinessBookingProfileCustomerTimezoneChoice Choices of customer-facing time zone used for bookings.

CardBrand Indicates a card's brand, such as `VISA` or `MASTERCARD`.

CardPrepaidType Indicates a card's prepaid type, such as `NOT_PREPAID` or `PREPAID`.

CardSquareProduct card square product swagger:model CardSquareProduct.

CardType Indicates a card's type, such as `CREDIT` or `DEBIT`.

CashDrawerEventType The types of events on a CashDrawerShift.

CashDrawerShiftState The current state of a cash drawer shift.

CatalogCustomAttributeDefinitionAppVisibility Defines the visibility of a custom attribute to applications other than their creating application.

CatalogCustomAttributeDefinitionSellerVisibility Defines the visibility of a custom attribute to sellers in Square client applications, Square APIs or in Square UIs (including Square Point of Sale applications and Square Dashboard).

CatalogCustomAttributeDefinitionType Defines the possible types for a custom attribute.

CatalogDiscountModifyTaxBasis catalog discount modify tax basis swagger:model CatalogDiscountModifyTaxBasis.

CatalogDiscountType How to apply a CatalogDiscount to a CatalogItem.

CatalogItemProductType The type of a CatalogItem.

CatalogModifierListSelectionType Indicates whether a CatalogModifierList supports multiple selections.

CatalogObjectType Possible types of CatalogObjects returned from the Catalog, each containing type-specific properties in the `*_data` field corresponding to the object type.

CatalogPricingType Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.

CatalogQuickAmountsSettingsOption Determines a seller's option on Quick Amounts feature.

CatalogQuickAmountType Determines the type of a specific Quick Amount.

Country Indicates the country associated with another entity, such as a business.

Currency Indicates the associated currency for an amount of money.

CustomerCreationSource Indicates the method used to create the customer profile.

CustomerInclusionExclusion Indicates whether customers should be included in, or excluded from, the result set when they match the filtering criteria.

CustomerSortField Specifies customer attributes as the sort key to customer profiles returned from a search.

DayOfWeek Indicates the specific day of the week.

DeviceCodeStatus DeviceCode.Status enum.

DisputeEvidenceType The type of the dispute evidence.

DisputeReason The list of possible reasons why a cardholder might initiate a dispute with their bank.

DisputeState The list of possible dispute states.

EcomVisibility Determines item visibility in Ecom (Online Store) and Online Checkout.

EmployeeStatus The status of the Employee being retrieved.

ErrorCategory Indicates which high-level category of error has occurred during a request to the Connect API.

ErrorCode Indicates the specific error that occurred during a request to a Square API.

ExcludeStrategy Indicates which products matched by a CatalogPricingRule will be excluded if the pricing rule uses an exclude set.

InlineTypes Object types to inline under their respective parent object in certain connect v2 responses swagger:model InlineTypes.

InventoryAlertType Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.

InventoryChangeType Indicates how the inventory change was applied to a tracked quantity of items.

InventoryState Indicates the state of a tracked item quantity in the lifecycle of goods.

InvoiceAutomaticPaymentSource Indicates the automatic payment method for an `invoice payment request`.

InvoiceCustomFieldPlacement Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF copies of the invoice.

InvoiceDeliveryMethod Indicates how Square delivers the `invoice` to the customer.

InvoicePaymentReminderStatus The status of a payment request reminder.

InvoiceRequestMethod Specifies the action for Square to take for processing the invoice.

InvoiceRequestType Indicates the type of the payment request.

InvoiceSortField Field to use for sorting.

InvoiceStatus Indicates the status of an invoice.

JobAssignmentPayType Enumerates the possible pay types that a job can be assigned.

LocationCapability The capabilities a location may have.

LocationStatus The status of the location, whether a location is active or inactive.

LocationType A location's physical or mobile type.

LoyaltyAccountMappingType The type of mapping.

LoyaltyEventSource Defines whether the event was generated by the Square Point of Sale.

LoyaltyEventType The type of the loyalty event.

LoyaltyProgramAccrualRuleType The type of the accrual rule that defines how buyers can earn points.

LoyaltyProgramRewardDefinitionScope Indicates the scope of the reward tier.

LoyaltyProgramRewardDefinitionType The type of discount the reward tier offers.

LoyaltyProgramStatus Indicates whether the program is currently active.

LoyaltyRewardStatus The status of the loyalty reward.

MeasurementUnitArea Unit of area used to measure a quantity.

MeasurementUnitGeneric measurement unit generic swagger:model MeasurementUnitGeneric.

MeasurementUnitLength The unit of length used to measure a quantity.

MeasurementUnitTime Unit of time used to measure a quantity (a duration).

MeasurementUnitUnitType Describes the type of this unit and indicates which field contains the unit information.

MeasurementUnitVolume The unit of volume used to measure a quantity.

MeasurementUnitWeight Unit of weight used to measure a quantity.

MerchantStatus merchant status swagger:model MerchantStatus.

OrderFulfillmentPickupDetailsScheduleType The schedule type of the pickup fulfillment.

OrderFulfillmentState The current state of this fulfillment.

OrderFulfillmentType The type of fulfillment.

OrderLineItemDiscountScope Indicates whether this is a line item or order level discount.

OrderLineItemDiscountType Indicates how the discount is applied to the associated line item or order.

OrderLineItemTaxScope Indicates whether this is a line item or order level tax.

OrderLineItemTaxType Indicates how the tax is applied to the associated line item or order.

OrderServiceChargeCalculationPhase Represents a phase in the process of calculating order totals.

OrderState The state of the order.

Product Indicates the Square product used to generate an inventory change.

ProductType product type swagger:model ProductType.

RefundStatus Indicates a refund's current status.

RegisterDomainResponseStatus The status of domain registration.

RiskEvaluationRiskLevel risk evaluation risk level swagger:model RiskEvaluationRiskLevel.

SearchCatalogItemsRequestStockLevel Defines supported stock levels of the item inventory.

SearchOrdersSortField Specifies which timestamp to use to sort SearchOrder results.

ShiftFilterStatus Specifies the `status` of `Shift` records to be returned.

ShiftSortField Enumerates the `Shift` fields to sort on.

ShiftStatus Enumerates the possible status of a `Shift` swagger:model ShiftStatus.

ShiftWorkdayMatcher Defines the logic used to apply a workday filter.

SortOrder The order (e.g., chronological or alphabetical) in which results from a request are returned.

SubscriptionCadence Determines the billing cadence of a `Subscription` swagger:model SubscriptionCadence.

SubscriptionEventSubscriptionEventType The possible subscription event types.

SubscriptionStatus Possible subscription status values.

TaxCalculationPhase When to calculate the taxes due on a cart.

TaxInclusionType Whether to the tax amount should be additional to or included in the CatalogItem price.

TeamMemberAssignedLocationsAssignmentType Enumerates the possible assignment types the team member can have swagger:model TeamMemberAssignedLocationsAssignmentType.

TeamMemberStatus Enumerates the possible statuses the team member can have within a business.

TenderCardDetailsEntryMethod Indicates the method used to enter the card's details.

TenderCardDetailsStatus Indicates the card transaction's current status.

TenderType Indicates a tender's type.

TransactionProduct Indicates the Square product used to process a transaction.

TransactionType The transaction type used in the disputed payment.

Weekday The days of the week.