CompanyDetailsModel

Contains company details data

Methods

The following API methods use this data model.

Required Fields

groupKey

uuid

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.

customerId

uuid

The unique ID of this company

contactId

uuid

Company primary contact id

Optional Fields

name

string, nullable

The unique ID of this company

address1

string, nullable

Company address info

address2

string, nullable

Company address info

address3

string, nullable

Company address info

city

string, nullable

Company address info

state

string, nullable

Company address info

postalCode

string, nullable

Company address info

country

string, nullable

Company address country

phoneNumber

string, nullable

Company phone number

faxNumber

string, nullable

Company fax number

email

string, nullable

Company email address

contactName

string, nullable

Company primary contact name

contactEmail

string, nullable

Company primary contact email address

Deprecated Fields

Deprecated fields are maintained for backwards compatibility with previous versions of the API. Deprecated fields may be removed in a future release of the API.

outstandingInvoices

int32

Company number of outstanding invoices

groupBaseCurrencyCode

string, nullable

The group's base currency code.

outstandingAmount

double

Company total outstanding invoice amount in the group's base currency.

amountPastDue

double

Company total past due amount in the group's base currency.

payments

CompanyDetailsPaymentModel[], nullable

Company payments collected