v1

latestOpenAPI 3.0.12026-07-248498266.5 KB

Statements

Retrieve Detailed Statement Version

Retrieve a specific, detailed version of a Statement.

This endpoint supports Sandbox Mode.

get/plug/statements/{statementId}/versions/{versionId}/details

Path parameters

statementIdstring required

versionIdstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

amountDuenumber nullable required

The monetary amount that is required to be paid.

amountDueAfterDueDatenumber nullable required

The total amount due for the account after the due date, excluding any late fees or penalties.

amountDueBeforeDueDatenumber nullable required

The total amount due for the account before the due date, excluding any late fees or penalties.

correlationIdsstring[] required

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

createdAtstring date-time nullable required

A timestamp indicating when the entity was created.

credentialIdsstring[] required

An unique identifier for a credential.

currencyCode'USD' | 'AUD' | 'CAD' | 'EUR' | 'GBP' | 'ZAR' | 'RON' | 'BRL' | 'DKK' | 'CHF' | 'MXN' | 'NZD' | 'NOK' | 'SEK' | 'CZK' | 'COP' | 'PLN' | 'ARS' | 'GTQ' | 'SGD' | 'TRY' | 'INR' | 'JPY' | 'HKD' | 'HUF' | 'AED' | 'MAD' | 'PHP' | 'IDR' | 'UYU' | 'CLP' | 'PEN' | 'MYR' | 'OMR' | 'BHD' | 'SAR' | 'GHS' | 'THB' | 'VND' | 'LKR' | 'KRW' | 'BAM' | 'BGN' | 'RSD' | 'TWD' | 'KES' | 'NGN' | 'ILS' | 'CNY' | 'CRC' | 'EUS' nullable required

The ISO 4217 currency code for charges. This list will grow as additional currencies are supported over time.

customerNumberstring nullable required

The bill contains a unique identifier for the customer associated with the account. This is not the account number

cycleNumberstring nullable required

The code or ID for a meter reading schedule.

dataIngestionMethod'BILL_UPLOAD' | 'UTILITY_WEBSITE_ACCESS' nullable required

Indicates the method you used to send data to us.

disconnectDatestring date nullable required

The date on which the service for the account was disconnected.

discountBeforeDueDatenumber nullable required

Any discounts applied to the account if the outstanding balance is paid before the due date.

discoveredAtstring date-time nullable required

Timestamp indicating when the statement data was discovered and added to the system.

discoveredStatementIdstring nullable required

The unique identifier for the discovered statement in the Arcadia platform.

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.

isFinalBillboolean required

Indicates whether the current bill is the final bill for the account.

isLatestVersionboolean required

Indicates if this is the latest/default version of the statement.

lastModifiedAtstring date-time nullable required

The timestamp indicating when this resource was last modified.

newChargesnumber nullable required

Any new charges applied to the account since the last billing cycle or statement.

normalizedSummaryAccountNumberstring nullable required

The normalized version of the Summary account number (removing things like hyphens, underscores, and leading zeros).

outstandingBalancenumber nullable required

The remaining balance yet to be paid for the account.

periodEndDatestring date nullable required

The end date of the measuring period.

periodStartDatestring date nullable required

The start date of the measuring period.

previousBalancenumber nullable required

The balance carried forward from the previous billing period.

previousStatementDatestring date nullable required

The date of the previous bill.

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 data format of the data extraction source we used.

statementDatestring date nullable required

The date of the statement.

summaryAccountIdstring nullable required

The unique identifier of the summary account.

summaryAccountNumberstring nullable required

The number or identifier assigned to the summary account by the provider.

totalChargesnumber nullable required

The total charges applied for a specific billing period.

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

Describes the source document.

versionIdstring required

The unique identifier for the statement version.