VRPlatformVRPlatform
Csv

/csv-imports/{id}/records

List records from a completed or failed CSV import.

Required scope: integrations:import

GET
/csv-imports/{id}/records

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Query Parameters

cursor?string

Opaque pagination cursor returned by a previous response. Pass it back unchanged.

Formatvrp-opaque-cursor
issueCode?string
Value in"accountNotFound" | "ambiguousAccount" | "ambiguousBankAccount" | "ambiguousContact" | "ambiguousExpenseAccount" | "ambiguousListing" | "ambiguousMarkupTax" | "ambiguousOwner" | "ambiguousPayoutAccount" | "ambiguousReservation" | "ambiguousVendor" | "bankAccountNotFound" | "beforeBankRecordStartDate" | "bookingPayoutAmountInvalid" | "booksClosed" | "companyDetailsRequired" | "contactConnectionConflict" | "contactNotFound" | "currencyRequired" | "depositAlreadyExists" | "depositAmountRequired" | "duplicateBankRecordReference" | "duplicateOwnerListing" | "duplicateVendor" | "existingOwnership" | "expenseAlreadyExists" | "expenseAccountNotFound" | "inconsistentDepositField" | "inconsistentExpenseField" | "invalidAmount" | "invalidCountry" | "invalidEmail" | "invalidField" | "invalidMarkup" | "invalidOwnerKind" | "invalidState" | "invalidVendorKind" | "listingNotFound" | "mappingRequired" | "markupTaxNotFound" | "nonContiguousLogicalRecord" | "ownerBillingListingRequired" | "ownerIdentityRequired" | "ownerNameRequired" | "payoutAccountNotFound" | "possibleDuplicate" | "referenceRequired" | "requiredValueMissing" | "reservationListingMismatch" | "reservationNotFound" | "resourceValidationFailed" | "stripePayoutNetMismatch" | "stripePayoutRowInvalid" | "transactionValidation" | "unmappedBoolean" | "vendorIdentityRequired" | "vendorNameRequired" | "vendorNotFound"
limit?integer
Default100
Range1 <= value <= 250
state?string|string
Default"all"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/csv-imports/497f6eca-6276-4993-bfeb-53cbbbba6f08/records"
{
  "data": [
    {
      "recordRef": "string",
      "rowNumbers": [
        1
      ],
      "state": "created",
      "entityIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "issues": [
        {
          "code": "accountNotFound",
          "field": "string",
          "rowNumber": 1,
          "message": "string",
          "details": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "duplicateReview": {
        "matchBasis": [
          "accountId",
          "date",
          "amount"
        ],
        "candidates": [
          {
            "source": "csvImport",
            "bankRecordId": "e894441d-c102-49bb-bb73-226e8914f1d6",
            "date": "string",
            "amount": -9007199254740991,
            "description": "string"
          }
        ],
        "candidateCount": 9007199254740991,
        "candidatesTruncated": true
      }
    }
  ],
  "nextCursor": "string"
}
{
  "code": "BAD_REQUEST",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "reason": "importOutcomeCursorInvalid"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "NOT_FOUND",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "reason": "importNotFound"
  }
}
{
  "code": "CONFLICT",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "reason": "importOutcomesUnavailable"
  }
}
{
  "code": "GONE",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "reason": "importOutcomesExpired"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "MISDIRECTED_REQUEST",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": {
    "teamId": "a4ede8ba-7c0a-4485-8763-cbd9b282fbec",
    "dataRegion": "ap",
    "apiBaseUrl": "http://example.com"
  }
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "LOCKED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}
{
  "code": "AUDIT_CURSOR_EXPIRED",
  "message": "string",
  "links": {
    "docs": "string",
    "schema": "string"
  },
  "issues": [
    {
      "message": "string",
      "path": [
        "string"
      ],
      "schema": "string"
    }
  ],
  "retryable": true,
  "context": null
}

/connections/{id} PUT

Previous Page

/csv-imports/{id} GET

Next Page