{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"API Versions Breaking Changes","siteUrl":"https://docs.peachfinance.com","description":"API and product documentation for Peach Finance, a lending-as-a-service platform."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"api-versions-breaking-changes","__idx":0},"children":["API Versions Breaking Changes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is a list of breaking changes and the API version in which they were introduced."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2026-08-04-beta","__idx":1},"children":["2026-08-04 (Beta)"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Added ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateToCheckToKeepGrace"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateToCheckToKeepGraceCanceledAt"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["dateToCheckToRestoreGrace"]}," to the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gracePeriod"]}," object on obligations."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Draw ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["atOrigination.gracePeriod"]}," gained ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["numPeriodsToEvaluateGrace"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minPaymentCalculationOverride"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"changed-endpoints","__idx":2},"children":["Changed Endpoints"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/draws"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /people/{personId}/loans/{loanId}/draws"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/draws/{drawId}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /people/{personId}/loans/{loanId}/draws/{drawId}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /people/{personId}/loans/{loanId}/draws/{drawId}/credit-limit"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/draws/{drawId}/obligations"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/draws/{drawId}/obligations/{obligationId}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/obligations"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/obligations/{obligationId}"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2025-03-26","__idx":3},"children":["2025-03-26"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Borrower field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["borrowerType"]}," was added."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Borrower field ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["collectionsIntensity"]}," was changed to be not read only."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fixed User object schema: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["user.employee"]}," should only have a subset of full employee properties."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fixed Employee object schema: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["availableAndPermittedTasktypes"]}," should be a read only array."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed deprecated property ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["gracePeriod"]}," from Line of Credit statement details."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Fixed transaction object schema: transaction objects have a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metaData"]}," property."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Renamed ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["idsOnly"]}," enum option to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["minimal"]}," in the API request parameters for /loans."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Removed deprecated ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["status"]}," property from template version objects."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/refunds"]}," returned v2 refund fields, consistent with the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /companies/{companyId}/people/{personId}/loans/{loanId}/refunds"]}," endpoint."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"changed-endpoints-1","__idx":4},"children":["Changed Endpoints"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /communicator/templatedescriptors/{descriptorId}/templates"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /communicator/templates"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /communicator/templates"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /communicator/templates/{templateVersionId}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /communicator/templates/{templateVersionId}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /employees"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /employees"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /employees/{employeeId}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /employees/{employeeId}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /loans"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /people/{personId}/loans/{loanId}/migration/past-transaction"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/refunds"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /people/{personId}/loans/{loanId}/statements/{statementId}/details"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /people/{personId}/loans/{loanId}/transactions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /users"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /users"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /users/{userId}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT /users/{userId}"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /v2/communicator/templates"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2023-11-29","__idx":5},"children":["2023-11-29"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This is an empty change created to facilitate deployment of the API Versioning system. It does not change the schema or transform requests/responses."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"2018-01-01","__idx":6},"children":["2018-01-01"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["This is the base version of the API."]}]}]},"headings":[{"value":"API Versions Breaking Changes","id":"api-versions-breaking-changes","depth":1},{"value":"2026-08-04 (Beta)","id":"2026-08-04-beta","depth":2},{"value":"Changed Endpoints","id":"changed-endpoints","depth":3},{"value":"2025-03-26","id":"2025-03-26","depth":2},{"value":"Changed Endpoints","id":"changed-endpoints-1","depth":3},{"value":"2023-11-29","id":"2023-11-29","depth":2},{"value":"2018-01-01","id":"2018-01-01","depth":2}],"frontmatter":{"seo":{"title":"API Versions Breaking Changes"}},"lastModified":"2026-08-17T20:21:43.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api-docs/breaking-changes","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}