Zentry.Billing.Api v1.0

Base URLs:

• http://localhost:5081
• https://api.billing.zentrypass.com

Authentication

• API Key (API_KEY)
  • Parameter Name: Api-Key Authentication, in: header.

Employer

GetEmployerBillingProfile

GET /Employer/{EmployerId}/profile

Parameters

Name	In	Type	Required	Description
EmployerId	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployerBillingProfile

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

EmployerInvoice

GetEmployerInvoices

POST /EmployerInvoice

Body parameter

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetEmployerInvoicesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployerInvoiceIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetEmployerInvoiceLink

GET /EmployerInvoice/{InvoiceId}/link

Parameters

Name	In	Type	Required	Description
InvoiceId	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetEmployerInvoiceLinkResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

EmployerLicense

GetEmployerLicenses

POST /EmployerLicense

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "employerIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetEmployerLicensesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployerLicenseIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UpsertEmployerLicense

POST /EmployerLicense/upsert

Body parameter

{
  "employerId": "string",
  "name": "Starter",
  "cost": 8000,
  "checkInTokens": 60,
  "canReserveRoom": false,
  "futurePrice": 10000,
  "monthsUntilPriceIncrease": 2
}

Parameters

Name	In	Type	Required	Description
id	query	string	false	none
body	body	UpsertEmployerLicenseRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployerLicense

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Payment

GetPayments

POST /Payment

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "tenantIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetPaymentsRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	PaymentIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

CreateUserPayment

POST /Payment/user/create

Body parameter

{
  "userId": "string",
  "amount": 0
}

Parameters

Name	In	Type	Required	Description
body	body	CreateUserPaymentRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	Payment

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetUserCostBreakdown

GET /Payment/user/breakdown

Parameters

Name	In	Type	Required	Description
Amount	query	integer(int64)	false	The amount in cents.
UserId	query	string	false	The id of the user to get the breakdown for

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetCostBreakdownResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Stripe

GetSetupIntent

GET /Stripe/setup-intent

Responses

Status	Meaning	Description	Schema
200	OK	OK	StripeSetupIntentResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

SyncPaymentSetupIntent

GET /Stripe/sync/{Id}

Parameters

Name	In	Type	Required	Description
request	header	SyncSetupIntentRequest	false	none
Id	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UserBillingProfile

GetUserBillingProfiles

POST /UserBillingProfile

Body parameter

{
  "offset": 0,
  "limit": 25,
  "userIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetUserBillingProfilesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserBillingProfileIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UserLicense

GetUserLicenses

POST /EmployeeLicense

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "tenantIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "statuses": [
    "Pending"
  ],
  "expirationDateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "type": "User",
  "employerIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetUserLicensesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserLicenseIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

CreateEmployeeLicense

POST /UserLicense/create

Body parameter

