POSDataSourceSaveModel
Request body for creating or updating a POS data source. Deliberately excludes
UnitId (comes from the create request separately and is immutable on update)
and LastM*/CreatedBy/CreatedOn (trigger/audit-managed). Also excludes
DebugMode and ExportTimeCard - per AB#196461 rework discussion, the team
confirmed ExportTimeCard isn't used, and DebugMode was left out of scope.
- ActiveType: boolean | null
Only Whether only active employees/items should be imported.
- AutoType: boolean | null
E O D Whether an automatic End-Of-Day should run for this data source.
- AutoType: boolean | null
Link Employees Whether employees should be automatically linked on import.
- AutoType: boolean | null
Refresh Employees Whether employees should be automatically refreshed on import.
- AuxiliaryType: boolean | null
Y N Whether this data source is an auxiliary (secondary) source for the unit.
- BackgroundType: boolean | null
Queue Whether this data source's import runs through the background queue.
- CheckType: string | nullFormat: uuid
Out Id Checkout template to link this data source to (
UImportDataSourceCO.ID). On create,nullleaves it unlinked. On update,nullmeans "no change" - there is currently no way to unlink an already-linked checkout template through this API. See OPS.Web.Api.v2.Models.POS.DataSourceSetup.POSDataSourceModel.CheckOutId. - DeclaredType: boolean | null
Tips Includes C C Tips Whether declared tips already include credit card tips.
- DescriptionType: string | null
Description of the data source.
- ExportType: boolean | null
Employee Whether this data source is used to export employees to the POS.
- ExportType: string | null
Employee Mode Employee identifier mode used for employee export (e.g. "SSN", "PN", "PayrollID").
- ExportType: boolean | null
Schedule Whether this data source is used to export schedules to the POS.
- ExternalType: string | null
Data Source Id External identifier for this data source, used to match it against vendor-side records (e.g. Brink LocationID).
- ImportType: boolean | null
Cost Whether menu item cost data should be imported.
- ImportType: boolean | null
Open Time Punches Whether open (not yet clocked out) time punches should be imported.
- LocalType: string | null
Export Path Local path used when exporting data back to the POS.
- LocalType: string | null
Path Local file drop path used by file-based data source types.
- LockType: boolean | null
Whether the data source is locked against concurrent import runs.
- LoginType: string | null
Name Login name used to reach the POS vendor's API/server, for cloud-based types.
- OffsetType: integer | nullFormat: int32
Row offset applied when importing (e.g. skipping header rows for file-based types).
- PasswordType: string | null
Password/API key used to reach the POS vendor's API/server, for cloud-based types.
- ReverseType: boolean | null
Paid In Out Sign Whether the sign of imported paid in/out amounts should be reversed.
- RunType: string | null
After Day Script Script executed after the last import run of a business day.
- RunType: string | null
After Script Script executed after each import run.
- RunType: string | null
Before Day Script Script executed before the first import run of a business day.
- RunType: string | null
Before Script Script executed before each import run.
- SplitType: boolean | null
Whether the import splits data by some vendor-specific grouping (e.g. multiple terminals/files).
- TypeType: string | null
Data source type code (
POSDataSourceType.Code). Required on create. - UseType: boolean | null
Beta Version Whether the import should run against the Beta version of the import logic.
- UseType: boolean | null
Export Beta Version Whether the export should run against the Beta version of the export logic.
- UseType: boolean | null
For Missing Data Whether this data source is used as the fallback when importing missing data for a unit.
- VisibleType: boolean | null
Whether the data source is visible/active. Maps to
Hide = Visible ? 'N' : 'Y'.
