Universal Data Models - Membrane Docs

Universal Data Models (UDM) let you work with data from third-party applications in a standardized way—without knowing anything about the underlying data structure. Connectors provide mappings from and to UDM for relevant data models. You can find currently supported Universal Data Models below.

Activities

Fields Schema

Field	Type	Notes
id	string	Read Only
title	string
description	string
type	string
durationSeconds	number
location	string
isRecurrent	boolean
participants	list	item: object
userId	string
contactId	string
status	string
companyId	string
dealId	string
leadId	string
ownerId	string
startTime	string	Format: date-time
endTime	string	Format: date-time
dueTime	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Bills

Fields Schema

Field	Type	Notes
id	string	Read Only
number	string
name	string
memo	string
status	string
paymentMethod	string
supplierId	string
currency	string
payments	list	item: string
lineItems	list	item: object
id	string
itemName	string
description	string
code	string
type	string
companyId	string
ledgerAccountId	string
quantity	number
unitPrice	number
unitOfMeasure	string
purchasePrice	number
salesPrice	number
taxable	boolean
taxAmount	number
totalAmount	number
totalAmount	number
totalTax	number
exchangeRate	number
totalDiscount	number
subTotal	number
balance	number
ledgerAccountId	string
issueDate	string	Format: date-time
dueDate	string	Format: date-time
paidOnDate	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Campaign Members

Fields Schema

Field	Type	Notes
id	string	Read Only
fullName	string
firstName	string
lastName	string
primaryEmail	string
campaignId	string
contactId	string
leadId	string
source	string
status	string
companyId	string
jobTitle	string
hasOptedOutOfEmail	boolean
createdTime	string	Format: date-time
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Campaigns

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
cost	number
description	string
source	string
stage	string
type	string
ownerId	string
sentCount	number	Read Only
replyCount	number	Read Only
openCount	number	Read Only
clickCount	number	Read Only
startTime	string	Format: date-time
endTime	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only
lastActivityTime	string	Format: date-time, Read Only

Companies

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
websiteUrl	string
phones	list	item: object
value	string
type	string
primaryPhone	string
description	string
currency	string
industry	string
ownerId	string
primaryAddress	object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
addresses	list	item: object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
numberOfEmployees	number
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only
lastActivityTime	string	Format: date-time, Read Only

Contacts

Fields Schema

Field	Type	Notes
id	string	Read Only
fullName	string
firstName	string
lastName	string
primaryEmail	string
emails	list	item: object
value	string
type	string
primaryPhone	string
phones	list	item: object
value	string
type	string
primaryAddress	object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
addresses	list	item: object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
stage	string
companyName	string
companyId	string
ownerId	string
jobTitle	string
source	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only
lastActivityTime	string	Format: date-time, Read Only

Contact Lists

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
description	string
source	string
type	string
ownerId	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Credit Notes

Fields Schema

Field	Type	Notes
id	string	Read Only
number	string
memo	string
status	string
customerId	string
currency	string
exchangeRate	number
payments	list	item: string
lineItems	list	item: object
id	string
itemName	string
description	string
quantity	number
totalLineAmount	number
companyId	string
ledgerAccountId	string
unitPrice	number
taxRate	string
allocations	list	item: object
id	string
type	string	Enum: invoice, order, expense, credit_memo, over_payment, pre…
amount	number
totalAmount	number
totalTax	number
totalDiscount	number
subTotal	number
balance	number
ledgerAccountId	string
issueDate	string	Format: date-time
paidOnDate	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Customers

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
code	string
description	string
firstName	string
lastName	string
companyName	string
companyId	string
status	any
currency	string
addresses	list	item: object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
phones	list	item: object
value	string
type	string
emails	list	item: object
value	string
type	string
websiteUrl	string
notes	string
tax_number	string
orderIds	list	item: string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Deal Products

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
quantity	number
price	number
dealId	string
productId	string
isActive	boolean
createdTime	string	Format: date-time
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Deals

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
amount	number
currency	string
companyId	string
contactId	string
campaignId	string
source	string
description	string
stage	string
stageId	string
status	string	Enum: open, won, lost
type	string
ownerId	string
probability	number
closeTime	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only
lastActivityTime	string	Format: date-time, Read Only

