Import APIs

Post /api/v3/import/bill

Operation: BillImportV3 Permissions: BillsAndBatches (Create)

This endpoint allows the import of an EnergyCAP Advanced or a profile mapped file. The file can be comma separated file (CSV/DAT/TXT) or EXCEL (XLSX) or a collection of files (ZIP). The file should be base64 encoded with a UTF8 character set.

---

Post /api/v3/import/reading

Operation: ReadingImportV3 Permissions: IntervalData (Manage)

This endpoint allows the import of a channel reading (“interval”) data import file. The file should be a base64-encoded delimited text file with a UTF8 character set.

---

Post /api/v3/import/reading/profile

Operation: CreateReadingImportProfileV3 Permissions: IntervalData (Manage)

Creates an interval data import profile

---

Get /api/v3/import/reading/profile

Operation: GetReadingImportProfilesV3 Permissions: IntervalData (Manage)

Returns all Reading Import profiles

---

Get /api/v3/import/reading/profile/{profileId}

Operation: GetReadingImportProfileV3 Permissions: IntervalData (Manage)

Returns one reading import profile

---

Put /api/v3/import/reading/profile/{profileId}

Operation: EditReadingImportProfileV3 Permissions: IntervalData (Manage)

Edits an interval data import profile

---

Delete /api/v3/import/reading/profile/{profileId}

Operation: DeleteReadingImportProfileV3 Permissions: IntervalData (Manage)

Deletes a reading import profile

---

Get /api/v3/import/bill/profile

Operation: GetBillImportProfilesV3 Permissions: BillsAndBatches (Create)

Get all bill import profiles

---

Post /api/v3/import/bill/profile

Operation: WriteBillImportProfileV3 Permissions: BillsAndBatches (Create)

Creates a bill import profile

---

Get /api/v3/import/bill/profile/{profileId}

Operation: GetBillImportProfileV3 Permissions: BillsAndBatches (Create)

Get a bill import profile

---

Delete /api/v3/import/bill/profile/{profileId}

Operation: DeleteBillImportProfileV3 Permissions: BillsAndBatches (Create)

Deletes a bill import profile

---

Put /api/v3/import/bill/profile/{profileId}

Operation: EditBillImportProfileV3 Permissions: BillsAndBatches (Create)

Edit a bill import profile

---

Get /api/v202407/import/esareading/profile

Operation: GetEsaReadingImportProfilesV202407 Permissions: Meters (View)

Get all ESA reading import profiles

---

Post /api/v202407/import/esareading/profile

Operation: CreateEsaReadingImportProfileV202407 Permissions: Meters (Create)

Creates an ESA reading import profile

---

Get /api/v202407/import/esareading/profile/{profileId}

Operation: GetEsaReadingImportProfileV202407 Permissions: Meters (View)

Gets an ESA reading import profile

---

Put /api/v202407/import/esareading/profile/{profileId}

Operation: EditEsaReadingImportProfileV202407 Permissions: Meters (Edit)

Edits an ESA reading import profile

---

Delete /api/v202407/import/esareading/profile/{profileId}

Operation: DeleteEsaReadingImportProfileV202407 Permissions: Meters (Delete)

Deletes an ESA reading import profile

---

Post /api/v202407/import/esareading

Operation: ImportEsaReadingWithProfileV202407 Permissions: Meters (Create)

This endpoint allows the import of an ESA reading import file.
The file should be a base64-encoded file with a UTF8 character set.

---

Get /api/v202403/import/record/profile

Operation: GetRecordImportProfilesV202403 Permissions: Records (View)

Get all emission record import profiles

---

Post /api/v202403/import/record/profile

Operation: CreateRecordImportProfileV202403 Permissions: Records (Create)

Creates an emission record import profile

---

Get /api/v202403/import/record/profile/{profileId}

Operation: GetRecordImportProfileV202403 Permissions: Records (View)

Get an emission record import profile

---

Put /api/v202403/import/record/profile/{profileId}

Operation: EditRecordImportProfileV202403 Permissions: Records (Create)

Edits an emission record import profile

---

Delete /api/v202403/import/record/profile/{profileId}

Operation: DeleteRecordImportProfileV202403 Permissions: Records (Create)

Deletes an emission record import profile

---

Post /api/v202403/import/record

Operation: ImportEmissionRecordsWithProfileV202403 Permissions: Records (Create)

This endpoint allows the import of a emission records import file.
The file should be a base64-encoded delimited text file with a UTF8 character set.

---

Post /api/v202401/import/bill/task/{taskGuid}/kickout

Operation: ImportBillImportTaskKickoutsV202401 Permissions: BillsAndBatches (Create)

This endpoint allows the reimport of an EnergyCAP.
All kickout files generated from the import will be zipped and reimported as a single task.

---

Get /api/v202401/import/bill/task/{taskGuid}/kickout/summary

Operation: GetTaskKickoutSummaryV202401 Permissions: BillsAndBatches (View)

Retrieves a list of kickout messages associated with a specified bill import task

---

Get /api/v202401/import/bill/task/{taskGuid}/kickout/{filename}/summary

Operation: GetTaskKickoutSummaryByFileV202401 Permissions: BillsAndBatches (View)

Retrieves a list of kickout messages associated with a specified bill import task and file.

---

Get /api/v202401/import/bill/task/{taskGuid}/kickout/detail

Operation: GetBillImportKickoutDetailsV202401 Permissions: BillsAndBatches (View)

Retrieves the kickout details associated with a specified bill import task and an optional kickout message.

---

Get /api/v202401/import/bill/task/{taskGuid}/kickout/{filename}/detail

Operation: GetBillImportKickoutDetailsByFileV202401 Permissions: BillsAndBatches (View)

Retrieves the kickout details associated with a specified bill import task, file and an optional kickout message.

---