Zentry.Billing.Api v1.0

Base URLs:

https://api.billing.zentrypass.com

Authentication

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

Employer

GetEmployerBillingProfileLink

GET /Employer/{EmployerId}/profile/link

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetBillingProfileLinkResponse

GetEmployerBillingPlans

GET /Employer/plans

Responses

Status	Meaning	Description	Schema
200	OK	OK	EmployerBillingPlanIPagedResponse

Invoice

CreateWorkspaceInvoices

POST /Invoice/workspace/create

Body parameter

{
  "fromDate": "2019-08-24T14:15:22Z",
  "toDate": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateWorksapceInvoicesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

GetWorkspaceInvoices

POST /Invoice/workspace

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

GetWorkspaceInvoiceLink

GET /Invoice/workspace/{InvoiceId}/link

Parameters

Name	In	Type	Required	Description
InvoiceId	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetWorkspaceInvoiceLinkResponse

CompleteWorkspaceInvoice

POST /Invoice/workspace/complete

Body parameter

{
  "invoiceId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CompleteWorkspaceInvoiceRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

CreateEmployerInvoices

POST /Invoice/employer/create

Body parameter

{
  "fromDate": "2019-08-24T14:15:22Z",
  "toDate": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
body	body	CreateEmployerInvoicesRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

GetEmployerInvoices

POST /Invoice/employer

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

GetEmployerInvoiceLink

GET /Invoice/employer/{InvoiceId}/link

Parameters

Name	In	Type	Required	Description
InvoiceId	path	string	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetEmployerInvoiceLinkResponse

CompleteEmployerInvoice

POST /Invoice/employer/complete

Body parameter

{
  "invoiceId": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CompleteEmployerInvoiceRequest	false	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

Workspace

GetWorkspaceBillingProfileLink

GET /Workspace/{WorkspaceId}/profile/link

Parameters

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

Responses

Status	Meaning	Description	Schema
200	OK	OK	GetBillingProfileLinkResponse

GetWorkspaceBillingProfile

GET /Workspace/profile

Responses

Status	Meaning	Description	Schema
200	OK	OK	WorkspaceBillingProfile

Schemas

CompleteEmployerInvoiceRequest

{
  "invoiceId": "string"
}

Name	Type	Required	Restrictions	Description
invoiceId	string	true	none	none

CompleteWorkspaceInvoiceRequest

{
  "invoiceId": "string"
}

Name	Type	Required	Restrictions	Description
invoiceId	string	true	none	none

CreateEmployerInvoicesRequest

{
  "fromDate": "2019-08-24T14:15:22Z",
  "toDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
fromDate	string(date-time)	true	none	none
toDate	string(date-time)	true	none	none

CreateWorksapceInvoicesRequest

{
  "fromDate": "2019-08-24T14:15:22Z",
  "toDate": "2019-08-24T14:15:22Z"
}

Name	Type	Required	Restrictions	Description
fromDate	string(date-time)	true	none	none
toDate	string(date-time)	true	none	none

EmployerBillingPlan

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "name": "Starter",
  "cost": 8000,
  "checkInTokens": 60
}

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 billing plan
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.

EmployerBillingPlanIPagedResponse

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

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

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",
  "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
total	integer(int64)	true	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",
      "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

GetBillingProfileLinkResponse

{
  "link": "string"
}

Name	Type	Required	Restrictions	Description
link	string	true	none	none

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

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

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	Error

WorkspaceBillingProfile

{
  "id": "184d3163ee1ffbbdb38b6c07",
  "dateCreated": "2019-08-24T14:15:22Z",
  "dateUpdated": "2019-08-24T14:15:22Z",
  "workspaceId": "string",
  "stripeAccountId": "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
workspaceId	string	true	none	none
stripeAccountId	string	true	none	none

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
}

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

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
    }
  ],
  "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

Zentry.Billing.Api v1.0

Employer​

GetEmployerBillingProfileLink​

Parameters

Responses

GetEmployerBillingPlans​

Responses

Invoice​

CreateWorkspaceInvoices​

Parameters

Responses

GetWorkspaceInvoices​

Parameters

Responses

GetWorkspaceInvoiceLink​

Parameters

Responses

CompleteWorkspaceInvoice​

Parameters

Responses

CreateEmployerInvoices​

Parameters

Responses

GetEmployerInvoices​

Parameters

Responses

GetEmployerInvoiceLink​

Parameters

Responses

CompleteEmployerInvoice​

Parameters

Responses

Workspace​

GetWorkspaceBillingProfileLink​

Parameters

Responses

GetWorkspaceBillingProfile​

Responses

Schemas​

CompleteEmployerInvoiceRequest​

CompleteWorkspaceInvoiceRequest​

CreateEmployerInvoicesRequest​

CreateWorksapceInvoicesRequest​

EmployerBillingPlan​

EmployerBillingPlanIPagedResponse​

EmployerInvoice​

EmployerInvoiceIPagedResponse​

EmployerInvoiceQuery​

GetBillingProfileLinkResponse​

GetEmployerInvoiceLinkResponse​

GetEmployerInvoicesRequest​

GetWorkspaceInvoiceLinkResponse​

GetWorkspaceInvoicesRequest​

IPagedRequest​

InvoiceStatus​

Enumerated Values​

WorkspaceBillingProfile​

WorkspaceInvoice​

WorkspaceInvoiceIPagedResponse​

WorkspaceInvoiceQuery​

Employer

GetEmployerBillingProfileLink

GetEmployerBillingPlans

Invoice

CreateWorkspaceInvoices

GetWorkspaceInvoices

GetWorkspaceInvoiceLink

CompleteWorkspaceInvoice

CreateEmployerInvoices

GetEmployerInvoices

GetEmployerInvoiceLink

CompleteEmployerInvoice

Workspace

GetWorkspaceBillingProfileLink

GetWorkspaceBillingProfile

Schemas

CompleteEmployerInvoiceRequest

CompleteWorkspaceInvoiceRequest

CreateEmployerInvoicesRequest

CreateWorksapceInvoicesRequest

EmployerBillingPlan

EmployerBillingPlanIPagedResponse

EmployerInvoice

EmployerInvoiceIPagedResponse

EmployerInvoiceQuery

GetBillingProfileLinkResponse

GetEmployerInvoiceLinkResponse

GetEmployerInvoicesRequest

GetWorkspaceInvoiceLinkResponse

GetWorkspaceInvoicesRequest

IPagedRequest

InvoiceStatus

Enumerated Values

WorkspaceBillingProfile

WorkspaceInvoice

WorkspaceInvoiceIPagedResponse

WorkspaceInvoiceQuery