Per-merchant AI credit wallet and balances.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CreditsBalance | Decimal | decimal(12,4) | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| MerchantId | Int32 | int | β | |||
| MonthlyAllocation | Decimal | decimal(12,4) | ||||
| MonthlyCreditsUsed | Decimal | decimal(12,4) | ||||
| MonthlyResetAtUtc | DateTime | datetime2(3) | ||||
| PlanType | String | varchar(50) | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| TotalCreditsAllocated | Decimal | decimal(12,4) | ||||
| TotalCreditsConsumed | Decimal | decimal(12,4) | ||||
| TotalCreditsPurchased | Decimal | decimal(12,4) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Definition of an AI credit plan tier.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(500) | β | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Key | String | varchar(50) | ||||
| MonthlyCredits | Decimal | decimal(12,4) | ||||
| Name | String | nvarchar(100) | ||||
| PublicId | String | varchar(32) | ||||
| SortOrder | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Ledger entry against an AI credit account.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| AccountId | Int32 | int | β | |||
| AiRequestLogId | Int64 | bigint | β | β | ||
| Amount | Decimal | decimal(12,4) | ||||
| BalanceAfter | Decimal | decimal(12,4) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(500) | ||||
| IsDeleted | Boolean | bit | ||||
| MerchantId | Int32 | int | ||||
| Type | String | varchar(20) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| UserEmail | String | nvarchar(256) | ||||
| UserId | String | nvarchar(450) |
Registered/versioned prompt template (system + user prompt, model, cost).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| AllowedRoles | String | varchar(200) | β | |||
| Category | String | varchar(50) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(500) | β | |||
| InputTokenCostPer1M | Decimal | decimal(10,4) | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Key | String | varchar(100) | ||||
| MaxTokens | Int32 | int | ||||
| Model | String | varchar(100) | ||||
| Name | String | nvarchar(200) | ||||
| OutputTokenCostPer1M | Decimal | decimal(10,4) | ||||
| OutputValidation | String | nvarchar(max) | β | |||
| Provider | String | varchar(20) | ||||
| PublicId | String | varchar(32) | ||||
| SystemPrompt | String | nvarchar(max) | ||||
| Temperature | Decimal | decimal(3,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| UserPromptTemplate | String | nvarchar(max) | ||||
| VariableSchema | String | nvarchar(max) | β |
Log of every AI request (tokens, cost, latency, review/flag status).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CreditsConsumed | Decimal | decimal(10,4) | ||||
| ErrorMessage | String | nvarchar(1000) | β | |||
| EstimatedCostUsd | Decimal | decimal(10,6) | ||||
| FlagReason | String | nvarchar(500) | β | |||
| InputVariables | String | nvarchar(max) | ||||
| IpAddress | String | varchar(45) | β | |||
| IsBillable | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| IsFlagged | Boolean | bit | ||||
| LatencyMs | Int64 | bigint | ||||
| MerchantId | Int32 | int | β | |||
| Model | String | varchar(100) | ||||
| Output | String | nvarchar(max) | β | |||
| PartnerId | Int32 | int | β | |||
| PromptId | Int32 | int | β | |||
| PromptKey | String | varchar(100) | ||||
| Provider | String | varchar(20) | ||||
| PublicId | String | varchar(32) | ||||
| ReviewNotes | String | nvarchar(500) | β | |||
| ReviewedAtUtc | DateTime | datetime2(3) | β | |||
| ReviewedByUserId | String | nvarchar(450) | β | |||
| Status | String | varchar(20) | ||||
| SystemPromptUsed | String | nvarchar(max) | ||||
| TokensInput | Int32 | int | ||||
| TokensOutput | Int32 | int | ||||
| TokensTotal | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| UserEmail | String | nvarchar(256) | ||||
| UserId | String | nvarchar(450) | ||||
| UserPromptResolved | String | nvarchar(max) | ||||
| UserRole | String | varchar(50) |
Platform-level audit trail of significant actions.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int64 | bigint | β | |||
| Action | String | varchar(50) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| Details | String | nvarchar(max) | β | |||
| EntityId | String | varchar(50) | ||||
| EntityType | String | varchar(100) | ||||
| IpAddress | String | varchar(45) | β | |||
| MerchantId | Int32 | int | β | β | ||
| PartnerId | Int32 | int | β | β | ||
| UserId | String | nvarchar(450) | β | β |
A registered POS/terminal device, its activation and IoT identity.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| ActivatedAtUtc | DateTime | datetime2(3) | β | |||
| ActivationToken | String | varchar(50) | β | |||
| ActivationTokenExpiresUtc | DateTime | datetime2(3) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DeviceCode | String | varchar(50) | ||||
| DeviceName | String | nvarchar(100) | ||||
| DeviceTokenHash | Byte[] | varbinary(32) | β | |||
| DeviceType | DeviceType | varchar(20) | DeviceType | |||
| FailedActivationAttempts | Int32 | int | ||||
| IoTHubConnectionString | String | varchar(500) | β | |||
| IoTHubDeviceId | String | varchar(200) | β | |||
| IsDeleted | Boolean | bit | ||||
| LastSeenUtc | DateTime | datetime2(3) | β | |||
| LocationId | Int32 | int | ||||
| MerchantId | Int32 | int | β | |||
| PublicId | String | varchar(32) | ||||
| Status | DeviceStatus | varchar(20) | DeviceStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| ClaimType | String | nvarchar(max) | β | |||
| ClaimValue | String | nvarchar(max) | β | |||
| RoleId | String | nvarchar(450) | β |
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | String | nvarchar(450) | β | |||
| ConcurrencyStamp | String | nvarchar(max) | β | |||
| Name | String | nvarchar(256) | β | |||
| NormalizedName | String | nvarchar(256) | β |
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| ClaimType | String | nvarchar(max) | β | |||
| ClaimValue | String | nvarchar(max) | β | |||
| UserId | String | nvarchar(450) | β |
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| LoginProvider | String | nvarchar(450) | β | |||
| ProviderKey | String | nvarchar(450) | β | |||
| ProviderDisplayName | String | nvarchar(max) | β | |||
| UserId | String | nvarchar(450) | β |
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| UserId | String | nvarchar(450) | β | β | ||
| RoleId | String | nvarchar(450) | β | β |
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | String | nvarchar(450) | β | |||
| AccessFailedCount | Int32 | int | ||||
| AvatarUrl | String | nvarchar(500) | β | |||
| ConcurrencyStamp | String | nvarchar(max) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| String | nvarchar(256) | β | ||||
| EmailConfirmed | Boolean | bit | ||||
| EmailDomain | String | nvarchar(256) | β | |||
| FirstName | String | nvarchar(50) | ||||
| IsActive | Boolean | bit | ||||
| LastLoginUtc | DateTime | datetime2(3) | β | |||
| LastName | String | nvarchar(50) | ||||
| LockoutEnabled | Boolean | bit | ||||
| LockoutEnd | DateTimeOffset | datetimeoffset | β | |||
| NormalizedEmail | String | nvarchar(256) | β | |||
| NormalizedUserName | String | nvarchar(256) | β | |||
| PasswordHash | String | nvarchar(max) | β | |||
| PhoneNumber | String | nvarchar(max) | β | |||
| PhoneNumberConfirmed | Boolean | bit | ||||
| PreferredProvider | String | varchar(50) | β | |||
| RequiresPasswordChange | Boolean | bit | ||||
| SecurityStamp | String | nvarchar(max) | β | |||
| TwoFactorEnabled | Boolean | bit | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| UserName | String | nvarchar(256) | β |
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| UserId | String | nvarchar(450) | β | β | ||
| LoginProvider | String | nvarchar(450) | β | |||
| Name | String | nvarchar(450) | β | |||
| Value | String | nvarchar(max) | β |
Maps an email domain to an auth provider (routing/SSO enforcement).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| Domain | String | varchar(256) | ||||
| IsActive | Boolean | bit | ||||
| IsEnforced | Boolean | bit | ||||
| Provider | String | varchar(50) |
Linked external identity provider (OAuth) record.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| IsDeleted | Boolean | bit | ||||
| LinkedAtUtc | DateTime | datetime2(3) | ||||
| Provider | String | varchar(50) | ||||
| ProviderDisplayName | String | nvarchar(200) | β | |||
| ProviderKey | String | nvarchar(256) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| UserId | String | nvarchar(450) | β |
Short-lived token to hand a session across apps/domains.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| ExpiresAtUtc | DateTime | datetime2(3) | ||||
| IpAddress | String | varchar(45) | β | |||
| IsUsed | Boolean | bit | ||||
| MerchantPublicId | String | varchar(32) | ||||
| Reason | SupportSessionReason | varchar(32) | SupportSessionReason | |||
| ReasonDetails | String | nvarchar(200) | β | |||
| Token | String | varchar(64) | ||||
| UsedAtUtc | DateTime | datetime2(3) | β | |||
| UserId | String | nvarchar(450) |
Pending invite for a user to join a partner or merchant.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| AcceptedAtUtc | DateTime | datetime2(3) | β | |||
| AcceptedByUserId | String | nvarchar(450) | β | β | ||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| String | nvarchar(256) | |||||
| ExpiresAtUtc | DateTime | datetime2(3) | ||||
| FirstName | String | nvarchar(100) | β | |||
| InvitedByUserId | String | nvarchar(450) | β | |||
| IsDeleted | Boolean | bit | ||||
| IsRevoked | Boolean | bit | ||||
| LastName | String | nvarchar(100) | β | |||
| MerchantId | Int32 | int | β | |||
| PartnerId | Int32 | int | β | β | ||
| PublicId | String | varchar(32) | ||||
| ResendCount | Int32 | int | ||||
| TargetRole | String | varchar(50) | ||||
| Token | String | varchar(64) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
One-time passwordless email sign-in token.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| String | nvarchar(256) | |||||
| ExpiresAtUtc | DateTime | datetime2(3) | ||||
| IpAddress | String | varchar(45) | β | |||
| IsUsed | Boolean | bit | ||||
| Token | String | varchar(64) | ||||
| UsedAtUtc | DateTime | datetime2(3) | β |
Issued refresh token / session record.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int64 | bigint | β | |||
| AbsoluteExpiresAtUtc | DateTime | datetime2(3) | ||||
| Context | String | nvarchar(20) | ||||
| DeviceLabel | String | nvarchar(100) | β | |||
| ExpiresAtUtc | DateTime | datetime2(3) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IpAddress | String | nvarchar(45) | ||||
| IssuedAtUtc | DateTime | datetime2(3) | ||||
| MerchantPublicId | String | nvarchar(32) | β | |||
| PartnerPublicId | String | nvarchar(32) | β | |||
| ReplacedByTokenHash | Byte[] | binary(32) | β | |||
| RevokedAtUtc | DateTime | datetime2(3) | β | |||
| RevokedReason | String | nvarchar(50) | β | |||
| SessionId | Guid | uniqueidentifier | ||||
| TokenHash | Byte[] | binary(32) | ||||
| UserAgent | String | nvarchar(500) | ||||
| UserId | String | nvarchar(450) |
Grants a user access to a merchant with a role (multi-tenant membership).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| LastActivatedAtUtc | DateTime | datetime2(3) | β | |||
| MerchantId | Int32 | int | β | |||
| Role | UserRole | varchar(20) | UserRole | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| UserId | String | nvarchar(450) | β |
A member's account in a group loyalty program.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GroupLoyaltyProgramId | Int32 | int | β | |||
| LifetimePoints | Decimal | decimal(18,2) | ||||
| MemberEmail | String | nvarchar(200) | β | |||
| MemberName | String | nvarchar(100) | ||||
| MemberPhone | String | varchar(20) | ||||
| MerchantGroupId | Int32 | int | β | |||
| PointsBalance | Decimal | decimal(18,2) | ||||
| PublicId | String | varchar(32) | ||||
| Status | GroupLoyaltyAccountStatus | tinyint | GroupLoyaltyAccountStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A loyalty program shared across a merchant group.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| MerchantGroupId | Int32 | int | β | |||
| MinPointsToRedeem | Decimal | decimal(18,2) | ||||
| Name | String | nvarchar(100) | ||||
| PointsNewActivation | Decimal | decimal(18,2) | ||||
| PointsPerDollar | Decimal | decimal(18,4) | ||||
| PublicId | String | varchar(32) | ||||
| RedemptionRate | Decimal | decimal(18,4) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Which merchants participate in a group program (join).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| GroupLoyaltyProgramId | Int32 | int | β | |||
| MerchantId | Int32 | int | β |
Points earn/redeem entry across the group.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| EmployeeName | String | nvarchar(100) | β | |||
| GroupLoyaltyAccountId | Int64 | bigint | β | |||
| MerchantGroupId | Int32 | int | ||||
| Points | Decimal | decimal(18,2) | ||||
| Reference | String | nvarchar(50) | β | |||
| SaleAmount | Decimal | decimal(18,2) | β | |||
| SourceLocationName | String | nvarchar(100) | ||||
| SourceMerchantId | Int32 | int | β | |||
| SourceSaleGlobalId | Guid | uniqueidentifier | β | |||
| TransactionType | LoyaltyTransactionType | tinyint | LoyaltyTransactionType |
Per-merchant feature toggle / override value.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| FeatureKey | String | varchar(100) | ||||
| IsEnabled | Boolean | bit | ||||
| MerchantId | Int32 | int | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| Value | String | nvarchar(500) | β |
Which modules a merchant has activated.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| ActivatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DeactivatedAtUtc | DateTime | datetime2(3) | β | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| MerchantId | Int32 | int | β | |||
| ModuleDefinitionId | Int32 | int | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Catalog of platform modules (core + vertical add-ons); seeded.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| Category | String | varchar(30) | ||||
| Classification | ModuleClassification | tinyint | ModuleClassification | |||
| Code | String | varchar(50) | ||||
| Description | String | nvarchar(500) | ||||
| IsCore | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| PublicId | String | varchar(32) | ||||
| SortOrder | Int32 | int | ||||
| VerticalAffinity | IndustryTemplate | tinyint | β | IndustryTemplate |
Delivery/engagement event for a sent email (delivered, opened, bounced).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int64 | bigint | β | |||
| EventType | String | nvarchar(100) | ||||
| OutboxId | Int64 | bigint | β | β | ||
| ProviderMessageId | String | nvarchar(200) | β | |||
| RawPayload | String | nvarchar(max) | ||||
| ReceivedAt | DateTime | datetime2(3) |
Queued outbound email pending send (transactional outbox).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int64 | bigint | β | |||
| AttemptCount | Int32 | int | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| IdempotencyKey | Guid | uniqueidentifier | ||||
| LastError | String | nvarchar(2000) | β | |||
| MerchantId | Int32 | int | β | |||
| NextAttemptAt | DateTime | datetime2(3) | ||||
| Payload | String | nvarchar(max) | ||||
| ProviderMessageId | String | nvarchar(200) | β | |||
| Status | EmailOutboxStatus | tinyint | EmailOutboxStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) |
Email/SMS message template, scoped and versioned by channel/language.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| BodyHtml | String | nvarchar(max) | ||||
| BodyText | String | nvarchar(max) | β | |||
| Channel | NotificationChannel | tinyint | NotificationChannel | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| IsSystemTemplate | Boolean | bit | ||||
| Language | String | varchar(10) | ||||
| Name | String | nvarchar(200) | ||||
| PublicId | String | varchar(32) | ||||
| RequiredVariables | String | nvarchar(500) | β | |||
| Scope | TemplateScope | tinyint | TemplateScope | |||
| ScopeId | Int32 | int | β | |||
| Subject | String | nvarchar(500) | β | |||
| TemplateKey | String | varchar(100) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Historical version snapshot of a notification template.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| BodyHtml | String | nvarchar(max) | ||||
| BodyText | String | nvarchar(max) | β | |||
| ChangeReason | String | nvarchar(500) | β | |||
| ChangedAtUtc | DateTime | datetime2(3) | ||||
| ChangedByUserId | String | nvarchar(450) | ||||
| Subject | String | nvarchar(500) | β | |||
| TemplateId | Int32 | int | β |
A provisioned SQL database (shared or dedicated) for merchant data.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DatabaseName | String | varchar(100) | ||||
| DatabaseServerId | Int32 | int | β | |||
| ElasticPoolName | String | varchar(100) | β | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| IsProvisioned | Boolean | bit | ||||
| IsShared | Boolean | bit | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A SQL Server/instance that hosts merchant databases.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| ConnectionTemplate | String | varchar(500) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Provider | String | varchar(20) | ||||
| PublicId | String | varchar(32) | ||||
| ServerName | String | varchar(100) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A merchant (business/store operator) onboarded under a partner.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| City | String | nvarchar(100) | β | |||
| Code | String | varchar(20) | ||||
| ContactEmail | String | nvarchar(256) | β | |||
| ContactName | String | nvarchar(200) | β | |||
| ContactPhone | String | varchar(20) | β | |||
| CountryCode | String | char(2) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DefaultTimeZoneId | String | varchar(50) | ||||
| IndustryTemplate | IndustryTemplate | tinyint | IndustryTemplate | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| MerchantGroupId | Int32 | int | β | β | ||
| Name | String | nvarchar(100) | ||||
| Notes | String | nvarchar(2000) | β | |||
| PartnerId | Int32 | int | β | |||
| PublicId | String | varchar(32) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Maps a merchant to the physical Merchant DB that holds its data.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DatabaseId | Int32 | int | β | |||
| IsDeleted | Boolean | bit | ||||
| MerchantId | Int32 | int | β | |||
| PublicId | String | varchar(32) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Groups merchants under one owner for shared loyalty/gift cards.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GroupCode | String | varchar(20) | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(200) | ||||
| PublicId | String | varchar(32) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Reseller/channel partner that owns a book of merchants.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| Code | String | varchar(50) | ||||
| ContactEmail | String | varchar(256) | β | |||
| ContactName | String | nvarchar(200) | β | |||
| ContactPhone | String | varchar(20) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| IsHousePartner | Boolean | bit | ||||
| Name | String | nvarchar(200) | ||||
| Notes | String | nvarchar(max) | β | |||
| PublicId | String | varchar(32) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Links an identity user to a partner with a partner-scoped role.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| Id | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| PartnerId | Int32 | int | β | |||
| Role | PartnerRole | varchar(30) | PartnerRole | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| UserId | String | nvarchar(450) | β |
A house/charge account (credit terms, balance).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AccountGroupId | Int64 | bigint | β | |||
| AccountNumber | String | varchar(30) | ||||
| ContactEmail | String | varchar(254) | β | |||
| ContactName | String | nvarchar(150) | β | |||
| ContactPhone | String | varchar(30) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CreditLimit | Decimal | decimal(18,2) | ||||
| CreditLimitEnforcement | CreditLimitEnforcement | tinyint | CreditLimitEnforcement | |||
| CurrentBalance | Decimal | decimal(18,2) | ||||
| FinanceChargeAnnualRate | Decimal | decimal(7,4) | ||||
| FinanceChargeCompounding | Boolean | bit | ||||
| FinanceChargeMinimum | Decimal | decimal(18,2) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| GracePeriodDays | Int32 | int | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(150) | ||||
| PaymentTermsDueDays | Int32 | int | ||||
| PaymentTermsType | PaymentTermsType | tinyint | PaymentTermsType | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Status | AccountStatus | tinyint | AccountStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A person authorized on an account.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AccountId | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CustomerId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| IsPrimary | Boolean | bit | ||||
| Role | String | varchar(30) | ||||
| RowVersion | Byte[] | rowversion | ||||
| SpendingLimit | Decimal | decimal(18,2) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A grouping of accounts with default terms.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| Code | String | varchar(20) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DefaultPaymentTermsDueDays | Int32 | int | ||||
| DefaultPaymentTermsType | PaymentTermsType | tinyint | PaymentTermsType | |||
| Description | String | nvarchar(500) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A ledger entry (charge/payment) on an account.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AccountId | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CustomerId | Int64 | bigint | β | β | ||
| DueDate | DateOnly | date | ||||
| EntryType | AccountLedgerEntryType | tinyint | AccountLedgerEntryType | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsOpen | Boolean | bit | ||||
| IsPositive | Boolean | bit | ||||
| Notes | String | nvarchar(500) | β | |||
| OrderId | Int64 | bigint | β | β | ||
| PaymentMethodId | Int64 | bigint | β | β | ||
| PostingDate | DateOnly | date | ||||
| PublicId | String | varchar(32) | ||||
| ReasonCodeId | Int64 | bigint | β | β | ||
| Reference | String | varchar(100) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SaleId | Int64 | bigint | β | β | ||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Application/running-balance detail linking ledger entries.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AccountId | Int64 | bigint | β | |||
| AccountLedgerId | Int64 | bigint | β | |||
| Amount | Decimal | decimal(18,2) | ||||
| AppliedAmount | Decimal | decimal(18,2) | β | |||
| AppliedToDetailId | Int64 | bigint | β | β | ||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| RowVersion | Byte[] | rowversion | ||||
| RunningBalance | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A generated periodic account statement.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AccountId | Int64 | bigint | β | |||
| ClosingBalance | Decimal | decimal(18,2) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| FinanceChargeAmount | Decimal | decimal(18,2) | ||||
| GeneratedByEmployeeId | Int64 | bigint | β | β | ||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| OpeningBalance | Decimal | decimal(18,2) | ||||
| PeriodEndDate | DateOnly | date | ||||
| PeriodStartDate | DateOnly | date | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| StatementDate | DateOnly | date | ||||
| StatementNumber | Int32 | int | ||||
| Status | AccountStatementStatus | tinyint | AccountStatementStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Per-tenant change-history audit trail.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| Action | String | varchar(10) | ||||
| ChangedByDisplayName | String | nvarchar(100) | β | |||
| ChangedByUserId | Int32 | int | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| EntityId | Int64 | bigint | ||||
| EntityType | String | varchar(50) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IpAddress | String | varchar(45) | β | |||
| IsDeleted | Boolean | bit | ||||
| NewValuesJson | String | nvarchar(max) | β | |||
| OldValuesJson | String | nvarchar(max) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| Source | String | varchar(20) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A coupon code tied to a promotion with usage limits.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Code | String | varchar(50) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CurrentUses | Int32 | int | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| MaxUses | Int32 | int | β | |||
| PromotionId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A customer record.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AccountNumber | String | varchar(50) | ||||
| CertExpiryDate | DateTime | datetime2(3) | β | |||
| CertIssuedDate | DateTime | datetime2(3) | β | |||
| CertNumber | String | varchar(50) | β | |||
| Company | String | nvarchar(200) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CustomFields | String | nvarchar(max) | ||||
| DefaultDiscountPercent | Decimal | decimal(5,2) | β | |||
| String | nvarchar(200) | β | ||||
| FirstName | String | nvarchar(100) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| HasConflict | Boolean | bit | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| LastName | String | nvarchar(100) | ||||
| MergedAtUtc | DateTime | datetime2 | β | |||
| MergedIntoCustomerId | Int64 | bigint | β | |||
| Phone | String | varchar(30) | β | |||
| PriceTierId | Int64 | bigint | β | β | ||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| TaxExempt | Boolean | bit | ||||
| TaxProfileId | Int64 | bigint | β | β | ||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
An address for a customer.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Address1 | String | nvarchar(200) | β | |||
| Address2 | String | nvarchar(200) | β | |||
| AddressType | String | varchar(20) | ||||
| City | String | nvarchar(100) | β | |||
| Country | String | char(2) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CustomerId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDefault | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| PostalCode | String | varchar(20) | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| State | String | nvarchar(100) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Aggregated purchase metrics per customer.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CustomerId | Int64 | bigint | β | |||
| FirstVisitUtc | DateTime | datetime2 | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LastVisitUtc | DateTime | datetime2 | β | |||
| LifetimeValue | Decimal | decimal(18,2) | ||||
| RowVersion | Byte[] | rowversion | ||||
| TotalReturns | Decimal | decimal(18,2) | ||||
| TotalSales | Decimal | decimal(18,2) | ||||
| TotalVisits | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A gift card and its balance.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CardNumber | String | varchar(25) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CurrentBalance | Decimal | decimal(18,2) | ||||
| ExpirationDate | DateOnly | date | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| OriginalAmount | Decimal | decimal(18,2) | ||||
| ProductId | Int64 | bigint | β | β | ||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Status | GiftCardStatus | tinyint | GiftCardStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Activity entry against a gift card (issue/redeem/reload).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| ActivityType | GiftCardActivityType | tinyint | GiftCardActivityType | |||
| Amount | Decimal | decimal(18,2) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GiftCardId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Notes | String | varchar(200) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| RunningBalance | Decimal | decimal(18,2) | ||||
| SaleId | Int64 | bigint | β | β | ||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A customer's balance in a loyalty program.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CustomerId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LifetimePoints | Decimal | decimal(18,2) | ||||
| LoyaltyProgramId | Int64 | bigint | β | |||
| PointsBalance | Decimal | decimal(18,2) | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Status | LoyaltyAccountStatus | tinyint | LoyaltyAccountStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A per-merchant loyalty program config.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| MinPointsToRedeem | Decimal | decimal(18,2) | ||||
| Name | String | nvarchar(100) | ||||
| PointsNewActivation | Decimal | decimal(18,2) | ||||
| PointsPerDollar | Decimal | decimal(18,4) | ||||
| PublicId | String | varchar(32) | ||||
| RedemptionRate | Decimal | decimal(18,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Points earn/redeem entry.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LoyaltyAccountId | Int64 | bigint | β | |||
| Notes | String | nvarchar(500) | β | |||
| Points | Decimal | decimal(18,2) | ||||
| Reference | String | varchar(100) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SaleAmount | Decimal | decimal(18,2) | β | |||
| SaleId | Int64 | bigint | β | β | ||
| TransactionType | LoyaltyTransactionType | tinyint | LoyaltyTransactionType | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A discount/promotion definition.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(500) | β | |||
| DiscountType | PromotionDiscountType | tinyint | PromotionDiscountType | |||
| DiscountValue | Decimal | decimal(18,4) | ||||
| EndDateUtc | DateTime | datetime2 | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(200) | ||||
| Priority | Int32 | int | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| StartDateUtc | DateTime | datetime2 | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A condition/reward rule within a promotion.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| FreeQuantity | Int32 | int | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| PromotionId | Int64 | bigint | β | |||
| RequiredQuantity | Int32 | int | β | |||
| RowVersion | Byte[] | rowversion | ||||
| TargetId | Int64 | bigint | β | |||
| TargetType | PromotionTargetType | tinyint | PromotionTargetType | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
An employee/POS operator with PIN and security level.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DefaultCommissionPercent | Decimal | decimal(5,2) | β | |||
| String | nvarchar(200) | β | ||||
| EmployeeCode | String | varchar(50) | ||||
| FirstName | String | nvarchar(100) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| HireDate | DateTime | datetime2(3) | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| LastName | String | nvarchar(100) | ||||
| Phone | String | nvarchar(30) | β | |||
| PinEncrypted | Byte[] | varbinary(64) | β | |||
| PinHash | String | varchar(128) | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| SecurityLevel | Int32 | int | ||||
| TerminationDate | DateTime | datetime2(3) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
An employee's role at a location.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| RoleName | String | nvarchar(50) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A pay/job role for an employee at a location.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Code | String | varchar(30) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| Name | String | nvarchar(100) | ||||
| PayRate | Decimal | decimal(18,2) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A break within a time entry.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| BreakEndUtc | DateTime | datetime2(3) | β | |||
| BreakStartUtc | DateTime | datetime2(3) | ||||
| BreakType | BreakType | tinyint | BreakType | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DurationMinutes | Int32 | int | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsAutoClosed | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Notes | String | nvarchar(500) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| Source | String | varchar(20) | ||||
| TimeEntryId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A clock-in/clock-out time record.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AdjustedByEmployeeId | Int64 | bigint | β | |||
| BreakMinutes | Int32 | int | ||||
| ClockInPhotoOverrideByEmployeeId | Int64 | bigint | β | |||
| ClockInPhotoOverrideReason | String | nvarchar(120) | β | |||
| ClockInPhotoUrl | String | nvarchar(500) | β | |||
| ClockInUtc | DateTime | datetime2(3) | ||||
| ClockOutPhotoOverrideByEmployeeId | Int64 | bigint | β | |||
| ClockOutPhotoOverrideReason | String | nvarchar(120) | β | |||
| ClockOutPhotoUrl | String | nvarchar(500) | β | |||
| ClockOutUtc | DateTime | datetime2(3) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| JobRoleId | Int64 | bigint | β | β | ||
| LocationId | Int64 | bigint | β | |||
| Notes | String | nvarchar(500) | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Source | String | varchar(20) | ||||
| Status | TimeEntryStatus | tinyint | TimeEntryStatus | |||
| TotalHours | Decimal | decimal(8,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A stock adjustment document.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AdjustmentDate | DateTime | datetime2(3) | ||||
| ClosedByEmployeeId | Int64 | bigint | β | |||
| ClosedDate | DateTime | datetime2(3) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DocumentNumber | String | varchar(20) | ||||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| Notes | String | nvarchar(500) | β | |||
| PublicId | String | varchar(32) | ||||
| ReasonCodeId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| Status | AdjustmentStatus | tinyint | AdjustmentStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A variant's quantity change within an adjustment.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| InventoryAdjustmentId | Int64 | bigint | β | |||
| IsDeleted | Boolean | bit | ||||
| LineNumber | Int32 | int | ||||
| Notes | String | nvarchar(200) | β | |||
| ProductVariantId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| QuantityChange | Decimal | decimal(10,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UnitCost | Decimal | decimal(18,4) | ||||
| UnitPrice | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Append-only ledger of every stock movement.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DocumentNumber | String | varchar(20) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| MovementType | MovementType | tinyint | MovementType | |||
| ProductVariantId | Int64 | bigint | β | |||
| Quantity | Decimal | decimal(18,4) | ||||
| ReferenceId | Int64 | bigint | β | |||
| ReferenceType | String | varchar(20) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| UnitCost | Decimal | decimal(18,4) | ||||
| UnitPrice | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Per-location stock, cost, price and reorder settings for a variant.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Cost | Decimal | decimal(18,4) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| LastReceivedDate | DateTime | datetime2(3) | β | |||
| LastSoldDate | DateTime | datetime2(3) | β | |||
| LocationId | Int64 | bigint | β | |||
| Price | Decimal | decimal(18,2) | β | |||
| PriceChangedDate | DateTime | datetime2(3) | β | |||
| ProductVariantId | Int64 | bigint | β | |||
| QuantityOnHand | Decimal | decimal(18,4) | ||||
| QuantityReserved | Decimal | decimal(18,4) | ||||
| ReorderPoint | Decimal | decimal(18,4) | ||||
| RestockLevel | Decimal | decimal(18,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| TaxGroupId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A physical inventory count document.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| ClosedByEmployeeId | Int64 | bigint | β | |||
| ClosedDate | DateTime | datetime2(3) | β | |||
| CountDate | DateTime | datetime2(3) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DocumentNumber | String | varchar(20) | ||||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| Notes | String | nvarchar(500) | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Status | StockCountStatus | tinyint | StockCountStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A counted variant line (counted vs system qty).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CountedQuantity | Decimal | decimal(18,4) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| ProductVariantId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| StockCountId | Int64 | bigint | β | |||
| SystemQuantity | Decimal | decimal(18,4) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| Variance | Decimal | decimal(18,4) |
Physical label stock dimensions (preset or custom).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GapMm | Decimal | decimal(8,2) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| HeightMm | Decimal | decimal(8,2) | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| IsPreset | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| WidthMm | Decimal | decimal(8,2) |
Printable label layout bound to a label size.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(500) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDefault | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| LabelSizeId | Int64 | bigint | β | |||
| Name | String | nvarchar(100) | ||||
| PrinterLanguage | PrinterLanguage | tinyint | PrinterLanguage | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| TemplateBody | String | nvarchar(max) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A label print job and its progress.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CompletedAtUtc | DateTime | datetime2 | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LabelTemplateId | Int64 | bigint | β | |||
| LocationId | Int64 | bigint | β | |||
| PrintedCount | Int32 | int | ||||
| RowVersion | Byte[] | rowversion | ||||
| Status | PrintJobStatus | tinyint | PrintJobStatus | |||
| TotalLabels | Int32 | int | ||||
| TriggeredBy | PrintJobTrigger | tinyint | PrintJobTrigger | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A physical store/location.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Address1 | String | nvarchar(200) | β | |||
| Address2 | String | nvarchar(200) | β | |||
| City | String | nvarchar(100) | β | |||
| Country | String | char(2) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DefaultCurrencyId | Int64 | bigint | β | β | ||
| DefaultTaxGroupId | Int64 | bigint | β | |||
| DefaultTimeZoneId | String | varchar(50) | β | |||
| String | nvarchar(200) | β | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| InitializedAtUtc | DateTime | datetime2(3) | β | |||
| InitializedByUserId | String | nvarchar(450) | β | |||
| InitializedFromLocationId | Int64 | bigint | β | β | ||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| LocationType | String | varchar(20) | ||||
| Name | String | nvarchar(100) | ||||
| Phone | String | varchar(30) | β | |||
| PostalCode | String | varchar(20) | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| State | String | nvarchar(100) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A named group of locations.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(500) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Membership of a location in a group (join).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| LocationGroupId | Int64 | bigint | β | |||
| LocationId | Int64 | bigint | β |
Key/value setting scoped to a location.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| LocationId | Int64 | bigint | β | |||
| SettingKey | String | varchar(100) | ||||
| SettingValue | String | nvarchar(max) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) |
Key/value setting scoped to the merchant.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| SettingKey | String | varchar(100) | ||||
| SettingValue | String | nvarchar(max) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) |
A POS terminal/register at a location.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| Model | String | nvarchar(100) | β | |||
| Name | String | nvarchar(100) | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| SerialNumber | String | varchar(50) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Key/value setting scoped to a terminal.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| SettingKey | String | varchar(100) | ||||
| SettingValue | String | nvarchar(max) | β | |||
| TerminalId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) |
A quote/order/layaway that can convert to a sale.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| BalanceDue | Decimal | decimal(18,2) | ||||
| ConvertedSaleId | Int64 | bigint | β | β | ||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CustomerId | Int64 | bigint | β | β | ||
| DepositTotal | Decimal | decimal(18,2) | ||||
| DueDate | DateTime | datetime2(3) | β | |||
| EmployeeId | Int64 | bigint | β | |||
| ExpiresAtUtc | DateTime | datetime2(3) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsSynced | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| Notes | String | nvarchar(500) | β | |||
| OrderDateUtc | DateTime | datetime2(3) | ||||
| OrderNumber | String | varchar(50) | ||||
| OrderType | OrderType | tinyint | OrderType | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Status | OrderStatus | tinyint | OrderStatus | |||
| SubTotal | Decimal | decimal(18,2) | ||||
| TaxTotal | Decimal | decimal(18,2) | ||||
| Total | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Status/action history for an order.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Action | String | nvarchar(50) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Notes | String | nvarchar(500) | β | |||
| OrderId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A line on an order.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DiscountAmount | Decimal | decimal(18,2) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LineNumber | Int32 | int | ||||
| LineTotal | Decimal | decimal(18,2) | ||||
| Notes | String | nvarchar(200) | β | |||
| OrderId | Int64 | bigint | β | |||
| ProductVariantId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| Quantity | Decimal | decimal(18,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UnitPrice | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A deposit/payment recorded against an order.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Amount | Decimal | decimal(18,2) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Notes | String | nvarchar(200) | β | |||
| OrderId | Int64 | bigint | β | |||
| PaymentDateUtc | DateTime | datetime2(3) | ||||
| PaymentMethodId | Int64 | bigint | β | |||
| ReferenceNumber | String | nvarchar(100) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Audit of product cost changes over time.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| ChangeType | CostChangeType | tinyint | CostChangeType | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| NewCost | Decimal | decimal(18,4) | ||||
| Notes | String | nvarchar(200) | β | |||
| OldCost | Decimal | decimal(18,4) | ||||
| ProductVariantId | Int64 | bigint | β | |||
| ReferenceId | Int64 | bigint | β | |||
| ReferenceType | String | varchar(20) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SupplierId | Int64 | bigint | β | β | ||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A (approvable) batch price change document.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| AppliedDate | DateTime | datetime2(3) | β | |||
| ApprovedByEmployeeId | Int64 | bigint | β | |||
| ApprovedDate | DateTime | datetime2(3) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByEmployeeId | Int64 | bigint | β | |||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(200) | ||||
| DocumentNumber | String | varchar(20) | ||||
| EffectiveDate | DateTime | datetime2(3) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsGlobal | Boolean | bit | ||||
| Notes | String | nvarchar(500) | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Status | PriceChangeStatus | tinyint | PriceChangeStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A variant's old/new price within a price change.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Multiplier | Decimal | decimal(8,4) | β | |||
| NewPrice | Decimal | decimal(18,2) | β | |||
| OldPrice | Decimal | decimal(18,2) | ||||
| PriceChangeId | Int64 | bigint | β | |||
| ProductVariantId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Restricts a price change to specific locations (join).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| PriceChangeId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A named customer/price tier.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| Code | String | varchar(20) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| SortOrder | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Additional barcodes mapped to a variant.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Barcode | String | varchar(50) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsPrimary | Boolean | bit | ||||
| ProductVariantId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Tier-specific price for a variant.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Price | Decimal | decimal(18,2) | ||||
| PriceTierId | Int64 | bigint | β | |||
| ProductVariantId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Product category, optionally hierarchical.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(500) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| ParentCategoryId | Int64 | bigint | β | β | ||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| SortOrder | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Component line of a kit/bundle product.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| ComponentPrice | Decimal | decimal(18,2) | β | |||
| ComponentProductVariantId | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| ProductId | Int64 | bigint | β | |||
| Quantity | Decimal | decimal(18,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| SortOrder | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Sellable/stockable product master (the catalog head).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AllowFractionalQty | Boolean | bit | ||||
| BundleType | BundleType | tinyint | BundleType | |||
| CanBeSold | Boolean | bit | ||||
| CategoryId | Int64 | bigint | β | β | ||
| CommissionMode | CommissionMode | tinyint | β | CommissionMode | ||
| CommissionValue | Decimal | decimal(18,4) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CustomFields | String | nvarchar(max) | ||||
| Description | String | nvarchar(2000) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsEbtEligible | Boolean | bit | ||||
| LockQuantityAtPos | Boolean | bit | ||||
| MSRP | Decimal | decimal(18,2) | β | |||
| Name | String | nvarchar(200) | ||||
| PromptVariantAtPos | Boolean | bit | ||||
| PublicId | String | varchar(32) | ||||
| RequiresManualPrice | Boolean | bit | ||||
| RowVersion | Byte[] | rowversion | ||||
| SellingUoMId | Int64 | bigint | β | β | ||
| Status | ProductStatus | tinyint | ProductStatus | |||
| StockingUoMId | Int64 | bigint | β | β | ||
| TagAlongProductId | Int64 | bigint | β | β | ||
| TagAlongQuantity | Decimal | decimal(10,3) | β | |||
| TareWeight | Decimal | decimal(10,3) | β | |||
| TareWeightPercent | Decimal | decimal(5,2) | β | |||
| TaxGroupId | Int64 | bigint | β | β | ||
| TrackInventory | Boolean | bit | ||||
| TrackSerialNumbers | Boolean | bit | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| UseComponentPrice | Boolean | bit |
POS alert/prompt attached to a product (age check, message).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AlertType | AlertType | tinyint | AlertType | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Message | String | nvarchar(500) | β | |||
| MinimumAge | Byte | tinyint | β | |||
| ProductId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| RequireAcknowledgement | Boolean | bit | ||||
| RowVersion | Byte[] | rowversion | ||||
| Title | String | nvarchar(100) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Additional product-to-category memberships (join).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| ProductId | Int64 | bigint | β | β | ||
| CategoryId | Int64 | bigint | β | β | ||
| SortOrder | Int32 | int |
Image attached to a product.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AltText | String | nvarchar(200) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsPrimary | Boolean | bit | ||||
| ProductId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SortOrder | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| Url | String | nvarchar(500) |
An option/axis (e.g. Size, Color) for a product's variants.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| ProductId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SortOrder | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A value within a product option (e.g. Small, Red).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| ProductOptionId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SortOrder | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| Value | String | nvarchar(100) |
Time/day windows restricting when a product can be sold.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DaysOfWeek | Byte | tinyint | β | |||
| EndUtc | DateTime | datetime2(3) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| ProductId | Int64 | bigint | β | |||
| Reason | String | nvarchar(200) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SortOrder | Int32 | int | ||||
| StartUtc | DateTime | datetime2(3) | β | |||
| TimeEnd | TimeOnly | time | β | |||
| TimeStart | TimeOnly | time | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| WindowType | SaleWindowType | tinyint | SaleWindowType |
A specific sellable variant of a product (SKU-level).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Barcode | String | varchar(50) | β | |||
| Cost | Decimal | decimal(18,4) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| ImageUrl | String | nvarchar(500) | β | |||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Price | Decimal | decimal(18,2) | ||||
| PriceLowerBound | Decimal | decimal(18,2) | β | |||
| PriceUpperBound | Decimal | decimal(18,2) | β | |||
| ProductId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Sku | String | varchar(50) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| Weight | Decimal | decimal(18,4) | β |
Maps a variant to its chosen option values (join).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| ProductOptionValueId | Int64 | bigint | β | |||
| ProductVariantId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
E-commerce listing/sync state for a product on a platform.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| ExternalProductId | String | varchar(100) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LastSyncError | String | nvarchar(500) | β | |||
| LastSyncedUtc | DateTime | datetime2(3) | β | |||
| Metafields | String | nvarchar(max) | β | |||
| OnlineDescription | String | nvarchar(max) | β | |||
| Platform | WebPlatform | tinyint | WebPlatform | |||
| ProductId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| Slug | String | varchar(200) | ||||
| SyncStatus | WebListingSyncStatus | tinyint | β | WebListingSyncStatus | ||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Distributes a received shipment across locations.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| ClosedByEmployeeId | Int64 | bigint | β | |||
| ClosedDate | DateTime | datetime2(3) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DistributionDate | DateTime | datetime2(3) | ||||
| DocumentNumber | String | varchar(20) | ||||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Notes | String | nvarchar(500) | β | |||
| PublicId | String | varchar(32) | ||||
| PurchaseReceiptId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SourceLocationId | Int64 | bigint | β | |||
| Status | DistributionStatus | tinyint | DistributionStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Allocation of a distribution line to a destination location.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AcknowledgedByEmployeeId | Int64 | bigint | β | |||
| AcknowledgedDate | DateTime | datetime2(3) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DistributionLineId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| Quantity | Decimal | decimal(10,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A variant line to be distributed.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| AllocatedQuantity | Decimal | decimal(10,4) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DistributionId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| ProductVariantId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| PurchaseReceiptLineId | Int64 | bigint | β | β | ||
| RowVersion | Byte[] | rowversion | ||||
| TotalQuantity | Decimal | decimal(10,4) | ||||
| UnitCost | Decimal | decimal(18,4) | ||||
| UnitPrice | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Supplier sourcing info for a product (cost, SKU, pack size).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsPrimary | Boolean | bit | ||||
| MinimumOrder | Decimal | decimal(18,4) | β | |||
| ProductId | Int64 | bigint | β | |||
| PurchasingUoMId | Int64 | bigint | β | β | ||
| RowVersion | Byte[] | rowversion | ||||
| SupplierCost | Decimal | decimal(18,4) | β | |||
| SupplierId | Int64 | bigint | β | |||
| SupplierSku | String | varchar(50) | β | |||
| UnitsPerPurchaseUoM | Decimal | decimal(18,6) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A purchase order to a supplier.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| ClosedByEmployeeId | Int64 | bigint | β | |||
| ClosedDate | DateTime | datetime2(3) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DocumentNumber | String | varchar(20) | ||||
| EmployeeId | Int64 | bigint | β | |||
| ExpectedDate | DateTime | datetime2(3) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| Notes | String | nvarchar(500) | β | |||
| OrderDate | DateTime | datetime2(3) | ||||
| PublicId | String | varchar(32) | ||||
| QuantityInvoiced | Decimal | decimal(18,4) | ||||
| QuantityToInvoice | Decimal | decimal(18,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Status | PurchaseOrderStatus | tinyint | PurchaseOrderStatus | |||
| SubTotal | Decimal | decimal(18,2) | ||||
| SupplierId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
An ordered variant line on a PO.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LineNumber | Int32 | int | ||||
| LineTotal | Decimal | decimal(18,2) | ||||
| Notes | String | nvarchar(200) | β | |||
| ProductVariantId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| PurchaseOrderId | Int64 | bigint | β | |||
| PurchasingUoMId | Int64 | bigint | β | β | ||
| QuantityInvoiced | Decimal | decimal(10,4) | ||||
| QuantityOrdered | Decimal | decimal(10,4) | ||||
| QuantityReceived | Decimal | decimal(10,4) | ||||
| QuantityToInvoice | Decimal | decimal(10,4) | ||||
| QuantityToReceive | Decimal | decimal(10,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UnitCost | Decimal | decimal(18,4) | ||||
| UnitsPerPurchaseUoM | Decimal | decimal(10,4) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Goods-received document (optionally against a PO).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| ClosedByEmployeeId | Int64 | bigint | β | |||
| ClosedDate | DateTime | datetime2(3) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DocumentNumber | String | varchar(20) | ||||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| Notes | String | nvarchar(500) | β | |||
| PublicId | String | varchar(32) | ||||
| PurchaseOrderId | Int64 | bigint | β | β | ||
| ReceiptDate | DateTime | datetime2(3) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Status | PurchaseReceiptStatus | tinyint | PurchaseReceiptStatus | |||
| SupplierId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A received variant line.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LineNumber | Int32 | int | ||||
| Notes | String | nvarchar(200) | β | |||
| ProductVariantId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| PurchaseOrderLineId | Int64 | bigint | β | β | ||
| PurchaseReceiptId | Int64 | bigint | β | |||
| PurchasingUoMId | Int64 | bigint | β | β | ||
| QuantityInStockingUoM | Decimal | decimal(10,4) | ||||
| QuantityReceived | Decimal | decimal(10,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UnitCost | Decimal | decimal(18,4) | ||||
| UnitPrice | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A vendor/supplier master.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| AccountNumber | String | varchar(50) | β | |||
| Address1 | String | nvarchar(200) | β | |||
| Address2 | String | nvarchar(60) | β | |||
| City | String | nvarchar(100) | β | |||
| Country | String | char(2) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| Notes | String | nvarchar(1000) | β | |||
| Phone | String | varchar(16) | β | |||
| PostalCode | String | varchar(20) | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| State | String | nvarchar(100) | β | |||
| TaxNumber | String | varchar(30) | β | |||
| Terms | String | nvarchar(50) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| Website | String | nvarchar(255) | β |
A contact person at a supplier.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| String | varchar(255) | β | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| IsPrimary | Boolean | bit | ||||
| Name | String | nvarchar(120) | ||||
| Ordinal | Int32 | int | ||||
| Phone | String | varchar(16) | β | |||
| PhoneExt | String | varchar(10) | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| SupplierId | Int64 | bigint | β | |||
| Title | String | nvarchar(120) | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A currency the merchant transacts in.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CurrencyCode | String | varchar(3) | ||||
| DecimalPlaces | Int32 | int | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Symbol | String | nvarchar(5) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Defines a custom field for an entity type.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DataType | String | varchar(20) | ||||
| DefaultValue | String | nvarchar(500) | β | |||
| EntityType | String | varchar(50) | ||||
| FieldKey | String | varchar(50) | ||||
| FieldName | String | nvarchar(100) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsRequired | Boolean | bit | ||||
| IsSearchable | Boolean | bit | ||||
| Module | String | varchar(50) | β | |||
| Options | String | nvarchar(max) | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| SortOrder | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Per-merchant document-number generator.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int32 | int | β | |||
| DocumentType | String | varchar(20) | ||||
| NextNumber | Int32 | int | ||||
| PadLength | Int32 | int | ||||
| Prefix | String | varchar(10) |
A dated FX rate between two currencies.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| EffectiveDate | DateOnly | date | ||||
| FromCurrencyId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Rate | Decimal | decimal(18,6) | ||||
| RowVersion | Byte[] | rowversion | ||||
| Source | String | varchar(50) | ||||
| ToCurrencyId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A reusable reason code (voids, adjustments, movements).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| Code | String | varchar(30) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| ReasonType | String | varchar(30) | ||||
| RequiresNote | Boolean | bit | ||||
| RowVersion | Byte[] | rowversion | ||||
| SortOrder | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A pinned/favorite report for quick access in the portal Reports area (team-wide when UserId is null, personal otherwise; Position orders them).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Position | Int32 | int | ||||
| PublicId | String | varchar(32) | ||||
| ReportKey | String | nvarchar(64) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| UserId | String | nvarchar(450) | β |
A unit of measure (each, case, lb, etc.).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| Code | String | varchar(10) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DecimalPlaces | Int32 | int | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(50) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Conversion factor between two units (optionally product-specific).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| ConversionFactor | Decimal | decimal(18,6) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| FromUoMId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| ProductId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| ToUoMId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Pre-aggregated (summarized) daily sales totals by dimension/location.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DimensionId | Int64 | bigint | ||||
| DimensionType | String | varchar(30) | ||||
| DiscountTotal | Decimal | decimal(18,2) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| ItemCount | Int32 | int | ||||
| LocationId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SaleDate | DateTime | date | ||||
| TaxTotal | Decimal | decimal(18,2) | ||||
| Total | Decimal | decimal(18,2) | ||||
| TransactionCount | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A configured tender type.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| Code | String | varchar(30) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| OpensCashDrawer | Boolean | bit | ||||
| PaymentType | String | varchar(30) | ||||
| RequiresChange | Boolean | bit | ||||
| RowVersion | Byte[] | rowversion | ||||
| SortOrder | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Links a return line back to the original sold line and quantities.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| OriginalSaleLineItemId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| QuantityReturned | Decimal | decimal(18,4) | ||||
| QuantitySold | Decimal | decimal(18,4) | ||||
| ReturnLocationId | Int64 | bigint | β | β | ||
| ReturnSaleLineItemId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A completed POS sale/return transaction.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CashierEmployeeId | Int64 | bigint | β | |||
| ChangeDue | Decimal | decimal(18,2) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CurrencyId | Int64 | bigint | β | β | ||
| CustomerCertExpiryDate | DateTime | datetime2(3) | β | |||
| CustomerCertNumber | String | varchar(50) | β | |||
| CustomerId | Int64 | bigint | β | β | ||
| DiscountTotal | Decimal | decimal(18,2) | ||||
| ExchangeRateUsed | Decimal | decimal(18,6) | β | |||
| ForeignCurrencyTotal | Decimal | decimal(18,2) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsSynced | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| OriginalSaleId | Int64 | bigint | β | β | ||
| PublicId | String | varchar(32) | ||||
| ReasonCodeId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SaleDateUtc | DateTime | datetime2(3) | ||||
| SaleNumber | String | varchar(50) | ||||
| SaleType | String | varchar(20) | ||||
| SalesRepEmployeeId | Int64 | bigint | β | |||
| ShiftId | Int64 | bigint | β | |||
| Status | String | varchar(20) | ||||
| Subtotal | Decimal | decimal(18,2) | ||||
| TaxTotal | Decimal | decimal(18,2) | ||||
| TerminalId | Int64 | bigint | β | |||
| Total | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| VoidComment | String | nvarchar(500) | β |
A line on a sale (sale or return).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CommissionAmount | Decimal | decimal(18,2) | β | |||
| CommissionPercent | Decimal | decimal(5,2) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DiscountAmount | Decimal | decimal(18,2) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsReturn | Boolean | bit | ||||
| LineTotal | Decimal | decimal(18,2) | ||||
| ProductVariantId | Int64 | bigint | β | |||
| Quantity | Decimal | decimal(18,4) | ||||
| ReasonCodeId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SaleId | Int64 | bigint | β | |||
| SalesRepEmployeeId | Int64 | bigint | β | |||
| TagAlongFromLineId | Int64 | bigint | β | β | ||
| TaxClassification | TaxClassification | tinyint | TaxClassification | |||
| TaxHolidayCode | String | varchar(50) | β | |||
| TaxHolidayId | Int64 | bigint | β | β | ||
| TaxOverrideNotes | String | nvarchar(500) | β | |||
| TaxOverrideReasonCodeCode | String | varchar(50) | β | |||
| TaxOverrideReasonCodeId | Int64 | bigint | β | β | ||
| UnitPrice | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A tender applied to a sale.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Amount | Decimal | decimal(18,2) | ||||
| ChangeGiven | Decimal | decimal(18,2) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| PaymentMethodId | Int64 | bigint | β | |||
| ReferenceNumber | String | varchar(100) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| SaleId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Tax breakdown captured per sale/line.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| RowVersion | Byte[] | rowversion | ||||
| SaleId | Int64 | bigint | β | |||
| SaleLineItemId | Int64 | bigint | β | β | ||
| TaxAmount | Decimal | decimal(18,2) | ||||
| TaxRateCode | String | varchar(50) | ||||
| TaxRateId | Int64 | bigint | β | |||
| TaxRateName | String | nvarchar(100) | ||||
| TaxRateValue | Decimal | decimal(8,6) | ||||
| TaxableAmount | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Cash in/out (pay-in, pay-out, drop) during a shift.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Amount | Decimal | decimal(18,2) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| MovementType | CashMovementType | tinyint | CashMovementType | |||
| Notes | String | nvarchar(500) | β | |||
| ReasonCodeId | Int64 | bigint | β | |||
| Recipient | String | nvarchar(200) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| ShiftId | Int64 | bigint | β | |||
| ShiftSegmentId | Int64 | bigint | β | β | ||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Non-sale register events (no-sale, drawer open).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Comment | String | nvarchar(500) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| EmployeeId | Int64 | bigint | β | |||
| EventType | NonSaleEventType | tinyint | NonSaleEventType | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| PublicId | String | varchar(32) | ||||
| ReasonCodeId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| ShiftId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A cashier/register shift with reconciliation totals.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| BlindClosedAtUtc | DateTime | datetime2(3) | β | |||
| BusinessDate | DateOnly | date | ||||
| CardTotal | Decimal | decimal(18,2) | ||||
| CashTotal | Decimal | decimal(18,2) | ||||
| ClosedAtUtc | DateTime | datetime2(3) | β | |||
| ClosedByEmployeeId | Int64 | bigint | β | β | ||
| ClosingAmount | Decimal | decimal(18,2) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| CurrentTerminalId | Int64 | bigint | β | β | ||
| CustomerCount | Int32 | int | ||||
| DiscountTotal | Decimal | decimal(18,2) | ||||
| DroppedTotal | Decimal | decimal(18,2) | ||||
| EmployeeId | Int64 | bigint | β | |||
| ExpectedAmount | Decimal | decimal(18,2) | β | |||
| ExportedAtUtc | DateTime | datetime2(3) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsBlindClose | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| IsExported | Boolean | bit | ||||
| IsSynced | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| MergedAtUtc | DateTime | datetime2(3) | β | |||
| MergedIntoShiftId | Int64 | bigint | β | β | ||
| NetSalesTotal | Decimal | decimal(18,2) | ||||
| NoSaleCount | Int32 | int | ||||
| OpenedAtUtc | DateTime | datetime2(3) | ||||
| OpeningAmount | Decimal | decimal(18,2) | β | |||
| OtherTenderTotal | Decimal | decimal(18,2) | ||||
| OverShortAmount | Decimal | decimal(18,2) | β | |||
| PaidOutTotal | Decimal | decimal(18,2) | ||||
| PublicId | String | varchar(32) | ||||
| ReturnsTotal | Decimal | decimal(18,2) | ||||
| RowVersion | Byte[] | rowversion | ||||
| SalesTotal | Decimal | decimal(18,2) | ||||
| ShiftNumber | String | varchar(50) | ||||
| SourceId | String | varchar(50) | β | |||
| SourceSystem | SourceSystem | tinyint | SourceSystem | |||
| Status | ShiftStatus | tinyint | ShiftStatus | |||
| TaxTotal | Decimal | decimal(18,2) | ||||
| TransactionCount | Int32 | int | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| VoidCount | Int32 | int |
A counted tender total vs expected for a shift.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CountType | CountType | tinyint | CountType | |||
| CountedAmount | Decimal | decimal(18,2) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| ExpectedAmount | Decimal | decimal(18,2) | ||||
| ForeignCurrencyAmount | Decimal | decimal(18,2) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| PaymentMethodId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| ShiftId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β | |||
| Variance | Decimal | decimal(18,2) |
A continuous segment of a shift on a terminal.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| EndReason | SegmentEndReason | tinyint | SegmentEndReason | |||
| EndedAtUtc | DateTime | datetime2(3) | β | |||
| EndingCashAmount | Decimal | decimal(18,2) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| IsSynced | Boolean | bit | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| SequenceNumber | Int16 | smallint | ||||
| ShiftId | Int64 | bigint | β | |||
| StartedAtUtc | DateTime | datetime2(3) | ||||
| StartingCashAmount | Decimal | decimal(18,2) | β | |||
| TerminalId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Tax collected during a shift by rate.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| RowVersion | Byte[] | rowversion | ||||
| ShiftId | Int64 | bigint | β | |||
| TaxAmount | Decimal | decimal(18,2) | ||||
| TaxRateId | Int64 | bigint | β | |||
| TaxableAmount | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Per-device, per-entity high-water mark for offline sync.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DeviceRegistrationId | Int32 | int | ||||
| EntityType | String | varchar(100) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LastPullRowVersion | Byte[] | varbinary(8) | ||||
| LastPullUtc | DateTime | datetime2(3) | ||||
| LastPushUtc | DateTime | datetime2(3) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A command queued for delivery to a device.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CommandType | String | varchar(50) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DeliveredAtUtc | DateTime | datetime2(3) | β | |||
| DeviceCode | String | varchar(50) | β | |||
| DeviceRegistrationId | Int32 | int | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Payload | String | nvarchar(max) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| Status | SyncCommandStatus | tinyint | SyncCommandStatus | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A record of a device sync session.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CompletedAtUtc | DateTime | datetime2(3) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DeviceCode | String | varchar(50) | ||||
| DeviceRegistrationId | Int32 | int | ||||
| EntitiesPulled | Int32 | int | ||||
| EntitiesPushed | Int32 | int | ||||
| ErrorMessage | String | nvarchar(500) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| RowVersion | Byte[] | rowversion | ||||
| Status | SyncLogStatus | tinyint | SyncLogStatus | |||
| SyncType | SyncType | tinyint | SyncType | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A tax treatment profile (e.g. exempt) assignable to customers.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(500) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| PublicId | String | varchar(32) | ||||
| RequiresCert | Boolean | bit | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Remaps a source tax group to a target group for a profile.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| FromTaxGroupId | Int64 | bigint | β | β | ||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| RowVersion | Byte[] | rowversion | ||||
| TaxProfileId | Int64 | bigint | β | |||
| ToTaxGroupId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A named group of tax rates applied together.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(500) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Membership of a tax rate in a tax group (join, ordered).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Priority | Int32 | int | ||||
| RowVersion | Byte[] | rowversion | ||||
| TaxGroupId | Int64 | bigint | β | |||
| TaxRateId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A tax-holiday period that switches items to another tax group.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| Code | String | varchar(50) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| Description | String | nvarchar(1000) | β | |||
| EndUtc | DateTime | datetime2(3) | ||||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| Name | String | nvarchar(200) | ||||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| StartUtc | DateTime | datetime2(3) | ||||
| TimeZone | String | varchar(100) | ||||
| ToTaxGroupId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Categories included in a tax holiday, with price cap.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CategoryId | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| MaxUnitPrice | Decimal | decimal(18,2) | β | |||
| RowVersion | Byte[] | rowversion | ||||
| TaxHolidayId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Locations where a tax holiday applies (join).
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| TaxHolidayId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Products included in a tax holiday, with price cap.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| MaxUnitPrice | Decimal | decimal(18,2) | β | |||
| ProductId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| TaxHolidayId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
An individual tax rate.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | |||
| Id | Int64 | bigint | β | |||
| Code | String | varchar(50) | ||||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsActive | Boolean | bit | ||||
| IsCompounding | Boolean | bit | ||||
| IsDeleted | Boolean | bit | ||||
| IsIncludedInPrice | Boolean | bit | ||||
| Name | String | nvarchar(100) | ||||
| PublicId | String | varchar(32) | ||||
| Rate | Decimal | decimal(8,6) | ||||
| RowVersion | Byte[] | rowversion | ||||
| ShowOnReceipt | Boolean | bit | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A ship/receive confirmation event against a transfer.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| ConfirmationDate | DateTime | datetime2(3) | ||||
| ConfirmationType | TransferConfirmationType | tinyint | TransferConfirmationType | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DocumentNumber | String | nvarchar(20) | ||||
| EmployeeId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LocationId | Int64 | bigint | β | |||
| Notes | String | nvarchar(500) | β | |||
| PublicId | String | varchar(32) | ||||
| RowVersion | Byte[] | rowversion | ||||
| TransferOrderId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Per-line quantity delta within a confirmation.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| PublicId | String | varchar(32) | ||||
| QuantityDamagedDelta | Decimal | decimal(10,4) | ||||
| QuantityDelta | Decimal | decimal(10,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| TransferConfirmationId | Int64 | bigint | β | |||
| TransferOrderLineId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
An inter-location stock transfer document.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| ClosedByEmployeeId | Int64 | bigint | β | |||
| ClosedDate | DateTime | datetime2(3) | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| DocumentNumber | String | varchar(20) | ||||
| FromLocationId | Int64 | bigint | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| Notes | String | nvarchar(500) | β | |||
| PublicId | String | varchar(32) | ||||
| ReceivedDate | DateTime | datetime2(3) | β | |||
| RequestDate | DateTime | datetime2(3) | ||||
| RequestedByEmployeeId | Int64 | bigint | β | |||
| RowVersion | Byte[] | rowversion | ||||
| ShippedDate | DateTime | datetime2(3) | β | |||
| Status | TransferOrderStatus | tinyint | TransferOrderStatus | |||
| ToLocationId | Int64 | bigint | β | |||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
A variant line on a transfer, with staged quantities.
| Column | Type | Provider | Null | PK | FK | Enum |
|---|---|---|---|---|---|---|
| MerchantId | Int32 | int | β | β | ||
| Id | Int64 | bigint | β | |||
| CreatedAtUtc | DateTime | datetime2(3) | ||||
| CreatedByUserId | String | nvarchar(450) | β | |||
| GlobalId | Guid | uniqueidentifier | ||||
| IsDeleted | Boolean | bit | ||||
| LineNumber | Int32 | int | ||||
| ProductVariantId | Int64 | bigint | β | |||
| PublicId | String | varchar(32) | ||||
| QuantityDamaged | Decimal | decimal(10,4) | ||||
| QuantityReceived | Decimal | decimal(10,4) | ||||
| QuantityRequested | Decimal | decimal(10,4) | ||||
| QuantityShipped | Decimal | decimal(10,4) | ||||
| RowVersion | Byte[] | rowversion | ||||
| TransferOrderId | Int64 | bigint | β | |||
| UnitCost | Decimal | decimal(18,4) | ||||
| UnitPrice | Decimal | decimal(18,2) | ||||
| UpdatedAtUtc | DateTime | datetime2(3) | ||||
| UpdatedByUserId | String | nvarchar(450) | β |
Charge = 0Payment = 1CreditMemo = 2DebitMemo = 3FinanceCharge = 4Draft = 0Sent = 1Paid = 2Overdue = 3Active = 0Suspended = 1Closed = 2Draft = 0Completed = 1Cancelled = 2AgeVerification = 0Warning = 1Info = 2Paid = 0Unpaid = 1None = 0Kit = 1Assembly = 2Matrix = 3LotMatrix = 4CashDrop = 1PayIn = 2PayOut = 3DrawerCount = 4DrawerHandoff = 5None = 0PercentOfSale = 1PercentOfProfit = 2FixedAmount = 3SupplierIncrease = 0SupplierDecrease = 1ManualAdjustment = 2ReceivingVariance = 3EndOfShift = 0TerminalHandoff = 1ManagerCount = 2Warn = 0Block = 1None = 2Pending = 0Active = 1Disabled = 2Revoked = 3POS = 0Kiosk = 1Draft = 0Allocated = 1Shipped = 2Completed = 3Cancelled = 4Pending = 0Dispatching = 1Sent = 2Failed = 3Dead = 4Activation = 0Reload = 1Redemption = 2Adjustment = 3Expiration = 4Active = 0Inactive = 1Expired = 2Active = 0Inactive = 1Expired = 2Shop = 0Pharmacy = 1Hardware = 2Active = 0Inactive = 1Expired = 2Earn = 0Redeem = 1Adjust = 2Void = 3Expire = 4Core = 0Vertical = 1AddOn = 2Sale = 0Return = 1Receipt = 2Adjustment = 3TransferOut = 4TransferIn = 5Count = 6Distribution = 7NoSale = 0Aborted = 1XReport = 2ZReport = 3ZZReport = 4BlindCloseout = 5Email = 0Sms = 1Push = 2Draft = 0Confirmed = 1InProgress = 2ReadyForPickup = 3Completed = 4Cancelled = 5Quote = 0LayawayOrder = 1BackOrder = 2WorkOrder = 3SpecialOrder = 4PartnerAdmin = 0PartnerSupport = 1DueOnReceipt = 0NetDays = 1EndOfMonth = 2Draft = 0PendingApproval = 1Approved = 2Applied = 3Cancelled = 4Rejected = 5Zpl = 0Tspl = 1Pending = 0Printing = 1Completed = 2Failed = 3Manual = 0Receiving = 1PriceChange = 2Draft = 0Active = 1Inactive = 2Percent = 0FixedAmount = 1BuyXGetY = 2FixedPrice = 3Product = 0Category = 1Sale = 2Draft = 0Submitted = 1PartiallyReceived = 2FullyReceived = 3Closed = 4Cancelled = 5Draft = 0Completed = 1Cancelled = 2Available = 1Blocked = 2Active = 0Moved = 1LoggedOut = 2IdleTimeout = 3ManagerOverride = 4ShiftClosed = 5Merged = 6Open = 1Suspended = 2PendingCount = 3Closed = 4Merged = 5Voided = 6NativeQIIUB = 0ImportTool = 1InProgress = 0Completed = 1Cancelled = 2SupportTicket = 0BugInvestigation = 1Onboarding = 2Billing = 3DataCorrection = 4Compliance = 5Training = 6Other = 7Pending = 0Delivered = 1Failed = 2Started = 0Completed = 1Failed = 2Pull = 0Push = 1Full = 2Taxed = 0Exempt = 1Waived = 2Mapped = 3Platform = 0Partner = 1Merchant = 2Open = 0Closed = 1Adjusted = 2Shipped = 0Received = 1PartialReceived = 2Rejected = 3Draft = 0Submitted = 1Shipped = 2InTransit = 3PartiallyReceived = 4Received = 5Closed = 6Cancelled = 7SystemAdmin = 0Admin = 1Manager = 2Cashier = 3Pending = 0Synced = 1Error = 2Disabled = 3Qiiub = 0Shopify = 1BigCommerce = 2WooCommerce = 3