CompanyMagicLinkSummaryModel
A summary of companies combined with their most recent magic links
Methods
The following API methods use this data model.
Required Fields
companyId
The unique id for this company
companyName
string, 0-100 characters
The short name of the company.
groupKey
The GroupKey uniquely identifies a single Lockstep Platform account. All records for this
account will share the same GroupKey value. GroupKey values cannot be changed once created.
For more information, see Accounts and GroupKeys.
outstandingAmount
The total outstanding amount for this company
totalOpenInvoices
The total number of open invoices for this company
pastDue
The total number of invoices that are past due for this company
totalVisits
Total number of visits for all magic links sent for this company
linksSent
Total number of sent links for this company
Optional Fields
companyType
string, nullable, 0-20 characters
This field indicates the type of company. It can be one of a limited number of values:
Company, Customer, Group, Vendor, or Third Party. A company that represents both a customer and a vendor
is identified as a CustomerVendor.
Company
- This record represents a company that is part of the organization of the account holder.Customer
- This record represents a business entity that purchases things from the account holder.Group
- Only one record of typeGROUP
exists in each account. Contains your account profile.Vendor
- This record represents a business entity that sells things to the account holder.Third Party
- This record represents a business entity that is neither a customer nor vendor.CustomerVendor
- Both a customer and a vendor.CompanyProfile
- Profile for a Company, each Company should have at most 1 profile, used only for Profile Management.
primaryContactName
string, nullable
The name of the primary contact for this company
primaryContactEmailAddress
string, nullable
The email of the primary contact for this company
pointOfContact
string, nullable
The point of contact for this company
latestMagicLinkDate
date-time, nullable
Created date of the most recent magic link made for this company
latestMagicLinkId
uuid, nullable
Id of the most recent magic link made for this company
latestMagicLinkStatus
MagicLinkStatus, nullable
Status of the most recent magic link made for this company
Updated 20 days ago