{
  "employerId": "926d3163ee1ffbbdb47b6a76",
  "licenseId": "926d3163ee1ffbbdb47b6a76",
  "userId": "926d3163ee1ffbbdb47b6a76"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateEmployeeLicenseRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	UserLicense

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Workspace

GetWorkspaceBillingProfileLink

GET /Workspace/profile/link

Parameters

Name	In	Type	Required	Description
2fa-code	header	string	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetBillingProfileLinkResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetWorkspaceBillingProfile

GET /Workspace/profile

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceBillingProfile

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

WorkspaceInvoice

CreateWorkspaceInvoice

POST /WorkspaceInvoice/create

Body parameter

{
  "workspaceId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateWorkspaceInvoiceRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceInvoice

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

PreviewWorkspaceInvoice

POST /WorkspaceInvoice/preview

Body parameter

{
  "workspaceId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateWorkspaceInvoiceRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceInvoice

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetWorkspaceInvoices

POST /WorkspaceInvoice

Body parameter

{
  "offset": 0,
  "limit": 25,
  "workspaceIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetWorkspaceInvoicesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceInvoiceIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

GetWorkspaceInvoiceLink

GET /WorkspaceInvoice/{InvoiceId}/link

Parameters

Name	In	Type	Required	Description
InvoiceId	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetWorkspaceInvoiceLinkResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

WorkspaceLicense

GetWorkspaceLicenses

POST /WorkspaceLicense

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "tenantIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "statuses": [
    "Pending"
  ],
  "expirationDateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "type": "User"
}

Parameters

Name	In	Type	Required	Description
body	body	GetWorkspaceLicensesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceLicenseIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

WorkspaceLicenseTemplate

GetWorkspaceLicenseTemplates

POST /WorkspaceLicenseTemplate

Body parameter

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "workspaceIds": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	GetWorkspaceLicenseTemplatesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceLicenseTemplateIPagedResponse

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

UpsertWorkspaceLicenseTemplate

POST /WorkspaceLicenseTemplate/upsert

Body parameter

{
  "name": "string",
  "description": "string",
  "workspaceId": "string",
  "locationIds": [
    "string"
  ],
  "cost": 8000,
  "billingFrequency": "Monthly"
}

Parameters

Name	In	Type	Required	Description
id	query	string	false	none
body	body	UpsertWorkspaceLicenseTemplateRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceLicenseTemplate

To perform this operation, you must be authenticated by means of one of the following methods: API_KEY

Schemas

BillingFrequency

"Monthly"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Monthly
anonymous	Annually
anonymous	Once

CreateEmployeeLicenseRequest

{
  "employerId": "926d3163ee1ffbbdb47b6a76",
  "licenseId": "926d3163ee1ffbbdb47b6a76",
  "userId": "926d3163ee1ffbbdb47b6a76"
}

Name	Type	Required	Restrictions	Description
employerId	string	true	none	Zentry Pass Employer Id
licenseId	string	true	none	Zentry Pass Employer License Id.
userId	string	true	none	Zentry Pass User Id

CreateUserPaymentRequest

{
  "userId": "string",
  "amount": 0
}

Name	Type	Required	Restrictions	Description
userId	string	true	none	none
amount	integer(int64)	true	none	none

CreateWorkspaceInvoiceRequest

{
  "workspaceId": "string"
}

Name	Type	Required	Restrictions	Description
workspaceId	string	true	none	none

DateRange

{
  "from": "2019-08-24T14:15:22Z",
  "to": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
from	string(date-time)	true	none	The start of the date range
to	string(date-time)	true	none	The end of the date range

EmployerBillingProfile

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "employerId": "926d3163ee1ffbbdb47b6a76",
  "hasPaymentMethod": true,
  "zipCode": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
employerId	string	true	none	Zentry Pass Employer Id
hasPaymentMethod	boolean	true	none	Flag indicating this employer has setup a payment method
zipCode	string¦null	false	none	The billing zip code

EmployerInvoice

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "employerId": "string",
  "status": "New",
  "fromDate": "2019-08-24T14:15:22Z",
  "toDate": "2019-08-24T14:15:22Z",
  "subTotal": 0,
  "feeTotal": 0,
  "taxes": 0,
  "total": 0
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
employerId	string	true	none	none
status	InvoiceStatus	true	none	none
fromDate	string(date-time)¦null	false	none	none
toDate	string(date-time)	true	none	none
subTotal	integer(int64)	true	none	none
feeTotal	integer(int64)¦null	false	none	none
taxes	integer(int64)¦null	false	none	none
total	integer(int64)¦null	false	none	none

EmployerInvoiceIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "employerId": "string",
      "status": "New",
      "fromDate": "2019-08-24T14:15:22Z",
      "toDate": "2019-08-24T14:15:22Z",
      "subTotal": 0,
      "feeTotal": 0,
      "taxes": 0,
      "total": 0
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[EmployerInvoice]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

EmployerInvoiceQuery

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
employerIds	[string]¦null	false	none	none

EmployerLicense

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "employerId": "string",
  "name": "Starter",
  "cost": 8000,
  "checkInTokens": 60,
  "canReserveRoom": false,
  "futurePrice": 10000,
  "monthsUntilPriceIncrease": 2
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
employerId	string	true	none	Zentry Pass Employer Id
name	string	true	none	The name of the license
cost	integer(int64)	true	none	How much this billing plan costs for the employee. Cost is in cents.
checkInTokens	integer(int32)	true	none	The number of tokens an employee is allocated for per month.
canReserveRoom	boolean	true	none	Whether this billing plan is allowed to reserve special rooms
futurePrice	integer(int64)¦null	false	none	Future price that this license will increase to. Cost is in cents. Null if no future price increase is planned.
monthsUntilPriceIncrease	integer(int32)¦null	false	none	Number of months from employee activation date until the price increases to FuturePrice. Null if no future price increase is planned.

EmployerLicenseIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "employerId": "string",
      "name": "Starter",
      "cost": 8000,
      "checkInTokens": 60,
      "canReserveRoom": false,
      "futurePrice": 10000,
      "monthsUntilPriceIncrease": 2
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[EmployerLicense]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

EmployerLicenseQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "employerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	none
employerIds	[string]¦null	false	none	List of Zentry Pass Employer Ids

Fee

{
  "name": "string",
  "amount": 0
}

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the fee
amount	integer(int64)	true	none	The amount of the fee in cents

GetBillingProfileLinkResponse

{
  "link": "string"
}

Name	Type	Required	Restrictions	Description
link	string	true	none	none

GetCostBreakdownFee

{
  "name": "string",
  "amount": 0
}

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the fee
amount	integer(int64)	true	none	The amount of the fee in cents

GetCostBreakdownResponse

{
  "amount": 0,
  "fees": [
    {
      "name": "string",
      "amount": 0
    }
  ],
  "feeTotal": 0,
  "taxes": 0,
  "total": 0
}

Name	Type	Required	Restrictions	Description
amount	integer(int64)	true	none	The original amount in cents
fees	[GetCostBreakdownFee]¦null	false	none	Breakdown of all the fees
feeTotal	integer(int64)¦null	false	read-only	The amount in fees in cents.
taxes	integer(int64)	true	none	The amount of taxes in cents.
total	integer(int64)	true	none	The total amount in cents

GetEmployerInvoiceLinkResponse

{
  "link": "string"
}

Name	Type	Required	Restrictions	Description
link	string	true	none	none

GetEmployerInvoicesRequest

{
  "offset": 0,
  "limit": 25,
  "employerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	EmployerInvoiceQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetEmployerLicensesRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "employerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	EmployerLicenseQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetPaymentsRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "tenantIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	PaymentQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetUserBillingProfilesRequest

{
  "offset": 0,
  "limit": 25,
  "userIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	UserBillingProfileQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetUserLicensesRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "tenantIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "statuses": [
    "Pending"
  ],
  "expirationDateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "type": "User",
  "employerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	UserLicenseQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetWorkspaceInvoiceLinkResponse

{
  "link": "string"
}

Name	Type	Required	Restrictions	Description
link	string	true	none	none

GetWorkspaceInvoicesRequest

{
  "offset": 0,
  "limit": 25,
  "workspaceIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	WorkspaceInvoiceQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetWorkspaceLicenseTemplatesRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "workspaceIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	WorkspaceLicenseTemplateQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

GetWorkspaceLicensesRequest

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "tenantIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "statuses": [
    "Pending"
  ],
  "expirationDateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "type": "User"
}

Name	Type	Required	Restrictions	Description
anonymous	WorkspaceLicenseQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

IPagedRequest

{
  "offset": 0,
  "limit": 25
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	read-only	How far to skip into a collection
limit	integer(int32)	true	read-only	How many results to return

InvoiceStatus

"New"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	New
anonymous	Complete
anonymous	Failed
anonymous	ProfileIncomplete
anonymous	Error

License

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "name": "string",
  "activationDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "billingFrequency": "Monthly",
  "tenantId": "926d3163ee1ffbbdb47b6a76",
  "userId": "926d3163ee1ffbbdb47b6a76",
  "cost": 8000,
  "status": "Pending",
  "autoRenew": true,
  "futurePrice": 10000,
  "priceIncreaseDate": "2019-08-24T14:15:22Z",
  "type": "User"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
name	string	true	none	The name of the license
activationDate	string(date-time)	true	none	The date this license becomes active
expirationDate	string(date-time)	true	none	The date this license expires
billingFrequency	BillingFrequency	true	none	none
tenantId	string	true	none	Zentry Pass Tenant Id
userId	string	true	none	Zentry Pass User Id
cost	integer(int64)	true	none	How much this license costs. Cost is in cents.
status	LicenseStatus	true	none	none
autoRenew	boolean	true	none	Whether this plan should auto-renew
futurePrice	integer(int64)¦null	false	none	Future price that this license will increase to. Cost is in cents. Null if no future price increase is planned.
priceIncreaseDate	string(date-time)¦null	false	none	The date when the price will increase to FuturePrice. Null if no future price increase is planned.
type	LicenseType	true	none	none

LicenseQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "tenantIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "statuses": [
    "Pending"
  ],
  "expirationDateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "type": "User"
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	none
tenantIds	[string]¦null	false	none	none
userIds	[string]¦null	false	none	none
statuses	[LicenseStatus]¦null	false	none	none
expirationDateRange	DateRange	false	none	none
type	LicenseType	false	none	none

LicenseStatus

"Pending"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Pending
anonymous	Active
anonymous	Suspended
anonymous	Inactive

LicenseType

"User"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	User
anonymous	Workspace

LocationInvoice

{
  "locationId": "string",
  "locationName": "string",
  "locationInvoiceDetails": [
    {
      "timeIn": "2019-08-24T14:15:22Z",
      "cost": 0
    }
  ],
  "total": 0
}

Name	Type	Required	Restrictions	Description
locationId	string	true	none	none
locationName	string	true	none	none
locationInvoiceDetails	[LocationInvoiceDetail]	true	none	none
total	integer(int64)	true	read-only	none

LocationInvoiceDetail

{
  "timeIn": "2019-08-24T14:15:22Z",
  "cost": 0
}

Name	Type	Required	Restrictions	Description
timeIn	string(date-time)	true	none	none
cost	integer(int64)	true	none	none

Payment

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "tenantId": "926d3163ee1ffbbdb47b6a76",
  "subTotal": 0,
  "fees": [
    {
      "name": "string",
      "amount": 0
    }
  ],
  "feeTotal": 0,
  "taxes": 0,
  "total": 0,
  "result": "Unknown",
  "refund": {
    "amount": 0,
    "date": "2019-08-24T14:15:22Z",
    "reason": "string"
  }
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
tenantId	string	true	none	Zentry Pass Tenant Id
subTotal	integer(int64)	true	none	The subtotal amount charged in cents
fees	[Fee]¦null	false	none	Breakdown of all the fees on this payment
feeTotal	integer(int64)¦null	false	read-only	The fees associated with the payment. Stored in cents.
taxes	integer(int64)¦null	false	none	How much was charged in taxes in cents
total	integer(int64)¦null	false	none	The total amount charged including taxes
result	PaymentResult	true	none	none
refund	Refund	false	none	none

PaymentIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "tenantId": "926d3163ee1ffbbdb47b6a76",
      "subTotal": 0,
      "fees": [
        {
          "name": "string",
          "amount": 0
        }
      ],
      "feeTotal": 0,
      "taxes": 0,
      "total": 0,
      "result": "Unknown",
      "refund": {
        "amount": 0,
        "date": "2019-08-24T14:15:22Z",
        "reason": "string"
      }
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[Payment]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

PaymentQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "tenantIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	none
tenantIds	[string]¦null	false	none	none

PaymentResult

"Unknown"

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	none

Enumerated Values

Property	Value
anonymous	Unknown
anonymous	Successful
anonymous	Failed
anonymous	Refunded

Refund

{
  "amount": 0,
  "date": "2019-08-24T14:15:22Z",
  "reason": "string"
}

Name	Type	Required	Restrictions	Description
amount	integer(int64)	true	none	The amount that was refunded if there was a refund issued
date	string(date-time)	true	none	The date of the refund
reason	string¦null	false	none	The reason for the refund

StripeSetupIntentResponse

{
  "clientSecret": "string"
}

Name	Type	Required	Restrictions	Description
clientSecret	string	true	none	none

SyncSetupIntentRequest

{
  "id": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	none

UpsertEmployerLicenseRequest

{
  "employerId": "string",
  "name": "Starter",
  "cost": 8000,
  "checkInTokens": 60,
  "canReserveRoom": false,
  "futurePrice": 10000,
  "monthsUntilPriceIncrease": 2
}

Name	Type	Required	Restrictions	Description
employerId	string	true	none	Zentry Pass Employer Id
name	string	true	none	The name of the license
cost	integer(int64)	true	none	How much this billing plan costs for the employee. Cost is in cents.
checkInTokens	integer(int32)	true	none	The number of tokens an employee is allocated for per month.
canReserveRoom	boolean	true	none	Whether this billing plan is allowed to reserve special rooms
futurePrice	integer(int64)¦null	false	none	Future price that this license will increase to. Cost is in cents. Null if no future price increase is planned.
monthsUntilPriceIncrease	integer(int32)¦null	false	none	Number of months from employee activation date until the price increases to FuturePrice. Null if no future price increase is planned.

UpsertWorkspaceLicenseTemplateRequest

{
  "name": "string",
  "description": "string",
  "workspaceId": "string",
  "locationIds": [
    "string"
  ],
  "cost": 8000,
  "billingFrequency": "Monthly"
}

Name	Type	Required	Restrictions	Description
name	string	true	none	The name of the license
description	string	true	none	Description of the license
workspaceId	string	true	none	Zentry Pass Workspace Id
locationIds	[string]¦null	false	none	Zentry Pass Location Ids this workspace license can be used at. If this is null, then it can be used at any location.
cost	integer(int64)	true	none	How much this license costs. Cost is in cents.
billingFrequency	BillingFrequency	true	none	none

UserBillingProfile

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "userId": "926d3163ee1ffbbdb47b6a76",
  "hasPaymentMethod": true,
  "zipCode": "string"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
userId	string	true	none	Zentry Pass User Id
hasPaymentMethod	boolean	true	none	Flag indicating this user has setup a payment method
zipCode	string¦null	false	none	The billing zip code

UserBillingProfileIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "userId": "926d3163ee1ffbbdb47b6a76",
      "hasPaymentMethod": true,
      "zipCode": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[UserBillingProfile]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

UserBillingProfileQuery

{
  "offset": 0,
  "limit": 25,
  "userIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
userIds	[string]¦null	false	none	none

UserLicense

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "name": "string",
  "activationDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "billingFrequency": "Monthly",
  "tenantId": "926d3163ee1ffbbdb47b6a76",
  "userId": "926d3163ee1ffbbdb47b6a76",
  "cost": 8000,
  "status": "Pending",
  "autoRenew": true,
  "futurePrice": 10000,
  "priceIncreaseDate": "2019-08-24T14:15:22Z",
  "type": "User",
  "tokenDateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "checkInTokens": 60,
  "canReserveRoom": false
}

Name	Type	Required	Restrictions	Description
anonymous	License	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» tokenDateRange	DateRange	true	none	none
» checkInTokens	integer(int32)	true	none	The number of tokens an employee is allocated for per month.
» canReserveRoom	boolean	true	none	Whether this license allows the employee to reserve special rooms

UserLicenseIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "name": "string",
      "activationDate": "2019-08-24T14:15:22Z",
      "expirationDate": "2019-08-24T14:15:22Z",
      "billingFrequency": "Monthly",
      "tenantId": "926d3163ee1ffbbdb47b6a76",
      "userId": "926d3163ee1ffbbdb47b6a76",
      "cost": 8000,
      "status": "Pending",
      "autoRenew": true,
      "futurePrice": 10000,
      "priceIncreaseDate": "2019-08-24T14:15:22Z",
      "type": "User",
      "tokenDateRange": {
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z"
      },
      "checkInTokens": 60,
      "canReserveRoom": false
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[UserLicense]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

UserLicenseQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "tenantIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "statuses": [
    "Pending"
  ],
  "expirationDateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "type": "User",
  "employerIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
anonymous	LicenseQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» employerIds	[string]¦null	false	none	none

WorkspaceBillingProfile

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "workspaceId": "string",
  "payoutsEnabled": true
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
workspaceId	string	true	none	Zentry Pass Workspace Id
payoutsEnabled	boolean	true	none	Indicates workspaces has payouts enabled

WorkspaceInvoice

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "workspaceId": "string",
  "status": "New",
  "fromDate": "2019-08-24T14:15:22Z",
  "toDate": "2019-08-24T14:15:22Z",
  "total": 0,
  "locationInvoices": [
    {
      "locationId": "string",
      "locationName": "string",
      "locationInvoiceDetails": [
        {
          "timeIn": "2019-08-24T14:15:22Z",
          "cost": 0
        }
      ],
      "total": 0
    }
  ]
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
workspaceId	string	true	none	none
status	InvoiceStatus	true	none	none
fromDate	string(date-time)¦null	false	none	none
toDate	string(date-time)	true	none	none
total	integer(int64)	true	none	none
locationInvoices	[LocationInvoice]	true	none	none

WorkspaceInvoiceIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "workspaceId": "string",
      "status": "New",
      "fromDate": "2019-08-24T14:15:22Z",
      "toDate": "2019-08-24T14:15:22Z",
      "total": 0,
      "locationInvoices": [
        {
          "locationId": "string",
          "locationName": "string",
          "locationInvoiceDetails": [
            {
              "timeIn": "2019-08-24T14:15:22Z",
              "cost": 0
            }
          ],
          "total": 0
        }
      ]
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[WorkspaceInvoice]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

WorkspaceInvoiceQuery

{
  "offset": 0,
  "limit": 25,
  "workspaceIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
workspaceIds	[string]¦null	false	none	none

WorkspaceLicense

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "name": "string",
  "activationDate": "2019-08-24T14:15:22Z",
  "expirationDate": "2019-08-24T14:15:22Z",
  "billingFrequency": "Monthly",
  "tenantId": "926d3163ee1ffbbdb47b6a76",
  "userId": "926d3163ee1ffbbdb47b6a76",
  "cost": 8000,
  "status": "Pending",
  "autoRenew": true,
  "futurePrice": 10000,
  "priceIncreaseDate": "2019-08-24T14:15:22Z",
  "type": "User",
  "locationId": "string"
}

Name	Type	Required	Restrictions	Description
anonymous	License	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» locationId	string¦null	false	none	Zentry Pass Location Id. Optional.

WorkspaceLicenseIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "name": "string",
      "activationDate": "2019-08-24T14:15:22Z",
      "expirationDate": "2019-08-24T14:15:22Z",
      "billingFrequency": "Monthly",
      "tenantId": "926d3163ee1ffbbdb47b6a76",
      "userId": "926d3163ee1ffbbdb47b6a76",
      "cost": 8000,
      "status": "Pending",
      "autoRenew": true,
      "futurePrice": 10000,
      "priceIncreaseDate": "2019-08-24T14:15:22Z",
      "type": "User",
      "locationId": "string"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[WorkspaceLicense]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

WorkspaceLicenseQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "tenantIds": [
    "string"
  ],
  "userIds": [
    "string"
  ],
  "statuses": [
    "Pending"
  ],
  "expirationDateRange": {
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z"
  },
  "type": "User"
}

Name	Type	Required	Restrictions	Description
anonymous	LicenseQuery	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none

WorkspaceLicenseTemplate

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "workspaceId": "string",
  "locationIds": [
    "string"
  ],
  "cost": 8000,
  "billingFrequency": "Monthly"
}

Name	Type	Required	Restrictions	Description
id	string	true	none	The unique identifier for this entity
dateCreated	string(date-time)	true	none	The initial date this entity was created
dateUpdated	string(date-time)	true	none	The last time this entity was updated
name	string	true	none	The name of the license
description	string	true	none	Description of the license
workspaceId	string	true	none	Zentry Pass Workspace Id
locationIds	[string]¦null	false	none	Zentry Pass Location Ids this workspace license can be used at. If this is null, then it can be used at any location.
cost	integer(int64)	true	none	How much this license costs. Cost is in cents.
billingFrequency	BillingFrequency	true	none	none

WorkspaceLicenseTemplateIPagedResponse

{
  "data": [
    {
      "id": "184d3163ee1ffbbdb38b6c07",
      "dateCreated": "2019-08-24T14:15:22Z",
      "dateUpdated": "2019-08-24T14:15:22Z",
      "name": "string",
      "description": "string",
      "workspaceId": "string",
      "locationIds": [
        "string"
      ],
      "cost": 8000,
      "billingFrequency": "Monthly"
    }
  ],
  "pagedRequest": {
    "offset": 0,
    "limit": 25
  },
  "totalCount": 100
}

Name	Type	Required	Restrictions	Description
data	[WorkspaceLicenseTemplate]	true	read-only	The paged data
pagedRequest	IPagedRequest	true	none	none
totalCount	integer(int32)	true	read-only	The total number of items available

WorkspaceLicenseTemplateQuery

{
  "offset": 0,
  "limit": 25,
  "ids": [
    "string"
  ],
  "workspaceIds": [
    "string"
  ]
}

Name	Type	Required	Restrictions	Description
offset	integer(int32)	true	none	How far to skip into a collection
limit	integer(int32)	true	none	How many results to return
ids	[string]¦null	false	none	List of Workspace License Ids
workspaceIds	[string]¦null	false	none	List of Zentry Pass Workspace Ids