Deal Stages

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
state	string	Enum: open, won, lost

Documents

Fields Schema

Field	Type	Notes
id	string	Read Only
uri	string	Read Only
title	string
parentDocumentId	string
canHaveChildren	boolean	Read Only
isDownloadable	boolean	Default: true, Read Only
text	string
ownerId	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Drives

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
description	string
ownerId	string
uri	string	Read Only
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Drive Items

Fields Schema

Field	Type	Notes
id	string	Read Only
itemType	string	Enum: file, folder, Allow Custom: true
name	string
mimeType	string
description	string
previewUri	string	Read Only
size	integer	Read Only
path	string	Read Only
folderId	string
ownerId	string
driveId	string
downloadUri	string	Read Only
uri	string	Read Only
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Eeocs

Fields Schema

Field	Type	Notes
id	string
candidateId	string
race	string
gender	string
veteranStatus	string
disabilityStatus	string
submittedTime	string	Format: date-time, Read Only
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Emails

Fields Schema

Field	Type	Notes
id	string	Read Only
threadId	string	Read Only
to	list	item: string
cc	list	item: string
bcc	list	item: string
from	string
replyTo	string
subject	string
body	string
html_body	string
status	string
ownerId	string
contactId	string
leadId	string
companyId	string
dealId	string
attachments	list	item: object
id	string
type	string
name	string
url	string
content	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Employees

Fields Schema

Field	Type	Notes
id	string	Read Only
fullName	string
firstName	string
lastName	string
userName	string
preferredName	string
personalEmail	string
workEmail	string
mobileNumber	string
homeAddress	object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
workAddress	object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
employmentStatus	string	Enum: active, inactive, terminated, other
companyId	string
departmentId	string
startDate	string	Format: date-time
terminationDate	string	Format: date-time
gender	string	Enum: male, female, other, not_specified, Allow Custom: true
ethnicity	string
birthday	string	Format: date-time
photoUrl	string
timezone	string
title	string
employments	list	item: any
compensations	list	item: object
id	string
jobId	string
rate	number
paymentUnit	string
currency	string
paymentFrequency	string
flsaStatus	string
effectiveDate	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Files

Fields Schema

Field	Type	Notes
id	string	Read Only
mimeType	string
name	string
description	string
previewUri	string	Read Only
size	integer	Read Only
path	string	Read Only
folderId	string
ownerId	string
driveId	string
downloadUri	string	Read Only
uri	string	Read Only
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Folders

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
description	string
size	integer	Read Only
path	string	Read Only
parentFolderId	string
ownerId	string
driveId	string
downloadUri	string	Read Only
uri	string	Read Only
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Invoices

Fields Schema

Field	Type	Notes
id	string	Read Only
number	string
name	string
memo	string
status	string
paymentMethod	string
customerId	string
currency	string
payments	list	item: string
lineItems	list	item: object
id	string
itemName	string
description	string
code	string
type	string
status	string
companyId	string
ledgerAccountId	string
quantity	number
unitOfMeasure	string
unitPrice	number
purchasePrice	number
salesPrice	number
taxable	boolean
taxAmount	number
totalAmount	number
inventoryDate	string	Format: date-time
totalAmount	number
totalTax	number
exchangeRate	number
totalDiscount	number
subTotal	number
balance	number
ledgerAccountId	string
issueDate	string	Format: date-time
dueDate	string	Format: date-time
paidOnDate	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Job Applications

Fields Schema

Field	Type	Notes
id	string
candidateId	string
jobId	string
appliedAt	string	Format: date-time
status	string
currentStage	string
source	string
rejectedTime	string	Format: date-time
rejectionReason	string
creditedTo	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Job Candidates

Fields Schema

Field	Type	Notes
id	string
fullName	string
firstName	string
lastName	string
company	string
title	string
addresses	list	item: object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
phones	list	item: object
value	string
type	string
primaryEmail	string
primaryPhone	string
emails	list	item: object
value	string
type	string
urls	list	item: object
value	string
type	string
applicationIds	list	item: string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Job Interviews

