API Docs / Schemas / ContactImportRowDto

ContactImportRowDto

One data row of a subcontractor import CSV as the analysis sees it: the contact it would become, or why it is skipped.

Properties

Name Type Description
rowId*string

The row's id (row-{n}, n the 1-based data row; the header is row 0), passed back in the import's selections

The row's id (row-{n}, n the 1-based data row; the header is row 0), passed back in the import's selections

name*string

The name the row gives the contact (the trading name, else first and last name), as written in the file

The name the row gives the contact (the trading name, else first and last name), as written in the file

subcontractorTypeenum

The subcontractor type (SoleTrader when the file leaves it blank); null when the row carries no CIS details

SoleTrader Partnership Company Trust

The subcontractor type (SoleTrader when the file leaves it blank); null when the row carries no CIS details

SoleTrader Partnership Company Trust

utrstring

The UTR

The UTR

emailAddressstring

The email address

The email address

isVatRegistered*boolean

Whether the contact is VAT registered

Whether the contact is VAT registered

verificationNumberstring

The HMRC verification number the row carries; the import records it as a manual verification

The HMRC verification number the row carries; the import records it as a manual verification

taxStatusenum

The tax status of that verification

NetOfHigherDeduction NetOfStandardDeduction Gross

The tax status of that verification

NetOfHigherDeduction NetOfStandardDeduction Gross

externalIdstring

The external id

The external id

skipReasonstring

Why the row cannot be imported; null when it can

Why the row cannot be imported; null when it can

defaultSelected*boolean

Whether a client should pre-select the row (true when it has no skip reason)

Whether a client should pre-select the row (true when it has no skip reason)

JSON Example

{
  "rowId": "string",
  "name": "string",
  "subcontractorType": "SoleTrader",
  "utr": "string",
  "emailAddress": "string",
  "isVatRegistered": false,
  "defaultSelected": false
}