API Docs / Schemas / ImportJobClientDto

ImportJobClientDto

The outcome of a single client within an import job, including why it failed

Properties

Name Type Description
externalIdstring

The client ID from the external system (e.g., Xero contact ID)

The client ID from the external system (e.g., Xero contact ID)

namestring

The client's name on the external platform. Null when the platform never returned the
client - fall back to the external ID for display.

The client's name on the external platform. Null when the platform never returned the
client - fall back to the external ID for display.

statusenum

Pending InProgress Completed Failed Skipped

Pending InProgress Completed Failed Skipped

errorMessagestring

Why this client failed to import. Null for any status other than Failed.

Why this client failed to import. Null for any status other than Failed.

processedDatestring

When this client was processed

When this client was processed

JSON Example

{
  "externalId": "string",
  "name": "string",
  "status": "Pending",
  "errorMessage": "string",
  "processedDate": "2024-01-01T00:00:00Z"
}

Contained in Schemas