Team Setup

Use provider API key auth on all routes in this page. These setup routes do not use x-team-id.

List Teams

curl 'https://api.edge.vrplatform.app/teams' \
  -H 'x-api-key: <provider-api-key>'

Use this when you need to discover the team id that already exists for a customer.

Get One Team

curl 'https://api.edge.vrplatform.app/teams/<team-id>' \
  -H 'x-api-key: <provider-api-key>'

Useful fields in the response:

• id
• name
• status
• type
• partner
• isGeneralLedger
• booksClosedAt
• extractableConnections

Create Team

curl -X POST 'https://api.edge.vrplatform.app/teams' \
  -H 'x-api-key: <provider-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Example Team",
    "email": "team@example.com",
    "generalLedger": false,
    "ownerPortalShowDraftStatements": false
  }'

Required fields:

• name
• email
• generalLedger

Common optional fields:

• partnerId
• billingPartnerId
• statementAddress
• billingAddress
• ownerPortalShowDraftStatements
• addMembers

Behavior:

• if partnerId is omitted, VRPlatform uses the authenticated key tenant
• if generalLedger is false, the team is created without GL initialization
• if generalLedger is true or an object, VRPlatform queues GL init during create

Initialize General Ledger Later

Use PATCH /teams/{id}/init only when the team already exists and still needs initialization, or when you want to send a specific init payload.

curl -X PATCH 'https://api.edge.vrplatform.app/teams/<team-id>/init' \
  -H 'x-api-key: <provider-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{
    "copyFromTeamId": "11111111-1111-4111-8111-111111111111",
    "include": ["accounts", "taxRates", "lineMappings"]
  }'

Body fields:

• copyFromTeamId
• copyLineMappingsFromPartnerId
• taxRateCountryOverwrite
• include

Supported include values:

• statementLayouts
• recurringFees
• accounts
• taxRates
• lineMappings

Next Step

Once you have the managed team id, continue with Connection Creation.