Statements

Retrieve Statement Version

Retrieve a specific version of a Statement.

This endpoint supports Sandbox Mode.

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

Request

  • Base URL: https://api.arcadia.com
  • URL: https://api.arcadia.com/plug/statements/{statementId}/versions/{versionId}
  • Auth: OAuth 2 (client credentials, token URL /oauth2/token)

Path parameters

statementIdstring required
versionIdstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

OK

amountDuenumber nullable required

The monetary amount that is required to be paid.

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.

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.

dataIngestionMethod'BILL_UPLOAD' | 'UTILITY_WEBSITE_ACCESS' nullable required

Identifies the data ingestion method that created this Statement.

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.

isLatestVersionboolean required

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

lastModifiedAtstring date-time nullable required

The timestamp indicating when this resource was last modified.

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.

statementDatestring date nullable required

The date of the statement.

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' required

Describes the source document.

versionIdstring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.