Fields Schema

Field	Type	Notes
id	string
candidateId	string
organizerId	string
interviewerIds	list	item: string
stage	string
status	string
location	string
startTime	string	Format: date-time
endTime	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Job Offers

Fields Schema

Field	Type	Notes
id	string
jobApplicationId	string
status	string
sentTime	string	Format: date-time
closedTime	string	Format: date-time
startDate	string	Format: date
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Jobs

Fields Schema

Field	Type	Notes
id	string
name	string
description	string
code	string
status	string
isConfidential	boolean
hiringManagersIds	list	item: string
recruitersIds	list	item: string
departmentsIds	list	item: string
officesIds	list	item: string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Journal Entries

Fields Schema

Field	Type	Notes
id	string	Read Only
number	string
title	string
memo	string
currency	string
companyId	string
lineItems	list	item: object
id	string
description	string
type	string	Enum: debit, credit
amount	number
ledgerAccountId	string
companyId	string
contactId	string
exchangeRate	number
taxType	string
taxCode	string
ledgerAccountId	string
payments	list	item: string
transactionDate	string	Format: date-time
createdTime	string	Format: date-time, Read Only
updatedTime	string	Format: date-time, Read Only

Leads

Fields Schema

Field	Type	Notes
id	string	Read Only
fullName	string
firstName	string
lastName	string
primaryEmail	string
emails	list	item: object
value	string
type	string
primaryPhone	string
phones	list	item: object
value	string
type	string
primaryAddress	object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
addresses	list	item: object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
stage	string
value	number
companyName	string
companyId	string
ownerId	string
jobTitle	string
source	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only
lastActivityTime	string	Format: date-time, Read Only

Ledger Accounts

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
code	string
description	string
classification	string	Enum: Asset, Liability, Equity, Revenue, Expense
type	string
status	string	Enum: Active, Inactive, Archived
currentBalance	number
currency	string
taxRateId	string
companyId	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Meetings

Fields Schema

Field	Type	Notes
id	string	Read Only
title	string
description	string
durationSeconds	number
location	string
isRecurrent	boolean
participants	list	item: object
userId	string
contactId	string
leadId	string
status	string
companyId	string
dealId	string
ownerId	string
startTime	string	Format: date-time
endTime	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Messages

Fields Schema

Field	Type	Notes
id	string	Read Only
subject	string
channelId	string
threadId	string
text	string
ownerId	string
status	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Notes

Fields Schema

Field	Type	Notes
id	string	Read Only
title	string
content	string
status	string
ownerId	string
contactId	string
leadId	string
companyId	string
dealId	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Orders

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
notes	string
status	string	Enum: open, closed
customerId	string
currency	string
totalAmount	number
paymentMethod	string
paymentStatus	string
fullFillmentStatus	string
billingAddress	object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
shippingAddress	object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
lineItems	list	item: object
name	string
productId	string
sku	string
quantity	number
unitPrice	number
totalAmount	number
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Payments

Fields Schema

Field	Type	Notes
id	string	Read Only
status	string
type	string
notes	string
currency	string
exchangeRate	string
totalAmount	number
supplierId	string
customerId	string
ledgerAccountId	string
paymentMethod	string
transactionDate	string	Format: date-time
isReconciled	boolean
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Payrolls

Fields Schema

Field	Type	Notes
id	string	Read Only
employeeId	string
companyId	string
runState	string	Enum: PAID, DRAFT, APPROVED, CLOSED, Allow Custom: true
runType	string	Enum: REGULAR, OFF_CYCLE, UNSCHEDULED, CORRECTION, TERMINATI…, Allow Custom: true
isProcessed	boolean
processedTime	string	Format: date-time
checkTime	string	Format: date-time
startTime	string	Format: date-time
endTime	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Products

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
description	string
code	string
type	string
weight	number
isActive	boolean
price	number
status	string
options	list	item: object
id	string
name	string
values	list	item: string
variants	list	item: object
id	string
name	string
price	number
sku	string
weight	number
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Projects

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
description	string
type	string
parentId	string
ownerId	string
startTime	string	Format: date-time
dueTime	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Suppliers

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
code	string
description	string
firstName	string
lastName	string
companyName	string
companyId	string
status	string
currency	string
addresses	list	item: object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
phones	list	item: object
value	string
type	string
emails	list	item: object
value	string
type	string
websiteUrl	string
notes	string
taxNumber	string
orderIds	list	item: string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Tasks

