Files

Update File

To update a file, make a PATCH call to the files endpoint with a specific fileId. Currently only correlationId can be updated.

patch/plug/files/{fileId}

Request

  • Base URL: https://api.arcadia.com
  • URL: https://api.arcadia.com/plug/files/{fileId}
  • Auth: OAuth 2 (client credentials, token URL /oauth2/token)

Path parameters

fileIdstring required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

correlationIdstring

A string value you can set to help you reconcile with your internal systems.

Response

OK

accountNumbersstring[] required

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

correlationIdstring nullable required

A string value you can set to help you reconcile with your internal systems.

createdAtstring date-time required

A timestamp indicating when the entity was created.

createdBystring required

User or system responsible for creating the entity.

discoveredStatementIdstring nullable required

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

fileNamestring required

The name of the file when it was originally submitted.

idstring required

A unique identifier for the entity.

isCustomerActionRequiredboolean required

Indicates whether any action is required from you regarding this resource.

lastModifiedAtstring date-time required

The timestamp indicating when this resource was last modified.

statementDatestring date nullable required

The date of the statement.

statementIdstring nullable required

The unique identifier of a statement.

status'QUEUED' | 'FAILURE' | 'IN_PROGRESS' | 'COVERAGE_REQUEST' | 'SUCCESS' required

Status of the resource.

statusDetailsstring[] required

Reasons the resource has the current status.

transferMethod'CLIENT' | 'API' | 'EMAIL' | 'SFTP' | 'WEB_NAVIGATION_OCR' required

Indicates the method you used to send data to us.

Changes

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