API Docs / Schemas / BooksContactDto

BooksContactDto

A contact held in a client's own books.

Properties

Name Type Description
idstring

The platform's identifier for the contact.

The platform's identifier for the contact.

namestring

The contact's display name.

The contact's display name.

firstNamestring
lastNamestring
emailstring
phoneNumberstring
isCustomerboolean

Whether the books treat this contact as someone the client sells to.

Whether the books treat this contact as someone the client sells to.

isSupplierboolean

Whether the books treat this contact as someone the client buys from.

Whether the books treat this contact as someone the client buys from.

isActiveboolean

Whether the contact is still active in the books.

Whether the contact is still active in the books.

outstandingBalancenumber

What the contact owes, where the platform reports it. Null means the platform does not
report a balance, not that nothing is owed.

What the contact owes, where the platform reports it. Null means the platform does not
report a balance, not that nothing is owed.

externalUrlstring

A link to the contact in the platform's own interface, where one can be built.

A link to the contact in the platform's own interface, where one can be built.

JSON Example

{
  "id": "string",
  "name": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string"
}

Contained in Schemas