Fields Schema

Field	Type	Notes
id	string	Read Only
subject	string
content	string
status	string
type	string
priority	string
ownerId	string
assigneeId	string
followerIds	list	item: string
parentTaskId	string
projectId	string
tags	list	item: string
contactId	string
leadId	string
companyId	string
dealId	string
dueTime	string	Format: date-time
startTime	string	Format: date-time
endTime	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Tax Rates

Fields Schema

Field	Type	Notes
id	string	Read Only
name	string
code	string
description	string
effectiveTaxRate	number
totalTaxRate	number
type	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Users

Fields Schema

Field	Type	Notes
id	string	Read Only
title	string
fullName	string
firstName	string
lastName	string
userName	string
primaryEmail	string
emails	list	item: object
value	string
type	string
primaryPhone	string
phones	list	item: object
value	string
type	string
primaryAddress	object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
addresses	list	item: object
type	string
full	string
street	string
city	string
state	string
country	string
zip	string
companyName	string
companyId	string
imageUrl	string
timezone	string
isActive	boolean
roleId	string
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Timeoff Balances

Fields Schema

Field	Type	Notes
id	string	Read Only
employeeId	string
balanceHours	number
usedHours	number
policyType	string	Enum: VACATION, SICK, PERSONAL, JURY_DUTY, VOLUNTEER, BEREAVE…, Allow Custom: true
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Timeoff Requests

Fields Schema

Field	Type	Notes
id	string	Read Only
employeeId	string
approverId	string
status	string	Enum: REQUESTED, APPROVED, DECLINED, CANCELLED, Allow Custom: true
employeeNote	string
units	string	Enum: DAYS, HOURS, Allow Custom: true
amount	number
requestType	string	Enum: VACATION, SICK, PERSONAL, JURY_DUTY, VOLUNTEER, BEREAVE…, Allow Custom: true
startTime	string	Format: date-time
endTime	string	Format: date-time
createdTime	string	Format: date-time, Read Only
createdBy	string	Read Only
updatedTime	string	Format: date-time, Read Only
updatedBy	string	Read Only

Tip:
Universal Data Models make it easy to build integrations that work across many apps, by providing a consistent schema for common business objects.
For more details on mapping and usage, see the Connector Builder documentation.

Getting Started

Ways to Use Membrane

How Membrane Works

Managing Membrane

References

​Activities

​Bills

​Campaign Members

​Campaigns

​Companies

​Contacts

​Contact Lists

​Credit Notes

​Customers

​Deal Products

​Deals

​Deal Stages

​Documents

​Drives

​Drive Items

​Eeocs

​Emails

​Employees

​Files

​Folders

​Invoices

​Job Applications

​Job Candidates

​Job Interviews

​Job Offers

​Jobs

​Journal Entries

​Leads

​Ledger Accounts

​Meetings

​Messages

​Notes

​Orders

​Payments

​Payrolls

​Products

​Projects

​Suppliers

​Tasks

​Tax Rates

​Users

​Timeoff Balances

​Timeoff Requests

Activities

Bills

Campaign Members

Campaigns

Companies

Contacts

Contact Lists

Credit Notes

Customers

Deal Products

Deals

Deal Stages

Documents

Drives

Drive Items

Eeocs

Emails

Employees

Files

Folders

Invoices

Job Applications

Job Candidates

Job Interviews

Job Offers

Jobs

Journal Entries

Leads

Ledger Accounts

Meetings

Messages

Notes

Orders

Payments

Payrolls

Products

Projects

Suppliers

Tasks

Tax Rates

Users

Timeoff Balances

Timeoff Requests