VRPlatformVRPlatform
TransactionsTemplates

/transactions/recurring-templates/{id}/run

Queue recurring transaction instances for up to 366 explicit dates or all due dates. Use dryRun for immediate no-write results.

Required scope: transactions:expenses:write

POST
/transactions/recurring-templates/{id}/run

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

dryRun?boolean

Validate this request through the real write path, then roll back all changes. See https://docs.vrplatform.app/api/dry-run-mode.

Request Body

application/json

dates*|null

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 POST "https://api.vrplatform.app/transactions/recurring-templates/497f6eca-6276-4993-bfeb-53cbbbba6f08/run" \  -H "Content-Type: application/json" \  -d '{    "dates": [      "string"    ]  }'
[
  {
    "description": "string",
    "status": "active",
    "uniqueRef": "string",
    "isOpeningBalance": true,
    "type": "deposit",
    "date": "string",
    "lines": [
      {
        "uniqueRef": "string",
        "description": "string",
        "assignment": "accountsPayable",
        "amount": -9007199254740991,
        "ownerStatementId": "eccddabd-554b-48ab-a66d-28a57ff66fa9",
        "matchReservationConfirmationCode": "string",
        "matchReservationStripeGuestRef": "string",
        "matchReservationProcessorBookingRef": "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",
          "email": "user@example.com",
          "type": "owner"
        },
        "matchStatus": "string",
        "appliedAmount": {
          "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"
              }
            ]
          }
        }
      }
    ],
    "attachmentIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "recurringTemplateId": "d73afa31-bf14-4baf-aede-be5f4b4ff489",
    "recreatedFromTransactionId": "000264af-6c3a-4ff1-8534-ade50aa8d7fb",
    "matchBankAccountLast4": "string",
    "id": "string",
    "shortRef": "string",
    "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": "line_unassignedAccount",
        "severity": "error",
        "context": {}
      }
    ],
    "currency": "string",
    "amount": -9007199254740991,
    "recurringTemplate": {
      "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
      }
    ],
    "account": {
      "id": "string",
      "name": "string",
      "uniqueRef": "string",
      "status": "active"
    },
    "payment": {
      "bankRecordIds": [
        "string"
      ],
      "status": "unpaid",
      "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"
            }
          ]
        }
      },
      "date": "string"
    },
    "connection": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "status": "active",
      "uniqueRef": "string",
      "appId": "string"
    },
    "contact": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "firstName": "string",
      "uniqueRef": "string",
      "shortRef": "string",
      "email": "user@example.com",
      "type": "owner"
    },
    "source": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "string",
      "status": "active",
      "appId": "string",
      "appIcon": "string"
    },
    "matchStatus": "string",
    "matchedByBankRule": true,
    "returnedFromTransactionId": "edd2bee8-c5f7-4ff5-ae8f-fd9c96d50204",
    "returnEffectiveAt": "2024-01-15T12:30:00.000+00:00",
    "returnSummary": {
      "status": "none",
      "returnedAmount": -9007199254740991,
      "remainingReturnableAmount": -9007199254740991,
      "compensationTransactionIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "replacementTransactionId": "a44b4466-2c16-4884-a7c2-efd209c901e2"
    }
  }
]
{
  "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": "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
}

/transactions/recurring-templates GET

Previous Page

/transactions/recurring-templates/preview POST

Next Page