VRPlatformVRPlatform
TransactionsTemplates

/transactions/recurring-templates/{id}

Recurring Transaction Template

GET
/transactions/recurring-templates/{id}
X-API-Key<token>

API key provided in dashboard

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://api.vrplatform.app/transactions/recurring-templates/string"
{
  "id": "string",
  "status": "active",
  "uniqueRef": "string",
  "description": "string",
  "date": "string",
  "currency": "string",
  "amount": 0,
  "pattern": {
    "frequency": "daily",
    "interval": 0,
    "weekDays": [
      0
    ],
    "monthDays": [
      0
    ],
    "months": [
      0
    ],
    "count": 0,
    "endDate": "string"
  },
  "paymentStatus": "unpaid",
  "patternFormatted": "string",
  "nextTransactionInstanceAt": "string",
  "instancesCount": 0,
  "account": {
    "id": "string",
    "name": "string",
    "uniqueRef": "string",
    "status": "active"
  },
  "contact": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "firstName": "string",
    "uniqueRef": "string",
    "shortRef": "string"
  },
  "lines": [
    {
      "uniqueRef": "string",
      "description": "string",
      "assignment": "accountsPayable",
      "amount": -9007199254740991,
      "ownerStatementId": "eccddabd-554b-48ab-a66d-28a57ff66fa9",
      "matchReservationConfirmationCode": "string",
      "matchReservationStripeGuestRef": "string",
      "matchLineTypeClassification": "string",
      "id": "string",
      "issues": [
        {
          "code": "unassignedAccount",
          "severity": "error",
          "context": {
            "lineType": "string"
          }
        }
      ],
      "recurringTemplate": {
        "id": "string"
      },
      "total": 0,
      "listing": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "uniqueRef": "string",
        "shortRef": "string"
      },
      "reservation": {
        "id": "string",
        "shortRef": "string",
        "confirmationCode": "string",
        "uniqueRef": "string",
        "status": "booked",
        "checkIn": "string",
        "checkOut": "string"
      },
      "account": {
        "id": "string",
        "name": "string",
        "uniqueRef": "string",
        "status": "active"
      },
      "party": "owners",
      "contact": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "name": "string",
        "firstName": "string",
        "uniqueRef": "string",
        "shortRef": "string"
      },
      "matchStatus": "string",
      "appliedAmount": {
        "taxBehavior": "excluded",
        "taxRate": {
          "id": "string",
          "name": "string",
          "basisPoints": 100000
        }
      },
      "markup": {
        "amount": -9007199254740991,
        "taxBehavior": "excluded",
        "taxRate": {
          "id": "string",
          "name": "string",
          "basisPoints": 100000
        }
      },
      "lock": {
        "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"
            }
          ]
        }
      }
    }
  ],
  "issues": [
    {
      "code": "missingInstances",
      "severity": "warning",
      "context": {
        "dates": [
          "string"
        ]
      }
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}
{
  "code": "string",
  "message": "string",
  "issues": [
    {
      "message": "string"
    }
  ],
  "context": null
}