Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Discovered Statements

Retrieve Discovered Statement

Retrieve a single discovered statement record.

This endpoint supports Sandbox Mode.

get/plug/discoveredStatements/{discoveredStatementId}

Path parameters

discoveredStatementIdstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

OK

accountIdsstring[] required

List of account IDs associated with the discovered statement.

accountNumbersstring[] required

An array of account identifiers provided by the commodity provider (often times the bill publisher).

correlationIdsstring[] required

A list of correlationIds cascaded from all directly associated Credentials and Files.

createdAtstring date-time required

A timestamp indicating when the entity was created.

credentialIdsstring[] required

List of credential IDs associated with the discovered statement.

dataIngestionMethod'BILL_UPLOAD' | 'UTILITY_WEBSITE_ACCESS' nullable required

Identifies the data ingestion method that created this Statement.

dueDatestring date nullable required

The due date for payment associated with the account.

idstring required

A unique identifier for the entity.

invoiceNumberstring nullable required

The unique identifier or number assigned to a specific invoice.

isLatestVersionboolean required

Indicates whether the Statement is the most recent versionId of the Statement.

periodEndDatestring date nullable required

The end date of the measuring period.

periodStartDatestring date nullable required

The start date of the measuring period.

sourceType'TAG_NAME' | 'UNCLASSIFIED' | 'HTML' | 'CSS' | 'PNG' | 'JPG' | 'GIF' | 'TIFF' | 'SVG' | 'WEBP' | 'ICO' | 'PDF' | 'JSON' | 'CSV' | 'XML' | 'XLS' | 'XLSX' | 'TXT' | 'ZIP' | 'MSOTF' | 'OTF' | 'SFNT' | 'TTF' | 'WOFF' | 'WOFF2' | 'FONT_WOFF' | 'FONT_WOFF2' | 'FONT_XWOFF' | 'FONT_TTF' | 'FONT_SFNT' | 'URJA_NODE_LIST' | 'URJA_NAV_HISTORY' | 'INSERT_BILL' | 'EDI' | 'X12' | 'EDIFACT' | 'TRADACOMS' | 'WOOT' nullable required

The format of the data extraction source we used.

statementDatestring date nullable required

The date of the discovered statement.

statementIdstring nullable required

The unique identifier of a statement.

statementType'BILL' | 'NOTICE' | 'ADJUSTMENT' | 'PREPAID' nullable required

Describes the source document.

status'EXTRACTION_PASSED_QUALITY_CHECKS' | 'EXTRACTION_FAILED_QUALITY_CHECKS' required

Status of the discovered statement.

versionIdstring required

A unique identifier for the version of the Discovered Statement entity at a given moment in time.