VRPlatformVRPlatform
Statements

/statements/{id}

Get owner statement detail, including live journal freshness and operation metadata.

Required scope: statements:read

GET
/statements/{id}

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

viewAs?string
Default"manager"
Value in"owner" | "manager"

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

curl -X GET "https://api.vrplatform.app/statements/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "string",
  "total": -9007199254740991,
  "financials": {
    "balanceStart": -9007199254740991,
    "netRevenue": -9007199254740991,
    "expenses": -9007199254740991,
    "reserve": -9007199254740991,
    "netIncome": -9007199254740991,
    "payouts": -9007199254740991,
    "balanceEnd": -9007199254740991
  },
  "summary": [
    {
      "name": "string",
      "text": "string",
      "value": 0,
      "separated": true
    }
  ],
  "payment": {
    "expected": -9007199254740991,
    "received": -9007199254740991,
    "status": "unpaid"
  },
  "uniqueRef": "string",
  "currency": "string",
  "startAt": "string",
  "endAt": "string",
  "issues": [
    {
      "code": "emptyJournalEntryAccountIds",
      "severity": "error",
      "context": {
        "affected": 0
      },
      "message": "string"
    }
  ],
  "drilldown": {
    "type": "journalEntryReport",
    "filter": {
      "ids": "string",
      "txnCode": "string",
      "published": true,
      "status": "active",
      "ledger": "historical",
      "startAt": "string",
      "endAt": "string",
      "search": "string",
      "date": "string",
      "amount": "string",
      "isDateRangeEndInclusive": true,
      "reservationIds": "string",
      "transactionIds": "string",
      "ownerStatementIds": "string",
      "currency": "string",
      "excludeApAppendix": true,
      "listingIds": "string",
      "listingScope": "exact",
      "listingOwnershipPeriodIds": "string",
      "accountIds": "string",
      "accountReservationLineTypeIds": "string",
      "categoryIds": "string",
      "excludeCategoryIds": "string",
      "contactIds": "string",
      "classifications": "string",
      "accountType": "ledger",
      "types": "string",
      "excludeTypes": "string",
      "entityTypes": "string",
      "bookingChannels": "string",
      "triggerTypes": "string",
      "excludeTriggerTypes": "string",
      "parties": "string",
      "party": "owners",
      "accountAssignmentTypes": "string",
      "managerStatementSectionIds": "string",
      "recurringFee": true,
      "openingBalanceType": "taxPayable"
    },
    "measure": "periodActivity",
    "label": "string"
  },
  "payouts": [
    {
      "id": "string",
      "lineId": "string",
      "description": "string",
      "descriptionLock": {
        "status": "locked",
        "booksClosed": {
          "date": "string"
        },
        "ownerStatement": {
          "ids": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ]
        },
        "reconciled": {
          "bankRecordIds": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ]
        },
        "statementPeriod": {
          "hits": [
            {
              "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
              "txnAt": "string",
              "openFrom": "string"
            }
          ]
        }
      },
      "date": "string",
      "total": 0,
      "totalFormatted": "string",
      "providerPayment": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "provider": "ramp",
        "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",
        "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
        "syncId": "24d9ea7f-fdab-4f53-95fd-4deda2362964",
        "status": "requested",
        "providerStatus": "string",
        "providerTransferId": "string",
        "providerTransferStatus": "string",
        "externalRef": "string",
        "paymentReference": "string",
        "paymentMethod": "string",
        "destinationAccountLast4": "stri",
        "requestedArrivalDate": "string",
        "scheduledInitiationAt": "2024-01-15T12:30:00.000+00:00",
        "initiatedAt": "2024-01-15T12:30:00.000+00:00",
        "completedAt": "2024-01-15T12:30:00.000+00:00",
        "billArchivedAt": "2024-01-15T12:30:00.000+00:00",
        "failureReason": "string",
        "attemptId": "string",
        "attempt": 9007199254740991,
        "createdAt": "2024-01-15T12:30:00.000+00:00",
        "updatedAt": "2024-01-15T12:30:00.000+00:00"
      }
    }
  ],
  "source": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": "string",
    "status": "active",
    "appId": "string",
    "appIcon": "string"
  },
  "listing": {
    "id": "string",
    "name": "string",
    "uniqueRef": "string",
    "childCount": 9007199254740991
  },
  "status": "draft",
  "ownership": {
    "id": "string",
    "startAt": "string",
    "endAt": "string",
    "reserve": -9007199254740991,
    "members": [
      {
        "id": "string",
        "ownerId": "string",
        "contactId": "string",
        "contact": {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "firstName": "string",
          "uniqueRef": "string",
          "shortRef": "string",
          "email": "user@example.com",
          "type": "owner"
        },
        "split": 0
      }
    ]
  },
  "layout": {
    "name": "string",
    "summaryType": "default",
    "isDefault": true,
    "showTeamEmail": true,
    "netRevenueSections": [
      {
        "id": "string",
        "name": "string",
        "locked": true,
        "visible": "all",
        "aggregate": true,
        "columns": [
          {
            "id": "string",
            "name": "string",
            "locked": true,
            "visible": "all",
            "type": "field",
            "value": "string"
          }
        ]
      }
    ],
    "otherSections": [
      {
        "id": "string",
        "name": "string",
        "locked": true,
        "visible": "all",
        "columns": [
          {
            "id": "string",
            "name": "string",
            "locked": true,
            "visible": "all",
            "type": "field",
            "value": "string"
          }
        ]
      }
    ],
    "id": "string",
    "version": -9007199254740991,
    "activeListings": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "linkedAccounts": [
      {
        "id": "string",
        "name": "string",
        "uniqueRef": "string",
        "status": "active"
      }
    ],
    "createdAt": "2024-01-15T12:30:00.000+00:00",
    "systemSections": [
      {
        "id": "string",
        "name": "string",
        "locked": true,
        "visible": "all",
        "columns": [
          {
            "id": "string",
            "name": "string",
            "locked": true,
            "visible": "all",
            "type": "field",
            "value": "string"
          }
        ]
      }
    ]
  },
  "rows": [
    {
      "id": "string",
      "total": -9007199254740991,
      "section": "string",
      "sourceListing": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "uniqueRef": "string",
        "shortRef": "string"
      },
      "issues": [
        {
          "code": "previousPeriodJournalEntries",
          "severity": "warning",
          "context": {
            "affected": 0
          },
          "message": "string"
        }
      ],
      "descriptionEdit": {
        "status": "editable",
        "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
        "lineId": "e698cdee-c4ef-4d12-b0ea-7c98b2fc64a8",
        "reason": "notEditable"
      },
      "columns": [
        {
          "name": "string",
          "text": "string",
          "type": "string",
          "value": 0,
          "accountIds": [
            "string"
          ],
          "drilldown": {
            "type": "journalEntryReport",
            "filter": {
              "ids": "string",
              "txnCode": "string",
              "published": true,
              "status": "active",
              "ledger": "historical",
              "startAt": "string",
              "endAt": "string",
              "search": "string",
              "date": "string",
              "amount": "string",
              "isDateRangeEndInclusive": true,
              "reservationIds": "string",
              "transactionIds": "string",
              "ownerStatementIds": "string",
              "currency": "string",
              "excludeApAppendix": true,
              "listingIds": "string",
              "listingScope": "exact",
              "listingOwnershipPeriodIds": "string",
              "accountIds": "string",
              "accountReservationLineTypeIds": "string",
              "categoryIds": "string",
              "excludeCategoryIds": "string",
              "contactIds": "string",
              "classifications": "string",
              "accountType": "ledger",
              "types": "string",
              "excludeTypes": "string",
              "entityTypes": "string",
              "bookingChannels": "string",
              "triggerTypes": "string",
              "excludeTriggerTypes": "string",
              "parties": "string",
              "party": "owners",
              "accountAssignmentTypes": "string",
              "managerStatementSectionIds": "string",
              "recurringFee": true,
              "openingBalanceType": "taxPayable"
            },
            "measure": "periodActivity",
            "label": "string"
          },
          "props": {
            "property1": null,
            "property2": null
          }
        }
      ],
      "drilldown": {
        "type": "journalEntryReport",
        "filter": {
          "ids": "string",
          "txnCode": "string",
          "published": true,
          "status": "active",
          "ledger": "historical",
          "startAt": "string",
          "endAt": "string",
          "search": "string",
          "date": "string",
          "amount": "string",
          "isDateRangeEndInclusive": true,
          "reservationIds": "string",
          "transactionIds": "string",
          "ownerStatementIds": "string",
          "currency": "string",
          "excludeApAppendix": true,
          "listingIds": "string",
          "listingScope": "exact",
          "listingOwnershipPeriodIds": "string",
          "accountIds": "string",
          "accountReservationLineTypeIds": "string",
          "categoryIds": "string",
          "excludeCategoryIds": "string",
          "contactIds": "string",
          "classifications": "string",
          "accountType": "ledger",
          "types": "string",
          "excludeTypes": "string",
          "entityTypes": "string",
          "bookingChannels": "string",
          "triggerTypes": "string",
          "excludeTriggerTypes": "string",
          "parties": "string",
          "party": "owners",
          "accountAssignmentTypes": "string",
          "managerStatementSectionIds": "string",
          "recurringFee": true,
          "openingBalanceType": "taxPayable"
        },
        "measure": "periodActivity",
        "label": "string"
      },
      "type": "transaction",
      "source": {
        "id": "string",
        "type": "deposit",
        "description": "string",
        "lines": [
          {
            "id": "string",
            "description": "string",
            "descriptionLock": {
              "status": "locked",
              "booksClosed": {
                "date": "string"
              },
              "ownerStatement": {
                "ids": [
                  "497f6eca-6276-4993-bfeb-53cbbbba6f08"
                ]
              },
              "reconciled": {
                "bankRecordIds": [
                  "497f6eca-6276-4993-bfeb-53cbbbba6f08"
                ]
              },
              "statementPeriod": {
                "hits": [
                  {
                    "listingId": "8c73d933-f7ed-437e-9da1-caac95adc1ae",
                    "txnAt": "string",
                    "openFrom": "string"
                  }
                ]
              }
            }
          }
        ],
        "recurringFee": {
          "id": "string"
        }
      }
    }
  ],
  "attachments": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
      "createdAt": "2024-01-15T12:30:00.000+00:00",
      "filename": "string",
      "extension": "string",
      "contentType": "string",
      "byteSize": -9007199254740991,
      "isOwnerAccessible": true
    }
  ],
  "journalStatus": {
    "state": "current",
    "reason": "journalLocked",
    "staleSince": "2024-01-15T12:30:00.000+00:00",
    "calculatedAt": "2024-01-15T12:30:00.000+00:00"
  },
  "operations": {
    "counts": {
      "total": 9007199254740991,
      "queued": 9007199254740991,
      "running": 9007199254740991,
      "completed": 9007199254740991,
      "failed": 9007199254740991
    },
    "items": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "type": "ach-verification",
        "status": "queued",
        "resource": {
          "type": "bank-rule",
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "role": "source",
          "url": "http://example.com"
        },
        "failure": {
          "code": "csvBlankHeader",
          "message": "CSV contains a blank header"
        },
        "initiator": {
          "type": "user",
          "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
        },
        "createdAt": "2024-01-15T12:30:00.000+00:00",
        "startedAt": "2024-01-15T12:30:00.000+00:00",
        "finishedAt": "2024-01-15T12:30:00.000+00:00"
      }
    ]
  }
}
{
  "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": "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": "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": "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": "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
}

/statements/{id} DELETE

Previous Page

/statements/by-period/csv GET

Next Page