API Docs / Schemas / ServiceImportPreviewDto

ServiceImportPreviewDto

Preview of what a service CSV import will do, returned before the user confirms.

Properties

Name Type Description
asyncJobCodestring

Job code to pass to the confirm endpoint to execute the import

Job code to pass to the confirm endpoint to execute the import

fileNamestring

Original filename

Original filename

clientsarray of ServiceImportPreviewClientDto

Per-client breakdown of what will happen

Per-client breakdown of what will happen

totalClientsinteger

Total number of client rows in the CSV

Total number of client rows in the CSV

clientsFoundinteger

Number of clients matched to existing clients

Number of clients matched to existing clients

clientsNotFoundinteger

Number of client rows where no matching client was found

Number of client rows where no matching client was found

servicesToCreateinteger

Number of new service assignments that will be created

Number of new service assignments that will be created

servicesToUpdateinteger

Number of existing service assignments that will be updated (values differ)

Number of existing service assignments that will be updated (values differ)

servicesUnchangedinteger

Number of existing service assignments that are unchanged and will be skipped

Number of existing service assignments that are unchanged and will be skipped

JSON Example

{
  "asyncJobCode": "string",
  "fileName": "string",
  "clients": [
    {
      "client": "...",
      "csvClientName": "...",
      "error": "...",
      "services": "..."
    }
  ],
  "totalClients": 0,
  "clientsFound": 0
}

Used By Operations